Create Checkout - V2

PUT

/order/v2/checkout

• Sandbox

Create a Checkout link for payment

This version all checkout orders will be validated by AML process, to prevent frauds.

NOTE: Please, to authenticate use the scope: “api://app-order-hml”

Authorizations

• Bearer

Parameters

Header Parameters

idempotency-key

required

string format: uuid

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request Body ^required

object

customer

required

The customer of the checkout.

object

fullName

required

The name of the customer, e.g.: [John Doe] or [Acme Corporation].

string

type

required

The type of entity that owns the account.

string

Allowed values: INDIVIDUAL ORGANIZATION

document

required

The document of the Customer.

object

type

required

Type of document, used when providing an ID number.

----------------------------
Brasil
----------------------------
CPF
CNPJ
OTHERS

string

Allowed values: CPF CNPJ OTHERS

number

required

The number in the document.

string

email

required

The e-mail address of the Customer.

string

phone

required

The phone number of the Customer.

string

birth

The date of birth or foundation, in ISO-8601 YYYY-MM-DD format.

string

country

required

The country of the Merchant

string

Allowed values: AFG ALB DZA ASM AND AGO AIA ATA ATG ARG ARM ABW AUS AUT AZE BHS BHR BGD BRB BLR BEL BLZ BEN BMU BTN BOL BES BIH BWA BVT BRA IOT BRN BGR BFA BDI CPV KHM CMR CAN CYM CAF TCD CHL CHN CXR CCK COL COM COG COD COK CRI HRV CUB CUW CYP CZE DNK DJI DMA DOM ECU EGY SLV GNQ ERI EST ETH FLK FRO FJI FIN FRA GUF PYF ATF GAB GMB GEO DEU GHA GIB GRC GRL GRD GLP GUM GTM GGY GIN GNB GUY HTI HMD VAT HND HKG HUN ISL IND IDN IRN IRQ IRL IMN ISR ITA JAM JPN JEY JOR KAZ KEN KIR PRK KOR KWT KGZ LAO LVA LBN LSO LBR LBY LIE LTU LUX MAC MDG MWI MYS MDV MLI MLT MHL MTQ MRT MUS MYT MEX FSM MDA MCO MNG MNE MSR MAR MOZ MMR NAM NRU NPL NLD NCL NZL NIC NER NGA NIU NFK MNP NOR OMN PAK PLW PSE PAN PNG PRY PER PHL PCN POL PRT PRI QAT REU ROU RUS RWA BLM SHN KNA LCA MAF SPM VCT WSM SMR STP SAU SEN SRB SYC SLE SGP SXM SVK SVN SLB SOM ZAF SGS SSD ESP LKA SDN SUR SJM SWE CHE SYR TWN TJK TZA THA TLS TGO TKL TON TTO TUN TUR TKM TCA TUV UGA UKR ARE GBR USA UMI URY UZB VUT VEN VNM VGB VIR WLF ESH YEM ZMB ZWE

address

The address of the Customer.

object

state

required

State.

string

city

required

City.

string

street

required

Street.

string

neighborhood

required

Neighborhood.

string

number

required

Number.

string

complement

required

Complement.

string

postalCode

required

Postal code.

string

order

required

The checkout details.

object

code

required

Order reference in your system.

string

amount

required

Amount of the order.

object

currency

required

Currency

string

Allowed values: BRL USD USDT BUSD

value

required

The amount of the transaction, in minor units. Minor Units Format ------------------ All amount values must be formatted in that currency’s smallest unit. Two-decimal currency (for example Real): R$ 10,95 BRL, amount will be “10.95”. Two-decimal currency (for example US Dollars): $10.95 USD, amount will be “10.95”. Zero-decimal currency (for example Japanese Yen): ¥1095 JPY, amount will be “1095”. Click here to download the latest official ISO 4217 Currency Table, with Minor Units (number of decimal places) per currency

string

paymentMethod

required

Payment method for the order. (used to force a specific payment method)

string

Allowed values: CREDIT_CARD

use3ds

required

Whether to use 3D Secure for the order.

boolean

additionalInfo

required

Some description of your order as String.

string

webhookUrl

required

The URL for order notification.

string

redirectUrl

required

The URL for order return after payment Done

string

expiresAt

The expiration date and time for the checkout in ISO-8601 format. Must be a future date. If not provided, defaults to 1 day from creation. Maximum allowed will be validated at runtime based on configuration.

string

country

required

The country of the Merchant

string

Allowed values: AFG ALB DZA ASM AND AGO AIA ATA ATG ARG ARM ABW AUS AUT AZE BHS BHR BGD BRB BLR BEL BLZ BEN BMU BTN BOL BES BIH BWA BVT BRA IOT BRN BGR BFA BDI CPV KHM CMR CAN CYM CAF TCD CHL CHN CXR CCK COL COM COG COD COK CRI HRV CUB CUW CYP CZE DNK DJI DMA DOM ECU EGY SLV GNQ ERI EST ETH FLK FRO FJI FIN FRA GUF PYF ATF GAB GMB GEO DEU GHA GIB GRC GRL GRD GLP GUM GTM GGY GIN GNB GUY HTI HMD VAT HND HKG HUN ISL IND IDN IRN IRQ IRL IMN ISR ITA JAM JPN JEY JOR KAZ KEN KIR PRK KOR KWT KGZ LAO LVA LBN LSO LBR LBY LIE LTU LUX MAC MDG MWI MYS MDV MLI MLT MHL MTQ MRT MUS MYT MEX FSM MDA MCO MNG MNE MSR MAR MOZ MMR NAM NRU NPL NLD NCL NZL NIC NER NGA NIU NFK MNP NOR OMN PAK PLW PSE PAN PNG PRY PER PHL PCN POL PRT PRI QAT REU ROU RUS RWA BLM SHN KNA LCA MAF SPM VCT WSM SMR STP SAU SEN SRB SYC SLE SGP SXM SVK SVN SLB SOM ZAF SGS SSD ESP LKA SDN SUR SJM SWE CHE SYR TWN TJK TZA THA TLS TGO TKL TON TTO TUN TUR TKM TCA TUV UGA UKR ARE GBR USA UMI URY UZB VUT VEN VNM VGB VIR WLF ESH YEM ZMB ZWE

Responses

200

The resource was returned successfully

object

id

required

The id of the order create.

string

code

required

Order id in your system.

string

status

required

Order status

string

qrcodeLink

Link image qrCode.

string

qrcodeBase64

Base64 of image qrCode.

string

qrcodeData

String with all pix transaction info needed to be copy and paste into bank app

string

expireDateTime

QrCode expiration DateTime

string

deepLink

Deeplink to open binance app to payment.

string

universalLink

required

Universal url to finish the payment.

string

challengeUrl

Challenge url for 3DS antifraud verification.

string

challengeAccessToken

Challenge access token for 3DS antifraud verification.

string

challengeSetupUrl

Challenge url for 3DS antifraud verification.

string

challengeSetupAccessToken

Challenge access token for 3DS antifraud verification.

string

challengeStatus

Challenge status for 3DS antifraud verification.

string

checkoutLink

Checkout url to finish the payment.

string

token

Order Token

string

fee

Fee

object

fixed

required

Fixed fee amount

object

variable

required

Variable fee amount

object

additional

required

Addictional fee amount

object

errorMessage

Error message

string

amountToPay

required

Final value, which the customer will pay, including fees

string

description

required

Description about the order

string

bankAccount

required

Payment bank account, SPEI only

object

clabe

required

The clabe

string

beneficiary

required

The beneficiary

string

bankCode

required

The bankCode

string

400

The request is not valid

Array<string>

403

Unauthorized Request

Array<string>

500

An unexpected error occurred inside the server

Array<string>