Credit Card

Call the Credit Card API to request payments via Credit Card.

---

POST /v1/credit_card

Request

curl -v --location --request POST 'https://sandbox.smartfastpay.com/v1/credit_card' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer < Access-Token >' \
    --data-raw '{
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "name": "Richard Roe",
        "email": "[e-mail]",
        "document": "16972691419",
        "amount": 300,
        "currency": "BRL",
        "max_installments": 4,
        "callback": "http://mysite.com/api/notification",
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277"
            "redirect": {
                "url": "http://mysite.com/success_payment"
            }
        }
    }'

Parameters details

Parameter	Type	Required	Description
customer_id	string min: 1 | max: 255	yes	The customer id stored on your platform for future identification.
branch	string min: 1 | max: 255	no	When the merchant needs to keep track of its various offices / branch, this field must be fill.
name	string min: 3 | max: 150	yes	Name of the customer who started the transaction.
email	string min: 30 | max: 255	yes	Email of the customer who started the transaction.
document	string Format: 99999999999	yes	Brazilian document (CPF) of the customer who started the transaction. - Must be a valid CPF document; Eg: 12345678909
amount	decimal (10,2) min: 2	yes	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	no	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
max_installments	numeric min: 1 | max: 12	yes	Determine the maximum number of installments allowed
callback	string min: 30 | max: 250 (Method: POST)	yes	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	yes	The id of the transaction generated in you platform.
redirect
url	string min: 30 | max: 250	no	After completing a transaction, we will redirect to this link if it exists.

Response

{
    "requestId": "2840429ae5547ede3850f7464ec3a1cd\15166459175723748126;o=1",
    "data": {
        "id": "11acb6a4-ea1d-4bf6-a87d-3f7b5c0340f9",
        "status": "pending",
        "expires_in": 1681219918,
        "payment": {
            "method": "credit_card"
        },
        "values": {
            "total": "28.00",
            "subtotal": "28.00",
            "exchange": "1.00",
            "fee": 0
        },
        "credit_card": {
            "url": "https:\\app.credit-card.com\checkout\NjQzNTVhNDc3OWNiYzk0MTBjN2ViMWU2"
        }
    }
}

Response details

Parameter	Description
id	The created payment by the request made unique identificator. Can be used to verify the payment status in the GET /v1/payment/{id} endpoint
status	The current status of the payment. These are our statuses: pending, paid, denied, expired
expires_in	Limit date to receive the payment
payment
method	credit_card
values
total	The full value of the transaction, including service fees. Decimal separator it a dot
subtotal	The value of the transaction, without service fees. Decimal separator it a dot
exchange	The exchange rate applied to the current transaction
fee	The service fee value
credit_card
url	String to open credit card checkout.