Skip to main content
POST
/
v1
/
payouts
{
  "fee": {
    "type": "<unknown>",
    "value": 123
  },
  "bank_account_name": "<string>",
  "bank_account_number": "<string>",
  "bank_name": "<string>",
  "currency": "<string>",
  "merchant_id": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_on": "2023-11-07T05:31:56Z",
  "amount": 123,
  "fee_amount": 123,
  "net_amount": 123,
  "payout_status": "<unknown>",
  "description": "<string>",
  "updated_on": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
amount
number<double>
required

Amount

​
bank_account_name
string
required

Bank Account Name

​
bank_account_number
string
required

Bank Account Number

​
bank_name
string
required

Bank Name

​
currency
string
required

Currency

​
metadata
object

Metadata

​
description
string | null

Description

​
reference_id
string | null

Reference Id

Response

Created

​
fee
object
required
​
bank_account_name
string
required
​
bank_account_number
string
required
​
bank_name
string
required
​
currency
string
required
​
merchant_id
string
required
​
id
string<uuid>
required
​
created_on
string<date-time>
required
​
amount
number<double>
​
fee_amount
number<double>
​
net_amount
number<double>
​
payout_status
any
​
description
string | null
​
updated_on
string<date-time> | null