API Fields

`REST API` Field Reference

This section provides you with information about the REST API field reference.

Audience and Purpose: This guide is written for application developers who want to use the REST API to integrate Cybersource services into an order management system. Implementing Cybersource services requires software development skills. You must write code that uses the REST API request and reply fields.
Conventions: These special statements are used in this document:
IMPORTANT

An Important
statement contains information essential to successfully completing a task or learning a concept.

WARNING

A Warning
contains information or instructions, which, if not heeded, can result in a security risk, irreversible loss of data, or significant cost in time or revenue or both.
Related Documentation: Refer to the Technical Documentation Hub in the Cybersource Developer Center for additional technical documentation:
https://developer.cybersource.com/docs.html
Customer Support: For support information about any service, visit the Support Center:
http://support.visaacceptance.com

Recent Revisions to This Document

26.01.01

December 2025:
This revision of the guide contains updated or new field information.

Added these new fields:

objectInformation.comment

objectInformation.title

processingInformation.amexIndirectModelType

tokenInformation.tokenProvisioningInformation.consumerConsentObtained

tokenInformation.tokenProvisioningInformation.multiFactorAuthenticated

Deprecated this field:

comment

Updated these fields:

consumerAuthenticationInformation.signedParesStatusReason

consumerAuthenticationInformation.transactionFlowIndicator

issuerInformation.responseCode

paymentinformation.tokenizedCard.cryptogram

paymentInformation.tokenizedCard.transactionType

processorInformation.merchantAdvice.code

processorInformation.paymentAccountReferenceNumber

25.11.02

November 2025:
This revision of the guide contains updated or new field information.

Updated these fields:

merchantInformation.domainName

paymentInformation.card.cardType

paymentInformation.card.type

paymentInformation.tokenizedCard.type

processingInformation.originalPaymentId

25.11.01

November 2025:
This revision of the guide contains updated or new field information.

Updated this field:

processingInformation.networkPartnerId

25.10.02

October 2025:
This revision of the guide contains updated or new field information.

Added this field:

paymentInformation.paymentAccountReference.id

25.10.01

October 2025:
This revision of the guide contains updated or new field information.

Updated this field:

consumerAuthenticationInformation.overrideCountryCode

Deprecated these fields:

consumerAuthenticationInformation.veresEnrolled

processorInformation.customer.personalIDResult

25.09.02

September 2025:
This revision of the guide contains updated or new field information.

Updated these fields:

paymentInformation.card.sourceAccountType

paymentInformation.card.useAs

pointOfSaleInformation.catLevel

pointOfSaleInformation.terminalCapability

25.09.01

September 2025:
This revision of the guide contains updated or new field information.

Added these new fields:

orderInformation.amountDetails.refundBalance

paymentInfomation.eWallet.fundingSource

paymentInfomation.eWallet.name

processorInformation.issuerInformation.code

processorInformation.issuerInformation.name

processorInformation.rawResponse

processorInformation.rawResponseLocal

Updated these fields:

consumerAuthenticationInformation.alternateAuthenticationMethod

consumerAuthenticationInformation.fido.fidoFlowType

consumerAuthenticationInformation.fido.reasonCode

consumerAuthenticationInformation.fido.reasonDescription

consumerAuthenticationInformation.languagePreference

consumerAuthenticationInformation.methodUrlPresent

processorInformation.merchantAdvice.code

processorInformation.merchantAdvice.codeRaw

25.08.01

August 2025: Added these new fields:; authenticatedIdentities.relyingPartyId

authenticatorRenderMethod

paymentInstrument.bankAccount.type

paymentInstrument.instrumentIdentifier.bankAccount.number

paymentInstrument.instrumentIdentifier.bankAccount.routingNumber

25.07.01

July 2025
: This revision of the guide contains updated or new field information.

Updated this field:

installmentInformation.paymentType

25.06.02

June 2025
: This revision of the guide contains updated or new field information.

Added these new fields:

card.type

consumerAuthenticationInformation.fido.fidoFlowType

consumerAuthenticationInformation.fido.reasonCode

consumerAuthenticationInformation.fido.reasonDescription

consumerAuthenticationInformation.languagePreference

consumerAuthenticationInformation.methodUrlPresent

Updated these fields:

consumerAuthenticationInformation. alternateAuthenticationMethod

25.06.01

June 2025:
This revision of the guide contains updated or new field information.

Added these new fields:

clientReferenceInformation.transactionId

authenticatedIdentities.data

authenticatedIdentities.id

authenticatedIdentities.provider

clientCorrelationId

deviceInformation.platformType

issuerAuthCode

otp

paymentAccountInformation.card.type

paymentInformation.card.cardType

paymentInformation.card.type

paymentInformation.tokenizedCard.type

sessionInformation.secureToken

stepUpOptions.id

stepUpOptions.method

stepUpOptions.platformType

stepUpOptions.requestPayload

stepUpOptions.source

stepUpOptions.subMethod

stepUpOptions.value

25.05.02

May 2025
: This revision of the guide contains updated or new field information.

Updated these fields:

Updated the data length of the

merchantInformation.merchantDescriptor.name

field for the Visa Platform Connect processor.

installmentInformation.paymentType

recurringPayment.informationType

processingInformation.commerceIndicator

25.05.01

May 2025:
This revision of the guide contains updated or new field information.

Updated these fields:

clientReferenceInformation.transactionId

processingInformation.walletType

Added these new fields:

completeMandate.decisionManager

completeMandate.type

processingInformation.fundingOptions.initiator.originatorInitiatedTransaction.originalTransactionId

processingInformation.validationLevel

25.04.02

April 2025:
This revision of the guide contains updated or new field information.

Updated these fields:

pointOfSaleInformation.catLevel

pointOfSaleInformation.pinEntrySolution

processingInformation.businessApplicationId

processingInformation.merchantVerificationValue

recipientInformation.accountType

senderInformation.account.number

senderInformation.locality

travelInformation.transit.airline.passengerName

Added these new fields:

captureOptions.dateToCapture

processingInformation.foreignRetailIndicator

processorInformation.enhancedDataEnabled

25.04.01

March 2025:
This revision of the guide contains updated or new field information.

Updated this field:

merchantInformation.merchantDescriptor.county

Added these new fields:

paymentCredentialType

transactionType

25.04

March 2025:
This revision of the guide contains updated or new field information.

Added these new fields:

transientTokenResponseOptions.includeCardPrefix

travelInformation.autoRental.adjustedAmount

travelInformation.autoRental.adjustedAmountIndicator

travelInformation.autoRental.affiliateName

travelInformation.autoRental.agreementNumber

travelInformation.autoRental.commodityCode

travelInformation.autoRental.companyId

travelInformation.autoRental.corporateClientCode

travelInformation.autoRental.customerName

travelInformation.autoRental.customerServicePhoneNumber

travelInformation.autoRental.dailyRentalRate

travelInformation.autoRental.distanceTraveled

travelInformation.autoRental.distanceUnit

travelInformation.autoRental.driverAge

travelInformation.autoRental.extraCharge

travelInformation.autoRental.extraMileageCharge

travelInformation.autoRental.fuelCharges

travelInformation.autoRental.gpsCharge

travelInformation.autoRental.insuranceAmount

travelInformation.autoRental.insuranceIndicator

travelInformation.autoRental.lateFeeAmount

travelInformation.autoRental.maxFreeDistance

travelInformation.autoRental.mileageCharge

travelInformation.autoRental.noShowIndicator

travelInformation.autoRental.numberOfAdditionalDrivers

travelInformation.autoRental.odometerReading

travelInformation.autoRental.oneWayDropOffAmount

travelInformation.autoRental.otherCharges

travelInformation.autoRental.parkingViolationCharge

travelInformation.autoRental.phoneCharge

travelInformation.autoRental.programCode

travelInformation.autoRental.promotion.additionalCouponCode

travelInformation.autoRental.promotion.couponCode

travelInformation.autoRental.ratePerMile

travelInformation.autoRental.rentalAddress.address1

travelInformation.autoRental.rentalAddress.address2

travelInformation.autoRental.rentalAddress.city

travelInformation.autoRental.rentalAddress.country

travelInformation.autoRental.rentalAddress.location

travelInformation.autoRental.rentalAddress.locationId

travelInformation.autoRental.rentalAddress.postalCode

travelInformation.autoRental.rentalAddress.state

travelInformation.autoRental.rentalDateTime

travelInformation.autoRental.returnAddress.address1

travelInformation.autoRental.returnAddress.city

travelInformation.autoRental.returnAddress.country

travelInformation.autoRental.returnAddress.location

travelInformation.autoRental.returnAddress.locationId

travelInformation.autoRental.returnAddress.postalCode

travelInformation.autoRental.returnAddress.state

travelInformation.autoRental.returnDateTime

travelInformation.autoRental.specialProgramCode

travelInformation.autoRental.taxDetails.amount

travelInformation.autoRental.taxDetails.applied

travelInformation.autoRental.taxDetails.exemptionCode

travelInformation.autoRental.taxDetails.rate

travelInformation.autoRental.taxDetails.taxSummary

travelInformation.autoRental.taxDetails.taxType

travelInformation.autoRental.timePeriod

travelInformation.autoRental.towingCharge

travelInformation.autoRental.vehicleClass

travelInformation.autoRental.vehicleIdentificationNumber

travelInformation.autoRental.vehicleMake

travelInformation.autoRental.vehicleModel

travelInformation.autoRental.weeklyRate

25.03

February 2025:
This revision of the guide contains updated or new field information.

Added these new fields:

captureMandate.requestSaveCard

processingInformation.japanPaymentOptions.bonusAmount

processingInformation.japanPaymentOptions.bonuses

processingInformation.japanPaymentOptions.bonusMonth

processingInformation.japanPaymentOptions.preapprovalType

processingInformation.japanPaymentOptions.secondBonusAmount

processingInformation.japanPaymentOptions.secondBonusMonth

Updated this field:

recipientInformation.nationality

25.02

January 2025:
This revision of the guide contains updated or new field information.

Updated these fields:

deviceInformation.hostName

orderInformation.amountDetails.gratuityAmount

processingInformation.authorizationOptions.billPaymentType

25.01

January 2025:
This revision of the guide contains updated or new field information.

Added this new field:

createInstrumentIdentifier

Updated these fields:

orderInformation.amountDetails.taxDetails[].type

orderInformation.lineItems[].productSku

processingInformation.authorizationOptions.billPaymentType

processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction.reason

processingInformation.businessApplicationId

processingInformation.purposeOfPayment

recipientInformation.accountId

recipientInformation.accountType

recipientInformation.address1

recipientInformation.administrativeArea

recipientInformation.country

recipientInformation.firstName

recipientInformation.lastName

recipientInformation.locality

recipientInformation.middleName

recipientInformation.postalCode

senderInformation.account.fundsSource

senderInformation.account.number

senderInformation.account.type

senderInformation.address1

senderInformation.administrativeArea

senderInformation.countryCode

senderInformation.firstName

senderInformation.identificationNumber

senderInformation.lastName

senderInformation.middleName

senderInformation.name

senderInformation.personalIdType

senderInformation.locality

senderInformation.phoneNumber

senderInformation.referenceNumber

24.24

December 2024:
This revision of the guide contains updated or new field information.

Added this new field:

paymentInformation.card.productSubtype

Updated these fields:

allowedCardNetworks

allowedPaymentTypes

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

The following are specifications and conditions that apply to a Reseller/Partner enabling its merchants through

Cybersource for

Visa Platform Connect

(“VPC”) processing

. Failure to meet any of the specifications and conditions below is subject to the liability provisions and indemnification obligations under Reseller/Partner’s contract with Visa/Cybersource.

Before boarding merchants for payment processing on a VPC acquirer’s connection, Reseller/Partner and the VPC acquirer must have a contract or other legal agreement that permits Reseller/Partner to enable its merchants to process payments with the acquirer through the dedicated VPC connection and/or traditional connection with such VPC acquirer.

Reseller/Partner is responsible for boarding and enabling its merchants in accordance with the terms of the contract or other legal agreement with the relevant VPC acquirer.

Reseller/Partner acknowledges and agrees that all considerations and fees associated with chargebacks, interchange downgrades, settlement issues, funding delays, and other processing related activities are strictly between Reseller and the relevant VPC acquirer.

Reseller/Partner acknowledges and agrees that the relevant VPC acquirer is responsible for payment processing issues, including but not limited to, transaction declines by network/issuer, decline rates, and interchange qualification, as may be agreed to or outlined in the contract or other legal agreement between Reseller/Partner and such VPC acquirer.

DISCLAIMER: NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR ANY ERRORS OR OMISSIONS BY THE

Visa Platform Connect

ACQUIRER IN PROCESSING TRANSACTIONS. NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR RESELLER/PARTNER BOARDING MERCHANTS OR ENABLING MERCHANT PROCESSING IN VIOLATION OF THE TERMS AND CONDITIONS IMPOSED BY THE RELEVANT

Visa Platform Connect

ACQUIRER.

Introduction to the REST API Fields

REST, or (REpresentational State Transfer), is an architecture for developing web services. It enables communication between a client and server using HTTP protocols.

REST-compliant machines communicate with each other using stateless messaging. Stateless messaging is a loosely coupled connection between a client and server, where each message is self-contained. This connection enables the client and server to communicate without first establishing a communication channel and without managing the state between systems.

This guide provides an alphabetical list of the REST fields available through the Cybersource platform.

acquirerInformation

These fields are related to acquirer information. Use these links to view the specifications for these fields, or when you are viewing this content in a browser, enter

Ctrl + F

(Windows) or

Command + F

(Mac) to search for a field.

acquirerInformation.acquirerMerchantId

acquirerInformation.acquirerBin

acquirerInformation.country

acquirerInformation.merchantId

acquirerInformation.password

acquirerInformation. acquirerMerchantId

An aquirer assigned merchant ID.

Specifications

Data Type:
String

Data Length:
15 or 23. The length depends upon the number assigned by acquiring bank.

Mapping Information

REST API Field:

acquirerInformation.acquirerMerchantId

SCMP API Field:

acquirer_merchant_ID

Simple Order API Field:

ccAuthService_acquirerMerchantId

acquirerInformation. acquirerBin

pa_ds_login_id

Simple Order API Field:

payerAuthEnrollService_merchantId

acquirerInformation. password

Registered password for the Visa directory server.

For Mastercard, this value is always 12345678.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

acquirerInformation.password

SCMP API Field:

pa_ds_password

Simple Order API Field:

payerAuthEnrollService_password

addressVerificationInformation

These fields are related to address verification.

addressVerificationInformation.addressType

addressVerificationInformation.applicableRegion

addressVerificationInformation.barCode.checkDigit

addressVerificationInformation.barCode.value

addressVerificationInformation.careOf

addressVerificationInformation.errorCode

addressVerificationInformation.matchScore

addressVerificationInformation.standardAddress.address1. withApartment

addressVerificationInformation.standardAddress.address1.withoutApartment

addressVerificationInformation.standardAddress.address2

addressVerificationInformation.standardAddress.address3

addressVerificationInformation.standardAddress.address4

addressVerificationInformation.standardAddress.administrativeArea

addressVerificationInformation.standardAddress.country

addressVerificationInformation.standardAddress.county

addressVerificationInformation.standardAddress.csz

addressVerificationInformation.standardAddress.iso.Country

addressVerificationInformation.standardAddress.locality

addressVerificationInformation.standardAddress.postalCode

addressVerificationInformation.statusCode

addressVerificationInformation. addressType

Contains the record type of the postal code to which the address was matched.

U.S. Addresses
: Depending on the quantity and quality of the address information provided, this field contains one or two characters:

One character: Sufficient correct information was provided to result in accurate matching.

Two characters: Standardization would provide a better address if more or better input address information was available. The second character is

D

(default).

Blank fields are unassigned. When an address cannot be standardized, the parsing of the input data determines the address type. In this case, standardization can indicate a street, rural route, highway contract, general delivery, or PO box.

These address type codes are returned:

Address Type Codes
Code	Description
F	Firm.
G	General delivery.
H	High-rise apartment or office building.
M	Military.
P	Post office box.
R	Rural route or highway contract.
S	Street (usually one side of one city block).
FD	Firm default. The standardization process could not assign a firm extended ZIP code.
GD	General delivery default. Assigned when general delivery is the only primary name listed for the ZIP code.
HD	High-rise default. The standardization process assigned the extended ZIP code for the entire building. Assignment at the unit, floor, or wing level is possible. A suite or apartment number could be out of range.
RD	Rural route or highway contract default. The standardization process assigned the extended ZIP code for the entire route, but it was unable to assign the box number.
SD	Street default. The standardization process assigned the extended ZIP code for the block because there was no extended ZIP code for the building.
SR	Street served by route.
UD	Unique default. The owner of the ZIP code did not assign extended ZIP codes, or the address was not matched.

All Other Countries
: This field contains one of these values:

P

: Post

S

: Street

X

: Unknown

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.addressType

SCMP API Field:

dav_address_type

Simple Order API Field:

davReply_addressType

addressVerificationInformation. applicableRegion

The regional location of the delivery address.

Possible values include:

Canada

International

US

The values of the error codes and status codes mean different things depending on the applicable region.

Specifications

Data Type:
String

REST API Field:

addressVerificationInformation.errorCode

SCMP API Fields:

dav_ca_error_info

(Canadian)

dav_intl_error_info

(international)

dav_us_error_info

(US)

Simple Order API Fields:

davReply_caErrorInfo

(Canadian)

davReply_intlErrorInfo

(international)

davReply_usErrorInfo

(US)

addressVerificationInformation. matchScore

Indicates the probable correctness of the address match.

Returned for U.S. and Canadian addresses. Returns a value from

0-9

, where

0

is most likely to be correct and

9

is least likely to be correct, or

-1

if there is no address match.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

addressVerificationInformation.matchScore

SCMP API Field:

dav_match_score

Simple Order API Field:

davReply_matchScore

addressVerificationInformation. standardAddress.address1. withApartment

First line of the standardized address, including apartment information.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.address1.withApartment

SCMP API Field:

dav_standard_address

Simple Order API Field:

davReply_standardizedAddress1

addressVerificationInformation. standardAddress.address1. withoutApartment

Simple Order API Fields:

davReply_caInfo

davReply_intlInfo

davReply_usInfo

aggregatorInformation

These fields are related to aggregators.

aggregatorInformation.aggregatorId

aggregatorInformation.city

aggregatorInformation.country

aggregatorInformation.name

aggregatorInformation.postalCode

aggregatorInformation.serviceProvidername

aggregatorInformation.state

aggregatorInformation.streetAddress

aggregatorInformation.subMerchant.address1

aggregatorInformation.subMerchant.administrativeArea

aggregatorInformation.subMerchant.cardAcceptorId

aggregatorInformation.subMerchant.country

aggregatorInformation.subMerchant.email

aggregatorInformation.subMerchant.id

aggregatorInformation.subMerchant.locality

aggregatorInformation.subMerchant.name

aggregatorInformation.subMerchant.phoneNumber

aggregatorInformation.subMerchant.postalCode

aggregatorInformation.subMerchant.region

aggregatorInformation. aggregatorId

Value that identifies you as a payment aggregator.

Get this value from the processor.

FDC Compass: This value must consist of uppercase letters.
Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not available for standard credit card transactions.; This field is optional in a request for an AFT with aggregator support an OCT with aggregator support.
Visa Platform Connect: This field is required for Payouts transactions making OCT requests from merchants that are payment facilitators using Visa Platform Connect .

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

Record: CP01 TCR6

Position: 95-105

Field: Market Identifier / Payment Facilitator ID
Visa Platform Connect: This field is required in an authorization request message for Visa, Mastercard, and Discover transactions.

Specifications

Data Type:
String

Data Length:

Chase Paymentech Solutions :
204

Cielo :
11

FDC Nashville Global :
15

Getnet :
11

Rede :
11

Payment aggregator business name.

Chase Paymentech Solutions: This field is available only for Payouts transactions only. It is not available for standard credit card transactions. It is optional for Mastercard and Visa transactions.
FDC Compass: This value must consist of uppercase letters.
Getnet: This value must consist of uppercase letters. Special characters are not allowed.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.
Payouts OCT
:: Required in OCT requests from merchants that are payment facilitators using the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length

American Express Direct : Maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 37 characters.

Chase Paymentech Solutions : 22 for Mastercard, 25 for Visa

FDC Compass : Maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 37 characters.

FDC Nashville Global : 12

Getnet : 7

: 25

Visa Platform Connect : 25

Mapping Information

REST API Field:

aggregatorInformation.name

SCMP API Field:

aggregator_name

Simple Order API Fields:

ccAuthService_aggregatorName

ccCaptureService_aggregatorName

ccCreditService_aggregatorName

octService_aggregatorName

aggregatorInformation. postalCode

The postal code of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

aggregatorInformation.postalCode

SCMP API Field:

aggregator_postalCode

Simple Order API Fields:

ccAuthService_aggregatorPostalcode

octService_aggregatorPostalcode

aggregatorInformation. serviceProvidername

Name of the transfer service provider.

This field is available only on the Visa Platform Connect processor.

With Mastercard payment cards, the value for this field corresponds to this data in the TC 33 capture file:

Records: CP12 TCR2, TCR3, TCR4

Field: Gateway Data

This field is required for Payouts original credit transaction (OCT) service requests from these types of merchants:

Merchants who are payment facilitators.

Merchants who want OCT processing to be deferred to a specified date and time.

To support Visa Direct transactions in Original Credit Transactions destined to issuers in Australia or Canada, you must include additional merchant address data in the authorization request:

Field 43—Card Acceptor Name/Location

Field 59—National Point-of-Service Geographical Data

Field 104, Usage 2—Transaction-Specific Data in TLV format, Dataset ID 56—Additional Acceptance Information, Tag 81—Acceptor Legal Business Name

To process Faster Refund Original Credit Transactions (OCTs) in AP and the EU, include these fields in the request:

Transaction Type

Record: Field 3

Positions: 1-2

Transaction Amount

Record: Field 4

Card Acceptor Name or Location

Record: Field 43

Transaction Identifier

Record: Field 62.2 (in bitmap format)

Message Reason Code

Record: Field 63.3

Acceptor Legal Business Name

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 56

Tag: 81

Business Application Identifier (BAI)

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 57

Tag: 01

Visa Merchant Identifier

Record: 126.5

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

aggregatorInformation.serviceProvidername

SCMP API Field:

service_provider_name

Simple Order API Field:

octService_serviceProviderName

aggregatorInformation. state

The state or providence of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

aggregatorInformation.state

SCMP API Field:

aggregator_state

Simple Order API Fields:

ccAuthService_aggregatorState

octService_aggregatorState

aggregatorInformation. streetAddress

The street address of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
99

Mapping Information

REST API Field:

aggregatorInformation.streetAddress

SCMP API Field:

aggregator_streetAddress

Simple Order API Fields:

ccAuthService_aggregatorStreetAddress

octService_aggregatorStreetAddress

aggregatorInformation. subMerchant.address1

The first line of the street address of the submerchant associated with the aggregator.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase letters.
Getnet: Allowable characters are letters, numbers, and spaces. Special characters are not allowed.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.

Specifications

Data Type:
String

Data Length:

American Express Direct :
29

Chase Paymentech Solutions :
38

Cielo :
22

FDC Compass :
38

FDC Nashville Global :
25

Getnet :
40—When length is greater than 40, characters to the right of the 40th character are discarded.

:
29

Rede :
48

Visa Platform Connect :
29

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.address1

SCMP API Field:

submerchant_street

Simple Order API Field:

invoiceHeader_submerchantStreet

aggregatorInformation. subMerchant.administrativeArea

Sub-merchant’s state or province.

Use a state, province, or territory code.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase characters.
Getnet: All characters must be uppercase letters. Special characters are not allowed.
Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR4

Position: 164-166

Field: Region Code

Specifications

Data Type:
String

Data Length:

Getnet :
2—When length is greater than 2, characters to the right of the 2nd character are discarded.

All other processors:
3

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.administrativeArea

SCMP API Field:

submerchant_state

Simple Order API Field:

invoiceHeader_submerchantState

aggregatorInformation. subMerchant.cardAcceptorId

Unique identifier assigned by the payment card company to the sub-merchant.

FDC Nashville Global: This field is available only for aggregator authorizations with American Express.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.cardAcceptorId

SCMP API Field:

submerchant_merchant_id

Simple Order API Field:

invoiceHeader_submerchantMerchantID

aggregatorInformation. subMerchant.country

Sub-merchant’s country.

Use the two-character ISO country code.

Barclays: For marketplace transactions, include this field and the
merchantInformation.merchantDescriptor.country
field in the transaction request. The marketplace is the merchant, and the retailer is the sub‑merchant. When the field values do not match, the transaction is identified as a foreign retail transaction to the acquirer and the merchant can verify them in the Business Center on the transactions details page.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of only uppercase letters.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.country

SCMP API Field:

submerchant_country

Simple Order API Field:

invoiceHeader_submerchantCountry

aggregatorInformation. subMerchant.email

Sub-merchant's email address.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
Visa Platform Connect: With American Express, the value of this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB

Position: 25-64

Field: American Express Seller Email Address

Specifications

Data Type:
String

Data Length:

FDC Nashville Global :
19

All other processors:
40

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.email

SCMP API Field:

submerchant_email

Simple Order API Field:

invoiceHeader_submerchantEmail

aggregatorInformation. subMerchant.id

ID that you assigned to the sub-merchant.

FDC Compass: This value must consist of uppercase letters.
Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
Visa Platform Connect: This field is required for the Payouts OCT service requests from merchants that are payment facilitators using Visa Platform Connect .; With American Express, the value of this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB

Position: 65-84

Field: American Express Seller ID

With Mastercard and Visa, the value of this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Position: 117-131

Field: Sub-Merchant ID
Visa Platform Connect: This field is required in an authorization request message for Discover transactions.

Specifications

Data Type:
String

Data Length:

Cielo : 15

FDC Nashville Global : 14

Getnet : 15

Rede : 15

Visa Platform Connect : American Express: 20, Mastercard and Visa: 15

All other processors: 20

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.id

SCMP API Field:

submerchant_id

Simple Order API Field:

invoiceHeader_submerchantID

aggregatorInformation. subMerchant.locality

Sub-merchant’s city.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase characters.
Getnet: Allowable characters are letters, numbers, and spaces. Special characters are not allowed.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.

Specifications

Data Type
: String

Data Length:

Chase Paymentech Solutions :
21 for Mastercard, 13 for Visa

Cielo :
13

FDC Compass :
21

FDC Nashville Global :
11

Getnet :
13—When length is greater than 13, characters to the right of the 13th character are discarded.

Rede :
13

All other processors:
14

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.locality

SCMP API Field:

submerchant_city

Simple Order API Field:

invoiceHeader_submerchantCity

aggregatorInformation. subMerchant.name

Sub-merchant’s business name.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase characters.
Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB

Position: 109-146

Field: American Express Seller Name

Specifications

Data Type:
String

Data Length:

American Express Direct : Maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 37 characters.

Chase Paymentech Solutions : Mastercard: 22, Visa: 25.

FDC Compass : American Express: 19. Mastercard: maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 37 characters.

FDC Nashville Global : American Express: 12. Mastercard: maximum length of the sub-merchant name depends on the length of the aggregator name: if aggregator name length is 1 through 3, maximum sub-merchant name length is 21; if aggregator name length is 4 through 7, maximum sub-merchant name length is 17; if aggregator name length is 8 through 12, maximum sub-merchant name length is 12.

Visa Platform Connect : American Express: maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. Not used with other card types.

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.name

SCMP API Field:

submerchant_name

Simple Order API Field:

invoiceHeader_submerchantName

aggregatorInformation. subMerchant.phoneNumber

Sub-merchant’s telephone number.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of numbers or a combinations of numbers and uppercase letters.

Formats:

NNN-NNN-NNNN

NNN-AAAAAAA
Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB

Position: 5-24

Field: American Express Seller Telephone Number

Specifications

Data Type:
String

Data Length:

Cielo :
13

FDC Compass :
13

FDC Nashville Global :
10

All other processors
: 20

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.phoneNumber

SCMP API Field:

submerchant_telephone_number

Simple Order API Field:

invoiceHeader_submerchantTelephoneNumber

aggregatorInformation. subMerchant.postalCode

Partial postal code for the sub-merchant’s address.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase letters.
Getnet: All characters must be numbers. Special characters are not allowed.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.

Specifications

Data Type:
String

Data Length:

American Express Direct :
10

Chase Paymentech Solutions :
15

FDC Compass :
15

Visa Platform Connect :
10

All other processors:
9

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.postalCode

SCMP API Field:

submerchant_postal_code

Simple Order API Field:

invoiceHeader_submerchantPostalCode

aggregatorInformation. subMerchant.region

Sub-merchant’s region.

FDC Nashville Global: This field is available only for aggregator authorizations.

Example
:
NE
indicates that the sub-merchant is in the northeast region.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.region

SCMP API Field:

submerchant_region

Simple Order API Field:

invoiceHeader_submerchantRegion

agreementInformation

These fields are related to agreements.

agreementInformation.agreementId

agreementInformation.dateSigned

agreementInformation.eSignIndicator

agreementInformation. agreementId

Identifier for the billing agreement.

This API field is required when checking the status of a billing agreement.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

agreementInformation.agreementId

SCMP API Field:

ap_billing_agreement_id

Simple Order API Field:

ap_billingAgreementID

agreementInformation. dateSigned

The date the mandate was signed.

Format:

YYYYMMDD

Only numerical values are supported.

Specifications

Data Type:
String

Data Length:
8

Mapping

REST Field Name:

agreementInformation.dateSigned

Simple Order Field Name:

apImportMandateService_dateSigned

agreementInformation. eSignIndicator

The indicator that the customer signed the electronic mandate.

Possible values:

N

: False

Y

: True

Specifications

Data Type:
String

Data Length:
1

Mapping

REST Field Name:

agreementInformation.eSignIndicator

Simple Order Field Name:

apUpdateMandateService_esign

allowedCardNetworks

The card networks that are allowed for the merchant.

Possible values:

Microform Integration: AMEX

CARNET

CARTESBANCAIRES

CUP

DINERSCLUB

DISCOVER

EFTPOS

ELO

JCB

JCREW

MADA

MAESTRO

MASTERCARD

MEEZA

VISA
Unified Checkout: AMEX

CARNET

CARTESBANCAIRES

CUP

DINERSCLUB

DISCOVER

EFTPOS

ELO

JCB

JCREW

MADA

MAESTRO

MASTERCARD

MEEZA

VISA

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

allowedCardNetworks

Simple Order API Field:
No corresponding field.

allowedPaymentTypes

The payment types that are allowed for the merchant.

Possible values:

Click to Pay Drop-In UI: CLICKTOPAY
Microform Integration: CARD

CHECK
Unified Checkout: APPLEPAY

CHECK

CLICKTOPAY

GOOGLEPAY

PANENTRY

IMPORTANT

Click to Pay supports American Express, Mastercard, and Visa for saved cards. Visa and Mastercard tokenize payment credentials using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay Token Requester IDs (TRIDs) rather than your existing TRIDs.

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

allowedPaymentTypes

Simple Order API Field:
No corresponding field.

authorizationInformation

These fields are related to authorizations.

authorizationInformation.approvalCode

authorizationInformation.reasonCode

authorizationInformation.reversalSubmitted

authorizationInformation. approvalCode

Authorization code.

This field is returned only when the value is sent by the processor.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

authorizationInformation.approvalCode

SCMP API Field:

auth_reversal_auth_code

Simple Order API Field:

ccAuthReversalReply_authorizationCode

authorizationInformation. reasonCode

Response flag for the original transaction.

Specifications

Type:
String

Length:
50

Mapping Information

REST API Field:

authorizationInformation.reasonCode

SCMP API Field:

original_transaction_rflag

Simple Order API Field:
No corresponding field

authorizationInformation. reversalSubmitted

Flag that indicates whether a full authorization reversal was successfully submitted.

This field is available only on the FDC Nashville Global processor.

Possible values:

Y

: Authorization reversal was successfully submitted.

N

: Authorization reversal was not successfully submitted. You must send a credit request for a refund.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

authorizationInformation.reversalSubmitted

SCMP API Field:

reversal_submitted

Simple Order API Field:

voidReply_reversalSubmitted

authenticatedIdentities

These fields are related to authenticated identities.

authenticatedIdentities.data

authenticatedIdentities.id

authenticatedIdentities.provider

authenticatedIdentities.relyingPartyId

authenticatedIdentities. data

The data from the authenticated identity, for FIDO this could be the Attestation.Base64URL encoded string (RFC4648).The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.

Specifications

Data Type:
String

Data Length:
17000

Mapping Information

REST API Field:

authenticatedIdentities.data

Simple Order API Field:
No corresponding field.

authenticatedIdentities. id

The id from the authenticated identity, for FIDO this could be the Relying Party Identifier.Base64URL encoded string (RFC4648).The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.

Specifications

Data Type:
String

Data Length:
2000

Mapping Information

REST API Field:

authenticatedIdentities.id

Simple Order API Field:
No corresponding field.

authenticatedIdentities. provider

The provider of the authenticated identity.

Possible value:

VISA_PAYMENT_PASSKEY

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

authenticatedIdentities.provider

Simple Order API Field:
No corresponding field.

authenticatedIdentities. relyingPartyId

The Base64URL-encoded value of auth.visa.com or vts.auth.visa.com .

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

authenticatedIdentities.relyingPartyId

Simple Order API Field:
No corresponding field.

authenticatorRenderMethod

The render method for the authenticator.

Possible values:

IFRAME

POPUP

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

authenticatorRenderMethod

Simple Order API Field:
No corresponding field.

buyerInformation

These fields are related to buyers.

buyerInformation.companyTaxId

buyerInformation.dateOfBirth

buyerInformation.gender

buyerInformation.hashedPassword

buyerInformation.language

buyerInformation.merchantCustomerId

buyerInformation.mobilePhone

buyerInformation.noteToSeller

buyerInformation.personalIdentification[].id

buyerInformation.personalIdentification.issuedBy

buyerInformation.personalIdentification[].type

buyerInformation.personalIdentification[]. verificationResults

buyerInformation.vatRegistrationNumber

buyerInformation.walletId

buyerInformation.workPhone

buyerInformation. companyTaxId

Tax identifier for the customer’s company.

This field is supported only for these kinds of payments on Visa Platform Connect :

BNDES transactions

Installment payments with Mastercard

Set the value for this field to the Cadastro Nacional da Pessoa Jurídica (CNPJ). The request must include this field or

buyerInformation.personalIdentification[].id

and

buyerInformation.personalIdentification[].type

. When a request includes both fields, the value for the

buyerInformation.personalIdentification[].id

and

buyerInformation.personalIdentification[].type

field

s

is

are

sent to the processor and the

buyerInformation.companyTaxId

field is ignored.

REST API Field:

buyerInformation.hashedPassword

SCMP API Field:

customer_password

Simple Order API Field:

billTo_customerPassword

buyerInformation. language

The language indicator for payment services.

For the Korea Cyber Payment (KCP) service, the default value is

Korean

.

Possible values:

EN

: English

Korean

: Korean

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

buyerInformation.language

SCMP API Field:

ap_initiate_language_interface

Simple Order API Field:

apInitiateService_languageInterface

buyerInformation. merchantCustomerId

Customer identifier.

This field is available only on the Banque de France et Tresor Public , Barclays , BNP Paribas France , Credit Mutuel-CIC , FDC Compass , Prosa , and Worldpay VAP processors.

These processors have specific requirements:

Credit Mutuel-CIC: For recurring payments in Mexico, the value for this field is the customer’s contract number.; Before you request the authorization, you must inform the issuer about the customer contract numbers that will be used for recurring transactions.
Prosa: For recurring payments in Mexico, the value for this field is the customer’s contract number.
Worldpay VAP: For a follow-on credit, Cybersource verifies these fields in the order given for a customer account ID value, and it uses d the first value it finds:
The
buyerInformation.merchantCustomerId
field value in the follow-on credit request.

The
buyerInformation.merchantCustomerId
field value that was used for the capture that is being credited.

The
buyerInformation.merchantCustomerId
field value that was used for the original authorization.

Specifications

Data Type:
String

Data Length:
15

Data Length

Banque de France et Tresor Public : 20

Barclays : 17

BNP Paribas France : 20

Credit Mutuel-CIC : 20

FDC Compass : 100

Prosa : 20

Mapping Information

REST API Field:

buyerInformation.merchantCustomerId

SCMP API Fields:

customer_account_id

purchaser_code

Simple Order API Fields:

billTo_customerID

invoiceHeader_purchaserCode

This field is available only on the Barclays processor.

buyerInformation. mobilePhone

Cardholder’s mobile phone number.

Specifications

Data Type:
Integer

Data Length:
25

Mapping Information

REST API Field:

buyerInformation.mobilePhone

SCMP API Field:

pa_mobile_phone

Simple Order API Field:

payerAuthEnrollService_mobilePhone

buyerInformation. noteToSeller

Note to the recipient of the funds.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

buyerInformation.noteToSeller

buyerInformation. personalIdentification[].id

Personal ID value, based on the personal ID type.

For example, if the personal ID type is Passport, the passport holder’s passport number would be the value of this field.

Syntax

"buyerInformation": {
    "personalIdentification": [
      {
        "type": "TAX_ID",
        "id": "A30328567",
        "issuedBy": "US"
      }
      ]

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:

buyerInformation.personalIdentification.id

SCMP API Fields:

verification_results_passport_number

verification_results_personal_id

verification_results_driver_license_no

verification_results_buyer_registration

SO API Fields:

verificationResults_passportNumber

verificationResults_personalID

verificationResults_driversLicenseNumber

verificationResults_buyerRegistration

buyerInformation. personalIdentification. issuedBy

A two or three character code that indicates the identity of the issuing authority usually a state or country code.

Use the two-character ISO state or country code.

Syntax

"buyerInformation": {
    "personalIdentification": [
      {
        "type": "TAX_ID",
        "id": "A30328567",
        "issuedBy": "US"
      }
      ]

Specifications

Data Type:
String

Data Length:
2-6

Mapping Information

REST API Fields:

buyerInformation.personalIdentification.issuedBy

SCMP API Field:

personal_id_issued_by

Simple Order API Field:

personalID_issuedBy

buyerInformation. personalIdentification[]. type

The type of document issued that identifies the account owner/authorized signer.

Valid values:

• 0 – Driver’s License (USA)

• 1 – Military (USA)

• 2 – Passport

• 3 – Resident Alien ID

• 4 – State Identification

• 5 – Student Identification

• 6 – Driver’s License (Foreign)

• 7 – Driver’s License (Canada)

• 8 – Driver’s License (Mexico)

• 9 – Other Primary ID (Foreign)

• A – Matricula Consular Card

• B – South America Cedula No.

Type of the personal identification.

Possible values include:

NATIONAL

: National ID

CPF

: Cadastro de Pessoas Fisicas (CPF)

CNPJ

: Cadastro Nacional da Pessoa Juridica (CNPJ)

CURP

: Clave Única de Registro de Población (CURP)

DRIVER_LICENSE

: Drivers License

MATRICULA_CONSULAR_CARD:

MILITARY:

OTHER:

PASSPORT_NUMBER

: Passport

PERSONAL_ID

: Other Personal ID

RESIDENT_ALIEN:

SOUTH_AMERICA_CEDULA_NO:

SSN

: Social Security Number

STATE:

STUDENT:

TAX_ID

: Tax ID

Comercio Latino: Set this field to the Cadastro de Pessoas Fisicas (CFP). The CFP number is required for AVS for Redecard in Brazil.

Syntax

"buyerInformation": {
    "personalIdentification": [
      {
        "type": "TAX_ID",
        "id": "A30328567",
        "issuedBy": "US"
      }
      ]

Specifications

Data Type:
String

Data Length:
Fixed, based on above list.

Mapping Information

REST API Field:

buyerInformation.personalIdentification.type

SCMP API Fields:

personal_id_number

personal_id_type

verification_results_merchant_tax_id

verification_results_passport_number

verification_results_personal_id

verification_results_driver_license_no

verification_results_buyer_registration

Simple Order API Fields:

personalID_number

personalID_type

verificationResults_merchantTaxID

verificationResults_passportNumber

verificationResults_personalID

verificationResults_driversLicenseNumber

verificationResults_buyerRegistration

buyerInformation. personalIdentification[]. verificationResults

Verification results for Issuer or Card Network for verification transactions.

Possible values:

1

: Verified.

2

: Failed.

3

: Verification was not performed.

4

: Issuer does not support verification.

Syntax

"buyerInformation": {
    "personalIdentification": [
      {
        "type": "TAX_ID",
        "id": "A30328567",
        "issuedBy": "US",
        "verificationResults": "INVALID_DATA"
      }
      ]

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

buyerInformation.personalIdentification.verificationResults

SCMP API Fields:

customer_passport_number

(request)

drivers_license_no

(request)

personal_id

(request)

verification_results_passport_number

(response)

verification_results_personal_id

(response)

verification_results_driver_license_no

(response)

verification_results_buyer_registration

(response)

Simple Order API Fields:

billTo_driversLicenseNumber

(request)

billTo_passportCountry

(request)

billTo_passportNumber

(request)

billTo_personalId

(request)

verificationResults_passportNumber

(response)

verificationResults_personalID

(response)

verificationResults_driversLicenseNumber

(response)

verificationResults_buyerRegistration

(response)

buyerInformation. vatRegistrationNumber

Buyer’s VAT registration number.

This field is available on the Barclays , Elavon Americas , FDC Nashville Global , GPN , OmniPay Direct , TSYS Acquiring Solutions , and Visa Platform Connect processors.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

buyerInformation.vatRegistrationNumber

SCMP API Fields:

buyer_registration

purchaser_vat_registration_number

Simple Order API Fields:

invoiceHeader_purchaserVATRegistrationNumber

This field is available only for authorizations on the Barclays processor.

item_#_buyerRegistration

taxService_buyerRegistration

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas : Customer VAT Registration Number

FDC Nashville Global : Customer VAT Registration Number

GPN : Customer VAT Number

OmniPay Direct : Customer VAT Registration Number

TSYS Acquiring Solutions : Customer VAT Registration Number

Visa Platform Connect : purchaseVATRegistrationNumber

buyerInformation. walletId

One-time identification code.

Used only for Alipay transactions, this field includes the number scanned from the barcode that is provided in the mobile application.

Specifications

Data Type:
String

Data Length:
150

Mapping Information

REST API Field:

buyerInformation.walletId

buyerInformation. workPhone

Cardholder's work phone number.

Specifications

Data Type:
Integer

Data Length:
25

Mapping Information

REST API Field:

buyerInformation.workPhone

SCMP API Field:

pa_work_phone

Simple Order API Field:

payerAuthEnrollService_workPhone

captureMandate

These fields are related to capture mandates.

captureMandate.billingType

captureMandate.comboCard

captureMandate.requestEmail

captureMandate.requestPhone

captureMandate.requestSaveCard

captureMandate.requestShipping

captureMandate.shipToCountries

captureMandate.showAcceptedNetworkIcons

captureMandate. billingType

Configure Unified Checkout to capture billing address information.

Possible values:

FULL

NONE

PARTIAL

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

captureMandate.billingType

Simple Order API Field:
No corresponding field.

captureMandate. comboCard

Indicates whether you want to offer the Combo Card feature for digital payment methods enabled on Click to Pay or Unified Checkout .

This field is supported when the

allowedPaymentTypes

field is set to

CLICKTOPAY

,

PANENTRY

, or both.

REST API Field:

captureMandate.requestPhone

Simple Order API Field:
No corresponding field.

captureMandate. requestSaveCard

Indicates whether you want to enable the Save Card feature for digital payment methods enabled on Unified Checkout .

This field is supported when the

allowedPaymentTypes

field is set to

CLICKTOPAY

,

PANENTRY

, or both.

Possible values:

true

: Enable the Save Card feature.

false

: Do not enable the Save Card feature.

By default, the value of the field is

false

and the Save Card feature is disabled.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

captureMandate.requestSaveCard

Simple Order API Field:
No corresponding field.

captureMandate. requestShipping

Configure Unified Checkout to capture shipping information.

Possible values:

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

captureMandate.requestShipping

Simple Order API Field:
No corresponding field.

captureMandate. shipToCountries

List of countries available to ship to in Unified Checkout . Use a two-character ISO country code.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

captureMandate.shipToCountries

Simple Order API Field:
No corresponding field.

captureMandate. showAcceptedNetworkIcons

Configure Unified Checkout to display the list of accepted card networks beneath the payment button.

Possible values:

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

captureMandate.showAcceptedNetworkIcons

Simple Order API Field:
No corresponding field.

captureOptions. dateToCapture

card

This field is related to cards.

card.type

The type of card that is used to provision a Token Management Service network tokenized card.

Possible value:

001

: Visa

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

card.type

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

clientCorrelationId

Used to correlate authentication and payment credential requests.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

clientCorrelationId

Simple Order API Field:
No corresponding field.

clientReferenceInformation

These fields provide client reference information.

clientReferenceInformation.apiKey

clientReferenceInformation.applicationName

clientReferenceInformation.applicationUser

clientReferenceInformation.applicationVersion

clientReferenceInformation.code

clientReferenceInformation.comments

clientReferenceInformation.ownerMerchantId

clientReferenceInformation.partner.developerId

clientReferenceInformation.partner. originalTransactionId

clientReferenceInformation.partner.solutionId

clientReferenceInformation.partner. thirdPartyCertificationNumber

clientReferenceInformation.pausedRequestID

clientReferenceInformation.reconciliationId

clientReferenceInformation.returnReconciliationId

clientReferenceInformation.submitLocalDateTime

clientReferenceInformation.transactionId

clientReferenceInformation. apiKey

PSP merchant API key.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

clientReferenceInformation.apiKey

SCMP API Field:

ap_api_key

Simple Order API Field:

ap_apiKey

clientReferenceInformation. applicationName

Client used to send the transaction request.

Specifications

Data Type:
String

Maximum Data Length:
50

Mapping Information

REST API Field:

clientReferenceInformation.applicationName

clientReferenceInformation. applicationUser

Entity responsible for submitting a processing request through the client.

This value may be a person, system, or connection method.

Specifications

Data Type:
String

Maximum Data Length:
60

Mapping Information

REST API Field:

clientReferenceInformation.applicationUser

clientReferenceInformation. applicationVersion

Version number of the client used to send the transaction request.

Specifications

Data Type:
String

Maximum Data Length:
50

Mapping Information

REST API Field:

clientReferenceInformation.applicationVersion

clientReferenceInformation. code

Order reference or tracking number.

Provide a unique value for each transaction so that you can perform meaningful searches for the transaction. Refer to the Getting Started with Cybersource Advanced
guide.

IMPORTANT

Depending on the values in your Cybersource account, there might be a requirement for this field's value to be unique within a 15-minute period. Contact customer support to find out whether this requirement applies to your Cybersource account.

PIN Debit Transactions: Requests for PIN debit reversals must include the same merchant reference number that was used in the transaction that is being reversed.
FDC Nashville Global: During card-not-present transactions, certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
FDC Nashville Global: During card-present transactions, when you do not send a valid value, one is created for you. However, the value is not returned, so you cannot use it to track the order.
SIX: When a card-present request does not include a merchant reference number, this value is provided by the client software that is installed on the POS terminal.

Specifications

Data Type:
String

Data Length:
50

Data Length
:

China UnionPay Data Length:
40

Elavon Americas Data Length:
39

FDC Nashville Global Data Length:
8

RuPay Data Length:
24 (Credit Services)

RuPay Data Length:
50 (Other services)

All Other Processor's Data Length:
8

Mapping Information

REST API Field:

clientReferenceInformation.code

SCMP API Field:

merchant_ref_number

Simple Order API Field:

merchantReferenceCode

clientReferenceInformation. comments

Comments about the transaction.

Mass Transit Transactions: Requests for Mass Transit transactions must include this field set to the value that corresponds to the type of transaction. The value that you send in this field appears in transaction details in the Business Center . For possible values, see the
Card Present Connect | Mass Transit Developer Guide
.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

clientReferenceInformation.comments

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

clientReferenceInformation. ownerMerchantId

Merchant ID used to create the subscription or token.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

clientReferenceInformation.ownerMerchantId

SCMP API Fields:

ecp_credit_owner_merchant_id

ecp_debit_owner_merchant_id

Simple Order API Fields:

ecCreditReply_ownerMerchantID

ecDebitReply_ownerMerchantID

clientReferenceInformation. partner. developerId

Identifier for the developer that integrated a partner solution to Cybersource .

Send this value in all requests that are sent through the partner solutions built but that developer. Cybersource assigns this ID to the developer.

IMPORTANT

When you see a developer ID of

999

in reports, the submitted developer ID is incorrect.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

clientReferenceInformation.partner.developerId

SCMP API Field:

developer_id

Simple Order API Field:

developerID

clientReferenceInformation. partner. originalTransactionId

Value that links the previous transaction to the current follow-on request.

This field is available only for Cybersource integrations.

This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal’s software and to Cybersource . Therefore, you can use this value to reconcile transactions between Cybersource and the terminal’s software.

This value is not sent to the processor. Instead, the value is forwarded to the Cybersource reporting software.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

clientReferenceInformation.partner.originalTransactionId

SCMP API Field:

partner_original_transaction_id

Simple Order API Field:

partnerOriginalTransactionID

clientReferenceInformation. partner. solutionId

Identifier for pre-built partner solution that is integrated to Cybersource .

Send this value in all requests that are sent through the partner solution. Cybersource assigns this ID to the partner.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

clientReferenceInformation.partner.solutionId

SCMP API Field:

partner_solution_id

Simple Order API Field:

partnerSolutionID

clientReferenceInformation. partner. thirdPartyCertificationNumber

Value that identifies the application vendor and application version for a third-party gateway.

You are provided with this value during testing and validation.

This field is supported only on Visa Platform Connect .

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

clientReferenceInformation.partner.thirdPartyCertificationNumber

SCMP API Field:

third_party_certification_number

Simple Order API Field:

thirdPartyCertificationNumber

clientReferenceInformation. pausedRequestID

Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete.

To resume and continue with the authorization/decision service flow, call the services and include the request ID from the prior decision call.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:

clientReferenceInformation.pausedRequestID

SCMP API Field:

paused_request_id

Simple Order API Field:

decisionManager_pausedRequestID

clientReferenceInformation. reconciliationId

Reference number for the transaction.

IMPORTANT

For most Cybersource services, the response message includes a unique reconciliation ID that is assigned by Cybersource . For most payment processors, you can use this value to reconcile the transactions in your Cybersource reports with the transactions in your processor reports.

For details, such as specific field names and information about processors that do not support reconciliation, see the implementation guide or developer guide for the payment method you are using.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

clientReferenceInformation.reconciliationId

SCMP API Field:

ap_initiate_trans_ref_no

Simple Order API Fields:

apInitiateReply_reconciliationID

apInitiateService_reconciliationID

clientReferenceInformation. returnReconciliationId

Reference number for for a transaction refund.

Specifications

Data Type:
String

Mapping Information

REST API Field:

clientReferenceInformation.returnReconciliationId

clientReferenceInformation. submitLocalDateTime

Local date and time at your physical location.

Format:

yyyyMMDDhhmmss

MM

= month

yyyy

= year

DD

= day

hh

= hour

mm

= minutes

ss

= seconds

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

clientReferenceInformation.submitLocalDateTime

SCMP API Field:

transaction_local_date_time

Simple Order API Field:

transactionLocalDateTime

clientReferenceInformation. transactionId

Unique identifier that the client system assigns, which will restrict transaction processing duplication. Required field for an authorization, sale, credit, refund, PIN debit purchase, and PIN debit credit requests. The identifier can be used to locate and identify these requests in the event of a time-out, in order to be used in a subsequent reversal or void request.

The suggested format for this value is:

Positions 1-4:
Last four characters or your merchant ID.

Positions 5-7:
Julian date. Format: ddd

Positions 8-13:
Time stamp. Format: hhmmss

Positions 14-15:
Two arbitrary characters. One way to generate two arbitrary characters is to use a counter from 01-99.

This response is sent when a duplicate request is detected:

"INVALID_REQUEST"
        "reason": "DUPLICATE_REQUEST"
        "message": "Declined - The transaction identifier sent with this request has already been used in the last 60 days"

This field is available only on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:

PIN Debit Transactions: 15

Other Transactions: 30

Mapping Information

REST API Field:

clientReferenceInformation.transactionId

SCMP API Fields:

merchant_transaction_identifier

pin_debit_credit_transaction_id

pin_debit_purchase_transaction_id

Simple Order API Fields:

merchantTransactionIdentifier

pinDebitCreditReply_transactionID

pinDebitPurchaseReply_transactionID

clientVersion

Version number that is being used by the application.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

clientVersion

REST API Field:

configVersion

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

consumerAuthenticationInformation

These fields provide consumer authentification information.

consumerAuthenticationInformation.accessToken

consumerAuthenticationInformation.acsOperatorID

consumerAuthenticationInformation.acsReferenceNumber

consumerAuthenticationInformation.acsRenderingType

consumerAuthenticationInformation.acsTransactionId

consumerAuthenticationInformation.acsUrl

consumerAuthenticationInformation.acsWindowSize

consumerAuthenticationInformation.alternateAuthenticationData

consumerAuthenticationInformation.alternateAuthenticationDate

consumerAuthenticationInformation.alternateAuthenticationMethod

consumerAuthenticationInformation. authenticationBrand

consumerAuthenticationInformation. authenticationDate

consumerAuthenticationInformation.authenticationPath

consumerAuthenticationInformation.authenticationResult

consumerAuthenticationInformation.authenticationStatusMsg

consumerAuthenticationInformation.authenticationTransactionContextId

consumerAuthenticationInformation. authenticationTransactionContext

consumerAuthenticationInformation.authenticationTransactionId

consumerAuthenticationInformation.authenticationType

consumerAuthenticationInformation.authenticationValue

consumerAuthenticationInformation.authorizationPayload

consumerAuthenticationInformation.cardholderMessage

consumerAuthenticationInformation.cavv

consumerAuthenticationInformation.cavvAlgorithm

consumerAuthenticationInformation.challengeCancelCode

consumerAuthenticationInformation.challengeCode

consumerAuthenticationInformation.challengeRequired

consumerAuthenticationInformation.credentialEncrypted

consumerAuthenticationInformation.customerCardAlias

consumerAuthenticationInformation.dataQualityIndicator

consumerAuthenticationInformation. decoupledAuthenticationIndicator

consumerAuthenticationInformation. decoupledAuthenticationMaxTime

consumerAuthenticationInformation.defaultCard

consumerAuthenticationInformation.deviceChannel

consumerAuthenticationInformation.deviceDataCollectionURL

consumerAuthenticationInformation. directoryServerErrorCode

consumerAuthenticationInformation.directoryServerErrorDescription

consumerAuthenticationInformation.directoryServerTransactionId

consumerAuthenticationInformation.dsReferenceNumber

consumerAuthenticationInformation.eci

consumerAuthenticationInformation.eciRaw

consumerAuthenticationInformation.ecommerceIndicator

consumerAuthenticationInformation.effectiveAuthenticationType

consumerAuthenticationInformation.exemptionDataRaw

consumerAuthenticationInformation.fido.fidoFlowType

consumerAuthenticationInformation.fido.reasonCode

consumerAuthenticationInformation. fido.reasonDescription

consumerAuthenticationInformation.idciDecision

consumerAuthenticationInformation.idciReasonCode1

consumerAuthenticationInformation.idciReasonCode2

consumerAuthenticationInformation.idciScore

consumerAuthenticationInformation.interactionCounter

consumerAuthenticationInformation. languagePreference

consumerAuthenticationInformation.marketingOptIn

consumerAuthenticationInformation.marketingSource

consumerAuthenticationInformation.mcc

consumerAuthenticationInformation.merchantFraudRate

consumerAuthenticationInformation.merchantScore

consumerAuthenticationInformation.messageCategory

consumerAuthenticationInformation. methodUrlPresent

consumerAuthenticationInformation.networkScore

consumerAuthenticationInformation.otpToken

consumerAuthenticationInformation.overrideCountryCode

consumerAuthenticationInformation. overridePaymentMethod

consumerAuthenticationInformation.paSpecificationVersion

consumerAuthenticationInformation.pareq

consumerAuthenticationInformation[].paresStatus

consumerAuthenticationInformation. signedParesStatusReason

consumerAuthenticationInformation.priorAuthenticationData

consumerAuthenticationInformation.priorAuthenticationMethod

consumerAuthenticationInformation. priorAuthenticationReferenceId

consumerAuthenticationInformation.priorAuthenticationTime

consumerAuthenticationInformation.productCode

consumerAuthenticationInformation.proofXml

consumerAuthenticationInformation.proxyPan

consumerAuthenticationInformation.referenceId

consumerAuthenticationInformation. requestorInitiatedAuthenticationIndicator

consumerAuthenticationInformation.requestorName

consumerAuthenticationInformation.responseAccessToken

consumerAuthenticationInformation.returnUrl

consumerAuthenticationInformation.scoreRequest

consumerAuthenticationInformation.sdkFlowType

consumerAuthenticationInformation.sdkMaxTimeout

consumerAuthenticationInformation.sdkTransactionId

consumerAuthenticationInformation.signedParesStatusReason

consumerAuthenticationInformation.signedPares

consumerAuthenticationInformation.specificationVersion

consumerAuthenticationInformation.stepUpUrl

consumerAuthenticationInformation.strongAuthentication. authenticationIndicator

consumerAuthenticationInformation.strongAuthentication. authenticationOutageExemptionIndicator

consumerAuthenticationInformation.strongAuthentication. delegatedAuthenticationExemptionIndicator

consumerAuthenticationInformation.strongAuthentication. issuerInformation.trustedMerchantExemptionResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.delegatedAuthenticationResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.exemptionDataRaw

consumerAuthenticationInformation.strongAuthentication. issuerInformation.lowValueExemptionResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.riskAnalysisExemptionResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.secureCorporatePaymentResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.transactionRiskAnalysisExemptionResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.trustedMerchantExemptionResult

consumerAuthenticationInformation.strongAuthentication.lowValueExemptionIndicator

consumerAuthenticationInformation.strongAuthentication. riskAnalysisExemptionIndicator

consumerAuthenticationInformation.strongAuthentication. secureCorporatePaymentIndicator

consumerAuthenticationInformation.strongAuthentication. trustedMerchantExemptionIndicator

consumerAuthenticationInformation. strongAuthentication.transactionMode

consumerAuthenticationInformation. threeDSServerOperatorId

consumerAuthenticationInformation.threeDSServerTransactionId

consumerAuthenticationInformation.transactionFlowIndicator

consumerAuthenticationInformation.transactionToken

consumerAuthenticationInformation. ucafAuthenticationData

consumerAuthenticationInformation. ucafCollectionIndicator

consumerAuthenticationInformation.validityPeriod

consumerAuthenticationInformation.whiteListStatus

consumerAuthenticationInformation.whiteListStatusSource

consumerAuthenticationInformation.xid

consumerAuthenticationInformation. accessToken

JSON Web Token (JWT) used to authenticate the customer with the authentication provider (for example, CardinalCommerce or RuPay).

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. accessToken

SCMP API Field:

pa_access_token

Simple Order API Fields:

payerAuthEnrollReply_accessToken

payerAuthSetupReply_accessToken

consumerAuthenticationInformation. acsOperatorID

Access Control Server (ACS) identifier assigned by the directory service.

Each directory service can assign a unique ID to each ACS. This field is used with 3-D Secure 2.0. Required in mada transaction responses.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsOperatorID

SCMP API Field:

pa_acs_operator_id

Simple Order API Field:

payerAuthEnrollReply_acsOperatorId

consumerAuthenticationInformation. acsReferenceNumber

Unique identifier assigned by EMVCo upon testing and approval.

This field is used with 3-D Secure 2.0.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

consumerAuthenticationInformation.acsReferenceNumber

SCMP API Fields:

acs_reference_number

pa_acs_reference_number

Simple Order API Fields:

ccAuthService_acsReferenceNumber

payerAuthEnrollReply_acsReferenceNumber

consumerAuthenticationInformation. acsRenderingType

Identifies the UI type that the ACS will use to complete the challenge.

Available only for mobile application transactions using the Cardinal Mobile SDK.

This field is a JSON object that comprises the following two fields, each two characters long.

ACS Interface Field Name:

acsInterface

is the ACS interface the challenge presents to the cardholder. Possible values:

01

: Native UI.

02

: HTML UI.

ACS UI Template Field Name:

acsUiTemplate

identifies the UI template format that the ACS first presents to the consumer. Possible values:

01

: Text.

02

: Single select.

03

: Multi select.

04

: OOB (Out of Band).

05

: HTML other.

Valid values for each interface:

Native UI:

01-04

.

HTML UI:

01-05

.

HTML other is valid only when combined with HTML UI. If HTML other is used with Native UI, it results in error=203.

JSON Object Example:

{ "acsRenderingType":{ "acsInterface";"02", "acsUiTemplate":03" } }

Specifications

Data Type:
String

Data Length:
See description.

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsRenderingType

SCMP API Field:

pa_acs_rendering_type

Simple Order API Fields:

payerAuthEnrollReply_acsRenderingType

payerAuthValidateReply_acsRenderingType

consumerAuthenticationInformation. acsTransactionId

Unique transaction identifier assigned by the access control server (ACS) to identify a single transaction.

When you request the payer authentication and authorization services separately, get the value for this field from the

consumerAuthenticationInformation. acsTransactionId

response field.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsTransactionId

SCMP API Fields:

acs_server_transaction_id

pa_acs_transaction_id

Simple Order API Fields:

ccAuthService_acsServerTransactionID

payerAuthEnrollReply_acsTransactionID

payerAuthValidateReply_acsTransactionID

consumerAuthenticationInformation. acsUrl

URL for the card-issuing bank’s authentication form that you receive when the card is enrolled.

The value can be very large.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsUrl

SCMP API Field:

pa_enroll_acs_url

Simple Order API Field:

payerAuthEnrollReply_acsURL

consumerAuthenticationInformation. acsWindowSize

You can send this override field to set the challenge window size to display to the cardholder. The Access Control Server (ACS) replies with content that is formatted appropriately for this window size to allow for the best user experience.

The sizes are width x height in pixels of the window displayed in the cardholder browser. Possible values:

01

: 250x400

02

: 390x400

03

: 500x600

04

: 600x400

05

: Full page

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsWindowSize

SCMP API Field:

pa_acs_window_size

Simple Order API Field:

payerAuthEnrollService_acsWindowSize

consumerAuthenticationInformation. alternateAuthenticationData

Data that documents and supports a specific authentication process.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. alternateAuthenticationData

SCMP API Field:

pa_alternate_authentication_data

Simple Order API Field:

payerAuthEnrollService_alternateAuthenticationData

consumerAuthenticationInformation. alternateAuthenticationDate

Date and time in UTC of the cardholder authentication.

Format:

yyyyMMDDHHMM

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

consumerAuthenticationInformation. alternateAuthenticationDate

SCMP API Field:

pa_alternate_authentication_date

Simple Order API Fields:

payerAuthEnrollReply_alternateAuthenticationDate

payerAuthEnrollService_alternateAuthenticationDate

consumerAuthenticationInformation. alternateAuthenticationMethod

Mechanism used by the cardholder to authenticate to the 3-D Secure requestor.

Possible values:

01

: No authentication occurred.

REST API Field Reference

Recent Revisions to This Document

26.01.01

25.11.02

25.11.01

25.10.02

25.10.01

25.09.02

25.09.01

25.08.01

25.07.01

25.06.02

25.06.01

25.05.02

25.05.01

25.04.02

25.04.01

25.04

25.03

25.02

25.01

24.24

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to the REST API Fields

acquirerInformation

acquirerInformation. acquirerMerchantId

Specifications

Mapping Information

acquirerInformation. acquirerBin

Specifications

Mapping Information

acquirerInformation. country

Specifications

Mapping Information

acquirerInformation. merchantId

Specifications

Mapping Information

acquirerInformation. password

Specifications

Mapping Information

addressVerificationInformation

addressVerificationInformation. addressType

Specifications

Mapping Information

addressVerificationInformation. applicableRegion

Specifications

Mapping Information

addressVerificationInformation. barCode.checkDigit

Specifications

Mapping Information

addressVerificationInformation. barCode.value

Specifications

Mapping Information

addressVerificationInformation. careOf

Specifications

Mapping Information

addressVerificationInformation. errorCode

Specifications

Mapping Information

addressVerificationInformation. matchScore

Specifications

Mapping Information

addressVerificationInformation. standardAddress.address1. withApartment

Specifications

Mapping Information

addressVerificationInformation. standardAddress.address1. withoutApartment

Specifications

Mapping Information

addressVerificationInformation. standardAddress.address2

Specifications

Mapping Information

addressVerificationInformation. standardAddress.address3

Specifications

Mapping Information

addressVerificationInformation. standardAddress.address4

Specifications

Mapping Information

addressVerificationInformation. standardAddress.administrativeArea

Specifications

Mapping Information

`REST API` Field Reference