Logo

Documentation v1.0.0

Checkout (BRAZIL)

Call the Checkout API to gives your buyers a simplified and secure checkout experience. SmartFastPay intelligently presents the most relevant payment types to your shoppers, automatically, making it easier for them to complete their purchase using methods like Bank Transfer, PIX, and other payment types..

POST
/transaction/checkout
Request
  
                                                            
                                                                curl -v --location --request POST 'https://sandbox.smartfastpay.com/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",
                                                                        "amount": 4300,
                                                                        "currency": "USD",
                                                                        "callback": "http://mysite.com/api/notification",
                                                                        "transaction": {
                                                                            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
                                                                            "redirect": {
                                                                                "url": "http://mysite.com/success_payment",
                                                                                "type": "URL"
                                                                            }
                                                                        },
                                                                        "payment": {
                                                                            "method": ["pix","boleto","picpay","bank_transfer"]
                                                                        }
                                                                    }'
Parameters details
 
Parameter Type Description
customer_id string
min: 1 | max: 255 		required The customer id stored on your platform for future identification.
branch string
min: 1 | max: 255 		optional When the merchant needs to keep track of its various offices / branch, this field must be fill.
name string
min: 3 | max: 150 		required Name of the customer who started the transaction.
email string
min: 30 | max: 255 		required Email of the customer who started the transaction.
document string
Format: 99999999999 		optional Brazilian document (CPF) of the customer who started the transaction.
- Must be a valid CPF document;
Eg: 12345678909
amount decimal (10,2)
min: 2 		required The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)
Eg: 300.10
currency string (3)
(USD or BRL)
min: 3 | max: 3 		optional The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.

This parameter is optional, if currency isn't provided it will auto-select USD.
Default: USD
callback string
min: 30 | max: 250
(Method: POST) 		required The URL in you site that our API will notify when the payment changes the status, the HTTP supported method should be HTTP
Eg: http://my-url-callback/
transaction
id string
min: 1 | max: 255 		required The id of the transaction generated in you platform.
payment
method array
min: 1 		optional By using this field, our checkout page will only list the payment methods entered here. Allowed: pix, picpay, boleto and bank_transfer
redirect
url string
string
min: 30 | max: 250
 optional Redirect URL that we will set to our "back to website" button after the transaction was completed
type string
(HTML or URL)
min: 0 | max: 10 		optional Return type of the request, if HTML is provided the request will return the HTML of the page, if URL is provided the request will return a URL with that will redirect to the HTML page rendered.
Response (URL)
  
                                                            
                                                                {
                                                                    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
                                                                    "data": {
                                                                        "url": "https://sandbox.smartfastpay.com/v1/cbfc1b2e-b1d7-42c0-8dc5-ffe94d64938e"
                                                                        "transaction_id": "cbfc1b2e-b1d7-42c0-8dc5-ffe94d64938e",
                                                                        "expires_in": 1694786912
                                                                    }
                                                                }
Response (HTML)