Simple Order API | null

Required Fields for a Sale

The following fields are required in a request for a sale:
billTo_city
Required except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
billTo_country
Required except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
billTo_email
Required except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
billTo_firstName
Required except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
billTo_lastName
Required except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
billTo_postalCode
Required when the billing country is the U.S. or Canada except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
billTo_state
Required when the billing country is the U.S. or Canada except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
billTo_street1
Required except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
card_accountNumber
card_cardType
Required on
Visa Platform Connect
for all card types. On other processors, required for certain card types. It is strongly recommended that you send the card type even if it is optional for your processor. Omitting the card type can cause the transaction to be processed with the wrong card type.
card_expirationMonth
Required except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
card_expirationYear
Required except when your account is configured for relaxed requirements for address data and expiration date.
Important:
It is your responsibility to determine whether a field is required for the transaction that you are requesting.
ccAuthService_commerceIndicator
Required for requests that include payer authentication data. Otherwise, it is optional.
ccAuthService_run
Set this field to
true
.
ccCaptureService_run
Set this field to
true
.
item_#_productName
Required when the product code is not
default
or one of the values for shipping or handling. Otherwise, this field is optional.
item_#_productSKU
Required when the product code is not
default
or one of the values for shipping or handling. Otherwise, this field is optional.
item_#_quantity
Required when the product code is not
default
or one of the values for shipping or handling. Otherwise, this field is optional.
merchantID
merchantReferenceCode
purchaseTotals_currency
purchaseTotals_grandTotalAmount
Either
purchaseTotals_grandTotalAmount
or
item_#_unitPrice
must be included in the request.
shipTo_city
Required when any shipping address information is included in the request and shipping to the U.S. or Canada. Otherwise, this field is optional.
shipTo_country
Required when any shipping address information is included in the request. Otherwise, this field is optional.
shipTo_postalCode
Required when any shipping address information is included in the request and shipping to the U.S. or Canada. Otherwise, this field is optional.
shipTo_state
Required when any shipping address information is included in the request and shipping to the U.S. or Canada. Otherwise, this field is optional.
shipTo_street1
Required when any shipping address information is included in the request. Otherwise, this field is optional.