Authorization and Creating TMS Tokens with a Transient Token

This section provides the minimal set of information required to perform a successful authorization and create TMS tokens (customer, payment isntrument, and shipping address) with a transient token.

Endpoint

Production:

POST https://api.cybersource.com/pts/v2/payments

Test:

POST https://apitest.cybersource.com/pts/v2/payments

Required Fields for an Authorization and Creating TMS Tokens with a Transient Token

orderInformation.amountDetails.currency orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount orderInformation.amountDetails.totalAmount
orderInformation.billTo.address1 orderInformation.billTo.address1
orderInformation.billTo.administrativeArea orderInformation.billTo.administrativeArea
orderInformation.billTo.country orderInformation.billTo.country
orderInformation.billTo.email orderInformation.billTo.email
orderInformation.billTo.firstName orderInformation.billTo.firstName
orderInformation.billTo.lastName orderInformation.billTo.lastName
orderInformation.billTo.locality orderInformation.billTo.locality
orderInformation.billTo.postalCode orderInformation.billTo.postalCode
orderInformation.shipTo.address1 orderInformation.shipTo.address1
orderInformation.shipTo.administrativeArea orderInformation.shipTo.administrativeArea
orderInformation.shipTo.country orderInformation.shipTo.country
orderInformation.shipTo.firstName orderInformation.shipTo.firstName
orderInformation.shipTo.lastName orderInformation.shipTo.lastName
orderInformation.shipTo.locality orderInformation.shipTo.locality
orderInformation.shipTo.postalCode orderInformation.shipTo.postalCode
processingInformation.actionList processingInformation.actionList: Set this field to
TOKEN_CREATE
.
processingInformation.actionTokenTypes.customer
processingInformation.actionTokenTypes.paymentInstrument
processingInformation.actionTokenTypes.shippingAddress
tokenInformation.transientTokenJwt

REST Interactive Example: Authorization and Creating TMS Tokens with a Transient Token

Required fields are denoted with an *. Objects with ^ are optional, however if provided, they have required fields under them - marked with an *

Request Builder

clientReferenceInformation

code

reconciliationId

pausedRequestId

transactionId

comments

partner

originalTransactionId

developerId

solutionId

thirdPartyCertificationNumber

applicationName

applicationVersion

applicationUser

processingInformation

actionList

enableEscrowOption

actionTokenTypes

binSource

capture

Request: Live Console

POST:https://apitest.cybersource.com/pts/v2/payments
Change
Sample Request:Payment with Flex Token(Create Permanent TMS token)
Payment Processor Type:Chase Paymentech (Default)
Change

Body

Success: Copy Successful

 
{
  "clientReferenceInformation": {
    "code": "TC50171_3"
  },
  "processingInformation": {
    "actionList": [
      "TOKEN_CREATE"
    ],
    "actionTokenTypes": [
      "customer",
      "paymentInstrument",
      "shippingAddress"
    ]
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "102.21",
      "currency": "USD"
    },
    "billTo": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "1 Market St",
      "locality": "san francisco",
      "administrativeArea": "CA",
      "postalCode": "94105",
      "country": "US",
      "email": "test@cybs.com",
      "phoneNumber": "4158880000"
    },
    "shipTo": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "1 Market St",
      "locality": "san francisco",
      "administrativeArea": "CA",
      "postalCode": "94105",
      "country": "US"
    }
  },
  "tokenInformation": {
    "transientTokenJwt": "eyJraWQiOiIwODVLd3ZiZHVqZW1DZDN3UnNxVFg3RG5nZzlZVk04NiIsImFsZyI6IlJTMjU2In0.eyJkYXRhIjp7Im51bWJlciI6IjQxMTExMVhYWFhYWDExMTEiLCJ0eXBlIjoiMDAxIn0sImlzcyI6IkZsZXgvMDgiLCJleHAiOjE1OTU2MjAxNTQsInR5cGUiOiJtZi0wLjExLjAiLCJpYXQiOjE1OTU2MTkyNTQsImp0aSI6IjFFMTlWWVlBUEFEUllPSzREUUM1NFhRN1hUVTlYN01YSzBCNTc5UFhCUU1HUUExVU1MOFI1RjFCM0IzQTU4MkIifQ.NKSM8zuT9TQC2OIUxIFJQk4HKeHhj_RGWmEqOQhBi0TIynt_kCIup1UVtAlhPzUfPWLwRrUVXnA9dyjLt_Q-pFZnvZ2lVANbiOq_R0us88MkM_mqaELuInCwxFeFZKA4gl8XmDFARgX1aJttC19Le6NYOhK2gpMrV4i0yz-IkbScsk0_vCH3raayNacFU2Wy9xei6H_V0yw2GeOs7kF6wdtMvBNw_uoLXd77LGE3LmV7z1TpJcG1SXy2s0bwYhEvkQGnrq6FfY8w7-UkDBWT1GhU3ZVP4y7h0l1WEX2xqf_ze25ZiYJQfWrEWPBHXRubOpAuaf4rfeZei0mRwPU-sQ"
  }
}

Response

Descriptions

201

Successful response.

_links
Type object

_links

self
Type object

self

reversal
Type object

reversal

capture
Type object

capture

customer
Type object

customer

paymentInstrument
Type object

paymentInstrument

shippingAddress
Type object

shippingAddress

instrumentIdentifier
Type object

instrumentIdentifier

id
Type stringMaxLength 26

An unique identification number generated by Cybersource to identify the submitted request. Returned by all services.
It is also appended to the endpoint of the resource.
On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.

message
Type string

More information about the transaction response.

submitTimeUtc
Type string

Time of request in UTC. Format: YYYY-MM-DDThh:mm:ssZ
Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).
The T separates the date and the time. The Z indicates UTC.

Returned by Cybersource for all services.

status
Type string

The status of the submitted transaction.

Possible values:

AUTHORIZED
PARTIAL_AUTHORIZED
AUTHORIZED_PENDING_REVIEW
AUTHORIZED_RISK_DECLINED
PENDING_AUTHENTICATION
PENDING_REVIEW
DECLINED
INVALID_REQUEST

reconciliationId
Type stringMaxLength 60

Reference number for the transaction.
Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by Cybersource.
The actual value used in the request to the processor is provided back to you by Cybersource in the response.

errorInformation
Type object

errorInformation

clientReferenceInformation
Type object

clientReferenceInformation

processingInformation
Type object

processingInformation

bankTransferOptions
Type object

bankTransferOptions

paymentSolution
Type stringMaxLength 12

Type of digital payment solution for the transaction. Possible Values:

visacheckout: Visa Checkout. This value is required for Visa Checkout transactions. For details, see payment_solution field description in Visa Checkout Using the REST API.
001: Apple Pay.
004: Cybersource In-App Solution.
005: Masterpass. This value is required for Masterpass transactions on OmniPay Direct.
006: Android Pay.
007: Chase Pay.
008: Samsung Pay.
012: Google Pay.
013: Cybersource P2PE Decryption
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 TMS token.
027: Click to Pay.

enhancedDataEnabled
Type boolean

The possible values for the reply field are:

true : the airline data was included in the request to the processor.
false : the airline data was not included in the request to the processor.

Returned by authorization, capture, or credit services.

captureOptions
Type object

captureOptions

authorizationOptions
Type object

authorizationOptions

purchaseOptions
Type object

purchaseOptions

processorInformation
Type object

processorInformation

authIndicator
Type stringMaxLength 1

Flag that specifies the purpose of the authorization.

Possible values:

0: Preauthorization
1: Final authorization

approvalCode
Type stringMaxLength 6

Authorization code. Returned only when the processor returns this value.

The length of this value depends on your processor.

Returned by authorization service.

PIN debit

Authorization code that is returned by the processor.

Returned by PIN debit credit.

Elavon Encrypted Account Number Program

The returned value is OFFLINE.

TSYS Acquiring Solutions

The returned value for a successful zero amount authorization is 000000.

cardReferenceData
Type stringMaxLength 56

The Scheme reference data is a variable length data element up to a maximum of 56 characters. It may be sent by the acquirer in the
authorisation response message, and by the terminal (unchanged) in subsequent authorisation request messages associated with the same
transaction.
This field is used by Streamline and HSBC UK only, at present.

transactionId
Type stringMaxLength 50

Network transaction identifier (TID). You can use this value to identify a specific transaction when you are
discussing the transaction with your processor. Not all processors provide this value.

Returned by the authorization service.

PIN debit

Transaction identifier generated by the processor.

Returned by PIN debit credit.

GPX

Processor transaction ID.

Cielo

For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.

Comercio Latino

For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.

Cybersource through VisaNet and GPN

For details about this value for Cybersource through VisaNet and GPN, see "processorInformation.networkTransactionId" in REST API Fields

Moneris

This value identifies the transaction on a host system. It contains the following information:

Terminal used to process the transaction
Shift during which the transaction took place
Batch number
Transaction number within the batch
You must store this value. If you give the customer a receipt, display this value on the receipt.

Example For the value
66012345001069003:

Terminal ID = 66012345
Shift number = 001
Batch number = 069
Transaction number = 003

networkTransactionId
Type string

Same value as processorInformation.transactionId

responseCode
Type stringMaxLength 10

For most processors, this is the error message sent directly from the bank. Returned only when the processor
returns this value.

Important Do not use this field to evaluate the result of the authorization.

PIN debit

Response value that is returned by the processor or bank.
Important Do not use this field to evaluate the results of the transaction request.

Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal.

AIBMS

If this value is 08, you can accept the transaction if the customer provides you with identification.

Atos

This value is the response code sent from Atos and it might also include the response code from the bank.
Format: aa,bb with the two values separated by a comma and where:

aa is the two-digit error message from Atos.
bb is the optional two-digit error message from the bank.

Comercio Latino

This value is the status code and the error or response code received from the processor separated by a colon.
Format: [status code]:E[error code] or [status code]:R[response code]
Example 2:R06

JCN Gateway

Processor-defined detail error code. The associated response category code is in the processorInformation.responseCategoryCode field.
String (3)

paypalgateway

Processor generated ID for the itemized detail.

responseCodeSource
Type stringMaxLength 1

Used by Visa only and contains the response source/reason code that identifies the source of the response decision.

responseDetails
Type stringMaxLength 255

This field might contain information about a decline. This field is supported only for Cybersource through
VisaNet.

responseCategoryCode
Type stringMaxLength 36

Processor-defined response category code. The associated detail error code is in the processorInformation.responseCode or issuerInformation.responseCode
field of the service you requested.

This field is supported only for:

Japanese issuers
Domestic transactions in Japan
Comercio Latino—processor transaction ID required for troubleshooting

Maximum length for processors

Comercio Latino: 36
All other processors: 3

forwardedAcquirerCode
Type stringMaxLength 32

Name of the Japanese acquirer that processed the transaction. Returned only for JCN Gateway.
Please contact the Cybersource Japan Support Group for more information.

settlementDate
Type stringMaxLength 4

Field contains a settlement date. The date is in mmdd format, where: mm = month and dd = day.

sequenceNumber
Type stringMaxLength 50

This field serves as a unique identifier for initial and subsequent recurring transactions, specific to the payment brand, and is crucial for transaction tracking and recurrence management. Not all processors provide this value.
Returned by the authorization service.

avs
Type object

avs

cardVerification
Type object

cardVerification

merchantAdvice
Type object

merchantAdvice

code
Type stringMaxLength 2

Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won’t approve the transactions and where the retry is allowed.
Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.
In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.

Processors supported:

HSBC
Barclays
FDC Nash
FDI Global
Elavon America
VPC
Rede
Payment tech Salem

Possible values:

Card Type	Advice Code	Description
VISA	1	Issuer never approves
VISA	2	Issuer cannot approve at this time
VISA	3	Data quality/revalidate payment information
MasterCard	01	New account information available
MasterCard	02	Try Again Later
MasterCard	03	Do Not Try Again
MasterCard	04	Token not supported
MasterCard	21	Do not honor
MasterCard	22	Merchant does not qualify for product code
MasterCard	24	Retry after 1 hour
MasterCard	25	Retry after 24 hours
MasterCard	26	Retry after 2 days
MasterCard	27	Retry after 4 days
MasterCard	28	Retry after 6 days
MasterCard	29	Retry after 8 days
MasterCard	30	Retry after 10 days
MasterCard	40	Consumer non-reloadable prepaid card
MasterCard	41	Consumer single-use virtual card number
MasterCard	42	Sanctions score exceeds threshold value
MasterCard	99	Do Not Try Again

codeRaw
Type stringMaxLength 4

Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.

Cybersource through VisaNet

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR7
Position: 96-99
Field: Response Data-Merchant Advice Code

nameMatch
Type stringMaxLength 2

Visa Platform Connect

The field contains will contain the Account Name Request Result for zero amount Authorization request. Valid values are:

00 = Name Match Performed
01 = Name Match not Performed
02 = Name Match not supported

electronicVerificationResults
Type object

electronicVerificationResults

code
Type stringMaxLength 1

Mapped Electronic Verification response code for the customer’s name.

codeRaw
Type stringMaxLength 1

Raw Electronic Verification response code from the processor for the customer’s last name

email
Type stringMaxLength 1

Mapped Electronic Verification response code for the customer’s email address.

emailRaw
Type stringMaxLength 1

Raw Electronic Verification response code from the processor for the customer’s email address.

phoneNumber
Type stringMaxLength 1

Mapped Electronic Verification response code for the customer’s phone number.

phoneNumberRaw
Type stringMaxLength 1

Raw Electronic Verification response code from the processor for the customer’s phone number.

postalCode
Type stringMaxLength 1

Mapped Electronic Verification response code for the customer’s postal code.

postalCodeRaw
Type stringMaxLength 1

Raw Electronic Verification response code from the processor for the customer’s postal code.

street
Type stringMaxLength 1

Mapped Electronic Verification response code for the customer’s street address.

streetRaw
Type stringMaxLength 1

Raw Electronic Verification response code from the processor for the customer’s street address.

name
Type stringMaxLength 30

Visa Platform Connect

Mapped Electronic Verification response code for the customer’s name.

Valid values :

'Y' Yes, the data Matches
'N' No Match
'O' Partial Match

nameRaw
Type stringMaxLength 30

Visa Platform Connect

Raw Electronic Verification response code from the processor for the customer’s name.

Valid values :

'01' Match
'50' Partial Match
'99' No Match

firstNameRaw
Type stringMaxLength 2

Visa Platform Connect

Raw electronic verification response code from the processor for the customer’s first name.

Valid values :

'01' Match
'50' Partial Match
'99' No Match

firstName
Type stringMaxLength 1

Visa Platform Connect

Mapped electronic verification response code from the processor for the customer’s first name.

Valid values :

'Y' Yes, the data Matches
'N' No Match
'O' Partial Match

middleNameRaw
Type stringMaxLength 2

Visa Platform Connect

Raw electronic verification response code from the processor for the customer’s middle name.

Valid values :

'01' Match
'50' Partial Match
'99' No Match

middleName
Type stringMaxLength 1

Visa Platform Connect

Mapped electronic verification response code from the processor for the customer’s middle name.

Valid values :

'Y' Yes, the data Matches
'N' No Match
'O' Partial Match

lastNameRaw
Type stringMaxLength 2

Visa Platform Connect

Raw electronic verification response code from the processor for the customer’s last name.

Valid values :

'01' Match
'50' Partial Match
'99' No Match

lastName
Type stringMaxLength 1

Visa Platform Connect

Mapped electronic verification response code from the processor for the customer’s last name.

Valid values :

'Y' Yes, the data Matches
'N' No Match
'O' Partial Match

achVerification
Type object

achVerification

customer
Type object

customer

consumerAuthenticationResponse
Type object

consumerAuthenticationResponse

systemTraceAuditNumber
Type stringMaxLength 6

This field is returned only for American Express Direct and Cybersource through VisaNet.
Returned by authorization and incremental authorization services.

American Express Direct

System trace audit number (STAN). This value identifies the transaction and is useful when investigating a
chargeback dispute.

Cybersource through VisaNet

System trace number that must be printed on the customer’s receipt.

paymentAccountReferenceNumber
Type stringMaxLength 29

Payment Account Reference (PAR) is a non-financial reference assigned to each unique payment account and used to link a payment account to associated network tokens, i.e. the same PAR is returned for PAN-based and tokenized transactions, such as from digital wallets. PAR can be returned in authorisation responses for requests initiated with both real PANs and tokenized PANs. PAR can be used by merchants for fraud detection and regulatory compliance across different channels and digital wallets. PAR allows all participants in the payments chain to have a single, non-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder identification fields, and transmitted across the payments ecosystem to facilitate card holder identification.

Note On Cybersource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8
Position: 79-110
Field: Payment Account Reference

The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to Cybersource.
Cybersource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer,
who uses this information to facilitate end-of-day clearing processing with payment networks.

transactionIntegrityCode
Type stringMaxLength 2

Transaction integrity classification provided by Mastercard. This value specifies Mastercard’s evaluation of
the transaction’s safety and security. This field is returned only for Cybersource through VisaNet.

For card-present transactions, possible values:

A1: EMV or token in a secure, trusted environment
B1: EMV or chip equivalent
C1: Magnetic stripe
E1: Key entered
U0: Unclassified

For card-not-present transactions, possible values:

A2: Digital transactions
B2: Authenticated checkout
C2: Transaction validation
D2: Enhanced data
E2: Generic messaging
U0: Unclassified

For information about these values, contact Mastercard or your acquirer.

Cybersource through VisaNet

The value for this field corresponds to the following data in the TC 33 capture file,¹:

Record: CP01 TCR6
Position: 136-137
Field: Mastercard Transaction Integrity Classification

¹ The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to Cybersource.
Cybersource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses
this information to facilitate end-of-day clearing processing with payment networks.

amexVerbalAuthReferenceNumber
Type stringMaxLength 6

Referral response number for a verbal authorization with FDMS Nashville when using an American Express card.
Give this number to American Express when you call them for the verbal authorization.

masterCardServiceCode
Type stringMaxLength 2

Mastercard service that was used for the transaction. Mastercard provides this value to Cybersource.

Possible value:

53: Mastercard card-on-file token service

Cybersource through VisaNet

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6
Position: 133-134
Field: Mastercard Merchant on-behalf service.

Note This field is returned only for Cybersource through VisaNet.

masterCardServiceReplyCode
Type stringMaxLength 1

Result of the Mastercard card-on-file token service. Mastercard provides this value to Cybersource.

Possible values:

C: Service completed successfully.
F: One of the following:
- Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or
  authorization reversal.
- Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.
- Token requestor ID is missing or formatted incorrectly.
I: One of the following:
- Invalid token requestor ID.
- Suspended or deactivated token.
- Invalid token (not in mapping table).
T: Invalid combination of token requestor ID and token.
U: Expired token.
W: Primary account number (PAN) listed in electronic warning bulletin.

Note This field is returned only for Cybersource through VisaNet.

masterCardAuthenticationType
Type stringMaxLength 1

Type of authentication for which the transaction qualifies as determined by the Mastercard authentication
service, which confirms the identity of the cardholder. Mastercard provides this value to Cybersource.

Possible values:

1: Transaction qualifies for Mastercard authentication type 1.
2: Transaction qualifies for Mastercard authentication type 2.

Cybersource through VisaNet

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6
Position: 132
Field: Mastercard Member Defined service.

Note This field is returned only for Cybersource through VisaNet.

name
Type stringMaxLength 30

Name of the Processor.

routing
Type object

routing

Code	Network
0000	Priority Routing or Generic File Update
0002	Visa programs, Private Label and non-Visa Authorization Gateway Services
0003	Interlink
0004	Plus
0008	Star
0009	Pulse
0010	Star
0011	Star
0012	Star (primary network ID)
0013	AFFN
0015	Star
0016	Maestro
0017	Pulse (primary network ID)
0018	NYCE (primary network ID)
0019	Pulse
0020	Accel
0023	NETS
0024	CU24
0025	Alaska Option
0027	NYCE
0028	Shazam
0029	EBT POS

merchantNumber
Type stringMaxLength 15

Identifier that was assigned to you by your acquirer. This value must be printed on the receipt.

Returned by

Authorizations and Credits.

This reply field is only supported by merchants who have installed client software on their POS terminals and
use these processors:

American Express Direct
Credit Mutuel-CIC
FDC Nashville Global
OmniPay Direct
SIX

retrievalReferenceNumber
Type stringMaxLength 20

Ingenico ePayments

Unique number that Cybersource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report.

Cybersource through VisaNet

Retrieval request number.

paymentUrl
Type stringMaxLength 15

Direct the customer to this URL to complete the payment.

completeUrl
Type stringMaxLength 2048

The redirect URL for forwarding the consumer to complete page. This redirect needed by PSP to track browser information of consumer.
PSP then redirect consumer to merchant success URL.

signature
Type string

signature

publicKey
Type string

publicKey

sellerProtection
Type object

sellerProtection

transactionExpiryDate
Type stringMaxLength 8

The date on which the transaction expires and payment cannot be made.

customUrl
Type string

For merchants to declare customs
Customs declaration service URL.

schemeAssignedId
Type stringMaxLength 150

Unique id assigned to a merchant by the APM and not PSP
The merchant ID, as boarded with Alipay

deviceUrl
Type stringMaxLength 50

The QR code value. Convert this value into an image and send it to the POS terminal to be displayed. The terminal can also perform the conversion.
The value is a URL like in the example below:
https://qr.alipay.com/pmxabcka1ts5grar12.

disbursementMode
Type string

The funds are released to the merchant immediately.
INSTANT The funds are released to the merchant immediately.
DELAYED The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.

updateTimeUtc
Type string

The date and time when the transaction was last updated, in Internet date and time format.

expirationTimeUtc
Type string

The date and time when the authorized payment expires, in Internet date and time format.

orderId
Type string

The id of the order

orderStatus
Type stringMaxLength 255

The order status.
Possible values:

CREATED
VOIDED
COMPLETED
PAYER_ACTION_REQUIRED

merchantRiskPrediction
Type stringMaxLength 150

Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region.
A newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices.

issuerInformation
Type object

issuerInformation

country
Type stringMaxLength 3

Country in which the card was issued. This information enables you to determine whether the card was issued
domestically or internationally. Use the two-character ISO Standard Country Codes.

This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase
Paymentech Solutions.

discretionaryData
Type stringMaxLength 255

Data defined by the issuer.

The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.

This field is supported only for Visa transactions on Cybersource through VisaNet.

countrySpecificDiscretionaryData
Type stringMaxLength 140

Data defined by the issuer.

This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan.
This subfield contains the Katakana text to be printed on the receipt.

responseCode
Type stringMaxLength 6

This is the raw Association/Issuer Response Codes. You can use ‘issuer/association’ response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You’ll receive an association/issuer response code for the majority of transactions.

Processors supported:

HSBC
FDC Nashville Global
SIX

Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor.

Possible values:

Card Type	Response Code	Description
VISA	000	Successful approval/completion or that V.I.P. PIN verification is successful
VISA	001	Refer to card issuer
VISA	002	Refer to card issuer, special condition
VISA	003	Invalid merchant or service provider
VISA	004	Pickup card
MasterCard	000	Approved or completed successfully
MasterCard	001	Refer to card issuer
MasterCard	003	Invalid merchant
MasterCard	004	Capture card
MasterCard	005	Do not honor
AMEX	000	Approved
AMEX	001	Approve with ID
AMEX	002	Partial Approval (Prepaid Cards only)
AMEX	100	Deny
AMEX	101	Expired Card/Invalid Expiration Date
Discover	000	Approved or completed successfully
Discover	001	Reserved for future USE
Discover	002	Reserved for future USE
Discover	003	Invalid Merchant
Discover	004	Capture Card

pinRequestIndicator
Type stringMaxLength 1

This field contains value ‘1’ which is sent by Issuer in the response when PIN is requested by issuer,

This field is only supported for Visa Platform Connect.

paymentAccountInformation
Type object

paymentAccountInformation

card
Type object

card

suffix
Type string

Last four digits of the cardholder’s account number. This field is included in the reply message when the client software
that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details.

You must contact customer support to have your account enabled to receive these fields in the credit reply message.

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

PIN debit

This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.

Returned by PIN debit credit and PIN debit purchase.

This field is supported only by the following processors:

American Express Direct
Credit Mutuel-CIC
FDC Nashville Global
OmniPay Direct
SIX

expirationMonth
Type stringMaxLength 2

Two-digit month in which the payment card expires.

Format: MM.

Valid values: 01 through 12. Leading 0 is required.

Barclays and Streamline

For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value
(01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is
in the past does not cause Cybersource to reject your request. However, an invalid expiration date might cause
the issuer to reject your request.

Encoded Account Numbers

For encoded account numbers (type=039), if there is no expiration date on the card, use 12.

FDMS Nashville

Required field.

All other processors

Required if pointOfSaleInformation.entryMode=keyed. However, this field is optional if your account is configured
for relaxed requirements for address data and expiration date. Important It is your responsibility to determine
whether a field is required for the transaction you are requesting.

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

expirationYear
Type stringMaxLength 4

Four-digit year in which the payment card expires.

Format: YYYY.

Barclays and Streamline

For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause Cybersource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.

Encoded Account Numbers

For encoded account numbers (type=039), if there is no expiration date on the card, use 2021.

FDMS Nashville

Required field.

FDC Nashville Global and FDMS South

You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.

All other processors

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

type
Type string

Three-digit value that indicates the card type.

IMPORTANT It is strongly recommended that you include the card type field in request messages even if it is
optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type.

Possible values:

001: Visa. Use card type value 001 for Visa Electron.
002: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.
003: American Express
004: Discover
005: Diners Club
006: Carte Blanche[^1]
007: JCB[^1]
008: Optima
009: GE Private Label
010: Beneficial Private Label
011: Twinpay Credit Card
012: Twinpay Debit Card
013: WalMart
014: Enroute[^1]
015: Lowe's Consumer
016: Home Depot Consumer
017: MBNA
018: Dick's Sportswear
019: Casual Corner
020: Sears
021: JAL[^1]
023: Disney Card
024: Maestro (UK Domestic)[^1]
025: Sam's Club Consumer
026: Sam's Club Business
027: Nico's
028: Paymentech Bill Me Later
029: Bebe
030: Restoration Hardware
031: Delta Online
032: Solo
033: Visa Electron[^1]. Do not use this value. Use 001 for all Visa card types.
034: Dankort[^1]
035: Laser
036: Cartes Bancaires[^1,4]
037: Carta Si[^1]
038: Pinless Debit
039: Encoded account number[^1]
040: UATP[^1]
041: HOUSEHOLD
042: Maestro (International)[^1]
043: GE MONEY
044: Korean Cards
045: Style Cards
046: JCrew
047: Payeasecn eWallet
048: Payeasecn Bank Transfer
049: Meijer
050: Hipercard[^2,3]
051: Aura
052: Redecard
053: Orico card
054: Elo[^3]
055: Capitol One Private Label
056: Carnet
057: Costco Private Label
058: Carnet
059: ValueLink
060: MADA
061: RuPay
062: China UnionPay
063: Falabella Private Label
064: Prompt Card
065: Korean Domestic
066: Banricompras
067: MEEZA
068: PayPak
070: EFTPOS
071: Codensa
072: Olimpica
073: Colsubsidio
074: Tuya
075: Sodexo
076: Naranja
077: Cabal
078: DINELCO
079: PANAL
080: EPM
081: Jaywan

[^1]: For this card type, you must include the paymentInformation.card.type or paymentInformation.tokenizedCard.type field in your request for an authorization or a stand-alone credit.
[^2]: For this card type on Cielo 3.0, you must include the paymentInformation.card.type or paymentInformation.tokenizedCard.type field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.
[^3]: For this card type on Getnet and Rede, you must include the paymentInformation.card.type or paymentInformation.tokenizedCard.type field in a request for an authorization or a stand-alone credit.
[^4]: For this card type, you must include the paymentInformation.card.type in your request for any payer authentication services.

Used by

Authorization
Required for Carte Blanche and JCB.
Optional for all other card types.

Card Present reply

This field is included in the reply message when the client software that is installed on the POS terminal uses
the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to
have your account enabled to receive these fields in the credit reply message.

Returned by the Credit service.

This reply field is only supported by the following processors:

American Express Direct
Credit Mutuel-CIC
FDC Nashville Global
OmniPay Direct
SIX

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

GPX

This field only supports transactions from the following card types:

Visa
Mastercard
AMEX
Discover
Diners
JCB
Union Pay International

prefix
Type stringMaxLength 6

Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number.

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

hashedNumber
Type stringMaxLength 60

Visa Platform Connect

This API field will contain the SHA 256 hashed value of PAN.

paymentInformation
Type object

paymentInformation

card
Type object

card

suffix
Type string

You must contact customer support to have your account enabled to receive these fields in the credit reply message.

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

PIN debit

This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder.

Returned by PIN debit credit and PIN debit purchase.

This field is supported only by the following processors:

American Express Direct
Credit Mutuel-CIC
FDC Nashville Global
OmniPay Direct
SIX

expirationMonth
Type stringMaxLength 2

Two-digit month in which the payment card expires.

Format: MM.

Valid values: 01 through 12. Leading 0 is required.

Barclays and Streamline

Encoded Account Numbers

For encoded account numbers (type=039), if there is no expiration date on the card, use 12.

FDMS Nashville

Required field.

All other processors

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

expirationYear
Type stringMaxLength 4

Four-digit year in which the payment card expires.

Format: YYYY.

Barclays and Streamline

Encoded Account Numbers

For encoded account numbers (type=039), if there is no expiration date on the card, use 2021.

FDMS Nashville

Required field.

FDC Nashville Global and FDMS South

You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.

All other processors

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

type
Type string

Three-digit value that indicates the card type.

Possible values:

001: Visa. Use card type value 001 for Visa Electron.
002: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.
003: American Express
004: Discover
005: Diners Club
006: Carte Blanche[^1]
007: JCB[^1]
008: Optima
009: GE Private Label
010: Beneficial Private Label
011: Twinpay Credit Card
012: Twinpay Debit Card
013: WalMart
014: Enroute[^1]
015: Lowe's Consumer
016: Home Depot Consumer
017: MBNA
018: Dick's Sportswear
019: Casual Corner
020: Sears
021: JAL[^1]
023: Disney Card
024: Maestro (UK Domestic)[^1]
025: Sam's Club Consumer
026: Sam's Club Business
027: Nico's
028: Paymentech Bill Me Later
029: Bebe
030: Restoration Hardware
031: Delta Online
032: Solo
033: Visa Electron[^1]. Do not use this value. Use 001 for all Visa card types.
034: Dankort[^1]
035: Laser
036: Cartes Bancaires[^1,4]
037: Carta Si[^1]
038: Pinless Debit
039: Encoded account number[^1]
040: UATP[^1]
041: HOUSEHOLD
042: Maestro (International)[^1]
043: GE MONEY
044: Korean Cards
045: Style Cards
046: JCrew
047: Payeasecn eWallet
048: Payeasecn Bank Transfer
049: Meijer
050: Hipercard[^2,3]
051: Aura
052: Redecard
053: Orico card
054: Elo[^3]
055: Capitol One Private Label
056: Carnet
057: Costco Private Label
058: Carnet
059: ValueLink
060: MADA
061: RuPay
062: China UnionPay
063: Falabella Private Label
064: Prompt Card
065: Korean Domestic
066: Banricompras
067: MEEZA
068: PayPak
070: EFTPOS
071: Codensa
072: Olimpica
073: Colsubsidio
074: Tuya
075: Sodexo
076: Naranja
077: Cabal
078: DINELCO
079: PANAL
080: EPM
081: Jaywan

Used by

Authorization
Required for Carte Blanche and JCB.
Optional for all other card types.

Card Present reply

Returned by the Credit service.

This reply field is only supported by the following processors:

American Express Direct
Credit Mutuel-CIC
FDC Nashville Global
OmniPay Direct
SIX

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

GPX

This field only supports transactions from the following card types:

Visa
Mastercard
AMEX
Discover
Diners
JCB
Union Pay International

prefix
Type stringMaxLength 6

Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number.

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

hashedNumber
Type stringMaxLength 60

Visa Platform Connect

This API field will contain the SHA 256 hashed value of PAN.

tokenizedCard
Type object

tokenizedCard

prefix
Type stringMaxLength 6

First six digits of token. Cybersource includes this field in the reply message when it decrypts the payment
blob for the tokenized transaction.

suffix
Type stringMaxLength 4

Last four digits of token. Cybersource includes this field in the reply message when it decrypts the payment
blob for the tokenized transaction.

For details, see token_suffix field description in [Google Pay Using the SCMP API.]
(https://apps.Cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/)

type
Type string

Three-digit value that indicates the card type.

Possible values:

001: Visa. Use card type value 001 for Visa Electron.
002: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.
003: American Express
004: Discover
005: Diners Club
006: Carte Blanche[^1]
007: JCB[^1]
008: Optima
009: GE Private Label
010: Beneficial Private Label
011: Twinpay Credit Card
012: Twinpay Debit Card
013: WalMart
014: Enroute[^1]
015: Lowe's Consumer
016: Home Depot Consumer
017: MBNA
018: Dick's Sportswear
019: Casual Corner
020: Sears
021: JAL[^1]
023: Disney Card
024: Maestro (UK Domestic)[^1]
025: Sam's Club Consumer
026: Sam's Club Business
027: Nico's
028: Paymentech Bill Me Later
029: Bebe
030: Restoration Hardware
031: Delta Online
032: Solo
033: Visa Electron[^1]. Do not use this value. Use 001 for all Visa card types.
034: Dankort[^1]
035: Laser
036: Cartes Bancaires[^1,4]
037: Carta Si[^1]
038: Pinless Debit
039: Encoded account number[^1]
040: UATP[^1]
041: HOUSEHOLD
042: Maestro (International)[^1]
043: GE MONEY
044: Korean Cards
045: Style Cards
046: JCrew
047: Payeasecn eWallet
048: Payeasecn Bank Transfer
049: Meijer
050: Hipercard[^2,3]
051: Aura
052: Redecard
053: Orico card
054: Elo[^3]
055: Capitol One Private Label
056: Carnet
057: Costco Private Label
058: Carnet
059: ValueLink
060: MADA
061: RuPay
062: China UnionPay
063: Falabella Private Label
064: Prompt Card
065: Korean Domestic
066: Banricompras
067: MEEZA
068: PayPak
070: EFTPOS
071: Codensa
072: Olimpica
073: Colsubsidio
074: Tuya
075: Sodexo
076: Naranja
077: Cabal
078: DINELCO
079: PANAL
080: EPM
081: Jaywan

Used by

Authorization
Required for Carte Blanche and JCB.
Optional for all other card types.

Card Present reply

Returned by the Credit service.

This reply field is only supported by the following processors:

American Express Direct
Credit Mutuel-CIC
FDC Nashville Global
OmniPay Direct
SIX

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

GPX

This field only supports transactions from the following card types:

Visa
Mastercard
AMEX
Discover
Diners
JCB
Union Pay International

assuranceLevel
Type stringMaxLength 2

Confidence level of the tokenization. This value is assigned by the token service provider.

Note This field is supported only for Cybersource through VisaNet and FDC Nashville Global.

Returned by PIN debit credit or PIN debit purchase.

Note Merchants supported for Cybersource through VisaNet/Visa Platform Connect are advised not to use this field.

expirationMonth
Type stringMaxLength 2

One of two possible meanings:

The two-digit month in which a token expires.
The two-digit month in which a card expires.
Format: MM
Possible values: 01 through 12

NOTE The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.

Barclays and Streamline

For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause Cybersource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.

Encoded Account Numbers

For encoded account numbers (card_type=039), if there is no expiration date on the card, use 12.
Important It is your responsibility to determine whether a field is required for the transaction you are requesting.

Samsung Pay and Apple Pay

Month in which the token expires. Cybersource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.

expirationYear
Type stringMaxLength 4

One of two possible meanings:

The four-digit year in which a token expires.
The four-digit year in which a card expires.
Format: YYYY
Possible values: 1900 through 3000
Data type: Non-negative integer

NOTE The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.

Barclays and Streamline

For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through
3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause Cybersource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.

Encoded Account Numbers

For encoded account numbers (card_ type=039), if there is no expiration date on the card, use 2021.

FDC Nashville Global and FDMS South

You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of
the year.

Samsung Pay and Apple Pay

Year in which the token expires. Cybersource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.

Important It is your responsibility to determine whether a field is required for the transaction
you are requesting.

requestorId
Type stringMaxLength 11

Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value
is assigned by the token service provider and is unique within the token service provider’s database.

Note This field is supported only for Cybersource through VisaNet and FDC Nashville Global.

PIN debit

Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.

assuranceMethod
Type stringMaxLength 2

Confidence level of the tokenization. This value is assigned by the token service provider.

Note This field is supported only for Visa Platform Connect

tokenizedPaymentMethod
Type object

tokenizedPaymentMethod

accountFeatures
Type object

accountFeatures

accountType
Type stringMaxLength 2

Type of account. This value is returned only if you requested a balance inquiry. Possible values:

00: Not applicable or not specified
10: Savings account
20: Checking account
30: Credit card account
40: Universal account

PIN debit

Type of account. This value is returned only if you requested a balance inquiry.

Possible values:

00: Not applicable or not specified
10: Savings account
20: Checking account
40: Universal account
96: Cash benefits account
98: Food stamp account

Returned by PIN debit purchase.

accountStatus
Type stringMaxLength 1

Possible values:

N: Nonregulated
R: Regulated

Returned by PIN debit credit or PIN debit purchase.

Note This field is returned only for Cybersource through VisaNet.

balances
Type array

This is an array of multiple balances information an issuer can return for a given card.

balanceAmount
Type stringMaxLength 12

Remaining balance on the account.

Returned by authorization service.

PIN debit

Remaining balance on the prepaid card.

Returned by PIN debit purchase.

balanceAmountType
Type stringMaxLength 2

Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value
that is returned. Possible values for deposit accounts:

01: Current ledger (posted) balance.
02: Current available balance, which is typically the ledger balance less outstanding authorizations.

Some depository institutions also include pending deposits and the credit or overdraft line associated with the
account. Possible values for credit card accounts:

01: Credit amount remaining for customer (open to buy).
02: Credit limit.

currency
Type stringMaxLength 5

Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.

Returned by authorization service.

PIN debit

Currency of the remaining balance on the prepaid card.

Returned by PIN debit purchase.

balanceSign
Type stringMaxLength 8

Sign for the remaining balance on the account. Returned only when the processor returns this value. Possible values:

Possible values:

Positive
Negative

PIN debit

Sign for the remaining balance on the prepaid card. Returned only when the processor returns this value.

Returned by PIN debit purchase.

affluenceIndicator
Type stringMaxLength 13

Chase Paymentech Solutions

Indicates whether a customer has high credit limits. This information enables you to market high cost items to
these customers and to understand the kinds of cards that high income customers are using.

This field is supported for Visa, Mastercard, Discover, and Diners Club. Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

Litle

Flag that indicates that a Visa cardholder or Mastercard cardholder is in one of the affluent categories.
Possible values:

AFFLUENT: High income customer with high spending pattern (>100k USD annual income and >40k USD annual
card usage).
MASS AFFLUENT: High income customer (>100k USD annual income).

Maximum length is 13.

Chase Paymentech Solutions

Maximum length is 1.

category
Type stringMaxLength 7

GPX

Mastercard product ID associated with the primary account number (PAN).
Returned by authorization service.

Cybersource through VisaNet

Visa or Mastercard product ID that is associated with the primary account number (PAN).
For descriptions of the Visa product IDs, see the Product ID table on the Visa
Request & Response Codes web page.

Data Length: String (3)

GPN

Data Length: String (3)

Worldpay VAP

Important Before using this field on Worldpay VAP,
you must contact Cybersource Customer Support to have
your account configured for this feature.

Type of card used in the transaction. The only possible value is:

PREPAID: Prepaid Card

Data Length: String (7)

RBS WorldPay Atlanta

Type of card used in the transaction. Possible values:

B: Business Card
O: Noncommercial Card
R: Corporate Card
S: Purchase Card
Blank: Purchase card not supported

Data Length: String (1)

commercial
Type stringMaxLength 1

Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction
requests. This field is supported for Visa and Mastercard on Chase Paymentech Solutions. Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

group
Type stringMaxLength 1

Type of commercial card. This field is supported only for Cybersource through VisaNet. Possible values:

B: Business card
R: Corporate card
S: Purchasing card
0: Noncommercial card

Returned by authorization service.

healthCare
Type stringMaxLength 1

Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on Chase
Paymentech Solutions. Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

payroll
Type stringMaxLength 1

Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB
on Chase Paymentech Solutions. Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

level3Eligible
Type stringMaxLength 1

Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III
data in your transaction requests. This field is supported for Visa and Mastercard on Chase Paymentech
Solutions. Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

pinlessDebit
Type stringMaxLength 1

Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on Chase
Paymentech Solutions. Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

signatureDebit
Type stringMaxLength 1

Indicates whether the card is a signature debit card.

This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might
want to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and
Maestro (International) on Chase Paymentech Solutions. Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

prepaid
Type stringMaxLength 1

Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or
prepaid card is presented for use when establishing a new recurring, installment, or deferred billing
relationship.

This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.
Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

regulated
Type stringMaxLength 1

Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card
issuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover,
Diners Club, and JCB on Chase Paymentech Solutions. Possible values:

Y: Yes
N: No
X: Not applicable / Unknown

accountHolderType
Type stringMaxLength 25

This is the account owner information, valid values are:

01 : primary account holder
02 : secondary account holder
This is returned in the response of an account verification transaction by the Issuer.

bank
Type object

bank

customer
Type object

customer

paymentInstrument
Type object

paymentInstrument

instrumentIdentifier
Type object

instrumentIdentifier

shippingAddress
Type object

shippingAddress

scheme
Type stringMaxLength 255

Subtype of card account. This field can contain one of the following values:

Maestro International
Maestro UK Domestic
MasterCard Credit
MasterCard Debit
Visa Credit
Visa Debit
Visa Electron

Note Additional values may be present.

bin
Type stringMaxLength 255

Credit card BIN (the first six digits of the credit card).Derived either from the cc_bin request field
or from the first six characters of the customer_cc_num field.

accountType
Type stringMaxLength 255

Type of payment card account. This field can refer to a credit card, debit card, or prepaid card
account type.

issuer
Type stringMaxLength 255

Name of the bank or entity that issued the card account.

binCountry
Type stringMaxLength 255

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

eWallet
Type object

eWallet

paymentInsightsInformation
Type object

paymentInsightsInformation

orderInformation
Type object

orderInformation

amountDetails
Type object

amountDetails

totalAmount
Type stringMaxLength 15

Amount you requested for the payment or capture.

This value is returned for partial authorizations.
This field is also returned on incremental authorizations will contain the aggregated amount from the original authorizations and all the incremental authorizations.

authorizedAmount
Type stringMaxLength 15

Amount that was authorized.

Returned by authorization service.

PIN debit

Amount of the purchase.

Returned by PIN debit purchase.

currency
Type stringMaxLength 3

Currency used for the order. Use the three-character ISO Standard Currency Codes.

Used by

Authorization
Required field.

Authorization Reversal
For an authorization reversal (reversalInformation) or a capture (processingOptions.capture is set to true), you must use the same currency that you used in your payment authorization request.

PIN Debit

Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the ISO Standard Currency Codes.
Returned by PIN debit purchase.

For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.
For the possible values, see the ISO Standard Currency Codes.

Required field for PIN Debit purchase and PIN Debit credit requests.
Optional field for PIN Debit reversal requests.

GPX

This field is optional for reversing an authorization or credit.

DCC for First Data

Your local currency.

Tax Calculation

Required for international tax and value added tax only.
Optional for U.S. and Canadian taxes.
Your local currency.

settlementAmount
Type stringMaxLength 12

This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account.
This field is returned for OCT transactions.

settlementCurrency
Type stringMaxLength 3

This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account.
This field is returned for OCT transactions.

originalAmount
Type stringMaxLength 15

Amount in your original local pricing currency.

This value cannot be negative. You can include a decimal point (.) in this field to denote the currency
exponent, but you cannot include any other special characters.

If needed, Cybersource truncates the amount to the correct number of decimal places.

originalCurrency
Type stringMaxLength 15

Your local pricing currency code.

For the possible values, see the ISO Standard Currency Codes.

processorTransactionFee
Type stringMaxLength 15

Amount up to N digit after the decimals separator as defined in ISO 4217 for the appropriate currency code.

exchangeRate
Type stringMaxLength 17

The rate of conversion of the currency given in the request to CNY. The conversion happens at the time when Alipay’s trade order is created

foreignCurrency
Type stringMaxLength 3

Currency code for the transaction performed in cross border currency.

foreignAmount
Type stringMaxLength 11

The transaction amount in CNY.

discountAmount
Type stringMaxLength 11

If coupons/vouchers are used in the transaction, the discount amount redeemed in the settlement currency will be returned. Otherwise, no return.

invoiceDetails
Type object

invoiceDetails

rewardPointsDetails
Type object

rewardPointsDetails

billTo
Type object

billTo

firstName
Type string

firstName

lastName
Type string

lastName

address1
Type stringMaxLength 60

First line of the billing street address.

address2
Type stringMaxLength 60

Second line of the billing street address.

locality
Type stringMaxLength 60

City of the billing address.

postalCode
Type stringMaxLength 10

Postal code for the billing address. The postal code must consist of 5 to 9 digits.
When the billing country is the U.S., the 9-digit postal code must follow this format:
[5 digits][dash][4 digits]
Example: 12345-6789
When the billing country is Canada, the 6-digit postal code must follow this format:
[alpha][numeric][alpha][space]
[numeric][alpha][numeric]
Example: A1B 2C3

administrativeArea
Type stringMaxLength 60

State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada.

country
Type stringMaxLength 2

Country of the billing address. Use the two-character ISO Standard Country Codes.

email
Type stringMaxLength 256

Email address of the customer.

alternatePhoneNumberVerificationStatus
Type stringMaxLength 15

Visa Platform Connect

Contains one of the following values that will identify the phone number result code in the account verification response message:

'VERIFIED' - Customer verified

'UNVERIFIED' - Customer not verified

'FAILED' - Customer verification failed

alternateEmailVerificationStatus
Type stringMaxLength 15

Visa Platform Connect

Contains one of the following values that will identify the phone number result code in the account verification response message:

'VERIFIED' - Customer verified

'UNVERIFIED' - Customer not verified

'FAILED' - Customer verification failed

phoneNumber
Type stringMaxLength 15

Customer’s phone number.

It is recommended that you include the country code when the order is from outside the U.S.

Chase Paymentech Solutions

Optional field.

Credit Mutuel-CIC

Optional field.

Cybersource through VisaNet

Credit card networks cannot process transactions that contain non-ASCII characters. Cybersource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent Cybersource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, Cybersource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.

For Payouts:

This field may be sent only for FDC Compass.

OmniPay Direct

Optional field.

SIX

Optional field.

TSYS Acquiring Solutions

Optional field.

Worldpay VAP

Optional field.

All other processors

Not used.

nameSuffix
Type stringMaxLength 60

Customer’s name suffix.

shipTo
Type object

shipTo

pointOfSaleInformation
Type object

pointOfSaleInformation

emv
Type object

emv

tags
Type stringMaxLength 1998

EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV
data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.

For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com

Note Card present information about EMV applies only to credit card processing and PIN debit processing.
All other card present information applies only to credit card processing. PIN debit processing is available only
on FDC Nashville Global.

Important The following tags contain sensitive information and must not be included in this field:

56: Track 1 equivalent data
57: Track 2 equivalent data
5A: Application PAN
5F20: Cardholder name
5F24: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX)
99: Transaction PIN
9F0B: Cardholder name (extended)
9F1F: Track 1 discretionary data
9F20: Track 2 discretionary data

For captures, this field is required for contact EMV transactions. Otherwise, it is optional.

For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.
Otherwise, it is optional.

Important For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,
you must include the following tags in this field. For all other types of EMV transactions, the following tags
are optional.

95: Terminal verification results
9F10: Issuer application data
9F26: Application cryptogram

Cybersource through VisaNet

In Japan: 199 bytes
In other countries: String (252)

For Mastercard Transactions, Optionally Tag 9F60 (Authenticated Application Data) and
Tag 96 (Kernel Identifier - Terminal) can be included in the Field.

GPX

This field only supports transactions from the following card types:

Visa
Mastercard
AMEX
Discover
Diners
JCB
Union Pay International

JCN Gateway

The following tags must be included:

4F: Application identifier
84: Dedicated file name

Data length: 199 bytes

All other processors:

String (999)

Used by

Authorization: Optional
Authorization Reversal: Optional
Credit: Optional
PIN Debit processing (purchase, credit and reversal): Optional

chipValidationType
Type stringMaxLength 2

Entity or service that provided the validation results returned in chipValidationResult.

Possible values:

02: MasterCard on-behalf pre-validation service (The MasterCard authorization platform validated the M/Chip cryptogram before the authorization request reached the issuer.)
03: MasterCard on-behalf stand-in service (The MasterCard authorization platform validated the M/Chip cryptogram because the issuer was not available.)
50: Issuer
90: Chip fall-back transaction downgrade process (The chip could not be read.)

This field is returned only for NFC payment network tokenization transactions with MasterCard.

Note No Cybersource through VisaNet acquirers support EMV at this time.

chipValidationResult
Type stringMaxLength 1

Cryptogram validation results returned by the entity or service specified in chipValidationType.

Possible values:

A: Application cryptogram is valid, but the application transaction counter (ATC) is outside allowed range. (A large jump in ATC values may indicate data copying or other fraud.)
C: Chip validation was completed successfully.
E: Application cryptogram is valid but the ATC indicates possible replay fraud.
F: Format error in the chip data.
G: Application cryptogram is valid but is not a valid authorization request cryptogram (ARQC).
I: Application cryptogram is invalid.
T: Application cryptogram is valid but terminal verification results (TVR) or card verification results (CVR) are invalid.
U: Application cryptogram could not be validated because of a technical error.

This field is returned only for NFC payment network tokenization transactions with MasterCard.

Note No Cybersource through VisaNet acquirers support EMV at this time.

amexCapnData
Type stringMaxLength 15

Point-of-sale details for the transaction. This value is returned only for American Express Direct.
Cybersource generates this value, which consists of a series of codes that identify terminal capability,
security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN
requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on
credits.

When you perform authorizations, captures, and credits through Cybersource, Cybersource passes this value from
the authorization service to the subsequent services for you. However, when you perform authorizations through
Cybersource and perform subsequent services through other financial institutions, you must ensure that your
requests for captures and credits include this value.

terminalId
Type stringMaxLength 8

Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements.

Cybersource through VisaNet

A list of all possible values is stored in your Cybersource account. If terminal ID validation is enabled for
your Cybersource account, the value you send for this field is validated against the list each time you include
the field in a request. To enable or disable terminal ID validation, contact Cybersource Customer Support.

When you do not include this field in a request, Cybersource uses the default value that is defined in your Cybersource account.

FDC Nashville Global

To have your account configured to support this field, contact Cybersource Customer Support. This value must be a value that FDC Nashville Global issued to you.

For Payouts

This field is applicable for Cybersource through VisaNet.

GPX

Identifier for the terminal at your retail location. A list of all possible values is stored in your account.
If terminal ID validation is enabled for your account, the value you send for this field is validated against
the list each time you include the field in a request. To enable or disable terminal ID validation, contact
customer support.

When you do not include this field in a request, the default value that is defined in your account is used.

Optional for authorizations.

Used by

Authorization
Optional for the following processors. When you do not include this field in a request, the default value that is
defined in your account is used.

American Express Direct
Credit Mutuel-CIC
FDC Nashville Global
SIX
Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include pointOfSaleInformation.catLevel.
FDMS Nashville: The default value that is defined in your account is used.
GPX
OmniPay Direct: Optional field.

For the following processors, this field is not used.

GPN
JCN Gateway
RBS WorldPay Atlanta
TSYS Acquiring Solutions
Worldpay VAP

Card Present reply

Terminal identifier assigned by the acquirer. This value must be printed on the receipt.

installmentInformation
Type object

installmentInformation

additionalCosts
Type stringMaxLength 12

Additional costs charged by the issuer to fund the installment payments.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 128-139
Field: Total Other Costs

additionalCostsPercentage
Type stringMaxLength 4

Additional costs divided by the amount funded.

For example:

A value of 1.0 specifies 1%.
A value of 4.0 specifies 4%.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 140-143
Field: Percent of Total Other Costs

amount
Type stringMaxLength 13

Amount for the current installment payment.

This field is supported only for Cybersource through VisaNet.

amountFunded
Type stringMaxLength 12

Amount funded.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 48-59
Field: Total Amount Funded

amountRequestedPercentage
Type stringMaxLength 4

Amount requested divided by the amount funded.

For example:

A value of 90.0 specifies 90%.
A value of 93.7 specifies 93.7%.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 60-63
Field: Percent of Amount Requested

annualFinancingCost
Type stringMaxLength 7

Annual cost of financing the installment payments.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 158-164
Field: Annual Total Cost of Financing

annualInterestRate
Type stringMaxLength 7

Annual interest rate.

This field is returned only for two kinds of installment payments on Visa Platform Connect:

Crediario with Visa in Brazil: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.
Mastercard in all countries except Brazil, Croatia, Georgia, and Greece.

Example: A value of 1.0 specifies 1%.

Example: A value of 4.0 specifies 4%.

Brazil

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 151-157
Field: Annual Interest Rate

Other Countries

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 58-62 SCMP API Fields| 216
Field: Mastercard Annual Percentage Rate

expenses
Type stringMaxLength 12

Expenses charged by the issuer to fund the installment payments.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 64-75
Field: Total Expenses

expensesPercentage
Type stringMaxLength 4

Expenses divided by the amount funded.

For example:

A value of 1.0 specifies 1%.
A value of 4.0 specifies 4%.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 76-79
Field: Percent of Total Expenses

fees
Type stringMaxLength 12

Fees charged by the issuer to fund the installment payments.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 80-91
Field: Total Fees

feesPercentage
Type stringMaxLength 4

Fees divided by the amount funded.

For example:

A value of 1.0 specifies 1%.
A value of 4.0 specifies 4%.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 92-95
Field: Percent of Total Fees

frequency
Type stringMaxLength 1

Frequency of the installment payments. When you do not include this field in a request for a
Crediario installment payment, Cybersource sends a space character to the processor.

This field is supported only for Cybersource through VisaNet. Possible values:

B: Biweekly
M: Monthly
W: Weekly

For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:

Record: CP01 TCR9
Position: 41
Field: Installment Frequency

insurance
Type stringMaxLength 12

Insurance charged by the issuer to fund the installment payments.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 112-123
Field: Total Insurance

insurancePercentage
Type stringMaxLength 4

Insurance costs divided by the amount funded.

For example:

A value of 1.0 specifies 1%.
A value of 4.0 specifies 4%.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 124-127
Field: Percent Of Total Insurance

invoiceData
Type stringMaxLength 20

Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is
the same for all installment payments for one purchase.

This field is supported only for installment payments with Mastercard on Cybersource through VisaNet in Brazil.

The value for this field corresponds to the following data in the TC 33 capture file5:

Record: CP07 TCR4
Position: 51-70
Field: Purchase Identification

monthlyInterestRate
Type stringMaxLength 7

Monthly interest rate.

For example:

A value of 1.0 specifies 1%.
A value of 4.0 specifies 4%.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 144-150
Field: Monthly Interest Rate

planType
Type stringMaxLength 1

American Express Direct, Cielo, and Cybersource Latin American Processing

Flag that indicates the type of funding for the installment plan associated with the payment.

Possible values:

1: Merchant-funded installment plan
2: Issuer-funded installment plan
If you do not include this field in the request, Cybersource uses the value in your Cybersource account.

To change the value in your Cybersource account, contact Cybersource Customer Service.

Cybersource through VisaNet and American Express

Defined code that indicates the type of installment plan for this transaction.

Contact American Express for:

Information about the kinds of installment plans that American Express provides
Values for this field

For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:

Record: CP07 TCR3
Position: 5-6
Field: Plan Type

The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to Cybersource. Cybersource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.

Cybersource through VisaNet with Visa or Mastercard

Flag indicating the type of funding for the installment plan associated with the payment.
Possible values:

1 or 01: Merchant-funded installment plan
2 or 02: Issuer-funded installment plan
43: Crediario installment plan—only with Visa in Brazil

For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:

Record: CP07 TCR1
Position: 5-6
Field: Installment Type

For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:

Record: CP01 TCR5
Position: 39-40
Field: Installment Plan Type (Issuer or Merchant)

sequence
Type integer

Installment number when making payments in installments. Used along with totalCount to track which payment is being processed.

For example, the second of 5 payments would be passed to Cybersource as sequence = 2 and totalCount = 5.

Chase Paymentech Solutions and FDC Compass

This field is optional because this value is required in the merchant descriptors.

Cybersource through VisaNet

When you do not include this field in a request for a Crediario installment payment, Cybersource sends a value of 0 to the processor.

For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:

Record: CP01 TCR9
Position: 38-40
Field: Installment Payment Number

The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to Cybersource. Cybersource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.

taxes
Type stringMaxLength 12

Taxes collected by the issuer to fund the installment payments.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 96-107
Field: Total Taxes

taxesPercentage
Type stringMaxLength 4

Taxes divided by the amount funded.

For example:

A value of 1.0 specifies 1%.
A value of 4.0 specifies 4%.

This field is included in the authorization reply for the Crediario eligibility request when the issuer approves
the cardholder's request for Crediario installment payments in Brazil.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR9
Position: 108-111
Field: Percent of Total Taxes

totalAmount
Type stringMaxLength 13

Total amount of the loan that is being paid in installments. This field is supported only for Cybersource
through VisaNet.

totalCount
Type integer

Total number of installments when making payments in installments.

Chase Paymentech Solutions and FDC Compass

This field is optional because this value is required in the merchant descriptors.

American Express Direct, Cielo, and Comercio Latino

This value is the total number of installments you approved.

Cybersource Latin American Processing in Brazil

This value is the total number of installments that you approved. The default is 1.

All Other Processors

This value is used along with sequence to track which payment is being processed.

For example, the second of 5 payments would be passed to Cybersource as sequence = 2 and totalCount = 5.

Cybersource through VisaNet

For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:

Record: CP01 TCR9
Position: 23-25
Field: Number of Installments

For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:

Record: CP07 TCR3
Position: 7-8
Field: Number of Installments

For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:

Record: CP07 TCR1
Position: 7-8
Field: Number of Installments

For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:

Record: CP01 TCR5
Position: 20-22
Field: Installment Total Count

Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to Cybersource. Cybersource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.

minimumTotalCount
Type string

"Minimum number of installments offered by the issuer for this purchase. The issuer provides this value when the first installment payment is successful.
This field is supported for installment payments with Mastercard on Cybersource through VisaNet in all countries except Brazil, Croatia, Georgia, and Greece.
The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 75-76
Field: Mastercard Minimum Number Of Installments

maximumTotalCount
Type string

Maximum number of installments offered by the issuer for this purchase. The issuer provides this value when the first installment payment is successful.
This field is supported for installment payments with Mastercard on Cybersource through VisaNet in all countries except Brazil, Croatia, Georgia, and Greece.
The value for this field corresponds to the following data in the TC 33 capture file1:

Record: CP01 TCR5
Position: 77-78
Field: Mastercard Maximum Number Of Installments

firstInstallmentAmount
Type stringMaxLength 13

Amount of the first installment payment. The issuer provides this value when the first installment payment is successful.
This field is supported for Mastercard installment payments on Cybersource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece.
The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 23-34
Field: Amount of Each Installment

firstInstallmentDate
Type stringMaxLength 6

Date of the first installment payment. Format: YYMMDD. When you do not include this field, Cybersource sends a string of six zeros (000000) to the processor.

This field is supported only for Crediario installment payments in Brazil on Cybersource through VisaNet.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 42-47
Field: Date of First Installment

tokenInformation
Type object

tokenInformation

buyerInformation
Type object

buyerInformation

merchantCustomerId
Type stringMaxLength 100

Your identifier for the customer.

When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.

Comercio Latino

For recurring payments in Mexico, the value is the customer’s contract number.
Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.

Worldpay VAP

For a follow-on credit with Worldpay VAP, Cybersource checks the following locations, in the order
given, for a customer account ID value and uses the first value it finds:

customer_account_id value in the follow-on credit request
Customer account ID value that was used for the capture that is being credited
Customer account ID value that was used for the original authorization
If a customer account ID value cannot be found in any of these locations, then no value is used.

dateOfBirth
Type stringMaxLength 8

Recipient’s date of birth. Format: YYYYMMDD.

This field is a pass-through, which means that Cybersource ensures that the value is eight numeric characters
but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field
is not required for the transaction, Cybersource does not forward it to the processor.

vatRegistrationNumber
Type stringMaxLength 20

Customer’s government-assigned tax identification number.

Tax Calculation

Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.

personalIdentification
Type array

personalIdentification

type
Type string

The type of the identification.

Possible values:

NATIONAL
CPF
CPNJ
CURP
SSN
DRIVER_LICENSE
PASSPORT_NUMBER
PERSONAL_ID
TAX_ID
BR_CPF The individual tax ID type, typically is 11 characters long
BR_CNPJ The business tax ID type, typically is 14 characters long.

This field is supported only on the following processors.

ComercioLatino

Set this field to the Cadastro de Pessoas Fisicas (CPF).

Cybersource Latin American Processing

Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.
Note Cybersource Latin American Processing is the name of a specific processing connection that Cybersource supports. In the Cybersource API documentation, Cybersource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called Cybersource Latin American Processing. It is not for any other Latin American processors that Cybersource supports.

id
Type stringMaxLength 26

The value of the identification type. This field is supported only on the following processors.

ComercioLatino

Set this field to the Cadastro de Pessoas Fisicas (CPF).

Cybersource Latin American Processing

issuedBy
Type string

The government agency that issued the driver's license or passport.

If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued.

If type = PASSPORT, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy.

Use the two-character State, Province, and Territory Codes for the United States and Canada.

TeleCheck

Contact your TeleCheck representative to find out whether this field is required or optional.

All Other Processors

Not used.

verificationResults
Type string

Verification results received from Issuer or Card Network for verification transactions. Response Only Field.

taxId
Type string

The description for this field is not available.

loginId
Type stringMaxLength 64

The buyer’s Alipay login Id, the id might be an email or mobile number. The id is partially masked for privacy. cao***@126.com or 186***22156

riskInformation
Type object

Contains the result of risk assessment.

profile
Type object

profile

rules
Type array

rules

infoCodes
Type object

infoCodes

velocity
Type object

velocity

casePriority
Type integerMaxLength 1

You receive this field only if you subscribe to the Enhanced Case Management service. The priority level ranges from 1 (highest) to 5 (lowest); the default value is 3. If you do not assign a priority to your rules or to your profiles, the default value is given to the order.

For all possible values, see the decision_case_priority field description in the Decision Manager Using the SCMP API Developer Guide on the Cybersource Business Center. Click Decision Manager > Documentation > Guides > Decision Manager Using the SCMP API Developer Guide (PDF link).

localTime
Type stringMaxLength 255

The customer's local time (hh:mm:ss), which is calculated from the transaction request time and the
customer's billing address.

For details, see the score_time_local field description in the Decision Manager Using the SCMP API Developer Guide on the Cybersource Business Center.

score
Type object

score

ipAddress
Type object

Contains detailed response information about the customer's IP address.

anonymizerStatus
Type stringMaxLength 255

Indicates whether the transaction IP address is associated with a known anonymous proxy.

For all possible values, see the score_ip_anonymizer_status field description in the Decision Manager Using the SCMP API Developer Guide on the Cybersource Business Center. Click Decision Manager > Documentation > Guides > Decision Manager Using the SCMP API Developer Guide (PDF link).

locality
Type stringMaxLength 255

Name of the city decoded from the IP address used directly or indirectly by the customer to send the order.

For all possible values, see the score_ip_city field description in the Decision Manager Using the SCMP API Developer Guide on the Cybersource Business Center. Click Decision Manager > Documentation > Guides > Decision Manager Using the SCMP API Developer Guide (PDF link).

country
Type stringMaxLength 255

Name of the country decoded from the IP address used directly or indirectly by the customer to send the order.

For all possible values, see the score_ip_country field description in the Decision Manager Using the SCMP API Developer Guide on the Cybersource Business Center. Click Decision Manager > Documentation > Guides > Decision Manager Using the SCMP API Developer Guide (PDF link).

administrativeArea
Type stringMaxLength 255

Name of the state decoded from the IP address used directly or indirectly by the customer to send the order.

For all possible values, see the score_ip_state field description in the Decision Manager Using the SCMP API Developer Guide on the Cybersource Business Center. Click Decision Manager > Documentation > Guides > Decision Manager Using the SCMP API Developer Guide (PDF link).

routingMethod
Type stringMaxLength 255

Routing method decoded from the IP address used directly or indirectly by the customer to send the order.

For all possible values, see the score_ip_routing_method field description in the Decision Manager Using the SCMP API Developer Guide on the Cybersource Business Center. Click Decision Manager > Documentation > Guides > Decision Manager Using the SCMP API Developer Guide (PDF link).

carrier
Type stringMaxLength 255

Provides the name of the organization that owns the ASN. The carrier is responsible for the traffic carried on the network or set of networks designated as an Autonomous System (AS) and identified by the ASN.
While there are more than 27,000 active ASNs, there are fewer carriers, because a single carrier often manages several ASNs.

organization
Type stringMaxLength 255

The Registering Organization is the entity responsible for the actions and content associated with a given block of IP addresses. This is in contrast to the carrier, which is responsible for the routing of traffic for network blocks. Registering Organizations include many types of entities, including corporate, government, or educational entities, and ISPs managing the allocation and use of network blocks.

providers
Type object

Name of the 3rd party provider, for example, Emailage.
For all possible values, see the decision_provider_#_name field description in the Decision Manager Using the SCMP API Developer Guide on the Cybersource Business Center. Click Decision Manager > Documentation > Guides > Decision Manager Using the SCMP API Developer Guide (PDF link).

travel
Type object

travel

processorResults
Type object

processorResults

consumerAuthenticationInformation
Type object

consumerAuthenticationInformation

accessToken
Type string

JSON Web Token (JWT) used to authenticate the consumer with the authentication provider, such as, CardinalCommerce or Rupay.
Note - Max Length of this field is 2048 characters.

acsRenderingType
Type string

Identifies the UI Type the ACS will use to complete the challenge. NOTE: Only available for App transactions using the Cardinal Mobile SDK.

acsTransactionId
Type stringMaxLength 36

Unique transaction identifier assigned by the ACS to identify a single transaction.

acsUrl
Type stringMaxLength 2048

URL for the card-issuing bank’s authentication form that you receive when the card is enrolled.
The value can be very large.

authenticationPath
Type string

Indicates what displays to the customer during the authentication process.
This field can contain one of these values:

ADS: (Card not enrolled) customer prompted to activate the card during the checkout process.
ATTEMPTS: (Attempts processing) Processing briefly displays before the checkout process is completed.
ENROLLED: (Card enrolled) the card issuer’s authentication window displays.
UNKNOWN: Card enrollment status cannot be determined.
NOREDIRECT: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer.

The following values can be returned if you are using rules-based payer authentication.

RIBA: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely
to be challenged cannot be determined.
RIBA_PASS: The card-issuing bank supports risk-based authentication and it is likely that the
cardholder will not be challenged to provide credentials, also known as silent authentication.

authorizationPayload
Type string

The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow

authenticationTransactionId
Type stringMaxLength 26

Payer authentication transaction identifier is used to link the check
enrollment and validate authentication messages. For Rupay, this field should be passed as request only for Resend OTP use case.

cardholderMessage
Type stringMaxLength 128

Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction.The Issuer can provide information to Cardholder.
For example, “Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.”.
The Issuing Bank can optionally support this value.

cavv
Type stringMaxLength 255

Unique identifier generated by the card-issuing bank for Visa, American Express, JCB, Diners Club, and
Discover transactions after the customer is authenticated. The value is in base64. When you
request the card authorization service, Cybersource automatically converts the value, not the field name,
to the format required by your payment processor.

cavvAlgorithm
Type stringMaxLength 1

Field that is returned only when the CAVV is generated, which occurs when paresStatus
contains the values Y (successful authentication) or A (attempted authentication). If
you use the ATOS processor, send the value of this field in the cavv_algorithm request field of the
authorization service. This field contains one of these values:

2: Visa, American Express, JCB, Diners Club, and Discover
3: Mastercard

challengeCancelCode
Type stringMaxLength 2

An indicator as to why the transaction was canceled.
Possible Values:

01: Cardholder selected Cancel.
02: Reserved for future EMVCo use (values invalid until defined by EMVCo).
03: Transaction Timed Out—Decoupled Authentication
04: Transaction timed out at ACS—other timeouts
05: Transaction Timed out at ACS - First CReq not received by ACS
06: Transaction Error
07: Unknown
08: Transaction Timed Out at SDK

challengeRequired
Type stringMaxLength 1

Indicates whether a challenge is required in order to complete authentication.
Note Regional mandates might determine that a challenge is required.

Possible values:

Y: Challenge required
N: Challenge not required

Note Used by the Hybrid integration.

decoupledAuthenticationIndicator
Type stringMaxLength 1

Indicates whether the 3DS Requestor requests the ACS to utilize Decoupled Authentication and agrees to utilize Decoupled Authentication if the ACS confirms its use.

Possible Values:

Y - Decoupled Authentication is supported and preferred if challenge is necessary

N - Do not use Decoupled Authentication

Default Value: N

directoryServerErrorCode
Type string

The directory server error code indicating a problem with this transaction. Note - Max Length of this field is typically 3 characters.

directoryServerErrorDescription
Type stringMaxLength 4096

Directory server text and additional detail about the error for this transaction.

ecommerceIndicator
Type stringMaxLength 255

Commerce indicator for cards not enrolled. This field contains one of these values:

internet: Card not enrolled, or card type not supported by payer authentication. No liability shift.
js_attempted: Card not enrolled, but attempt to authenticate is recorded. Liability shift.
js_failure: J/Secure directory service is not available. No liability shift.
spa: Mastercard card not enrolled in the SecureCode program. No liability shift.
vbv_attempted: Card not enrolled, but attempt to authenticate is recorded. Liability shift.
vbv_failure: For payment processor Barclays, Streamline, AIBMS, or FDC Germany, you receive
this result if Visa’s directory service is not available. No liability shift.

eci
Type string

Note This field applies only to non-U.S-issued cards.

For enroll, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB,
Diners Club, and Discover transactions when the card is not enrolled. For more information, see
"Interpreting the Reply," page 22.

If you are not using the Cybersource payment services, you must send this value to your payment
processor in the subsequent request for card authorization. This field contains one of these values:

06: The card can be enrolled. Liability shift.
07: The card cannot be enrolled. No liability shift.

For validate, Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB,
Diners Club, and Discover transactions. The field is absent when authentication fails.
You must send this value to your payment processor in the subsequent request for card authorization.
This field contains one of these values:

05: Successful authentication
06: Authentication attempted
07: Failed authentication (No response from the merchant because of a problem.)

eciRaw
Type string

ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover.
The field is absent when authentication fails. If your payment processor is Streamline, you must pass the
value of this field instead of the value of eci or ucafCollectionIndicator.

This field can contain one of these values:

01: Authentication attempted (Mastercard)
02: Successful authentication (Mastercard)
05: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover)
06: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover)

effectiveAuthenticationType
Type stringMaxLength 2

This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows;
CH - Challenge
FR - Frictionless
FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer).

ivr
Type object

ivr

strongAuthentication
Type object

strongAuthentication

issuerInformation
Type object

issuerInformation

riskAnalysisExemptionResult
Type stringMaxLength 80

Possible values: Visa Platform Connect

8401 Merchant not participating in Visa Trusted Listing Program.
8402 Issuer not participating in Visa Trusted Listing Program.
8403 Cardholder has not trusted the merchant (supplied by Visa Net).
8404 Indeterminate or invalid issuer response.
8473 Cardholder has not trusted the merchant (issuer-supplied).
8474 Did not meet the exemption criteria (issuer-supplied).

Upto 20 Values may be received in a transaction.

trustedMerchantExemptionResult
Type stringMaxLength 4

Possible values: Visa Platform Connect

2 Trusted merchant exemption validated/honored.
3 Trusted merchant exemption failed validation/not honored.

lowValueExemptionResult
Type stringMaxLength 1

This will be the value returned by Visanet when low value exemption has been requested.

Valid values: Visa Platform Connect

2 Low value exemption validated/honored
3 Low value exemption failed validation/not honored

secureCorporatePaymentResult
Type stringMaxLength 1

This will be the value returned by Visanet when secure corporate payment (scp) exemption has been requested.

Valid values: Visa Platform Connect

2 Secure corporate payment exemption validated/honored
3 Secure corporate payment exemption failed validation/not honored

transactionRiskAnalysisExemptionResult
Type stringMaxLength 1

This will be the value returned by Visanet when transaction risk analysis (TRA) exemption has been requested.

Valid values: Visa Platform Connect

2 transaction risk analysis (TRA) exemption validated/honored
3 transaction risk analysis (TRA) exemption failed validation/not honored

delegatedAuthenticationResult
Type stringMaxLength 1

This will be the value returned by Visanet when delegated authentication has been requested.

networkScore
Type stringMaxLength 2

The global score calculated by the CB scoring platform and returned to merchants.

pareq
Type string

Payer authentication request (PAReq) message that you need to forward to the ACS.
The value can be very large. The value is in base64.

paresStatus
Type string

Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway
Processing, you need to send the value of this field in your authorization request. This field can contain
one of these values:

A: Proof of authentication attempt was generated.
N: Customer failed or canceled authentication. Transaction denied.
U: Authentication not completed regardless of the reason.
Y: Customer was successfully authenticated.

proofXml
Type string

Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need
to show proof of enrollment checking, you may need to parse the string for the information required by the
payment card company. The value can be very large.
For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment
checking for any payer authentication transaction that you re-present because of a chargeback.

proxyPan
Type string

Encrypted version of the card number used in the payer authentication request message.

sdkTransactionId
Type stringMaxLength 36

SDK unique transaction identifier that is generated on each new transaction.

signedParesStatusReason
Type stringMaxLength 2

Provides additional information as to why the PAResStatus has a specific value.

specificationVersion
Type string

This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0

stepUpUrl
Type stringMaxLength 2048

The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration.

threeDSServerTransactionId
Type stringMaxLength 36

Unique transaction identifier assigned by the 3DS Server to identify a single transaction.

ucafAuthenticationData
Type string

AAV is a unique identifier generated by the card-issuing bank for Mastercard Identity Check
transactions after the customer is authenticated. The value is in base64.
Include the data in the card authorization request.

ucafCollectionIndicator
Type string

For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the
customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator.
This field can contain these values: 0, 1.

For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check
transactions. The field is absent when authentication fails. You must send this value to your payment
processor in the request for card authorization. This field contain one of these values:

0: Authentication data not collected, and customer authentication was not completed.
1: Authentication data not collected because customer authentication was not completed.
2: Authentication data collected because customer completed authentication.

veresEnrolled
Type string

Result of the enrollment check. This field can contain one of these values:

Y: Card enrolled or can be enrolled; you must authenticate. Liability shift.
N: Card not enrolled; proceed with authorization. Liability shift.
U: Unable to authenticate regardless of the reason. No liability shift.

Note This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for
this processor, you must send the value of this field in your authorization request.

The following value can be returned if you are using rules-based Payer Authentication:

B: Indicates that authentication was bypassed.

whiteListStatusSource
Type stringMaxLength 2

This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS

xid
Type string

Transaction identifier generated by Cybersource for successful enrollment or validation checks.
Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes.
Cybersource forwards the XID with the card authorization service to these payment processors in these cases:

Barclays
Streamline (when the ecommerceIndicator=spa)

directoryServerTransactionId
Type stringMaxLength 36

The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results.
For Cybersource Through Visanet Gateway:
The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID

dataQualityIndicator
Type stringMaxLength 10

The field is used to indicate that a transaction does not meet the Visa Secure authentication data quality requirements.

authenticationResult
Type string

Raw authentication data that comes from the cardissuing bank. Primary authentication field that
indicates if authentication was successful and if liability shift occurred. You should examine first the
result of this field. This field contains one of these values:

-1: Invalid PARes.
0: Successful validation.
1: Cardholder is not participating, but the attempt to authenticate was recorded.
6: Issuer unable to perform authentication.
9: Cardholder did not complete authentication.

authenticationStatusMsg
Type string

Message that explains the authenticationResult reply field.

indicator
Type string

Indicator used to differentiate Internet transactions from other types. The authentication failed if this field
is not returned. For Visa, if your payment processor is Streamline, Barclays, AIBMS, or FDC Germany,
you receive the value vbv_failure instead of internet when eci is 07.
The value of this field is passed automatically to the authorization service if you request the services
together. This field contains one of these values:

aesk: American Express SafeKey authentication verified successfully.
aesk_attempted: Card not enrolled in American Express SafeKey, but the attempt to authenticate was recorded.
dipb: Discover ProtectBuy authentication verified successfully.
dipb_attempted: Card not enrolled in Discover ProtectBuy, but the attempt to authenticate was recorded.
internet: Authentication was not verified successfully.
js: J/Secure authentication verified successfully.
js_attempted: Card not enrolled in J/Secure, but the attempt to authenticate was recorded.
moto: Mail or telephone order.
pb_attempted: Card not enrolled in Diners Club ProtectBuy, but the attempt to authenticate was recorded.
recurring: Recurring transaction.
spa: Mastercard Identity Check authentication verified successfully.
spa_failure: Mastercard Identity Check failed authentication.
vbv: Visa Secure authentication verified successfully.
vbv_attempted: Card not enrolled in Visa Secure, but the attempt to authenticate was recorded.
vbv_failure: Visa Secure authentication unavailable.

interactionCounter
Type stringMaxLength 2

Indicates the number of authentication cycles attempted by the cardholder and is tracked by the Issuing Banks ACS.Example: if customer gets the challenge window and enter in their one time password and hit submit then that interaction counter should just be 1.
When customer gets the challenge window and the bank asks if they want to have the one time password sent to their phone or their email and they have to choose before going to the next screen to enter in their one time password then this interaction count would be 2.
One for the selection of how they want the one time password delivered and another with them actually entering in the one time password and hitting the submit button.

whiteListStatus
Type stringMaxLength 1

Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.

Possible Values:

Y - 3DS Requestor is whitelisted by cardholder

N - 3DS Requestor is not whitelisted by cardholder

merchantInformation
Type object

merchantInformation

embeddedActions
Type object

Contains embedded actions, that includes status and response for every actions in the list.

CAPTURE
Type object

CAPTURE

DECISION
Type object

DECISION

CONSUMER_AUTHENTICATION
Type object

CONSUMER_AUTHENTICATION

VALIDATE_CONSUMER_AUTHENTICATION
Type object

VALIDATE_CONSUMER_AUTHENTICATION

WATCHLIST_SCREENING
Type object

WATCHLIST_SCREENING

TOKEN_CREATE
Type object

TOKEN_CREATE

TOKEN_UPDATE
Type object

TOKEN_UPDATE

watchlistScreeningInformation
Type object

watchlistScreeningInformation

400

Invalid request.

502

Unexpected system error or system timeout.

Live Console URL: index.html#payments_payments_process-a-payment_samplerequests-dropdown_payment-with-flex-token-create-permanent-tms-token_liveconsole-tab-request-body

REST Example: Authorization and Creating TMS Tokens with a Transient Token

Endpoint:

POST https://api.cybersource.com/pts/v2/payments

{
  "clientReferenceInformation": {
    "code": "TC50171_3"
  },
  "processingInformation": {
    "actionList": [
      "TOKEN_CREATE"
    ],
    "actionTokenTypes": [
      "customer",
      "paymentInstrument",
      "shippingAddress"
    ]
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "102.21",
      "currency": "USD"
    },
    "billTo": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "1 Market St",
      "locality": "san francisco",
      "administrativeArea": "CA",
      "postalCode": "94105",
      "country": "US",
      "email": "test@cybs.com",
      "phoneNumber": "4158880000"
    },
    "shipTo": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "1 Market St",
      "locality": "san francisco",
      "administrativeArea": "CA",
      "postalCode": "94105",
      "country": "US"
    }
  },
  "tokenInformation": {
    "transientTokenJwt": "eyJraWQiOiIwMFN2SWFHSWZ5YXc4OTdyRGVHOWVGZE9ES2FDS2MxcSIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJGbGV4LzAwIiwiZXhwIjoxNjE0NzkyNTQ0LCJ0eXBlIjoiYXBpLTAuMS4wIiwiaWF0IjoxNjE0NzkxNjQ0LCJqdGkiOiIxRDBWMzFQMUtMRTNXN1NWSkJZVE04VUcxWE0yS0lPRUhJVldBSURPkhLNjJJSFQxUVE1NjAzRkM3NjA2MDlDIn0.FrN1ytYcpQkn8TtafyFZnJ3dV3uu1XecDJ4TRIVZN-jpNbamcluAKVZ1zfdhbkrB6aNVWECSvjZrbEhDKCkHCG8IjChzl7Kg642RWteLkWz3oiofgQqFfzTuq41sDhlIqB-UatveU_2ukPxLYl87EX9ytpx4zCJVmj6zGqdNP3q35Q5y59cuLQYxhRLk7WVx9BUgW85tl2OHaajEc25tS1FwH3jDOfjAC8mu2MEk-Ew0-ukZ70Ce7Zaq4cibg_UTRx7_S2c4IUmRFS3wikS1Vm5bpvcKLr9k_8b9YnddIzp0p0JOCjXC_nuofQT7_x_-CQayx2czE0kD53HeNYC5hQ"
  }
}

Successful Response

{
    "_links": {
        "authReversal": {
            "method": "POST",
            "href": "/pts/v2/payments/6826220442936119603954/reversals"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/payments/6826220442936119603954"
        },
        "capture": {
            "method": "POST",
            "href": "/pts/v2/payments/6826220442936119603954/captures"
        }
    },
    "clientReferenceInformation": {
        "code": "TC50171_3"
    },
    "id": "6826220442936119603954",
    "orderInformation": {
        "amountDetails": {
            "authorizedAmount": "102.21",
            "currency": "USD"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "001"
        }
    },
    "paymentInformation": {
        "tokenizedCard": {
            "type": "001"
        },
        "card": {
            "type": "001"
        }
    },
    "pointOfSaleInformation": {
        "terminalId": "111111"
    },
    "processorInformation": {
        "approvalCode": "888888",
        "networkTransactionId": "123456789619999",
        "transactionId": "123456789619999",
        "responseCode": "100",
        "avs": {
            "code": "X",
            "codeRaw": "I1"
        }
    },
    "reconciliationId": "68449782YGMSJXND",
    "status": "AUTHORIZED",
    "submitTimeUtc": "2023-04-27T19:00:44Z",
    "tokenInformation": {
        "instrumentidentifierNew": false,
        "instrumentIdentifier": {
            "state": "ACTIVE",
            "id": "7010000000016241111"
        },
        "shippingAddress": {
            "id": "FA56F3248492C901E053A2598D0A99E3"
        },
        "paymentInstrument": {
            "id": "FA56E8725B06A553E053A2598D0A2105"
        },
        "customer": {
            "id": "FA56DA959B6AC8FBE053A2598D0AD183"
        }
    }
}

Authorization and Creating TMS Tokens with a Transient Token

Endpoint

Required Fields for an Authorization and Creating TMS Tokens with a Transient Token

REST Interactive Example: Authorization and Creating TMS Tokens with a Transient Token

Process a Payment

Overview

Request Builder

Body

Response

Descriptions

Used by

PIN Debit

FDC Nashville Global

PIN Debit

PIN debit

Elavon Encrypted Account Number Program

TSYS Acquiring Solutions

PIN debit

GPX

Cielo

Comercio Latino

Cybersource through VisaNet and GPN

Moneris

PIN debit

AIBMS

Atos

Comercio Latino

JCN Gateway

paypalgateway

Maximum length for processors

Processors supported:

Possible values:

Cybersource through VisaNet

Visa Platform Connect

Visa Platform Connect

Visa Platform Connect

Visa Platform Connect

Visa Platform Connect

Visa Platform Connect

Visa Platform Connect

Visa Platform Connect

Visa Platform Connect

American Express Direct

Cybersource through VisaNet

Cybersource through VisaNet

Cybersource through VisaNet

Cybersource through VisaNet

Returned by

Ingenico ePayments

Cybersource through VisaNet

Processors supported:

Possible values:

Google Pay transactions

PIN debit

Barclays and Streamline

Encoded Account Numbers

FDMS Nashville

All other processors

Google Pay transactions

Barclays and Streamline

Encoded Account Numbers

FDMS Nashville

FDC Nashville Global and FDMS South

All other processors

Google Pay transactions

Used by

Card Present reply

Google Pay transactions

GPX

Google Pay transactions

Visa Platform Connect

Google Pay transactions

PIN debit

Barclays and Streamline

Encoded Account Numbers

FDMS Nashville

All other processors

Google Pay transactions

Barclays and Streamline

Encoded Account Numbers