Retrieve A Payment Link
HTTP Request
GET
/v2/cashier/payment-link/{linkId}
Response Body
Request Body{
"code": 0,
"message": "success",
"data": {
"linkId": "egGFE9mdsSa6DM5YwNGY5w",
"orderId": "2022-12-15T14:07:00-01",
"amount": 9999,
"currency": "BRL",
"country": "BR",
"paymentStatus": "INITIAL_STATUS",
"callbackUrl": "https://your-domain/callback/",
"redirectUrl": "https://your-domain/checkout-page",
"description": "this is a test payment",
"finalPaymentMethod": null,
"finalStatusTimestamp": 0,
"finalStatusTime": null,
"refundAmount": null,
"refundStatus": "INITIAL_STATUS",
"refundTime": null,
"refundTimestamp": 0,
"name": "buyer name",
"email": "liquido-test@gmail.com",
"phone": "+5511999999999",
"documentId": "51364124025",
"merchant": {
"name": null,
"logo": null
},
"transferDetails": {
"pix": null,
"boleto": null,
"bankTransfer": null,
"payCash": null,
"pse": null
},
"allowPaymentMethods": [
"CREDIT_CARD",
"PIX",
"BOLETO",
"BANK_TRANSFER_BR"
],
"billingAddress": {
"zipCode": "04849333",
"state": "SP",
"city": "sao paulo",
"district": "Jardim Gaivotas",
"street": "Rua 9 de setembro",
"number": "15",
"country": "BR",
"complement": "casa"
},
"refunded": false
}
}
Response Body Parameters
Parameter |
Type |
Description |
linkId |
String |
Unique payment link id in liquido. |
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. Supported Payment Methods see here |
paymentStatus |
String |
Payment status, enum value as: INITIAL_STATUS, IN_PROGRESS, SETTLED. |
finalPaymentMethod |
String |
The payment method for user to complete payment. |
finalStatusTime |
String |
The datetime for user to complete payment. date format: "yyyy-MM-dd HH:mm:ss", timezone: UTC |
finalStatusTimestamp |
Long |
The timestamp for user to complete payment. |
refundTime |
String |
The datetime of complete refund. it is null when "refunded" is false. date format: "yyyy-MM-dd HH:mm:ss", timezone: UTC |
refundTimestamp |
Long |
The timestamp of complete refund. it is 0 when "refunded" is false. |
refunded |
Boolean |
If true,meaning the payment has been refunded. |
refundAmount |
Long |
The refund amount, The minimum settlement granularity of the current currency, such as 100=1BRL |
refundStatus |
String |
The refund status, enum value as: INITIAL_STATUS, IN_PROGRESS, SETTLED, FAILED. |
name |
String |
Customer's name |
email |
String |
Customer's email |
phone |
String |
Mobile phone number, must start with country calling codes, such as "+55". |
documentId |
String |
Resident ID number, such as CPF/CNPJ in Brazil. Does not contain separator characters. |
billingAddress |
Address Object |
Billing address info. |
callbackUrl |
String |
When the payment link status changed. liquido will send a post http request to the callback url. |
redirectUrl |
String |
When the payment completed. payment link will redirect to redirectUrl if it is not null. |
description |
String |
Description of payment |
transferDetails |
Object |
Transfer Details of payment. the details as same as "transferDetails" in Payin API |
BillingAddress Object Parameters
Parameter |
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. |
TransferDetails Object Parameters
Parameter |
Type |
Description |
pix |
JSON |
pix detail info |
boleto |
JSON |
boleto detail info |
bankTransfer |
JSON |
The bank transfer details |
Pix
Parameter |
Type |
Description |
qrCode |
String |
barcode of pix order |
qrCodeType |
String |
enum value of STATIC, DYNAMIC |
expirationTime |
String |
expired time |
Boleto
Parameter |
Type |
Description |
barcode |
String |
barcode |
digitalLine |
String |
digitalLine |
paymentTerm |
JSON |
payment term info, such as payment expired date |
PaymentTerm
Parameter |
Type |
Description |
paymentDeadline |
Long |
timestamp of seconds, payment dead line should within 5years |
BankTransfer
Parameter |
Type |
Description |
expirationTime |
String |
The expiration time of the payment |
bankAccountInfo |
JSON |
The information of bank account |
BankAccountInfo
Parameter |
Type |
Description |
bankCode |
String |
The bankcode of the bank, 3 digits |
beneficiaryName |
String |
The beneficiary name, such as BRL_LIQUIDO |
bankAccountNumber |
String |
The beneficiary bank account number |
bankBranchId |
String |
The beneficiary bank branch Id |
bankAccountType |
String |
The beneficiary bank account type, such as ContaCorrente |
ispb |
String |
The ISPB of the bank, used in the same way as the shorter bank code, 8 digits |
document |
JSON |
payer's identity proof, CPF or CNPJ |