Create Transparent Order - V1
PUT /order/v1/transparent
The transaction is called transparent as it has no interface and/or screen that your customer should interact with.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”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
The customer of the order.
object
The name of the customer, e.g.: [John Doe] or [Acme Corporation].
The type of entity that owns the account.
The document of the Customer.
object
Type of document, used when providing an ID number.
----------------------------
Brasil
----------------------------
CPF
CNPJ
OTHERS
----------------------------
Mexico
----------------------------
CURP,
RFC
The number in the document.
The e-mail address of the Customer.
The phone number of the Customer.
The date of birth or foundation, in ISO-8601 YYYY-MM-DD format.
The country of the Merchant
Address.
object
State.
City.
Street.
Neighborhood.
Number.
Complement.
Postal code.
IP.
The order details.
object
Order reference in your system.
Payment method
Brazil - BRL
- PIX: Instant payment method
- BINANCE_PAY: Crypto payment
- DEPOSIT: Bank transfer (optional
bankSlugfield for specific bank selection) - BOLETO: Brazilian bank slip
Mexico - MXN
- CREDIT_CARD: Credit card payment
- SPEI: Electronic transfer
- OXXO: Cash payment at OXXO stores
- OXXOPAY: OXXO digital wallet
- PAYNET: PayNet payment method
Amount of the order.
object
Currency
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
Some description of your order as String.
The URL for order notification.
The URL for order return after payment Done
The financial partner of the order
PIX QRCode expiration limit, with granularity of seconds. This field should only be used to generate dynamic PIX QRCodes. If not filled in, the default value will be 86400 seconds, equivalent to 24 hours.
Special payment details.
object
3DS authentication token (payment method nonce) returned after completing the 3-D Secure flow. Required by partners such as PayPal/Redpay for credit card payments.
Tokenized card identifier produced by the card-tokenization process. Use when the payment method expects a stored card token instead of raw card data.
Credit card data. Use skipThreeDSecure field to control 3DS behavior.
object
Card holder name
Card holder document masked with first 3 digits visible (CPF: 11 digits total, CNPJ: 14 digits total)
Credit card number
Card security code (CVV)
Card expiration date (MM/YY format)
Card brand (e.g., Visa, Mastercard, Amex, etc.)
Number of installments
Whether to skip 3DS authentication
Number of installments for credit card payments.
Browser data for 3DS authentication.
object
Bank identifier for DEPOSIT payments. Optional — if omitted, the default bank will be used. Available banks at GET /v1/orders/deposit/banks.
The merchant of the order.
object
The name of the Merchant.
The document of the Merchant.
object
Type of document, used when providing an ID number.
The number in the document.
The country of the Merchant
Responses
Section titled “ Responses ”The resource was returned successfully
object
The id of the order create.
Order id in your system.
Order status
Link image qrCode.
Base64 of image qrCode.
String with all pix transaction info needed to be copy and paste into bank app
QrCode expiration DateTime
Deeplink to open binance app to payment.
Universal url to finish the payment.
Challenge url for 3DS antifraud verification.
Challenge access token for 3DS antifraud verification.
Challenge url for 3DS antifraud verification.
Challenge access token for 3DS antifraud verification.
Challenge status for 3DS antifraud verification.
Checkout url to finish the payment.
Order Token
Fee
object
Fixed fee amount
object
Variable fee amount
object
Addictional fee amount
object
Error message
Final value, which the customer will pay, including fees
Description about the order
Payment bank account, SPEI only
object
The clabe
The beneficiary
The bankCode
The request is not valid
Unauthorized Request
An unexpected error occurred inside the server