Skip to content

Create A Payment Link

HTTP Request

POST /v2/cashier/payment-link/

Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Body
{
    "orderId": "2022-12-15T14:07:00-01",
    "amount": 9999,
    "currency": "BRL",
    "country": "BR",
    "allowPaymentMethods": [
        "CREDIT_CARD",
        "PIX",
        "BANK_TRANSFER_BR",
        "BOLETO"
    ],
    "name": "buyer name",
    "email": "liquido-test@gmail.com",
    "phone": "+5511999999999",
    "documentId": "51364124025",
    "billingAddress": {
        "zipCode": "04849333",
        "state": "SP",
        "city": "sao paulo",
        "district": "Jardim Gaivotas",
        "street": "Rua 9 de setembro",
        "number": "15",
        "complement": "casa",
        "country": "BR"
    },
    "callbackUrl": "https://your-domain/callback/",
    "redirectUrl": "https://your-domain/checkout-page",
    "description": "this is a test payment"
}
Content-Type: application/json
{
    "paymentLink": "https://buy.liquido.com/{linkId}",
    "linkId": "{linkId}"
}

Supported Payment Methods

Payment Method Country Limit Important Note
CREDIT_CARD BR, MX, CO
PIX BR
BOLETO BR >= 5BRL
BANK_TRANSFER_BR BR
BANK_TRANSFER_MX MX
PAY_CASH MX, CO <= 10,000 MXN or <= 3,000,000 COP
PSE CO >= 1500 COP name, phone and email are required.
NEQUI CO >= 1500 COP name, phone and email are required.

Request Headers Parameters

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

Request Body Parameters

Parameter Required Type Description
orderId String Unique order id in merchant system.
amount Long The transfer amount, The minimum settlement granularity of the current currency, such as 100=1BRL
country String Country code
currency String The currency code of the transferred fund
allowPaymentMethods List Declare which payment methods are included in the payment link, not null. The order of payment methods display should be consistent with the order from allowPayMethods. Supported Payment Methods see here
name String User full name(less than or equal to 50 characters). If you previously collected customer's name ahead of the payment process, you can pass a customer’s name into payment link. This information will autofill the payment form.
email String Less than or equal to 64 characters. If you previously collected customer's email ahead of the payment process, you can pass a customer’s email into payment link. This information will be used for risk control
phone String Mobile phone number, must start with country calling codes, such as "+55". If you previously collected customer's phone ahead of the payment process, you can pass it into payment link. This information will be used for risk control
documentId String Resident ID number, such as CPF/CNPJ in Brazil. Does not contain separator characters.
billingAddress Address Object Billing address info. If you previously collected customer's billing address ahead of the payment process, you can pass it into payment link. This information will autofill the Boleto payment form
callbackUrl String When the payment link status changed. liquido will send a post http request to the callback url. details see here
redirectUrl String When the payment completed. payment link will redirect to redirectUrl if it is not null.
description String Description of payment

BillingAddress Object Parameters

Parameter Required Type Description
zipCode String zip code. such as CEP in Brazil
state String state. should be abbreviation, such as SP in Brazil
city String city name.
district String district name.
street String street name.
number String street number.
complement String complement info.
country String country code.

Response Body Parameters

Parameter Type Description
paymentLink String the payment link which hosted in liquido.
linkId String unique id of the payment link in liquido.
Back to top