Retrieve Transaction
Request to retrieve the details of a transaction. For example you can retrieve the details of an authorization that you previously executed.
URL | https://egenius.unicredit.ro/api/nvp/version/43 |
HTTP Method | POST |
Authentication |
This operation requires authentication via one of the following methods:
|
Request Parameters
apiOperation String =RETRIEVE_TRANSACTION FIXED
Existence
FIXED
Fixed value
RETRIEVE_TRANSACTION
Validation Rules
Any sequence of zero or more unicode characters.
XSD type
string
merchant Alphanumeric + additional characters = COMPULSORY
The unique identifier issued to you by your payment provider.
Existence
COMPULSORY
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40
order.id String = COMPULSORY
A unique identifier for this order to distinguish it from any other order you create.
Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order you create using your merchant profile.
Existence
COMPULSORY
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
transaction.id String = COMPULSORY
Unique identifier for this transaction to distinguish it from any other transactions on the order.
Existence
COMPULSORY
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
apiOperation String =RETRIEVE_TRANSACTION FIXED
Existence
FIXED
Fixed value
RETRIEVE_TRANSACTION
Validation Rules
Any sequence of zero or more unicode characters.
XSD type
string
correlationId String = OPTIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Existence
OPTIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
merchant Alphanumeric + additional characters = COMPULSORY
The unique identifier issued to you by your payment provider.
Existence
COMPULSORY
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40
order.id String = COMPULSORY
A unique identifier for this order to distinguish it from any other order you create.
Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order you create using your merchant profile.
Existence
COMPULSORY
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
responseControls = OPTIONAL
Container for fields that control the response returned for the request.
Fixed value
responseControls.sensitiveData String = OPTIONAL
Indicates how sensitive data is returned in the response.
Existence
OPTIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
transaction.id String = COMPULSORY
Unique identifier for this transaction to distinguish it from any other transactions on the order.
Existence
COMPULSORY
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
Response Parameters
browserPayment = CONDITIONAL
Information required by the gateway to manage browser payment interactions.
Fixed value
browserPayment.redirectUrl Url = CONDITIONAL
The URL issued by the gateway to which you must redirect the payer's browser to make a payment.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensure that the URL begins with 'https' and is longer than 11 characters.
XSD type
string
merchant Alphanumeric + additional characters = Always Provided
The unique identifier issued to you by your payment provider.
Existence
Always Provided
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40
order = Always Provided
Information about the order associated with this transaction.
Fixed value
order.amount Decimal = Always Provided
The total amount for the order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.creationTime DateTime = Always Provided
The timestamp indicating the time the gateway considers the order to have been created.
Existence
Always Provided
Fixed value
Validation Rules
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
XSD type
string
order.currency Upper case alphabetic text = Always Provided
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Existence
Always Provided
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
order.id String = Always Provided
A unique identifier for this order to distinguish it from any other order you create.
Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order created by your merchant profile.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
order.totalAuthorizedAmount Decimal = Always Provided
The amount that has been successfully authorized for this order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.totalCapturedAmount Decimal = Always Provided
The amount that has been successfully captured for this order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.totalRefundedAmount Decimal = Always Provided
The amount that has been successfully refunded for this order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
response = Always Provided
Fixed value
response.gatewayCode Enumeration = Always Provided
Summary of the success or otherwise of the proposed operation.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ABORTED
Transaction aborted by payer
ACQUIRER_SYSTEM_ERROR
Acquirer system error occurred processing the transaction
APPROVED
Transaction Approved
APPROVED_PENDING_SETTLEMENT
Transaction Approved - pending batch settlement
AUTHENTICATION_FAILED
Payer authentication failed
BLOCKED
Transaction blocked due to Risk or 3D Secure blocking rules
CANCELLED
Transaction cancelled by payer
DECLINED
The requested operation was not successful. For example, a payment was declined by issuer or payer authentication was not able to be successfully completed.
DECLINED_AVS
Transaction declined due to address verification
DECLINED_AVS_CSC
Transaction declined due to address verification and card security code
DECLINED_CSC
Transaction declined due to card security code
DECLINED_DO_NOT_CONTACT
Transaction declined - do not contact issuer
DECLINED_PAYMENT_PLAN
Transaction declined due to payment plan
DEFERRED_TRANSACTION_RECEIVED
Deferred transaction received and awaiting processing
DUPLICATE_BATCH
Transaction declined due to duplicate batch
EXCEEDED_RETRY_LIMIT
Transaction retry limit exceeded
EXPIRED_CARD
Transaction declined due to expired card
INSUFFICIENT_FUNDS
Transaction declined due to insufficient funds
INVALID_CSC
Invalid card security code
LOCK_FAILURE
Order locked - another transaction is in progress for this order
NOT_ENROLLED_3D_SECURE
Card holder is not enrolled in 3D Secure
NOT_SUPPORTED
Transaction type not supported
PARTIALLY_APPROVED
The transaction was approved for a lesser amount than requested. The approved amount is returned in order.totalAuthorizedAmount.
PENDING
Transaction is pending
REFERRED
Transaction declined - refer to issuer
SUBMITTED
The transaction has successfully been created in the gateway. It is either awaiting submission to the acquirer or has been submitted to the acquirer but the gateway has not yet received a response about the success or otherwise of the payment.
SYSTEM_ERROR
Internal system error occurred processing the transaction
TIMED_OUT
The gateway has timed out the request to the acquirer because it did not receive a response. You can handle the transaction as a declined transaction. Where possible the gateway will attempt to reverse the transaction.
UNKNOWN
The transaction has been submitted to the acquirer but the gateway was not able to find out about the success or otherwise of the payment. If the gateway subsequently finds out about the success of the payment it will update the response code.
UNSPECIFIED_FAILURE
Transaction could not be processed
result Enumeration = Always Provided
A system-generated high level overall result of the operation.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown
transaction = Always Provided
Information about this transaction.
Fixed value
transaction.acquirer = Always Provided
Fixed value
transaction.acquirer.id String = Always Provided
The ID for the acquirer used to process the transaction.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
transaction.amount Decimal = Always Provided
The total amount for the transaction.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
transaction.currency Upper case alphabetic text = Always Provided
The currency of the transaction expressed as an ISO 4217 alpha code, e.g. USD.
Existence
Always Provided
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
transaction.id String = Always Provided
Unique identifier for this transaction to distinguish it from any other transactions on the order.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
transaction.type Enumeration = Always Provided
Indicates the type of action performed on the order.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTHORIZATION
Authorization
AUTHORIZATION_UPDATE
Authorization Update
CAPTURE
Capture
PAYMENT
Payment (Purchase)
REFUND
Refund
REFUND_REQUEST
Refund Request
VERIFICATION
Verification
VOID_AUTHORIZATION
Void Authorization
VOID_CAPTURE
Void Capture
VOID_PAYMENT
Void Payment
VOID_REFUND
Void Refund
3DSecure = CONDITIONAL
Information on 3DSecure fields.
Fixed value
3DSecure.acsEci Digits = CONDITIONAL
The Electronic Commerce Indicator returned by the card issuer in the authentication response message.
It indicates the level of security and authentication of the transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
1
maximum length
2
3DSecure.authenticationStatus Enumeration = CONDITIONAL
Indicates if the cardholder verification was successful.
Included only if payment authentication was attempted and a PARes (Payer Authentication Response) was received by the MPI.
The PARes message is the response received from the card Issuer's Access Control Server (ACS) after the cardholder has completed the authentication process.
The PARes message is the response received from the card Issuer's Access Control Server (ACS) after the cardholder has completed the authentication process.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION_ATTEMPTED
Authentication was attempted but the card issuer did not perform the authentication.
AUTHENTICATION_NOT_AVAILABLE
An internal error occurred and Authentication is not currently available.
AUTHENTICATION_SUCCESSFUL
The cardholder was successfully authenticated.
3DSecure.authenticationToken Base64 = CONDITIONAL
The base64 encoded value generated by the card issuer.
Included in subsequent transaction request messages and used by the card scheme to verify that the authentication occurred and the values provided are valid. The token should be used unaltered.
This field corresponds to the Cardholder Authentication Verification Value (CAVV) for Visa, the Accountholder Authentication Value (AAV) for MasterCard and JCB, or the American Express Verification Value (AEVV) for American Express.
This field corresponds to the Cardholder Authentication Verification Value (CAVV) for Visa, the Accountholder Authentication Value (AAV) for MasterCard and JCB, or the American Express Verification Value (AEVV) for American Express.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is Base64 encoded
XSD type
string
allowable lengths
28 or 32
3DSecure.enrollmentStatus Enumeration = Always Provided
Indicates if the cardholder is enrolled for 3-D Secure authentication.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ENROLLED
The card is enrolled for 3DS authentication.
ENROLLMENT_STATUS_UNDETERMINED
The Issuer's ACS was unable to process the request to check enrollment or the card is ineligible.
NOT_ENROLLED
The card is not enrolled for 3DS authentication.
3DSecure.xid Base64 = CONDITIONAL
A unique transaction identifier generated by the Payment Gateway on behalf of the merchant to identify the 3DS transaction.
This field is mandatory for Verified By Visa transactions if authentication was available. The XID should be used in operation requests unaltered.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is Base64 encoded
XSD type
string
allowable length
28
3DSecureId ASCII Text = CONDITIONAL
A unique identifier supplied by the merchant for the authentication.
It is first defined in the check3DSEnrollment operation, and then included in subsequent operations.
It is not used when the authentication is performed externally.
It is not used when the authentication is performed externally.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
1
maximum length
64
airline = CONDITIONAL
Airline industry specific data
Fixed value
airline.bookingReference Alphanumeric = CONDITIONAL
The record locator used to access a specific Passenger Name Record (PNR).
PNR is a record in the database of a booking system that contains the itinerary for a passenger, or a group of passengers traveling together.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
6
maximum length
15
airline.documentType Enumeration = CONDITIONAL
The type of charge associated with the transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Document Type Code
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ADDITIONAL_COLLECTION
Additional Collection
AGENCY_EXCHANGE_ORDER
Agency Exchange Order
AGENCY_GROUP_TICKET
Agency Group Ticket
AGENCY_MISCELLANEOUS_CHARGE_ORDER
Agency Misc. Charge Order (MCO)
AGENCY_PASSENGER_TICKET
Agency Passenger Ticket
AGENCY_TOUR_ORDER_OR_VOUCHER
Agency Tour Order/Voucher
AIR_FREIGHT
SPD/Air Freight
ANIMAL_TRANSPORTATION_CHARGE
Animal Transportation Charge
CATALOGUE_MERCHANDISE_ORDERED
Catalogue Merchandise Ordered
CLUB_MEMBERSHIP_FEE
Club Membership Fee
COUPON_BOOK
Coupon Book
CREDIT_CLASS_SERVICE_ADJUSTMENT
Credit Class of Service Adjustment
CREDIT_DENIED_BOARDING
Credit Denied Boarding
CREDIT_EXCHANGE_REFUND
Credit Exchange Refund
CREDIT_LOST_TICKET_REFUND
Credit Lost Ticket Refund
CREDIT_MISCELLANEOUS_REFUND
Credit Misc. Refund
CREDIT_MULTIPLE_UNUSED_TICKETS
Credit Multiple Unused Tickets
CREDIT_OVERCHARGE_ADJUSTMENT
Credit Overcharge Adjustment
CREDIT_UNUSED_TRANSPORTATION
Credit Unused Transportation
DEBT_ADJUSTMENT_DUPLICATE_REFUND_OR_USE
Debt Adjustment Duplicate Refund/Use
DUTY_FREE_SALE
Duty Free Sale
EXCESS_BAGGAGE
Excess Baggage
EXCHANGE_ADJUSTMENT
Exchange Adjustment
EXCHANGE_ORDER
Exchange Order
FIREARMS_CASE
Firearms Case
FREQUENT_FLYER_FEE_OR_PURCHASE
Frequent Flyer Fee/Purchase
FREQUENT_FLYER_FULFILLMENT
Frequent Flyer Fulfillment
FREQUENT_FLYER_OVERNIGHT_DELIVERY_CHARGE
Frequent Flyer Overnight Delivery Charge
GROUP_TICKET
Group Ticket
IN_FLIGHT_ADJUSTMENT
In-flight Adjustment
IN_FLIGHT_CHARGES
In-flight Charges
IN_FLIGHT_DUTY_FREE_PURCHASE
In-flight Duty Free Purchase
IN_FLIGHT_MERCHANDISE_ORDERED
In-flight Merchandise Ordered
IN_FLIGHT_PHONE_CHARGES
In-flight Phone Charges
KENNEL_CHARGE
Kennel Charge
LOST_TICKET_APPLICATION
Lost Ticket Application
MISCELLANEOUS_CHARGE_ORDER_OR_PREPAID_TICKET_ADVICE
Misc. Charge Order (MCO) / Prepaid Ticket Auth.
MISCELLANEOUS_TAXES_FEES
Miscellaneous Tax(es) Fee(s)
PASSENGER_TICKET
Passenger Ticket
SELF_SERVICE_TICKETS
Self-Service Ticket(s)
SENIOR_CITIZEN_DISCOUNT_BOOKLETS
Senior Citizen Discount Booklets
SMALL_PACKAGE_DELIVERY
Small Package Delivery
SPECIAL_SERVICE_TICKET
Special Service Ticket
SUPPORTED_REFUND
Supported Refund
TICKET_BY_MAIL
Ticket by Mail
TOUR_DEPOSIT
Tour Deposit
TOUR_ORDER_VOUCHER
Tour Order Voucher
UNDERCHARGE_ADJUSTMENT
Undercharge Adjustment
UNSUPPORTED_REFUND
Unsupported Refund
UPGRADE_CHARGE
Upgrade Charge
VENDOR_REFUND_CREDIT
Vendor Refund Credit
VENDOR_SALE
Vendor Sale
airline.itinerary = CONDITIONAL
Itinerary details
Fixed value
airline.itinerary.leg[n] = CONDITIONAL
Travel leg details.
Fixed value
airline.itinerary.leg[n].carrierCode Regex = CONDITIONAL
The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must match regex
XSD type
string
regex
\w{2}|\d{3}|\w{2}/\d{3}
airline.itinerary.leg[n].conjunctionTicketNumber Alphanumeric = CONDITIONAL
The ticket containing the coupon for this leg for an itinerary with more than four trip legs.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
11
maximum length
16
airline.itinerary.leg[n].couponNumber Alphanumeric = CONDITIONAL
The coupon number on the ticket for the trip leg.
Each trip leg requires a separate coupon. The coupon within the series is identified by the coupon number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
1
airline.itinerary.leg[n].departureAirport Upper case alphabetic text = CONDITIONAL
The 3 character IATA airport code of the departure airport for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
airline.itinerary.leg[n].departureDate Date = CONDITIONAL
Date of departure for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
XSD type
string
airline.itinerary.leg[n].departureTax Decimal = CONDITIONAL
Tax payable on departure for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
airline.itinerary.leg[n].departureTime Time = CONDITIONAL
Departure time in local time for the departure airport for this trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]
XSD type
string
airline.itinerary.leg[n].destinationAirport Upper case alphabetic text = CONDITIONAL
The 3 character IATA airport code for the destination airport for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
airline.itinerary.leg[n].destinationArrivalDate Date = CONDITIONAL
Arrival date in local time for the destination airport for this trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
XSD type
string
airline.itinerary.leg[n].destinationArrivalTime Time = CONDITIONAL
Arrival time in local time for the destination airport for this trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 extended time formats, hh:mm[:ss]Z or hh:mm[:ss](+/-)hh[:mm]
XSD type
string
airline.itinerary.leg[n].endorsementsRestrictions Alphanumeric = CONDITIONAL
Restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
20
airline.itinerary.leg[n].exchangeTicketNumber Alphanumeric = CONDITIONAL
New ticket number issued when a ticket is exchanged for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
11
maximum length
16
airline.itinerary.leg[n].fare Decimal = CONDITIONAL
Total fare payable for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
airline.itinerary.leg[n].fareBasis Alphanumeric = CONDITIONAL
Code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
24
airline.itinerary.leg[n].fees Decimal = CONDITIONAL
Total fees payable for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
airline.itinerary.leg[n].flightNumber Alphanumeric = CONDITIONAL
The flight number for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
4
maximum length
6
airline.itinerary.leg[n].stopoverPermitted Boolean = CONDITIONAL
Indicates if a stopover is permitted for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
airline.itinerary.leg[n].taxes Decimal = CONDITIONAL
Total taxes payable for the trip leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
airline.itinerary.leg[n].travelClass Alphanumeric = CONDITIONAL
The industry code indicating the class of service (e.g. Business, Coach) for the leg.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
3
airline.itinerary.numberInParty Digits = CONDITIONAL
Number of passengers associated with this booking.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
1
maximum length
3
airline.itinerary.originCountry Upper case alphabetic text = CONDITIONAL
The 3 character ISO 3166-1 alpha-3 country code of the country of origin for the itinerary.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
airline.passenger[n] = CONDITIONAL
Passenger details
Fixed value
airline.passenger[n].firstName String = CONDITIONAL
First name of the passenger to whom the ticket is being issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
airline.passenger[n].frequentFlyerNumber String = CONDITIONAL
Frequent Flyer or Loyalty Program number for this passenger.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
airline.passenger[n].lastName String = CONDITIONAL
Last name of the passenger to whom the ticket is being issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
airline.passenger[n].middleName String = CONDITIONAL
Middle name of the passenger to whom the ticket is being issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
airline.passenger[n].specificInformation Alphanumeric = CONDITIONAL
Passenger specific information recorded on the ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
59
airline.passenger[n].title String = CONDITIONAL
Title of the passenger to whom the ticket is being issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
airline.planNumber Alphanumeric = CONDITIONAL
Plan number supplied by the airline for this booking.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
2
maximum length
2
airline.ticket = CONDITIONAL
Ticket details
Fixed value
airline.ticket.conjunctionTicketIndicator Boolean = CONDITIONAL
Indicates if a conjunction ticket with additional coupons was issued.
Conjunction ticket refers to two or more tickets concurrently issued to a passenger and which together constitute a single contract of carriage.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
airline.ticket.eTicket Boolean = CONDITIONAL
Indicates if an electronic ticket was issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
airline.ticket.exchangedTicketNumber Alphanumeric = CONDITIONAL
The original ticket number when this is a transaction for an exchanged ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
11
maximum length
16
airline.ticket.issue = CONDITIONAL
Ticket issue information.
Fixed value
airline.ticket.issue.address String = CONDITIONAL
The address where the ticket was issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
16
airline.ticket.issue.carrierCode Regex = CONDITIONAL
The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier issuing the ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must match regex
XSD type
string
regex
\w{2}|\d{3}|\w{2}/\d{3}
airline.ticket.issue.carrierName Alphanumeric = CONDITIONAL
Name of airline carrier issuing the ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
25
airline.ticket.issue.city Alphanumeric = CONDITIONAL
The city/town where the ticket was issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
18
airline.ticket.issue.country Upper case alphabetic text = CONDITIONAL
The 3 character ISO 3166-1 alpha-3 country code of the country where the ticket was issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
airline.ticket.issue.date Date = CONDITIONAL
The date the ticket was issued.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
XSD type
string
airline.ticket.issue.travelAgentCode Alphanumeric = CONDITIONAL
Industry code of the travel agent issuing the ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
8
maximum length
9
airline.ticket.issue.travelAgentName Alphanumeric = CONDITIONAL
Name of the travel agent issuing the ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
30
airline.ticket.restricted Boolean = CONDITIONAL
Indicates if the issued ticket is refundable.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
airline.ticket.ticketNumber Alphanumeric = CONDITIONAL
The airline ticket number associated with the transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
11
maximum length
16
airline.ticket.totalFare Decimal = CONDITIONAL
Total fare for all trip legs on the ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
airline.ticket.totalFees Decimal = CONDITIONAL
Total fee for all trip legs on the ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
airline.ticket.totalTaxes Decimal = CONDITIONAL
Total taxes for all trip legs on the ticket.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
airline.transactionType Enumeration = CONDITIONAL
The type of transaction performed against this airline booking.
Existence
CONDITIONAL
Fixed value
Validation Rules
Transaction Type
XSD type
string
Value must be a member of the following list. The values are case sensitive.
EXCHANGE_TICKET
Exchange Ticket
MISCELLANEOUS_CHARGE
Miscellaneous Charge
REFUND
Refund
REVERSAL
Reversal
TICKET_PURCHASE
Ticket Purchase
TOUR_ORDER
Tour Order
billing = CONDITIONAL
Information on the billing address including the contact details of the payer.
Fixed value
billing.address = CONDITIONAL
The payer's billing address.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
billing.address.city String = CONDITIONAL
The city portion of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
billing.address.company String = CONDITIONAL
The name of the company associated with this address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
billing.address.country Upper case alphabetic text = CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
billing.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
The post code or zip code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
XSD type
string
minimum length
1
maximum length
10
billing.address.stateProvince String = CONDITIONAL
The state or province of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
billing.address.street String = CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
billing.address.street2 String = CONDITIONAL
The second line of the address (if provided).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
browserPayment = CONDITIONAL
Information required by the gateway to manage browser payment interactions.
Fixed value
browserPayment.interaction = CONDITIONAL
Provides details about the interaction of your system and the providers system when initiating the browser payment, redirecting the customer's browser to the provider's system, back to the merchant's website and completing the browser payment.
Fixed value
browserPayment.interaction.status Enumeration = Always Provided
The status of the interaction between the merchant's system and the providers system.
Existence
Always Provided
Fixed value
Validation Rules
Defines the interaction state of the transaction.
XSD type
string
Value must be a member of the following list. The values are case sensitive.
COMPLETED
This browser payment has been completed, i.e. the gateway has been informed about the payment result.
INITIATED
This browser payment has successfully been initiated.
REDIRECTED_TO_PROVIDER
The customer's browser has been redirected to the provider's website for this browser payment.
RETURNED_TO_MERCHANT
The customer's browser has been redirected back to the merchant's website for this browser payment.
browserPayment.interaction.timeCompleted ASCII Text = CONDITIONAL
The date and time the browser payment was completed, i.e. the gateway has been informed about the payment result.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
0
maximum length
29
browserPayment.interaction.timeInitiated ASCII Text = CONDITIONAL
The date and time the browser payment was initiated.
Provided only, if initiating the browser payment was successful (response.gatewayCode=SUBMITTED).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
0
maximum length
29
browserPayment.interaction.timeRedirected ASCII Text = CONDITIONAL
The date and time the customer's browser was received from the merchant's website and redirected to the provider's website.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
0
maximum length
29
browserPayment.interaction.timeReturned ASCII Text = CONDITIONAL
The date and time the customer's browser was received from the provider's website and redirected back to the merchant's website.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
0
maximum length
29
browserPayment.operation Enumeration = CONDITIONAL
The type of transaction you want to create for this payment.
You can choose between an Authorization and a Payment transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTHORIZE
The transaction created in the gateway is an AUTHORIZATION transaction.
PAY
The transaction created in the gateway is a PAYMENT transaction.
browserPayment.paypal = CONDITIONAL
Additional information you must provide when initiating a PayPal browser payment.
It includes specific details about the checkout flow for this PayPal payment.
Fixed value
browserPayment.paypal.displayShippingAddress Boolean = CONDITIONAL
Indicates whether you want PayPal to display the shipping address to the payer on the PayPal website.
By default, the shipping address is displayed to the payer. For more detailed information about displaying the shipping address on the PayPal website, see PayPal Integration: Display/Override Shipping Address.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
browserPayment.paypal.overrideShippingAddress Boolean = CONDITIONAL
Indicates whether you want to allow the payer to change the shipping address for the payment on the PayPal website.
By default, the payer is allowed to change the shipping address. For more detailed information about the payer overriding the shipping address on the PayPal website, see PayPal Integration: Display/Override Shipping Address.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
browserPayment.paypal.paymentConfirmation Enumeration = CONDITIONAL
Indicates where in the checkout flow you want the payer to commit to the payment - on the PayPal website or on your website after returning from the PayPal website.
With the latter option, you must confirm the payment using the CONFIRM_BROWSER_PAYMENT operation.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CONFIRM_AT_MERCHANT
The payer commits to the payment on your website.
CONFIRM_AT_PROVIDER
The payer commits to the payment on the PayPal website.
browserPayment.redirectUrl Url = CONDITIONAL
The URL issued by the gateway to which you must redirect the payer's browser to make a payment.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensure that the URL begins with 'https' and is longer than 11 characters.
XSD type
string
browserPayment.returnUrl Url = CONDITIONAL
The URL to which you want the payer's browser to be redirected on completing the payment at the payment provider's website.
The same redirect URL will be used by the gateway to redirect the payer's browser irrespective of the success or otherwise of the payment.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensure that the URL begins with 'https' and is longer than 11 characters.
XSD type
string
constraints = CONDITIONAL
Information about any constraints that apply to this transaction.
Specify constraints to ensure that the transaction conforms to predefined criteria. This is useful if your integration does not directly collect all the transaction values (e.g. a session-based integration or a checkout integration).
Fixed value
constraints.paymentPlans = CONDITIONAL
Information about the payment plan constraints which apply for this transaction.
Specify payment plan constraints to restrict the available payment plan options for this transaction.
Fixed value
constraints.paymentPlans.numberOfDeferrals Integer = CONDITIONAL
The allowable number of deferral months for the payment plan.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
0
maximum value
99
constraints.paymentPlans.numberOfPayments Integer = CONDITIONAL
The allowable number of installments for the payment plan.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
99
constraints.paymentPlans.supported[n] String = CONDITIONAL
The identifiers for the payment plans supported for this transaction.
If you wish to offer any payment plans to the payer, provide the plan identifiers in this field else pass it as empty.
See Payment Plans for the supported payment plans and their identifiers.
See Payment Plans for the supported payment plans and their identifiers.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
correlationId String = CONDITIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
currencyConversion = CONDITIONAL
Information specific to the use of dynamic currency conversion (DCC).
If you requested a rate quote via the gateway, provide the requestId as returned in the PAYMENT_OPTIONS_INQUIRY response. For rate quote requests performed outside the gateway, you must at least provide payer amount, payer currency, provider and payer exchange rate.
You can only provide DCC information on the initial transaction for an order. If provided on subsequent transactions or an order, DCC information will be ignored.
You can only provide DCC information on the initial transaction for an order. If provided on subsequent transactions or an order, DCC information will be ignored.
Fixed value
currencyConversion.exchangeRateTime DateTime = CONDITIONAL
The timestamp of when the conversion rate is effective.
The timestamp may need to be displayed to the payer on the merchant site to satisfy regulatory requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
XSD type
string
currencyConversion.marginPercentage Decimal = CONDITIONAL
The foreign exchange markup applied as a percentage to the transaction amount for providing the conversion service.
The margin percentage may need to be displayed to the payer on the merchant site to satisfy regulatory requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
10000000
minimum value
0
maximum post-decimal digits
5
currencyConversion.payerAmount Decimal = CONDITIONAL
The total amount of the transaction in the payer's currency.
You must include this field if the payer accepted the DCC offer you presented to them.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
currencyConversion.payerCurrency Upper case alphabetic text = CONDITIONAL
The currency of the DCC rate quote provided by your DCC Service Provider.
The currency must be expressed as an ISO 4217 alpha code, e.g. USD and must be different to that provided for transaction currency. You must include this field if the payer accepted the DCC offer you presented to them.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
currencyConversion.payerExchangeRate Decimal = CONDITIONAL
The exchange rate used to convert the transaction amount into the payer's currency.
The payer exchange rate includes the foreign exchange markup (marginPercentage). The payer exchange rate is displayed to the payer on the merchant site.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000000000
minimum value
0
maximum post-decimal digits
12
currencyConversion.payerReceiptText String = CONDITIONAL
This is a piece of HTML markup that can be included as part of the receipt where the payer has accepted the currency conversion quote.
It contains information necessary to comply with scheme requirements.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
4096
currencyConversion.provider Enumeration = CONDITIONAL
This identifies the name of the provider of the DCC quote.
This data is for information purposes, and may be useful if you use multiple DCC providers.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FEXCO
TRAVELEX_CURRENCY_SELECT
currencyConversion.providerReceipt String = CONDITIONAL
The quote provider's unique reference to the rate quote.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
currencyConversion.uptake Enumeration = Always Provided
Indicates how DCC applies to the order.
If not provided, this value defaults to NOT_REQUIRED.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ACCEPTED
The payer accepted the DCC offer and pays in their own currency. The conditions of the rate quote are applied in the processing of this transaction.
DECLINED
The payer declined the DCC offer and pays in your transaction currency.
NOT_AVAILABLE
A rate quote was requested, but no DCC offer was provided. For rate quotes via the gateway the PAYMENT_OPTION_INQUIRY response contains a currencyConversion.gatewayCode other than QUOTE_PROVIDED.
NOT_REQUIRED
DCC is not required for this transaction.
customer = CONDITIONAL
Information about the customer, including their contact details.
Fixed value
customer.email Email = CONDITIONAL
The email address of the customer.
The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
XSD type
string
customer.firstName String = CONDITIONAL
The payer's first name.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
customer.lastName String = CONDITIONAL
The payer's last or surname.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
customer.mobilePhone String = CONDITIONAL
The contact person's mobile phone or cell phone number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
customer.phone String = CONDITIONAL
The phone number of the person to whom the order is being billed.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
customer.taxRegistrationId String = CONDITIONAL
The tax registration identifier of the customer.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
30
device = CONDITIONAL
Information associated with the device's source of transaction.
Fixed value
device.ani String = CONDITIONAL
The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
10
device.aniCallType String = CONDITIONAL
The 2 digit ANI information identifier provided by the telephone company to indicate the call type, for example, cellular (61-63), toll free (24,25), etc.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
2
device.browser String = CONDITIONAL
The User-Agent header of the browser the customer used to place the order.
For example, MOZILLA/4.0 (COMPATIBLE; MSIE 5.0; WINDOWS 95)
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
255
device.hostname String = CONDITIONAL
The name of the server to which the customer is connected.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
60
device.ipAddress String = CONDITIONAL
The IP address of the computer used by the customer, in nnn.nnn.nnn.nnn format.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
7
maximum length
15
device.mobilePhoneModel String = CONDITIONAL
The mobile phone manufacturer's identifier for the model of the mobile device used to initiate the payment.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
255
gatewayEntryPoint Enumeration = CONDITIONAL
How the transaction was created.
Existence
CONDITIONAL
Fixed value
Validation Rules
How the transaction was created.
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTO
The transaction was automatically generated by the gateway. For example, a Capture transactions for Auto-Capture or an order reversal transaction for risk rejected orders.
BATCH
The transaction was submitted as part of a merchant batch. Batches can either be uploaded via Batch or via Merchant Administration.
CHECKOUT
The transaction was created via checkout integration.
MERCHANT_ADMINISTRATION
The transaction was initiated in Merchant Administration.
THREE_PARTY
The transaction was created via 3-Party Pages (PC/VPC) integration.
TWO_PARTY
The transaction was created via 2-Party (PC/VPC) integration.
WEB_SERVICES_API
The transaction was submitted via Web Services API.
giftCard = CONDITIONAL
Fixed value
giftCard.availableBalance = CONDITIONAL
Fixed value
giftCard.availableBalance.amount Decimal = CONDITIONAL
The available balance on the card.
This is the amount available to the payer to spend using this gift card after this payment.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
giftCard.availableBalance.currency Upper case alphabetic text = CONDITIONAL
The currency of available balance on the card expressed as an ISO 4217 alpha code, e.g. USD.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
lineOfBusiness String = CONDITIONAL
Your payment service provider might have configured your merchant profile to support several lines of business.
Each line of business can have different payment parameters, such as bank account, supported cards or such.
For example, lineOfBusiness = TICKET_SALES can have a different bank account from lineOfBusiness = MERCHANDISING. One line of business on your profile might be "null". To use that, do not provide the lineOfBusiness field.
For example, lineOfBusiness = TICKET_SALES can have a different bank account from lineOfBusiness = MERCHANDISING. One line of business on your profile might be "null". To use that, do not provide the lineOfBusiness field.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters except space
XSD type
string
minimum length
1
maximum length
100
merchant Alphanumeric + additional characters = Always Provided
The unique identifier issued to you by your payment provider.
Existence
Always Provided
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
XSD type
string
minimum length
1
maximum length
40
order = Always Provided
Information about the order associated with this transaction.
Fixed value
order.acceptPartialAmount Boolean = CONDITIONAL
Indicates whether you will accept a payment less than order.amount, e.g. when using a gift card.
If not set or set to FALSE, and the full amount is not available, the transaction will be rejected.
Unless you have been advised by your payment service provider that the gateway supports partial approvals for your acquirer, you can ignore this field.
If the gateway supports partial approvals for your acquirer you must set this field to TRUE else the transaction is rejected by the gateway.
Unless you have been advised by your payment service provider that the gateway supports partial approvals for your acquirer, you can ignore this field.
If the gateway supports partial approvals for your acquirer you must set this field to TRUE else the transaction is rejected by the gateway.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
order.amount Decimal = Always Provided
The total amount for the order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.cashAdvance Boolean = CONDITIONAL
Set this flag if the transaction is a manual cash disbursement transaction, i.e. cash is disbursed upon the acceptance of a card by a financial institution teller.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
order.cashbackAmount Decimal = CONDITIONAL
The amount the payer has chosen to receive as cash in addition to the amount they are paying for the goods or services they are purchasing from you.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.certainty Enumeration = CONDITIONAL
Indicates your level of assurance that the amount you have requested for authorization will be the final amount you capture.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ESTIMATED_MAXIMUM_AMOUNT
The amount is the maximum possible value of the final amount to be captured. The amount requested might be reduced to final amount. The authorization may not be reversed.
ESTIMATED_MINIMUM_AMOUNT
The amount is the minimum amount expected to be captured. The amount requested might be incremented to the final amount or the authorization may be reversed.
FINAL_AMOUNT
The final amount is known and will be captured. The authorization may not be reversed.
order.creationTime DateTime = Always Provided
The timestamp indicating the time the gateway considers the order to have been created.
Existence
Always Provided
Fixed value
Validation Rules
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
XSD type
string
order.currency Upper case alphabetic text = Always Provided
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Existence
Always Provided
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
order.custom String = CONDITIONAL
A field you provide to capture additional information about this order that is only of interest to you.
The gateway does not send this information to the acquirer. A maximum of 50 such fields may be added to the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
250
order.customerNote String = CONDITIONAL
A note from the payer about this order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
250
order.customerOrderDate Date = CONDITIONAL
The date the payer placed the order.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
XSD type
string
order.customerReference ASCII Text = CONDITIONAL
The payer's own reference for the order.
This reference may assist the payer to identify the order in their system. For example, a purchase order number, project identifier, or cost center.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
0
maximum length
25
order.description String = CONDITIONAL
Short textual description of the contents of the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
order.discount = CONDITIONAL
Information about a price reduction you have applied to the order.
For example, you may apply discounts for trade, employees, bulk purchase, or a sales promotion.
Fixed value
order.discount.amount Decimal = CONDITIONAL
The total amount of the discount you have applied to the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.discount.code String = CONDITIONAL
The code you use to identify the reason for the discount.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
order.discount.description String = CONDITIONAL
A description of your reason for the discount.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
order.gratuityAmount Decimal = CONDITIONAL
The amount the payer has chosen to provide as a gratuity or tip in addition to the amount they are paying for the goods or services they are purchasing from you.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.id String = Always Provided
A unique identifier for this order to distinguish it from any other order you create.
Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order created by your merchant profile.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
order.invoiceNumber String = CONDITIONAL
The invoice number you issued for this order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
25
order.item[n] = CONDITIONAL
Information about the items the payer purchases with the order.
Fixed value
order.item[n].brand String = CONDITIONAL
The brand of the item.
For example, Dell.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
order.item[n].category String = CONDITIONAL
Your category for the item.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
order.item[n].description String = CONDITIONAL
Description for the item with information such as size, color, etc.
For example, 'Color:Red, Size:M'
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
order.item[n].detail = CONDITIONAL
Only use this parameter group to provide additional line item details required for a better interchange rate for Purchasing Cards, Business and/or Corporate Cards (Level 3).
Check with your payment service provider if Level 3 data is supported for your acquirer.
Fixed value
order.item[n].detail.acquirerCustom JSON Text = CONDITIONAL
Use this field to provide line item details that your acquirer requires you to provide.
Data must be provided in JSON format using the record name and field name (separated by a comma) to identify the value provided. Contact your payment service provider for details about the supported fields including the field definitions.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is valid Json Format
XSD type
string
minimum length
1
maximum length
4000
order.item[n].detail.commodityCode Integer = CONDITIONAL
A code describing a commodity or a group of commodities pertaining to goods classification.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
order.item[n].detail.unitDiscountRate Decimal = CONDITIONAL
The discount rate (percentage) applied to this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
999999
minimum value
0
maximum post-decimal digits
5
order.item[n].detail.unitTax[n] = CONDITIONAL
Information about the taxes per unit.
Fixed value
order.item[n].detail.unitTax[n].amount Decimal = CONDITIONAL
The tax amount for the tax type defined in order.item[n].detail.unitTax[m].type for the item.
Note that the tax amount provided must reflect the tax amount applied before a discount was applied.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
order.item[n].detail.unitTax[n].rate Decimal = CONDITIONAL
The tax rate (percentage) applied to the item for the tax type defined in order.item[n].detail.unitTax[m].type.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
order.item[n].detail.unitTax[n].type String = CONDITIONAL
The tax type for which the amount specified under order.item[n].detail.unitTax[m].amount has been paid for this item.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
order.item[n].detail.unitTaxRate Decimal = CONDITIONAL
The tax rate (percentage) of the tax charged for this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
999999
minimum value
0
maximum post-decimal digits
5
order.item[n].detail.unitTaxType String = CONDITIONAL
The type of tax charged for this item.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
10
order.item[n].detail.unspsc Integer = CONDITIONAL
The United Nations Standard Products and Services Code (UNSPSC) for the item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
order.item[n].detail.upc Integer = CONDITIONAL
The Universal Product Code (UPC) for the item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
order.item[n].industryCategory Enumeration = CONDITIONAL
Provide the industryCategory to send this line item to your acquirer for specialized processing as industry data.
Such processing might have legal obligations, which are your responsibility. Do not provide an industryCategory, unless you are certain it applies to you, and is accepted by your acquirer.We support the following industry standard processing:US health care processing using the IIAS standard.The supported values for industryCategory are:HEALTHCARE_VISION, HEALTHCARE_DENTAL, HEALTHCARE_PRESCRIPTION, HEALTHCARE_OTHERWe formulate an IIAS message by summing the amounts of all the line items having the same industryCategory. The amount of a line item is:
(order.item.unitPrice + order.item.tax) * order.item.quantity
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
HEALTHCARE_DENTAL
HEALTHCARE_OTHER
HEALTHCARE_PRESCRIPTION
HEALTHCARE_VISION
order.item[n].name String = Always Provided
A short name describing the item.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
order.item[n].quantity Integer = Always Provided
The quantity of the item.
Existence
Always Provided
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
order.item[n].sku String = CONDITIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
order.item[n].unitDiscountAmount Decimal = CONDITIONAL
The discount amount applied to this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
order.item[n].unitOfMeasure String = CONDITIONAL
The unit of measure used for the item quantity.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
10
order.item[n].unitPrice Decimal = Always Provided
The cost price for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
order.item[n].unitTaxAmount Decimal = CONDITIONAL
The tax amount for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total tax amount for this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
order.itemAmount Decimal = CONDITIONAL
The total item amount for the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.localTaxRegistrationId String = CONDITIONAL
Your tax registration identifier provided by the Local/State/Province tax authority.
If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Provincial Sales Tax (PST).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
25
order.notificationUrl Url = CONDITIONAL
The URL to which the gateway will send Webhook notifications when an order is created or updated.
To receive notifications at this URL, you must enable Webhook notifications in Merchant Administration. Ensure the URL is HTTPS
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensure that the URL begins with 'https' and is longer than 11 characters.
XSD type
string
order.owningEntity String = CONDITIONAL
Your identifier for the part of your organization that is responsible for the order.
You might provide this data when you want to track the accountability for the order. For example, store number, sales region, branch, or profit center
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
order.recurringPaymentAgreement Alphanumeric = CONDITIONAL
Your reference to the contract or agreement you have with the payer to process recurring payments.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
30
order.reference String = CONDITIONAL
An optional identifier for the order.
For example, a shopping cart number, an order number, or an invoice number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
200
order.requestorName String = CONDITIONAL
The name of the person who requested the goods or services.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.shippingAndHandlingAmount Decimal = CONDITIONAL
The total shipping and handling amount for the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.statementDescriptor = CONDITIONAL
Contact information provided by you for printing on payer's account statements.
Fixed value
order.statementDescriptor.address = CONDITIONAL
Descriptor address of the merchant.
Fixed value
order.statementDescriptor.address.city String = CONDITIONAL
The city portion of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.statementDescriptor.address.company String = CONDITIONAL
The name of the company associated with this address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.statementDescriptor.address.country Upper case alphabetic text = CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
order.statementDescriptor.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
The post code or zip code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
XSD type
string
minimum length
1
maximum length
10
order.statementDescriptor.address.stateProvince String = CONDITIONAL
The state or province of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
order.statementDescriptor.address.street String = CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.statementDescriptor.address.street2 String = CONDITIONAL
The second line of the address (if provided).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.statementDescriptor.name String = CONDITIONAL
Descriptor name of the merchant.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.statementDescriptor.phone String = CONDITIONAL
Descriptor phone number of the merchant's business.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
order.status Enumeration = CONDITIONAL
The current status of the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTHORIZED
The payment has been authorized successfully but the authorized amount has not yet been captured, in part, full, or excess.
CANCELLED
The initial transaction for this order has been voided successfully.
CAPTURED
The authorized amount for this order, in full or excess, has been captured successfully.
EXCESSIVELY_REFUNDED
The payment has been captured in part, full, or excess, but the captured amount in excess has been refunded successfully.
FAILED
The payment has not been successful.
INITIATED
A browser payment that has successfully been initiated for this order. No payment has yet been made.
PARTIALLY_CAPTURED
The authorized amount for this order, in part, has been captured successfully.
PARTIALLY_REFUNDED
The payment has been captured in part, full, or excess, but the captured amount in part has been refunded successfully.
REFUNDED
The payment has been captured in part, full, or excess, but the captured amount in full has been refunded successfully.
REFUND_REQUESTED
A refund against captured amounts on this order has been requested but not executed. Requires further action to approve the refund.
VERIFIED
The card details for this order have successfully been verified. No payment has yet been initiated or made.
order.subMerchant = CONDITIONAL
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
These merchants are referred to as your sub-merchants.
The sub-merchant's details you provide may be displayed on the payer's cardholder statement.
Note that your acquirer may require you to register with the card scheme(s) before allowing you to submit sub-merchant details with a transaction.
This data must be on the initial transaction of an order, subsequent transactions with sub-merchant will be rejected.
Fixed value
order.subMerchant.address = CONDITIONAL
The sub-merchant's address.
Fixed value
order.subMerchant.address.city String = CONDITIONAL
The city portion of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.subMerchant.address.company String = CONDITIONAL
The name of the company associated with this address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.subMerchant.address.country Upper case alphabetic text = CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
order.subMerchant.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
The post code or zip code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
XSD type
string
minimum length
1
maximum length
10
order.subMerchant.address.stateProvince String = CONDITIONAL
The state or province of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
order.subMerchant.address.street String = CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.subMerchant.address.street2 String = CONDITIONAL
The second line of the address (if provided).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.subMerchant.bankIndustryCode Digits = CONDITIONAL
Code used by acquirer to describe the business or industry the sub-merchant operates in.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
4
maximum length
4
order.subMerchant.email Email = CONDITIONAL
The sub-merchant's email address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
XSD type
string
order.subMerchant.identifier String = CONDITIONAL
Your identifier for the sub-merchant.
You can use this identifier in searches and reports in the gateway.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.subMerchant.phone String = CONDITIONAL
The sub-merchant's phone number
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
order.subMerchant.registeredName String = CONDITIONAL
The legal name of the sub-merchant.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.subMerchant.tradingName String = CONDITIONAL
The trading name of the sub merchant, also known as doing business as (DBA), operating as or trading as.
For MasterCard transactions the name must not exceed 21 characters.
For American Express transactions the name must not exceed 27 characters (or 36 characters including the aggregator name).
The trading name may be displayed on the payer's cardholder statement. Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
order.tax[n] = CONDITIONAL
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in order.taxAmount.
Fixed value
order.tax[n].amount Decimal = CONDITIONAL
The tax amount included in this order for the tax type.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
order.tax[n].rate Decimal = CONDITIONAL
The tax rate (percentage) used to determine the tax amount included in this order for the tax type.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
6
order.tax[n].type String = CONDITIONAL
The type of tax included in the order amount.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
order.taxAmount Decimal = CONDITIONAL
The total tax amount for the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.taxRegistrationId String = CONDITIONAL
Your tax registration identifier provided by the Federal/National tax authority (for example, federal tax identification number, ABN).
If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Harmonized Sales Tax (HST) or Goods and Services Tax (GST) collected by the Canada Revenue Agency.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
30
order.taxStatus String = CONDITIONAL
Indicates your tax status for this order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
5
maximum length
20
order.totalAuthorizedAmount Decimal = Always Provided
The amount that has been successfully authorized for this order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.totalCapturedAmount Decimal = Always Provided
The amount that has been successfully captured for this order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.totalRefundedAmount Decimal = Always Provided
The amount that has been successfully refunded for this order.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
order.walletIndicator String = CONDITIONAL
The wallet indicator as returned by the wallet provider.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
3
maximum length
3
order.walletProvider Enumeration = CONDITIONAL
The wallet provider used to collect the customer's payment details used for this transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
MASTERPASS_ONLINE
MasterPass Online wallet provider.
partnerSolutionId String = CONDITIONAL
If, when integrating with the gateway, you are using a solution (e.g. a shopping cart or e-commerce solution) provided, supported or certified by your payment service provider, enter the solution ID issued by your payment service provider here.
If your payment service provider has not provided you with a solution ID, you should ignore this field.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
paymentPlan = CONDITIONAL
Information about the payment plan selected by the cardholder.
Fixed value
paymentPlan.finalAmount Decimal = Always Provided
The total amount payable by the cardholder, including interest for this plan.
The amount is expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents. This field is returned only when plan type is AMEX_PlanAmex.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
2140000000
minimum value
0.001
maximum post-decimal digits
3
paymentPlan.interestRate Decimal = Always Provided
The interest rate applied to the purchase amount for this plan.
This field is returned only when plan type is AMEX_PlanAmex.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
100
minimum value
0
paymentPlan.numberOfDeferrals Integer = Always Provided
The number of months for which the payment is deferred.
Existence
Always Provided
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
0
maximum value
99
paymentPlan.numberOfPayments Integer = Always Provided
The number of monthly payments payable by the cardholder.
Existence
Always Provided
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
99
paymentPlan.paymentAmount Decimal = Always Provided
The value of each monthly payment for the selected plan.
The amount is expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents. This field is returned only when plan type is AMEX_PlanAmex.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
2140000000
minimum value
0.001
maximum post-decimal digits
3
paymentPlan.planId String = Always Provided
The identifier for the payment plan.
See Payment Plans for the supported payment plans and their identifiers.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
posTerminal = CONDITIONAL
Information about the device used to initiate the transaction at the Point-of-Sale (POS).
Fixed value
posTerminal.address = CONDITIONAL
The address where the POS is located.
For the posTerminal.address.country field - EMV: 9F1A.
Fixed value
posTerminal.address.city String = CONDITIONAL
The city portion of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
posTerminal.address.company String = CONDITIONAL
The name of the company associated with this address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
posTerminal.address.country Upper case alphabetic text = CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
posTerminal.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
The post code or zip code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
XSD type
string
minimum length
1
maximum length
10
posTerminal.address.stateProvince String = CONDITIONAL
The state or province of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
posTerminal.address.street String = CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
posTerminal.address.street2 String = CONDITIONAL
The second line of the address (if provided).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
posTerminal.attended Enumeration = CONDITIONAL
Specifies whether the terminal is attended by the merchant.
You only need to provide this field for card present transactions.
You must provide a value for this field for chip transactions with UK acquirers.
This field corresponds to EMV tag 9F35
You must provide a value for this field for chip transactions with UK acquirers.
This field corresponds to EMV tag 9F35
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ATTENDED
Attended terminal.
SEMI_ATTENDED
Where a card or proximity payment device is present; and the cardholder is present; and the cardholder completes the transaction and, if required, an individual representing the merchant or acquirer assist the cardholder to complete the transaction.
UNATTENDED
Unattended terminal.
UNKNOWN_OR_UNSPECIFIED
Unknown or unspecified.
posTerminal.cardPresenceCapability Enumeration = CONDITIONAL
Indicates the capabilities of the terminal to support card present, card not present or both.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CARD_NOT_PRESENT
Card not present.
CARD_PRESENT
Card present.
CARD_PRESENT_AND_CARD_NOT_PRESENT
Card present and card not present.
posTerminal.inputCapability Enumeration = CONDITIONAL
Indicates the type of input the terminal is capable of receiving.
For example, chip, magnetic stripe read, key entry or contactless.
This field corresponds to EMV tag 9F33
This field corresponds to EMV tag 9F33
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
BARCODE
The terminal supports data input using a barcode reader.
CHIP
Chip read only.
CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE
MSR, chip and key entry.
CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE_AND_RFID
The terminal supports chip read, key entry, magnetic stripe read, and RFID read.
CHIP_AND_MAGNETIC_STRIPE
MSR and chip.
CONTACTLESS_CHIP
Contactless chip.
CONTACTLESS_MAGNETIC_STRIPE
Contactless MSR.
CONTACTLESS_OR_MAGNETIC_STRIPE
The terminal supports both contactless interaction with a chip and magnetic stripe read.
KEY_ENTRY
Key entry only.
KEY_ENTRY_AND_MAGNETIC_STRIPE
MSR and key entry.
MAGNETIC_STRIPE
Magnetic strip read (MSR) only.
UNKNOWN
VOICE_AUDIO_RESPONSE
posTerminal.lane String = CONDITIONAL
The name that you use to uniquely identify the location of the Point Of Sale instance used to initiate the transaction.
Examples could be S43_L12 (Lane 12 in Shop 43) or Kiosk_76. This field can be used for your search or reporting needs, and might be used by fraud management systems.
This field corresponds to EMV tag 9F1C
This field corresponds to EMV tag 9F1C
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
8
posTerminal.location Enumeration = CONDITIONAL
Indicates the physical location of the terminal in relation to your business premises.
If you do not provide a value for this field for a mobile wallet payment the gateway defaults the value to PAYER_TERMINAL_OFF_PREMISES.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
MERCHANT_TERMINAL_OFF_PREMISES
A terminal under the merchant's control but not on the merchant's premises was used.
MERCHANT_TERMINAL_ON_PREMISES
A terminal under the merchant's control on the merchant's premises was used.
NO_TERMINAL_VOICE_OR_AUDIO_RESPONSE
A voice or an audio response system was used, not a physical terminal.
PAYER_TERMINAL_OFF_PREMISES
A terminal under the payer's control and off the merchant's premises was used. For example, a mobile device or personal computer.
PAYER_TERMINAL_ON_PREMISES
A terminal under the payer's control on the merchant's premises was used. For example, a mobile device or personal computer.
posTerminal.onlineReasonCode Enumeration = CONDITIONAL
Indicates the reason for sending a transaction online to the acquirer rather than completing it locally at the terminal.
The online reason code is mandatory for chip and chip fallback transactions (including reversals) for transactions with UK acquirers.
Where more than one reason applies, then the order of priority used for the enumeration list applies.
Where more than one reason applies, then the order of priority used for the enumeration list applies.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CHIP_APPLICATION_DATA_FILE_ERROR
The application data file on the chip was unable to process. The terminal has possession of the card. Only used by integrated ICC/MSR terminals (where the terminal has possession of the card and when this condition can be accurately identified).
CHIP_COMMON_DATA_FILE_ERROR
The application common data file on the chip was unable to process. Only used by integrated ICC/MSR terminals (where the terminal has possession of the card and when this condition can be accurately identified).
FORCED_BY_CHIP
The chip application forced the the transaction to go online.
FORCED_BY_ISSUER
Issuer rules forced the transaction to go online. For example, the card is expired.
FORCED_BY_MERCHANT
Rules in the merchant's POS application forced the transaction to go online. For example, the card was used twice or send one in a certain number of authorizations online.
FORCED_BY_TERMINAL
The terminal forced the transaction to go online. For example, the results of tests the terminal carried out during the EMV process indicated to send the transaction online.
MERCHANT_SUSPICIOUS
The merchant has indicated a suspicious transaction. For example, they indicated an unsuccessful signature check or the card returned an inappropriate cryptogram.
OVER_FLOOR_LIMIT
The transaction amount is above the limit set for local processing of the transaction at the terminal.
RANDOM_SELECTION_BY_TERMINAL
The terminal has randomly selected the transaction for online processing.
UNABLE_TO_PROCESS_CHIP
The terminal is not able to process a chip transaction. The transaction was sent online as a fallback.
posTerminal.panEntryMode Enumeration = CONDITIONAL
Indicates how you or the Payer entered the Primary Account Number (PAN) of the card at the terminal.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
BARCODE_READER
The PAN was entered via a barcode reader.
CHIP
The PAN was entered by reading data from the chip on the card.
CHIP_FALLBACK
A chip-capable terminal failed to process the transaction using data on the card's chip. Therefore, the PAN was read using a fallback mode.
CONTACTLESS
The PAN was entered by a contactless interaction with a chip.
ECOMMERCE
The PAN was entered via an electronic commerce interaction, including chip.
KEYED
The PAN was manually entered.
MOBILE_COMMERCE
OPTICAL_CHARACTER_READER
The PAN was entered via an an optical character reader.
RFID_CHIP
An RFID device was used. Chip data is provided.
RFID_STRIPE
An RFID device was used. Stripe data is provided.
SWIPE
The PAN was read from the magnetic stripe, and the full, unaltered contents of the stripe are provided.
SWIPE_WITH_SIGNATURE
The PAN was read from the magnetic stripe and a signature was provided.
UNKNOWN
The mode of PAN entry is unknown.
VOICE_AUTHORIZATION
VOICE_RESPONSE
The PAN was collected using a Voice Response Unit.
posTerminal.pinEntryCapability Enumeration = CONDITIONAL
Indicates the capability of the terminal to accept entry of the Payer's PIN.
This field corresponds to EMV tag 9F33
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
OFFLINE_PIN_ONLY
Only offline PIN is supported.
PIN_NOT_SUPPORTED
Neither offline nor online PIN is supported.
PIN_PAD_INOPERATIVE
PIN is supported but the POS or Payment Client has determined that it is not operational.
PIN_SUPPORTED
Both offline & online PIN supported.
UNKNOWN
The PIN entry capability is not known.
posTerminal.pinLengthCapability Integer = CONDITIONAL
The maximum number of PIN characters that can be entered at the terminal
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
4
maximum value
12
posTerminal.serialNumber ASCII Text = CONDITIONAL
The unique serial number assigned by the manufacturer to the terminal device.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
1
maximum length
16
response = Always Provided
Fixed value
response.acquirerCode ASCII Text = CONDITIONAL
Value as generated by the acquirer that summarizes the success or otherwise of the proposed operation.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
1
maximum length
100
response.acquirerMessage ASCII Text = CONDITIONAL
The response from the acquirer in the text form.
This field is used in addition to response.acquirerCode for some acquirers where additional information needs to be communicated. For example, contact details to allow the merchant to contact the issuer directly to seek authorisation for the transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
1
maximum length
255
response.cardSecurityCode = CONDITIONAL
Fixed value
response.cardSecurityCode.acquirerCode ASCII Text = CONDITIONAL
The acquirer CSC response code generated by the card issuing institution.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
1
maximum length
100
response.cardSecurityCode.gatewayCode Enumeration = CONDITIONAL
The card security code result generated to indicate whether the data supplied matches the data held by the cardholder's issuing bank.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
MATCH
Valid or matched.
NOT_PRESENT
Merchant indicated CSC not present on card.
NOT_PROCESSED
Not processed.
NOT_SUPPORTED
Card issuer is not registered and/or certified
NO_MATCH
Invalid or not matched.
response.debugInformation String = CONDITIONAL
The container for additional information about a transaction.
Only returned for some errors and is dependent on the merchant's configuration. Returned in error, declined and approved scenarios, but would only be used to trouble shoot issues.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
2064
response.gatewayCode Enumeration = Always Provided
Summary of the success or otherwise of the proposed operation.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ABORTED
Transaction aborted by payer
ACQUIRER_SYSTEM_ERROR
Acquirer system error occurred processing the transaction
APPROVED
Transaction Approved
APPROVED_PENDING_SETTLEMENT
Transaction Approved - pending batch settlement
AUTHENTICATION_FAILED
Payer authentication failed
BLOCKED
Transaction blocked due to Risk or 3D Secure blocking rules
CANCELLED
Transaction cancelled by payer
DECLINED
The requested operation was not successful. For example, a payment was declined by issuer or payer authentication was not able to be successfully completed.
DECLINED_AVS
Transaction declined due to address verification
DECLINED_AVS_CSC
Transaction declined due to address verification and card security code
DECLINED_CSC
Transaction declined due to card security code
DECLINED_DO_NOT_CONTACT
Transaction declined - do not contact issuer
DECLINED_PAYMENT_PLAN
Transaction declined due to payment plan
DEFERRED_TRANSACTION_RECEIVED
Deferred transaction received and awaiting processing
DUPLICATE_BATCH
Transaction declined due to duplicate batch
EXCEEDED_RETRY_LIMIT
Transaction retry limit exceeded
EXPIRED_CARD
Transaction declined due to expired card
INSUFFICIENT_FUNDS
Transaction declined due to insufficient funds
INVALID_CSC
Invalid card security code
LOCK_FAILURE
Order locked - another transaction is in progress for this order
NOT_ENROLLED_3D_SECURE
Card holder is not enrolled in 3D Secure
NOT_SUPPORTED
Transaction type not supported
PARTIALLY_APPROVED
The transaction was approved for a lesser amount than requested. The approved amount is returned in order.totalAuthorizedAmount.
PENDING
Transaction is pending
REFERRED
Transaction declined - refer to issuer
SUBMITTED
The transaction has successfully been created in the gateway. It is either awaiting submission to the acquirer or has been submitted to the acquirer but the gateway has not yet received a response about the success or otherwise of the payment.
SYSTEM_ERROR
Internal system error occurred processing the transaction
TIMED_OUT
The gateway has timed out the request to the acquirer because it did not receive a response. You can handle the transaction as a declined transaction. Where possible the gateway will attempt to reverse the transaction.
UNKNOWN
The transaction has been submitted to the acquirer but the gateway was not able to find out about the success or otherwise of the payment. If the gateway subsequently finds out about the success of the payment it will update the response code.
UNSPECIFIED_FAILURE
Transaction could not be processed
response.recurringPaymentAdvice = CONDITIONAL
Fixed value
response.recurringPaymentAdvice.acquirerCode Digits = CONDITIONAL
This code may be returned by the acquirer for a failed recurring transaction (also known as Merchant Advice Code or Recurring Payment Cancellation).Merchants can use this information to determine the best action to take.
Please refer to Troubleshooting & FAQs - What if my transaction gets declined? for the list of values and their meaning.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
0
maximum length
2
result Enumeration = Always Provided
A system-generated high level overall result of the operation.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown
risk = CONDITIONAL
Information relevant to risk assessment.
Fixed value
risk.custom String = CONDITIONAL
Additional data passed to third-party risk assessment providers.
This field is only relevant if you use a third-party risk assessment provider, and you have agreed with them the values to provide (maximum 100 characters in a field name from the set A-Z, a-z, 0-9, maximum 4kB in length of values across all custom risk fields). An example might be:
Field: risk.custom.headOfficeLocation
Value: London UK
Field: risk.custom.headOfficeLocation
Value: London UK
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
4000
risk.paymentRecipient = CONDITIONAL
Details about the recipient of the payment and the destination account for the payment.
Your acquirer may require you to provide these details if you are a financial institution (Merchant Category Code 6012) submitting a transaction for a person paying off outstanding debts. Otherwise, do not provide these data elements.
Fixed value
risk.paymentRecipient.accountIdentifier String = Always Provided
The account identifier for the payment recipient's account.
For payments into a card account provide the card number. For payments into other accounts (for example a bank account) provide the account number. The value provided will be returned masked in the response.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
risk.paymentRecipient.dateOfBirth Date = Always Provided
The date of birth of the primary payment recipient in yyyy-mm-dd format.
Existence
Always Provided
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
XSD type
string
risk.paymentRecipient.lastName String = Always Provided
Last name of the primary payment recipient.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
risk.paymentRecipient.postcodeZip String = Always Provided
Postcode of the primary payment recipient.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
10
risk.response = CONDITIONAL
Fixed value
risk.response.gatewayCode Enumeration = CONDITIONAL
The overall result of risk assessment returned by the Payment Gateway for each authorization or pay transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ACCEPTED
Order accepted
NOT_CHECKED
Merchant risk rules were not checked and system rules did not reject the Order
REJECTED
Order rejected
REVIEW_REQUIRED
Order marked for review
risk.response.reversalResult Enumeration = CONDITIONAL
The result of order reversal, if this order was rejected after risk review.
The gateway automatically reverses orders that are sent to the acquirer for processing but are rejected after review.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
FAIL
The gateway failed to reverse the order.
NOT_APPLICABLE
The gateway did not attempt to reverse the order because reversal is not possible. For example, the acquirer does not support order reversals.
OKAY
The gateway successfully reversed the order.
risk.response.review = CONDITIONAL
Details of the decision you made, or need to make, when the risk provider has asked to you review this order.
Fixed value
risk.response.review.decision Enumeration = CONDITIONAL
The decision you made after reviewing the risk provider's assessment of this order.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ACCEPTED
The order has been released for processing
NOT_REQUIRED
No review required
PENDING
A decision to release/cancel the order is pending
REJECTED
The order has been cancelled and a reversal transaction was attempted
risk.response.review.decisionReason String = CONDITIONAL
The reason you selected when you reviewed this order in the external risk provider's system and decided to accept or reject the order.
This field is set to "MANUAL_OVERRIDE" if you chose to override the risk provider's decision to reject the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
risk.response.review.note String = CONDITIONAL
A note that your entered in the external risk provider's system when you reviewed this order and decided to accept or reject the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
2000
risk.response.review.timeOfDecision DateTime = CONDITIONAL
The date and time you made the decision to accept or reject the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
XSD type
string
risk.response.review.userId String = CONDITIONAL
The person who reviewed this order and made the decision to accept or reject the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
risk.response.rule[n] = CONDITIONAL
Details of the rules used by the risk provider to assess the risk of this order being fraudulent.
Fixed value
risk.response.rule[n].data String = CONDITIONAL
The data the risk rule uses for risk assessment.
For example, if a rule blocks BIN ranges, then BIN number is the data for the rule.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
255
risk.response.rule[n].id String = CONDITIONAL
The unique identifier for this risk rule provided by the external risk provider.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
32
risk.response.rule[n].name String = CONDITIONAL
The name of the risk rule.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
risk.response.rule[n].recommendation Enumeration = CONDITIONAL
The recommendation made by the risk provider after applying this rule.
Existence
CONDITIONAL
Fixed value
Validation Rules
The result for the specific risk rule when performed against this order
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ACCEPT
Based on this rule, the risk provider recommends proceeding with this order.
NO_ACTION
Based on this rule, the risk provider does not provide a recommendation to accept or reject this order.
REJECT
Based on this rule, the risk provider recommends that this order is rejected.
REVIEW
Based on this rule, the risk provider recommends that you review this order.
risk.response.rule[n].score Integer = CONDITIONAL
The external risk provider's risk assessment score for this order based on this risk rule.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
risk.response.rule[n].type Enumeration = CONDITIONAL
The source of this risk rule.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ERROR
The gateway was unable to connect to the external risk provider.
EXTERNAL_RULE
The risk rule has been defined in the external risk provider's system.
MERCHANT_RULE
The risk rule has been defined in the gateway by the Merchant.
MSO_RULE
The risk rule has been defined in the gateway by the MSO.
risk.response.totalScore Integer = CONDITIONAL
The total of the risk scores for all risk rules applied by the external risk provider when assessing the risk of this order being fraudulent.
The higher the score, the higher the fraud risk.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
shipping = CONDITIONAL
Information on the shipping address including the contact details of the addressee.
Fixed value
shipping.address = CONDITIONAL
The address to which the goods contained in this order are being shipped.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
shipping.address.city String = CONDITIONAL
The city portion of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
shipping.address.company String = CONDITIONAL
The name of the company associated with this address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
shipping.address.country Upper case alphabetic text = CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
shipping.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
The post code or zip code of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
XSD type
string
minimum length
1
maximum length
10
shipping.address.stateProvince String = CONDITIONAL
The state or province of the address.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
shipping.address.street String = CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
shipping.address.street2 String = CONDITIONAL
The second line of the address (if provided).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
shipping.contact = CONDITIONAL
Details of the contact person at the address the goods will be shipped to.
Fixed value
shipping.contact.email Email = CONDITIONAL
The contact person's email address.
The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
XSD type
string
shipping.contact.firstName String = CONDITIONAL
The first name of the person to whom the order is being shipped.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
shipping.contact.lastName String = CONDITIONAL
The last name or surname of the person to whom the order is being shipped.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
shipping.contact.mobilePhone String = CONDITIONAL
The contact person's mobile phone or cell phone number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
shipping.contact.phone String = CONDITIONAL
The phone number of the person to whom the order is being shipped.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
shipping.method Enumeration = CONDITIONAL
The shipping method code to indicate the time frame and the priority of the order.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ELECTRONIC
Electronic delivery.
GROUND
Ground (4 or more days).
OVERNIGHT
Overnight (next day).
PRIORITY
Priority (2-3 days).
SAME_DAY
Same day.
shipping.origin.postcodeZip Alphanumeric + additional characters = CONDITIONAL
The post code or zip code of the address the order is shipped from.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
XSD type
string
minimum length
1
maximum length
10
sourceOfFunds = CONDITIONAL
Information about the payment type selected by the payer for this payment and the source of the funds.
Depending on the payment type the source of the funds can be a debit or credit card, bank account, or account with a browser payment provider (such as PayPal).
For card payments the source of funds information may be represented by combining one or more of the following: explicitly provided card details, a session identifier which the gateway will use to look up the card details and/or a card token. Precedence rules will be applied in that explicitly provided card details will override session card details which will override card token details. Each of these may represent partial card details, however the combination must result in a full and complete set of card details. See Using Multiple Sources of Card Details for examples.
For card payments the source of funds information may be represented by combining one or more of the following: explicitly provided card details, a session identifier which the gateway will use to look up the card details and/or a card token. Precedence rules will be applied in that explicitly provided card details will override session card details which will override card token details. Each of these may represent partial card details, however the combination must result in a full and complete set of card details. See Using Multiple Sources of Card Details for examples.
Fixed value
sourceOfFunds.provided = CONDITIONAL
Information about the source of funds when it is directly provided (as opposed to via a token or session).
For browser payments, the source of funds details are usually collected from the payer on the payment provider's website and provided to you when you retrieve the transaction details (for a successful transaction). However, for some payment types (such as giropay), you must collect the information from the payer and supply it here.
Fixed value
sourceOfFunds.provided.ach = CONDITIONAL
For ACH payments, the details about the payers bank account used for the payment as well as the type of ACH payment are provided in this parameter group.
Fixed value
sourceOfFunds.provided.ach.accountType Enumeration = CONDITIONAL
An indicator identifying the type of bank account.
- Consumer (checking or savings), or
- Business
For pre-arranged payments (sourceOfFunds.provided.ach.secCode=PPD) retrieve this information from the payer.
If payments were telephone-initiated (sourceOfFunds.provided.ach.secCode=TEL) or internet-initiated (sourceOfFunds.provided.ach.secCode=WEB) you may choose to limit the payer's options (e.g. only support consumer checking accounts), depending on your type of business (e.g. B2C online webshop).
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CONSUMER_CHECKING
Consumer Checking Account
CONSUMER_SAVINGS
Consumer Savings Account
CORPORATE_CHECKING
Business Checking Account
sourceOfFunds.provided.ach.bankAccountHolder String = CONDITIONAL
The name of the bank account holder, as it appears on the account at the receiving financial institution.
Retrieve this information from the payer.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
28
sourceOfFunds.provided.ach.bankAccountNumber Alphanumeric + additional characters = CONDITIONAL
By default, the bank account number will be returned in a masked format, for example, xxxxxxxxxx0000.
If you wish to return unmasked bank account numbers, you must have the requisite permission, set the responseControls.sensitiveData field to UNMASK, and authenticate your call to the API using certificate authentication.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-', '/'
XSD type
string
minimum length
1
maximum length
17
sourceOfFunds.provided.ach.routingNumber Digits = CONDITIONAL
The identifier of the receiving financial institution.
Also known as:
- Routing number,
- Transit number, or
- ABA number
Retrieve this information from the payer.
See also http://en.wikipedia.org/wiki/Routing_transit_number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
9
maximum length
9
sourceOfFunds.provided.ach.secCode Enumeration = CONDITIONAL
Identifies the Standard Entry Class (SEC) code to be sent to the issuer.
The SEC is defined by NACHA and describes the origin and intent of the payment. For details please refer to https://www.nacha.org/.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
PPD
An ACH debit or credit payment (B2C) that has been authorized by an authenticated customer in written form (signed or similarly authenticated). PPD is used for pre-arranged payments (e.g. employee payroll, mortgage payments, expense reimbursement).
TEL
An ACH debit payment (B2C) that has been authorized by an authenticated customer via phone.
TEL may only be used if a relationship already exists between you and the consumer, or, the consumer initiates the contact with you.
WEB
An ACH debit payment (B2C) that has been authorized by an authenticated customer via the internet or a wireless network.
sourceOfFunds.provided.card = CONDITIONAL
Details as shown on the card.
Fixed value
sourceOfFunds.provided.card.accountType Enumeration = CONDITIONAL
You can provide this field for card types that have a savings/checking option, such as Maestro cards.
If you do not provide a value, we will use the acquirer's default. You can use paymentTypes.card.cardTypes in the 'Retrieve Payment Options' operation response to determine the card type.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CHECKING
SAVINGS
sourceOfFunds.provided.card.brand Enumeration = Always Provided
The brand name used to describe the card that is recognized and accepted globally.
For many major card types this will match the scheme name. In some markets, a card may also be co-branded with a local brand that is recognized and accepted within its country/region of origin (see card.localBrand).
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
MAESTRO
Maestro
MASTERCARD
MasterCard
UATP
UATP (Universal Air Travel Plan)
UNKNOWN
The brand of the card used in the transaction could not be identified
VISA
Visa
sourceOfFunds.provided.card.deviceSpecificExpiry = CONDITIONAL
The expiry date of the device specific account number associated with a mobile device used for payment.
Fixed value
sourceOfFunds.provided.card.deviceSpecificExpiry.month Digits = Always Provided
Month from the expiry date of the device specific account number.
Months are numbered January=1, through to December=12.
Existence
Always Provided
Fixed value
Validation Rules
Data is a number between 1 and 12 represented as a string.
XSD type
string
sourceOfFunds.provided.card.deviceSpecificExpiry.year Digits = Always Provided
Year from the expiry date of the device specific account number.
The Common Era year is 2000 plus this value.
Existence
Always Provided
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
2
maximum length
2
sourceOfFunds.provided.card.deviceSpecificNumber Masked digits = Always Provided
The payer's account number associated with a mobile device used for the payment when the payment is made from a device(for example, using Apple Pay, Samsung Pay, or Android Pay).This is also known as the Device Primary Account Number (DPAN).
Existence
Always Provided
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9, plus 'x' for masking
XSD type
string
minimum length
9
maximum length
19
sourceOfFunds.provided.card.emvRequest String = CONDITIONAL
This field only applies to transactions that originate from an EMV capable terminal.
It contains selected EMV fields as provided by the terminal.
For the list of field tags to include (if provided by the terminal), see Card Present Payments. Requests with any other tags are rejected by the gateway.
Some of the tags represent data that can occur on explicit fields in this API. You can submit the value either in this field, or in both places. For example, the PAN can be presented as EMV tag 5A in this field, or included both the sourceOfFunds.provided.card.number API field and in EMV tag 5A in this field.
If you specify the EMV tag only, we can populate the explicit field in the API. Fields where this is supported have the text "This field corresponds to EMV tag <tag name>" in their field descriptions.
If you specify both places, there will be no population of the explicit field or validation that the data matches.
The API response will not contain PCI sensitive fields.
For the list of field tags to include (if provided by the terminal), see Card Present Payments. Requests with any other tags are rejected by the gateway.
Some of the tags represent data that can occur on explicit fields in this API. You can submit the value either in this field, or in both places. For example, the PAN can be presented as EMV tag 5A in this field, or included both the sourceOfFunds.provided.card.number API field and in EMV tag 5A in this field.
If you specify the EMV tag only, we can populate the explicit field in the API. Fields where this is supported have the text "This field corresponds to EMV tag <tag name>" in their field descriptions.
If you specify both places, there will be no population of the explicit field or validation that the data matches.
The API response will not contain PCI sensitive fields.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
250
sourceOfFunds.provided.card.emvResponse String = CONDITIONAL
This field only applies to transactions that originate from an EMV capable terminal.
It contains the EMV fields returned from the issuer in response to an authorization request for the chip transaction when the transaction was sent online.
The card/terminal uses data returned from the issuer to make the final decision to accept or decline the transaction.
The card/terminal uses data returned from the issuer to make the final decision to accept or decline the transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
250
sourceOfFunds.provided.card.encryption Enumeration = CONDITIONAL
The method of encryption you used for the card number as received by the gateway.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
DUKPT
Derived Unique Key Per Transaction (DUKPT).
sourceOfFunds.provided.card.expiry = CONDITIONAL
Expiry date, as shown on the card.
This field corresponds to EMV tag 5F24
Fixed value
sourceOfFunds.provided.card.expiry.month Digits = Always Provided
Month, as shown on the card.
Months are numbered January=1, through to December=12.
Existence
Always Provided
Fixed value
Validation Rules
Data is a number between 1 and 12 represented as a string.
XSD type
string
sourceOfFunds.provided.card.expiry.year Digits = Always Provided
Year, as shown on the card.
The Common Era year is 2000 plus this value.
Existence
Always Provided
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
2
maximum length
2
sourceOfFunds.provided.card.fundingMethod Enumeration = Always Provided
The method used by the payer to provide the funds for the payment.
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CHARGE
The payer has a line of credit with the issuer which must be paid off monthly.
CREDIT
The payer has a revolving line of credit with the issuer.
DEBIT
Funds are immediately debited from the payer's account with the issuer.
UNKNOWN
The account funding method could not be determined.
sourceOfFunds.provided.card.issuer String = CONDITIONAL
The issuer of the card, if known.
WARNING: This information may be incorrect or incomplete – use at your own risk.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
0
maximum length
255
sourceOfFunds.provided.card.localBrand String = CONDITIONAL
The brand name used to describe a card that is recognized and accepted within its country/region of origin.
The card may also be co-branded with a brand name that is recognized and accepted globally (see card.brand).
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
3
maximum length
50
sourceOfFunds.provided.card.mobileWallet = CONDITIONAL
If the payer chose to pay using a mobile device you must provide details from the wallet in this parameter group.
Use this parameter group when accepting payments from mobile wallet providers such as Apple Pay, Android Pay or Samsung Pay.
Fixed value
sourceOfFunds.provided.card.mobileWallet.cryptogramFormat Enumeration = Always Provided
The format of the cryptogram provided for the device payment.
You must provide the cryptogram format when you decrypt the payment token and provide the payment details (including the online payment cryptogram) in the transaction request.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
3DSECURE
The payment data keys for the online payment cryptogram are provided using the 3-D Secure format.
EMV
The payment data keys for the online payment cryptogram are provided using the EMV format.
sourceOfFunds.provided.card.nameOnCard String = CONDITIONAL
The cardholder's name as printed on the card.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
256
sourceOfFunds.provided.card.number Masked digits = Always Provided
The account number embossed onto the card.
By default, the card number will be returned in 6.4 masking format, for example, 000000xxxxxx0000.If you wish to return unmasked card numbers, you must have the requisite permission, set responseControls.sensitiveData field to UNMASK, and authenticate your call to the API using certificate authentication.
Existence
Always Provided
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9, plus 'x' for masking
XSD type
string
minimum length
9
maximum length
19
sourceOfFunds.provided.card.pin = CONDITIONAL
The PIN (Personal Identification Number) entered by a payer at the point of sale that is used to authenticate their identity as the cardholder with the issuer.
Provide this data in the case where you want the PIN verified online by the issuer.
The gateway supports PINs encoded in ISO 9564-1 formats 0, 1 and 3.
Fixed value
sourceOfFunds.provided.card.pin.encryptionState Enumeration = CONDITIONAL
The PIN encryption state as determined by the terminal.
INVALID means the terminal detected some form of error in the encryption process.
The gateway will decline transactions with INVALID encryption state. This field may be omitted when the value is VALID.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
INVALID
The encryption state is invalid.
VALID
The encryption state is valid.
sourceOfFunds.provided.card.pin.keySerialNumber Hex = Always Provided
The DUKPT key serial number supplied by the terminal.
Existence
Always Provided
Fixed value
Validation Rules
Data is hexadecimal encoded
XSD type
string
minimum length
20
maximum length
20
sourceOfFunds.provided.card.scheme Enumeration = Always Provided
The organization that owns a card brand and defines operating regulations for its use.
The card scheme also controls authorization and settlement of card transactions among issuers and acquirers.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
MASTERCARD
MasterCard
UATP
UATP (Universal Air Travel Plan)
VISA
Visa
sourceOfFunds.provided.card.sequenceNumber Digits = CONDITIONAL
A number used to differentiate between cards with the same Primary Account Number (PAN).
This field corresponds to EMV tag 5F34
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
3
maximum length
3
sourceOfFunds.provided.card.trackDataProvided Boolean = CONDITIONAL
Indicates whether card track data is provided.
Existence
CONDITIONAL
Fixed value
Validation Rules
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
XSD type
boolean
sourceOfFunds.provided.giftCard = CONDITIONAL
A gift card was used.
The payer's gift card details are provided in this parameter group.
Fixed value
sourceOfFunds.provided.giftCard.brand Enumeration = Always Provided
The brand name used to describe the card that is recognized and accepted globally.
For many major card types this will match the scheme name.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
LOCAL_BRAND_ONLY
The card does not have a global brand.
sourceOfFunds.provided.giftCard.localBrand String = Always Provided
The brand name used to describe a card as determined by the gateway, based on the BIN range of the card.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
sourceOfFunds.provided.giftCard.number Masked digits = Always Provided
Card number as printed or embossed on the gift card.
Existence
Always Provided
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9, plus 'x' for masking
XSD type
string
minimum length
9
maximum length
19
sourceOfFunds.provided.giftCard.pin Masked digits = CONDITIONAL
PIN number for the gift card.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9, plus 'x' for masking
XSD type
string
minimum length
4
maximum length
8
sourceOfFunds.provided.paypal = CONDITIONAL
Information about the payer's PayPal account provided to you only when the payer successfully makes a payment.
Fixed value
sourceOfFunds.provided.paypal.accountEmail Email = CONDITIONAL
The email address of the payer's PayPal account.
Existence
CONDITIONAL
Fixed value
Validation Rules
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
XSD type
string
sourceOfFunds.provided.paypal.accountHolder String = CONDITIONAL
The name of the account holder of the payer's PayPal account.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
255
sourceOfFunds.provided.sofort = CONDITIONAL
For successful payments, provides details about the payer's bank account that was the origin of transfer on the Sofortbanking website.
The format of the bank account details differs per country.
Fixed value
sourceOfFunds.provided.sofort.bankAccountHolder String = CONDITIONAL
The name of the bank account holder for the payer's bank account.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
255
sourceOfFunds.provided.sofort.bankAccountNumber String = CONDITIONAL
The country-specific bank account number for the payer's bank account.
By default, the bank account number will be returned in a masked format, for example, xxxxxx0000. If you wish to return unmasked bank account numbers, you must have the requisite permission, set responseControls.sensitiveData field to UNMASK, and authenticate your call to the API using certificate authentication.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
30
sourceOfFunds.provided.sofort.bankIdentifier String = CONDITIONAL
The country-specific bank identifier for the payer's bank account.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
30
sourceOfFunds.provided.sofort.bic String = CONDITIONAL
The international Business Identifier Code (BIC) for the payer's bank account.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
sourceOfFunds.provided.sofort.country Upper case alphabetic text = CONDITIONAL
The 3 letter ISO standard alpha country code of the payer's bank account.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
sourceOfFunds.provided.sofort.iban String = CONDITIONAL
The International Bank Account Number (IBAN) for the payer's bank account.
By default, the International Bank Account Number will be returned in a masked format, for example, xxxxxx0000. If you wish to return unmasked international bank account numbers, you must have the requisite permission, set responseControls.sensitiveData field to UNMASK, and authenticate your call to the API using certificate authentication.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
sourceOfFunds.token Alphanumeric = CONDITIONAL
A token identifies a payer's card details.
You can create a token using the Save Card operation, and then use the token in place of card details in future operations. For details see How to Configure Tokenization.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data may consist of the characters 0-9, a-z, A-Z
XSD type
string
minimum length
1
maximum length
40
sourceOfFunds.type Enumeration = CONDITIONAL
The payment method your payer has chosen for this payment.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CARD
The payer selected to pay using a credit or debit card. The payer's card details must be provided.
timeOfRecord DateTime = CONDITIONAL
Transaction Date.
The date when the transaction happened.The time the gateway considers the operation to have occurred. The gateway uses timeOfRecord as a point-in-time value for operations such as sorting, billing, and reporting.
Existence
CONDITIONAL
Fixed value
Validation Rules
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
XSD type
string
transaction = Always Provided
Information about this transaction.
Fixed value
transaction.acquirer = Always Provided
Fixed value
transaction.acquirer.additionalResponseData JSON Text = CONDITIONAL
Provides additional data provided by the acquirer in the transaction response that could be of interest to you.
It might provide additional information that may help you understand unexpected results or provide acquirer-specific response data. For example, it could provide information about the results of validation of data by the issuer or card scheme of data you provided for card present transactions. The data is provided as as series of name-value pairs where the name is the acquirer field and the value is exactly as provided by the acquirer. For example, {"48.74.1":3, "48.74.2:5":48, "48.80":67}
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is JSON Text
XSD type
string
minimum length
1
maximum length
4000
transaction.acquirer.batch Integer = CONDITIONAL
The processor's identifier for the settlement batch.
Provided only if the transaction was settled by batch.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
2147483647
transaction.acquirer.customData String = CONDITIONAL
Additional information requested by the acquirer which cannot be passed using other available data fields.
This field must not contain sensitive data.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
4000
transaction.acquirer.date String = CONDITIONAL
The date the transaction was processed, as returned by the acquirer.
Not returned by most acquirers.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
4000
transaction.acquirer.id String = Always Provided
The ID for the acquirer used to process the transaction.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
transaction.acquirer.merchantId String = CONDITIONAL
An identifier allocated by an acquirer to the merchant.
This may also be referred to as the Card Acceptor Identification Code (CAIC), Card Acceptor ID (CAID), or Service Establishment Number (SE Number).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
transaction.acquirer.settlementDate Date = CONDITIONAL
The date the acquirer expects the funds to be transferred to (in the case of payments) or from (in the case of refunds) the merchant's account.
The date is defined in the acquirer's time zone (see transaction.acquirer.timeZone).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
XSD type
string
transaction.acquirer.time String = CONDITIONAL
The time the transaction was processed, as returned by the acquirer.
Not returned by most acquirers.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
4000
transaction.acquirer.timeZone Time Offset = CONDITIONAL
The acquirer's time zone associated with the settlement date for the transaction (see transaction.acquirer.settlementDate).
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 UTC time offset format, +hhmm or -hhmm.
XSD type
string
transaction.acquirer.transactionId String = CONDITIONAL
Identifier used by the acquirer to identify the transaction.
This identifier may be used by the acquirer in settlement reports.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
transaction.amount Decimal = Always Provided
The total amount for the transaction.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
transaction.bancanet = CONDITIONAL
Additional information the gateway requires to initiate a BancaNet browser payment.
Fixed value
transaction.bancanet.merchantPaymentReference String = Always Provided
The payment reference for the payment.
The format depends on your BancaNet Directo account (Servicio Electrónico de Pagos or Concentración de Fondos).
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
62
transaction.bancanet.paymentDueDate Date = CONDITIONAL
The date by when the payer should make the payment.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
XSD type
string
transaction.bancanet.paymentReason String = CONDITIONAL
The reason for the payment, for example, 'Pago de tarjeta', which is displayed to the payer on the BancaNet website.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
transaction.batchName String = CONDITIONAL
The name of the batch that you used to upload this transaction to the gateway.
Provided only if this transaction was submitted via a batch file.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
512
transaction.currency Upper case alphabetic text = Always Provided
The currency of the transaction expressed as an ISO 4217 alpha code, e.g. USD.
Existence
Always Provided
Fixed value
Validation Rules
Data must consist of the characters A-Z
XSD type
string
minimum length
3
maximum length
3
transaction.discountAmount Decimal = CONDITIONAL
The total amount deducted from the transaction amount that would normally apply.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
transaction.frequency Enumeration = CONDITIONAL
Indicates the frequency of the transaction offered to the payer.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
INSTALLMENT
Indicates an installment transaction where the payer authorizes you to deduct multiple payments over an agreed period of time for a single purchase.
RECURRING
Indicates a recurring transaction where the payer authorizes you to automatically debit their accounts for bill or invoice payments.
SINGLE
Indicates a single transaction where a single payment is used to complete the order.
transaction.id String = Always Provided
Unique identifier for this transaction to distinguish it from any other transactions on the order.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
transaction.item[n] = CONDITIONAL
Information about the items the payer purchases with the transaction.
Fixed value
transaction.item[n].brand String = CONDITIONAL
The brand of the item.
For example, Dell.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
transaction.item[n].category String = CONDITIONAL
Your category for the item.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
transaction.item[n].description String = CONDITIONAL
Description for the item with information such as size, color, etc.
For example, 'Color:Red, Size:M'
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
transaction.item[n].detail = CONDITIONAL
Only use this parameter group to provide additional line item details required for a better interchange rate for Purchasing Cards, Business and/or Corporate Cards (Level 3).
Check with your payment service provider if Level 3 data is supported for your acquirer.
Fixed value
transaction.item[n].detail.acquirerCustom JSON Text = CONDITIONAL
Use this field to provide line item details that your acquirer requires you to provide.
Data must be provided in JSON format using the record name and field name (separated by a comma) to identify the value provided. Contact your payment service provider for details about the supported fields including the field definitions.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is valid Json Format
XSD type
string
minimum length
1
maximum length
4000
transaction.item[n].detail.commodityCode Integer = CONDITIONAL
A code describing a commodity or a group of commodities pertaining to goods classification.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
transaction.item[n].detail.unitDiscountRate Decimal = CONDITIONAL
The discount rate (percentage) applied to this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
999999
minimum value
0
maximum post-decimal digits
5
transaction.item[n].detail.unitTax[n] = CONDITIONAL
Information about the taxes per unit.
Fixed value
transaction.item[n].detail.unitTax[n].amount Decimal = CONDITIONAL
The tax amount for the tax type defined in order.item[n].detail.unitTax[m].type for the item.
Note that the tax amount provided must reflect the tax amount applied before a discount was applied.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
transaction.item[n].detail.unitTax[n].rate Decimal = CONDITIONAL
The tax rate (percentage) applied to the item for the tax type defined in order.item[n].detail.unitTax[m].type.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
transaction.item[n].detail.unitTax[n].type String = CONDITIONAL
The tax type for which the amount specified under order.item[n].detail.unitTax[m].amount has been paid for this item.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
transaction.item[n].detail.unitTaxRate Decimal = CONDITIONAL
The tax rate (percentage) of the tax charged for this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
999999
minimum value
0
maximum post-decimal digits
5
transaction.item[n].detail.unitTaxType String = CONDITIONAL
The type of tax charged for this item.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
10
transaction.item[n].detail.unspsc Integer = CONDITIONAL
The United Nations Standard Products and Services Code (UNSPSC) for the item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
transaction.item[n].detail.upc Integer = CONDITIONAL
The Universal Product Code (UPC) for the item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
transaction.item[n].industryCategory Enumeration = CONDITIONAL
Provide the industryCategory to send this line item to your acquirer for specialized processing as industry data.
Such processing might have legal obligations, which are your responsibility. Do not provide an industryCategory, unless you are certain it applies to you, and is accepted by your acquirer.We support the following industry standard processing:US health care processing using the IIAS standard.The supported values for industryCategory are:HEALTHCARE_VISION, HEALTHCARE_DENTAL, HEALTHCARE_PRESCRIPTION, HEALTHCARE_OTHERWe formulate an IIAS message by summing the amounts of all the line items having the same industryCategory. The amount of a line item is:
(order.item.unitPrice + order.item.tax) * order.item.quantity
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
HEALTHCARE_DENTAL
HEALTHCARE_OTHER
HEALTHCARE_PRESCRIPTION
HEALTHCARE_VISION
transaction.item[n].name String = Always Provided
A short name describing the item.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
transaction.item[n].quantity Integer = Always Provided
The quantity of the item.
Existence
Always Provided
Fixed value
Validation Rules
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
XSD type
nonNegativeInteger
minimum value
1
maximum value
9999999999999999
transaction.item[n].sku String = CONDITIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
transaction.item[n].unitDiscountAmount Decimal = CONDITIONAL
The discount amount applied to this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
transaction.item[n].unitOfMeasure String = CONDITIONAL
The unit of measure used for the item quantity.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
10
transaction.item[n].unitPrice Decimal = Always Provided
The cost price for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Existence
Always Provided
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
transaction.item[n].unitTaxAmount Decimal = CONDITIONAL
The tax amount for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total tax amount for this item.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
-1000000000000
maximum post-decimal digits
3
transaction.itemAmount Decimal = CONDITIONAL
The total item amount for this transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
transaction.merchantNote String = CONDITIONAL
Your note about this transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
250
transaction.receipt ASCII Text = CONDITIONAL
A unique reference generated by the acquirer for a specific merchant interaction.
The reference may be used when contacting the acquirer about a specific transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data consists of ASCII characters
XSD type
string
minimum length
1
maximum length
100
transaction.reference String = CONDITIONAL
An optional identifier for this transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
transaction.requestedAmount Decimal = CONDITIONAL
If the transaction was partially approved (response.gatewayCode=PARTIALLY_APPROVED), this field contains the originally requested amount.
The transaction amount (transaction.amount) and order amount (order.amount) are both set to the actually approved amount.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
transaction.shippingAndHandlingAmount Decimal = CONDITIONAL
The total shipping and handling amount for this transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
transaction.source Enumeration = CONDITIONAL
Indicates the source through which you received the transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MOTO
Transaction received by mail or telephone.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.
transaction.targetTransactionId String = CONDITIONAL
The identifier for the transaction you wish to void or refund.
That is the {transactionId} URL field for REST and the transaction.id field for NVP.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
40
transaction.tax[n] = CONDITIONAL
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in transaction.taxAmount.
Fixed value
transaction.tax[n].amount Decimal = CONDITIONAL
The tax amount included in this transaction for the tax type.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
14
transaction.tax[n].rate Decimal = CONDITIONAL
The tax rate (percentage) used to determine the tax amount included in this transaction for the tax type.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
XSD type
string
minimum length
1
maximum length
6
transaction.tax[n].type String = CONDITIONAL
The type of tax included in the transaction amount.
The correct value as used by your acquirer may have to be provided. Contact your payment service provider for details.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
50
transaction.taxAmount Decimal = CONDITIONAL
The total tax amount for the transaction.
You only need to provide this field when you capture or refund part of the order amount. In this case, the amount must not exceed order.taxAmount. If you provide this field when you capture or refund the full amount of the order, then the value provided must match order.taxAmount.
Existence
CONDITIONAL
Fixed value
Validation Rules
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
XSD type
decimal
maximum value
1000000000000
minimum value
0
maximum post-decimal digits
3
transaction.taxStatus String = CONDITIONAL
Indicates your tax status for this transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
5
maximum length
20
transaction.terminal String = CONDITIONAL
The terminal configured at the processor/acquirer used to process the transaction.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
16
transaction.transit = CONDITIONAL
Transit
Fixed value
transaction.transit.fareCollection Enumeration = Always Provided
The Aggregated Transit Fare Collection functionality allows your payers to use their contactless card as both the method of payment as well as their travel ticket.
In this case you will be allowed to aggregate these contactless payments for transit fares within limitations (time periods, amounts) as specified by the card schemes.
Use the field to indicate the purpose of this transaction.
Use the field to indicate the purpose of this transaction.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AGGREGATION_ACROSS_TRIPS
Indicates that an Authorization is made for a fixed amount but that you intend to capture a (yet unknown) amount for more than one transit fare. It allows you to aggregate the transit fares for trips payed for using the same card within the limitations specified by the card schemes. The authorization may not be reversed.
DEBT_RECOVERY
Indicates that this Authorization has been initiated by you to collect an outstanding transit fare. The card schemes place limitations on when and how often you can attempt to clear a transit fare debt.
The Authorization must be a Card Not Present transaction .
Do not use this flag for payments initiated by the payer to pay off fare debts. In this case submit an Authorization without this flag.
transaction.transit.transportationMode Enumeration = Always Provided
Provide the transport mode used by the payer for the first trip when fare collection is aggregated across one or more trips as well as on debt recovery transactions.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CABLE_CAR
Cable Car
COACH
Coach
COMMUTER_TRAIN
Commuter Train
EXPRESS_COMMUTER_TRAIN
Express Commuter Train
FUNICULAR_TRAIN
Funicular Train
HIGH_SPEED_TRAIN
High Speed Train
INTERURBAN_BUS
Interurban Bus
INTER_CITY
Inter City
LIGHT_TRAIN_MASS_TRANSIT
Light Train Mass Transit
LOCOMOTIVE
Locomotive
OTHER
Other
PARA_TRANSIT
Para Transit
PARKING
Parking
POWERED_MOTOR_VEHICLE
Powered Motor Vehicle
REGIONAL_TRAIN
Regional Train
RURAL_BUS
Rural Bus
SELF_DRIVE_VEHICLE
Self Drive Vehicle
TAXI
Taxi
TOLL
Toll
TRAILER
Trailer
TRAIN
Train
URBAN_BUS
Urban Bus
WATER_BORNE_VEHICLE
Water Borne Vehicle
transaction.type Enumeration = Always Provided
Indicates the type of action performed on the order.
Existence
Always Provided
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
AUTHORIZATION
Authorization
AUTHORIZATION_UPDATE
Authorization Update
CAPTURE
Capture
PAYMENT
Payment (Purchase)
REFUND
Refund
REFUND_REQUEST
Refund Request
VERIFICATION
Verification
VOID_AUTHORIZATION
Void Authorization
VOID_CAPTURE
Void Capture
VOID_PAYMENT
Void Payment
VOID_REFUND
Void Refund
userId String = CONDITIONAL
The person who initiated this transaction.
For Merchant Administration, the person is identified by their logon name.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
256
version String = CONDITIONAL
The Web Services API version that you submitted the request in.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
8
error = CONDITIONAL
Information on possible error conditions that may occur while processing an operation using the API.
Fixed value
error.cause Enumeration = CONDITIONAL
Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.
error.explanation String = CONDITIONAL
Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
1000
error.field String = CONDITIONAL
Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
error.supportCode String = CONDITIONAL
Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
100
error.validationType Enumeration = CONDITIONAL
Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.
result Enumeration = CONDITIONAL
A system-generated high level overall result of the operation.
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.