v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB

payin

Create a refund

post/payin/refund

Request body

intent_idstring required

external_idstring required

An external ID to identify a user. It can be the merchant's user ID or other tracking ID.

amountnumber double

String encoded decimal number

Example request

{
  "external_id": "SOME_PREFIX:SOME_UNIQUE_ID",
  "amount": 10
}

Response

Refund created (Payout Id returned)

idstring uuid

Id of the payout intent

originstring uuid

The origin account Id

descriptionstring

external_idstring

Id used to track the payout

amountnumber double

String encoded decimal number

feenumber double

String encoded decimal number

total_amountnumber double

String encoded decimal number

referencestring

Id of the payout generated by the financial provider

timestampstring date-time

The timestamp of the payout creation

Example response

{
  "id": "4d6c83e6-44ce-4963-ac83-e644ced9631c",
  "origin": "f3676011-5203-43db-a760-115203e3db5e",
  "description": "Test Payout",
  "external_id": "e5af7e6e-98f4-4e43-af7e-6e98f42e43ef",
  "amount": 10,
  "fee": 10,
  "total_amount": 10,
  "reference": "XBVTIQ3CQNN1ETFPG79TCC5IYA",
  "timestamp": "2024-09-30T18:00:58.087Z",
  "customer": {
    "name": "Jane Doe",
    "tax_id_type": "rfc",
    "tax_id": "DODJ2301016J3",
    "external_id": "SOME_PREFIX:SOME_UNIQUE_ID",
    "withdrawal_account": {
      "id": "9c1dd10e-7c19-470d-9dd1-0e7c19670d64",
      "account_format": "clabe",
      "account_number": "012180826854179156",
      "description": "Account",
      "branch": "0",
      "bank": {
        "code": "012",
        "bicfi": "BBVAMXMMXXX",
        "name": "BBVA",
        "country": "MX"
      }
    }
  },
  "events": [
    {
      "state": "created",
      "timestamp": "2024-09-30T18:00:58.087Z",
      "message": "Payin created"
    }
  ]
}