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://eu-gateway.mastercard.com/api/nvp/version/21 |
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
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
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].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].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.customerReference String = CONDITIONAL
Information supplied by the customer.
For example, Frequent Flyer number.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
20
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 address of the payer to whom the order is being billed.
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.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
billing.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
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.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.operation Enumeration = CONDITIONAL
The type of transaction you want to create for this payment.
You can choose between an Authorization and a Payment transaction. For a successful Authorization transaction, you must submit a CAPTURE request to move the funds from the payer's PayPal account to your account.
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.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 which apply to this transaction.
Specify constraints to ensure the transaction conforms to pre-defined criteria. This is useful when your integration does not directly collect all the transaction values. For example, a session based integration or a hosted payment page 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).
Fixed value
currencyConversion.payerAcceptance Enumeration = Always Provided
Status indicating how the payer acted on the DCC offer that you presented on the payment page.
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 presented to them and will pay in their own currency.
DECLINED
The payer declined the DCC offer presented to them and will pay in your transaction currency.
NOT_OFFERED
DCC was not offered to the payer as a rate quote was not available for this transaction.
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
customer = CONDITIONAL
Information associated with the customer's source of transaction.
Fixed value
customer.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
customer.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
customer.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
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.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
customer.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
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.
HOSTED_FORM
The transaction was created via Hosted Form integration.
HOSTED_PAGE
The transaction was created via Hosted Page 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.
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.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. This data may be used to qualify for better interchange rates on corporate purchase card transactions.
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 (for example, the purchase order number).
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
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.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.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.productSKU String = CONDITIONAL
Unique SKU (Stock Keeping Unit) for the single, most expensive product associated with this order.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
15
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.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
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
-1000000000000
maximum post-decimal digits
3
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.
VERIFIED
The card details for this order have successfully been verified. No payment has yet been initiated or made.
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
-1000000000000
maximum post-decimal digits
3
order.taxRegistrationId String = CONDITIONAL
Your tax registration identifier provided by the tax authority (for example, federal tax identification number, ABN).
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
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.
VISA_CHECKOUT
Visa Checkout 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
Fixed value
posTerminal.attended Enumeration = CONDITIONAL
Indicates if the terminal has been attended by the merchant.
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.
UNATTENDED
Unattended terminal.
UNKNOWN_OR_UNSPECIFIED
Unknown or unspecified.
posTerminal.cardholderActivated Enumeration = CONDITIONAL
Indicates if the terminal is activated by the cardholder.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
NOT_CARDHOLDER_ACTIVATED
Terminal is not activated by the cardholder.
SELF_SERVICE_TERMINAL
Terminal is self serviced.
posTerminal.entryMode Digits = CONDITIONAL
Indicates the entry mode the cardholder/merchant used to enter the PAN and PIN details of the card.
The first two digits indicate the PAN entry mode and the last digit indicates the PIN entry mode. For example, 011 may indicate manual PAN entry (01) with PIN entry on the terminal (1).
PAN ENTRY Mode
01 - Manual Entry
02 - Magnetic stripe read, but full unaltered contents not provided
04 - OCR/MICR coding read
05 - PAN auto entry via chip
07 - Auto-entry via contactless magnetic chip
79 - Chip card at chip-capable terminal was unable to process transaction using data on the chip or magnetic stripe on the card-therefore, PAN entry via manual entry
80 - Chip card at chip-capable terminal was unable to process transaction using data on the chip therefore; the terminal defaulted to the magnetic stripe read for the PAN. This is referred to as fallback.
90 - Magnetic stripe read and full, unaltered contents provided
91 - Auto-entry via contactless magnetic strip
PIN Entry Mode
0 - Unspecified or unknown
1 - Terminal has PIN entry capability
2 - Terminal does not have PIN entry capability (default)
8 - Terminal has PIN entry capability but PIN pad is not currently operative
PAN ENTRY Mode
01 - Manual Entry
02 - Magnetic stripe read, but full unaltered contents not provided
04 - OCR/MICR coding read
05 - PAN auto entry via chip
07 - Auto-entry via contactless magnetic chip
79 - Chip card at chip-capable terminal was unable to process transaction using data on the chip or magnetic stripe on the card-therefore, PAN entry via manual entry
80 - Chip card at chip-capable terminal was unable to process transaction using data on the chip therefore; the terminal defaulted to the magnetic stripe read for the PAN. This is referred to as fallback.
90 - Magnetic stripe read and full, unaltered contents provided
91 - Auto-entry via contactless magnetic strip
PIN Entry Mode
0 - Unspecified or unknown
1 - Terminal has PIN entry capability
2 - Terminal does not have PIN entry capability (default)
8 - Terminal has PIN entry capability but PIN pad is not currently operative
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
posTerminal.inputCapability Enumeration = CONDITIONAL
Indicates the type of input the terminal is capable of receiving.
Inputs include Magnetic strip read (MSR) key entry, chip, contactless MSR/chip, etc.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
CHIP
Chip read only.
CHIP_AND_KEY_ENTRY_AND_MAGNETIC_STRIPE
MSR, chip and key entry.
CHIP_AND_MAGNETIC_STRIPE
MSR and chip.
CONTACTLESS_CHIP
Contactless chip.
CONTACTLESS_MAGNETIC_STRIPE
Contactless MSR.
KEY_ENTRY
Key entry only.
KEY_ENTRY_AND_MAGNETIC_STRIPE
MSR and key entry.
MAGNETIC_STRIPE
Magnetic strip read (MSR) only.
posTerminal.location Enumeration = CONDITIONAL
Indicates the physical location of the terminal in relation to the card acceptor facility.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
OFF_CARD_ACCEPTOR_PREMISES
Off premises of card acceptor.
ON_CARD_ACCEPTOR_PREMISES
On premises of card acceptor.
posTerminal.name String = Always Provided
The name that you use to identify the Point Of Sale instance.
This should uniquely identify one POS within your business. Examples could be S43_L12 (Lane 12 in Shop 43) or Kiosk_76. This fields can be used for your search or reporting needs, and might be used by risk processing systems.
Existence
Always Provided
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
8
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.cardholderVerification = CONDITIONAL
Fixed value
response.cardholderVerification.avs = CONDITIONAL
The result returned after the billing address provided by the cardholder has been compared with the address held at the cardholder's issuing bank.
Fixed value
response.cardholderVerification.avs.acquirerCode ASCII Text = CONDITIONAL
The acquirer AVS 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.cardholderVerification.avs.gatewayCode Enumeration = CONDITIONAL
The address verification result generated to indicate whether the address 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.
ADDRESS_MATCH
Street address matched
ADDRESS_ZIP_MATCH
Street address and zip/postcode were matched
NAME_ADDRESS_MATCH
Card holder name and street address matched
NAME_MATCH
Card holder name matched
NAME_ZIP_MATCH
Card holder name and zip/postcode matched
NOT_AVAILABLE
No data available from issuer or AVS data not supported for transaction
NOT_REQUESTED
AVS not requested
NOT_VERIFIED
AVS could not be verified for an international transaction
NO_MATCH
No match
SERVICE_NOT_AVAILABLE_RETRY
Issuer system is unavailable. Retry can be attempted
SERVICE_NOT_SUPPORTED
Service currently not supported by acquirer or merchant
ZIP_MATCH
Zip/postcode matched. Street address not matched
response.cardholderVerification.detailedVerification[n] = CONDITIONAL
Results of the additional verification checks where an acquirer offers advanced cardholder verification and the data has been supplied in the Verify request.
Fixed value
response.cardholderVerification.detailedVerification[n].gatewayCode Enumeration = CONDITIONAL
The result returned after the specified data type has been verified by the acquirer.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
MATCHED
Data provided by cardholder matches record held by the cardholder's issuing bank.
NOT_CHECKED
Unable to perform verification checks on data provided.
NOT_MATCHED
Data provided by cardholder does NOT match record held by the cardholder's issuing bank.
NOT_PROVIDED
Verification could not be performed as data not provided.
SERVICE_NOT_AVAILABLE_RETRY
Issuer system is unavailable. Retry can be attempted
SERVICE_NOT_SUPPORTED
Service currently not supported by acquirer or merchant
response.cardholderVerification.detailedVerification[n].type Enumeration = CONDITIONAL
The data type which has been verified by the acquirer.
Existence
CONDITIONAL
Fixed value
Validation Rules
XSD type
string
Value must be a member of the following list. The values are case sensitive.
BILLING_PHONE
The phone number of the person that the bill is being sent to.
BILLING_POSTCODE_ZIP
The Postal/Zip code of the billing address.
BILLING_STREET_ADDRESS
The street name and number of the billing address.
CARDHOLDER_NAME
The full name of the cardholder.
CUSTOMER_EMAIL
The email address of the customer.
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
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.risk = CONDITIONAL
Fixed value
response.risk.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
response.risk.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.
response.risk.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
response.risk.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
response.risk.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
response.risk.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
response.risk.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
response.risk.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
response.risk.rule[n] = CONDITIONAL
Details of the rules used by the risk provider to assess the risk of this order being fraudulent.
Fixed value
response.risk.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
response.risk.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
response.risk.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
response.risk.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.
response.risk.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
response.risk.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.
response.risk.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
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
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.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.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.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.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.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
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.card = CONDITIONAL
Details as shown on the card.
Fixed value
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.
AMEX
American Express
CHINA_UNIONPAY
China UnionPay
DINERS_CLUB
Diners Club
DISCOVER
Discover
JCB
JCB (Japan Credit Bureau)
LOCAL_BRAND_ONLY
The card does not have a global brand.
MAESTRO
Maestro
MASTERCARD
MasterCard
RUPAY
RuPay
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.expiry = CONDITIONAL
Expiry date, as shown on the card.
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.holder = CONDITIONAL
The payer's name, to whom the bill is being sent.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
Fixed value
sourceOfFunds.provided.card.holder.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
sourceOfFunds.provided.card.holder.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
sourceOfFunds.provided.card.localBrand Enumeration = 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
XSD type
string
Value must be a member of the following list. The values are case sensitive.
BANAMEX_COSTCO
Banamex Costco (Mexico)
BANKAXEPT
BankAxept (Norway)
CARNET
Carnet (Mexico)
CARTE_BANCAIRE
Carte Bancaire (France)
COSTCO_MEMBER_CREDIT
Costco Member Credit
EBT
Electronic Benefit Transfer (USA)
EFTPOS
Eftpos(Aus)
ELO
Elo (Brazil)
FARMERS
Farmers Card (New Zealand)
GIROCARD_JCB
Girocard (JCB)
GIROCARD_MAESTRO
Girocard (Maestro)
GIROCARD_VISA
Girocard (Visa)
LASER
Laser (Ireland)
OTHER
Other local card brand
PAGOBANCOMAT
PagoBANCOMAT (Italy)
Q_CARD
Q Card (New Zealand)
SORIANA
Soriana (Mexico)
TRUE_REWARDS
True Rewards (New Zealand)
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.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.
AMEX
American Express
CHINA_UNIONPAY
China UnionPay
DINERS_CLUB
Diners Club
DISCOVER
Discover
JCB
JCB (Japan Credit Bureau)
MASTERCARD
MasterCard
OTHER
The scheme of the card used in the transaction could not be identified.
RUPAY
RuPay
UATP
UATP (Universal Air Travel Plan)
VISA
Visa
sourceOfFunds.provided.card.securityCodePresence Alphanumeric = CONDITIONAL
The code used to indicate the existence of the Card Security Code value.
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
2
sourceOfFunds.provided.card.sequenceNumber Digits = CONDITIONAL
The card sequence number for transactions where the data is read through a chip on the EMV card.
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.giropay = CONDITIONAL
The additional details required to initiate a giropay browser payment.
Fixed value
sourceOfFunds.provided.giropay.bankIdentifier Digits = Always Provided
The German bank identifier (Bankleitzahl) for the payer's bank account.
Existence
Always Provided
Fixed value
Validation Rules
Data is a string that consists of the characters 0-9.
XSD type
string
minimum length
8
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.
GIROPAY
The payer selected the payment method giropay.
PAYPAL
The payer selected the payment method PayPal.
SOFORT
The payer selected the payment method Sofortbanking.
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.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
The Acquirer Merchant Identifier (also known as Card Acceptor Identification Code (CAIC)) is an identifier allocated to you by your acquirer.
Existence
CONDITIONAL
Fixed value
Validation Rules
Data can consist of any characters
XSD type
string
minimum length
1
maximum length
127
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.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.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.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
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.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].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].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].unitPrice Decimal = Always Provided
The cost price for the item.
This amount is multiplied with the item.quantity to determine the total amount for 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 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.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.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.taxAmount Decimal = CONDITIONAL
The amount of tax included in this transaction, if different to the default value.
The default value for a full capture is the Order.taxAmount. The default value for a full refund is the total tax captured on the order. 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 data may be used to qualify for better interchange rates on corporate purchase card transactions.
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.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.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
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.