Skip to content

Retrieve a Payment

HTTP Request

GET /v1/payments/charges/{{idempotencyKey}}

Request Headers
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
    "transferStatusCode": 200,
    "idempotencyKey": "1ec983fa-1c37-679b-809b-067861d8700019",
    "referenceId": "1ec983fa-1c37-679b-809b-067861d8700019",
    "paymentFlow": "DIRECT",
    "paymentMethod": "WEB_PAY",
    "amount": 1000,
    "currency": "CLP",
    "finalAmount": 1000,
    "finalCurrency": "CLP",
    "country": "CL",
    "createTime": "2023-05-30 00:37:42 GMT-07:00",
    "scheduledTime": "2023-05-30 00:37:44 GMT-07:00",
    "finalStatusTime": "2023-05-30 00:37:44 GMT-07:00",
    "payer": {
        "name": "Juan Garcia",
        "document": {
            "documentId": "530315550",
            "type": "RUT"
        "email": ""
    "transferStatus": "IN_PROGRESS",
    "description": "this is a test pay",
    "callbackUrl": "",
    "transferDetails": {
        "webPay": {
            "paymentUrl": "",
            "redirectUrl": ""
HTTP Headers Details
Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}
Path and Query Parameters
Parameter Type Description
idempotencyKey String The idempotency key of the transaction
Response Body Details
Parameter Type Description
transferStatus String Transfer status, SETTLED, IN_PROGRESS, FAILED
transferStatusCode Integer 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. 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
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.
createTime String Payment ticket created time
scheduledTime String Payment ticket scheduled time
finalStatusTime String Transfer final status update time, final status include SETTLED, FAILED
TransferDetails Object Parameters
Parameter Type Description
webPay JSON The webPay details

WebPay Object Parameters

Parameter Type Description
paymentUrl String URL for payment
redirectUrl String URL where Liquido will redirect to after the payment is finished

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.
CHARGED_BACK The transaction of this payment has been reported as chargeback.
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.
Back to top