Payment Object

account

string

The account identifier

agreement

string

The Portico requirement added for certification

aid_number

string

The authorization identifier. For Europay, Mastercard, Visa (EMV) transactions, this is the application identifier (AID) field.

allow_tip

boolean

The POS does not use this field

amount

numeric

The payment amount rounded to currency decimal precision

application_name

string

The name of card processing application, such as MasterCardCredit or AMEX. For EMV transactions, this is the APL field.

application_response_code

string

The EMV Authorization Response Code (ARC) field

arqc

string

The cryptogram field

auth

string

The authentication code

balance

numeric

The balance of the card

card_acquisition

string

The type of acquisition such as MANUAL, SWIPE, CONTACTLESS, SCANNER, CHIP, or CHIP_FALL_BACK_SWIPE. For EMV transactions, this is the CEM field.

card_brand_name

string

The card company brand such as Visa, Mastercard, or American Express

code

string

The payment code. Options include CASH, DEBIT, CREDIT, or GIFT.

e_signature

string

The Suppress Signature line

emv

boolean

The EMV format for Portico

external_pay_type

string

The customized gift card name

id

string

The unique payment identifier

issuer_application_data

string

The EMV AID field

offline_id

string

An identifier relating to a Store and Forward (SAF) action. It is used to query a payment device to update the status of a transaction after a SAF action. This has been available since OrderObject version 4.

open_cash_drawer

boolean

The POS does not use this field

pay_type_id

string

The identifier value relating to pay type enums

pay_type_name

string

The display name of the pay type used for the payment. This was added in OrderObject version 6.

point_balance

numeric

The number of points left in a customer's house account. For example, a customer could have 30 points left for rewards after the order transaction.

processed_at

string

The transaction processing time in Coordinated Universal Time (UTC) format

name_on_card

string

The card name

refund_policy

string

The Portico requirement added for certification

request_id

string

The request identifier by transaction

signature

boolean

Any value of this field triggers a print signature line (see e_signature and PIN). Convert to string.

status

string

The payment status

tc

string

The cryptogram field

terminal_id

string

The terminal where payment was processed

terminal_verification_results

string

The EMV terminal verification results (TVR) field

tip_amount

number

The sum of total tips

trace_number

string

The transaction identifier in the batch

transaction_id

string

The transaction identifier

transaction_status_indicator

string

The EMV transaction status indicator (TSI) field

transaction_type

string

The available transactions types. For example, SALE or REFUND.

verification_method

string

For EMV transactions, this is the Cardholder Verification Method (CVM) field.