Skip to content
Gowd Platform

Create Checkout - V1

Deprecated
PUT
/order/v1/checkout

Create a Checkout link for payment

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “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

Section titled “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
Example
John Doe
type
required

The type of entity that owns the account.

string
Allowed values: INDIVIDUAL ORGANIZATION
Example
INDIVIDUAL
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
Example
CPF
number
required

The number in the document.

string
Example
81985010020
email
required

The e-mail address of the Customer.

string
Example
John.doe@acme.com
phone
required

The phone number of the Customer.

string
Example
+14154891022
birth

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

string
Example
1984-03-16
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
Example
BRA
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
Example
order_id_in_your_system
amount
required

Amount of the order.

object
currency
required

Currency

string
Allowed values: BRL USD USDT BUSD
Example
BRL
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
Example
10.95
paymentMethod
required

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

string
Allowed values: CREDIT_CARD
Example
CREDIT_CARD
use3ds
required

Whether to use 3D Secure for the order.

boolean
additionalInfo
required

Some description of your order as String.

string
Example
Buy credit for the game
webhookUrl
required

The URL for order notification.

string
Example
http://www.yourserver.com/my_notification_endpoint
redirectUrl
required

The URL for order return after payment Done

string
Example
http://www.yourwebsite.com/payment_done
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
Example
2026-03-19T14:30:00.000Z
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
Example
BRA

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource was returned successfully

object
id
required

The id of the order create.

string
Example
de05f0db-e6a3-462e-8f1c-8dc8dd07c278
code
required

Order id in your system.

string
Example
order_id_in_your_system
status
required

Order status

string
Example
INITIAL
qrcodeLink

Link image qrCode.

string
Example
https://public.bnbstatic.com/static/payment/20221217/cf16107e-cb98-4dca-9dcb-1ce2aa814057.jpg
qrcodeBase64

Base64 of image qrCode.

string
Example
/9j/4AAQ8DaxNqel3eoyzy27W7LdSIy7SytkbUU5yg7+td9QAUUUUAFFFFABRRRQAooooAKKKKACiiigD/2Q==
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
Example
bnc://app.binance.com/payment/secpay?tempToken=R1iUiVRLcMXPboLsiU8KkLytFgUI40MA&returnLink=https://pay.binance.com/en/checkout/bcba8fa221cf4aea9f2822a8865ed1ce
universalLink
required

Universal url to finish the payment.

string
Example
https://app.binance.com/payment/secpay?linkToken=a0f04c0786464e818d13c3c16efec196&_dp=Ym5jOi8vYXBwLmJpbmFuY2UuY29tL3BheW1lbnQvc2VjcGF5P3RlbXBUb2tlbj1GR3FNRE10bDJaNGFkMzlsN0J1VjU5Zm9qYTNHalMxNyZyZXR1cm5MaW5rPWh0dHBzOi8vcGF5LmJpbmFuY2UuY29tL2VuL2NoZWNrb3V0L2EwZjA0YzA3ODY0NjRlODE4ZDEzYzNjMTZlZmVjMTk2
challengeUrl

Challenge url for 3DS antifraud verification.

string
Example
https://test.redpayonline.com/pay/review/eadd3d34-5bc7-4
challengeAccessToken

Challenge access token for 3DS antifraud verification.

string
Example
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
challengeSetupUrl

Challenge url for 3DS antifraud verification.

string
Example
https://test.redpayonline.com/pay/review/eadd3d34-5bc7-4
challengeSetupAccessToken

Challenge access token for 3DS antifraud verification.

string
Example
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
challengeStatus

Challenge status for 3DS antifraud verification.

string
Example
PENDING
checkoutLink

Checkout url to finish the payment.

string
Example
https://pay.binance.com/en/checkout/35829f34bc214f6c83f4c23fa3baaa49
token

Order Token

string
Example
28878A179CB25212A9F4B4DF8E5BC951D719499R
fee

Fee

object
fixed
required

Fixed fee amount

object
Example
1.00
variable
required

Variable fee amount

object
Example
1.00
additional
required

Addictional fee amount

object
Example
1.00
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

Section titled “400 ”

The request is not valid

Array<string>

403

Section titled “403 ”

Unauthorized Request

Array<string>

500

Section titled “500 ”

An unexpected error occurred inside the server

Array<string>