FILTER BY TAG

Process a Sale

This section describes how to send a sale request to process a payment.
A sale request authorizes and captures a payment in the same request. A successful sale response includes an Pluxee redirect URL and a
PENDING
status. Redirect the customer to the Pluxee URL to allow the customer to complete the checkout using their Pluxee account. When the customer completes the checkout, the customer is redirected to your website.
When you receive a successful response, save the sale request ID in the
id
response field to perform a follow-on check status request or refund request.

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

Processing a Sale

Follow these steps to successfully process sale.
  1. Send a
    POST
    request to the
    https://apitest.cybersource.com
    /pts/v2/payments
    endpoint and include these required fields:
    clientReferenceInformation.code
    merchantInformation.cancelUrl
    merchantInformation.failureUrl
    merchantInformation.successUrl
    orderInformation.amountDetails.currency
    Set to
    EUR
    .
    orderInformation.amountDetails.totalAmount
    orderInformation.billTo.country
    orderInformation.billTo.email
    orderInformation.billTo.firstName
    orderInformation.billTo.lastName
    paymentInformation.paymentType.method.name
    Set to
    SODEXO
    .
    paymentInformation.paymentType.name
    Set to
    Voucher
    .
    processingInformation.actionList
    Set to
    AP_SALE
    .
  2. You can include these optional fields in the request:
  3. Redirect the customer to the returned URL in the
    merchantInformation.successUrl
    response field.
    "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess"
  4. When the customer completes the checkout using their Pluxee credentials, the customer is redirected to the merchant website based on the URL that you included in the
    merchantInformation.successUrl
    request field.
  5. Save the request ID in the
    id
    field from the sale response. Include the request ID in a check status request to confirm that the payment is complete.
    "id": "7551878413816917004807"

Example: Processing a Sale

Request
{ "clientReferenceInformation": { "code": "123" }, "merchantInformation": { "cancelUrl": "https://www.valid.merchant.redirect.url.from.request.html?actioncancel", "failureUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionfailure", "successUrl": "https://www.valid.merchant.redirect.url.from.request.html?actionsuccess" }, "paymentInformation": { "paymentType": { "method": { "name": "SODEXO" }, "name": "Voucher" } }, "orderInformation": { "billTo": { "firstName": "John", "lastName": "Doe", "country": "FR", "email": "test@test.com" }, "amountDetails": { "totalAmount": "10.00", "currency": "EUR" } }, "processingInformation": { "actionList": [ "AP_SALE" ] } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/7546709037156463304805/voids" }, "billingAgreement": { "method": "POST", "href": "/pts/v2/billing-agreements/7546709037156463304805" }, "self": { "method": "POST", "href": "/pts/v2/payments/7546709037156463304805" }, "refund": { "method": "POST", "href": "/pts/v2/payments/7546709037156463304805/refunds" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546709037156463304805" } }, "clientReferenceInformation": { "code": "123" }, "id": "7546709037156463304805", "message": "Request was processed successfully.", "orderInformation": { "amountDetails": { "totalAmount": "10.00", "currency": "EUR" } }, "processorInformation": { "responseDetails": "00001", "paymentUrl": "https://payment.limonetikqualif.com/PluxeeFrance/Order/PayPage/734260616764", "transactionId": "734260616764", "responseCode": "00001" }, "reconciliationId": "XFZ40E1G1A6G", "status": "PENDING", "submitTimeUtc": "2025-08-08T16:35:04Z" }

Response Statuses for Processing a Sale

Cybersource
responds to your sale request with one of these statuses in the
status
field:
  • FAILED
    : The sale cannot be completed.
  • PENDING
    : The sale request is accepted but is not completed. Send a check status request as often as necessary to obtain the information that you need. For more information, see Check a Transaction Status.