API Overview

Payments Developer Guide
- Recent Revisions to This Document

Introduction to Payments
- Financial Institutions and Payment Networks
  - Merchant Financial Institutions (Acquirers)
  - Customer Financial Institutions (Issuers)
  - Payment Networks
  - Payment Processors
- Card Types
  - Credit Cards
  - Debit Cards
- Transaction Types
  - Card-Not-Present Transactions
  - Authorizations with Card Verification Numbers
    - CVN Locations and Terminology
  - International Transactions
    - Compliance
    - Merchant Remittance Funding
- Payment Services
  - Authorizations
    - Micropayment Authorizations
    - Online Authorizations
    - Offline Authorizations
    - Incremental Authorizations
      - Scenario for the Incremental Authorization Service
    - Pre-Authorizations
    - Authorization Workflow
  - Sales
    - Dual-Message Processing
      - Partial Authorizations
    - Single-Message Processing
  - Authorization Reversals
  - Captures
    - Capture Workflow
  - Credits
    - Credit Workflow
  - Voids
- Payment Features
  - Debit and Prepaid Card Payments
  - Payer Authentication
  - Relaxed Requirements for Address Data and Expiration Date in Payment Transactions
  - 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
- 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
  - 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
- Zero Amount Authorizations
  - Required Fields for Processing a Zero Amount Authorization
  - REST Example: Processing a Zero Amount Authorization
- Pre-Authorizations
  - Required Fields for a Pre-Authorization
  - REST Example: Processing a Pre-Authorization
- Authorization Reversal
  - Required Fields for Processing an Authorization Reversal
  - REST Example: Processing an Authorization Reversal
- Time-Out Authorization Reversals
  - Required Fields for Processing a Time-Out Authorization Reversal
  - REST Example: Processing a Time-Out Authorization Reversal
- Sales
  - Required Fields for Processing a Sale
  - REST 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
  - REST Example: Sales with Payment Network Tokens
- Captures
  - Required Fields for Capturing an Authorization
  - REST Example: Capturing an Authorization
- Refunds
  - Required Fields for Processing a Refund
  - REST Interactive Example: Processing a Refund
  - REST Example: Processing a Refund
- Voids for a Capture or Credit
  - Required Fields for Voiding a Capture or Credit
  - REST Example: Voiding a Capture or Credit
- Time-Out Voids for a Capture, Sale, Refund, or Credit
  - Required Fields for a Time-Out Void for a Capture, Sale, Refund, or Credit
  - REST Example: Time-Out Void for a Capture, Sale, Refund, or 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
  - 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

Payer Authentication Processing
- Additional Resources for Payer Authentication
- Providing Payer Authentication Information for Authorization
- 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

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
    - 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
- 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
    - 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
    - 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
    - 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 with TMS
- 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
    - 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
- Additional Resources for TMS
- 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

Dual-Message Processing

Dual-message processing is a two-step process. The authorization is processed first. If the authorization is successful, the capture is processed immediately afterward. The response includes the authorization and the capture information. If the authorization is declined, the capture is not processed, and the response message includes only the authorization information.