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
- 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
  - Simple Order Example: Processing a Basic Authorization
- Authorizations with Line Items
  - Optional Line Item Fields
  - 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
- Zero Amount Authorizations
  - Required Fields for Processing a Zero Amount Authorization
  - Simple Order Example: Processing a Zero Amount Authorization
- Pre-Authorizations
  - Required Fields for a Pre-Authorization
  - Simple Order Example: Processing a Pre-Authorization
- Authorization Reversal
  - Required Fields for Processing an Authorization Reversal
  - Simple Order Example: Processing an Authorization Reversal
- Time-Out Authorization Reversals
  - Required Fields for Processing a Time-Out 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
- Follow-On Credits
  - Required Fields for Processing a Follow-On Credit
  - Simple Order Example: Processing a Follow-On Credit
- Voids for a Capture or Credit
  - Required Fields for Voiding a Capture or Credit
  - Simple Order API Example: Voiding a Capture or Credit
- Time-Out Voids for a Capture, Sale, Follow-On Credit, or Stand-Alone Credit
  - Required Fields for a Time-Out Void for a Capture, Sale, Follow-On Credit, or Stand-Alone Credit
  - Simple Order Example: Time-Out 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
  - 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

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
  - 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

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
- 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
    - 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
    - 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
    - Simple Order Example: Authorizing Subsequent MIT Unscheduled COF Payments

Optional Field for Enabling Debit and Prepaid Partial Authorizations

You can use these optional fields to include additional information when enabling debit and prepaid partial authorizations.

linkToRequest: Set this field to the request ID that was returned in the response message from the original authorization request.

Related Information

API field reference guide for the Simple Order API