Skip to content

Retrieve a Refund

HTTP Request

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

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Content-Type: application/json
{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "2022030214000007-1",
    "referenceId": "2022030214000007",
    "paymentMethod": "CARD",
    "amount": 300,
    "currency": "HNL",
    "country": "HN",
    "finalAmount": 300,
    "finalCurrency": "HNL",
    "createTime": "2022-03-01 21:18:56 GMT-08:00",
    "scheduledTime": "2022-03-01 21:18:56 GMT-08:00",
    "finalStatusTime": "2022-03-01 21:18:57 GMT-08:00",
    "payer": {
        "document":{
            "documentId":"0801199012345",
            "type":"DNI"
        },
        "name": "username",
        "email": "username@liquido.com",
        "phone": "+50481987654321",
        "billingAddress": {  
            "zipCode": "1001",
            "state": "Buenos Aires",
            "city": "Buenos Aires",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "5940",
            "complement": "casa",
            "country": "HN"
        }
    },
    "transferStatus": "SETTLED",
    "description": "refund test",
    "callbackUrl": "https://api.client.comcallback/"
}

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 refund

Response Body Details

Parameter Type Description
idempotencyKey String idempotencyKey of refund record, generate by merchant.
referenceId String idempotencyKey of the payment which need to refund.
amount Long The refund amount
country String country code
currency String The currency code of the refund
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.
description String reason for refund
callbackUrl String URL where Liquido will send notifications associated to changes to this refund.
createTime String refund ticket created time
scheduledTime String refund ticket scheduled time
finalStatusTime String refund final status update time, final status include SETTLED, FAILED
transferStatus String refund status, SETTLED, IN_PROGRESS, FAILED
transferStatusCode Integer refund status code, 200 transaction SETTLED or IN_PROGRESS, other FAILED
transferErrorMsg String refund error message if failed
Back to top