API Overview

Payments Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Payments
- Financial Institutions and Payment Networks
  - Merchant Financial Institutions (Acquirers)
  - Customer Financial Institutions (Issuers)
  - Payment Networks
  - Payment Processors
    - Visa Platform Connect Acquirers
- 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 Payment Services
    - Merchant Remittance Funding
  - Token Management Service
- Payment Services
  - Authorizations
    - Online Authorizations
    - Offline Authorizations
    - Pre-Authorizations
    - Payment Network Token Authorizations
    - Authorization Workflow
  - Sales
    - Dual-Message Processing
      - Partial Authorizations
    - Single-Message Processing
  - Authorization Reversals
  - Automatic Partial Authorization Reversals
  - Captures
    - Capture Workflow
  - Credits
    - Credit Workflow
  - Voids
- Payment Features
  - 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
  - Mastercard Bill Payments
  - Mastercard Expert Monitoring Solutions
  - Payer Authentication
  - Relaxed Requirements for Address Data and Expiration Date in Payment Transactions
  - Split Shipments
  - Introduction to Credentialed Transactions
- Testing the Payment Services
  - Requirements for Testing
  - Test Card Numbers
  - Using Amounts to Simulate Errors
  - Test American Express Card Verification

Standard Payment Processing
- Basic Authorizations
  - Declined Authorizations
  - Required Fields for Processing a Basic Authorization
    - Country-Specific Required Fields for Processing a Basic Authorization
  - Simple Order Example: Processing a Basic Authorization
- Authorizations with Line Items
  - Optional Line Item Fields
  - Required Fields for Processing an Authorization with Line Items
    - Country-Specific Required Fields for Processing an Authorization with Line Items
  - Simple Order 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
  - Simple Order API 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
  - Simple Order Example: Processing an Authorization with a Card Verification Number
- Marketplace Authorizations with Foreign Retailers
  - Required Fields for Processing a Marketplace Authorization with a Foreign Retailer
  - Simple Order Example: Processing a Authorization with a Foreign Retailer
- Authorizations with Strong Customer Authentication Exemption
  - Required Fields for Processing an Authorization with an SCA Exemption
  - Simple Order 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
  - Simple Order Example: Processing a Zero Amount Authorization
- Pre-Authorizations
  - Required Fields for a Pre-Authorization
    - Country-Specific Required Fields for Processing a Pre-Authorization
  - Simple Order Example: Processing a Pre-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
  - Simple Order 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
  - Simple Order Example: Final Authorizations
- Authorization Reversal
  - Required Fields for Processing an Authorization Reversal
  - Simple Order Example: Processing an Authorization Reversal
- Timeout Authorization Reversals
  - Required Fields for Processing a Timeout Authorization Reversal
  - Simple Order Example: Processing a Merchant-Initiated Authorization Reversal
- Sales
  - Required Fields for Processing a Sale
  - Simple Order Example: Processing a Sale
- Sales with Payment Network Tokens
  - Required Fields for Sales with Payment Network Tokens
  - Optional Fields for Sales with Payment Network Tokens
  - Simple Order API Example: Authorizations with Payment Network Tokens
- Captures
  - Required Fields for Capturing an Authorization
  - Simple Order Example: Capturing an Authorization
- Marketplace Captures with Foreign Retailers
  - Required Fields for Capturing an Authorization with a Foreign Retailer
  - Simple Order Example: Capturing a Marketplace Authorization with a Foreign Retailer
- Multiple Partial Captures
  - Required Fields for Processing Multiple Partial Captures
  - Simple Order Example: Processing Multiple Partial Captures
- Forced Captures
  - Required Fields for Forced Captures
  - Simple Order Example: Forced Captures
- Follow-On Credits
  - Required Fields for Processing a Follow-On Credit
  - Simple Order Example: Processing a Follow-On Credit
- Stand-Alone Credits
  - Required Fields for Processing a Stand-Alone Credit
  - Simple Order Example: Processing a Stand-Alone Credit
- Voids for Capture or Credit
  - Required Fields for Processing a Void
  - Simple Order API Example: Processing a Void
- Timeout Voids for a Capture, Sale, Follow-On Credit, or Stand-Alone Credit
  - Required Fields for Processing a Timeout Void for a Capture, Sale, Follow-On Credit, or Stand-Alone Credit
  - Simple Order Example: Processing a Timeout Void for a Capture, Sale, Follow-On Credit, or Stand-Alone Credit

Debit and Prepaid Card Processing
- Additional Resources for Debit and Prepaid Payments
- 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
  - Simple Order 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
  - Simple Order 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
  - Simple Order Example: Disabling Debit and Prepaid Partial Authorizations

Airline Data Processing
- Airline Travel Legs
- Authorizations
  - Required Fields for Authorizing an Airline Payment
  - Simple Order Example: Authorizing an Airline Payment
- 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
  - Simple Order Example: Capturing an Airline Payment
- Captures for Ancillary Purchases
  - Required Fields for Capturing an Authorization for Ancillary Purchases
  - Ancillary Fields for Capturing an Authorization for an Ancillary Purchase
  - Simple Order Example: Capturing an Authorization for an Ancillary Purchase
- Follow-On Credits
  - Required Fields for Processing an Airline Follow-On Credit
  - Optional Fields for Processing an Airline Follow-On Credit
  - Simple Order Example: Processing an Airline Follow-On Credit
- Stand-Alone Credits
  - Required Fields for Processing an Airline Stand-Alone Credit
  - Optional Fields for Processing an Airline Stand-Alone Credit
  - Simple Order Example: Processing an Airline Stand-Alone Credit

Japanese Payment Options Processing
- Authorize a Single Payment with Japanese Payment Options
  - Required Fields for Authorizing a Single Payment Using the JPO Method
  - Simple Order Example: Authorizing a JPO Single Payment
- Authorize a Bonus Payment with Japanese Payment Options
  - Required Fields for Authorizing a JPO Bonus Payment
  - Simple Order Example: Authorizing a JPO Bonus Payment
- Authorize an Installment Payment with Japanese Payment Options
  - Required Fields for Authorizing a JPO Installment Payment
  - Simple Order 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
  - Simple Order Example: Authorizing a JPO Installment Payment
- Authorize a Combination Payment with Japanese Payment Options
  - Required Fields for Authorizing a Combination Payment Using the JPO Method
  - Simple Order Example: Authorizing a JPO Combination Payment

Mastercard Processing
- Mastercard Bill Payment Processing
  - Required Fields for Authorizing a Mastercard Bill Payment
  - Simple Order 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
  - Simple Order Example: Obtaining the Mastercard Fraud Score for an Authorization

Payer Authentication Processing
- Additional Resources for Payer Authentication
- 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
  - Simple Order Example: Processing an Authorization Using American Express SafeKey
- JCB J/Secure
  - Required Fields for Processing an Authorization Using JCB J/Secure Authentication
  - Simple Order Example: Processing an Authorization Using JCB J/Secure Authentication
- Mastercard Identity Check
  - Required Fields for Processing an Authorization Using Mastercard Identity Check
  - Simple Order Example: Processing an Authorization Using Mastercard Identity Check
- Visa Secure
  - Required Fields for Processing an Authorization Using Visa Secure
  - Simple Order Example: Validating and Authorizing an Authorization

Relaxed Requirements for Address Data and Expiration Date in Payment Transactions
- Requirements
- Services
- Relaxed Fields

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 Resources for Credentialed Transactions
- Customer-Initiated Transactions with Credentials on File
  - Storing Customer Credentials with a CIT and PAN
    - Required Fields for Storing Customer Credentials During a CIT
    - Simple Order Example: Storing Customer Credentials During a CIT
  - Retrieving 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
    - Simple Order Example: Retrieving Customer Credentials During a CIT
- Delayed Transaction
  - Merchant-Initiated Delayed Transaction with PAN
    - Required Fields for Processing a Merchant-Initiated Delayed Transaction
      - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
    - Simple Order Example: Processing a Merchant-Initiated Delayed Authorization Transaction
- Incremental Transaction
  - Merchant-Initiated Incremental Transaction with PAN
    - Required Fields for Processing Merchant-Initiated Incremental Transactions
      - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
    - Simple Order Example: Processing Merchant-Initiated Incremental Transactions
- No-Show Transactions
  - Merchant-Initiated 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
    - Simple Order Example: Processing Merchant-Initiated No-Show Transactions
- Reauthorization Transaction
  - Merchant-Initiated Reauthorization Transactions with PAN
    - Required Fields for Processing Merchant-Initiated Reauthorized Transactions
      - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
    - Simple Order Example: Processing a Merchant-Initiated Reauthorized Transaction
- Resubmission Transaction
  - Merchant-Initiated Resubmission Transaction with PAN
    - Required Fields for Processing a Merchant-Initiated Resubmitted Transaction
      - Card-Specific Required Field for Processing a Merchant-Initiated Transactions
    - Simple Order Example: Processing a Merchant-Initiated Resubmitted Transaction
- Installment Payments
  - Customer-Initiated Installment Payments with PAN
    - Required Fields for Initial Customer-Initiated Installment Payments with a PAN
    - Simple Order Example: Authorizing Initial Customer-Initiated Installment Payments with a PAN
  - Merchant-Initiated Installment Payments with PAN
    - Required Fields for Authorizing Merchant-Initiated Subsequent Installment Payments
      - Card-Specific Required Field for Retrieving Customer Credentials During a CIT
      - Country-Specific Required Fields for Installment Payments with Mastercard or Visa Card
      - India-Specific Required Fields for Installment Payments
    - Simple Order Example: Authorizing Merchant-Initiated Subsequent Installment Payments
- Recurring Payments
  - Customer-Initiated Recurring Payment with PAN
    - Required Fields for Authorizing a Customer-Initiated Recurring Payment with PAN
    - Simple Order Example: Authorizing a Customer-Initiated Recurring Payment with a PAN
  - Merchant-Initiated Recurring Payments with PAN
    - Required Fields for Authorizing a Merchant-Initiated Recurring Payment
      - Card-Specific Required Fields for Authorizing Subsequent Recurring Payments
      - Country-Specific Required Fields for Authorizing Subsequent Recurring Payments
    - Simple Order Example: Authorizing a Merchant-Initiated Recurring Payment
- Mastercard Standing Order Payments
  - Mastercard Initial CIT Standing Order Payment
    - Required Fields for Authorizing Initial CIT Standing Order Payments
    - Simple Order Example: Authorizing Initial CIT Standing Order Payments
- Mastercard Subscription Payments
  - Mastercard CIT Initial Subscription Payment
    - Required Fields for Authorizing CIT Initial Subscription Payments
    - Simple Order Example: Authorizing Initial CIT Subscription Payments
- Unscheduled COF Payments
  - Customer-Initiated Unscheduled COF Payment with PAN
    - Required Fields for a Customer-Initiated Unscheduled COF Payment with PAN
    - Simple Order Example: Customer-Initiated Unscheduled COF Payment with PAN
  - Merchant-Initiated 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
    - Simple Order Example: Authorizing Subsequent MIT Unscheduled COF Payments

On This Page

Recent Revisions to This Document

25.02

Incremental Authorizations: Added an optional field. See Optional Field for Processing an Incremental Authorization.

25.01

Added a testing section. See Testing the Payment Services.

Marketplace Transactions with Foreign Retailers: Added authorizations and captures. See these sections:
Marketplace Authorizations with Foreign Retailers
Marketplace Captures with Foreign Retailers
Credentialed Transactions: Removed Mastercard required field for retrieving customer credentials during a CIT request. See Card-Specific Required Field for Retrieving Customer Credentials During a CIT.; Added new country-specific fields for requesting a subsequent installment payment. See Country-Specific Required Fields for Installment Payments with Mastercard or Visa Card.

24.14

This revision contains only editorial changes and no technical updates.

24.13

This revision contains only editorial changes and no technical updates.

24.12

This revision contains only editorial changes and no technical updates.

24.11

This revision contains only editorial changes and no technical updates.

24.10

This revision contains only editorial changes and no technical updates.

24.09

This revision contains only editorial changes and no technical updates.

24.08

This revision contains only editorial changes and no technical updates.

24.07

Pre-Authorizations: Added pre-authorization processing. See Pre-Authorizations.
Meeza Cards: Added Meeza as a supported card type for Visa Platform Connect.
Multiple Partial Captures: Updated the multiple partial capture required fields to include the
ccCaptureService_sequence
and
ccCaptureService_totalCount
fields for all countries.

24.06

Credit Authorizations on Follow-On Credits: Added credit authorization information to Follow-On Credits.
Credit Authorizations on Stand-Alone Credits: Added credit authorization information to Stand-Alone Credits.
Multiple Partial Captures: Updated how to set the
ccCaptureService_totalCount
field. See Multiple Partial Captures.

Back to top