checkout_form

POST

https://api.cfxpay.io/{{param_environment}}/{{param_company}}/gateway/checkout_form

Last modified:2024-02-23 13:39:55

Use this endpoint to generate a new form URL for your clients to complete the final payment steps, after selecting the payment type on your side. If you have any questions about this flow, see Integration Types.

When you redirect your user to the generated URL they will go through the following screens:

📌

If you want to use our paywall page but need customization for your brand, please contact us.

Payer information form page

Invoice page

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Body Params application/json

Example

{
    "payment_type_id": "a88eb69672cc1f8483d481a56259dcaa",
    "tracking_id": "a4235e64-599f-4a1c-8b09-3aac2498d283",
    "amount": "41.17",
    "callback_url": "https://api.cfxpay.io/webhook_test",
    "description": "Payment transaction at Wolff Ferry",
    "cancel_url": "https://cfxpay.io",
    "return_url": "https://cfxpay.io"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api.cfxpay.io/{{param_environment}}/{{param_company}}/gateway/checkout_form' \
--header 'Language: PORTUGUESE_BR' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "payment_type_id": "a88eb69672cc1f8483d481a56259dcaa",
    "tracking_id": "a4235e64-599f-4a1c-8b09-3aac2498d283",
    "amount": "41.17",
    "callback_url": "https://api.cfxpay.io/webhook_test",
    "description": "Payment transaction at Wolff Ferry",
    "cancel_url": "https://cfxpay.io",
    "return_url": "https://cfxpay.io"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "server": "01",
    "code": 0,
    "message": "Success",
    "identifier": "1708389855466491981",
    "type": "LOG_INFO",
    "caller": "_checkout_form",
    "caller_id": "1708389855395790263",
    "translation_message": "Sucesso",
    "gateway": [
        {
            "checkout_url": "https://checkout.cfxpay.io/#/form/U2FsdGVkX19E8Syd-WlZGxTP2DSRvEqha0PMtZLBy70XxTNuIzExPbcuhjDL3D2NibkxeY7ZqkGDQUvqx5J3RD1OPP0TNHu2tY3DeBbKCXYPYwC4odOR95naFhYCKmzKah-RMkt3ScVYVDWlK-5R2jiZ-ggjP7FwIsMCIOB1EmjVhtREP3k1z5-7sZHgNrCjFNHXqoWWcaH6bm-pP05EhIvAWe3i67WOQs5vJvGAG_04umZWhb6Lgjv5cNu-KdXr8Zx67Dbd8eKcv1mtmMnBxJa1TbY481iLRQElPMkPVwv90FvThALelDFuHS0iJbHe-daRFEWFB4gJFU-gasZzfxh4L1DA0JXeQwa1BSRePMMIjJbd8qhXkfOIp5ZSYhclAU690cSjC6J0z00q3S3zsVIPyRBWD8WWLgP0FFiXdSurME6yfXJI-Kdm_RhT8Wi44kobk-VhFTNYuwu0hJwHchFxtZaPQLsNNJiIFwl8y6WNcmjkLONpjOVv4ORjabut"
        }
    ]
}

🟠400Wrong Params

Modified at 2024-02-23 13:39:55

checkout_create

balance_merchant