API Overview

Payments Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Payments
- Financial Institutions and Payment Networks
- Card Types
- Transaction Types
- Payment Services
  - Authorization
    - Online Authorization
    - Offline Authorization
    - Incremental Authorization
      - Scenario for an Incremental Authorization
    - Pre-Authorization
    - Payment Network Token Authorization
    - Authorization Workflow
  - Sale
    - Dual-Message Processing
      - Partial Authorizations
    - Single-Message Processing
  - Authorization Reversal
  - Automatic Partial Authorization Reversal
  - Capture
    - Capture Workflow
  - Refund
    - Credit Workflow
  - Void
- Payment Features
  - Debit and Prepaid Card Payments
  - Airline Data
    - Cybersource Airline Data Processing
    - Airline Data Reference Information
      - Airline Document Type Codes
      - Ancillary Service Category Codes
  - Interchange Optimization
  - Japanese Payment Options
  - Level II and Level III Data
  - Micropayments
  - Mastercard Bill Payments
  - Mastercard Expert Monitoring Solutions
  - Payer Authentication
  - Relaxed Requirements for Address Data and Expiration Date in Payment Transactions
  - Split Shipment
  - Introduction to Credentialed Transactions
  - Token Management Service
- Testing the Payment Services
  - Requirements for Testing
  - Test Card Numbers
  - Using Amounts to Simulate Errors
  - Test American Express Card Verification

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

Airline Data Processing
- Additional Resources for Airline Data
- Airline Travel Legs
- Authorize an Airline Ticket Payment
- Captures for Ticket Purchases
- Captures for Ancillary Purchases
- Refunds
- Issue a Credit

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

Level II Processing
- Additional Resources for Level II/III Payments
- Captures with Level II Data
- Credits with Level II Data
- Sales with Level II Data

Level III Processing
- Additional Resources for Level II/III Payments
- Captures with Level III Data
- Credits with Level III Data
- Sales with Level III Data

Mastercard Processing
- Mastercard Bill Payment Processing
- Mastercard Expert Monitoring Solutions Processing

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

Relaxed Requirements for Address Data and Expiration Date in Payment Transactions

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
- Additional Resources for Credentialed Transactions
- Customer-Initiated Transactions with Credentials on File
  - Storing Customer Credentials with a CIT and PAN
  - Storing Customer Credentials with a CIT and TMS
  - Using Stored Customer Credentials During a CIT
- Delayed Transaction
  - Merchant-Initiated Delayed Transaction with PAN
  - Merchant-Initiated Delayed Transaction with TMS
- Incremental Transaction
  - Merchant-Initiated Incremental Transaction with PAN
  - Merchant-Initiated Incremental Transaction with TMS
- No-Show Transactions
  - Merchant-Initiated No-Show Transactions with PAN
  - Merchant-Initiated No-Show Transaction with TMS
- Reauthorization Transaction
  - Merchant-Initiated Reauthorization Transactions with PAN
  - Merchant-Initiated Reauthorization Transactions with TMS
- Resubmission Transaction
  - Merchant-Initiated Resubmission Transaction with PAN
  - Merchant-Initiated Resubmission Transaction with TMS
- Installment Payments
  - Customer-Initiated Installment Payments with PAN
  - Customer-Initiated Installment Payment with TMS
  - Customer-Initiated Installment Payment with Enrollable Network Tokens
  - Merchant-Initiated Installment Payments with PAN
  - Merchant-Initiated Installment Payment with TMS
- Recurring Payments
  - Customer-Initiated Recurring Payment with PAN
  - Customer-Initiated Recurring Payment with TMS
  - Customer-Initiated Recurring Payment with Enrollable Network Tokens
  - Merchant-Initiated Recurring Payments with PAN
  - Merchant-Initiated Recurring Payments with TMS
- Mastercard Standing Order Payments
  - Mastercard Initial CIT Standing Order Payment
  - Mastercard Initial CIT Standing Order Payment with TMS
- Mastercard Subscription Payments
  - Mastercard CIT Initial Subscription Payment
  - Mastercard CIT Initial Subscription Payment with TMS
- Unscheduled COF Payments
  - Customer-Initiated Unscheduled COF Payment with PAN
  - Customer-Initiated Unscheduled COF Payments with TMS
  - Customer-Initiated Unscheduled COF Payment with Enrollable Network Tokens
  - Merchant-Initiated Unscheduled COF Payment with PAN
  - Merchant-Initiated Unscheduled COF Payments with TMS

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

On This Page

Capture

This section describes how to capture an authorized transaction.

All supported card types can process captures.

Endpoint

Production:

POST https://api.cybersource.com/pts/v2/payments/{id}
/captures

Test:

POST https://apitest.cybersource.com/pts/v2/payments/{id}
/captures

The

{id}

is the transaction ID returned in the authorization response.

Required Fields for Capturing an Authorization

clientReferenceInformation.code: This field value maps from the original authorization, sale, or credit transaction.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount

REST Example: Capturing an Authorization

Request

{
    "clientReferenceInformation": {
        "code": "ABC123"
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "EUR"
    }
}

Response to a Successful Request

{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/captures/6662994431376681303954/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/captures/6662994431376681303954"
        }
    },
    "clientReferenceInformation": {
        "code": "1666299443215"
    },
    "id": "6662994431376681303954",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "EUR"
        }
    },
    "reconciliationId": "66535942B9CGT52U",
    "status": "PENDING",
    "submitTimeUtc": "2022-10-20T20:57:23Z"
}

Back to top