On This Page

Card Present Connect | Retail Integration Guide

This section describes how to use this guide and where to find further information.

Audience and Purpose

This guide is written for merchants who want to process card-present retail payments through
Cybersource
 and provides information about the
REST API
 guide for
China UnionPay
. For information about additional requirements and options for card-present transactions, see the
Payments Developer Guide
 in the Technical Documentation Portal.

Conventions

The following special statement is used in this document:
IMPORTANT
An
Important
 statement contains information essential to successfully completing a task or learning a concept.

Customer Support

For support information about any service, visit the Support Center:

Pilot Release

This document provides information about the pilot release of Card Present Connect | Retail for
China UnionPay
.

Recent Revisions to This Document

26.10.01

Initial release for
China UnionPay
.

Introduction to Card Present Connect | Retail

Card Present Connect | Retail is part of a unified commerce solution for payment technology providers. This solution supports card-present transactions at the point of sale (POS) and on mobile POS (mPOS) devices. The solution also enables you to integrate with multiple processors and acquirers.
Card Present Connect payment management platform uses end-to-end encryption to enable secure and innovative payment solutions. Retail integration and value-added services are available through a single integration on the platform.
China UnionPay
 uses a different set of terms for standard industry payment services. For example, the
CUP
 term for an authorization is a pre-authorization. For more information, see Supported Transaction Types and Integrations. Also see the individual payment services discussed in Card-Present Retail Payment Services.

Enabling the Card Present Connect Platform

Before you can use the Card Present Connect platform, you must enable it.
Follow these steps to enable the Card Present Connect platform:
  1. Set up a
    Cybersource
     merchant account. To get started, contact your sales engineer, alliance partner, or technical account manager.
  2. Integrate the
    Cybersource
     APIs for use on the Card Present Connect platform.
  3. Integrate your terminal’s key management encryption and decryption with the Card Present Connect platform.
  4. Complete message-level validation (MLV) and Level 3 (L3) device certification. To get started, contact your sales engineer, alliance partner, or technical account manager.

Card-Present Transaction Risk Control Requirements

Card-present transactions carry lower risk than card-not-present transactions because the customer and payment card are physically present, which can result in lower transaction fees. However, acquirers must still apply standard risk-control measures. Acquirers must monitor transaction activity and manage fraud and disputes in accordance with payment network rules, including the Global Acquirer Risk Standards. They also must comply with these Visa risk compliance programs:
  • Visa Fraud Monitoring Program
  • Visa Dispute Monitoring Program
To meet risk control requirements, acquirers can use one of these options:
  • Enable
    Cybersource
     transaction and fraud monitoring tools.
  • Ensure that their payment technology partners (PTPs) implement transaction and fraud monitoring tools.
  • Deploy their own transaction and fraud monitoring tools.
Each option provides necessary fraud and risk controls for direct merchant relationships and for PTPs that do not operate their own monitoring solutions.
For more information, see Fraud and Risk Management Solutions.

Supported Transaction Types and Integrations

The table lists card-present retail transaction types and integrations supported by
China UnionPay
. The standard industry term for each transaction type is listed with the corresponding
China UnionPay
 term.
These device types are supported:
  • Point-of-sale (POS) devices
  • Cardholder-activated terminals (CATs)/unattended terminals
  • Mobile point-of-sale (mPOS) devices
  • Software point-of-sale (SoftPOS) devices, contactless only
The values listed in the Comments Field Value column of the table are entered in the
clientReferenceInformation.comments
 REST API field of transaction requests.
For information about required EMV tags, see Required EMV Tags.
Supported Transaction Types and Integrations for
China UnionPay
Transaction Type |
China UnionPay
 Term
Comments Field Value
Entry Mode
PIN Capability
Device Type
Authorization
Auth
  • Contact
  • Contactless
  • Swiped
  • Keyed
  • Online PIN: Contact, Contactless, Swiped, Keyed
  • PINless: Contactless, Keyed
  • POS
  • CAT
  • mPOS
  • SoftPOS: Contactless only
China UnionPay
 term:
Pre-Authorization
Sale
Sale
  • Contact
  • Contactless
  • Swiped
  • Keyed
  • Online PIN: Contact, Contactless, Swiped, Keyed
  • PINless: Contactless, Keyed
  • POS
  • CAT
  • mPOS
  • SoftPOS: Contactless only
China UnionPay
 term:
Purchase
Capture
Capture
  • Contact
  • Contactless
  • Swiped
  • Keyed
  • Online PIN: Contact, Contactless, Swiped, Keyed
  • PINless: Contactless, Keyed
  • POS
  • CAT
  • mPOS
  • SoftPOS: Contactless only
China UnionPay
 term:
Pre-Authorization Completion
Refund
Refund
  • Contact
  • Contactless
  • Swiped
  • Keyed
  • Does not apply.
  • POS
  • CAT
  • mPOS
  • SoftPOS: Contactless only
China UnionPay
 term:
Refund - Matched
Stand-Alone Credit
Stand-alone Credit
  • Contact
  • Contactless
  • Swiped
  • Keyed
  • Does not apply.
  • POS
  • CAT
  • mPOS
  • SoftPOS: Contactless only
China UnionPay
 term:
Refund - Un-matched
Authorization Reversal
Auth Reversal
  • Contact
  • Contactless
  • Swiped
  • Keyed
  • Online PIN: Contact, Contactless, Swiped, Keyed
  • PINless: Contactless, Keyed
  • POS
  • mPOS
  • SoftPOS: Contactless only
China UnionPay
 term:
Pre-Authorization Cancellation
Time-Out Authorization Reversal
Time-out Auth Reversal
  • Does not apply.
  • Does not apply.
  • Does not apply.
China UnionPay
 term:
Reversal of a Pre-Authorization
Void Sale
Sale Void
  • Contact
  • Contactless
  • Swiped
  • Keyed
  • Online PIN: Contact, Contactless, Swiped, Keyed
  • PINless: Contactless, Keyed
  • POS
  • mPOS
  • SoftPOS: Contactless only
China UnionPay
 term:
Purchase Cancellation
Void Capture
Capture Void
  • Contact
  • Contactless
  • Swiped
  • Keyed
  • Online PIN: Contact, Contactless, Swiped, Keyed
  • PINless: Contactless, Keyed
  • POS
  • mPOS
  • SoftPOS: Contactless only
China UnionPay
 term:
Pre-Authorization Completion Cancellation
Time-Out Void Sale
Sale Time-out Void
  • Does not apply.
  • Does not apply.
  • Does not apply.
China UnionPay
 term:
Reversal of a Purchase
Time-Out Void Capture
Capture Time-out Void
  • Does not apply.
  • Does not apply.
  • Does not apply.
China UnionPay
 term:
Reversal of a Pre-Authorization Completion

Card-Present Retail Payment Services

This section describes various card-present retail payment services for
China UnionPay
 and how to use them.

Required EMV Tags

The EMV tags listed in the table are required for
China UnionPay
 requests that include the
pointOfSaleInformation.emv.tags
 REST API field.
These are the values in the Attributes column of the table:
  • b
    : Binary (binary number or bit combination)
  • cn
    : Binary Coded Decimal
  • an
    : Alphanumeric data elements (each byte can be A-Z, a-z, or 0-9)
EMV Tags
Tag ID
Tag Name
Tag Length (Characters)
Attribute
9F26
Application Cryptogram (AC)
8
b
9F27
Cryptogram Information Data
1
b
9F10
Issuer Application Data (IAD)
Maximum 32
b
9F37
Unpredictable Number
4
b
9F36
Application Transaction Counter (ATC)
2
b
95
Terminal Verification Result (TVR)
5
b
9A
Transaction Date
3
cn
 (including a 6-digit valid number, format YYMMDD)
9C
Transaction Type
1
cn
 (including a 2-digit valid number)
9F02
Transaction Amount or Amount Authorized
6
cn
 (including a 12-digit valid number)
5F2A
Transaction Currency Code
2
cn
 (including a 3-digit valid number)
82
Application Interchange Profile
2
b
9F1A
Terminal Country Code
2
cn
 (including a 3-digit valid number)
9F03
Amount Other
6
cn
 (including a 12-digit valid number)
9F33
Terminal Capabilities
3
b
9F34
Cardholder Verification Method Result (CVMR)
3
b
9F35
Terminal Type
1
cn
 (a 2-digit valid number)
9F1E
Interface Device Serial Number (IFD)
8
an
84
Dedicated File Name (DF)
5~16
b
9F09
Terminal Application Version Number
2
b
9F41
Transaction Sequence Counter
2~4
cn
 (including a 4-digit to 8-digit valid number)
91
Issuer Authentication Data
8~16
b
71
Issuer Script Template 1
1~128
b
72
Issuer Script Template 2
1~128
b
DF31
Issuer Script Results
5~21
b
9F74
Issuer Authorization Code – Electronic Cash (ECIAC)
6
an
9F63
Card Product Identification Information
16
b
For the Transaction Amount or Amount Authorized tag (
9F02
), the value in Field 55 records the transaction amount transmitted from the terminal to the ICC/chip card. This value might be the same as, or different from, the value in Field 4, which indicates the actual transaction amount charged to the cardholder.
When QR code (QRC) data contains chip information, the acquirer must submit chip information in Field 55 with the same transmission requirements.

Authorization

Use this information to process an authorization. An authorization verifies that funds are available and reserves them for a subsequent capture.
The
China UnionPay
 term for an authorization is
pre-authorization
.
For more information about transaction types, see Supported Transaction Types and Integrations. Also see Required EMV Tags.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments

Required Fields for an Authorization

Set the value to
Auth
.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
Set the value to
062
.
Set the value to
1
 or
2
 for unattended devices,
5
 for SoftPOS, or
6
 for mPOS.
A value is required when EMV tag 5F34 is configured on the ICC/chip card.
A value is required for fallback scenarios.
A value is required for fallback scenarios in swiped or keyed transactions. Set the value to
1
 or
2
.
A value is required for full EMV on contact and contactless entry modes.
A value is required for PIN transactions using DUKPT for encryption.
A value is required for PIN transactions.
Set the value to
contact
,
contactless
,
swiped
, or
keyed
.
Set the value to
0
 or
1
 for PIN transactions.
A value is required when configuring POS terminal capability.
A value is required for PIN transactions.
A value is required for
contact
,
contactless
, and
swiped
 entry modes.
Set the value to
retail
.

Optional Fields for an Authorization

REST Example: Authorization

Request
{
    "clientReferenceInformation": {
        "code": "CUPPIN",
        "comments": "Auth",
        "transactionId": "uniqueValue221",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    },
    "pointOfSaleInformation": {
        "encryptedPin": "5AA3077474494121",
        "trackData": ";6210947000000013=30102010000000000000?",
        "encryptedKeySerialNumber": "23288800020018400013",
        "pinBlockEncodingFormat": "0",
        "terminalId": "12348765",
        "terminalPinCapability": "6",
        "emv": {
            "cardSequenceNumber": "001",
            "tags": "840B55494343204372656469749F3704333731379F2608ED64F3832566D2799F2701805F2A0203449A032501229C0103950500000000009F1A0203449F02060000000010009F090200109F1E0830303030303030319F03060000000000009F41024714820200009F33032040409F3501229F34034203009F100807000103A02002019F36020005910AE0581BE5F01EC4C33030"
        },
        "entryMode": "contact",
        "terminalCapability": "4"
    },
    "processingInformation": {
        "commerceIndicator": "retail"
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "421",
            "currency": "CNY"
        }
    },
    "paymentInformation": {
        "card": {
            "type": "062"
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "authReversal": {
            "method": "POST",
            "href": "/pts/v2/payments/7848077500097009811061/reversals"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/payments/7848077500097009811061"
        },
        "capture": {
            "method": "POST",
            "href": "/pts/v2/payments/7848077500097009811061/captures"
        }
    },
    "clientReferenceInformation": {
        "code": "CUPPIN",
        "transactionId": "uniqueValue221"
    },
    "id": "7848077500097009811061",
    "orderInformation": {
        "amountDetails": {
            "authorizedAmount": "421.00",
            "currency": "CNY"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "062"
        }
    },
    "paymentInformation": {
        "tokenizedCard": {
            "type": "062"
        },
        "card": {
            "type": "062"
        }
    },
    "processorInformation": {
        "approvalCode": "414384",
        "settlementDate": "0723",
        "responseCode": "00",
        "avs": {
            "code": "2"
        }
    },
    "promotionInformation": {
        "code": "Discount:35.29",
        "description": "Paid:385.71",
        "discountApplied": "35.29"
    },
    "reconciliationId": "620411220530",
    "status": "AUTHORIZED",
    "submitTimeUtc": "2026-07-23T11:55:51Z"
}

Sale

Use this information to process a sale, which combines an authorization and capture into a single transaction.
The
China UnionPay
 term for a sale is
purchase
.
For more information about transaction types, see Supported Transaction Types and Integrations. Also see Required EMV Tags.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments

Required Fields for a Sale

Set the value to
Sale
.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
Set the value to
062
.
Set the value to
1
 or
2
 for unattended devices,
5
 for SoftPOS, or
6
 for mPOS.
A value is required when EMV tag 5F34 is configured on the ICC/chip card.
A value is required for fallback scenarios.
A value is required for fallback scenarios in swiped or keyed transactions. Set the value to
1
 or
2
.
A value is required for full EMV on contact and contactless entry modes.
A value is required for PIN transactions using DUKPT for encryption.
A value is required for PIN transactions.
Set the value to
contact
,
contactless
,
swiped
, or
keyed
.
Set the value to
0
 or
1
 for PIN transactions.
A value is required when configuring POS terminal capability.
A value is required for PIN transactions.
A value is required for
contact
,
contactless
, and
swiped
 entry modes.
Set the value to
true
.
Set the value to
retail
.

REST Example: Sale

Request
{
    "clientReferenceInformation": {
        "code": "CUPPIN",
        "comments": "Sale",
        "transactionId": "uniqueValue221",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    },
    "pointOfSaleInformation": {
        "encryptedPin": "5AA3077474494121",
        "trackData": ";6210947000000013=30102010000000000000?",
        "encryptedKeySerialNumber": "23288800020018400013",
        "pinBlockEncodingFormat": "0",
        "terminalId": "12348765",
        "terminalPinCapability": "6",
        "emv": {
            "cardSequenceNumber": "001",
            "tags": "840B55494343204372656469749F3704333731379F2608ED64F3832566D2799F2701805F2A0203449A032501229C0103950500000000009F1A0203449F02060000000010009F090200109F1E0830303030303030319F03060000000000009F41024714820200009F33032040409F3501229F34034203009F100807000103A02002019F36020005910AE0581BE5F01EC4C33030"
        },
        "entryMode": "contact",
        "terminalCapability": "4"
    },
    "processingInformation": {
        "commerceIndicator": "retail",
        "capture": "true"
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "421",
            "currency": "CNY"
        }
    },
    "paymentInformation": {
        "card": {
            "type": "062"
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/payments/7848164905397011911061/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/payments/7848164905397011911061"
        }
    },
    "clientReferenceInformation": {
        "code": "CUPPIN",
        "transactionId": "uniqueValue221"
    },
    "id": "7848164905397011911061",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "421.00",
            "authorizedAmount": "421.00",
            "currency": "CNY"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "062"
        }
    },
    "paymentInformation": {
        "tokenizedCard": {
            "type": "062"
        },
        "card": {
            "type": "062"
        }
    },
    "pointOfSaleInformation": {
        "emv": {
            "tags": "9F36020005910AE0581BE5F01EC4C33030720B860984180000042B2A509E"
        }
    },
    "processorInformation": {
        "settlementDate": "0723",
        "responseCode": "00",
        "avs": {
            "code": "2"
        }
    },
    "promotionInformation": {
        "code": "Discount:35.29",
        "description": "Paid:385.71",
        "discountApplied": "35.29"
    },
    "reconciliationId": "620414220544",
    "status": "AUTHORIZED",
    "submitTimeUtc": "2026-07-23T14:21:32Z"
}

Capture

Use this information to capture a previous authorization. This section includes REST examples for capturing a transaction with and without using a payment card. Transactions processed without the payment card are typically initiated by the merchant's back-office staff.
The
China UnionPay
 term for a capture is
pre-authorization completion
.
For more information about transaction types, see Supported Transaction Types and Integrations. Also see Required EMV Tags.

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 a Capture

Set the value to
Capture
.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required when EMV tag 5F34 is configured on the ICC/chip card.
A value is required for full EMV on contact and contactless entry modes.
A value is required for PIN transactions using DUKPT for encryption.
A value is required for PIN transactions.
Set the value to
contact
,
contactless
,
swiped
, or
keyed
.
Set the value to
0
 or
1
 for PIN transactions.
A value is required for PIN transactions.
A value is required for
contact
,
contactless
, and
swiped
 entry modes.
Set the value to
retail
 when PAN or track data is sent in the request for a payment initiated using a payment card.

Optional Fields for a Capture

When you do not include one of these optional fields in a capture request, the value in your merchant account or configuration is used.

REST Example: Capture Initiated Using a Payment Card

Request
{
    "clientReferenceInformation": {
        "code": "RTS-Capture",
        "comments": "Capture",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    },
    "processingInformation": {
        "commerceIndicator": "retail"
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "210",
            "currency": "CNY"
        }
    },
    "pointOfSaleInformation": {
        "encryptedPin": "5AA3077474494121",
        "trackData": ";6210947000000013=30102010000000000000?",
        "encryptedKeySerialNumber": "23288800020018400013",
        "pinBlockEncodingFormat": "0",
        "terminalId": "12345678",
        "terminalPinCapability": "6",
        "entryMode": "contact",
        "emv": {
            "cardSequenceNumber": "001"
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/captures/7847874797217000511061/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/captures/7847874797217000511061"
        }
    },
    "clientReferenceInformation": {
        "code": "RTS-Capture"
    },
    "id": "7847874797217000511061",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "210.00",
            "currency": "CNY"
        }
    },
    "processorInformation": {
        "settlementDate": "0723"
    },
    "reconciliationId": "620406220446",
    "status": "PENDING",
    "submitTimeUtc": "2026-07-23T06:18:01Z"
}

REST Example: Capture Initiated Without Using a Payment Card

Request
{
    "clientReferenceInformation": {
        "code": "RTS-Capture",
        "comments": "Capture",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "210",
            "currency": "CNY"
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/captures/7847885476267001311061/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/captures/7847885476267001311061"
        }
    },
    "clientReferenceInformation": {
        "code": "RTS-Capture"
    },
    "id": "7847885476267001311061",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "210.00",
            "currency": "CNY"
        }
    },
    "processorInformation": {
        "settlementDate": "0723"
    },
    "reconciliationId": "620406220453",
    "status": "PENDING",
    "submitTimeUtc": "2026-07-23T06:35:48Z"
}

Refund

Use this information to process a refund for a previous capture or sale. This section includes REST examples for processing a refund with and without using a payment card. Transactions processed without the payment card are typically initiated by the merchant's back-office staff.
The
China UnionPay
 term for a refund matched to a previous transaction is
refund - matched
.
For more information about transaction types, see Supported Transaction Types and Integrations. Also see Required EMV Tags.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments/
{id}
/refunds
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments/
{id}
/refunds
The
{id}
 is the transaction ID returned in the capture or sale response.

Required Fields for a Refund

Set the value to
Refund
.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required when EMV tag 5F34 is configured on the ICC/chip card.
Set the value to
contact
,
contactless
,
swiped
, or
keyed
.
A value is required for
contact
,
contactless
, and
swiped
 entry modes.
Set the value to
retail
 when PAN or track data is sent in the request for a payment initiated using a payment card.

Optional Fields for a Refund

When you do not include one of these optional fields in a refund request, the value in your merchant account or configuration is used.

REST Example: Refund Initiated Using a Payment Card

Request
{
    "clientReferenceInformation": {
        "code": "Refund",
        "comments": "Refund",
        "transactionId": "uniqueValue221",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    },
    "processingInformation": {
        "commerceIndicator": "retail"
    },
    "pointOfSaleInformation": {
        "terminalId": "12345678",
        "trackData": ";6225830010000202=27126210000000000001F?",
        "emv": {
            "cardSequenceNumber": 1
        },
        "entryMode": "contact"
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "CNY"
        }
    },
    "merchantInformation": {
        "transactionLocalDateTime": "20260724085022"
    }
}
Response to a Successful Request
{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/refunds/7848896021147003640428/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/refunds/7848896021147003640428"
        }
    },
    "clientReferenceInformation": {
        "code": "Refund",
        "transactionId": "uniqueValue221"
    },
    "id": "7848896021147003640428",
    "orderInformation": {
        "amountDetails": {
            "currency": "cny"
        }
    },
    "processorInformation": {
        "retrievalReferenceNumber": "2300058480",
        "settlementDate": "0724"
    },
    "reconciliationId": "620510228807",
    "refundAmountDetails": {
        "currency": "CNY",
        "refundAmount": "100.00"
    },
    "status": "PENDING",
    "submitTimeUtc": "2026-07-24T10:40:07Z"
}

REST Example: Refund Initiated Without Using a Payment Card

Request
{
    "clientReferenceInformation": {
        "code": "Refund",
        "comments": "Refund",
        "transactionId": "uniqueValue221",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "cny"
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/refunds/7848896021147003640428/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/refunds/7848896021147003640428"
        }
    },
    "clientReferenceInformation": {
        "code": "Refund",
        "transactionId": "uniqueValue221"
    },
    "id": "7848896021147003640428",
    "orderInformation": {
        "amountDetails": {
            "currency": "cny"
        }
    },
    "processorInformation": {
        "retrievalReferenceNumber": "2300058480",
        "settlementDate": "0724"
    },
    "reconciliationId": "620510228807",
    "refundAmountDetails": {
        "currency": "cny",
        "refundAmount": "100.00"
    },
    "status": "PENDING",
    "submitTimeUtc": "2026-07-24T10:40:07Z"
}

Stand-Alone Credit

Use this information to process a stand-alone credit, with no reference to a previous transaction.
The
China UnionPay
 term for a refund not matched to a previous transaction is
refund - un-matched
.
For more information about transaction types, see Supported Transaction Types and Integrations.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/credits/
Test:
POST
https://apitest.cybersource.com
/pts/v2/credits/

Required Fields for a Stand-Alone Credit

Set the value to
Stand-alone Credit
.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
Set the value to
062
.
Set the value to
1
 or
2
 for unattended devices,
5
 for SoftPOS, or
6
 for mPOS.
A value is required when EMV tag 5F34 is configured on the ICC/chip card.
A value is required for fallback scenarios for transactions initiated using a card.
A value is required for fallback scenarios in swiped or keyed transactions initiated using a card. Set the value to
1
 or
2
.
Set the value to
contact
,
contactless
,
swiped
, or
keyed
.
A value is required when configuring POS terminal capability for transactions initiated using a card.
A value is required for
contact
,
contactless
, and
swiped
 entry modes.
Set the value to
retail
.

Optional Fields for a Stand-Alone Credit

REST Example: Stand-Alone Credit

Request
{
    "clientReferenceInformation": {
        "code": "FE56907",
        "comments": "Stand-alone Credit",
        "transactionId": "uniqueValue221",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    },
    "processingInformation": {
        "commerceIndicator": "retail"
    },
    "pointOfSaleInformation": {
        "terminalId": "12345678",
        "terminalCapability": "5",
        "trackData": ";6225830010000202=27126210000000000001F?",
        "emv": {
            "cardSequenceNumber": 1
        },
        "entryMode": "contactless"
    },
    "paymentInformation": {
        "card": {
            "type": "062"
        }
    },
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "CNY"
        }
    },
    "merchantInformation": {
        "transactionLocalDateTime": "20260724085022"
    }
}
Response to a Successful Request
{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/credits/7848177260997013211061/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/credits/7848177260997013211061"
        }
    },
    "clientReferenceInformation": {
        "code": "FE56907",
        "transactionId": "uniqueValue221"
    },
    "creditAmountDetails": {
        "currency": "CNY",
        "creditAmount": "100.00"
    },
    "id": "7848177260997013211061",
    "orderInformation": {
        "amountDetails": {
            "currency": "CNY"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "062"
        }
    },
    "paymentInformation": {
        "tokenizedCard": {
            "type": "062"
        },
        "card": {
            "type": "062"
        }
    },
    "processorInformation": {
        "retrievalReferenceNumber": "2300056700",
        "settlementDate": "0723"
    },
    "reconciliationId": "620414220556",
    "status": "PENDING",
    "submitTimeUtc": "2026-07-23T14:42:09Z"
}

Authorization Reversal

Use this information to reverse a previous authorization. This section includes REST examples for reversing an authorization with and without using a payment card. Transactions processed without the payment card are typically initiated by the merchant's back-office staff.
The
China UnionPay
 term for an authorization reversal is
pre-authorization cancellation
.
For more information about transaction types, see Supported Transaction Types and Integrations. Also see Required EMV Tags.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments/
{id}
/reversals
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments/
{id}
/reversals
The
{id}
 is the transaction ID returned in the authorization response.

Required Fields for an Authorization Reversal

Set the value to
Auth Reversal
.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required when EMV tag 5F34 is configured on the ICC/chip card.
A value is required for PIN transactions using DUKPT for encryption.
A value is required for PIN transactions.
Set the value to
contact
,
contactless
,
swiped
, or
keyed
.
Set the value to
0
 or
1
 for PIN transactions.
A value is required for PIN transactions.
A value is required for
contact
,
contactless
, and
swiped
 entry modes.
Set the value to
retail
 when PAN or track data is sent in the request for a payment initiated using a payment card.

Optional Fields for an Authorization Reversal

When you do not include one of these optional fields in an authorization reversal request, the value in your merchant account or configuration is used.

REST Example: Authorization Reversal Initiated Using a Payment Card

Request
{
  "clientReferenceInformation": {
    "code": "RTS-Auth-Reversal",
    "comments": "Auth Reversal",
    "partner": {
      "thirdPartyCertificationNumber": "testTPCN",
      "developerId": "cup12",
      "solutionId": "cup123"
    }
  },
  "processingInformation": {
    "commerceIndicator": "retail"
  },
  "reversalInformation": {
    "amountDetails": {
      "currency": "CNY",
      "totalAmount": "421"
    }
  },
  "pointOfSaleInformation": {
    "encryptedPin": "5AA3077474494121",
    "trackData": ";6210947000000013=30102010000000000000?",
    "encryptedKeySerialNumber": "23288800020018400013",
    "pinBlockEncodingFormat": "0",
    "terminalPinCapability": "6",
    "terminalId": "12345678",
    "entryMode": "contact",
    "emv": {
      "cardSequenceNumber": "001"
    }
  }
}
Response to a Successful Request
{
    "_links": {
        "self": {
            "method": "GET",
            "href": "/pts/v2/reversals/7847895874767002111061"
        }
    },
    "authorizationInformation": {
        "approvalCode": "414304"
    },
    "clientReferenceInformation": {
        "code": "RTS-Auth-Reversal"
    },
    "id": "7847895874767002111061",
    "orderInformation": {
        "amountDetails": {
            "currency": "CNY"
        }
    },
    "processorInformation": {
        "settlementDate": "0723",
        "responseCode": "00"
    },
    "reconciliationId": "620406220460",
    "reversalAmountDetails": {
        "reversedAmount": "421.00",
        "currency": "CNY"
    },
    "status": "REVERSED",
    "submitTimeUtc": "2026-07-23T06:53:08Z"
}

REST Example: Authorization Reversal Initiated Without Using a Payment Card

Request
{
  "clientReferenceInformation": {
    "code": "RTS-Auth-Reversal",
    "comments": "Auth Reversal",
    "transactionId": "uniqueValue221",
    "partner": {
      "thirdPartyCertificationNumber": "testTPCN",
      "developerId": "cup12",
      "solutionId": "cup123"
    }
  },
  "reversalInformation": {
    "amountDetails": {
      "currency": "CNY",
      "totalAmount": "421"
    }
  }
}
Response to a Successful Request
{
    "_links": {
        "self": {
            "method": "GET",
            "href": "/pts/v2/reversals/7847897892327002611061"
        }
    },
    "authorizationInformation": {
        "approvalCode": "414305"
    },
    "clientReferenceInformation": {
        "code": "RTS-Auth-Reversal"
    },
    "id": "7847897892327002611061",
    "orderInformation": {
        "amountDetails": {
            "currency": "CNY"
        }
    },
    "processorInformation": {
        "settlementDate": "0723",
        "responseCode": "00"
    },
    "reconciliationId": "620406220464",
    "reversalAmountDetails": {
        "reversedAmount": "421.00",
        "currency": "CNY"
    },
    "status": "REVERSED",
    "submitTimeUtc": "2026-07-23T06:56:30Z"
}

Time-Out Authorization Reversal

Use this information to process a merchant-initiated, time-out authorization reversal when you do not receive a response message after sending an authorization request.
The
China UnionPay
 term for a time-out authorization reversal is
reversal of a pre-authorization
.
For more information about transaction types, see Supported Transaction Types and Integrations.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/reversals
Test:
POST
https://apitest.cybersource.com
/pts/v2/reversals

Required Fields for a Time-Out Authorization Reversal

REST Example: Time-Out Authorization Reversal

Request
{
  "clientReferenceInformation": {
    "code": "RTS-Auth-TOR",
    "transactionId": "cppincert1",
    "comments": "Time-out Auth Reversal",
    "partner": {
      "thirdPartyCertificationNumber": "testTPCN",
      "developerId": "cup12",
      "solutionId": "cup123"
    }
  },
  "reversalInformation": {
    "amountDetails": {
      "totalAmount": "505"
    }
  }
}
Response to a Successful Request
{
    "_links": {
        "self": {
            "method": "GET",
            "href": "/pts/v2/reversals/7848899814087004240428"
        }
    },
    "clientReferenceInformation": {
        "code": "RTS-Auth-TOR",
        "transactionId": "cppincert1"
    },
    "id": "7848899814087004240428",
    "orderInformation": {
        "amountDetails": {
            "currency": "CNY"
        }
    },
    "processorInformation": {
        "settlementDate": "0724",
        "responseCode": "00"
    },
    "reconciliationId": "620510228810",
    "reversalAmountDetails": {
        "reversedAmount": "505.00",
        "currency": "CNY"
    },
    "status": "REVERSED",
    "submitTimeUtc": "2026-07-24T10:40:07Z"
}

Void a Sale or Capture

Use this information to void a sale or a capture transaction. This section includes REST examples for voiding a sale or capture with and without using a payment card. Transactions processed without the payment card are typically initiated by the merchant's back-office staff.
The
China UnionPay
 term for a voided sale is
purchase cancellation
. The term for a voided capture is
pre-authorization completion cancellation
.
For more information about transaction types, see Supported Transaction Types and Integrations. Also see Required EMV Tags.

Void a Sale

Use this endpoint to void a sale transaction.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments/
{id}
/voids
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments/
{id}
/voids
The
{id}
 is the transaction ID returned in the sale response.

Void a Capture

Use this endpoint to void a capture transaction.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/captures/
{id}
/voids
Test:
POST
https://apitest.cybersource.com
/pts/v2/captures/
{id}
/voids
The
{id}
 is the transaction ID returned in the capture response.

Required Fields for Voiding a Sale or Capture

Set the value to
Sale Void
 or
Capture Void
.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required for keyed transactions.
A value is required when EMV tag 5F34 is configured on the ICC/chip card.
A value is required for PIN transactions using DUKPT for encryption.
A value is required for PIN transactions.
Set the value to
contact
,
contactless
,
swiped
, or
keyed
.
Set the value to
0
 or
1
 for PIN transactions.
A value is required for PIN transactions.
A value is required for
contact
,
contactless
, and
swiped
 entry modes.
Set the value to
retail
 when PAN or track data is sent in the request for a payment initiated using a payment card.

Optional Fields for Voiding a Sale or Capture

When you do not include one of these optional fields in a void request, the value in your merchant account or configuration is used.

REST Example: Voiding a Sale or Capture Initiated Using a Payment Card

Request
{
    "clientReferenceInformation": {
        "code": "RTS-Void",
        "comments": "Sale Void",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    },
    "processingInformation": {
        "commerceIndicator": "retail"
    },
    "pointOfSaleInformation": {
        "encryptedPin": "AC287D0B9C81B5AE",
        "encryptedKeySerialNumber": "23288800020018400013",
        "pinBlockEncodingFormat": "0",
        "terminalPinCapability": "6",
        "terminalId": "12345678",
        "trackData": ";8171999900000018=30102010000000000000?",
        "entryMode": "contact",
        "emv": {
            "cardSequenceNumber": "001"
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "self": {
            "method": "GET",
            "href": "/pts/v2/voids/7848068861837009211061"
        }
    },
    "clientReferenceInformation": {
        "code": "RTS-Void"
    },
    "id": "7848068861837009211061",
    "orderInformation": {
        "amountDetails": {
            "currency": "CNY"
        }
    },
    "processorInformation": {
        "settlementDate": "0723",
        "responseCode": "00"
    },
    "reconciliationId": "620411220523",
    "status": "VOIDED",
    "submitTimeUtc": "2026-07-23T11:41:27Z",
    "voidAmountDetails": {
        "currency": "cny",
        "voidAmount": "320.00"
    }
}

REST Example: Voiding a Sale or Capture Initiated Without Using a Payment Card

Request
{
    "clientReferenceInformation": {
        "code": "RTS-Void",
        "comments": "Sale Void",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "self": {
            "method": "GET",
            "href": "/pts/v2/voids/7848070302487009411061"
        }
    },
    "clientReferenceInformation": {
        "code": "RTS-Void"
    },
    "id": "7848070302487009411061",
    "orderInformation": {
        "amountDetails": {
            "currency": "CNY"
        }
    },
    "processorInformation": {
        "settlementDate": "0723",
        "responseCode": "00"
    },
    "reconciliationId": "620411220525",
    "status": "VOIDED",
    "submitTimeUtc": "2026-07-23T11:43:51Z",
    "voidAmountDetails": {
        "currency": "cny",
        "voidAmount": "320.00"
    }
}

Void Time-Out Reversal

Use this information to process a merchant-initiated, void time-out reversal when you do not receive a response message after sending a void request.
The
China UnionPay
 term for a sale time-out void is
reversal of a purchase
. The term for a capture time-out void is
reversal of a pre-authorization completion
.
For more information about transaction types, see Supported Transaction Types and Integrations.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/voids/
Test:
POST
https://apitest.cybersource.com
/pts/v2/voids/

Required Fields for a Void Time-Out Reversal

Set the value to
Sale Time-out Void
 or
Capture Time-out Void
.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Cybersource
 provides the value for this field.
Set the value to the transaction ID for the original transaction.

REST Example: Void Time-Out Reversal

Request
{
    "clientReferenceInformation": {
        "code": "RTS-Void TOR",
        "transactionId": "cppincert5",
        "comments": "Sale Time-out Void",
        "partner": {
            "thirdPartyCertificationNumber": "testTPCN",
            "developerId": "cup12",
            "solutionId": "cup123"
        }
    }
}
Response to a Successful Request
{
    "_links": {
        "self": {
            "method": "GET",
            "href": "/pts/v2/voids/7848910512387005440428"
        }
    },
    "clientReferenceInformation": {
        "code": "RTS-Void TOR",
        "transactionId": "cppincert5"
    },
    "id": "7848910512387005440428",
    "orderInformation": {
        "amountDetails": {
            "currency": "CNY"
        }
    },
    "processorInformation": {
        "settlementDate": "0724",
        "responseCode": "00"
    },
    "reconciliationId": "620511228818",
    "status": "VOIDED",
    "submitTimeUtc": "2026-07-24T11:04:12Z",
    "voidAmountDetails": {
        "currency": "cny",
        "voidAmount": "265.00"
    }
}