v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB

payout

Create individual payout

post/payout/transfer

Query parameters

previewboolean

Enables payout validation, fee calculation, and total amount estimation (amount + fee = total_amount) without creating or processing the payout. Currently available only for Peru (PE).

Request body

descriptionstring

external_idstring

Id used to track the payout

originstring uuid

The origin account Id

amountnumber double

String encoded decimal number

Example request

{
  "description": "Test Payout",
  "external_id": "e5af7e6e-98f4-4e43-af7e-6e98f42e43ef",
  "origin": "f3676011-5203-43db-a760-115203e3db5e",
  "amount": 10,
  "customer": {
    "name": "Jane Doe",
    "tax_id_type": "rfc",
    "tax_id": "DODJ2301016J3",
    "external_id": "SOME_PREFIX:SOME_UNIQUE_ID",
    "withdrawal_account": {
      "account_number": "19395123123223150",
      "branch": "0",
      "account_format": "clabe",
      "bicfi": "BBVAMXMMXXX"
    }
  }
}

Response

Payout created

idstring uuid

Id of the payout intent

originstring uuid

The origin account Id

descriptionstring

external_idstring

Id used to track the payout

feenumber double

String encoded decimal number

amountnumber double

String encoded decimal number

referencestring

Id of the payout generated by the financial provider

Example response

{
  "id": "4d6c83e6-44ce-4963-ac83-e644ced9631c",
  "origin": "f3676011-5203-43db-a760-115203e3db5e",
  "description": "Test Payout",
  "external_id": "e5af7e6e-98f4-4e43-af7e-6e98f42e43ef",
  "fee": 10,
  "amount": 10,
  "reference": "XBVTIQ3CQNN1ETFPG79TCC5IYA",
  "customer": {
    "name": "Jane Doe",
    "tax_id_type": "rfc",
    "tax_id": "DODJ2301016J3",
    "external_id": "SOME_PREFIX:SOME_UNIQUE_ID",
    "withdrawal_account": {
      "account_number": "19395123123223150",
      "branch": "0",
      "account_format": "clabe",
      "bicfi": "BBVAMXMMXXX"
    }
  }
}