Overview
Use the Checkout API to generate a secure payment page via SmartFastPay.
Last updated
Use the Checkout API to generate a secure payment page via SmartFastPay.
Last updated
The parameters provided here are mandatory for creating the payment link, ensuring that relevant payment methods like Bank Transfer, PIX, PSE, Deuna, and more are automatically presented to shoppers. In addition to the required parameters, we offer optional fields that can be included to enhance the user experience. These fields allow pre-filled information, such as address, documents, and other personal data, to be automatically transferred, preventing users from having to re-enter them when they reach our payment page.
To access the complete and detailed list of all available parameters, including optional ones, please refer to the page, where you'll find all the foundational elements that apply across different countries and methods.
customer.id
string
yes
Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer
customer.name
string
yes optional on (v2/transaction/checkout)
The full name of the customer making the payment. It should match the name on the customer's identification documents
customer.email
string
yes optional on (v2/transaction/checkout)
The email address of the customer. This will be used for sending payment confirmations and notifications
customer.document.number
string
yes optional on (v2/transaction/checkout)
The official identification number of the customer. This is typically a national ID, or other government-issued document
customer.document.type
string
yes optional on (v2/transaction/checkout)
transaction.id
string
yes
A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process
transaction.currency
string
yes
transaction.amount
decimal
(10,2)
yes
The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)
Eg: 300.10
branch
string
no
The specific branch or location identifier where the transaction is being processed, if applicable
country
string
yes
payment_method
array
yes
The method of payment being used for the transaction, such as bank transfer, credit card...
notification_url
string
yes
The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format
redirect_url
string
no
The URL to which the customer will be redirected after completing the payment. This parameter is optional and typically used for providing a success or failure page
The type of document provided by the customer. Common types include national ID, or driver's license. .
The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). .
The country code where the transaction is taking place. The format is ISO 3166-1 alpha-3 (e.g., BRA for Brazil).