On This Page
FILTER BY TAG

Create a Session

To create a session, you must include shipping fields in your request. The shipping field values are included in the invoice Oney sends to the customer.
When the session request is complete, the response message includes a pre-approval token from Oney. Use this pre-approval token when initializing the Oney authorization service. The session response message also includes a redirection URL that remains available for the customer up to 20 minutes after the session request.

Line Items

The session 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 sessions 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/payment-references
Test:
POST
https://apitest.cybersource.com
/pts/v2/payment-references

Response Statuses

The session service responds with one of these statuses as the
status
 field value:
  • PENDING
    : The session is initiated and the customer may now checkout. Request the check status service to retrieve status updates. See Check a Transaction Status.
The session service also responds with a reason code as the field value.

Creating a Session

Follow these steps to successfully create a session.
  1. Send a
    POST
     request to the
    https://api.cybersource.com
    /pts/v2/payments
     endpoint and include these required fields:
    Set to
    ONEY
    .
    Set to
    BNPL
    .
    Set to
    AP_SESSIONS
    .
  3. Redirect the customer to the returned URL in the
    processorInformation.paymentUrl
     response field.
    "paymentUrl": "https://payment.limonetikqualif.com/OneyInternational/Order/PayPage/430844862998?LmkData=dGhtPTN4"
  4. When the customer completes the checkout using their Oney credentials, the customer is redirected to the merchant site based on the URL that you included in the
    merchantInformation.successURL
     field.
  5. Save the returned pre-approval token contained in the
    processorInformation.token
     response field. Include the pre-approval token in the authorization request to link the authorization to the session.
    "token": "430844862998"

Example: Create a Session

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"
            }
        ]
    },
    "paymentInformation": {
        "paymentType": {
            "name": "BNPL",
            "method": {
                "name": "ONEY"
            }
        }
    },
    "processingInformation": {
        "actionList": "AP_SESSIONS"
    },
    "merchantInformation": {
        "cancelURL": "https://www.test0.com",
        "successURL": "https://www.test1.com",
        "failureURL": "https://www.test1.com"
    }
}
Response
{
    "_links": {
        "self": {
            "method": "POST",
            "href": "/pts/v2/payment-references"
        },
        "updateSession": {
            "method": "PATCH",
            "href": "/pts/v2/payment-references/7546763020266529004807"
        },
        "status": {
            "method": "POST",
            "href": "/pts/v2/refresh-payment-status/7546763020266529004807"
        },
        "order": {
            "method": "POST",
            "href": "/pts/v2/payment-references/7546763020266529004807/intents"
        }
    },
    "clientReferenceInformation": {
        "code": "refnum-1234"
    },
    "id": "7546763020266529004807",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "600.00",
            "currency": "EUR"
        }
    },
    "processorInformation": {
        "responseDetails": "00001",
        "paymentUrl": "https://payment.limonetikqualif.com/OneyInternational/Order/PayPage/430844862998?LmkData=dGhtPTN4",
        "responseCode": "00001",
        "token": "430844862998"
    },
    "reconciliationId": "XFZ40E1G1CCC",
    "status": "PENDING",
    "submitTimeUtc": "2025-08-08T180503Z"
}
RELATED TO THIS PAGE