Fetch Payout Account
GET/payout_accounts/:id
Fetch Payout Account
Request
Path Parameters
ID of the payout account to fetch
Responses
- 200
- 401
- 403
- 404
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
The ID of the payout account.
Possible values: [bank
, wallet
]
Indicates the payout account type.
ISO-4217 three-letter currency code.
Contains the public information relevant to the payout account. For example, the IBAN of the bank account. Every service provider can provide a different set of properties.
Date and time when the payout account was created.
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account_type": "bank",
"currency": "SAR",
"properties": {
"iban": "SA8430400108057386290038"
},
"created_at": "Date and time when the payout account was created."
}
Invalid authorization credentials
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [authentication_error
]
Possible values: [Invalid authorization credentials
]
{
"type": "authentication_error",
"message": "Invalid authorization credentials",
"errors": null
}
Invalid authorization credentials
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [api_error
]
Possible values: [User not authorized
]
{
"type": "api_error",
"message": "User not authorized",
"errors": null
}
One of the record referenced in the request was not found
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [record_not_found
]
{
"type": "record_not_found",
"message": "The <object type> record you were looking for was not found.",
"errors": null
}