On This Page
FILTER BY TAG

Authorize a Payment

The authorization service confirms a customer's account holds enough funds for the payment.
The authorization request requires the pre-approved token returned in the session response in the
processorInformation.token
 field.
When a payment is authorized, it can be captured within 28 days.

Line Items

The authorization service requires you to include line items in your request. Line items are included in a request in the
lineItem[]
 array.
For more information on how to use line items, see Using Line Items.

Tax Amounts

Include the tax amount for every type of purchased product in the
orderInformation.lineItems[].taxAmount
 field when you request the authorization service.

Calculating the Grand Total

Include the grand total in the request by using the
orderInformation.amountDetails.totalAmount
 field.

Endpoints

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

Response Statuses

The authorization service responds with one of these statuses as the
status
 field value:
  • AUTHORIZED
    : The payment is successfully authorized.
  • FAILED
    : The authorization request failed.
  • PENDING
    : The authorization request is accepted but is not authorized. Either the authorization is being audited by Oney or the customer has not completed the checkout using the redirection URL. The merchant should send a check status request to retrieve status updates. Request the check status service to retrieve status updates. See Check a Transaction Status.
The authorization service also responds with a reason code as the
responseCode
 field value.

Example: Processing an Authorization

Request
{
    "clientReferenceInformation": {
        "code": "refnum-1234"
    },
    "orderInformation": {
        "billTo": {
            "firstName": "John",
            "lastName": "Doe",
            "address1": "1 Market St",
            "locality": "Paris",
            "administrativeArea": "AR",
            "postalCode": "75001",
            "country": "FR",
            "email": "nredhi@visa.com",
            "phoneNumber": "33623456789"
        },
        "shipTo": {
            "firstName": "John",
            "lastName": "Doe",
            "address1": "1 Market St",
            "locality": "Paris",
            "administrativeArea": "AR",
            "postalCode": "75001",
            "country": "FR",
            "email": "nredhi@visa.com",
            "phoneNumber": "33623456789"
        },
        "amountDetails": {
            "totalAmount": "600.00",
            "currency": "EUR"
        },
        "lineItems": [
            {
                "unitPrice": "1.00",
                "quantity": "10",
                "productSKU": "testI",
                "productName": "TV",
                "productCode": "4564",
                "totalAmount": "10"
            },
            {
                "unitPrice": "15.00",
                "quantity": "1",
                "productSKU": "testJ",
                "productName": "TV",
                "productCode": "65432",
                "totalAmount": "15"
            }
        ]
    },
    "processorInformation": {
        "preApprovalToken": "430844862998"
    },
    "paymentInformation": {
        "paymentType": {
            "name": "BNPL",
            "method": {
                "name": "ONEY"
            }
        }
    },
    "processingInformation": {
        "actionList": "AP_AUTH"
    }
}
Response
{
    "_links": {
        "authReversal": {
            "method": "POST",
            "href": "/pts/v2/payments/7546766970976403004805/reversals"
        },
        "capture": {
            "method": "POST",
            "href": "/pts/v2/payments/7546766970976403004805/captures"
        },
        "self": {
            "method": "POST",
            "href": "/pts/v2/payments/7546766970976403004805"
        },
        "status": {
            "method": "POST",
            "href": "/pts/v2/refresh-payment-status/7546766970976403004805"
        }
    },
    "clientReferenceInformation": {
        "code": "refnum-1234"
    },
    "id": "7546766970976403004805",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "600.00",
            "currency": "EUR"
        }
    },
    "processorInformation": {
        "approvalCode": "1000",
        "responseDetails": "00003",
        "transactionId": "430844862998",
        "responseCode": "00003"
    },
    "reconciliationId": "XFZ3ZE1G1DHB",
    "status": "AUTHORIZED",
    "submitTimeUtc": "2025-08-08T18:11:38Z"
}
RELATED TO THIS PAGE