POST
/
api
/
service
/
payout
/
create

Authorizations

​
X-Ivy-Api-Key
string
header
required

Body

application/json
​
amount
number
required

The amount of the customer payout

​
currency
enum<string>
required

The currency of the customer payout

Available options:
EUR,
GBP,
PLN
​
destination
object
required

The destination of the customer payout.

​
metadata
object

The metadata of the customer payout

​
paymentReference
string

The payment reference of the customer payout. The customer will see this reference in their bank statement.

Response

200 - application/json
​
amount
number
required
​
currency
enum<string>
required
Available options:
EUR,
GBP,
PLN
​
destination
object
required

The validation logic is based on the "type" field. For example, if "type" is set to "iban", the "iban" object must be filled out.

​
id
string
required
​
status
enum<string>
required
Available options:
paid,
pending,
failed
​
createdAt
string
​
metadata
object

Any key-value pairs, which will be stored to the object. See here for more info.

​
updatedAt
string
Retrieve Account BalanceList Customer Payouts