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
  - Token Management Service
- Payment Services
  - Authorizations
    - Micropayment Authorizations
    - Online Authorizations
    - Offline Authorizations
    - Incremental Authorizations
      - Scenario for the Incremental Authorization Service
    - 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
  - Debit and Prepaid Card Payments
  - Payer Authentication
  - Relaxed Requirements for Address Data and Expiration Date in Payment Transactions
  - Introduction to Credentialed Transactions

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
- 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
- Zero Amount Authorizations
  - Required Fields for Processing a Zero Amount Authorization
  - Simple Order Example: Processing a Zero Amount Authorization
- Pre-Authorizations
  - Required Fields for Processing a Pre-Authorization
  - Simple Order Example: Processing a Pre-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 Reversals
  - 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
- Captures
  - Required Fields for Capturing an Authorization
  - Simple Order Example: Capturing an Authorization
- 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
  - 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
- 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
- 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: Processing an Authorization Using Visa Secure

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
    - Simple Order Example: Storing Customer Credentials During a CIT
  - 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
    - 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
- Recurring Payments
  - Customer-Initiated Recurring Payment with PAN
    - Required Fields for Authorizing a Customer-Initiated Recurring Payment with PAN Using Simple Order API
    - 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 Authorizing Initial CIT Unscheduled COF Payments
    - Simple Order Example: Authorizing Initial CIT Unscheduled COF Payments
  - 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

On This Page

Merchant Financial Institutions (Acquirers)

A merchant financial institution, also known as an acquirer
, offers accounts to businesses that accept payment cards. Before you can accept payments, you must have a merchant account from an acquirer. Your merchant account must be configured to process card-not-present, card-present, or mail-order/telephone-order (MOTO) transactions.

If excessive chargebacks or fraudulant changes occur, these actions might be taken:

You might be required to change your business processes to reduce the number chargebacks, fraud, or both.

Your acquiring institution might increase your discount rate.

Your acquiring institution might revoke your merchant account.

Contact your sales representative for information about products that can help prevent fraud.

Back to top