Recent Revisions to This Document

About This Guide

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Payments
- Financial Institutions and Payment Networks
  - Merchant Financial Institutions (Acquirers)
  - Issuing (Customer) Financial Institutions
  - Payment Networks
  - Payment Processors
- Card Types
  - Co-Badged Cards
  - Co-Branded Cards
  - Credit Cards
  - Debit Cards
  - Prepaid Cards
  - Private Label Cards
  - Quasi-Cash
- Transaction Types
  - Card-Not-Present Transactions
  - Card-Present Transactions
  - Authorizations with Card Verification Numbers
    - CVN Locations and Terminology
  - International Transactions
    - Dynamic Currency Conversion
    - Merchant Remittance Funding
  - Token Management Service
- Payment Services
  - Authorizations
    - payments-intro-processing-auth-micropayment
    - Online Authorizations
    - Offline Authorizations
    - Incremental Authorizations
      - Example: Incremental Authorization
    - Payment Network Token Authorizations
    - Authorization Workflow
  - Authorization Reversals
  - Captures
    - Capture Workflow
  - Credits
    - Credit Workflow
  - Voids
  - Sales
    - Dual Message Processing
      - Partial Authorizations
    - Single Message Processing
- Payment Features
  - Card-Present Authorizations
  - Debit and Prepaid Card Payments
  - Airline Data
    - Cybersource Airline Data Processing
    - Airline Travel Legs
    - Airline Data Reference Information
      - Airline Document Type Codes
      - Ancillary Service Category Codes
  - Interchange Optimization
  - Japanese Payment Options
  - Level II and Level III Data
  - Mastercard Bill Payments
  - Mastercard Expert Monitoring Solutions
  - Payer Authentication
  - Split Shipments
  - Stored Credentials
  - Token Management Service

Standard Payments Processing
- Additional Documentation
- Basic Authorizations
  - Declined Authorizations
  - Required Fields for Processing a Basic Authorization
    - Country-Specific Required Fields for Processing a Basic Authorization
  - REST Interactive Example: Processing a Basic Authorization
  - REST Example: Processing a Basic Authorization
- Authorizations with Line Items
  - Required Fields for Processing an Authorization with Line Items
    - Country-Specific Required Fields for Processing an Authorization with Line Items
  - REST Example: Processing an Authorization with Line Items
- Authorizations with Payment Network Tokens
  - Required Fields for Authorizations with Payment Network Tokens
  - Optional Fields for Authorizations with Payment Network Tokens
  - REST Example: Authorizations with Payment Network Tokens
- Authorizations with a Card Verification Number
  - Required Fields for Processing an Authorization with a Card Verification Number
  - Optional Fields for Processing an Authorization with a Card Verification Number
  - REST Example: Processing an Authorization with a Card Verification Number
- Authorizations with the DCC Gateway Service
  - Required Fields for Processing DCC Authorizations
    - Country-Specific Required Fields for Processing a DCC Authorization
  - REST Example: Processing a DCC Authorization
- Authorizations with Strong Customer Authentication Exemption
  - Required Fields for Processing an Authorization with an SCA Exemption
  - REST Example: Processing an Authorization with an SCA Exemption for Low-Value Transactions
- Zero Amount Authorizations
  - Required Fields for Processing a Zero Amount Authorization
    - Country-Specific Required Fields for Processing a Zero Amount Authorization
  - REST Example: Processing a Zero Amount Authorization
- Incremental Authorizations
  - Required Fields for Processing an Incremental Authorization
    - Country-Specific Required Fields for Processing an Incremental Authorization
  - Optional Field for Processing an Incremental Authorization
  - REST Example: Processing an Incremental Authorization
- Final Authorization Indicator
  - Requirements for Final Authorizations
  - Pre-authorizations
  - Unmarked Authorizations
    - Requirements for Unmarked Authorizations
  - Undefined Authorizations
    - Requirements for Undefined Authorizations
  - Required Fields for Final Authorizations
  - REST Example: Final Authorizations
- Authorization Reversal
  - Required Fields for Processing an Authorization Reversal
  - REST Example: Processing an Authorization Reversal
- Capture
  - Required Fields for Capturing an Authorization
  - REST Example: Capturing an Authorization
- Multiple Partial Captures
  - Required Fields for Processing Multiple Partial Captures
  - REST Example: Processing Multiple Partial Captures
- Forced Captures
  - Required Fields for Forced Captures
  - REST Example: Forced Captures
- Refunds
  - Required Fields for Processing a Refund
  - REST Interactive Example: Processing a Refund
  - REST Example: Processing a Refund
- Credit
  - Required Fields for Processing a Credit
  - REST Interactive Example: Processing a Credit
  - REST Example: Processing a Credit
- Sales
  - Required Fields for Processing a Sale
  - REST Example: Processing a Sale
- Voids
  - Required Fields for Processing a Void
  - REST Example: Processing a Void

Card Present Connect | Retail Processing
- Additional Documentation
- Authorization with Contactless EMV and Online PIN
  - Required Fields for Processing an Authorization with Contactless EMV and Online PIN
  - REST Example: Processing an Authorization with Contactless EMV and Online PIN
- Authorization with Contactless EMV and Offline PIN
  - Required Fields for Processing an Authorization with Contactless EMV and Offline PIN
  - REST Example: Processing an Authorization with Contactless EMV and Offline PIN
- Authorization with Contactless EMV and Online PIN
  - Required Fields for Processing an Authorization with Contactless EMV and Online PIN
  - REST Example: Processing an Authorization with Contactless EMV and Online PIN
- Authorizations with Magnetic Stripe Swipes
  - Required Fields for Processing an Authorization with Swiped Track Data
  - REST Example: Processing an Authorization with Swiped Track Data
- Authorizations with Hand-Keyed Data
  - Required Fields for Processing an Authorization with Hand Keyed Data
  - REST Example: Processing an Authorization with Hand Keyed Data
- Authorization for a Cash Advance with a Credit Card
  - Required Fields for Processing an Authorization for a Cash Advance
  - Optional Fields for Processing an Authorization for a Cash Advance
  - REST Example: Processing an Authorization for a Cash Advance
  - Response Codes from an Authorization for a Cash Advance
- Capture
  - Required Fields for Capturing an Authorization
  - Capturing an Authorization Using REST APIs
  - REST Example: Capturing an Authorization

Card Present Connect | Mass Transit Processing
- Additional Documentation
- Mastercard Authorization with EMV Data
  - Example: Mastercard Authorization with EMV Data
- Visa Account Verification Request (AVR) with EMV Data
  - Example: Visa AVR Authorization with EMV Data
- Visa Deferred Sale with EMV Data
  - Example: Visa Deferred Sale with EMV Data
- Tap-Initiated Authorization for Debt Recovery with EMV Data
  - Example: Tap-Initiated Authorization for Debt Recovery with EMV Data
- Merchant-Initiated Authorizations for Debt Recovery with Stored Card Data
  - Example: Merchant-Initiated Authorization for Debt Recovery with Stored Card Data
- Tap-Initiated Sales for Debt Recovery with EMV Data
  - Example: Tap-Initiated Sale for Debt Recovery with EMV Data Using the REST API
- Merchant-Initiated Sales for Debt Recovery with Stored Card Data
  - Example: Merchant-Initiated Sale for Debt Recovery with Stored Card Data
- Stand-Alone Credits with Card Data
  - Example: Stand-Alone Credit with Card Data
- Capture an Authorization
  - Example: Capture a Authorization
- Authorization Reversals
  - Example: Reversing a Mass Transit Authorization
- Timeout Reversal
  - Example: Timeout Reversal
- Timeout Void
  - Example: Timeout Void

Debit and Prepaid Card Processing
- Additional Documentation
- Processing Debit and Prepaid Authorizations
  - Required Fields for Processing Debit and Prepaid Authorizations
    - Country Specific Required Fields to Process Debit and Prepaid Authorizations
  - Optional Field for Processing Debit and Prepaid Authorizations
  - REST Example: Processing Debit and Prepaid Authorizations
- Enabling Debit and Prepaid Partial Authorizations
  - Required Fields for Enabling Debit and Prepaid Partial Authorizations
  - Optional Field for Enabling Debit and Prepaid Partial Authorizations
  - REST Example: Enabling Debit and Prepaid Partial Authorizations
- Disabling Debit and Prepaid Partial Authorizations
  - Required Field for Disabling Debit and Prepaid Partial Authorizations
  - Optional Field for Disabling Debit and Prepaid Partial Authorizations
  - REST Example: Disabling Debit and Prepaid Partial Authorizations

Airline Data Processing
- Additional Documentation
- Visa Platform Connect Airline Authorizations
  - Required Fields for Authorizing an Airline Payment
  - REST Example: Authorizing an Airline Payment
- Visa Platform Connect Airline Captures for Ticket Purchases
  - Required Fields for Capturing an Airline Payment
    - Card-Specific Field to Capture an Airline Payment
  - Optional Fields for Capturing an Airline Payment
  - REST Example: Capturing an Airline Payment
- Visa Platform Connect Airline Captures for Ancillary Purchases
  - Required Fields for Capturing an Authorization for Ancillary Purchases
  - Ancillary Fields for Capturing an Authorization for an Ancillary Purchase
  - REST Example: Capturing an Authorization for an Ancillary Purchase
- Visa Platform Connect Airline Refunds
  - Required Fields for Processing an Airline Refund
  - Optional Fields for Processing an Airline Refund
  - REST Example: Processing an Airline Refund
- Visa Platform Connect Airline Credits
  - Required Fields for Processing an Airline Credit
  - Optional Fields for Processing an Airline Credit
  - REST Example: Processing an Airline Credit

Japanese Payment Options Processing
- Authorize a Single Payment with Japanese Payment Options
  - Required Fields for Authorizing a Single Payment Using the JPO Method
  - REST Example: Authorizing a JPO Single Payment
- Authorize a Bonus Payment with Japanese Payment Options
  - Required Fields for Authorizing a JPO Bonus Payment
  - REST Example: Authorizing a JPO Bonus Payment
- Authorize an Installment Payment with Japanese Payment Options
  - Required Fields for Authorizing a JPO Installment Payment
  - REST Example: Authorizing a JPO Installment Payment
- Authorize a Revolving Payment with Japanese Payment Options
  - Required Fields for Authorizing a Revolving Payment Using the JPO Method
  - REST Example: Authorizing a JPO Revolving Payment
- Authorize a Combination Payment with Japanese Payment Options
  - Required Fields for Authorizing a Combination Payment Using the JPO Method
  - REST Example: Authorizing a JPO Combination Payment

Level II Processing
- Additional Documentation
- Captures with Level II Data
  - Required Fields for Capturing a Payment with Level II Data
  - Optional Fields for Capturing a Payment with Level II Data
  - REST Example: Capturing a Payment with Level II Data
- Credits with Level II Data
  - Required Fields for Processing a Credit with Level II Data
  - Optional Fields for Processing a Credit with Level II Data
  - REST Example: Processing a Credit with Level II Data
- Sales with Level II Data
  - Required Fields for Processing a Sale with Level II Data
  - Optional Fields for Processing a Sale with Level II Data
  - REST Example: Processing a Sale with Level II Data

Level III Processing
- Additional Documentation
- Captures with Level III Data
  - Required Fields for Capturing a Payment with Level III Data
  - Optional Fields for Capturing a Payment with Level III Data
  - REST Example: Capturing a Payment with Level III Data
- Credits with Level III Data
  - Required Fields for Processing a Credit with Level III Data
  - Optional Fields for Processing a Credit with Level III Data
  - REST Example: Processing a Credit with Level III Data
- Sales with Level III Data
  - Required Fields for Processing a Sale with Level III Data
  - Optional Fields for Processing a Sale with Level III Data
  - REST Example: Processing a Sale with Level III Data

Mastercard Processing
- Mastercard Bill Payment Processing
  - Required Fields for Authorizing a Mastercard Bill Payment
  - REST Example: Authorizing a Mastercard Bill Payment
- Mastercard Expert Monitoring Solutions Processing
  - Required Fields for Processing an Authorization with Mastercard Expert Monitoring Solutions
  - Response Field for Authorizations with Mastercard Expert Monitoring Solutions
  - REST Example: Obtaining the Mastercard Fraud Score for an Authorization

Payer Authentication Processing
- Additional Documentation
- Providing Payer Authentication Information for Authorization
- American Express SafeKey
  - Required Fields for Processing an Authorization Using American Express SafeKey
  - Optional Field for Processing an Authorization Using American Express SafeKey
  - REST Example: Processing an Authorization Using American Express SafeKey
- JCB J/Secure
  - Required Fields for Processing an Authorization Using JCB J/Secure Authentication
  - REST Example: Processing an Authorization Using JCB J/Secure Authentication
- Mastercard Identity Check
  - Required Fields for Processing an Authorization Using Mastercard Identity Check
  - REST Example: Processing an Authorization Using Mastercard Identity Check
- Visa Secure
  - Required Fields for Processing an Authorization Using Visa Secure
  - REST Example: Processing an Authorization Using Visa Secure

Split Shipments Processing
- Authorizing a Sale for a Product Not Yet Available
- Processing Two Authorizations and a Capture for Multiple Products
- Processing an Authorization and Two Captures for Multiple Products

Processing Payments Using Credentials
- Additional Documentation
- Customer-Initiated Transactions with Credentials on File
  - Storing Customer Credentials with a CIT and PAN
    - Required Fields for Storing Customer Credentials During a CIT
    - REST Example: Storing Customer Credentials During a CIT
  - Storing Customer Credentials with a CIT and TMS
    - Required Fields for Storing a Customers Credentials with a CIT and TMS
    - Example: Storing a Customer's Credentials with a CIT and TMS
  - Using Stored Customer Credentials During a CIT
    - Required Fields for Retrieving Customer Credentials During a Customer-Initiated Transaction
      - Card-Specific Required Field for Retrieving Customer Credentials During a CIT
    - REST Example: Retrieving Customer Credentials During a CIT
- MIT Delayed Transaction with PAN
  - Required Fields for Processing a Merchant-Initiated Delayed Transaction
    - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
  - REST Example: Processing a Merchant-Initiated Delayed Authorization Transaction
- MIT Delayed Transaction with TMS
  - Required Fields for MIT Delayed Transaction with TMS
  - Example: MIT Delayed Transaction with TMS Instrument Identifier
  - Example: MIT Delayed Transaction with TMS Payment Instrument
  - Example: MIT Delayed Transaction with TMS Customer token
- MIT Incremental Transaction with PAN
  - Required Fields for Processing Merchant-Initiated Incremental Transactions
    - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
  - REST Example: Processing Merchant-Initiated Incremental Transactions
- MIT Incremental Transaction with TMS
  - Required Fields for MIT Incremental Transaction with TMS
  - Example: MIT Incremental Transaction with a TMS Instrument Identifier
  - Example: MIT Incremental Transaction with a TMS Payment Instrument
  - Example: MIT Incremental Transaction with a TMS Customer token
- MIT No-Show Transactions with PAN
  - Required Fields for Processing Merchant-Initiated No-Show Charges
    - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
  - Optional Field for Processing Merchant-Initiated No-Show Charges
  - REST Example: Processing Merchant-Initiated No-Show Transactions
- MIT No-Show Transaction with TMS
  - Required Fields for MIT No-Show Transaction with TMS
  - Example: MIT No-Show Transaction with a TMS Instrument Identifier
  - Example: MIT No-Show Transaction with a TMS Payment Instrument
  - Example: MIT No-Show Transaction with a TMS Customer
- MIT Reauthorization Transactions with PAN
  - Required Fields for Processing Merchant-Initiated Reauthorized Transactions
    - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
  - REST Example: Processing a Merchant-Initiated Reauthorized Transaction
- MIT Reauthorization Transactions with TMS
  - Required Fields for MIT Reauthorization Transaction with TMS
  - Example: MIT Reauthorization Transaction with a TMS Instrument Identifier
  - Example: MIT Reauthorization Transaction with a TMS Payment Instrument
  - Example: MIT Reauthorization Transaction with a TMS Customer
- MIT Resubmission Transaction with PAN
  - Required Fields for Processing a Merchant-Initiated Resubmitted Transaction
    - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
  - REST Example: Processing a Merchant-Initiated Resubmitted Transaction
- MIT Resubmission Transaction with TMS
  - Required Fields for MIT Resubmission Transaction with TMS
  - Example: MIT Resubmission Transaction with a TMSInstrument Identifier
  - Example: MIT Resubmission Transaction with a TMSPayment Instrument
  - Example: MIT Reauthorization Transaction with a TMS Customer
- Installment Payments
  - CIT Installment Payments with PAN
    - Required Fields for Initial Customer-Initiated Installment Payments with a PAN
    - REST Example: Authorizing Initial Customer-Initiated Installment Payments with a PAN
  - CIT Installment Payment with TMS
    - Required Fields for CIT Installment Payments with TMS
    - REST Example: CIT Installment Payment with TMS
  - MIT Installment Payments with PAN
    - Required Fields for Authorizing Merchant-Initiated Subsequent Installment Payments
    - Card-Specific Required Field for Retrieving Customer Credentials During a CIT
    - India-Specific Required Fields for Installment Payments
    - REST Example: Authorizing Merchant-Initiated Subsequent Installment Payments
  - MIT Installment Payment with TMS
    - Required Fields for MIT Installment Payments with TMS
    - Card-Specific Required Field for Retrieving Customer Credentials During a CIT
    - India-Specific Required Fields for Installment Payments
    - Example: MIT with TMS Instrument Identifier Token
- Recurring Payments
  - CIT Recurring Payment with PAN
    - Required Fields for Authorizing Initial Recurring Payments Using REST API
    - REST Example: Authorizing an Initial CIT Recurring Payment with a PAN
  - CIT Recurring Payment with TMS
    - Required Fields for CIT Recurring Payments with TMS
    - REST Example: CIT Recurring Payment with TMS
  - MIT Recurring Payments with PAN
    - Required Fields for Authorizing Subsequent Recurring Payments
      - Card-Specific Required Fields for Authorizing Subsequent Recurring Payments
      - Country-Specific Required Fields for Authorizing Subsequent Recurring Payments
    - REST Example: Authorizing Subsequent Recurring Payments
  - MIT Recurring Payments with TMS
    - Required Fields for MIT Recurring Payments with TMS
    - Example: MIT Recurring Payment with a TMS Instrument Identifier
    - Example: MIT Recurring Payment with TMS Payment Instrument
    - Example: MIT Recurring Payment with a TMS Customer Token
- Mastercard Standing Order Payments
  - Mastercard Initial CIT Standing Order Payment
    - Required Fields for Authorizing Initial CIT Standing Order Payments
    - REST Example: Authorizing Initial CIT Standing Order Payments
- Mastercard Subscription Payments
  - Mastercard CIT Initial Subscription Payment
    - Required Fields for Authorizing CIT Initial Subscription Payments
    - REST Example: Authorizing Initial CIT Subscription Payments
- Unscheduled COF Payments
  - CIT Unscheduled COF Payment with PAN
    - Required Fields for Authorizing Initial CIT Unscheduled COF Payments
    - REST Example: Authorizing Initial CIT Unscheduled COF Payments
  - CIT Unscheduled COF Payments with TMS
    - Required Fields for CIT Unscheduled COF Payments with TMS
    - REST Example: Initial CIT Unscheduled COF Payment in TMS
  - MIT Unscheduled COF Payments with PAN
    - Required Fields for Authorizing Subsequent MIT Unscheduled COF Payments
      - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
      - Country-Specific Required Fields for Authorizing Subsequent Recurring Payments
    - REST Example: Authorizing Subsequent MIT Unscheduled COF Payments
  - MIT Unscheduled COF Payments with TMS
    - Required Fields for MIT Unscheduled COF Payments with TMS
    - Example: MIT Unscheduled COF Payment with TMS Instrument Identifier
    - Example: MIT Unscheduled COF Payment with TMS Payment Instrument
    - Example: MIT Unscheduled COF Payment with TMS Customer
- Merchant-Initiated Authorization Reversals
  - Required Fields for Processing a Merchant-Initiated Authorization Reversal
  - REST Example: Processing a Merchant-Initiated Authorization Reversal
- Merchant-Initiated Capture Voids
  - Required Fields for Processing a Merchant-Initiated Capture Void
  - REST Example: Processing a Merchant-Initiated Capture Void
- Merchant-Initiated Credit Voids
  - Required Fields for Processing a Merchant-Initiated Credit Void
  - REST Example: Processing a Merchant-Initiated Credit Void

Token Management Service Processing
- Additional Documentation
- Authorize a Payment with a Customer Token
  - Required Fields for Authorizing a Payment with a Customer Token
  - REST Example: Authorizing a Payment with a Customer Token
  - REST Example: Authorizing a Payment Using a Customer Token Linked to a Network Token
- Authorize a Payment with a Non-Default Shipping Address
  - Required Fields for Authorizing a Payment with a Non-Default Shipping Address
  - REST Example: Authorizing a Payment with a Non-Default Shipping Address
- Authorize a Payment with Non-Default Payment Instrument
  - Required Fields for Authorizing a Payment with Non-Default Payment Instrument
  - Optional Fields for Authorizing a Payment with Non-Default Payment Instrument
  - REST Example: Authorizing a Payment with Non-Default Payment Instrument
- Authorize a Payment with a Payment Instrument
  - Required Fields for Authorizing a Payment with a Payment Instrument
  - Optional Fields for Authorizing a Payment with a Payment Instrument
  - REST Example: Authorizing a Payment with a Payment Instrument
- Authorize a Payment with an Instrument Identifier
  - Required Fields for Authorizing a Payment with an Instrument Identifier
  - REST Example: Authorizing a Payment with an Instrument Identifier
  - REST Interactive Example: Authorizing a Payment with an Instrument Identifier
- Authorize a Payment with Legacy Token
  - Required Fields for Authorizing a Payment with Legacy Token
  - REST Example: Authorizing a Payment with Legacy Token
  - REST Interactive Example: Authorizing a Payment with a Legacy Token
- Make a Credit with a Customer Token
  - Required Fields for Making a Credit with a Customer Token
  - REST Example: Making a Credit with a Customer Token
- Make a Credit with Non-Default Payment Instrument
  - Required Fields for Making a Credit with Non-Default Payment Instrument
  - Optional Fields for Making a Credit with Non-Default Payment Instrument
  - REST Example: Making a Credit with Non-Default Payment Instrument
- Make a Credit with a Payment Instrument
  - Required Fields for Making a Credit with a Payment Instrument
  - REST Example: Making a Credit with a Payment Instrument
- Make a Credit with an Instrument Identifier
  - Required Fields for Making a Credit with an Instrument Identifier
  - REST Example: Making a Credit with an Instrument Identifier
  - REST Interactive Example: Making a Credit with an Instrument Identifier
- Make a Credit with Legacy Token
  - Required Fields for Making a Credit with Legacy Token
  - REST Example: Making a Credit with Legacy Token

On This Page

American Express SafeKey

American Express SafeKey is the authentication service in the American Express card network that uses the 3‑D Secure protocol to validate customers at checkout. When you request an authorization using a supported card type and a supported processor, you can include payer authentication data in the request.

Before implementing payer authentication for American Express SafeKey, contact customer support to have your account configured for this feature.

Fields Specific to the American Express SafeKey Use Case

These API fields are required specifically for this use case.

consumerAuthenticationInformation.cavv: Required when payer authentication is successful.
processingInformation.commerceIndicator
: Set this field to one of these values:
aesk
: Successful authentication (3‑D Secure value of
05
).
aesk_attempted
: Authentication was attempted (3‑D Secure value of
06
).
internet
: Authentication failed or was not attempted (3‑D Secure value of
07
).

Processor-Specific Requirements

Visa Platform Connect

processingInformation.authorizationOptions. transaction: Required only for merchants in Saudi Arabia.

Endpoint

Production:

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

Test:

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

Related Information

Payer Authentication Developer Guide | REST API