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-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
  - 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
  - Captures
    - Capture Workflow
  - Credits
    - Credit Workflow
  - Voids
- Payment Features
  - Card-Present Authorizations
  - Debit and Prepaid Card Payments
  - Airline Data
    - Visa Acceptance Solutions 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
  - Relaxed Requirements for Address Data and Expiration Date in Payment Transactions
  - Split Shipments
  - Introduction to Credentialed Transactions
  - Token Management Service
- Testing the Payment Services
  - Requirements for Testing
  - Test Card Numbers
  - Using Amounts to Simulate Errors
  - Test American Express Card Verification

Standard Payment Processing
- Additional Resources for Processing Payments
- Basic Authorizations
  - Declined Authorizations
  - 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 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 Authorizations
- Pre-Authorizations
  - Required Fields for a Pre-Authorization
    - Country-Specific Required Fields for Processing a Pre-Authorization
  - REST Example: Processing a Pre-Authorization
- Incremental Authorizations
  - Required Fields for Processing an Incremental Authorization
    - Country-Specific Required Fields 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 Reversals
  - Required Fields for Processing an Authorization Reversal
  - REST Example: Processing an Authorization Reversal
- Timeout Authorization Reversals
  - Required Fields for Processing a Timeout Authorization Reversal
  - REST Example: Processing a Timeout Authorization Reversal
- Sales
  - Required Fields for Processing a Sale
  - REST Example: Processing a Sale
- Captures
  - 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
- Credits
  - Required Fields for Processing a Credit
  - REST Interactive Example: Processing a Credit
  - REST Example: Processing a Credit
- Voids
  - Required Fields for Processing a Void
  - REST Example: Processing a Void
- Timeout Voids for a Capture, Sale, Refund, or Credit
  - Required Fields for Processing a Timeout Void for a Capture, Sale, Refund, or Credit
  - REST Example: Processing a Timeout Void for a Capture, Sale, Refund, or Credit

Card Present Connect | Retail Processing
- Authorization with Contact EMV and Online PIN
  - Required Fields for Processing an Authorization with Contact EMV and Online PIN
  - REST Example: Processing an Authorization with Contact EMV and Online PIN
- Authorization with Contact EMV and Offline PIN
  - Required Fields for Processing an Authorization with Contact EMV and Offline PIN
  - REST Example: Processing an Authorization with Contact 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
- Captures
  - Required Fields for Capturing an Authorization
  - Capturing an Authorization Using REST APIs
  - REST Example: Capturing an Authorization

Card Present Connect | Mass Transit Processing
- American Express Account Status Check Authorization with EMV Data
  - Required Fields for a American Express Account Status Check AVR Authorization with EMV Data Using the REST API
  - REST Example: American Express Account Status Check Authorization with EMV Data
- American Express Delayed Online Authorization with EMV Data
  - Required Fields for a American Express Delayed Online Authorization with EMV Data Using the REST API
  - REST Example: American Express Delayed Online Authorization with EMV Data
- Discover Authorization with EMV Data
  - Required Fields for a Discover Authorization with EMV Data Using the REST API
  - REST Example: Discover Authorization with EMV Data
- Mastercard Authorization with EMV Data
  - Required Fields for a Mastercard Authorization with EMV Data Using the REST API
  - REST Example: Mastercard Authorization with EMV Data
- Visa Account Verification Request (AVR) with EMV Data
  - Required Fields for a Visa AVR Authorization with EMV Data Using the REST API
  - REST Example: Visa AVR Authorization with EMV Data
- Discover Sale with EMV Data
  - Required Fields for a Discover Sale with EMV Data Using the REST API
  - REST Example: Discover Sale with EMV Data
- Visa Deferred Sale with EMV Data
  - Required Fields for a Visa Deferred Sale with EMV Data Using the REST API
  - REST Example: Visa Deferred Sale with EMV Data
- Tap-Initiated Authorization for Debt Recovery with EMV Data
  - Required Fields for a Tap-Initiated Authorization for Debt Recovery with EMV Data Using the REST API
  - REST Example: Tap-Initiated Authorization for Debt Recovery with EMV Data
- Merchant-Initiated Authorizations for Debt Recovery with Stored Card Data
  - Required Fields for a Merchant-Initiated Authorization for Debt Recovery with Stored Card Data Using the REST API
  - REST Example: Merchant-Initiated Authorization for Debt Recovery with Stored Card Data
- Tap-Initiated Sale for Mastercard Debt Recovery with EMV Data
  - Required Fields for a Tap-Initiated Sale for Mastercard Debt Recovery with EMV Data Using the REST API
  - REST Example: Tap-Initiated Sale for Mastercard Debt Recovery with EMV Data
- Tap-Initiated Sale for Visa Debt Recovery with EMV Data
  - Required Fields for a Tap-Initiated Sale for Visa Debt Recovery with EMV Data Using the REST API
  - REST Example: Tap-Initiated Sale for Visa Debt Recovery with EMV Data
- Merchant-Initiated Sale for Debt Recovery with Stored Card Data
  - Required Fields for a Merchant-Initiated Sale for Debt Recovery with Stored Card Data Using the REST API
  - REST Example: Merchant-Initiated Sale for Debt Recovery with Stored Card Data
- Credit with a Token
  - Required Fields for a Credit with a Token Using the REST API
  - REST Example: Credit with a Token
- Capture an Authorization
  - Required Fields for a Mass Transit Capture
  - REST Example: Capture an Authorization
- Authorization Reversal
  - Required Fields for a Mass Transit Authorization Reversal
  - REST Example: Reversing a Mass Transit Authorization
- Timeout Reversal
  - Required Fields for a Timeout Reversal
  - REST Example: Timeout Reversal
- Timeout Void
  - Required Field for a Timeout Void
  - REST Example: Timeout Void

Debit and Prepaid Card Processing
- 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
- Airline Travel Legs
- Authorizations
  - Required Fields for Authorizing an Airline Payment
  - REST 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
  - REST 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
  - REST Example: Capturing an Authorization for an Ancillary Purchase
- Refunds
  - Required Fields for Processing an Airline Refund
  - Optional Fields for Processing an Airline Refund
  - REST Example: Processing an Airline Refund
- 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
- 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
- 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
- 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: Validating and Authorizing a Transaction

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
- 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 Customer Credentials with a CIT and TMS
    - REST Example: Storing Customer Credentials with a CIT and TMS
  - 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
    - REST 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
    - REST Example: Processing a Merchant-Initiated Delayed Authorization Transaction
  - Merchant-Initiated 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
- 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
    - REST Example: Processing Merchant-Initiated Incremental Transactions
  - Merchant-Initiated 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
- 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
    - REST Example: Processing Merchant-Initiated No-Show Transactions
  - Merchant-Initiated 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
- 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
    - REST Example: Processing a Merchant-Initiated Reauthorized Transaction
  - Merchant-Initiated 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
- 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
    - REST Example: Processing a Merchant-Initiated Resubmitted Transaction
  - Merchant-Initiated Resubmission Transaction with TMS
    - Required Fields for MIT Resubmission Transaction with TMS
    - Example: MIT Resubmission Transaction with a TMS Instrument Identifier
    - Example: MIT Resubmission Transaction with a TMS Payment Instrument
    - Example: MIT Reauthorization Transaction with a TMS Customer
- Installment Payments
  - Customer-Initiated 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
  - Customer-Initiated Installment Payment with TMS
    - Required Fields for CIT Installment Payments with TMS
    - REST Example: CIT Installment Payment with TMS
  - Customer-Initiated Installment Payment with Enrollable Network Tokens
    - Required Fields for a CIT Installment Payment with Enrollable Network Tokens
    - Example: CIT Installment Payments with Enrollable Network Tokens
  - 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
    - REST Example: Authorizing Merchant-Initiated Subsequent Installment Payments
  - Merchant-Initiated Installment Payment with TMS
    - Required Fields for MIT Installment Payments with TMS
      - 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
    - Example: MIT with TMS Instrument Identifier Token
- Recurring Payments
  - Customer-Initiated Recurring Payment with PAN
    - Required Fields for Authorizing a Customer-Initiated Recurring Payment with PAN
    - REST Example: Authorizing a Customer-Initiated Recurring Payment with a PAN
  - Customer-Initiated Recurring Payment with TMS
    - Required Fields for Authorizing a Customer-Initiated Recurring Payment with TMS
    - REST Example: Authorizing a Customer-Initiated Recurring Payment with TMS
  - Customer-Initiated Recurring Payment with Enrollable Network Tokens
    - Required Fields for Authorizing a Customer-Initiated Recurring Payments with Enrollable Network Tokens
    - REST Example: Authorizing a Customer-Initiated Recurring Payment with Enrollable Network Tokens
  - 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
    - REST Example: Authorizing a Merchant-Initiated Recurring Payment
  - Merchant-Initiated Recurring Payments with TMS
    - Required Fields for Authorizing a Merchant-Initiated Recurring Payments with TMS
    - REST Example: Authorizing a Merchant-Initiated Recurring Payment with a TMS Instrument Identifier
    - REST Example: Authorizing a Merchant-Initiated Recurring Payment with TMS Payment Instrument
    - REST Example: Authorizing a Merchant-Initiated 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 Initial CIT Standing Order Payment with TMS
    - Required Fields for Authorizing Initial CIT Standing Order Payments with TMS
    - REST Example: Authorizing Initial CIT Standing Order Payments with TMS
- Mastercard Subscription Payments
  - Mastercard CIT Initial Subscription Payment
    - Required Fields for Authorizing CIT Initial Subscription Payments
    - REST Example: Authorizing Initial CIT Subscription Payments
  - Mastercard CIT Initial Subscription Payment with TMS
    - Required Fields for Authorizing CIT Initial Subscription Payments with TMS
    - REST 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
    - REST Example: Customer-Initiated Unscheduled COF Payment with PAN
  - Customer-Initiated Unscheduled COF Payments with TMS
    - Required Fields for CIT Unscheduled COF Payments with TMS
    - REST Example: Initial CIT Unscheduled COF Payment in TMS
  - Customer-Initiated Unscheduled COF Payment with Enrollable Network Tokens
    - Required Fields for CIT Unscheduled COF Payment with Enrollable Network Tokens
    - REST API Example: CIT Unscheduled COF Payment with Enrollable Network Tokens
  - 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
    - REST Example: Authorizing Subsequent MIT Unscheduled COF Payments
  - Merchant-Initiated 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

Token Management Service Processing
- Authorizing 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
- Authorizing 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
- Authorizing a Payment with a Non-Default Payment Instrument
  - Required Fields for Authorizing a Payment with a Non-Default Payment Instrument
  - Optional Fields for Authorizing a Payment with a Non-Default Payment Instrument
  - REST Example: Authorizing a Payment with a Non-Default Payment Instrument
- Authorizing 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 Example: Authorizing a Payment with an Instrument Identifier While Creating TMS Tokens
- Authorize a Payment While Ignoring Network Token
  - Required Fields for Authorizing a Payment While Ignoring Network Token
  - REST Example: Authorizing a Payment While Ignoring Network Token
- Authorizing a Payment with a Legacy Token
  - Required Fields for Authorizing a Payment with a Legacy Token
  - REST Example: Authorizing a Payment with a Legacy Token
- Making 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
- Making a Credit with a Non-Default Payment Instrument
  - Required Fields for Making a Credit with a Non-Default Payment Instrument
  - Optional Fields for Making a Credit with a Non-Default Payment Instrument
  - REST Example: Making a Credit with a Non-Default Payment Instrument
- Making 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
- Making 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
- Making a Credit with a Legacy Token
  - Required Fields for Making a Credit with a Legacy Token
  - REST Example: Making a Credit with a Legacy Token

On This Page

Captures

This section provides the information you need in order to capture an authorized transaction.

Supported Card Types

All supported card types can process captures. .

Endpoint

Production:

POST https://api.visaacceptance.com/pts/v2/payments/{id}
/captures

Test:

POST https://apitest.visaacceptance.com/pts/v2/payments/{id}
/captures

The

{id}

is the transaction ID returned in the authorization response.

Required Fields for Capturing an Authorization

Use these required fields for capturing an authorization.

clientReferenceInformation.code: This field value maps from the original authorization, sale, or credit transaction.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount

REST Example: Capturing an Authorization

Request

{
    "clientReferenceInformation": {
        "code": "ABC123"
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "EUR"
    }
}

Response to a Successful Request

{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/captures/6662994431376681303954/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/captures/6662994431376681303954"
        }
    },
    "clientReferenceInformation": {
        "code": "1666299443215"
    },
    "id": "6662994431376681303954",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "EUR"
        }
    },
    "reconciliationId": "66535942B9CGT52U",
    "status": "PENDING",
    "submitTimeUtc": "2022-10-20T20:57:23Z"
}

Back to top