On This Page

Process a Sale

Send a sale request to authorize and capture a payment in the same request. A successful sale response includes a redirect URL and a pending status. Redirect the customer to the URL to allow the customer to complete the checkout using Bizum. When the customer completes the checkout, the customer is redirected to your merchant website based on the success URL you include in the

merchantInformation.successUrl

request field.

Line Items

Line items are included in a request in the

lineItem[]

array.

For more information about how to properly format line items in your request, see Using Line Items.

Tax Amounts

You can include the tax amount for every type of purchased product in the

orderInformation.lineItems[].taxAmount

field when you request the sale 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

Cybersource responds to your sale request with one of these statuses in the

status

field:

Sale Status: FAILED
: The sale cannot be completed.
PENDING
: The sale request is accepted but is not completed. Request the check status service every 60 minutes to retrieve status updates. See Check a Request Status.

When you send a check status request to retrieve an updated sale status, these are the possible responses:

Check Status for a Sale: ABANDONED
: The customer did not complete the payment using the redirect URL.
FAILED
: The sale cannot be completed.
FUNDED
: The settled amount is funded to the merchant bank account.
PENDING
: The sale request is accepted but is not complete. Continue sending the check status request every 60 minutes.
SETTLED
: The sale request is settled for the requested amount. You cannot receive a settled status until the customer has completed checking out.

Processing a Sale

Follow these steps to successfully process sale.

Send a

POST

request to the

https://api.cybersource.com/pts/v2/payments

endpoint and include these required fields:

clientReferenceInformation.code
merchantInformation.cancelUrl
merchantInformation.failureUrl
merchantInformation.successUrl
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.billTo.country
orderInformation.billTo.email
orderInformation.billTo.firstName
orderInformation.billTo.lastName
paymentInformation.paymentType.method.name: Set to
BIZUM
.
paymentInformation.paymentType.name: Set to
bankTransfer
.
processingInformation.actionlist: Set to
AP_SALE
.

You can include these optional fields in the request:

merchantDefinedInformation[].key
merchantInformation.merchantDescriptor
orderInformation.billTo.address1
orderInformation.billTo.address2
orderInformation.billTo.administrativeArea
orderInformation.billTo.locality
orderInformation.billTo.phoneNumber
orderInformation.billTo.postalCode
orderInformation.lineItems[].productCode
orderInformation.lineItems[].productName
orderInformation.lineItems[].productSku
orderInformation.lineItems[].quantity
orderInformation.lineItems[].taxAmount
orderInformation.lineItems[].totalAmount
orderInformation.lineItems[].unitPrice

Redirect the customer to the returned URL in the

processorInformation.paymentUrl

response field.

"paymentUrl": "https://Bizum.limonetikqualif.com/PayPage/359299031517"

When the customer completes the checkout using their Bizum credentials, the customer is redirected to the merchant website based on the URL that you included in the

merchantInformation.successUrl

field.

Save the request ID in the

field from the sale response. Include the request ID in a check status request to confirm that the payment is complete.

"id": "7652176144426365504805"

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": "BIZUM"
            },
            "name": "bankTransfer"
        }
    },
    "orderInformation": {
        "billTo": {
            "country": "ES"
        },
        "amountDetails": {
            "currency": "EUR",
            "totalAmount": "8.00"
        }
    },
    "processingInformation": {
        "actionList": [
            "AP_SALE"
        ]
    }
}

Response to a Successful Request

{
    "_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/payments/7652176144426365504805/voids"
        },
        "billingAgreement": {
            "method": "POST",
            "href": "/pts/v2/billing-agreements/7652176144426365504805"
        },
        "self": {
            "method": "POST",
            "href": "/pts/v2/payments/7652176144426365504805"
        },
        "refund": {
            "method": "POST",
            "href": "/pts/v2/payments/7652176144426365504805/refunds"
        },
        "status": {
            "method": "POST",
            "href": "/pts/v2/refresh-payment-status/7652176144426365504805"
        }
    },
    "clientReferenceInformation": {
        "code": "123"
    },
    "id": "7652176144426365504805",
    "message": "Request was processed successfully.",
    "orderInformation": {
        "amountDetails": {
            "totalAmount": "8.00",
            "currency": "EUR"
        }
    },
    "processorInformation": {
        "responseDetails": "00001",
        "paymentUrl": "https://Bizum.limonetikqualif.com/PayPage/359299031517",
        "transactionId": "359299031517",
        "responseCode": "00001"
    },
    "reconciliationId": "XFZ3ZIRG3CAE",
    "status": "PENDING",
    "submitTimeUtc": "2025-12-08T18:13:35Z"
}