v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

Create Payout

post/payout

Request body

destination_idstring required

amountinteger required

Amount should be in subunits, e.g., $1 should be sent as 100.

descriptionstring required

supporting_documentsstring[]

This should be a publicly downloadable content URL e.g invoice for payment

Response

201

messagestring

{"stackTrail":"paths:/payout:post:responses:201:content:application/json:schema:properties:meta","oasType":"schema","type":"unknown"}

statusstring

Example response

{
  "data": {
    "payout": {
      "id": "b72d9524715111edbcfddb048077d2b7",
      "account_id": "8bc919c06bfd11eda78fe041a4724e32",
      "destination_id": "fad00b8c708d11edbcfddb048077d2b7",
      "type": "ach",
      "amount": 10000,
      "fee": 2500,
      "description": "Paul's food",
      "status": "queued",
      "created_at": "2022-12-01T09:25:29Z",
      "updated_at": "2022-12-01T09:25:29Z"
    },
    "transaction": {
      "id": "b72ebe0e715111edbcfddb048077d2b7",
      "account_id": "8bc919c06bfd11eda78fe041a4724e32",
      "kind": "deposit",
      "payout_id": "b72d9524715111edbcfddb048077d2b7",
      "type": "credit",
      "description": "Payout - Paul's food",
      "currency": "USD",
      "amount": 10000,
      "status": "successful",
      "created_at": "2022-12-01T09:25:29Z",
      "updated_at": "2022-12-01T09:25:29Z"
    }
  },
  "message": "Payout created successfully",
  "status": "success"
}