Recent Revisions to This Document

About This Guide

Introduction to Payments
- Financial Institutions and Payment Networks
  - Merchant Financial Institutions (Acquirers)
  - Issuing (Customer) Financial Institutions
  - Payment Networks
  - Payment Processors
- Card Types
  - Co-Badged Cards
  - Co-Branded Cards
  - Credit Cards
  - Debit Cards
  - Prepaid Cards
  - Private Label Cards
- Transaction Types
  - Card-Not-Present Transactions
  - Card-Present Transactions
  - Authorizations with Card Verification Numbers
    - CVN Locations and Terminology
    - International Transactions
      - Dynamic Currency Conversion
      - Merchant Remittance Funding
- Payment Services
  - Authorizations
    - payments-intro-processing-auth-micropayment
    - Online Authorizations
    - Offline Authorizations
    - Incremental Authorizations
      - Example: Incremental Authorization
    - Authorization Workflow
  - payments-intro-processing-reversal
  - Captures
    - Capture Workflow
  - Credits
    - Credit Workflow
  - Capture or Credit Voids
  - Sales
    - Dual Message Processing
      - Partial Authorizations
    - Single Message Processing
- Payment Features
  - Card-Present Authorizations
  - Debit and Prepaid Card Payments
  - Payer Authentication
  - Token Management Service

Standard Payments Processing
- Related Information
- 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
  - Supported Processors and Card Types
  - 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 the DCC Gateway Service
  - Required Fields for Processing DCC Authorizations
  - REST Example: Processing a DCC Authorization
- Zero Amount Authorizations
  - Required Fields for Processing a Zero Amount Authorization
  - REST Example: Processing a Zero Amount Authorization
- Capture
  - 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
- Credit
  - Required Fields for Processing a Credit
  - REST Interactive Example: Processing a Credit
  - REST Example: Processing a Credit
- Sales
  - Required Fields for Processing a Sale
  - REST Example: Processing a Sale
- Void
  - Required Fields for Processing a Void
  - REST Example: Processing a Void

Card Present Connect | Retail Processing
- Related Information
- Authorizations with Hand-Keyed Data
  - Required Fields for Processing an Authorization with Hand Keyed Data
  - REST Example: Processing an Authorization with Hand Keyed Data

Card Present Connect | Mass Transit Processing
- Related Information
- Discover Authorization with EMV Data
  - Example: Discover Authorization with EMV Data
- Mastercard Authorization with EMV Data
  - Example: Mastercard Authorization with EMV Data
- Visa Account Verification Request (AVR) with EMV Data
  - Example: Visa AVR Authorization with EMV Data
- Discover Sale with EMV Data
  - Example: Discover Sale with EMV Data
- Visa Deferred Sale with EMV Data
  - Example: Visa Deferred Sale with EMV Data
- Tap-Initiated Authorization for Debt Recovery with EMV Data
  - Example: Tap-Initiated Authorization for Debt Recovery with EMV Data
- Merchant-Initiated Authorizations for Debt Recovery with Stored Card Data
  - Example: Merchant-Initiated Authorization for Debt Recovery with Stored Card Data
- Tap-Initiated Sales for Debt Recovery with EMV Data
  - Example: Tap-Initiated Sale for Debt Recovery with EMV Data Using the REST API
- Merchant-Initiated Sales for Debt Recovery with Stored Card Data
  - Example: Merchant-Initiated Sale for Debt Recovery with Stored Card Data
- Stand-Alone Credits with Card Data
  - Example: Stand-Alone Credit with Card Data
- Capture an Authorization
  - Example: Capture a Authorization
- Authorization Reversals
  - Example: Reversing a Mass Transit Authorization
- Timeout Reversal
  - Example: Timeout Reversal
- Timeout Void
  - Example: Timeout Void

Debit and Prepaid Card Processing
- Related Information
- Processing Debit and Prepaid Authorizations
  - Required Fields for Processing Debit and Prepaid Authorizations
    - payments-debit-prepaid-auth-required-country
  - 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
- Related Information
- Providing Payer Authentication Information for Authorization

Processing Payments Using Credentials
- Related Information
- Customer-Initiated Transactions with Credentials on File
  - Storing Customer Credentials with a CIT
    - Required Fields for Storing Customer Credentials During a CIT
    - REST 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
    - REST Example: Retrieving Customer Credentials During a CIT

Token Management Service Processing
- Related Information
- Authorize 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
- Authorize 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
- Authorize a Payment with Non-Default Payment Instrument
  - Required Fields for Authorizing a Payment with Non-Default Payment Instrument
  - Optional Fields for Authorizing a Payment with Non-Default Payment Instrument
  - REST Example: Authorizing a Payment with Non-Default Payment Instrument
- Authorize 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 Interactive Example: Authorizing a Payment with an Instrument Identifier
- Authorize a Payment with Legacy Token
  - Required Fields for Authorizing a Payment with Legacy Token
  - REST Example: Authorizing a Payment with Legacy Token
  - REST Interactive Example: Authorizing a Payment with a Legacy Token
- Make 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
- Make a Credit with Non-Default Payment Instrument
  - Required Fields for Making a Credit with Non-Default Payment Instrument
  - Optional Fields for Making a Credit with Non-Default Payment Instrument
  - REST Example: Making a Credit with Non-Default Payment Instrument
- Make 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
- Make 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
  - REST Interactive Example: Making a Credit with an Instrument Identifier
- Make a Credit with Legacy Token
  - Required Fields for Making a Credit with Legacy Token
  - REST Example: Making a Credit with Legacy Token

On This Page

REST API | null

Required Fields for Making a Credit with an Instrument Identifier

orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.billTo.address1
orderInformation.billTo.administrativeArea
orderInformation.billTo.country
orderInformation.billTo.email
orderInformation.billTo.firstName
orderInformation.billTo.lastName
orderInformation.billTo.locality
orderInformation.billTo.postalCode
paymentInformation.card.expirationMonth
paymentInformation.card.expirationYear
paymentInformation.card.number
paymentInformation.card.type
paymentInformation.paymentInstrument.id: Set to the ID of the payment instrument token you want to use.

Related Information

API Field Reference for the REST API

Back to top