Skip to content

Refund

This service allows you to create refunds of an existing payment.

HTTP Request

POST /v1/payments/charges/refund

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "2022030214000007-1",
    "referenceId": "2022030214000007",
    "amount": 3,
    "currency": "MXN",
    "country": "MX",
    "description": "refund test",
    "callbackUrl": "https://api.client.com/callback/"
}
Response
{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "2022030214000007-1",
    "referenceId": "2022030214000007",
    "paymentMethod": "CREDIT_CARD",
    "amount": 3,
    "currency": "MXN",
    "country": "MX",
    "finalAmount": 100,
    "finalCurrency": "MXN",
    "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": {
        "name": "username",
        "email": "username@liquido.com",
        "document" : "1222112121",
        "phone": "5512345678",
        "billingAddress": {  
            "zipCode": "03400",
            "state": "CDMX",
            "city": "Álamos",
            "street": "Simón Bolívar",
            "number": "12121"
        }
    },
    "transferStatus": "SETTLED",
    "description": "refund test",
    "callbackUrl": "https://api.client.comcallback/"
}
HTTP Headers Parameters
Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}
Request Body Parameters
Parameter Required Type Description
idempotencyKey String idempotencyKey of refund transation, generate by merchant.
referenceId String idempotencyKey of payment which need to refund.
amount Long The refund amount, now just support full refund, as same as the payment amount. The minimum settlement granularity of the current currency, such as 100=1MXN
country String country code
currency String The currency code of the transferred fund
description String description of refund transation
callbackUrl String URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
Response Body Parameters
Parameter Type Description
idempotencyKey String idempotencyKey of refund record, generate by merchant.
referenceId String idempotencyKey of the payment which need to refund.
paymentMethod String payment method
amount Long The refund amount
country String country code
currency String The currency code of the refund
description String reason for refund
callbackUrl String URL where Liquido will send notifications associated to changes to this refund.
finalAmount String 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.
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 int refund status code, 200 transaction SETTLED or IN_PROGRESS, other FAILED
transferErrorMsg String refund 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 CURP
phone String Mobile Phone number.
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.

Notification / Callback

Notification / Callback
{
    "eventType": "CHARGE_REFUND_SUCCEEDED",
    "data": {
        "chargeDetails" : {
            "amount" : 3,
            "callbackUrl" : "https://api.client.com/callback/",
            "country" : "MX",
            "finalAmount": 100,
            "finalCurrency": "MXN",
            "createTime" : "2022-03-01 15:10:35 GMT+08:00",
            "currency" : "MXN",
            "description" : "refund test",
            "finalStatusTime" : "2022-03-01 15:10:37 GMT+08:00",
            "idempotencyKey" : "2022030114000005-1",
            "payer" : {
                "email" : "username@liquido.com",
                "name" : "username"
            },
            "paymentMethod" : "CREDIT_CARD",
            "referenceId" : "2022030214000007",
            "scheduledTime" : "2022-03-01 15:10:35 GMT+08:00",
            "transferStatus" : "SETTLED",
            "transferStatusCode" : 200
        }
    }
}
Notification Event Type
CHARGE_SUCCEEDED,
CHARGE_FAILED,
CHARGE_CHARGED_BACK,
CHARGE_REFUND_SUCCEEDED,
CHARGE_REFUND_FAILED;
Back to top