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}}"
}
Response
{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "2022030214000007-1",
    "referenceId": "2022030214000007",
    "paymentMethod": "CREDIT_CARD",
    "amount": 300,
    "currency": "COP",
    "country": "CO",
    "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:58 GMT-08:00",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "document" : "88712345",
        "phone": "+57 3123456789",
        "billingAddress": {  
            "zipCode": "111111",
            "state": "Cundinamarca",
            "city": "Bogotá",
            "street": "Apartamento 502, Torre I",
            "number": "Calle 34 # 56 - 78"
        }
    },
    "transferStatus": "SETTLED",
    "description": "refund test",
    "callbackUrl": "https://api.client.com/callback/"
}
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 Unique key of refund record.
referenceId String Unique key of payment record which refunded.
amount Long The refund amount
country String country code
currency String The currency of the transferred fund
createTime String The creation time of refund request
scheduledTime String Transfer ticket scheduled time
finalStatusTime String The settled or failed time of refund transaction
transferStatus String Transfer status, SETTLED, IN_PROGRESS, FAILED
transferStatusCode Integer Transfer status code, 200 transaction SETTLED or IN_PROGRESS or FAILED
transferErrorMsg String Transfer error message if failed

Object Parameters

Payer
Parameter Required Type Description
name String 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.
document String CC
phone String Mobile phone number. Should include “+57” as a prefix.
billingAddress JSON Billing address info.
BillingAddress
Parameter Required Type Description
zipCode String zip code.
state String state.
city String city name.
street String street name.
number String street number.
Back to top