API Overview

Payments Developer Guide
- Recent Revisions to This Document

Introduction to Payments
- Financial Institutions and Payment Networks
- Card Types
- Transaction Types
- Payment Services
- Payment Features

Standard Payment Processing
- Basic Authorizations
- Authorizations with Line Items
- Authorizations with Payment Network Tokens
- Zero Amount Authorizations
- Pre-Authorizations
- Authorization Reversals
- Timeout Authorization Reversals
- Sales
- Captures
- Refunds
- Voids
- Timeout Voids for a Capture, Sale, Refund, or Credit

Debit and Prepaid Card Processing
- Additional Resources for Debit and Prepaid Payments
- Processing Debit and Prepaid Authorizations
- Enabling Debit and Prepaid Partial Authorizations
- Disabling Debit and Prepaid Partial Authorizations

Payer Authentication Processing
- Additional Resources for Payer Authentication
- Providing Payer Authentication Information for Authorization
- Mastercard Identity Check
- Visa Secure

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
- Delayed Transaction
- No-Show Transactions
- Reauthorization Transaction
- Resubmission Transaction
- Installment Payments
- Recurring Payments
- Mastercard Standing Order Payments
- Mastercard Subscription Payments
- Unscheduled COF Payments

Token Management Service Processing
- Additional Resources for TMS
- Authorizing a Payment with a Customer Token
- Authorizing a Payment with a Non-Default Shipping Address
- Authorizing a Payment with a Non-Default Payment Instrument
- Authorizing a Payment with a Payment Instrument
- Authorize a Payment with an Instrument Identifier
- Authorize a Payment While Ignoring Network Token
- Authorizing a Payment with a Legacy Token
- Making a Credit with a Customer Token
- Making a Credit with a Non-Default Payment Instrument
- Making a Credit with a Payment Instrument
- Making a Credit with an Instrument Identifier
- Making a Credit with a Legacy Token

Required Fields for Authorizing a Merchant-Initiated Recurring Payment

Use these required fields to authorize subsequent recurring payments.

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.phoneNumber
orderInformation.billTo.postalCode
paymentInformation.card.expirationMonth
paymentInformation.card.expirationYear
paymentInformation. card. number
processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. previousTransactionID: For Discover and American Express cards, use the transaction ID from the original transaction. For Visa, use the last successful transaction ID.
processingInformation. authorizationOptions. initiator. storedCredentialUsed: Set to
true
.
processingInformation. authorizationOptions. initiator. type: Set to
merchant
.
processingInformation. commerceIndicator: Set to
recurring
.

Card-Specific Required Fields for Authorizing Subsequent Recurring Payments

Some card companies require additional information when making authorizations with stored credentials.

Discover

Include the authorization amount from the original transaction in this field:

processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction. originalAuthorizedAmount

Mastercard

Mastercard supports subscription and standing order payments instead of recurring payments.

See Mastercard Subscription Payments and Mastercard Standing Order Payments.