Skip to content

Cancel a virtual account

HTTP Request

POST /v1/payments/charges/references/cancel/{{idempotencyKey}}

Request Headers
{
  "Authorization": "Bearer {{access_token}}",
  "x-api-key": "{{api_key}}"
}
Content-Type: application/json
{
  "transferStatusCode": 200,
  "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
  "country": "MX",
  "currency": "MXN",
  "createTime": "2023-08-15 20:05:38 GMT-07:00",
  "status": "CANCELLED",
  "description": "this is a test references",
  "callbackUrl": "https://api.client.com/callback/",
  "transferDetails": {
    "clabeAccount": {
      "userInfo": {
        "legalName": "{{TARGET_ACCOUNT_LEGAL_NAME}}",
        "phoneNumber": "{{TARGET_ACCOUNT_PHONE_NUMBER}}"
      },
      "clabeAccountNumber": "706180162569438880"
    }
  }
}

Request Headers Parameters

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

PATH Parameters

Parameter Type Description
idempotencyKey String The idempotency key of the payment which need to cancel

Response Body Parameters

Parameter Type Description
transferStatusCode Integer Cancel account status code, 200 create account success
transferErrorMsg String Cancel account error message if failed
idempotencyKey String Unique key to ensure idempotent requests. given by the merchant in their system
country String Country code
currency String The currency code of the transferred fund
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
status String Account status,should be CANCELLED if success
TransferDetails Object Parameters
Parameter Type Description
clabeAccount JSON Clabe Account info
ClabeAccount Object Parameters
Parameter Type Description
clabeAccountNumber String Clabe account number of the payment
userInfo JSON User info
Back to top