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
- Testing the Payment Services

Standard Payment Processing
- Basic Authorizations
- Authorizations with Line Items
- Authorizations with Payment Network Tokens
- Authorizations with a Card Verification Number
- Zero Amount Authorizations
- Pre-Authorizations
- Authorization Reversals
- Sales
- Captures
- Multiple Partial Captures
- Forced Captures
- Refunds
- Credits
- Voids

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

Japanese Payment Options Processing
- Authorize a Single Payment with Japanese Payment Options
- Authorize a Bonus Payment with Japanese Payment Options
- Authorize an Installment Payment with Japanese Payment Options
- Authorize a Revolving Payment with Japanese Payment Options
- Authorize a Combination Payment with Japanese Payment Options

Payer Authentication Processing
- Additional Resources for Payer Authentication
- Providing Payer Authentication Information for Authorization
- American Express SafeKey
- JCB J/Secure
- Mastercard Identity Check
- Visa Secure

Processing Payments Using Credentials
- Additional Resources for Credentialed Transactions
- Customer-Initiated Transactions with Credentials on File

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

REST Example: Processing Multiple Partial Captures

Request

12345678910111213141516
{{
  "clientReferenceInformation": {
    "code": "TC50171_3"
  },
  "processingInformation": {
    "captureOptions": {
      "captureSequenceNumber": "2",
      "totalCaptureCount": "3"
    }
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "102.21",
      "currency": "USD"
    }
  }}

Response to a Successful Request

1234567891011121314151617181920212223
{"_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/captures/6742496815656503003954/voids"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/captures/6742496815656503003954"
    }
  },
  "clientReferenceInformation": {
    "code": "TC50171_3"
  },
  "id": "6742496815656503003954",
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "102.21",
      "currency": "USD"
    }
  },
  "reconciliationId": "67332020GD2G1OO1",
  "status": "PENDING",
  "submitTimeUtc": "2023-01-20T21:21:21Z"}