Skip to content

Boleto

Boleto Payment

Create A Boleto Payment.

HTTP Request

POST /v1/payments/charges/boleto

Request Headers

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Request Body

Request Body
{
    "idempotencyKey": "0bd88f8a-2c7e-4b95-903f-8da45d0e6129",
    "amount": 10000,
    "currency": "BRL",
    "country": "BR",
    "paymentMethod": "BOLETO",
    "paymentFlow": "DIRECT",
    "payer": {
        "name": "Cliente - Isabela",
        "document": {
            "documentId": "51364124025",
            "type": "CPF"
        },
        "email": "testeemail@gmail.com",
        "phone": "+55 81987654321",
        "billingAddress": {  
            "zipCode": "04849333",
            "state": "SP",
            "city": "sao paulo",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "15",
            "complement": "casa",
            "country": "BR"
        }
    },
    "orderInfo": {  
        "orderId": "test-order-id",  
        "shippingInfo": { 
            "name": "shipping test name",  
            "phone": "+55 81987654321",  
            "email": "thiago@example.com",
            "address": { 
                "street": "street name",
                "number": "building number",
                "complement": "unit, apt, etc.",
                "district": "district, neighborhood, etc.",
                "city": "city name",
                "state": "state, state code",
                "zipCode": "zip code, postal code",
                "country": "BR"
            }
        }
    },
    "paymentTerm": {
        "paymentDeadline": 1671194415
    },
    "description": "this is a test pay",
    "callbackUrl": "https://api.client.com/callback/",
    "subMerchantId": "UUID"
}
Parameter Required Type Description
idempotencyKey String Unique key to ensure idempotent requests. given by the merchant in their 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
paymentMethod String payment method, enum value as BOLETO
paymentFlow String payment flow, enum value as DIRECT or REDIRECT
payer JSON payer info
orderInfo JSON order info
riskData JSON risk control info
payerAddress JSON Billing address info. deprecated. The billingAddress field of payer object should be used instead
paymentTerm JSON payment term info, such as payment expired date
description String description of payment
callbackUrl String URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
subMerchantId String The sub merchant ID. Required for PSPs.

Response Body

Content-Type: application/json
{
    "transferStatusCode": 200,
    "transferErrorMsg": "",
    "idempotencyKey": "0bd88f8a-2c7e-4b95-903f-8da45d0e6129",
    "referenceId": "0bd88f8a-2c7e-4b95-903f-8da45d0e6129",
    "paymentMethod": "BOLETO",
    "amount": 10000,
    "currency": "BRL",
    "finalAmount": 10000,
    "finalCurrency": "BRL",
    "country": "BR",
    "createTime": "2022-12-08 08:02:14 UTC",
    "scheduledTime": "2022-12-08 08:02:15 UTC",
    "payer": {
        "name": "Cliente - Isabela",
        "document": {
            "documentId": "51364124025",
            "type": "CPF"
        },
        "email": "testeemail@gmail.com",
        "phone": "+55 81987654321",
        "billingAddress": {
            "street": "Rua 9 de setembro",
            "number": "15",
            "complement": "casa",
            "district": "Jardim Gaivotas",
            "city": "sao paulo",
            "state": "SP",
            "zipCode": "04849333",
            "country": "BR"
        }
    },
    "transferStatus": "IN_PROGRESS",
    "description": "this is a test",
    "callbackUrl": "https://api.liquido.com/v1/cashier/callback/",
    "transferDetails": {
        "boleto": {
            "barcode": "33299919800000100000001110725354807300286435",
            "digitalLine": "33290001151072535480673002864350991980000010000",
            "paymentTerm": {
                "paymentDeadline": 1671194415
            }
        }
    },
    "subMerchantId": "UUID"
}
Parameter Type Description
transferStatus String Transfer status, SETTLED, IN_PROGRESS, FAILED
transferStatusCode int Transfer status code, 200 transaction SETTLED or IN_PROGRESS, other FAILED
transferErrorMsg String Transfer error message if failed
referenceId String Unique key to payment ticket, generated by Liquido.
idempotencyKey String Unique key to ensure idempotent requests. given by the merchant in their system
amount Long The transfer amount
country String country code
currency String The currency code of the transferred fund
finalAmount String The final amount that is used for creating the charge order. EX: for charge orders with FX conversion, this field represents the converted amount from the original requested amount.
finalCurrency String The currency code of the finalAmount.
paymentMethod String payment method, enum value as BOLETO
paymentFlow String payment flow, enum value as DIRECT or REDIRECT
payer JSON payer info
transferDetails JSON transaction details info
description String description of payment
callbackUrl String URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
createdDate String Payment ticket created time
scheduledTime String Payment ticket scheduled time
finalStatusTime String Transfer final status update time, final status include SETTLED, FAILED
subMerchantId String The sub merchant ID.

Notification / Callback

Content-Type: application/json
{
    "eventType": "CHARGE_SUCCEEDED",
    "data":  {
        "chargeDetails": {
            "transferStatusCode": 200,
            "transferErrorMsg": "",
            "idempotencyKey": "0bd88f8a-2c7e-4b95-903f-8da45d0e6129",
            "referenceId": "0bd88f8a-2c7e-4b95-903f-8da45d0e6129",
            "paymentMethod": "BOLETO",
            "amount": 10000,
            "currency": "BRL",
            "finalAmount": 10000,
            "finalCurrency": "BRL",
            "country": "BR",
            "createTime": "2022-12-08 08:02:14 UTC",
            "scheduledTime": "2022-12-08 08:02:15 UTC",
            "finalStatusTime": "2022-12-08 08:47:02 UTC",
            "payer": {
                "name": "Cliente - Isabela",
                "document": {
                    "documentId": "51364124025",
                    "type": "CPF"
                },
                "email": "testeemail@gmail.com",
                "phone": "+55 81987654321",
                "billingAddress": {
                    "street": "Rua 9 de setembro",
                    "number": "15",
                    "complement": "casa",
                    "district": "Jardim Gaivotas",
                    "city": "sao paulo",
                    "state": "SP",
                    "zipCode": "04849333",
                    "country": "BR"
                }
            },
            "transferStatus": "SETTLED",
            "description": "this is a test",
            "callbackUrl": "https://api.liquido.com/v1/cashier/callback/",
            "transferDetails": {
                "boleto": {
                    "barcode": "33299919800000100000001110725354807300286435",
                    "digitalLine": "33290001151072535480673002864350991980000010000",
                    "paymentTerm": {
                        "paymentDeadline": 1671194415
                    }
                }
            },
            "subMerchantId": "UUID"
        }
    }
}

Object Parameters

Payer

Parameter Required Type Description
name String fullname(Input specification: Only a combination of uppercase and lowercase letters, numbers and spaces is allowed. Spanish and Portuguese letters, and other special characters are not allowed).
email String email.
phone String Mobile phone number. Should include “+55” as a prefix.
document JSON CPF or CNPJ is required in Brazil.
billingAddress JSON Billing address info.

Document

Parameter Required Type Description
documentId String identity number
type String enum of CPF or CNPJ

OrderInfo

Parameter Required Type Description
orderId String order identity number
shippingInfo JSON shipping info

ShippingInfo

Parameter Required Type Description
name String shipping name
phone String Mobile phone number. Should include “+55” as a prefix.
email String email address
address JSON the same as billingAddress

RiskData

Parameter Required Type Description
ipAddress String Cardholder's full name.

Address

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.

PaymentTerm

Parameter Required Type Description
paymentDeadline Long timestamp of seconds, payment dead line should within 5years

TransferDetails

Parameter Type Description
boleto JSON boleto detail info

Boleto

Parameter Type Description
barcode String barcode
digitalLine String digitalLine
paymentTerm JSON payment term info, such as payment expired date

PaymentTerm(Response)

Parameter Type Description
paymentDeadline Long timestamp of seconds, payment dead line

Transfer Status

Parameter Description
IN_PROGRESS The transaction of this method has started, but no transactions have been processed yet.
SETTLED The funds of the transaction of this payment have been transferred to the store.
REFUNDING The transaction of this payment is refunding.
REFUNDED The transaction of this payment method has been refunded.
FAILED There was an error while processing the transaction of this payment. This status is followed by a message with more details about the error.

Notification Event Type

CHARGE_SUCCEEDED,
CHARGE_FAILED,
CHARGE_CHARGED_BACK,
CHARGE_REFUND_SUCCEEDED,
CHARGE_REFUND_FAILED;

Boleto Receipt PDF

A receipt PDF can be downloaded after created a payment.

HTTP Request

GET /v1/payments/files/boleto/pdf/{idempotency_key}

Request Parameters

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

Response Body Parameters

Parameter Required Type Description
path String A PDF file link for receipt

PDF Example

voucher

Back to top