Transaction Object Fields

These field references describe the fields in a transaction object.

The following fields are available:

Field	Type	Pattern	Min	Max	Description
`purchase_order_number`	String	—	—	64	The identifier for the purchase. The service displays this value on the invoice when required.
`billing_address`	Object	—	—	—	See Address Object Fields.
`payment_address`	Object	—	—	—	See Address Object Fields.
`custom_data`	String	—	—	256	The custom data to associate with the transaction.
`buyer_name`	String	—	—	512	The buyer's first name, last name, or company name. For business-to-business (B2B) transactions, the validation service can overwrite this value.
`currency_code`	String	—	2	2	The ISO currency code for the transaction, for example `EUR` for Euros.
`discounts`	Object	—	—	—	See Discount Object Fields.
`sellers`	Object	—	—	—	Not applicable to this object.
`control_flags`	String	—	—	32	See Control Flag Object Fields.
`transaction_lines`	Object	—	—	—	See Transaction Lines Object Fields.
`buyer_tax_number`	String	—	—	256	The buyer's tax identification number. Include the country code in this value, such as `EU123456789`, or specify the country separately using `billing_country_code`. If both fields contain a country code, the service uses the country code in `buyer_tax_number` after validating it.
`custom_fields`	String	—	—	256	The custom fields stored as key-value pairs. The service does not process these fields.
`supply_timestamp`	String	—	—	—	The date and time of the supply.
`payment_due_timestamp`	String	—	—	—	The date and time when payment is due.
`external_unique_id`	String	`[a-zA-Z0-9_-]{20,64}`	20	64	The unique external identifier. Use a secure, randomly generated value.
`vouchers`	Object	—	—	—	See Voucher Object Fields.
`customer_id`	String	—	—	256	The free-form identifier that corresponds to the customer identifier in your system.
`buyer_email`	String	`[^@]+@[^@]+`	—	256	The buyer's email address. Use this field to capture the address for further processing, such as invoice delivery.
`tax_timestamp`	String	—	—	—	The date and time when the tax liability is created. The service uses this timestamp to determine the applicable tax and currency exchange rates and includes it on the invoice. If you do not provide a value, the service uses invoice_timestamp. Format: `yyyy-MM-dd'T'HH:mm:ssZZZ`.
`payment_timestamp`	String	—	—	—	The date and time when the payment is accepted.
`custom_id`	String	—	—	256	The custom identifier provided when the transaction is created. The field is required for schema validation, but the value can be empty.
`ship_to_address`	Object	—	—	—	See Address Object Fields.
`description`	Stri	—	—	—	The description of the transaction.
`invoice_timestamp`	String	—	—	—	The date and time when the invoice is issued. The service uses this value on the invoice and as the default for `tax_timestamp` when no tax timestamp is provided. If neither value is provided, the service uses the current time in the merchant's time zone. Format: `yyyy-MM-dd'T'HH:mm:ssZZZ`.
`location_evidence`	Object	—	—	—	See Location Evidence Object.