Overview

Use the Checkout API to generate a secure payment page via SmartFastPay.

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 Overview page, where you'll find all the foundational elements that apply across different countries and methods.

POST /v2/transaction/checkout

Request

curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/transaction/checkout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "12345678909",
                "type": "CPF"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "BRL",
            "amount": 100.00,
        },
        "branch": "YourCompanyOrBranchName",
        "country": "BRA",
        "notification_url": "https://mysite.com/api/notification",
        "redirect_url": "https://mysite.com/success"
    }'

Parameters details

ParameterTypeRequiredDescription

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

The full name of the customer making the payment. It should match the name on the customer's identification documents

customer.email

string

yes

The email address of the customer. This will be used for sending payment confirmations and notifications

customer.document.number

string

yes

The official identification number of the customer. This is typically a national ID, or other government-issued document

customer.document.type

string

yes

The type of document provided by the customer. Common types include national ID, or driver's license. List of documents allowed.

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

The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). List of currency codes.

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

The country code where the transaction is taking place. The format is ISO 3166-1 alpha-3 (e.g., BRA for Brazil). List of country codes.

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

Response

{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "url": "https://sandbox-checkout.smartfastpay.com/v1/cbfc1b2e-b1d7-42c0-8dc5-ffe94d64938e/cGADUcGFK9DJJvbGV0dyxwaXgsYmFua190cmAODHcg==/eyJkf3j982b2N1bWVuJAH8FHXIiOiIxMjM0NTY3ODkka90F8HJR5cGUiOiJDUEYifSwadhugcmEiOltdfQ=="
        "transaction_id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "expires_in": 1722108649
    }
}

Last updated