processingInformation

The following fields provide processing information.

processingInformation. actionList

One or more actions to be included with payment.
These actions invoke other services bundled with the risk service.
Possible values are:
  • DECISION_SKIP
    : Skips Decision Manager services.
  • TOKEN_CREATE
    : Creates a token from the payment data in your request.
  • CONSUMER_AUTHENTICATION
    : Verifies that a card is enrolled in Payer Authentication along with your request.
  • VALIDATE_CONSUMER_AUTHENTICATION
    : Includes a Payer Authentication result in your request.

Specifications

  • Data Type:
     Array of strings
  • Data Length:
     2,147,483,647

Mapping Information

  • REST API Field:
    processingInformation.actionList
  • SCMP API Field:
     No corresponding field
  • Simple Order API Field:
     No corresponding field
processingInformation

processingInformation. actionTokenTypes

Indicates the type of
TMS
 token to be created in the request.

Possible Values

  • customer
  • instrumentIdentifier
  • paymentInstrument
  • shippingAddress

Specifications

  • Data Type:
     Enum
  • Data Length:
     20

Mapping Information

No corresponding fields.
processingInformation

processingInformation. authorizationOptions. aftIndicator

Indicates whether the transaction is a
Payouts
 AFT transaction. This field has been released as part of a pilot feature.
You must receive prior approval from the processor before processing AFTs. Contact your processor to participate in AFT services.
This field is available only for Visa and Mastercard on the
Barclays
,
Chase Paymentech Solutions
,
FDC Nashville Global
,
First Data Merchant Solutions
,
LloydsTSB Cardnet International
,
Streamline
, and
Visa Platform Connect
 processors.
Possible values:
  • true
    : This is an AFT transaction.
  • false
     (default): This is not an AFT transaction.

Specifications

  • Data Type:
     String
  • Data Length:
     5
    • LloydsTSB Cardnet International
      ,
      First Data Merchant Solutions
      : 6

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.aftIndicator
  • SCMP API Field:
    aft_indicator
  • Simple Order API Field:
    aft_indicator
processingInformation

processingInformation. authorizationOptions. aggregatedAuthIndicator

Flag for a mass transit transaction that indicates whether the authorization is aggregated.
This field is available only for mass transit transactions on the
Visa Platform Connect
 processor.
Possible values:
  • true
    : Aggregated
  • false
     (default): Not aggregated
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR7
  • Position: 150-151
  • Field: Transit Transaction Type 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

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.aggregatedAuthIndicator
  • SCMP API Field:
    aggregated_auth_indicator
  • Simple Order API Field:
    ccAuthService_aggregatedAuthIndicator
processingInformation

processingInformation. authorizationOptions. authIndicator

Purpose of the authorization.
Possible values:
  • 0
    : Preauthorization.
  • 1
    : Final authorization.
To set the default for this field, contact customer support.
Barclays
 and
Elavon
The default for
Barclays
 and
Elavon
 is
1
 (final authorization). To change the default for this field, contact customer support.
Visa Platform Connect
When the value for this field is
0
, it corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR0
  • Position: 164
  • Field: Additional Authorization Indicators
When the value for this field is
1
, it does not correspond to any data in the TC 33 capture file.

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.authIndicator
  • SCMP API Field:
    auth_indicator
  • Simple Order API Field:
    authIndicator
processingInformation

processingInformation. authorizationOptions. authType

Authorization type.
Possible values:
  • AUTOCAPTURE
    : Automatic capture
  • STANDARDCAPTURE
    : Standard capture
  • VERBAL
    : Forced capture or verbal authorization
Automatic Capture and Standard Capture
To request an automatic capture if your account is not configured for automatic captures, set this field to
AUTOCAPTURE
 and include it in a bundled authorization and capture request.
To override an automatic capture and request a standard capture if your account is configured for automatic captures, set this field to
STANDARDCAPTURE
 and include it in a standard authorization or bundled authorization and capture request.
Forced Capture
A forced capture occurs when you process an authorization outside the
Cybersource
 system but then capture the order through
Cybersource
. To indicate that you are performing a forced capture, set this field to
verbal
 and include it in a bundled authorization and capture request along with other fields required for a forced capture.
Verbal Authorization
When you request an authorization through
Cybersource
, the issuing bank might ask you to call the payment processor to answer questions about the transaction. When this happens, the processor gives you a verbal authorization code for the transaction. To indicate that you are capturing a verbal authorization, set this field to
verbal
 and include it in a capture request along with other fields required for a verbal authorization.

Specifications

Automatic Capture and Standard Capture:
  • Data Type
    : String
  • Data Length
    : 15
Forced Capture and Verbal Authorization:
  • Data Type
    : String
  • Data Length
    : 11

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.authType
  • SCMP API Field:
    auth_type
  • Simple Order API Fields:
    • ccAuthService_authType
    • ccCaptureService_authType
processingInformation

processingInformation. authorizationOptions. balanceInquiry

Flag that specifies whether to return balance information.
Possible values:
  • true
    : Return balance information.
  • false
    : Do not return balance information.

Specifications

  • Data Type: Boolean

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.balanceInquiry
  • Simple Order API Field:
    balanceInquiry
processingInformation

processingInformation. authorizationOptions. billPayment

Indicates payment for bill or payment towards existing contractual loan.
For Visa card types only.
  • Authorization service:
     Flag that specifies whether this payment is for a bill or for an existing contractual loan. This value is case sensitive. Possible values:
    • true
      : Visa bill payment or loan payment.
    • false
       (default): Not a Visa bill payment or loan payment.
  • Capture service:
     Flag that specifies whether this is a credit for a bill that the customer paid with a Visa card. Possible values:
    • true
      : Credit for a Visa bill payment.
    • false
       (default): Not a credit for a Visa bill payment.

Specifications

  • Data Type:
     Boolean

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.billPayment
  • SCMP API Field:
    bill_payment
  • Simple Order API Fields:
    • For Card-Not-Present and Card-Present Transactions:
      ccAuthService_billPayment
    • For Card-Not-Present Transactions Only:
      ccCreditService_billPayment
processingInformation

processingInformation. authorizationOptions. billPaymentType

Reason for the payment.
Possible values:
  • 001
    : Utility payment.
  • 002
    : Government services.
  • 003
    : Mobile phone top-up.
  • 004
    : Coupon payment.
  • 005
    : Installment-based repayment.
This field is available only for bill payments in Brazil with Mastercard on the
Visa Platform Connect
 processor. To participate in the Mastercard Bill Payment program, you must sign up with Mastercard.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR0
  • Position: 48-50
  • Field: Bill Payment Transaction Type Identifier

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.billPaymentType
  • SCMP API Field:
    bill_payment_type
  • Simple Order API Field:
    billPaymentType
processingInformation

processingInformation. authorizationOptions. cashAdvanceIndicator

Indicates merchant provided a cash advance during a POS transaction.
Possible values:
  • true:
     Transaction is a cash advance.
  • false:
     Transaction is not a cash advance.

Specifications

  • Data Type:
     String
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.cashAdvanceIndicator
  • SCMP API Field:
    cash_advance_indicator
  • Simple Order API Field:
    cashAdvanceIndicator
processingInformation

processingInformation. authorizationOptions. debtRecoveryIndicator

Flag for a mass transit transaction that indicates whether the purpose of the authorization is to recover debt.
This field is available only for mass transit transactions.
Possible values:
  • true
    : Debt recovery transaction
  • false
     (default): Not a debt recovery transaction
Visa Platform Connect
This field is required for MTT merchant-initiated mail order or telephone order (MOTO) debt recovery on
Visa Platform Connect
 and optional for other kinds of MTT debt recovery and other processors.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR7
  • Position: 150-151
  • Field: Transit Transaction Type 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:
     5

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.debtRecoveryIndicator
  • SCMP API Field:
    debt_recovery_indicator
  • Simple Order API Field:
    ccAuthService_debtRecoveryIndicator
processingInformation

processingInformation. authorizationOptions.declineAvsFlags

User defined list of AVS codes that will cause system to decline a transaction.
When triggered, the AVS will return a
DAVSNO
 flag.
Use a
space
 to separate the values in the list.
IMPORTANT
To receive declines for the AVS code
N
, include the value
N
 in the list.

Cielo 3.0 and cybersource Latin American Processing AVS Codes

IMPORTANT
cybersource Latin American Processing refers to a specific processing connection and does not refer to any other processors that support the Latin American region.
AVS Code
Description
D
Postal code and address match (partial match).
E
AVS not supported for this card type (not supported), or the acquirer returned an unrecognized value for the AVS response (invalid).
F
Postal code matches, but the CPF and address do not match (partial match).
G
AVS not supported or verified (not supported).
I
AVS information is not available (no match).
K
CPF matches, but the postal code and address do not match (partial match).
L
Postal code and CPF match, but the address does not match (partial match).
N
Postal code, CPF, and address do not match (no match).
O
CPF and address match, but the postal code does not match (partial match).
R
Your implementation does not support AVS (not supported) or the system is unavailable.
T
Address matches, but the CPF and postal coded do not match (partial match).
V
Postal code, CPF and address matches (match).
CPF (Cadestro de Pessoas Fisicas) is only required for Redecard in Brazil.

AVS Codes for All Other Processors

Amerian Express Cards
For American Express cards only, you can receive Visa and Cybersource AVS codes in addition to American Express AVS codes.
When using the
Visa Platform Connect
 processor, American Express AVS codes are converted to VISA AVS codes before they are returned. As a result, American Express AVS codes are not returned for American Express cards.
American Express Card codes: F, H, K, L, O, T, V
Domestic and International Visa Cards
Returned AVS codes are the standard Visa AVS codes.
AVS is considered either domestic or international, depending on the location of the issuing bank. If the bank is located in the U.S., AVS is domestic. If the bank is located outside of the U.S., AVS is international. You should be prepared to handle both domestic and international AVS codes, as both types of codes can be returned whether or not the card is domestic or international.
International Visa Codes: B, C, D, G , I, M, P
Domestic Visa Codes: A, F, N, R, S, U, W, X, Y, Z
Cybersource
 Codes
In addition to standard Visa codes,
Cybersource
 provides the following numeric codes:
Cybersource
 codes: 1, 2, 3, 4
AVS Code
Description
A
Street address matches, but the postal code doesn't match (partial match)
B
Street address matches, but the postal code is not verified. Only returned for Visa cards not issued in the U.S. (partial match)
C
Street address and postal code do not match. Returned only for Visa cards not issued in the U.S. (partial match)
D
Street address and postal code match. (match)
E
AVS data is invalid or the AVS is not allowed for this card type. (invalid)
F
Card member name does not match, but billing postal code matches. (partial match)
G
Issuing back outside of the U.S. does not support AVS. (not supported)
H
Card member name does not match, but street address and postal code match. Only returned for American Express cards.
I
Address not verified. (no match)
K
Card member name matches, but billing address and postal code does not match. (partial match)
L
Card member name and billing postal code match, but billing address does not match (partial match)
M
Street address and postal code match. (match)
N
One of the following: Street address does not match (American Express Cards only), card member name does not match, street address does not match, postal code does not match. (no match)
O
Card member name and billing address match, but billing postal code does not match. (partial match)
P
Postal code matches, but street address not verified. (partial match)
R
System unavailable.
S
Issuing bank in the U.S. does not support AVS (not supported)
T
Card member name does not match, but address matches. (partial match)
U
Address information unavailable for one of these reasons: The U.S. bank does not support AVS outside of the US or the AVS system is not functioning properly. (system unavailable)
V
Card member name, billing address and billing postal code match. (match)
W
Street address does not match, but the 9-digit postal code matches (partial match)
X
Street address and the 9-digit postal code matches (match)
Y
Street address and the 5-digit postal code matches (match)
Z
Street address does not match, but the 5-digit postal code matches (partial match)
1
AVS is not supported for this processor and/or card type. Or AVS is disabled on your
Cybersource
 account. (not supported)
2
The processor returned an unrecognized value. (unrecognized)
3
Address is confirmed. Only returned for PayPal Express checkout. (match)
4
Address not confirmed. Only returned for PayPal Express checkout. (no match)
5
No AVS code returned (no match)

Specifications

  • Data Type:
     String
  • Data Length:
     15

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.declineAvsFlags
  • SCMP API Field:
    decline_avs_flags
  • Simple Order API Field:
    businessRules_declineAVSFlags
processingInformation

processingInformation. authorizationOptions. deferredAuthIndicator

Flag that indicates whether the authorization request is a deferred authorization.
This field is available for Mastercard transactions on the
Visa Platform Connect
 processor.
Possible values:
  • true
    : Deferred authorization
  • false
     (default): Not a deferred authorization
For mass transit transactions, the value for this field corresponds to this data in the TC 33 capture file:
  • First data item:
    • Record: CP01 TCR0
    • Position: 160-163
    • Field: Message Reason Code
  • Second data item:
    • Record: CP01 TCR7
    • Position: 150-151
    • Field: Transit Transaction Type 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:
     Boolean
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.deferredAuthIndicator
  • SCMP API Field:
    auth_deferred_auth_indicator
  • Simple Order API Field:
    ccAuthService_deferredAuthIndicator
processingInformation

processingInformation. authorizationOptions. extendAuthIndicator

Flag that indicates whether the authorization request is an extended authorization.
Possible values:
  • true
    : Deferred authorization
  • false
     (default): Not a deferred authorization
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:
     Boolean
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.extendAuthIndicator
  • SCMP API Field:
    auth_extend_auth_indicator
  • Simple Order API Field:
    ccAuthService_extendAuthIndicator
processingInformation

processingInformation. authorizationOptions. ignoreAvsResult

Flag for a sale request that specifies whether to allow the capture service to run even when the authorization receives an AVS decline.
An AVS decline is indicated by a
response flag value of
DAVSNO
.
Possible values:
  • true
    : Ignore the results of AVS checking, and run the capture service.
  • false
     (default): If the authorization receives an AVS decline, do not run the capture service.
When the value of this field is
true
, the list in the
processingInformation.authorizationOptions.declineAvsFlags
 field is ignored.

Specifications

  • Data Type:
     Boolean

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.ignoreAvsResult
  • SCMP API Field:
    ignore_avs
  • Simple Order API Field:
    businessRules_ignoreAVSResult
processingInformation

processingInformation. authorizationOptions. ignoreCvResult

Flag for a sale request that specifies whether to allow the capture service to run even when the authorization receives a CVN decline.
A CVN decline is indicated by the
processorInformation.cardVerification.resultCode
 value of
D
 or
N
.
Possible values:
  • true
    : Ignore the results of CVN checking, and run the capture service.
  • false
     (default): If the authorization receives a CVN decline, do not run the capture service.

Specifications

  • Data Type:
     Boolean

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.ignoreCvResult
  • SCMP API Field:
    ignore_bad_cv
  • Simple Order API Field:
    businessRules_ignoreCVResult
processingInformation

processingInformation. authorizationOptions. initiator. credentialStoredOnFile

Indicates whether the customer initiated the transaction and whether the credentials are stored for future authorizations.
This field is available only on the
FDC Compass
 and
Visa Platform Connect
 processors.
Future authorizations that use the stored credentials can be merchant-initiated transactions or customer-initiated credentials-on-file transactions.
Possible values:
  • true
    : Credentials from this transaction are stored for future authorizations.
  • false
    : Credentials from this transaction are not stored for future authorizations.
For the endpoint
/tss/v2/transactions/{id}
, possible values are
Y
 or
N
.
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR1
  • Position: 136
  • Field: POS Environment
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:
     5
For the endpoint
/tss/v2/transactions/{id}
, the data length is 1.

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.initiator.credentialStoredOnFile
  • SCMP API Field:
    subsequent_auth_first
  • Simple Order API Field:
    subsequentAuthFirst
processingInformation

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. agreementId

Unique ID generated by the merchant for recurring and unscheduled card-on-file transactions, and shared in subsequent transactions.
This field is required for all unscheduled card-on-file and recurring subsequent transactions from Saudi Arabia merchants. The merchant generates an agreement ID for each card holder or payment agreement. This field can contain foreign/Arabic character set. This value is forwarded to the Saudi payment processor.

Specifications

  • Data Type:
     String
  • Data Length:
     140

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction.agreementId
  • SCMP API Field:
    agreement_id
  • Simple Order API Field:
    agreementID
processingInformation

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. originalAuthorizedAmount

Amount of the original authorization.
This field is available only on the
FDC Compass
,
FDC Nashville Global
,
Streamline
, and
Visa Platform Connect
 processors.
This field is available only for the following types of transactions using Discover:
  • Merchant-initiated transactions.
  • FDC Nashville Global
    :
    Recurring payments that use payment network tokens.
  • FDC Nashville Global
     and
    Streamline
    :
    Subsequent authorizations.

Specifications

  • Data Type:
     String
  • Data Length:
     60

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.originalAuthorizedAmount
  • SCMP API Field:
    subsequent_auth_original_amount
  • Simple Order API Field:
    subsequentAuthOriginalAmount
processingInformation

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. processorTransactionID

This field is available only on the
FDMS Nashville
 processor.
The transaction ID value for subsequent merchant-initiated transactions. The value for this field is returned in the
processorInformation.transactionID
 field in the response message for the initial authorization in the series.

Specifications

  • Data Type:
     String
  • Data Length:
     16

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.initiator. merchantinitiatedTransaction.processorTransactionID
  • SCMP API Field:
    processor_trans_id
  • Simple Order API Field:
    processorTransId
processingInformation

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. reason

The reason for the incremental authorization or merchant-initiated transaction.
This field is available only for incremental authorizations and the types of merchant-initiated transactions identified in the table of possible values below.
This field is available only on the
FDC Compass
 and
Visa Platform Connect
 processors.
To include this field in an API request, set the value of the field to one of the values in the Possible Values column.
Field Values
Possible Values
Transaction Type
Supported Card Type(s)
1
Resubmission
  • Discover
  • Mastercard
  • Visa
2
Delayed charge
  • Discover
  • Mastercard
  • Visa
3
Reauthorization
  • Discover
  • Visa
4
No show
  • Discover
  • Mastercard
  • Visa
5
Incremental authorization
  • Discover
  • Visa
6
Partial shipment
  • Discover
  • Mastercard
7
Recurring or subscription
  • Mastercard
8
Standing order
  • Mastercard
9
Installment
  • Mastercard
10
Unscheduled Card-on-File (COF)
  • American Express
  • Discover
  • Mastercard
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR0
  • Position: 160-163
  • Field: Message Reason Code

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions. initiator.merchantInitiatedTransaction.reason
  • SCMP API Field:
    subsequent_auth_reason
  • Simple Order API Field:
    subsequentAuthReason
processingInformation

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. previousTransactionID

Network transaction identifier that was returned for a previous authorization in the series.
This field is available only on the
FDC Compass
,
FDI Australia
, and
Visa Platform Connect
 processors.
The value for this field was returned in the
processorInformation.transactionID
 field in the response message for either the original authorization in the series or the previous authorization in the series.
FDI Australia
This field is supported only for installment payments and merchant-initiated transactions.

Specifications

  • Data Type:
     String
  • Data Length:
    • 29 (Discover and Diners Club)
    • 15 (All other card types)

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions. initiator.merchantInitiatedTransaction.previousTransactionID
  • SCMP API Field:
    subsequent_auth_transaction_id
  • Simple Order API Field:
    subsequentAuthTransactionID
processingInformation

processingInformation. authorizationOptions. initiator. storedCredentialUsed

Indicates whether you obtained the payment information from credentials on file (COF) instead of from the customer.
This field is supported only for
FDC Compass
 and
Visa Platform Connect
.
Possible values:
  • true
    : Transaction uses COF.
  • false
    : Transaction does not use COF.
When you use the
Token Management Service
, this field is set to
true
 for you.

Specifications

  • Data Type:
     Boolean

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions. initiator.storedCredentialUsed
  • SCMP API Field:
    subsequent_auth_stored_credential
  • Simple Order API Field:
    subsequentAuthStoredCredential
processingInformation

processingInformation. authorizationOptions. initiator.type

Indicates whether the requested installment payment or recurring payment is a merchant-initiated transaction (MIT).
This field is available only on the
FDC Compass
,
FDC Nashville Global
,
Streamline
, and
Visa Platform Connect
 processors.
This field can be used with these request fields:
  • The
    processingInformation.commerceIndicatore
     field set to
    recurring
     (for recurring transactions) or
    install
     (for installment transactions).
  • The
    processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.reason
    subsequentAuthReason
     field set to any value supported for that field.
Possible values:
  • merchant
    : Merchant-initiated transaction.
  • customer
    : Not a merchant-initiated transaction.
Visa Platform Connect
:
The value for this field does not correspond to any data in the TC 33 capture file.

Specifications

  • Data Type:
     String
  • Data Length:
     8

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.initiator.type
  • SCMP API Field:
    subsequent_auth
  • Simple Order API Field:
    subsequentAuth
processingInformation

processingInformation. authorizationOptions. partialAuthIndicator

Flag that specifies whether partial authorizations are enabled.
This field is available only for the
FDC Compass
 and
Visa Platform Connect
 processor.
When a request includes this field, this value overrides the information in your account. Possible values:
  • true
    : Enables partial authorization transactions.
  • false
    : Does not enable partial authorization transactions.
Visa Platform Connect
To set the default for this field, contact customer support.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR0
  • Position: 164
  • Field: Additional Authorization Indicators

Specifications

  • Data Type:
     String
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.partialAuthIndicator
  • SCMP API Fields:
    • auth_partial_auth_indicator
    • pin_debit_purchase_partial_auth_indicator
  • Simple Order API Fields:
    • ccAuthService_partialAuthIndicator
    • pinDebitPurchaseService_partialAuthIndicator
processingInformation

processingInformation. authorizationOptions. paymentTypeIndicator

This value indicates whether the transaction is a Credential-on-File, installment, or recurring payment. It is sent only for transactions processed by SMCC.
Possible values:
  • C
    : Credential on File for initial storage, or unscheduled card on file for subsequent merchant-initiated transactions.
  • I
    : Installment payment.
  • R
    : Recurring payment, such as for utility bills and magazines.

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.paymentTypeIndicator
  • SCMP API Field:
    payment_type_indicator
  • Simple Order API Field:
    paymentTypeIndicator
processingInformation

processingInformation. authorizationOptions. splitPaymentTransaction

Flag that indicates a split payment transaction. A split payment allows the use of two payment methods for a single transaction.
Possible values:
  • true
    : split payment transaction is supported
  • false
     (default): split payment transaction is not supported

Specifications

  • Data Type:
     Boolean
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.splitPaymentTransaction
  • SCMP API Field:
    split_payment_transaction
  • Simple Order API Field:
    ccAuthService_splitPaymentTransaction
processingInformation

processingInformation. authorizationOptions. transactionMode

Identifies the type of transaction.
This field is required for all mobile and telephone transactions from Saudi Arabia merchants.
Possible values:
  • M
    : mobile order
  • T
    : telephone order

Specifications

  • Data Type:
     Alphanumeric
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.transactionMode
  • SCMP API Field:
    transaction_mode
  • Simple Order API Field:
    transactionMode
processingInformation

processingInformation. authorizationOptions. transportationMode

Mode of transportation or type of transportation-related payment.
This field is available only for the
Visa Platform Connect
 processor.
Possible values:
  • 00
    : Use this value for debt recovery, more than one transportation mode, or an unknown transportation mode.
  • 01
    : Urban bus
  • 02
    : Interurban bus
  • 03
    : Light train mass transit
  • 04
    : Train
  • 05
    : Commuter train
  • 06
    : Waterborne vehicle
  • 07
    : Toll
  • 08
    : Parking
  • 09
    : Taxi
  • 10
    : High-speed train
  • 11
    : Rural bus
  • 12
    : Express commuter train
  • 13
    : Paratransit
  • 14
    : Self-driving vehicle
  • 15
    : Coach
  • 16
    : Locomotive
  • 17
    : Powered motor coach
  • 18
    : Trailer
  • 19
    : Regional train
  • 20
    : Inter-city transportation
  • 21
    : Funicular train
  • 22
    : Cable car
This field is supported only for mass transit transactions.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR7
  • Position: 153-154
  • Field: Transportation Mode 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:
     2

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.transportationMode
  • SCMP API Field:
    transportation_mode
  • Simple Order API Field:
    ccAuthService_transportationMode
processingInformation

processingInformation. authorizationOptions. verbalAuthCode

Authorization code you received verbally or other manner outside of the system.

Specifications

  • Data Type:
     String
  • Data Length:
     7
  • Data Length:
    • JCN Gateway
      :
      Data Length:
       6 (captures), 7 (all other services)
    • All other processors:
       7

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.verbalAuthCode
  • SCMP API Fields:
    • auth_code
    • pin_debit_purchase_authorization_code
  • Simple Order API Fields:
    • ccAuthService_verbalAuthCode
    • ccCaptureService_verbalAuthCode
    • pinDebitPurchaseService_verbalAuthCode
processingInformation

processingInformation. authorizationOptions. verbalAuthTransactionId

Transaction ID (TID).
This field is available only for the American Express card type on the
American Express Direct
 and
FDMS South
 processors.
This field enables you to comply with American Express CAPN requirements.
Forced Capture
Obtain the value for this field from the authorization response.
Verbal Authorization
You cannot obtain a value for this field so
Cybersource
 uses the default value of
000000000000000
 (15 zeros).

Specifications

  • Data Type:
     String
  • Data Length:
     15

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.verbalAuthTransactionId
  • SCMP API Field:
    bill_transaction_id
  • Simple Order API Field:
    ccCaptureService_transactionID
processingInformation

processingInformation. authorizationOptions. cardVerificationIndicator

Indicates a card verification check during a transaction.
Possible values:
  • True:
     Transaction includes a card verification check.
  • False:
     Transaction does not include a card verification check.

Specifications

  • Data Type:
     String
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.cashAdvanceIndicator
  • SCMP API Field:
    auth_card_verification_indicator
  • Simple Order API Field:
    ccAuthService_cardVerificationIndicator
processingInformation

processingInformation. bankTransferOptions. effectiveDate

Effective date for the transaction.
The effective date must be within 45 days of the current day. If you do not include this value,
Cybersource
 sets the effective date to the next business day.
Format:
 MMDDYYYY
This field is available only for the
Cybersource ACH Service
 processor.
When the effective date is not set, the echeck transaction is batched at the next available batch time. When the echeck transaction is batched, the payment status changes to Payment. However, when the effective date is set to a date in advance, the transaction batches on the set date. While the transaction is awaiting batching, the transaction status is set to Submitted. When the echeck transaction is batched on the effective date, the transaction status changes to Payment.

Specifications

  • Data Type:
     String
  • Data Length:
     8
  • REST API Field:
    processingInformation.bankTransferOptions.effectiveDate
  • SCMP API Field:
    ecp_effective_date
  • Simple Order API Fields
    • ecCreditService_effectiveDate
    • ecDebitService_effectiveDate
processingInformation

processingInformation. bankTransferOptions. fraudScreeningLevel

Level of fraud screening. Possible values:
  • 1
    : Validation (default if the field has not already been configured for your merchant ID)
  • 2
    : Verification
  • 3
    : Guarantee

Specifications

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

Mapping Information

  • REST API Field:
    processingInformation.bankTransferOptions.fraudScreeningLevel
  • SCMP API Fields:
    • ecp_debit_verification_level
    • ecp_verification_level
  • Simple Order API Fields:
    • ecDebitReply_verificationLevel
    • ecDebitService_verificationLevel
processingInformation

processingInformation. bankTransferOptions. paymentCategoryCode

Flag that indicates whether to process the payment.
Use with deferred payments.
Possible values:
  • 0
    : Standard debit with immediate payment (default).
  • 1
    : For deferred payments, indicates that this is a deferred payment and that you will send a debit request with
    ecp_payment_mode
    =
    2
     in the future.
  • 2
    : For deferred payments, indicates notification to initiate payment.
    • Chase Paymentech Solutions
      and
      TeleCheck
      processors: use for deferred and partial payments.
    • Cybersource
       ACH Service
      : not used.

Specifications

  • Data Type:
     Integer
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.bankTransferOptions.paymentCategoryCode
  • SCMP API Field:
    ecp_payment_mode
  • Simple Order API Fields:
    ecDebitService_paymentMode
processingInformation

processingInformation. bankTransferOptions. secCode

Authorization method used for the transaction.
Possible values:
  • ARC
    : Accounts receivable conversion; check mailed and processed electronically
    (only used with the
    Chase Paymentech Solutions
     processor)
  • CCD
    : Cash concentration or disbursement; funds distributed or consolidated between corporate entities
    (do not use with the
    TeleCheck
     processor)
  • PPD
    : Prearranged payment and deposit; payment from a non-consumer organization to a consumer account
  • TEL
    : Telephone initiated
  • WEB
    : Internet or wireless network initiated
Chase Paymentech Solutions
In Canada, use
WEB
 for all ACH transactions.

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    processingInformation.bankTransferOptions.secCode
  • SCMP API Field:
    ecp_sec_code
  • Simple Order API Fields:
    check_secCode
processingInformation

processingInformation. bankTransferOptions. settlementMethod

Method used to settle the credit. Possible values:
  • A
    : Automated Clearing House
  • B
    : Best possible
  • F
    : Facsimile

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.bankTransferOptions.settlementMethod
  • SCMP API Fields:
    • ecp_credit_settlement_method
    • ecp_debit_settlement_method
    • ecp_settlement_method
  • Simple Order API Fields:
    • ccCreditReply_settlementMethod
    • ecCreditReply_settlementMethod
    • ecCreditService_settlementMethod
    • ecDebitReply_settlementMethod
    • ecDebitService_settlementMethod
processingInformation

processingInformation. bankTransferOptions. terminalCity

City in which the terminal is located.
If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.

Specifications

  • Data Type:
     String
  • Data Length:
     4

Mapping Information

  • REST API Field:
    processingInformation.bankTransferOptions.terminalCity
  • SCMP API Field:
    ecp_terminal_city
  • Simple Order API Fields:
    check_terminalCity
processingInformation

processingInformation. bankTransferOptions. terminalState

State in which the terminal is located.
If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.

Specifications

  • Data Type:
     String
  • Data Length:
     2-character USPS code

Mapping Information

  • REST API Field:
    processingInformation.bankTransferOptions.terminalState
  • SCMP API Field:
    ecp_terminal_state
  • Simple Order API Fields:
    check_terminalState
processingInformation

processingInformation. binSource

Source of the bank identification number (BIN).
You must provide the BIN source value for a source-level lookup. When you do not include this field, the lookup is performed against the default merged BIN sources data.
Possible values:
  • itmx
  • rupay

Specifications

  • Data Type:
     String
  • Data Length:
     20

Mapping Information

No corresponding fields.
processingInformation

processingInformation. businessApplicationId

Type of transaction.
This field is a
pass-through
, which means that the value is not verified or modified in any way before it is sent to the processor.
You can provide a business application ID in this field or in your account. When a request includes this field, the value in the field overrides the information in your account. Call customer support to update your account information.
For all services on the
Visa Platform Connect
 processor
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR8
  • Position: 108-109
  • Field: Business Application Identifier (BAI)
For non-Payouts transactions
Possible values:
  • AA
    : Account to account.
  • BB
    : Business to business.
  • BI
    : Bank-initiated money transfer.
  • BP
    : Non-card bill payment.
  • CB
    : Consumer Bill Payment
  • CC
    : Cash claim.
  • CI
    : Cash in.
  • CO
    : Cash out.
  • CP
    : Card bill payment.
  • FD
    : Funds disbursement (general), including:
    • Commission payments
    • Digital goods or games
    • Insurance payments
    • Loan disbursements
    • Lottery payouts
    • Shared economy
    • Non-government-initiated tax refund services such as tax preparation businesses
  • GD
    : Government disbursement, including:
    • Government-initiated tax refunds
    • Government benefit and welfare disbursements
  • GP
    : Gambling payout other than online gambling.
  • LO
    : Loyalty credits and rebates (not supported in European systems).
  • MA
    : Mobile air time payment.
  • MD
    : Merchant disbursement (acquirers or aggregators settling to merchants).
  • MI
    : Merchant-initiated money transfer.
  • MP
    : Face-to-face merchant payment.
  • OG
    : Online gambling payout.
  • PD
    : Payroll pension disbursement.
  • PG
    : Payment to government.
  • PP
    : Person to person.
  • PS
    : Payment for goods and services (general).
  • RP
    : Request to pay.
  • TU
    : Top-up for enhanced prepaid loads.
  • WT
    : Wallet transfer.
For Payouts transactions on the
Barclays
,
FDC Compass
, and
Visa Platform Connect
 processors
Possible values:
  • BB
    : Business to business.
  • CB
    : Consumer bill payment.
  • FD
    : Funds disbursement (general), including:
    • Commission payments
    • Digital goods or games
    • Insurance payments
    • Loan disbursements
    • Lottery payouts
    • Shared economy
    • Non-government-initiated tax refund services such as tax preparation businesses
  • GD
    : Government disbursement, including:
    • Government-initiated tax refunds
    • Government benefit and welfare disbursements
  • GP
    : Gambling payout other than online gambling.
  • LO
    : Loyalty credits and rebates (not supported in European systems).
  • MD
    : Merchant disbursement (acquirers or aggregators settling to merchants).
  • OG
    : Online gambling payout.
  • PD
    : Payroll pension disbursement.
  • WT
    : Wallet transfer.
Possible values:
  • PP
    : Person to person
  • RP
    : Request to pay.
For Payouts transactions on
Chase Paymentech Solutions
Possible values:
  • PP
    : Person to person.
  • WT
    : Wallet transfer.
For Payouts AFT services only
The
processingInformation.authorizationOptions.aftIndicator
 field is required to be set to
true
 to process
Payouts
 Account Funding Transactions (AFT) services on Visa and Mastercard card types.
You must receive prior approval from the processor before processing AFTs. Contact your processor to participate in AFT services.
For Payouts AFT services on
Barclays
 with Mastercard and Visa
For Mastercard, the
recipientInformation.accountType
 value must align with Business Application Identifier value.
Possible values for Visa:
  • AA
    : Account to account.
  • FD
    : Funds disbursement, e.g. insurance payout.
  • FT
    : Funds transfer where OCT not available.
  • PD
    : Payroll disbursement.
  • TU
    : Top Up: Prepaid load.
  • WT
    : Wallet transfer.
Possible values for Mastercard:
  • AA
    : Account to account. The
    recipientInformation.accountType
     value must be either 01, 02, 03 or 06.
  • FT
    : Funds transfer where OCT not available. The
    recipientInformation.accountType
     value must be either 00, 01, 02, 03 or 06.
  • PD
    : Payroll disbursement. The
    recipientInformation.accountType
     value must be 03.
  • TU
    : Top Up: Prepaid load. The
    recipientInformation.accountType
     value must be either 01, 02, 03 or 06.
  • WT
    : Wallet transfer. The
    recipientInformation.accountType
     value must be either 00, 01, 02, 03, 06 or absent.
For Payouts AFT services on
FDC Nashville Global
 with Mastercard and Visa
Visa will not reject transactions for anything, however, the acquirer will only support the values specified below.
Possible values for Visa:
  • AA
    : Account to account.
  • BI
    : Money transfer (bank-initiated).
  • CB
    : Consumer bill payment.
  • FT
    : Funds transfer.
  • PP
    : Person to person.
  • TU
    : Top Up: Prepaid load.
  • WT
    : Wallet transfer.
Possible values for Mastercard:
  • AA
    : Account to account.
  • BB
    : Business to business.
  • CO
    : Cash out.
  • CP
    : Card bill payment.
  • MD
    : Merchant disbursement (acquirers or aggregators settling to merchants).
  • PP
    : Person to person.
  • WT
    : Wallet transfer.
For Payouts AFT services on
LloydsTSB Cardnet International
, and
First Data Merchant Solutions
 with Mastercard and Visa
Possible values:
  • AA
    : Account to account.
  • BI
    : Money transfer (bank-initiated).
  • FD
    : Funds disbursement, e.g. insurance payout.
  • PD
    : Payroll disbursement.
  • PP
    : Person to person.
  • TU
    : Top Up: Prepaid load.
  • WT
    : Wallet transfer.
For Payouts AFT services on
Streamline
 with Mastercard and Visa
Possible values:
  • AA
    : Account to account.
  • FD
    : Funds disbursement, e.g. insurance payout.
  • FT
    : Funds transfer.
  • PD
    : Payroll disbursement.
  • PP
    : Person to person.
  • TU
    : Top Up: Prepaid load.
  • WT
    : Wallet transfer.

Specifications

  • Data Type:
     String
  • Data Length:
     2

Mapping Information

  • REST API Field:
    processingInformation.businessApplicationId
  • SCMP API Fields:
    • business_application_id
    • consumer_bill_payment
  • Simple Order API Fields:
    • ccAuthService_consumerBillPayment
    • invoiceHeader_businessApplicationID
processingInformation

processingInformation. capture

Flag that indicates whether to include a capture with the authorization, making it a bundled transaction, which is also known as a sale.
Possible values:
  • true
    : Include a capture with the authorization.
  • false
     (default): Do not include a capture with the authorization.

Specifications

  • Data Type:
     Boolean
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.capture
  • SCMP API Field:
     No corresponding field
  • Simple Order API Field:
     No corresponding field
processingInformation

processingInformation. captureOptions. captureSequenceNumber

Capture number when requesting multiple partial captures for one authorization.
This value is used along with
processingInformation.captureOptions.totalCaptureCount
 to track which capture is being processed.
Example:
 These are the values for the second of five captures:
processingInformation.captureOptions.captureSequenceNumber=2
processingInformation.captureOptions.totalCaptureCount=5
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR8
  • Position: 158-159
  • Field: Clearing Sequence Number

Specifications

  • Data Type:
     Integer
  • Data Length:
     2

Mapping Information

  • REST API Field:
    processingInformation.captureOptions.captureSequenceNumber
  • SCMP API Field:
    capture_sequence
  • Simple Order API Field:
    ccCaptureService_sequence
processingInformation

processingInformation. captureOptions. dateToCapture

Date on which the customer initiated a contactless transit transaction.
This field is available only for mass transit transactions.
Format:
 MMDD

Specifications

  • Data Type:
     String
  • Data Length:
     4

Mapping Information

  • REST API Field:
    processingInformation.captureOptions.dateToCapture
  • SCMP API Field:
    auth_capture_date
  • Simple Order API Field:
    ccAuthService_captureDate
processingInformation

processingInformation. captureOptions. isFinal

Indicates whether to release the authorization hold on the remaining funds.
Possible values:
  • true
    : Release the authorization hold on the remaining funds.
  • false
     Do not release the authorization hold on the remaining funds.

Specifications

  • Data Type:
     String
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.captureOptions.isFinal
  • SCMP API Field:
    ap_capture_is_final
  • Simple Order API Field:
    apCaptureService_isFinal
processingInformation

processingInformation. captureOptions. totalCaptureCount

Total number of captures when requesting multiple partial captures for one authorization.
This value is used along with
processingInformation.captureOptions.captureSequenceNumber
 to track which capture is being processed.
When you do not know the total number of captures that you are going to request, set this field to at least one more than the
processingInformation.captureOptions.captureSequenceNumber
 field until you reach the final capture. For the final capture, set both fields to the same value.
Example:
 These are the values for the second of five captures:
processingInformation.captureOptions.captureSequenceNumber=2
processingInformation.captureOptions.totalCaptureCount=5
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR8
  • Position: 160-161
  • Field: Clearing Sequence Count

Specifications

  • Data Type:
     Integer
  • Data Length:
     2

Mapping Information

  • REST API Field:
    processingInformation.captureOptions.totalCaptureCount
  • SCMP API Field:
    capture_total_count
  • Simple Order API Field:
    ccCaptureService_totalCount
processingInformation

processingInformation. commerceIndicator

Type of transaction.
Some payment card companies use this information when determining discount rates.
Possible Values for the Authorization Service:
E-Commerce Indicator Values
Value
Description
5
Secure e-commerce transaction with a credential-on-file (COF) token. Include
paymentinformation.tokenizedCard.cryptogram
 in the authorization request.
aesk
American Express SafeKey authentication was successful.
aesk attempted
American Express SafeKey authentication was attempted but did not succeed.
dipb
Discover card type.
install
Installment payment. For merchant-initiated transactions on
Visa Platform Connect
 with Mastercard in India or with an India-issued card, the
install
 value is used for the installment payment scenario and for unscheduled credentials-on-file transactions.
install_internet
Non-U.S. e-commerce (Internet) installment payment. This value is not supported on all processors.
internet
Default value for authorizations. E-commerce order placed from a website.
js
JCB J/Secure authentication was successful.
js_attempted
JCB J/Secure authentication was attempted but did not succeed.
moto
Mail order or telephone order.
moto_cc
Mail order or telephone order from a call center. This value is available only on gateways in Asia, the Middle East, and Africa. Contact your Customer Support representative for details.
pb
ProtectBuy authentication was successful.
pb_attempted
ProtectBuy authentication was attempted but did not succeed.
recurring
Recurring payment that is a U.S. transaction or non-U.S. mail order/telephone order (MOTO) transaction. For merchant-initiated transactions on
Visa Platform Connect
 with Mastercard in India or with an India-issued card, the
recurring
 value is used for the recurring payment scenario.
recurring_internet
Recurring payment that is a non-U.S. e-commerce (Internet) transaction.
retail
Card-present transaction.
rpy
RuPay
 PaySecure authentication was successful.
spa
  • For Mastercard Identity Check: Authentication was successful or was attempted but did not succeed. The e-commerce indicator for all Mastercard Identity Check transactions, including authentication attempts, must be set to
    spa
    . Otherwise, the transactions are processed as non-identity check transactions.
  • For secure transactions in France: Successful authentication for a Mastercard card or a Cartes Bancaires card that is co-badged with Mastercard.
spa_failure
  • For Mastercard Identity Check: Authentication failed.
  • For secure transactions in France: Authentication failure for a Mastercard card or a Cartes Bancaires card that is co-badged with Mastercard.
up3ds
For secure transactions for
China UnionPay
: Authentication was successful for a China UnionPay domestic debit card.
up3ds_attempted
For secure transactions for
China UnionPay
: Authentication was attempted but did not succeed for a China UnionPay domestic debit card.
up3ds_failure
For secure transactions for
China UnionPay
 domestic debit cards: Authentication failed for a China UnionPay domestic debit card.
vbv
  • For Visa Secure: Authentication was successful.
  • For secure transactions in France: Successful authentication for a Visa card or a Cartes Bancaires card that is co-badged with Visa.
vbv_attempted
  • For Visa Secure: Authentication was attempted but did not succeed.
  • For secure transactions in France: Authentication was attempted for a Visa card or a Cartes Bancaires card that is co-badged with Visa.
vbv_failure
  • For Visa Secure: Authentication failed.
  • For secure transactions in France: Authentication failure for a Visa card or a Cartes Bancaires card that is co-badged with Visa.
Possible values for the credit service
  • internet
    : E-commerce order placed through a website.
  • moto
    : Mail order or telephone order.
    Not supported on
    Cielo
     or
    UATP
    .
    On
    Barclays
    , this value is not permitted for Mestro International cards.
  • recurring
    : Recurring payment that is a U.S. transaction or non-U.S. MOTO transaction.
    On
    Barclays
    , this value is not permitted for Mestro International cards.
  • recurring_internet
    : Recurring payment that is a non-U.S. e-commerce (Internet) transaction.
Card-Present Transactions
For a card-present transaction, you must set this field to
retail
.
Payer Authentication
When you request the payer authentication and authorization services separately, get the value for this field from the
processingInformation.commerceIndicator
 response field.
PIN Debit Transactions
For a PIN debit transaction, you must set this field to
retail
.
Apple Pay
For the merchant decryption method, one of these values is required:
aesk
,
dipb
,
internet
,
spa
,
vbv
.
Samsung Pay
For the merchant decryption method, one of these values is required:
aesk
,
internet
,
spa
.
Payouts
For the
Barclays
 processor, the value for an account funding transaction (AFT) can be one of these indicators:
  • internet
    —For a transaction that does not use 3-D Secure.
  • vbv
     or
    vbv_attempted
    —For a transaction that uses 3-D Secure.
For the
Chase Paymentech Solutions
 processor, the value for an account funding transaction (AFT) and original credit transaction (OCT) is
internet
.
For the
FDC Compass
 and
Visa Platform Connect
 processors, the value for an original credit transaction (OCT) is
internet
.

Specifications

  • Data Type:
     String
  • Data Length:
    • Account funding transaction (AFT): 20
    • Card-not-present transaction: 20
    • Card-present transaction: 20
    • Original credit transaction (OCT): 13
    • PIN debit transaction: 13

Mapping Information

  • REST API Field:
    processingInformation.commerceIndicator
  • SCMP API Field:
    e_commerce_indicator
  • Simple Order API Fields:
    • ccAuthService_commerceIndicator
    • ccCreditService_commerceIndicator
    • octService_commerceIndicator
    • pinDebitCreditService_commerceIndicator
    • pinDebitPurchaseService_commerceIndicator
processingInformation

processingInformation. electronicBenefitsTransfer.category

Flag that specifies the category for the EBT transaction.
Possible values:
  • cash
    : Cash benefits, which can be used to purchase any item at a participating retailer, as well as to obtain cash-back or make a cash withdrawal from a participating ATM.
  • food
    : Food stamp benefits, which can be used only to purchase food items authorized by the USDA SNAP program.

Specifications

  • Data Type:
     String
  • Data Length:
     4

Mapping Information

  • REST API Field:
    processingInformation.electronicBenefitsTransfer.category
  • SCMP API Field:
    pin_debit_ebt_category
  • Simple Order API Fields:
    • pinDebitCreditService_ebtCategory
    • pinDebitPurchaseService_ebtCategory
processingInformation

processingInformation. electronicBenefitsTransfer. voucherSerialNumber

The serial number printed on the EBT voucher.

Specifications

  • Data Type:
     Integer
  • Data Length:
     15

Mapping Information

  • REST API Field:
    processingInformation.electronicBenefitsTransfer.voucherSerialNumber
  • SCMP API Field:
    pin_debit_ebt_voucher_serial_number
  • Simple Order API Field:
    pinDebitPurchaseService_ebtVoucherSerialNumber
processingInformation

processingInformation. enableEscrowOption

Indicates whether to use the customer’s escrow agreement.
The escrow agreement can be used only if the transaction is greater than or equal to 50,000 KRW. You must enter the shipping details in the KCP administration panel for escrow payments.
Primarily used for real estate transactions.
IMPORTANT
Available only for bank transfer payments.
Possible values:
  • true
    : Use the customer’s escrow agreement.
  • false
    : Do not use the customer’s escrow agreement.

Specifications

  • Data Type:
     String
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.enableEscrowOption
  • SCMP API Field:
    ap_initiate_escrow_agreement
  • Simple Order API Field:
    apInitiateService_escrowAgreement
processingInformation

processingInformation. enablerId

This field is the Enabler Verification Value (EVV) that Visa assigns to identify an enabler.
Instead of using acquirers, some merchants use enablers to process payments. Enablers are third parties with their own systems to process transactions for merchants or acquirers. This EVV is an optional five-character hexadecimal value that Visa assigns to identify the enabler that processes requests for authorization and OCT services. If the wrong enabler ID is used in a transaction, the transaction is still accepted. If the enabler ID character string is longer than five characters, the transaction is declined.
The agent unique ID data is still supported in the TC 33 capture file in the first five positions:
  • Record: CP12 TCR1
  • Position: 138-148
The five positions that follow the agent unique ID in CP12 TCR1 are used for the EVV. The final position is reserved for 0. Except for the first digit which is fixed, CP12-TCR1 positions 138-148 () now occupy all of ISO field 126.18.

Specifications

  • Data Type:
     String
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.enablerId
  • SCMP API Field:
    enabler_id
  • Simple Order API Fields:
    enablerId
processingInformation

processingInformation. extendedCreditTotalCount

Number of months over which the cardholder can pay for the purchase.
You can use this field when offering extended credit to a cardholder at a retail location. The cardholder provides this value. The issuer pays you for the purchase in one payment, and then the cardholder pays the issuer in the number of monthly payments specified by this value.
This field is available only for acquirers in South Africa on the
Visa Platform Connect
 processor.

Specifications

  • Data Type:
     String
  • Data Length:
     2

Mapping Information

  • REST API Field:
    processingInformation.extendedCreditTotalCount
  • SCMP API Field:
    extended_credit_total_count
  • Simple Order API Field:
    extendedCreditTotalCount
processingInformation

processingInformation. fundingOptions.initiator.type

Code that denotes whether the customer identification data belongs to the sender or the recipient.
Possible values:
  • P
    : Payee (recipient)
  • S
    : Payer (sender)
When this field is set to
S
, these API request fields are required:
  • senderInformation.personalIdType
  • senderInformation.personalIdSubType

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.fundingOptions.initiator.type
  • SCMP API Field:
    customer_entity_identifier
  • Simple Order API Field:
    ccAuthService_initiatorType
processingInformation

processingInformation. industryDataType

Indicates whether the transaction includes industry data.
For certain industries, you must set this field to an industry data value to be sent to the processor. When this field is not set to an industry value or is not included in the request, industry data does not go to the processor.
Possible Values
  • airline
  • auto_rental
  • healthcare_medical
  • healthcare_transit
  • lodging
  • restaurant
  • transit

Specifications

  • Data Type:
     String
  • Data Length:
     18

Mapping Information

  • REST API Field:
    processingInformation.industryDataType
  • SCMP API Field:
    industry_datatype
  • Simple Order API Fields:
    • ccAuthService_industryDatatype
    • ccCaptureService_industryDatatype
    • ccCreditService_industryDatatype
processingInformation

processingInformation. issuer.discretionaryData

Data defined by the issuer.
This field is available only for Visa and Mastercard on the
Visa Platform Connect
 processor.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP08 TCR1
  • Position: 5-168
  • Field: Free Form Text
The tables provide examples of the formats for discretionary data specific to acquirers for issuer-funded installment payments. The issuers and acquirers work together to develop and reach consensus on the formats. You must contact your acquirer for information about the formats to use.
Example:
 Discretionary Data Format for Issuer-Funded Installment Payments with Visa Guatemala
VC10000000050000
Discretionary Data Format for Issuer-Funded Installment Payments with Visa Guatemala
Position (Character or Digit #)
Number of Characters or Digits
Description
1-2
2
Prefix. Set this value to
VC
.
3-4
2
Total number of installments.
5-16
12
Total amount.
Example:
Discretionary Data Format for Issuer-Funded Installment Payments with Visa Uruguay
00612012345678910000000008160003359
Discretionary Data Format for Issuer-Funded Installment Payments with VisaNet Uruguay
Position (Character or Digit #)
Number of Characters or Digits
Description
1-2
2
Plan type.
Set this value to
00
.
Specifies that the transaction is an e-commerce transaction.
3
1
Grace period. Number of months that the issuer waits before charging customers.
4-5
2
Total number of installments.
Possible values:
00
 through
99
.
6
1
POS entry mode.
Set this value to
0
.
Specifies that the transaction is an e-commerce transaction.
7-15
9
Identity document number.
Set this value to the number on the customer’s identity document or leave it blank.
Format: right justified with 0 (zero) padding on the left.
16
1
Financial inclusion law indicator. Possible values:
  • 1
    : Law 17934
  • 2
    : Law 18099
  • 3
    : Asignaciones familiares (AFAM) (family allowance program)
  • 4
    : Real state law
  • 5
    : Law 19210
17-28
12
Financial inclusion amount.
This value is the amount the bank returns to the customer.
29-35
7
Merchant-generated invoice number.

Specifications

  • Data Type:
     String
  • Data Length:
     255
IMPORTANT
For an authorization, the maximum length for this value is 255 characters. In the capture file, the value is truncated at 164 characters.

Mapping Information

  • REST API Field:
    issuerInformation.discretionaryData
     and
    processingInformation.issuer.discretionaryData
  • SCMP API Field:
    issuer_additional_data
  • Simple Order API Field:
    issuer_additionalData
processingInformation

processingInformation. japanPaymentOptions. businessName

Business name in Japanese characters.
This field is available only on the
JCN Gateway
 processor, and for the Sumitomo Mitsui Card Co. acquirer on the
Visa Platform Connect
 processor.

Specifications

  • Data Type:
     String
  • Data Length:
     25

Mapping Information

  • REST API Field:
    processingInformation.japanPaymentOptions.businessName
  • SCMP API Field:
    jpo_business_name_japanese
  • Simple Order API Field:
    jpo_businessNameJapanese
processingInformation

processingInformation. japanPaymentOptions.businessNameAlphaNumeric

Business name in alphanumeric characters.
This field is available only on the
JCN Gateway
 processor, and for the Sumitomo Mitsui Card Co. acquirer on the
Visa Platform Connect
 processor.

Specifications

  • Data Type:
     String
  • Data Length:
     25

Mapping Information

  • REST API Field:
    processingInformation.japanPaymentOptions.businessNameAlphaNumeric
  • SCMP API Field:
    jpo_business_name_alphanumeric
  • Simple Order API Field:
    jpo_businessNameAlphanumeric
processingInformation

processingInformation. japanPaymentOptions. businessNameKatakana

Business name in Katakana characters.
This field is available only on the
JCN Gateway
 processor, and for the Sumitomo Mitsui Card Co. acquirer on the
Visa Platform Connect
 processor.

Specifications

  • Data Type:
     String
  • Data Length:
     25

Mapping Information

  • REST API Field:
    processingInformation.japanPaymentOptions.businessNameKatakana
  • SCMP API Field:
    jpo_business_name_katakana
  • Simple Order API Field:
    jpo_businessNameKatakana
processingInformation

processingInformation. japanPaymentOptions.firstBillingMonth

First billing month for a transaction that uses installment payments.
This field is available only on the
JCN Gateway
 processor, and for the Sumitomo Mitsui Card Co. acquirer on the
Visa Platform Connect
 processor.
Possible values: 01 through 12.
When you do not include this field in a request that uses installment payments for one of the Japanese payment options, the first billing month is set to the calendar month that follows the transaction date.

Specifications

  • Data Type:
     String
  • Data Length:
     2

Mapping Information

  • REST API Field:
    processingInformation.japanPaymentOptions.firstBillingMonth
  • SCMP API Field:
    jpo_first_billing_month
  • Simple Order API Field:
    jpo_firstBillingMonth
processingInformation

processingInformation. japanPaymentOptions.jis2TrackData

Japanese Industrial Standard Type 2 (JIS2) track data from the front of the card.
This field is available only on the
JCN Gateway
 and
Visa Platform Connect
 processors.

Specifications

  • Data Type:
     String
  • Data Length:
     69

Mapping Information

  • REST API Field:
    processingInformation.japanPaymentOptions.jis2TrackData
  • SCMP API Field:
    jpo_jis2_track_data
  • Simple Order API Field:
    jpo_jis2TrackData
processingInformation

processingInformation. japanPaymentOptions.paymentMethod

Type of Japanese payment option.
This field is available only on the
JCN Gateway
 processor, and for the Sumitomo Mitsui Card Co. acquirer on the
Visa Platform Connect
 processor.
This field is required for authorization and capture requests if set to these values:
21
,
22
,
23
,
24
,
31
,
32
,
34
,
61
, or
80
.
Possible values:
This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the transaction.
  • 10
    : One-time payment
  • 21
    ,
    22
    ,
    23
    ,
    24
    : Bonus payment (one-time)
  • 31
    ,
    32
    ,
    33
    ,
    34
    : Integrated payment (Bonus + Installment)
  • 61
    : Installment payment
  • 80
    : Revolving payment

Specifications

  • Data Type:
     String
  • Data Length:
     2

Mapping Information

  • REST API Field:
    processingInformation.japanPaymentOptions.paymentMethod
  • SCMP API Field:
    jpo_payment_method
  • Simple Order API Field:
    jpo_paymentMethod
processingInformation

processingInformation. japanPaymentOptions.installments

Number of installment payments.
This field is available only on the
JCN Gateway
 processor, and for the Sumitomo Mitsui Card Co. acquirer on the
Visa Platform Connect
 processor.
This field is required for authorization and capture requests if the value of the
processingInformation.japanPaymentOptions.paymentMethod
 field is set to
21
,
22
,
23
,
24
,
31
,
32
,
33
,
34
, or
80
.

Specifications

  • Data Type:
     String
  • Data Length:
     2

Mapping Information

  • REST API Field:
    processingInformation.japanPaymentOptions.installments
  • SCMP API Field:
    jpo_installments
  • Simple Order API Field:
    jpo_installments
processingInformation

processingInformation. japanPaymentOptions.terminalId

Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by
Cybersource
.
The difference between this field and the
pointOfSaleInformation.terminalId
 field is that you can define the
pointOfSaleInformation.terminalId
 field, but the
processingInformation.japanPaymentOptions.terminalId
 field is defined by the JCCA and is used only in Japan.
This field is available only on the
JCN Gateway
 and
Visa Platform Connect
 processors.
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR9
  • Position: 130-142
  • Field: Terminal Identification Number
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:
     Integer
  • Data Length:
     13

Mapping Information

  • REST API Field:
    processingInformation.japanPaymentOptions.terminalId
  • SCMP API Field:
    jpo_jcca_terminal_id
  • Simple Order API Field:
    jpo_jccaTerminalID
processingInformation

processingInformation. leastCostRouting

Flag that specifies whether to request that the processor use least-cost routing for the transaction.
This field is available only on the
FDI Australia
 and
Worldpay VAP
 processors.
When the request includes this field, this value overrides the information in your account.
Possible values:
  • Y
    : Request that the processor use least-cost routing for the transaction
  • N
     (default): Do not request that the processor use least-cost routing for the transaction

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.leastCostRouting
  • SCMP API Field:
    auth_least_cost_routing
  • Simple Order API Field:
    ccAuthService_leastCostRouting
processingInformation
processingInformation

processingInformation. loanOptions.assetType

Flag that specifies whether a loan is for a recoverable item or a non-recoverable item.
This field is available only for BNDES transactions on the
Visa Platform Connect
 processor.
Possible values:
  • N
    : Non-recoverable item
  • R
    : Recoverable item
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR2
  • Position: 26
  • Field: Asset Indicator

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.loanOptions.assetType
  • SCMP API Field:
    loan_asset_type
  • Simple Order API Field:
    loan_assetType
processingInformation

processingInformation. loanOptions.type

Type of loan or installment payment plan based on an agreement between you and the issuer.
This field is available only for these type of payments on the
Visa Platform Connect
 processor:
  • BINDES transactions
  • Installment payments with Mastercard in Brazil
Example:
 AGRO-CUSTEIO
Example:
 AGRO-INVEST
Example:
 BNDES-Type1
Example:
 CBN
Example:
 FINAME
For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR2
  • Position: 27-46
  • Field: Loan Type
For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR4
  • Position: 5-24
  • Field: Financing Type

Specifications

  • Data Type:
     String
  • Data Length:
     20

Mapping Information

  • REST API Field:
    processingInformation.loanOptions.type
  • SCMP API Field:
    loan_type
  • Simple Order API Field:
    loan_type
processingInformation

processingInformation. merchantVerificationValue

The override value of the Merchant Verification Value received by various card brands.

Specifications

  • Data Type:
     String
  • Data Length:
     25

Mapping Information

  • REST API Field:
    processingInformation.merchantVerificationValue
  • SCMP API Field:
    merchant_verification_value
  • Simple Order API Field:
    CCAuthService_merchantVerificationValue
processingInformation

processingInformation. mobileRemotePaymentType

Type of payment initiated from a cardholder’s mobile device.
This field is available only for Mastercard transactions on the
Visa Platform Connect
 processor.
Possible values:
  • 1
    : Customer-initiated remote purchase, face-to-face
  • 2
    : Customer-initiated remote purchase, e-commerce
  • 3
    : Customer-initiated remote purchase, mail order / telephone order
  • 4
    : Customer-initiated bill pay
  • 5
    : Customer-initiated top up
  • 6
    : Customer-initiated cash out
  • 7
    : ATM-triggered or agent-initiated cash out
  • 8
    : Merchant-initiated remote purchase, face-to-face
  • 9
    : Merchant-initiated remote purchase, e-commerce
Visa Platform Connect
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR6
  • Position: 94
  • Field: Mastercard Mobile Remote Payment Program Indicator

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.mobileRemotePaymentType
  • SCMP API Field:
    mobile_remote_payment_type
  • Simple Order API Field:
    ccAuthService_mobileRemotePaymentType
processingInformation

processingInformation. nationalNetDomesticData

Supplementary domestic transaction information provided by the acquirer.

Specifications

  • Data Type:
     String
  • Data Length:
     123
IMPORTANT
For an authorization, the maximum length for this value is 255 characters. In the capture file, the value is truncated at 161 characters.

Mapping Information

  • REST API Field:
    processingInformation.nationalNetDomesticData
  • SCMP API Field:
    national_net_domestic_data
  • Simple Order API Field:
    nationalNetDomesticData
processingInformation

processingInformation. networkPartnerID

Merchant payment gateway ID that is assigned by Mastercard and provided by your acquirer when a registered merchant payment gateway service provider is involved in the transaction.
This field is available only for the
Visa Platform Connect
 processor.
For Mastercard transactions on
Visa Platform Connect
, set this field to
00000163065
. If you do not include this field,
Cybersource
 will provide it for you.
If you support card-not-present Mastercard transactions, you must include this field in all transaction requests. When you process card-not-present transactions and do not include this field in your request,
Cybersource
 sets the field value to
00000163065
.

Specifications

  • Data Type:
     String
  • Data Length:
     11

Mapping Information

  • REST API Field:
    processingInformation.networkPartnerId
  • SCMP API Field:
    network_partner_id
  • Simple Order API Field:
    ccAuthService_networkPartnerId
processingInformation

processingInformation. networkRoutingOrder

Priority order of the networks through which the transaction will be routed.
IMPORTANT
This field is supported only for businesses located in the U.S.
Set this value to a series of one-character network codes in your preferred order:
Network
Code
Accel/Exchange
E
AFFN
U
Alaska Option
3
CU24
C
Quest/Electronic Benefits Transfer (EBT)
K
Interlink
G
Maestro
8
NETS
P
NYCE
F
Pulse
H
Shazam (ITS)
7
Star
M
Visa/PLUS
V
For example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of
MH
.
When you do not include this value in your PIN debit request,
Cybersource
 uses the list of network codes from your account.

Specifications

  • Data Type:
     String
  • Data Length:
     30

Mapping Information

  • REST API Field:
    processingInformation.networkRoutingOrder
  • SCMP API Field:
    network_order
  • Simple Order API Fields:
    • pinDebitCreditService_networkOrder
    • pinDebitPurchaseService_networkOrder
processingInformation

processingInformation. originalPaymentId

Links the current merchant initiated transaction (MIT) back to the original customer initiated transaction (CIT).
By linking the merchant initiated transaction back to the original customer initiated transaction, you extend the settlement period by one additional cycle. This is true when the transaction amount is $0 or more.

Specifications

  • Data Type:
     String
  • Data Length:
     11

Mapping Information

  • REST API Field:
    processingInformation.networkPartnerId
  • SCMP API Field:
    network_partner_id
  • Simple Order API Field:
    ccAuthService_networkPartnerId
processingInformation

processingInformation. payByPointsIndicator

Indicates whether transaction uses loyalty points.
Possible values:
  • true
    : Transaction uses loyalty points.
  • false
    : Transaction does not use loyalty points.

Specifications

  • Data Type:
     Boolean
  • Data Length:
     Does not apply

Mapping Information

  • REST API Field:
    processingInformation.payByPointsIndicator
  • SCMP API Field:
    pay_by_points_indicator
  • Simple Order API Field:
    payByPoints_indicator
processingInformation

processingInformation. paymentFlowMode

The indicator for whether a payment is processed using a
hosted order page
 (HOP) or an
inline
 widget.
Possible values:
  • HOP
    : Hosted order page
  • inline
    : Inline widget

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping

  • REST Field Name:
    processingInformation.paymentFlowMode
  • Simple Order Field Name:
    apSessionsService_paymentFlowMode
processingInformation

processingInformation. paymentSolution

Type of payment solution that is being used for the transaction.
This unique ID distinguishes digital payment solution transactions and authorizations with payment network tokens on the
Cybersource
 platform for reporting purposes.
Possible values:
  • 001
    : Apple Pay
  • 004
    :
    Cybersource
     In-App Solution
  • 005
    : Masterpass
  • 006
    : Android Pay
  • 007
    : Chase Pay
  • 008
    : Samsung Pay
  • 012
    : Google Pay
  • 014
    : Mastercard credential-on-file (COF) payment network token. Returned in authorizations that use a payment network token associated with a
    TMS
     token.
  • 015
    : Visa credential-on-file (COF) payment network token. Returned in authorizations that use a payment network token associated with a Token Management Service (
    TMS
    ) token.
  • 027
    : Click to Pay
  • visacheckout
    :
    Visa Click to Pay
    .

Specifications

  • Apple Pay, Google Pay, Samsung Pay, Visa payment network tokens, and Mastercard payment network tokens:
    • Data Type:
       String
    • Data Length:
       3
  • Visa Click to Pay
    :
    • Data Type:
       String
    • Data Length:
       12

Mapping Information

  • REST API Field:
    processingInformation.paymentSolution
  • SCMP API Field:
    payment_solution
  • Simple Order API Field:
    paymentSolution
processingInformation

processingInformation. payoutOptions. deferredDateTime

Date and time when the requested Payouts original credit transaction (OCT) is to be processed.
This field is required for a
Payouts
 OCT service request that specifies a deferred OCT processing date and time.
To use the deferred OCT processing option, include this field in the OCT request and specify the date and time in UTC.
Format:
yyyymmddhhmm
This field is available only for Payouts OCT transactions on the
Visa Platform Connect
 processor.

Specifications

  • Data Type:
     String
  • Data Length:
     12

Mapping Information

  • REST API Field:
    processingInformation.payoutOptions.deferredDateTime
  • SCMP API Field:
    oct_deferred_date_time
  • Simple Order API Field:
    octService_deferredDateTime
processingInformation

processingInformation. payoutOptions. acquirerBin

Acquirer bank identification number (BIN).
The Funds Transfer application is registered under this BIN. This field must match the information provided during enrollment.

Specifications

  • Data Type:
     String
  • Data Length:
     20

Mapping Information

No corresponding fields.
processingInformation

processingInformation. payoutOptions. networkId

The payment network identification code.
The networks specified must be a subset of the information that was provided during program enrollment.
Possible values:
  • 0020
    : Accel/Exchange
  • 0024
    : CU24
  • 0003
    : Interlink
  • 0016
    : Maestro
  • 0018
    : NYCE
  • 0027
    : NYCE
  • 0009
    : Pulse
  • 0017
    : Pulse
  • 0019
    : Pulse
  • 0008
    : Star
  • 0010
    : Star
  • 0011
    : Star
  • 0012
    : Star
  • 0015
    : Star
  • 0002
    : Visa/PLUS

Specifications

  • Data Type:
     String
  • Data Length:
     4

Mapping Information

No corresponding fields.
processingInformation

processingInformation. payoutOptions. payoutInquiry

Request parameter that is related to payouts information in BIN lookup.
Set the field to
true
, and provide attributes so that fund transfer and payouts information are included in the response. When payouts information is not provided or found, the response will have the standard account lookup.
Possible values:
  • true
  • false

Specifications

  • Data Type:
     Boolean
  • Data Length:
     5

Mapping Information

No corresponding fields.
processingInformation

processingInformation. processorId

Value that identifies the acquirer to use for the transaction.
This field is available only on the
Visa Platform Connect
 processor.
Contact customer support to get the value for this field.

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    processingInformation.processorId
  • SCMP API Field:
    processor_id
  • Simple Order API Field:
    processorID
processingInformation

processingInformation. purchaseLevel

Flag indicates the capture or credit request includes Level III data.
Set the value for this field to
3
.
This field is available on the
American Express Direct
,
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
 processors.

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    processingInformation.purchaseLevel
  • SCMP API Field:
    purchasing_level
  • Simple Order API Fields:
    • ccCaptureService_purchasingLevel
    • ccCreditService_purchasingLevel
    On the
    Barclays
     processor, the
    invoiceHeader_purchaserVATRegistrationNumber
     field is available for the capture service, and the
    ccCreditService_purchasingLevel
     field is available for the credit service.
processingInformation

processingInformation. purchaseOptions. isElectronicBenefitsTransfer

Flag that indicates that this transaction is an EBT transaction.
This field is available only on the
Visa Platform Connect
 processor.
Possible value:
EBT

Specifications

  • Date Type:
     Boolean
  • Data Length:
     3

Mapping Information

  • REST API Field:
    processingInformation.purchaseOptions.isElectronicBenefitsTransfer
  • SCMP API Field:
    pin_debit_payment_type
  • Simple Order API Fields:
    • pinDebitCreditService_paymentType
    • pinDebitPurchaseService_paymentType
processingInformation

processingInformation. purchaseOptions.type

This flag indicates an EBT voucher transaction. Also used to indicate the type of transaction for the Mastercard Benefits Payment Scheme in Brazil.
This field is available only on the
Visa Platform Connect
 processor.
Possible values:
  • verbal
    : EBT voucher transaction.
  • 01
    : Meal voucher for the employee nutrition program (PAT).
  • 02
    : Food voucher for the employee nutrition program (PAT).
  • 03
    : Culture voucher for worker's culture program (PCT).
  • 04
    : Meal voucher for the consolidation of labor laws program (CLT).
  • 05
    : Food voucher for the consolidation of labor laws program (CLT).

Specifications

  • Data Type:
     String
  • Data Length:
     6

Mapping Information

  • REST API Field:
    processingInformation.purchaseOptions.type
  • SCMP API Fields:
    • pin_debit_transaction_type
    • auth_transaction_type
  • Simple Order API Fields:
    • pinDebitPurchaseService_transactionType
    • ccAuthReply_transactionType
processingInformation

processingInformation. purchaseOptions. eligibilityIndicator

This flag indicates that this transaction is eligible for the Mastercard Benefits Payment Scheme in Brazil.
This field is available only on the
Visa Platform Connect
 processor.
Possible values:
  • Y
    : This transaction is eligible.
  • N
    : This transaction is not eligible.
The value in this field corresponds to this data in the TC 33 capture file:
  • Record: CP07 TCR0
  • Position: 97-98
  • Field: MasterCard - Brazilian Benefit Program

Specifications

  • Data Type:
     String
  • Data Length:
     1

Mapping Information

  • REST API Field:
    API processingInformation.purchaseOptions.eligibilityIndicator
  • SCMP API Field:
    auth_eligibility_indicator
  • Simple Order API Fields:
    • ccAuthService_eligibilityIndicator
    • ccAuthReply_eligibilityIndicator
processingInformation

processingInformation. purposeOfPayment

This code indicates the purpose of the funds being processed.
This field is received during original credit transactions (OCTs).
Mastercard and Maestro Requirements
IMPORTANT
Mastercard requires merchants processing gambling transactions to include this field in the authorization and refund request and to set its field value to
16
.
This field is available only on the
Visa Platform Connect
 processor.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Field: Purpose of Payment Code
  • Record: CP01 TCR0
  • Position: 53-54

Specifications

  • Data Type:
     String
  • Length:
     12

Mapping Information

  • REST API Field:
    processingInformation.purposeOfPayment
  • SCMP API Field:
    • auth_purpose_of_payment
    • oct_purpose_of_payment
  • Simple Order API Field:
    • authService_purposeOfPayment
    • octService_purposeOfPayment
processingInformation

processingInformation. reconciliationId

Transaction reference number.
Identifier used for tracking a request through to the payment processor for reconciliation.
This value is not returned for all processors.

Syntax

The syntax must conform to this regular expression.
Visa Platform Connect
[a-zA-Z0-9\-]
All other processors:
[a-zA-Z0-9]

Specifications

  • Data Type:
     String
  • Data Length
    :
    • Visa Platform Connect
      : 25
    • TeleCheck
      : 50
    • All other processors
      : 60

Mapping Information

  • REST API Field:
    processingInformation.reconciliationId
  • SCMP API Fields:
    • auth_trans_ref_no
    • ecp_ref_no
  • Simple Order API Fields:
    • ccAuthReply_reconciliationID
    • ecCreditService_referenceNumber
    • ecDebitService_referenceNumber
processingInformation

processingInformation. recurringOptions.firstRecurringPayment

Flag that specifies whether this transaction is the first in a series of recurring payments.
Possible values:
  • true
    : Yes, this is the first payment in a series of recurring payments.
  • false
     (default): No, this is not the first payment in a series of recurring payments.
This field is available only on the
Atos
,
Barclays
,
Credit Mutuel-CIC
,
FDC Nashville Global
 (with American Express cards and Visa cards), and
OmniPay Direct
 processors.

Specifications

  • Data Type:
     String
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.recurringOptions.firstRecurringPayment
  • SCMP API Field:
    auth_first_recurring_payment
  • Simple Order API Field:
    ccAuthService_firstRecurringPayment
processingInformation

processingInformation. recurringOptions.loanPayment

Flag that specifies whether this is a payment towards an existing contractual loan.
Possible values:
  • true
    : Loan payment.
  • false
     (default): Not a loan payment.

Specifications

  • Data Type:
     Boolean

Mapping Information

  • REST API Field:
    processingInformation.recurringOptions.loanPayment
  • SCMP API Field:
    debt_indicator
  • Simple Order API Field:
    debtIndicator
processingInformation

processingInformation. refundOptions.reason

Reason for a refund.
Barclays
:
 Used only for Mastercard and Maestro payment of winning transactions. Restricted to gaming merchants with MCC 7995.

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    processingInformation.refundOptions.reason
  • SCMP API Fields:
    • ap_refund_reason
    • credit_refund_reason
  • Simple Order API Fields:
    • apRefundService_reason
    • ccCreditService_refundReason
processingInformation

processingInformation. reportGroup

Value that you create that enables you to identify a group of transactions.
This field is available only on the
Worldpay VAP
 processor.

Specifications

  • Data Type:
     String
  • Data Length:
     25

Mapping Information

  • REST API Field:
    processingInformation.reportGroup
  • SCMP API Field:
    report_group
  • Simple Order API Field:
    reportGroup
processingInformation

processingInformation. transactionReason

Transaction reason code. Sends the reason code as 5120, which indicates the sales tax/value added tax part of original credit transactions (OCTs).
This field is available only on the
Visa Platform Connect
 processor.
To process Faster Refund Original Credit Transactions (OCTs) in AP and the EU, include these fields in the request:
  • Transaction Type
    • Record: Field 3
    • Positions: 1-2
  • Transaction Amount
    • Record: Field 4
  • Card Acceptor Name or Location
    • Record: Field 43
  • Transaction Identifier
    • Record: Field 62.2 (in bitmap format)
  • Message Reason Code
    • Record: Field 63.3
  • Acceptor Legal Business Name
    • Record: 104, Usage 2—Transaction-Specific Data (in TLV format)
    • Dataset ID: 56
    • Tag: 81
  • Business Application Identifier (BAI)
    • Record: 104, Usage 2—Transaction-Specific Data (in TLV format)
    • Dataset ID: 57
    • Tag: 01
  • Visa Merchant Identifier
    • Record: 126.5

Specifications

  • Data Type:
     String
  • Data Length:
     4

Mapping Information

  • REST API Field:
    processingInformation.transactionReason
  • SCMP API Field:
    transaction_reason
  • Simple Order API Field:
    transactionReason
processingInformation

processingInformation. transactionTimeout

The time limit in seconds for the transaction.
The time limit begins when the customer is directed to the merchant URL that is included in the sale service response. The maximum value is
99999
, which is about 27-hours. When the transaction reaches the time limit, the payment system changes the status to abandoned.

Specifications

  • Data Type:
    Integer
  • Data Length:
    5

Mapping

  • REST Field Name:
    processingInformation.transactionTimeout
  • Simple Order Field Name:
    ap_SaleService_transactionTimeout
processingInformation

processingInformation. transactionTypeIndicator

Transaction type indicator for Mastercard authorizations, authorization reversals, and credits.
Possible values:
  • C02
    : Mastercard rebate
  • C03
    : rePower load value
  • C04
    : Gaming pre-pay
  • C07
    : General person-to-person
  • C52
    : General transfer to own account
  • C53
    : Agent cash out
  • C54
    : Payment of own credit card bill
  • C55
    : Business Disbursement
  • C56
    : Government or non-profit disbursement
  • C57
    : Rapid merchant settlement
  • C58
    : Cash in at ATM (Usage limited to specific countries)
  • C59
    : Cash in at point of sale (Usage limited to specific countries)
  • C65
    : General business to business transfer
  • C67
    : Mastercard merchant-presented QR
  • C68
    : Mastercard merchant-presented QR refund payment
  • C91
    : Utility payments (for Brazil domestic use only)
  • C92
    : Government services (for Brazil domestic use only)
  • C93
    : Mobile phone top ups (for Brazil domestic use only)
  • C94
    : Coupon booklet payments (for Brazil domestic use only)
  • F07
    : General person-to-person transfer
  • F08
    : Person-to-person transfer to card account
  • F52
    : General transfer to own account
  • F53
    : Agent cash out
  • F54
    : Payment of own credit card bill
  • F55
    : Business disbursement
  • F61
    : Transfer to own staged digital wallet account
  • F64
    : Transfer to own debit or prepaid account
  • F65
    : General business-to-business transfer
  • P10
    : Installment-based repayment
  • P01
    : Mastercard ATM cash pick-up transaction
  • P70
    : Cryptocurrency
  • P71
    : High-risk securities

Specifications

  • Data Type:
     String
  • Data Length:
     3

Mapping Information

  • REST API Field:
    processingInformation.transactionTypeIndicator
  • SCMP API Field:
    transaction_type_indicator
  • Simple Order API Field:
    transactionTypeIndicator
processingInformation

processingInformation. visaCheckoutID

Identifier for a
Visa Click to Pay
 order.
Visa Click to Pay
 provides a unique order ID for every transaction in the
Visa Click to Pay
callID
 field.

Specifications

  • Data Type:
     String
  • Data Length:
     48

Mapping Information

  • REST API Field:
    processingInformation.visaCheckoutID
  • SCMP API Field:
    vc_order_id
  • Simple Order API Field:
    vc_orderID
processingInformation

processingInformation. walletType

Type of wallet.
This field is available only on the
FDC Compass
,
FDC Nashville Global
,
FDI Australia
,
Visa Platform Connect
, and
TSYS Acquiring Solutions
 processors.
Set the value for this field to
VCIND
.
FDC Compass
,
FDC Nashville Global
,
FDI Australia
, and
TSYS Acquiring Solutions
The value that is sent to the processor is the value that the processor expects for this field.
Visa Platform Connect
This field is a
passthrough
; therefore, the value is not verified or modified in any way before it is sent to the processor.
The value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR8
  • Position: 72-76
  • Field: Agent Unique ID

Specifications

  • Data Type:
     String
  • Data Length:
     5

Mapping Information

  • REST API Field:
    processingInformation.walletType
  • SCMP API Field:
    wallet_type
  • Simple Order API Field:
    wallet_type
processingInformation

processingInformation. purchaseOptions. benefitAmount

This field is the benefit amount being processed. It is for the Workplace Benefit Product for acquirers and issuers in the Europe region.
Possible values:
  • 12.00
    : Benefit amount in regional currency being processed.

Specifications

  • Data Type:
     String
  • Data Length:
     20

Mapping Information

  • REST API Field:
    processingInformation.purchaseOptions.benefitAmount
  • SCMP API Fields:
    • benefit_amount
  • Simple Order API Fields:
    • benefit_amount
processingInformation

processingInformation. purchaseOptions. benefitType

This field value is the type of benefit. It is for the Workplace Benefit Product for acquirers and issuers in the Europe region.
This field is available only for Visa Platform Connect.
Possible values:
  • 00
    : Not applicable
  • 10
    : Savings Account
  • 20
    : Checking Account
  • 30
    : Credit Card Account
  • 40
    : "Universal" Account (represented by customer ID)
  • 70
    : Employee Benefit
  • 96
    : Cash Benefits Account (for use by Electronic Benefits Transfer transactions only)
  • 98
    : Food Stamps Account (for use by Electronic Benefits Transfer transactions only)
  • 4T
    : Transportation/Transit
  • 52
    : General benefit
  • 53
    : Meal voucher
  • 54
    : Fuel
  • 55
    : Ecological/Sustainability
  • 58
    : Philanthropy/Patronage/Consumption
  • 59
    : Gift
  • 5S
    : Sports/Culture
  • 5T
    : Book/Education

Specifications

  • Data Type:
     String
  • Data Length:
     100

Mapping Information

  • REST API Field:
    processingInformation.purchaseOptions.benefitType
  • SCMP API Fields:
    • benefit_type
  • Simple Order API Fields:
    • benefit_type
processingInformation

processingInformation.authorizationOptions.serviceType

This field value defines the type of Account Funding Transaction (AFT).
The service type value,
0B
, denotes a back-to-back funding transaction that automatically transfers funds from one bank account to the account used to make a purchase. This type of transaction ensures that the purchasing account maintains adequate funds.
This field value is used in request and response for Europe domestic and intra-EEA AFTs.
Possible values:
  • 00
     = Normal transaction
  • 01
     = Originator hold
  • 02
     = Visa deferred Original Credit Transaction (OCT) hold, default interval
  • 03
     = Visa deferred OCT hold, user-defined interval
  • 09
     = Cancel pending deferred OCT request
  • 0B
     = Back-to-back transactions for AFT
  • 0I
     = Visa Direct custom program 1
  • 0Q
     = Query the status of the deferred OCT
  • A0
     = Alias Directory 2

Specifications

  • Data Type:
     String
  • Data Length:
     10

Mapping Information

  • REST API Field:
    processingInformation.authorizationOptions.serviceType
  • SCMP API Field:
    service_processing_service_type
  • Simple Order API Field:
    serviceProcessing_serviceType
processingInformation