Skip to content

Create A Card

Stores a card's information on Liquido's servers, and returns a card ID that can later be used to make payments.

HTTP Request

POST /v1/payments/vault/card

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "country": "BR",
    "card": {
        "cardHolderName": "card_holder_name",
        "cardNumber": "4242424242424242",
        "expirationMonth": "09",
        "expirationYear": "2024",
        "cvc": "123"
    }
}
Response
{
    "cardId": "123121123",
    "card": {
        "cardHolderName": "card_holder_name",
        "expirationMonth": 9,
        "expirationYear": 2024,
        "brand": "VISA",
        "bin": "458124",
        "last4": "0000"
    }
}

HTTP Headers Details

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Request Body Parameters

Parameter Required Type Description
country String Country code.
card JSON Card info.

Card Object Parameters

Parameter Required Type Description
cardHolderName String Cardholder's full name.
cardNumber String 16 digit number of the card, as a string without any separators.
cvc String Credit card verification code.
expirationMonth String 2 digit numbers representing the card's expiration month.
expirationYear String 4 digit numbers representing the card's expiration year.

Response Body Parameters

Parameter Type Description
cardId String The card ID received when saving the card.
card JSON Card detail info.

Card Object in response Parameters

Parameter Type Description
cardHolderName String Cardholder's full name.
bin String first 6 digit number of the card
last4 String last 4 digit number of the card
brand String Credit card brand. such as VISA, MASTERCARD
expirationMonth Integer 1 or 2 digit number(s) representing the card's expiration month.
expirationYear Integer 4 digit numbers representing the card's expiration year.

Create A Credit Card Payment With Card id

HTTP Request

POST /v1/payments/charges/card

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "amount": 100000,
    "currency": "BRL",
    "country": "BR",
    "paymentMethod": "CREDIT_CARD",
    ...  # other basic request fields
    "cardId": "8736453a-dad0-4f26-85f0-95e8787d0237",
}
Response
{
    "transferStatusCode": 200,
    "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "referenceId": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "paymentMethod": "CREDIT_CARD",
    "amount": 100000,
    "currency": "BRL",
    "finalAmount": 100000,
    "finalCurrency": "BRL",
    "country": "BR",
    ...  # other basic response fields
    "transferDetails": {
        "card": {
            "cardInfo": {
                "cardHolderName": "card_holder_name",
                "expirationMonth": 9,
                "expirationYear": 2024,
                "brand": "VISA",
                "bin": "458124",
                "last4": "0000"
            },
            "cardId": "8736453a-dad0-4f26-85f0-95e8787d0237"
        }
    },
}
Back to top