{"idempotencyKey":"0bd88f8a-2c7e-4b95-903f-8da45d0e6129","amount":10000,"currency":"BRL","country":"BR","paymentMethod":"BOLETO","paymentFlow":"DIRECT","payer":{"name":"Cliente - Isabela","document":{"documentId":"51234567890","type":"CPF"},"email":"testeemail@gmail.com","phone":"+5581987654321","billingAddress":{"zipCode":"04794000","state":"SP","city":"Sao Paulo","district":"Vila Gertrudes","street":"Avenida das Nacoes Unidas","number":"14401"}},"orderInfo":{"orderId":"test-order-id","orderReferenceNumber":"test-order-reference-number","shippingInfo":{"name":"shipping test name","phone":"+5581987654321","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":1765335600,"fine":{"value":0.02,"type":"RATE","startDate":1764039600},"dueDate":1763953200},"description":"this is a test pay","callbackUrl":"https://api.client.com/callback/","subMerchantId":"UUID"}
Create a Boleto payment with REDIRECT payment flow¶
Request Body
{"idempotencyKey":"0bd88f8a-2c7e-4b95-903f-8da45d0e6129","amount":10000,"currency":"BRL","country":"BR","paymentMethod":"BOLETO","paymentFlow":"REDIRECT","payer":{"name":"Cliente - Isabela","document":{"documentId":"51234567890","type":"CPF"},"email":"testeemail@gmail.com","phone":"+5581987654321","billingAddress":{"zipCode":"04794000","state":"SP","city":"Sao Paulo","district":"Vila Gertrudes","street":"Avenida das Nacoes Unidas","number":"14401"}},"orderInfo":{"orderId":"test-order-id","orderReferenceNumber":"test-order-reference-number","shippingInfo":{"name":"shipping test name","phone":"+5581987654321","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":1765335600,"fine":{"value":0.02,"type":"RATE","startDate":1764039600},"dueDate":1763953200},"description":"this is a test pay","callbackUrl":"https://api.client.com/callback/","subMerchantId":"UUID","merchantRedirectInfo":{"merchantPageUrl":"https://www.merchantpageexample.com/123456"}}
Content-Type: application/json
{"transferStatusCode":200,"transferErrorMsg":"","idempotencyKey":"0bd88f8a-2c7e-4b95-903f-8da45d0e6129","referenceId":"0bd88f8a-2c7e-4b95-903f-8da45d0e6129","paymentMethod":"BOLETO","paymentFlow":"REDIRECT","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":"51234567890","type":"CPF"},"email":"testeemail@gmail.com","phone":"+5581987654321","billingAddress":{"zipCode":"04794000","state":"SP","city":"Sao Paulo","district":"Vila Gertrudes","street":"Avenida das Nacoes Unidas","number":"14401"}},"transferStatus":"IN_PROGRESS","description":"this is a test","callbackUrl":"https://api.liquido.com/v1/cashier/callback/","transferDetails":{"boleto":{"barcode":"33299919800000100000001110725354807300286435","digitalLine":"33290001151072535480673002864350991980000010000","paymentTerm":{"paymentDeadline":1765335600,"fine":{"value":0.02,"type":"RATE","startDate":1764039600},"dueDate":1763953200}}},"subMerchantId":"UUID","redirectUrl":"https://www.redirect-qa.liquido.com?uid=ZddGZfCB6OergiZ","merchantRedirectInfo":{"merchantPageUrl":"https://www.merchantpageexample.com/123456"}}
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
Long
The final amount that is used for creating the charge order. e.g., for charge orders with FX conversion, this field represents the converted amount from the original requested amount.
URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
createTime
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.
redirectUrl
String
The URL where you must redirect your customer to complete the payment. It will be included in the response when “paymentFlow” is “REDIRECT” in the request parameters.
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.
zip code. such as CEP in Brazil, must be 8-digit number.
state
String
state. should be abbreviation, such as SP in Brazil, Length 2 characters. Available value: AC,AL,AP,AM,BA,CE,DF,ES,GO,MA,MT,MS,MG,PA,PB,PR,PE,PI,RJ,RN,RS,RO,RR,SC,SP,SE,TO
city
String
city name. The length must be between 2 and 30 characters.
district
String
district name. The length is no more than 50 characters.
street
String
street name. The length is no more than 100 characters.
number
String
street number. The length is no more than 8 characters.
complement
String
complement info. The length is no more than 50 characters.
BOLETO can no longer be paid after this date. Unix timestamp in seconds, will be processed to the precision of a day in BR timezone, should be greater than the current date in BR timezone and within 5 years. e.g., 1765335600 corresponds to 2025-12-10(BR timezone)
dueDate
Long
The final date for completing payment to avoid late fees. Unix timestamp in seconds, will be processed to the precision of a day in BR timezone, should be greater than the current date in BR timezone and less than or equal to the payment deadline. e.g., 1763953200 corresponds to 2025-11-24(BR timezone) This is required when the fine (for Boleto) is applied.
fine
JSON
configuration related to penalty interest for overdue BOLETO payments. Please contact your account manager before using this function
The fine calculation type, currently supported enumeration value "RATE", indicates that the fine is calculated as a percentage of the transaction amount.
startDate
Long
BOLETO penalty interest effective date. Unix timestamp in seconds, will be processed to the precision of a day in BR timezone, should be greater than the due date. e.g., 1764039600 corresponds to 2025-11-25(BR timezone)
value
Double
The rate of the fine, a decimal value, e.g., 0.02 = 2%
It is a URL that redirects to merchant page. It should be include when you need Liquido to redirect your customers back to your page after customers finish payments. This URL can only be set when ‘paymentFlow’ is ‘REDIRECT’ in the payment request.
