The result of the request transaction.
Examples:
StoredValueRedeem - Fail means the redemption did not occur.
CreditCardAuth - Fail means the authorization did not occur.
For credit cards more information is returned in Auth, AVS and CSC ResponseCodes.
Timeout means the service timed out waiting for a response from the authorizer.
Depending on your company's business rules, you may want to accept an order
where the ResponseCode is Timeout for a credit card authorization so as not to lose the order.
The authorization can be attempted by the OMS before processing the order.
In the case of a StoredValue, you would never accept an order unless the redeem was successful.
Codes defining reasons for authorization declines.
Bank specific authorization response codes are mapped to a canonical set of codes.
The canonical codes will be returned in this field.
The enumeration of the canonical codes and their descriptions will be documented separately.
Amount field for requests and responses.
Will contain the currency of the transaction.
The code that represents the type of currency being used for a
transaction.Currency codes are defined by ISO 4217:2008 See:
http://en.wikipedia.org/wiki/ISO_4217
Allowable Values: IS-4217 three-letter code.
Required: Only when a transaction amount is specified..
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A
Amount field for requests and responses.
Will contain the currency of the transaction.
The code that represents the type of currency being used for a
transaction.Currency codes are defined by ISO 4217:2008 See:
http://en.wikipedia.org/wiki/ISO_4217
Allowable Values: IS-4217 three-letter code.
Required: Only when a transaction amount is specified..
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A
The personal identification number or code associated with a gift card or gift certificate.
Allowable Values: Text string.
Required: Yes
Length: 1-8
Default Value: blank
Restrictions: N/A
Aliases: N/A
The card security code is the number on the back of the credit card
that is normally required for authorizations.
Fields that are encrypted via client-side encryption. Ex: PAN, CVV, PIN
Global type to cover Payment Account Numbers (PAN) Examples include: credit
card numbers, gift card numbers, bank account numbers.
Credit cards and gift cards are typically length 14-19. Bank Account numbers have a much higher range of
lengths, up to 30 digits in Europe.
Either a raw PAN or a token representing a PAN. The type includes an attribute, isToken, to indicate if
the PAN is tokenized.
Allowable Values: Text string
Required: No
Length: 22
Default Value: blank
Restrictions: N/A
Aliases: N/A
Indicates if the Payment Account Number (PAN) is the actual number, or a
representation of the number.
Allowable Values:
False - PAN is actual account number
True - PAN is tokenized account number
Required: Yes
Length: 1
Default Value: blank
Restrictions: N/A
Aliases: N/A
Masked pan ending with last four digits
This element identifies the tender type.
Example values:
Credit card: VC (Visa), MC (Master Card), AM (American Express)
Stred Value:
Stored Value tender type codes are provider specific (i.e Blackhawk, SVS, etc.)
Example: BH (Blackhawk), SP (SVS), OGC (GSI Online Gift Certificate)
Tender type Description
This value is passed through from the Order Management System. It is returned
from a PayPal Get.
Allowable values: text string
Required: No
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A
This value is passed through from the Order Management System. It is returned
from a PayPal Get.
Allowable values: text string
Required: No
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A
This value is passed through from the Order Management System. It is returned
from a PayPal Get.
Allowable values: text string
Required: No
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A
This will be set to true if the customer ultimately was approved for
and chose to make payment using their approved installment credit.
Allowable values: boolean
Required: No
Length: 64
Default Value: false
Restrictions: N/A
Aliases: N/A
Installment fee amount the customer has to pay during the lifetime of the loan.
Indicates the payment term. Example values are 6, 12, 18, and 24 months.
Allowable values: number
Required: No
Length: N/A
Default Value: 0
Restrictions: N/A
Aliases: N/A
Estimated amount per month that the customer will need to pay including fees and interests.
Estimated total payment amount including fees and interests the user will pay during the lifetime of the loan.
3-D Secure is an XML-based protocol designed to be an additional security
layer for online credit and debit card transactions. This type is passed through from VISA.
3DS Version used for authentication. Value to be passed in three component dotted version
notation e.g. 1.0.0, 2.1.0, etc.
Allowable values: text string
VPAS - Verified by VISA e-commerce transactions only.
VER - Verify Enrollment Response from the VER message, returned to the POE from the ACS server
as a result of a Verify Enrollment Request
For all other transactions, enter spaces.
'Y' - Card eligible for authentication processing
'N' - Attempted authentication. Card eligible for attempts liability, but attempts proof is not
available from Issuer.
'U' - Unable to process or card not eligible for attempts.
Required: yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A
This element shows wether the authentication has been done
internally or externally.
Allowable Values: Text string
VPAS - Verified by VISA
UCAF verified by MasterCard Secure Code
For all other transactions, enter spaces.
'Y' - Card eligible for authentication processing
'N' - Attempted authentication. Card eligible for attempts liability, but attempts proof is not
available from Issuer.
'U' - Unable to process or card not eligible for attempts.
Required: No
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A
E-commerce Verified by VISA and MasterCard SecureCode transactions
only. Data returned in authentication request.
Allowable values: For VISA, this field contains CAVV values in upacked, displayable format (0-9,
A-F). For MasterCard, this field contains the UCAF data in upacked, displayable base-64 format
(A-Z, a-z, 0-9, +, /, -). Left justify, space-fill right.
Required: No
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A
E-commerce Verified by VISA transactions only.
XID data returned from authentication request
hex encoded (0-9, A-F).
Allowable values: text string
Required: No
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A
Unique transaction identifier assigned by the Directory Server (DS) to identify a single
transaction. Required for mastercard 2.X transactions.
3-D Secure is an XML-based protocol designed to be an additional security layer
for online credit and debit card transactions. This is the ECI value received from Visa.
Allowable values: text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
The Issuer Bank Access Control Server(ACS) authenticates the
cardholder.
The authentication result is represented by the Payer Authentication Response (PAR) generated by
the Card Issuer ACS.
Allowable values: text string
Required: Yes
Length: 10,000
Default Value: blank
Restrictions: N/A
Aliases: N/A
This value is passed through from the Order Management System. It is
returned from a PayPal Get.
Allowable Values: Text string
Required: No
Length: 1
Default Value: blank
Restrictions: N/A
Aliases: N/A
Total amount for all line items excluding shipping and tax;
calculation works as follows
LineItemsTotal = First-LineItem-Quantity * First-LineItem--Amount + next one;
PayPal validates above calculation and throws error message for incorrect line items total;
LineItemsTotal may be negative for discounted items; note that LineItemsTotal + ShippingTotal + TaxTotal
must be always greater than 0;
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Total shipping amount for all line items.
Total tax amount for all line items.
Count of total shipment and current shipment.
The time at which the order was shipped
Details of the shipment carrier
The name of the carrier e.g. FedEx, UPS, USPS.
The carrier specific shipping service
e.g. "1-Day", "Overnight", "Ground"
The tracking id provided by the courier.
Current shipment number within the order.
Total number of shipments within the order.
The shipping priority.
Line item name like product title.
Allowable Values: Text string
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Descriptive information about the product.
Sequence number of current line item in cart if available.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Represents the identifier for an inventory product. a.k.a. SKU
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Information about tax costs associated with the item.
Information about discounts applied to the item.
Unit price amount for a line item.
Quantity for this line item.
Allowable Values: int
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
The units of the product quantity e.g. piece, pounds, meters.
Unit price amount for a line item.
URL of the product page.
URL of an image of the product.
A general categorization of the product.
The rate used for calculation as a percentage e.g. 7.25.
Total promotion amount for all line items.
Name of the promotion like coupon, discount, promo code, etc
Allowable Values: Text string
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Promotion amount.
Either a raw PAN or a token representing a PAN.
The type includes an attribute, isToken, to indicate if the PAN is tokenized.
Client encrypted pan
A set of values to identify all transactions for a unique payment for a single order
A unique identifier for the order.
The client is responsible for ensuring uniqueness across all transactions the client initiates
with this service.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
This element identifies the tender type.
Example values: VC (Visa), MC (Master Card), OGC (Online Gift Certificate)
SM (Maestro UK), SO (Solo UK)
Gift Cards tender type codes are provider specific (i.e Blackhawk, SVS, etc.)
Example: BH (Blackhawk), SP (SVS)
TenderClass used for API requests like Tender Type Look Up API or Protect Pan API.
NOTE: Use CreditCard tender class type instead of PrivateLabelCreditCard for private label credit card
account numbers;
PrivateLabelCreditCard is treated as CreditCard tender class type and available here for backward
compatibility purpose only.
Actual Payment Account Number (PAN).
Debit - Deduction from an account as payment for goods or sale
Credit - A refund or price adjustment given by a merchant to an account for a previous sale.
Only supplied for VAT stores. Used primarily for open invoice payment methods.
Refers to individual items within an order.
Refers to type of an invoice
Invoice type identification (mainly from OMS).
Relates to SHIPMENT, ORDER, DEBIT_MEMO.
Relates to appeasement. After the items reported on the invoice were shipped, a credit was issued for the items.
Relates to returns. The items reported on the invoice were returned.
Relates to item cancellation. The order on the items were cancelled before the items are shipped.
Relates to credit adjustment. A credit was issued for the items before the items are shipped.
VAT Invoice Number associated with the order.
For open invoice only.
The effective date of the receivable list.
VAT Invoice Date is the date when the VAT Invoice was generated.
For open invoice only.
Used for open invoice CREDIT transaction only.
List of Original VAT Invoice Numbers and dates are passed here.
The sum of payments or credits deducted from the total gross amount, if any.
This can be typically any amount paid/credited through non open invoice payment method.
Used for open invoice CREDIT transaction only.
Original VAT Invoice Number for the order being credited.
Used for open invoice CREDIT transaction only.
Original Reference Date for the order being credited.
For VAT stores. The VAT sub-totals grouped per VAT rate.
An amount of value added tax for a given VAT rate, in the currency of the enclosing context.
Tax identifier used for value added tax purposes.
VAT amount
VAT rate
Specifies how the invoice is dispatched to the recipient.
Represents the identifier for an inventoriable product. a.k.a. SKU
Represents the vendor/client's sku id. Used only in Loyalty Program.
Item quantity
Product description
For VAT stores, this is the vat inclusive price per unit.
Used only for GE Money PLCC/Co-brand settlements
Unique identifier for this line item
A list of Generic Key/Value pair used for partner customizations.
Example use: Loyalty Program
Generic Key/Value pair
Line Item Description (LID) Codes used for GE Money 225 Byte Settlement file for PLCC/Co-Brand.
Use either 4 alpha-numeric chars or 7 digits LID codes for a store.
Example: 0090, 2001 etc
The full set of SettlementStatus values are:
"S" = Settled
"R" = Settlement Refused
Contains the store identifier passed by the client in request URI
Amount to authorize
The AmountType includes a required attribute for a three character ISO currency code.
For existing customer, customer original registration date mm/dd/yyyy.
If not registered or new to the site, use the current date mm/dd/yyyy.
General categorization of the most expensive extended item cost in the shopping basket.
See the Bill Me Later Project Manager for a list of assigned codes.
This is the processor's merchant ID. Assigned by the processor.
Value used for Pricing, Terms, Merchant Settings.
Bill Me Later, Inc defined value.
Sales channel for the transaction
Flag that customer has logged into the merchant site successfully.
true - Customer logged into merchant website.
false - Customer not logged into merchant website.
Indicates if ShipToName = BillToName.
For BMLB, indicates if ShipToName= AdministratorFirstName + AdministratorLastName
true - Information is equal
false - Information is not equal
Should default to FALSE if business rules allow different Ship To from Bill To information
true - Information is equal
false - Information is not equal
The shipping amount is required by BML is the DeliveryMethod = PHY
Used to specify the redirect from the BML hosted application page to the merchant
if the customer chooses to go back to the payment options screen while sitting on a BML hosted
application page.
Used to redirect the customer back to the merchant
if they choose to update their address on a BML hosted application page. Merchant generated.
Allows merchant to customize favicon.
Places the merchant logo on the BML application page.
Maximum logo size is 375px high by 75px high.
The URL of the what-is informational window HTML page/file referenced from the PayCapture
screens.
This will be used by the merchant to specify the informational window when the merchant is
running a special offer .
If not supplied, this URL will default to the URL for standard terms.
Web
Call Center
Retail
Kiosk
Used for reauthorizations (When BackOfficeIndicator is set to true)
Physical
Digital
Cash and Carry
Service
To indicate the sequence of a payment in recurring payments
Allowable Values: String
Required: No
The first instance in the recurrence
A subsequent instance in the recurrence
recurring once only, useful for reattempt
Optional schema version, used to enable additional, non-backwards-compatible elements in
response messages. example values: 1, 2.0, 1.2.3.4
ISO 639 language code
Notes from customer
Reason information for success/failure.
Specifies Vault activation/deactivation status
Specifies Vault Tender selected/not-selected status
Specifies unique vault tender id
Customer billing name
Customer billing address
The field represents an identifier used to indicate how the account number was entered at the POS(point of sale).
Possible Values:
MANUAL - Key Entered
INTEGRATED_CIRCUIT_READ - Reliable
CARD_SWIPED - Magnetic Stripe - Track Read
CONTACTLESS - Contactless Magnetic Stripe Read
Allowable Values: String
Required: Yes
The field represents an identifier used to indicate the Pin capability of the POS.
Possible Values:
PIN - Electronic/PIN authentication
UNSPECIFIED - Not specified
Allowable Values: String
Required: Yes
The field identifies the presence of the person and the card at the point of sale.
Possible Values:
CARDHOLDER_PRESENT_CARD_PRESENT - Cardholder Present, Card Present
CARDHOLDER_PRESENT_STRIPE_UNREADABLE - Cardholder Present, Magnetic Stripe Could Not Be Read
Allowable Values: String
Required: Yes
An identifier used to describe the type of terminal being used for the transaction.
Possible Values:
UNSPECIFIED
ELECTRONIC_PAYMENT_TERMINAL - Electronic Payment Terminal (POS)
UNATTENDED_CUSTOMER_TERMINAL
MOBILE - Mobile POS (mPOS for example a cellphone or tablet device on a cellular network)
Allowable Values: String
Required: Yes
An identifier used to indicate the entry mode capability of the terminal.
Possible Values:
MAGNETIC - Magnetic stripe only
MAGNETIC_KEY - Magnetic stripe and key entry
MAGNETIC_KEY_CHIP - Magnetic stripe, key entry and chip
CONTACTLESS_RFID - Proximity terminal - contactless chip / RFID
CHIP - Chip only
MAGNETIC_CHIP - Chip and magnetic stripe
MANUAL - Manual entry only
CONTACTLESS - Proximity terminal - contactless magnetic stripe
Allowable Values: String
Required: Yes
An identifier for the type of Point Of Sale method used. This is used to mark transaction as being
of a specific method (ie: ApplePay, Samsung Pay, Bitcoin).
Allowable Values: String
Required: No
Response code of the credit card authorization. This includes approval, timeout, and several decline codes.
Please see supporting documentation for a full list of these codes.
Response code of the credit card authorization. This includes approval, timeout, and several decline codes.
Please see supporting documentation for a full list of these codes.
Authorization Code returned by the payment processor upon a successful credit card auth.
Any order taken by the Order Service that is paid for by Credit Card MUST have this authorization code.
Payment Processor Response for CVV2 (Card Verification Value) check.
For most credit cards, you will get an Approval on the AuthorizationResponseCode, even
though CVV2ResponseCode returns a CVV2 failure.
You CANNOT accept an order where CVV2ResponseCode returns a CVV2 failure code.
Please see supporting documentation for a full list of these codes.
Payment Processor Response for the Address Verification System check.
For most credit cards, you will get an Approval on the AuthorizationResponseCode, even
though AVSResponseCode returns an AVS failure code. That said, it is typically considered a significant fraud
risk to accept an order where AVSResponseCode returns an AVS failure code.
Please see supporting documentation for a full list of these codes.
Response code for customer phone number verification (only applies to Amex auths). This data should be
included in the OrderCreateRequest for Orders paid for with Amex to support downstream fraud processing.
Response code for customer name verification (only applies to Amex auths). This data should be
included in the OrderCreateRequest for Orders paid for with Amex to support downstream fraud processing.
Response code for customer email verification (only applies to Amex auths). This data should be
included in the OrderCreateRequest for Orders paid for with Amex to support downstream fraud processing.
The amount authorized by the credit card processor.
Includes a required attribute for a three character ISO currency code.
Profile Tracking Information
Post Office Box (do not pass PO Box as part of the request. e.g. 765)
This is the full displayable State/Province name
Typically a two- or three-digit postal abbreviation for
the state or province. Mainly used in Canada and the US.
This does not necessarily conform to the ISO 3166-2 code.
Two digit ISO country code conforming to ISO 3166 alpha 2.
See: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
Post Office Box (do not pass PO Box as part of the request. e.g. 765)
This is the full displayable State/Province name
Typically a two- or three-digit postal abbreviation for the state or province.
Mainly used in Canada and the US.
This does not necessarily conform to the ISO 3166-2 code.
Two digit ISO country code conforming to ISO 3166 alpha 2.
See: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
The billing name on a card, that is normally required for authorizations.
The transaction is eligible for 3D Secure authentication.
The transaction is not eligible for 3D Secure authentication.
The transaction eligibility could not be determined because of system
unavailability or 3D Secure authentication is otherwise unavailable.
Authentication for the transaction should be bypassed.
The transaction eligibility request could not be processed or resulted in
error due to invalid data in the request or bad request. It may be retried
after the root cause is corrected.
Indicates that the signature of the PARes has been validated successfully
and the message contents can be trusted.
Indicates that the PARes could not be validated. This result could be for a
variety of reasons; tampering, certificate expiration, etc., and the result
should not be trusted.
Alphanumeric ReferenceId used by Cardinal Commerce to uniquely identify a CMPI_LOOKUP Request
OMS that is sending this request..
Sole - Buyer does not need to create a PayPal account to check out. This is referred to as PayPal Account Optional.
Mark - Buyer must have a PayPal account to check out.
The transaction type of the operation.
Tender Types.
This URL will receive the result of an asynchronous payment.
It is required for any asynchronous payment method.
Example: my.app://custom/url
Gender information associated with the order.
Customer phone number
Customer email address
Information about a 3rd party that is facilitating some action.
A unique identifier for third party acting as a payment facilitator.
Reference id element in the gateway response for the initial payment.
The funds available result of confirm funds request.
Examples:
Success - funds available
Fail - funds not available
Pending - funds not available due to pending
Timeout - funds not available due to timeout
Contains the error code and error message.
Type appropriate for a single free form line in an address.
Accepts letters and punctuations separated by a single space without leading or trailing whitespace.
A string that contains at least one non-whitespace character
A UUID string in the format specified by RFC 4122.
Merchants to pass their soft description to be displayed on the shoppers bank statement,
generally business name in short form.
For US and Canada - pass the value without country code.
The phone number should in the below format,
e.g. 2223334444
This object contains the details used by the device for authorization.
A unique identifier for recurring payments.
A unique identifier for a customer such as a username or email address.
The type of 3DSecure authentication to be performed.
An optional element to support 3D secure authentication of different types: redirect and native 3DS2.
The URL which specifies the user to redirect to for performing authentication.
Data should be Base64 encoded.
Payment authorization request which holds the 3D Secure request data for the issuer.
Data should be Base64 encoded.
A payment session identifier returned by the card issuer.
After completing 3D Secure verification on the card issuer site, the shopper is
redirected back to the merchant site. This URL value specifies which merchant site
page the shopper goes back to.
Data should be Base64 encoded.
The returned token value.
Data should be Base64 encoded.