paymentInformation

The following fields provide payment information.

paymentInformation. accountFeatures. accountStatus

Status of the account.
This field is available only on the
Visa Platform Connect
processor.
Possible values:
  • N
    : Nonregulated
  • R
    : Regulated

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.accountStatus
  • SCMP API Field:
    payment_network_token_account_status
  • Simple Order API Field:
    paymentNetworkToken_accountStatus

paymentInformation. accountFeatures. accountType

Type of account.
This field is returned only when you request a balance inquiry.
Authorization
Possible values:
  • 00
    : Does not apply or not specified.
  • 10
    : Savings account.
  • 20
    : Checking account.
  • 30
    : Credit card account.
  • 40
    : Universal account.
PIN Debit
Possible values:
  • 00
    : Does not apply or not specified.
  • 10
    : Savings account.
  • 20
    : Checking account.
  • 40
    : Universal account.
  • 96
    : Cash benefits account.
  • 98
    : Food stamp account.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.accountType
  • SCMP API Fields:
    • auth_account_type
    • pin_debit_purchase_account_type
  • Simple Order API Fields:
    • ccAuthReply_accountType
    • pinDebitPurchaseReply_accountType

paymentInformation. accountFeatures.affluenceIndicator

Flag indicating a customer of high income.
Chase Paymentech Solutions
Flag that indicates whether a customer has a high credit limit.
This field is returned for Visa, Mastercard, Discover, and Diners Club. It enables you to market high cost items to these customers and to understand the kinds of cards that high income customers are using.
Possible values:
  • Y
    : Yes, the customer has a high credit limit.
  • N
    : No, the customer does not have a high credit limit.
  • X
    : Does not apply / Unknown.
Worldpay VAP
Flag that indicates whether a Visa customer or Mastercard customer is in one of the affluent categories.
Possible values:
  • AFFLUENT
    : High income customer with high spending pattern (>100k USD annual income and >40k USD annual card usage).
  • MASS AFFLUENT
    : High income customer (>100k USD annual income).

Specifications

  • Data Type:
    String
  • Data Length:
    • Chase Paymentech Solutions
      : 1
    • Worldpay VAP
      : 13

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.affluenceIndicator
  • SCMP API Field:
    auth_affluence_indicator
  • Simple Order API Field:
    ccAuthReply_affluenceIndicator

paymentInformation. accountFeatures. balanceAmount

Remaining balance on the account or prepaid card.

Specifications

  • Data type:
    String
  • Data Length:
    12

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.balanceAmount
  • SCMP API Fields:
    • auth_account_balance
    • pin_debit_purchase_auth_amount
  • Simple Order API Fields:
    • ccAuthReply_accountBalance
    • pinDebitPurchaseReply_accountBalance

paymentInformation. accountFeatures. balanceAmountType

Type of amount.
This field is returned only when you request a balance inquiry.
The issuer determines the value for this field.
Deposit Accounts
Possible values:
  • 01
    : Current ledger (posted) balance.
  • 02
    : Current available balance, which is typically the ledger balance minus outstanding authorizations. Some depository institutions also include pending deposits and the credit or overdraft line associated with the account.
Credit Card Accounts
Possible values:
  • 01
    : Credit amount remaining for customer (open to buy).
  • 02
    : Credit limit.

Specifications

  • Type:
    String
  • Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.balanceAmountType
  • SCMP API Fields:
    • auth_amount_type
    • pin_debit_purchase_amount_type
  • Simple Order API Fields:
    • ccAuthReply_amountType
    • pinDebitPurchaseReply_amountType

paymentInformation. accountFeatures.balanceSign

Sign for the remaining balance on the account or prepaid card.
This field is returned only when the processor sends this value.
Possible values:
  • positive
  • negative

Specifications

  • Type:
    String
  • Length:
    8

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.balanceSign
  • SCMP API Fields:
    • auth_account_balance_sign
    • pin_debit_purchase_account_balance_sign
  • Simple Order API Fields:
    • ccAuthReply_accountBalanceSign
    • pinDebitPurchaseReply_accountBalanceSign

paymentInformation. accountFeatures.category

Card type category.
GPN
Visa or Mastercard product ID.
Visa Platform Connect
Visa product ID.
RBS WorldPay Atlanta
Type of card used in the transaction. Possible values:
  • B
    : Business card.
  • O
    : Noncommercial card.
  • R
    : Corporate card.
  • S
    : Purchase card.
  • X^
    : Visa B2B Virtual Payments
  • X1
    : Flexible Rate B2B Virtual Program
  • Blank
    : Purchase card not supported.
You must process the new values of
X^
for Visa B2B Virtual Payments and
X1
for Flexible Rate B2B Virtual Program returned in this field by VisaNet when you send the product ID for Virtual Payment products.
Worldpay VAP
Type of card used in the transaction. The only possible value is
PREPAID
, which specifies a prepaid card.
IMPORTANT
Before using this field on
Worldpay VAP
, you must contact customer support to have your account configured for this feature.

Specifications

  • Data Type:
    String
  • Data Length:
    • GPN
      and
      Visa Platform Connect
      : 3
    • RBS WorldPay Atlanta
      : 7

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.category
  • SCMP API Fields:
    • auth_card_category
    • incremental_auth_card_category
    • payment_network_token_original_card_category
  • Simple Order API Fields:
    • ccAuthReply_cardCategory
    • ccIncrementalAuthReply_cardCategory
    • paymentNetworkToken_originalCardCategory

paymentInformation. accountFeatures.commercial

Flag that indicates whether the card is a commercial card.
This field is returned only for Visa and Mastercard payment cards processed by
Chase Paymentech Solutions
.
A commercial card enables you to include Level II data in a request.
Possible values:
  • Y
    : Yes, the card is a commercial card.
  • N
    : No, the card is not a commercial card.
  • X
    : Does not apply / Unknown.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.commercial
  • SCMP API Field:
    auth_card_commercial
  • Simple Order API Field:
    ccAuthReply_cardCommercial

paymentInformation. accountFeatures.currency

Currency of the remaining balance on the account prepaid card.

Specifications

  • Data Type:
    String
  • Data Length:
    5

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.currency
  • SCMP API Fields:
    • auth_account_balance_currency
    • pin_dejava.io.PrintWriter@352af744 bit_purchase_account_balance_currency
  • Simple Order API Fields:
    • ccAuthReply_accountBalanceCurrency
    • pinDebitPurchaseReply_accountBalanceCurrency

paymentInformation. accountFeatures.group

Type of commercial card.
This field is available only for the
Visa Platform Connect
processor.
Possible values:
  • B
    : Business card.
  • R
    : Corporate card.
  • S
    : Purchasing card.
  • 0
    : Noncommercial card.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.group
  • SCMP API Field:
    auth_card_group
  • Simple Order API Field:
    ccAuthReply_cardGroup

paymentInformation. accountFeatures.healthCare

Flag that indicates whether the card is a healthcare card.
This field is available only for Visa and Mastercard payment cards processed by the
Chase Paymentech Solutions
processor.
Possible values:
  • Y
    : Yes, the card is a healthcare card.
  • N
    : No, the card is not a healthcare card.
  • X
    : Does not apply / Unknown.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.healthCare
  • SCMP API Field:
    auth_card_healthcare
  • Simple Order API Field:
    ccAuthReply_cardHealthcare

paymentInformation. accountFeatures.level3Eligible

This field indicates whether the card is eligible for Level III interchange fees. This information enables you to include Level III data in a request.
This field is available only for Visa and Mastercard payment cards processed by the
Chase Paymentech Solutions
processor.
Possible values:
  • Y
    : Yes, the card is eligible for Level III interchange fees.
  • N
    : No, the card is not eligible for Level III interchange fees.
  • X
    : Does not apply / Unknown.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.level3Eligible
  • SCMP API Field:
    auth_card_level_3_eligible
  • Simple Order API Field:
    ccAuthReply_cardLevel3Eligible

paymentInformation. accountFeatures.payRoll

This field indicates whether the card is a payroll card.
This field is available only for Visa, Discover, Diners Club, and JCB payment cards processed by the
Chase Paymentech Solutions
processor.
Possible values:
  • Y
    : Yes, the card is a payroll card.
  • N
    : No, the card is not a payroll card.
  • X
    : Does not apply / Unknown.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.payRoll
  • SCMP API Field:
    auth_card_payroll
  • Simple Order API Field:
    ccAuthReply_cardPayroll

paymentInformation. accountFeatures.pinlessDebit

This field indicates whether the card is supported for PINless debits.
This field is available only for Visa and Mastercard payment cards processed by the
Chase Paymentech Solutions
processor.
Possible values:
  • Y
    : Yes, the card is supported for PINless debits.
  • N
    : No, the card is not supported for PINless debits.
  • X
    : Does not apply / Unknown.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.pinlessDebit
  • SCMP API Field:
    auth_card_pinless_debit
  • Simple Order API Field:
    ccAuthReply_cardPINlessDebit

paymentInformation. accountFeatures.prepaid

This field indicates whether the card is a prepaid card.
This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring, installment, or deferred billing relationship.
Possible values:
  • Y
    : Yes, the card is a prepaid card.
  • N
    : No, the card is not a prepaid card.
  • X
    : Does not apply / Unknown.
This field is available only for Visa, Mastercard, Discover, Diners Club, and JCB payment cards processed by the
Chase Paymentech Solutions
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.prepaid
  • SCMP API Field:
    auth_card_prepaid
  • Simple Order API Field:
    ccAuthReply_cardPrepaid

paymentInformation. accountFeatures.regulated

This field indicates whether the card is regulated according to the Durbin Amendment.
When a card is regulated according to the Durbin Amendment, it means that the issuer has assets that exceed 10B USD and is subject to price caps and interchange rules.
This field is available only for Visa, Mastercard, Discover, Diners Club, and JCB payment cards processed by the
Chase Paymentech Solutions
processor.
Possible values:
  • Y
    : Yes, the card is regulated according to the Durbin Amendment.
  • N
    : No, the card is not regulated according to the Durbin Amendment.
  • X
    : Does not apply / Unknown.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.regulated
  • SCMP API Field:
    auth_card_regulated
  • Simple Order API Field:
    ccAuthReply_cardRegulated

paymentInformation. accountFeatures.signatureDebit

This field indicates whether the card is a signature debit card.
This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might want to perform reversals promptly for a signature debit card.
This field is available only for Visa, Mastercard, and Maestro (International) payment cards processed by the
Chase Paymentech Solutions
processor.
Possible values:
  • Y
    : Yes, the card is a signature debit card.
  • N
    : No, the card is not a signature debit card.
  • X
    : Does not apply / Unknown.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.accountFeatures.signatureDebit
  • SCMP API Field:
    auth_card_signature_debit
  • Simple Order API Field:
    ccAuthReply_cardSignatureDebit

paymentInformation. bank.account. checkNumber

Check number.
Chase Paymentech Solutions
Optional.
Cybersource ACH Service
Not used.
TeleCheck
Strongly recommended on debit requests. Optional on credits.

Specifications

  • Data Type:
    String
  • Data Length:
    8

Mapping Information

  • REST API Field:
    paymentInformation.bank.account.checkNumber
  • SCMP API Field:
    ecp_check_no
  • Simple Order API Field:
    check_checkNumber

paymentInformation.bank.account. checkTransactionCode

Process control transaction code of the check.
This code is included in the stop-payment inquiry. The check must be identified by a check number, but the process control transaction code can also help to identify the check. If a process control transaction code appears on a check, it is part of the MICR line to the right of the On-Us symbol immediately following the bank account number.

Specifications

  • Data Type:
    String
  • Data Length:
    6

Mapping Information

  • REST API Field:
    paymentInformation.bank.account.checkTransactionCode
  • SCMP API Field:
    ecp_check_transaction_code
  • Simple Order API Field:
    check_checkTransactionCode

paymentInformation. bank.account. correctedAccountNumber

Corrected account number from the ACH verification service.

Specifications

  • Data Type:
    String
  • Data Length:
    17

Mapping Information

  • REST API Field:
    paymentInformation.bank.account.correctedAccountNumber
  • SCMP API Field:
    ecp_debit_corrected_account_number
  • Simple Order API Field:
    ecDebitReply_correctedAccountNumber

paymentInformation. bank.account. correctedRoutingnumber

Corrected routing number from the ACH verification service, which is described in ACH Verification.

Specifications

  • Data Type:
    String
  • Data Length:
    9

Mapping Information

  • REST API Field:
    paymentInformation.bank.account.correctedRoutingnumber
  • SCMP API Field:
    ecp_debit_corrected_routing_number
  • Simple Order API Field:
    ecDebitReply_correctedRouting
Number

paymentInformation. bank. account. iban

The International Bank Account Number (IBAN) for the bank account.

Specifications

  • Data Type:
    Alphanumeric
  • Data Length:
    50

Mapping

  • REST Field Name:
    paymentInformation.bank.account.iban
  • Simple Order Field Name:
    fundTransfer_iban

paymentInformation. bank.account. imageReferenceNumber

Image reference number associated with the check.
You cannot include any special characters.

Specifications

  • Data Type:
    String
  • Data Length:
    32

Mapping Information

  • REST API Field:
    paymentInformation.bank.account.imageReferenceNumber
  • SCMP API Field:
    ecp_image_reference_number
  • Simple Order API Fields:
    check_imageReferenceNumber

paymentInformation. bank.accountName

Name used on the bank account.
You can use this field only when scoring a direct debit transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    30

Mapping Information

  • REST API Field:
    paymentInformation.bank.accountName
  • SCMP API Field:
    bank_account_name
  • Simple Order API Field:
    fundTransfer_accountName

paymentInformation. bank.accountNumber

The customer's bank account number.
When processing encoded account numbers, use this field for the encoded account number.
When scoring a direct debit transaction, use this field if you do not or are not allowed to provide the International Bank Account Number (IBAN).
IMPORTANT
Do not include the IBAN or BBAN in this field. Include the IBAN in the
paymentInformation.bank.account.iban
field.

Specifications

  • Data Type:
    Non-negative integer (for e-check transactions); String (for all other transactions)
  • Data Length:
    17 (for e-check transactions); 30 (for all other transactions)

Mapping Information

  • REST API Field:
    paymentInformation.bank.accountNumber
  • SCMP API Fields:
    • bank_account_#
    • ecp_account_#
  • Simple Order API Fields:
    • check_accountNumber
    • fundTransfer_accountNumber

paymentInformation. bank.account.type

Account type.
Possible values:
  • C
    : Checking.
  • G
    : General ledger.
    This value is supported only on
    Wells Fargo ACH
    .
  • S
    : Savings
  • X
    : Corporate checking

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.bank.account.type
  • SCMP API Field:
    ecp-account-type
  • Simple Order API Field:
    check_accountType

paymentInformation. bank.address1

Address of the customer's bank.
You may use this field only when scoring a direct debit transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    255

Mapping Information

  • REST API Field:
    paymentInformation.bank.address1
  • SCMP API Field:
    bank_address
  • Simple Order API Field:
    bankInfo_adjava.io.PrintWriter@5022aedc dress

paymentInformation. bank.branchCode

Code used to identify the branch of the customer's bank.
Required for some countries if you do not or are not allowed to provide the IBAN. Use this field only when scoring a direct debit transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    paymentInformation.bank.branchCode
  • SCMP API Field:
    branch_code
  • Simple Order API Field:
    bankInfo_branchCode

paymentInformation. bank.checkDigit

Code used to validate the customer's account number.
Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.bank.checkDigit
  • SCMP API Field:
    bank_check_digit
  • Simple Order API Field:
    fundTransfer_bankCheckDigit

paymentInformation. bank.code

Country-specific code used to identify the customer's bank.
Required for some countries if you do not or are not allowed to provide the IBAN instead. You can use this field only when scoring a direct debit transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    paymentInformation.bank.code
  • SCMP API Field:
    bank_code
  • Simple Order API Field:java.io.PrintWriter@1852dbb6
    bankInfo_bankCode

paymentInformation. bank.country

Country where the bank is located.
Use the two-character ISO codes . You can use this field only when scoring a direct debit transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.bank.country
  • SCMP API Field:
    bank_country
  • Simple Order API Field:
    bankInfo_country

paymentInformation. bank. iban

The International Bank Account Number (IBAN) for the bank account.
For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    30

Mapping Information

  • REST API Field:
    paymentInformation.bank.iban
  • SCMP API Field:
    bank_iban
  • Simplejava.io.PrintWriter@1ad21c17 Order API Field:
    fundTransfer_iban

paymentInformation. bank.locality

City where the bank is located.
If you do not send this field, we presume the bank location is specified in the
orderInformation.billTo.locality
field. Because some banks validate the bank account information, consider sending this field if the bank location is not specified in the
orderInformation.billTo.locality
field.

Specifications

  • Data Type:
    String
  • Data Length:
    35

Mapping Information

  • REST API Field:
    paymentInformation.bank.locality
  • SCMP API Field:
    bank_city
  • Simple Order API Field:
    bankInfo_city

paymentInformation. bank.name

Bank's name.
You can use this field only when scoring a direct debit transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    40

Mapping Information

  • REST API Field:
    paymentInformation.bank.name
  • SCMP API Field:
    bank_name
  • Simple Order API Field:
    bankInfo_name

paymentInformation. bank.routingNumber

Bank routing number. This is also called the
transit number
.

Specifications

  • Data Type:
    Non-negative integer
  • Data Length:
    9

Mapping Information

  • REST API Field:
    paymentInformation.bank.routingNumber
  • SCMP API Field:
    ecp_rdfi
  • Simple Order API Fields:
    java.io.PrintWriter@362687b4
    check_bankTransitNumber

paymentInformation. bank. scheme

The bank scheme that establishes the rules for processing the direct debit.
Possible values:
  • bacs
    : Bacs UK
  • sepa
    : SEPA

Specifications

  • Data Type:
    String
  • Data Length:
    25

Mapping

  • REST Field Name:
    paymentInformation.bank.scheme
  • Simple Order Field Name:
    paymentScheme

paymentInformation. bank.swiftCode

The Bank Identification Code (BIC) that is the unique identifier for the business institution.
The BIC is established by the ISO 9362 international standard.
The BIC is also known as the SWIFT-BIC, the SWIFT ID, or the SWIFT code.
You can use this field only when scoring a direct debit transaction. Required only for cross-border transactions.

Specifications

  • Data Type:
    String
  • Data Length:
    30

Mapping Information

  • REST API Field:
    paymentInformation.bank.swiftCode
  • SCMP API Field:
    bank_swiftcode
  • Simple Order API Field:
    bankInfo_swiftCode

paymentInformation. binCountry

Country associated with the BIN of the customer's card used for the payment.
Use the two-character ISO country code. .
Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the Business Center.

Specifications

  • Data Type:
    String
  • Data Length:
    255

Mapping Information

    REST API Field:
    paymentInformation.binCountry
  • SCMP API Field:
    bin_country
  • Simple Order API Field:
    afsReply_binCountry

paymentInformation. card.accountEncoderId

Identifier for the issuing bank that provided the customer’s encoded account number.
This field is available only on the
Chase Paymentech Solutions
processor. Contact the processor to obtain the bank’s ID.

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Field:
    paymentInformation.card.accountEncoderId
  • SCMP API Field:
    account_encojava.io.PrintWriter@c958c61 der_id
  • Simple Order API Field:
    card_accountEncoderID

paymentInformation. card.bin

Credit card BIN (the first eight digits of the credit card).
The BIN will be used in place of the first eight digits of the credit card when present.

Specifications

  • Data Type:
    Positive Integer
  • Data Length:
    8

Mapping Information

  • REST API Field:
    paymentInformation.card.bin
  • SCMP API Field:
    cc_bin
  • Simple Order API Field:
    card_bin

paymentInformation. card.cardType

Three-digit value that indicates the card type. This field is required for the Payer Authentication Check Enrollment and Validation services.
IMPORTANT
Its a good idea to include the card type even when it is optional. Omitting the card type can cause the transaction to be processed with the wrong card type.
Card-Present Transactions:
This field is returned in the response message when the client software that is installed on the POS terminal uses the
Token Management Service
(
TMS
) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit response message. This field is available only for
Cybersource
integrations.
Card Type Codes Possible Values:
Each payment method, processor, and acquirer support different card types.
001
: Visa
For all processors except
SIX
, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value
001
for Visa Electron.
002
: Mastercard and Eurocard
For Eurocard, which is the European regional brand of Mastercard, you must include the card type field in a request for an authorization or stand-alone credit.
003
: American Express
004
: Discover
005
: Diners Club
006
: Carte Blanche
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
007
: JCB
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
014
: EnRoute
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
021
: JAL
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
024
: Maestro (UK Domestic)
033
: Visa Electron
Use this value only for
SIX
. For other processors, use
001
for all Visa card types. For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
034
: Dankort
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
036
: Cartes Bancaires
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
037
: Carta Si
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
039
: Encoded account number
This value is supported only on
Chase Paymentech Solutions
. For this value, you must include the card type field in a request for an authorization or stand-alone credit.
040
:
UATP
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
042
: Maestro (International)
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
050
: Hipercard
For this card type on
Cielo
3.0,
Getnet
, or
Rede
, you must include the card type field in a request for an authorization or stand-alone credit. This card type is not supported on
Cielo
1.5.
051
: Aura
054
: Elo
For this card type on
Getnet
or
Rede
, you must include the card type field in a request for an authorization or stand-alone credit.
058
: Carnet
059
: ValueLink
060
: mada
Required when accepting mada cards with Apple Pay. Supported with
Visa Platform Connect
only.
061
:
RuPay
062
: China UnionPay
065
: Korean Domestic Cards
For this card type on
Getnet
,
Rede
, and
Korean Cyber Payments
you must include the card type field in a request for an authorization or stand-alone credit.
066
: Banricompras
067
: Meeza
Available in Egypt only.
Barclays
: This field is optional for Visa card transactions that use the Payouts AFT services.
Visa Platform Connect
:
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01-TCR1
  • Position: 70-71
  • Field: Card ID
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.
Korean Cyber Payments
:
All cards from the issuers below are supported along with Visa and Mastercard.
  • BC
  • Hana
  • Hyundai
  • KB Kookmin
  • Lotte
  • NH Nonghyup
  • Samsung
  • Shinhan

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Fields:
    • paymentInformation.card.cardType
    • paymentInformation.card.type
    • paymentInformation.tokenizedCard.type
  • SCMP API Field:
    card_type
  • Simple Order API Field:
    card_cardType

paymentInformation. card.expirationMonth

Two-digit month in which the payment card expires.
Format: MM
Possible values:
01
through
12
. Leading
0
is required.
IMPORTANT
This field is optional if your account is configured for relaxed requirements for expiration date.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions
.
Barclays
and
Streamline
For Maestro (UK Domestic and International) cards, this value must be valid (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause
Cybersource
to reject a request. However, an invalid expiration date might cause the issuer to reject a request.
Chase Paymentech Solutions
For encoded account numbers (
paymentInformation.card.type
or
paymentInformation.tokenizedCard.type
=
039
), set the value for this field to
12
if the card does not provide an expiration date.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.card.expirationMonth
  • SCMP API Field:
    customer_cc_expmo
  • Simple Order API Field:
    card_expirationMonth

paymentInformation. card.expirationYear

Four-digit year in which the payment card expires.
Format: yyyy
IMPORTANT
This field is optional if your account is configured for relaxed requirements for expiration date.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions
.
Barclays
For Maestro (UK Domestic and International) cards on
Barclays
and
Streamline
, this value must be valid (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause
Cybersource
to reject a request. However, an invalid expiration date might cause the issuer to reject a request.
Chase Paymentech Solutions
For encoded account numbers (
paymentInformation.card.type
or
paymentInformation.tokenizedCard.type
=
039
), set the value for this field to
2021
if the card does not provide an expiration date.
Streamline
For Maestro (UK Domestic and International) cards on
Barclays
and
Streamline
, this value must be valid (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause
Cybersource
to reject a request. However, an invalid expiration date might cause the issuer to reject a request.

Specifications

  • FDC Nashville Global
    : You can provide two digits or four digits. When you provide two digits, they must be the last two digits of the year.
  • FDMS South
    : You can provide two digits or four digits. When you provide two digits, they must be the last two digits of the year.
  • Other Processors:
    • Data Type:
      String
    • Data Length:
      4

Mapping Information

  • REST API Fields:
    • paymentInformation.card.expirationYear
    • paymentInformation.tokenizedCard.expirationYear
  • SCMP API Field:
    customer_cc_expyr
  • Simple Order API Field:
    card_expirationYear

paymentInformation. card.hashedNumber

Provides a SHA-256 hashed value of the PAN.
This field can be used to meet Taiwan's Ministry of Finance mandate. This mandates requires merchants must generate a unique code based on the PAN as well as the customer's mobile number, membership number, or national ID for each authorization.
To receive this field during an authorization, you must request this field to be enabled through customer support.

Specifications

  • Data Type:
    String
  • Data Length:
    60

Mapping Information

  • REST API Field:
    paymentInformation.card.hashedNumber
  • SCMP API Field:
    customer_cc_hashed_number
  • Simple Order API Field:
    card_hashedAccountNumber

paymentInformation. card.issueNumber

Number of times a Maestro (UK Domestic) card has been issued to the account holder.
The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in a request, include exactly what is printed on the card. A value of
2
is different than a value of
02
.
Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.
The issue number is not required for Maestro (UK Domestic) transactions.

Specifications

  • Type:
    String
  • Length:
    5

Mapping Information

    java.io.PrintWriter@1ec9623b
  • REST API Field:
    paymentInformation.card.issueNumber
  • SCMP API Field:
    customer_cc_issue_number
  • Simple Order API Field:
    card_issueNumber

paymentInformation. card.number

Payment card number or network token.
Also known as the primary account number (PAN).
BIN Lookup Service
You can also use this field for encoded account numbers.
When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.
Chase Paymentech Solutions
When processing encoded account numbers, use this field for the encoded account number.

Specifications

  • FDMS Nashville
    (Card-Present transactions only):
    • Data Type:
      String
    • Data Length:
      19
  • Other Processors:
    • Data Type:
      String
    • Data Length:
      20

Mapping Information

  • REST API Field:
    paymentInformation.card.number
  • SCMP API Field:
    customer_cc_number
  • Simple Order API Field:
    card_accountNumber

paymentInformation. card.passPhrase

Card password.
The card password consists of 2 digits and is considered Personally Identifiable Information (PII).

Specifications

  • Data Type:
    Numeric String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.card.passPhrase
  • SCMP API Field:
    card_pass_phrase
  • Simple Order API Field:
    card_passPhrase

paymentInformation. card.personalData

Personal data used to validate the identity of the cardholder.
The data used will be either six digits representing the cardholder's date of birth or a 10-digit business number. This data is considered Personally Identifiable Information (PII).

Specifications

  • Data Type:
    String
  • Data Length:
    Up to 10

Mapping Information

  • REST API Field:
    paymentInformation.card.personalData
  • SCMP API Field:
    card_personal_data
  • Simple Order API Field:
    card_personalData

paymentInformation. card.productName

Name of the card product.
This field is available only for BNDES transactions on the
Visa Platform Connect
processor.
Set the value for this field to
BNDES
.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR4
  • Position: 115-120
  • Field: Brazil Country Data

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mappijava.io.PrintWriter@4a1c332a ng Information

  • REST API Field:
    paymentInformation.card.productName
  • SCMP API Field:
    card_product_name
  • Simple Order API Field:
    card_productName

paymentInformation. card.securityCode

Card verification number (CVN).
IMPORTANT
When enabling web browsers to auto-fill payment tokens, you must include
either the
paymentInformation.card.securityCode
or
paymentInformation.tokenizedCard.securityCode
field
in the authorization request.
Web browsers can replace primary account numbers with e-commerce tokens, which enables cardholders to auto-fill tokens, token expiration dates, and three-digit dynamic token verification values (DTVVs) on merchant payment entry forms.
You will receive the result code in the
processorInformation.consumerAuthenticationResponse.code
or
processorInformation.consumerAuthenticationResponse.codeRaw
fields.
This field is available only on the
FDC Compass
,
FDMS Nashville
, and
Visa Platform Connect
processors.

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Fields:
    • paymentInformation.card.securityCode
    • paymentInformation.tokenizedCard.securityCode
  • SCMP API Field:
    customer_cc_cv_number
  • Simple Order API Field:
    card_cvNumber

paymentInformation. card.securityCodeIndicator

Flag that specifies whether a CVN code was sent.
Possible values:
  • 0
    (default): CVN service not requested. This default value is used when you do not include the
    paymentInformation.card.securityCode
    or
    paymentInformation.tokenizedCard.securityCode
    field in the request.
  • 1
    (default): CVN service requested and supported. This default value is used when you include the
    paymentInformation.card.securityCode
    or
    paymentInformation.tokenizedCard.securityCode
    field in the request.
  • 2
    : CVN on payment card is illegible.
  • 9
    : CVN not imprinted on payment card.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.card.securityCodeIndicator
  • SCMP API Field:
    customer_cc_cv_indicator
  • Simple Order API Field:
    card_cvIndicator

paymentInformation. card.sourceAccountType

Flag that specifies the type of account associated with the card.
This field is available only for the
China UnionPay
,
Cielo
,
Comercio Latino
, and
Visa Platform Connect
processors.
The cardholder provides this information during the payment process.
This field is required for transactions with Brazilian-issued cards.
Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. It is strongly recommended that you include this field for combo card transactions.
China UnionPay
Card Transactions on
China UnionPay
This field is available only for China UnionPay card transactions. Possible values:
  • C
    : Domestic credit card.
  • D
    : Domestic debit card.
  • F
    : International credit card.
  • I
    : International debit card.
When the value is
D
, the e-commerce indicator and CAVV fields must be included in the authorization request.
When the value is
C
,
F
, or
I
, the card verification number, expiration month, and expiration year fields must be included in the authorization request.
Cielo
and
Comercio Latino
Credit Card Transactions
On these processors, this field is available only for authorizations. Possible values:
  • CR
    : Credit card
  • DB
    : Debit card
Visa Platform Connect
Credit Card Transactions
For combo card transactions with Mastercard in Brazil, the field is
paymentInformation.card.useAs
or
paymentInformation.card.sourceAccountType
fields are
also available.
Possible values:
  • CH
    : Checking account
  • CR
    : Credit card account
  • LI
    : Line of credit or credit portion of combo card
  • PP
    : Prepaid card or prepaid portion of combo card
  • SA
    : Savings account
  • UA
    : Universal account
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR0
  • Positions: 42-43
  • Field: Account Selection
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.
If
paymentInformation.card.useAs
is set to
credit/debit
and there is a value in the
paymentInformation.card.sourceAccountType
field, the value in the
paymentInformation.card.SourceAccountType
field takes precedence.
If
paymentInformation.card.useAs
is set to
CR/DB
and there is a value in the field, the value in the
paymentInformation.card.useAs
field takes precedence.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Fields:
    • paymentInformation.card.useAs
    • paymentInformation.card.sourceAccountType
  • SCMP API Field:
    override_payment_method
  • Simple Order API Fields:
    • ccAuthService_overridePaymentMethod
    • ccCreditService_overridePaymentMethod
    • pinDebitCreditService_overridePaymentMethod

paymentInformation. card.sourceAccountTypeDetails

Type of account for a line of credit or prepaid card.
This field is available only for combo card transactions in Brazil on the
Visa Platform Connect
processor.
Include this field when the value for the or field is line of credit (LI) or prepaid card (PP).
Line of Credit
Possible values:
  • AGRC
    : Visa Agro Custeio.
  • AGRE
    : Visa Agro Electron.
  • AGRI
    : Visa Agro Investimento.
  • AGRO
    : Visa Agro.
Prepaid Card
Possible values:
  • VVA
    : Visa Vale Alimentacao.
  • VVF
    : Visa Vale Flex.
  • VVR
    : Visa Vale Refeicao.
TC 33 Capture File
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR0
  • Position: 44-47
  • Field: Account Accessed

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Field:
    paymentInformation.card.sourceAccountTypeDetails
  • SCMP API Field:
    override_payment_details
  • Simple Order API Fields:
    • ccAuthService_overridePaymentDetails
    • ccCreditService_overridePaymentDetails

paymentInformation. card.startMonth

Month of the start of the Maestro (UK Domestic) card validity period.
Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.
Possible values:
01
through
12
.
The start date is not required for Maestro (UK Domestic) transactions.

Specifications

  • Data Type:
    String
  • Data Length:
    2
  • Data Format:
    MM

Mapping Information

  • REST API Field:
    paymentInformation.card.startMonth
  • SCMP API Field:
    customer_cc_startmo
  • Simple Order API Field:
    card_startMonth

paymentInformation. card.startYear

Year of the start of the Maestro (UK Domestic) card validity period.
Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.
The start date is not required for Maestro (UK Domestic) transactions.

Specifications

  • Data Type:
    String
  • Data Length:
    4
  • Data Format:
    yyyy

Mapping Information

  • REST API Field:
    paymentInformation.card.startYear
  • SCMP API Field:
    customer_cc_startyr
  • Simple Order API Field:
    card_startYear

paymentInformation. card.suffix

Last four digits of the customer’s account number.
You can use this value on the receipt that you give to the customer.
Card-Not-Present and PIN Debit Transactions
This field is returned only for tokenized transactions.
Card-Present Transactions
This field is returned in the response message when the client software that is installed on the POS terminal uses the
Token Management Service
(
TMS
) to retrieve tokenized payment details.
You must contact customer support to have your account enabled to receive these fields in the credit response message.
This field is supported only for
Cybersource
integrations.
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR8
  • Position: 85
  • Field: American Express last 4 PAN return indicator
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Field:
    paymentInformation.card.suffix
  • SCMP API Field:
    card_suffix
  • Simple Order API Field:
    card_suffix

paymentInformation. card.type

Three-digit value that indicates the card type. This field is required for the Payer Authentication Check Enrollment and Validation services.
IMPORTANT
Its a good idea to include the card type even when it is optional. Omitting the card type can cause the transaction to be processed with the wrong card type.
Card-Present Transactions:
This field is returned in the response message when the client software that is installed on the POS terminal uses the
Token Management Service
(
TMS
) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit response message. This field is available only for
Cybersource
integrations.
Card Type Codes Possible Values:
Each payment method, processor, and acquirer support different card types.
001
: Visa
For all processors except
SIX
, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value
001
for Visa Electron.
002
: Mastercard and Eurocard
For Eurocard, which is the European regional brand of Mastercard, you must include the card type field in a request for an authorization or stand-alone credit.
003
: American Express
004
: Discover
005
: Diners Club
006
: Carte Blanche
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
007
: JCB
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
014
: EnRoute
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
021
: JAL
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
024
: Maestro (UK Domestic)
033
: Visa Electron
Use this value only for
SIX
. For other processors, use
001
for all Visa card types. For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
034
: Dankort
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
036
: Cartes Bancaires
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
037
: Carta Si
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
039
: Encoded account number
This value is supported only on
Chase Paymentech Solutions
. For this value, you must include the card type field in a request for an authorization or stand-alone credit.
040
:
UATP
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
042
: Maestro (International)
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
050
: Hipercard
For this card type on
Cielo
3.0,
Getnet
, or
Rede
, you must include the card type field in a request for an authorization or stand-alone credit. This card type is not supported on
Cielo
1.5.
051
: Aura
054
: Elo
For this card type on
Getnet
or
Rede
, you must include the card type field in a request for an authorization or stand-alone credit.
058
: Carnet
059
: ValueLink
060
: mada
Required when accepting mada cards with Apple Pay. Supported with
Visa Platform Connect
only.
061
:
RuPay
062
: China UnionPay
065
: Korean Domestic Cards
For this card type on
Getnet
,
Rede
, and
Korean Cyber Payments
you must include the card type field in a request for an authorization or stand-alone credit.
066
: Banricompras
067
: Meeza
Available in Egypt only.
Barclays
: This field is optional for Visa card transactions that use the Payouts AFT services.
Visa Platform Connect
:
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01-TCR1
  • Position: 70-71
  • Field: Card ID
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.
Korean Cyber Payments
:
All cards from the issuers below are supported along with Visa and Mastercard.
  • BC
  • Hana
  • Hyundai
  • KB Kookmin
  • Lotte
  • NH Nonghyup
  • Samsung
  • Shinhan

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Fields:
    • paymentInformation.card.cardType
    • paymentInformation.card.type
    • paymentInformation.tokenizedCard.type
  • SCMP API Field:
    card_type
  • Simple Order API Field:
    card_cardType

paymentInformation. card.typeSelectionIndicator

Flag that identifies how the card type was selected.
This field is available only on
Banque de France et Tresor Public
,
BNP Paribas France
,
China UnionPay
, and
Credit Mutuel-CIC
processors.
Possible values:
  • 0
    : Card type was selected based on default acquirer settings.
  • 1
    : Customer selected the card type.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.card.typeSelectionIndicator
  • SCMP API Field:
    card_type_selection_indicator
  • Simple Order API Field:
    cardTypeSelectionIndicator

paymentInformation. card.useAs

Flag that specifies the type of account associated with the card.
This field is available only for
China UnionPay
,
Cielo
,
Comercio Latino
, and
Visa Platform Connect
.
The cardholder provides this information during the payment process.
This field is required for transactions with Brazilian-issued cards.
Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. It is strongly recommended that you include this field for combo card transactions.
China UnionPay
Card Transactions on
China UnionPay
Possible values:
  • C
    : Domestic credit card.
  • D
    : Domestic debit card.
  • F
    : International credit card.
  • I
    : International debit card.
When the value is
D
, the e-commerce indicator and CAVV fields must be included in the authorization request.
When the value is
C
,
F
, or
I
, the card verification number, expiration month, and expiration year fields must be included in the authorization request.
Cielo
and
Comercio Latino
Credit Card Transactions
On these processors, this field is available only for authorizations. Possible values:
  • CR
    : Credit card
  • DB
    : Debit card
Visa Platform Connect
Credit Card Transactions
For combo card transactions with Mastercard in Brazil, the field is
paymentInformation.card.useAs
or
paymentInformation.card.sourceAccountType
fields are
also available.
Possible values:
  • CH
    : Checking account
  • CR
    : Credit card account
  • LI
    : Line of credit or credit portion of combo card
  • PP
    : Prepaid card or prepaid portion of combo card
  • SA
    : Savings account
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR0
  • Positions: 42-43
  • Field: Account Selection
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.
A value of CR or DB in this field takes precedence over any value in the
paymentInformation.sourceAccountType
field.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Fields:
    • paymentInformation.card.useAs
    • paymentInformation.card.sourceAccountType
  • SCMP API Field:
    card_usage
  • Simple Order API Field:
    card_usage

paymentInformation. customer.customerId

Subscription ID or token ID.
When you use Recurring Billing or
Token Management Service
and you include this value in a request, many of the fields that are normally required for an authorization or credit become optional.
Payouts
:
When you include this field in your request, the following fields are optional:
  • paymentInformation.card.number
  • paymentInformation.tokenizedCard.expirationMonth
  • paymentInformation.tokenizedCard.expirationYear

Specifications

  • Data Type:
    String
  • Data Length:
    26

Mapping Information

  • REST API Field:
    paymentInformation.customer.customerId
  • SCMP API Field:
    subscription_id
  • Simple Order API Field:
    recurringSubscriptionInfo_subscriptionID

paymentInformation. customer.id

Unique identifier for the
Token Management Service
(
TMS
) customer token.
BIN Lookup Service
When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

  • Data Type:
    String
  • Data Length:
    32

Mapping Information

No corresponding fields.

paymentInformation. directDebit. mandate. clearingDate

The date on which the direct debit should be processed.

Specifications

  • Data Type:
    String
  • Data Length:
    8

Mapping

  • REST Field Name:
    paymentInformation.directDebit.mandate.clearingDate
  • Simple Order Field Name:
    apSaleService_dateCollect

paymentInformation. directDebit. mandate. id

The identifier for the direct debit mandate.

Specifications

  • Data Type:
    String
  • Data Length:
    35

Mapping

  • REST Field Name:
    paymentInformation.directDebit.mandate.id
  • Simple Order Field Name:
    RequestMessage_mandateID

paymentInformation. fluidData.descriptor

Format of the encrypted payment data.
Possible values:
  • Apple Pay:
    RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U
  • Blue PCI P2PE:
    Ymx1ZWZpbg==
  • Samsung Pay:
    RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=

Specifications

  • Data Type:
    String
  • Data Length:
    128

Mapping Information

  • REST API Field:
    paymentInformation.fluidData.descriptor
  • SCMP API Field:
    encrypted_payment_descriptor
  • Simple Order API Field:
    encryptedPayment_descriptor

paymentInformation. fluidData.encoding

Encoding method used to encrypt the payment data.
For Apple Pay transactions, the encoding method is Base64.

Specifications

  • Data Type:
    String
  • Data Length:
    6

Mapping Information

  • REST API Field:
    paymentInformation.fluidData.encoding
  • SCMP API Field:
    encrypted_payment_encoding
  • Simple Order API Field:
    encryptedPayment_encoding

paymentInformation. fluidData.value

Card-present transactions:
encrypted payment data.
Digital payment transactions:
encrypted payment data value. If you are using the
Cybersource
decryption option, populate this field with the encrypted payment data value returned by the Full Wallet request.

Specifications

  • Data Type:
    String
  • Data Length:
    3072

Mapping Information

  • REST API Field:
    paymentInformation.fluidData.value
  • SCMP API Field:
    encrypted_payment_data
  • Simple Order API Field:
    encryptedPayment_data

paymentInformation. initiationChannel

This code indicates how the account information was obtained.
This field is available only for payments processed with Mastercard and American Express on the
Visa Platform Connect
processor.
This field is supported for Mastercard only on Cybersource through VisaNet. When the initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. Call support to enable this feature.
Possible values for Mastercard transactions:
  • 00
    (default): Card
  • 01
    : Removable secure element that is personalized for use with a mobile phone and controlled by the wireless service provider. Examples are subscriber identity module (SIM), and universal integrated circuit card (UICC).
  • 02
    : Key fob
  • 03
    : Watch
  • 04
    : Mobile tag
  • 05
    : Wristband
  • 06
    : Mobile phone case or sleeve
  • 07
    : Mobile phone with a non-removable, secure element that is controlled by the wireless service provider. For example, code division multiple access (CDMA).
  • 08
    : Removable secure element that is personalized for use with a mobile phone and not controlled by the wireless service provider. For example: memory card used with a mobile phone.
  • 09
    : Mobile phone with a non-removable, secure element that is not controlled by the wireless service provider.
  • 10
    : Removable secure element that is personalized for use with a tablet or e-reader and is controlled by the wireless service provider. Examples are subscriber identity module (SIM) and universal integrated circuit card (UICC).
  • 11
    : Tablet or e-reader with a non-removable, secure element that is controlled by the wireless service provider.
  • 12
    : Removable secure element that is personalized for use with a tablet or e-reader and is not controlled by the wireless service provider.
  • 13
    : Tablet or e-book with a non-removable, secure element that is not controlled by the wireless service provider.
  • 14
    : Mobile phone or smartphone with a payment application running in a host processor.
  • 15
    : Tablet or e-reader with a payment application running in a host processor.
  • 16
    : Mobile phone or smartphone with a payment application running in the Trusted Execution Environment (TEE) of a host processor.
  • 17
    : Tablet or e-reader with a payment application running in the TEE of a host processor.
  • 18
    : Watch with a payment application running in the TEE of a host processor.
  • 19
    : Watch with a payment application running in a host processor.
Values
20
through
99
indicate the form factor but not the storage technology:
  • 20
    : Card
  • 21
    : Mobile phone
  • 22
    : Tablet or e-reader
  • 23
    : Watch or wristband, including a fitness band smart strap, disposable band, watch add-on, security band, or ID band.
  • 24
    : Sticker
  • 25
    : PC
  • 26
    : Device peripheral, such as a mobile phone case or sleeve.
  • 27
    : Electronic tag, such as a mobile tag or a key fob.
  • 28
    : Jewelry such as ring, bracelet, necklace and cuff links.
  • 29
    : Fashion accessory, such as a handbag, handbag charm, or eyewear.
  • 30
    : Garment such as a dress.
  • 31
    : Domestic appliance, such as a refrigerator or washing machine.
  • 32
    : Vehicle or vehicle-attached device.
  • 33
    : Media or gaming device, including a set-top box, media player, or television.
Values
34
through
99
are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice.
Possible values for American Express transactions:
  • AC
    : mPOS accessory/dongle with contact and contactless interfaces, with or without PIN pad
  • AS
    : mPOS accessory/dongle with contact and contactless interfaces and PIN on glass support. For example, a Secure Card Reader for PIN combined with a software-based PIN on commercial off-the-shelf (COTS) hardware
  • CC
    : Contactless payment on COTS (CPoC)—mobile-device-based contactless-only mPOS without PIN support
  • CS
    : CPoC—mobile-device-based contactless-only mPOS with PIN on glass support
The value for this field corresponds to the following data in the TC 33 capture file for American Express transactions:
  • Record: CP01-TCRB
  • Position: 79-80
  • Field: American Express Mobile Device Type
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.initiationChannel
  • SCMP API Field:
    payment_initiation_channel
  • Simple Order API Field:
    paymentInitiationChannel

paymentInformation. instrumentIdentifier.id

Unique identifier for the
Token Management Service
(
TMS
) instrument identifier token.
BIN Lookup Service
When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

  • Data Type:
    String
  • Data Length:java.io.PrintWriter@3d9dc157
    32

Mapping Information

No corresponding fields.

paymentInformation. intent

Reason for payment when using an alternative payment method.
Example:
Charity

Specifications

  • Data Type:
    String
  • Data Length:
    255

Mapping Information

  • REST API Field:
    paymentInformation.intent
  • SCMP API Field:
    ap_initiate_intent
  • Simple Order API Field:
    apInitiateService_intent

paymentInformation. legacyToken. id

Unique identifier for the legacy secure store token.

Specifications

  • Data Type:
    String
  • Minimum Data Length:
    1
  • Maximum Data Length:
    32

Mapping Information

No corresponding fields.

paymentInformation. method

Method of payment used for the order.
This field can contain one of the following values:
  • consumer
    (default): Customer credit card
  • corporate
    : Corporate credit card
  • debit
    : Debit card, such as a Maestro (UK Domestic) card
  • cod
    : Collect on delivery
  • check
    : Electronic check
  • p2p
    : Person-to-person payment
  • private1
    : Private label credit card
  • other
    : Other payment method

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

  • REST API Field:
    paymentInformation.method
  • SCMP API Field:
    payment_type
  • Simple Order API Field:
    invoiceHeader_tenderType

paymentInformation. orderInformation.shipTo.address3

Cardholder's shipping address.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    paymentInformation.orderInformation.shipTo.address3
  • SCMP API Field:
    ship_to_address3
  • Simple Order API Field:
    shipTo_street3

paymentInformation. orderInformation.shipTo.address4

Fourth line of the shipping address.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    paymentInformation.orderInformation.shipTo.address4
  • SCMP API Field:
    ship_to_address4
  • Simple Order API Field:
    java.io.PrintWriter@5481abfd
    shipTo_street4

paymentInformation. orderInformation.shipTo.middleName

Middle name of the recipient.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    paymentInformation.orderInformation.shipTo.middleName
  • SCMP API Field:
    ship_to_middlename
  • Simple Order API Field:
    java.io.PrintWriter@2a2f52f6
    shipTo_middleName

paymentInformation. paymentInstrument.id

Unique identifier for the
Token Management Service
(
TMS
) payment instrument token.
BIN Lookup Service
When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

  • Data Type:
    String
  • Data Length:
    32

Mapping Information

No corresponding fields.

paymentInformation. paymentType.method.name

The indicator for the payment type.
Possible values:
  • AFTERPAY
  • KLARNA

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Field:
    paymentInformation.paymentType.method.name
  • SCMP API Field:
    ap_payment_type
  • Simple Order API Field:
    apPaymentType

paymentInformation. paymentType.name

Name of the payment type.
Possible values:
CARD
: PIN Debit transaction
CHECK
: eCheck transaction
bankTransfer
: Online bank transfer transaction
localCard
: Korea Cyber Payment local card transaction.
carrierBilling
: Korea Cyber Payment carrier billing transaction.

Specifications

  • Data Type:
    Enum

Mapping Information

No corresponding fields.

paymentInformation. paymentType. subTypeName

Payment type details.
When the
paymentInformation.paymentType.name
field has a value of
CARD
, these are the possible values:
CREDIT
: Credit card transaction.
DEBIT
: PIN debit card transaction.
PREPAID
: Prepaid card transaction.

Specifications

  • Data Type:
    Enum

Mapping Information

No corresponding fields.

paymentInformation. shippingAddress.id

Unique identifier for the
Token Management Service
(
TMS
) shipping address token.
BIN Lookup Service
When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

  • Data Type:
    String
  • Data Length:
    32
java.io.PrintWriter@e85b489

Mapping Information

No corresponding fields.

paymentInformation. tokenizedCard. assuranceMethod

Confidence level of the provided token.
This value is provided by the token service provider.
Possible values:
  • 00
    : No issuer identity and verification (ID&V).
  • 10
    : Card issuer account verification.
  • 11
    : Card issuer interactive, single-factor cardholder authentication.
  • 12
    : Card issuer interactive, two-factor cardholder authentication.
  • 13
    : Card issuer risk-oriented, non-interactive cardholder authentication.
  • 14
    : Card issuer asserted authentication.
This field is available only for processing Apple Pay, Authorizations with Payment Network Tokens, Google Pay, PIN Debit Processing, and Samsung Pay transactions.
This field replaced the
paymentInformation.tokenizedCard.assuranceLevel
.

Specifications

  • Data Type:
    Integer
  • Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.assuranceMethod
  • SCMP API Field:
    payment_network_token_assurance_method
  • Simple Order API Field:
    paymentNetworkToken_assuranceMethod

paymentInformation. tokenizedCard.cryptogram

Token authentication verification value cryptogram.
For token-based transactions with 3-D Secure, you must submit both types of cryptograms: network token and 3-D Secure.
For all processors except RuPay, the value for this field must be 28-character Base64 or 40-character hex binary. All cryptograms use one of these formats.
On RuPay for the payer authentication seamless flow, use the customer's payment network token value.

Specifications

  • Data Type:
    String
  • Data Length:
    256

Mapping Information

  • REST API Field:
    paymentinformation.tokenizedCard.cryptogram
  • SCMP API Field:
    network_token_cryptogram
  • Simple Order API Field:
    ccAuthService_networkTokenCryptogram

paymentInformation. tokenizedCard.expirationMonth

Month in which the token expires.
This field is a response field that is included in the response message when the payment blob for the tokenized transaction is decrypted.
Format:
MM
Possible values:
01
through
12

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.expirationMonth
  • SCMP API Field:
    token_expiration_month
  • Simple Order API Field:
    token_expirationMonth

paymentInformation. tokenizedCard.expirationYear

Year in which the token expires.
This field is a response field that is included in the response message when the payment blob for the tokenized transaction is decrypted.
Format:
yyyy

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.expirationYear
  • SCMP API Field:
    token_expiration_year
  • Simple Order API Field:
    token_expirationYear

paymentInformation. tokenizedCard. number

Customer's payment network token value that contains the customer's credit card number.

Specifications

  • Data Type:
    String
  • Data Length:
    20

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.number
  • SCMP API Field:
    customer_cc_number
  • Simple Order API Field:
    card_accountNumber

paymentInformation. tokenizedCard.prefix

First six digits of token.
This field is available only for merchant-initiated transactions using the
Elavon Americas
processor.
This field is included in the response message when it decrypts the payment blob for the tokenized transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    6

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.prefix
  • SCMP API Field:
    token_prefix
  • Simple Order API Field:
    token_prefix

paymentInformation. tokenizedCard.requestorId

Value that identifies your business and indicates that the cardholder’s account number is tokenized.
This value is assigned by the token service provider and is unique within the token service provider’s database.
This field is available only on the
FDC Nashville Global
and
Visa Platform Connect
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    11

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.requestorId
  • SCMP API Field:
    payment_network_token_requestor_id
  • Simple Order API Field:
    paymentNetworkToken_requestorID

paymentInformation. tokenizedCard.securityCode

Card verification number (CVN).
IMPORTANT
When enabling web browsers to auto-fill payment tokens, you must include
either the
paymentInformation.card.securityCode
or
paymentInformation.tokenizedCard.securityCode
field
in the authorization request.
Web browsers can replace primary account numbers with e-commerce tokens, which enables cardholders to auto-fill tokens, token expiration dates, and three-digit dynamic token verification values (DTVVs) on merchant payment entry forms.
You will receive the result code in the
processorInformation.consumerAuthenticationResponse.code
or
processorInformation.consumerAuthenticationResponse.codeRaw
fields.
This field is supported on
FDC Compass
,
FDMS Nashville
, and
Visa Platform Connect
.

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Fields:
    • paymentInformation.card.securityCode
    • paymentInformation.tokenizedCard.securityCode
  • SCMP API Field:
    customer_cc_cv_number
  • Simple Order API Field:
    card_cvNumber

paymentInformation. tokenizedCard.storageMethod

Type of technology used in the device to store token data.
This field is available only on the
FDC Compass
processor.
Possible values:
  • 001
    : Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, an SE is tested against a set of requirements defined by the payment networks.
  • 002
    : Host card emulation (HCE). Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS.

Specifications

  • Data Type:
    Integer
  • Data Length:
    3

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.storageMethod
  • SCMP API Field:
    payment_network_token_device_tech_type
  • Simple Order API Field:
    paymentNetworkToken_deviceTechType

paymentInformation. tokenizedCard.suffix

Last four digits of token.
This field is available only for merchant-initiated transactions on the
Elavon Americas
processor.
This field is included in the response message when it decrypts the payment blob for the tokenized transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.suffix
  • SCMP API Field:
    token_suffix
  • Simple Order API Field:
    token_suffix

paymentInformation. tokenizedCard.transactionType

Type of transaction that provided the payment network token data.
This field is available only on the
Elavon Americas
,
FDC Compass
,
RuPay
, and
Visa Platform Connect
processors.
This value does not specify the token service provider. It specifies the entity that provided you with information about the token.
Possible values:
  • 1
    : In-app transaction.
    For Apple Pay, Google Pay,
    RuPay
    seamless flow, Samsung Pay, and Visa Safe Click (VSC).
  • 2
    : Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction.
  • 3
    : A transaction using stored customer credentials on Visa Platform Connect, whether for merchant-initiated transactions (MITs) or customer-initiated transactions (CITs).
Elavon Americas
For Google Pay transactions, this field is used only for merchant-initiated transactions.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    paymentInformation.tokenizedCard.transactionType
  • SCMP API Field:
    payment_network_token_transaction_type
  • Simple Order API Field:
    paymentNetworkToken_transactionType

paymentInformation. tokenizedCard.type

Three-digit value that indicates the card type. This field is required for the Payer Authentication Check Enrollment and Validation services.
IMPORTANT
Its a good idea to include the card type even when it is optional. Omitting the card type can cause the transaction to be processed with the wrong card type.
Card-Present Transactions:
This field is returned in the response message when the client software that is installed on the POS terminal uses the
Token Management Service
(
TMS
) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit response message. This field is available only for
Cybersource
integrations.
Card Type Codes Possible Values:
Each payment method, processor, and acquirer support different card types.
001
: Visa
For all processors except
SIX
, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value
001
for Visa Electron.
002
: Mastercard and Eurocard
For Eurocard, which is the European regional brand of Mastercard, you must include the card type field in a request for an authorization or stand-alone credit.
003
: American Express
004
: Discover
005
: Diners Club
006
: Carte Blanche
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
007
: JCB
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
014
: EnRoute
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
021
: JAL
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
024
: Maestro (UK Domestic)
033
: Visa Electron
Use this value only for
SIX
. For other processors, use
001
for all Visa card types. For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
034
: Dankort
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
036
: Cartes Bancaires
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
037
: Carta Si
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
039
: Encoded account number
This value is supported only on
Chase Paymentech Solutions
. For this value, you must include the card type field in a request for an authorization or stand-alone credit.
040
:
UATP
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
042
: Maestro (International)
For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
050
: Hipercard
For this card type on
Cielo
3.0,
Getnet
, or
Rede
, you must include the card type field in a request for an authorization or stand-alone credit. This card type is not supported on
Cielo
1.5.
051
: Aura
054
: Elo
For this card type on
Getnet
or
Rede
, you must include the card type field in a request for an authorization or stand-alone credit.
058
: Carnet
059
: ValueLink
060
: mada
Required when accepting mada cards with Apple Pay. Supported with
Visa Platform Connect
only.
061
:
RuPay
062
: China UnionPay
065
: Korean Domestic Cards
For this card type on
Getnet
,
Rede
, and
Korean Cyber Payments
you must include the card type field in a request for an authorization or stand-alone credit.
066
: Banricompras
067
: Meeza
Available in Egypt only.
Barclays
: This field is optional for Visa card transactions that use the Payouts AFT services.
Visa Platform Connect
:
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01-TCR1
  • Position: 70-71
  • Field: Card ID
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.
Korean Cyber Payments
:
All cards from the issuers below are supported along with Visa and Mastercard.
  • BC
  • Hana
  • Hyundai
  • KB Kookmin
  • Lotte
  • NH Nonghyup
  • Samsung
  • Shinhan

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Fields:
    • paymentInformation.card.cardType
    • paymentInformation.card.type
    • paymentInformation.tokenizedCard.type
  • SCMP API Field:
    card_type
  • Simple Order API Field:
    card_cardType