POST
/
api
/
service
/
payout
/
retrieve

Authorizations

​
X-Ivy-Api-Key
string
header
required

Body

application/json
​
id
string
required

The unique identifier of the Customer Payout

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
List Customer Payouts