Customer Payout
List Customer Payouts
Getting Started
Charge
Capabilities
Payout Report
Balance
Customer Payout
List Customer Payouts
List all Customer Payouts made by this merchant account.
POST
/
api
/
service
/
payout
/
list
curl --request POST \
--url https://api.sand.getivy.de/api/service/payout/list \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"limit": 123,
"skip": 123
}'{
"items": [
{
"id": "<string>",
"destination": {
"type": "<string>",
"iban": {
"iban": "<string>",
"bic": "<string>",
"accountHolderName": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"skip": 123,
"count": 123,
"hasNext": true
}Authorizations
Body
application/json
The number of items to retrieve
The number of items to skip
Response
200 - application/json
Returns a list of Customer Payouts
The validation logic is based on the "type" field. For example, if "type" is set to "iban", the "iban" object must be filled out.
The type of the financial address. The actual destination is determined by this field which can be either "iban", "sortCode", "bankCode", or "bban". The validation will fail if you set e.g. type="iban", but then not fill any values in the "iban" object.
- iban: The IBAN of the account
- sort_code: The sort code of the account
- bank_code: The bank code of the account
- bban: The BBAN of the account
Available options:
paid, pending, failed Available options:
EUR, GBP, PLN Any key-value pairs, which will be stored to the object. See here for more info.
The number of items skipped
The total number of items
Whether there are more items to retrieve
curl --request POST \
--url https://api.sand.getivy.de/api/service/payout/list \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"limit": 123,
"skip": 123
}'{
"items": [
{
"id": "<string>",
"destination": {
"type": "<string>",
"iban": {
"iban": "<string>",
"bic": "<string>",
"accountHolderName": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"skip": 123,
"count": 123,
"hasNext": true
}