checkout_form - CFX Pay

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

Language

string

required

Language list

Example:

PORTUGUESE_BR

Body Params application/json

tracking_id

string <uuid>

required

External tracking reference for the transaction UUID_v4.

payment_type_id

string <md5>

required

Specify the payment method ID.
This ID is returned in the endpoint payment_type.

>= 32 characters<= 32 characters

Example:

a88eb69672cc1f8483d481a56259dcaa

Match pattern:

^[a-fA-F0-9]{32}$

amount

string

required

Amount of the invoice.
The decimal separator used is a "dot" "."

<= 10 characters

Examples:

20.0025.4542.10

Match pattern:

^\d+(\.\d{2})?$

callback_url

string <uri>

required

The URL that receive notifications when a transaction is created or change STATUS.

Example:

https://api.cfxpay.io/webhook_test

cancel_url

string <uri>

optional

The URL to redirect the customer if the transaction is canceled.

Example:

https://cfxpay.io

return_url

string <uri>

optional

The URL to redirect the customer after the transaction is completed.

Example:

https://cfxpay.io

description

string

optional

A short description.

<= 100 characters

Example:

Payment user: 1234567890

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

Responses

🟢200Success

application/json

Body

server

string

required

code

integer

required

message

string

required

identifier

string

required

type

string

required

caller

string

required

caller_id

string

required

translation_message

string

required

gateway

array [object {1}]

optional

checkout_url

string

required

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