Skip to content

Retrieve A Payment Link

HTTP Request

GET /v2/cashier/payment-link/{{linkId}}

Response Body

success
{
    "code": 0,
    "message": "success",
    "data": {
        "linkId": "egGFE9mdsSa6DM5YwNGY5w",
        "orderId": "2022-12-15T14:07:00-01",
        "amount": 9999,
        "currency": "BRL",
        "country": "BR",
        "paymentStatus": "INITIAL_STATUS",
        "paymentDocumentUrl": "https://liquido-payment-link.s3.ap-southeast-1.amazonaws.com/payment-link/liquido/20240604-002.png",
        "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"
        },
        "shippingAddress": {
          "name": "name",
          "countryCode": "BR",
          "province": "province/state",
          "city": "city",
          "postalCode": "04849334",
          "line1": "Address Info",
          "line2": "Address Info"
        },
        "refunded": false,
        "expiredTime": "2023-10-18 09:21:06",
        "createTime": "2023-10-11 09:21:06",
        "updateTime": "2023-10-11 09:21:06",
        "needCollectAddress": true,
        "metadata": {
            "key1": "value1",
            "key2": "value2",
            ...
        }
    }
}
when link id is not exist.
{
    "code": 404,
    "message": "Payment Link not found!",
    "data": {
        "errorMessage": "Payment Link not found!"
    }
}
customer can't submit a payment after 7days(default)
{
    "code": 410,
    "message": "Payment Link is expired!",
    "data": {
        "errorMessage": "Payment Link is expired!"
    }
}

Response Body Parameters

Parameter Type Description
code String Status code of the request.
message String Message about the request status.
data JSON Business data returned for the request.

Object Parameters

Data

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.
paymentDocumentUrl String The document URL for the payment.
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.
shippingAddress JSON Shipping 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
needCollectAddress Boolean True or false.
expiredTime String The expiration time of the payment link.
createTime String The creation time of the payment link.
updateTime String The update time of the payment link.
metadata JSON Merchant reserved field

Data(Error)

Parameter Type Description
errorMessage String Message about the request error.

BillingAddress

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.

ShippingAddress

Parameter Type Description
name String Shipping name.
countryCode String Country code.
province String Province.
city String City.
postalCode String Postal code.
line1 String Address details.
line2 String Address details.

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
Back to top