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
  - Token Management Service
- 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
  - Automatic Partial 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
  - 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
- 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
- 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
- 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
- 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 for a Capture or Credit
  - Required Fields for Voiding a Capture or Credit
  - REST Example: Voiding a Capture 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

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

On This Page

Required Fields for Authorizing a Payment While Ignoring Network Token

clientReferenceInformation.code
paymentInformation.customer.id
paymentInformation.paymentInformation.id
paymentInformation.shippingAddress.id
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
processingInformation.capture
processingInformation.commerceIndicator
tokenInformation.networkTokenOption: Set value to
ignore
.

Related Information

API Field Reference for the REST API

Back to top