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": 10,
"skip": 1,
"type": "customer-payout"
}'
{
"items": [
{
"id": "<string>",
"type": "beneficiary",
"destination": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"metadata": {},
"createdAt": "<any>",
"updatedAt": "<any>",
"paymentReference": "<string>"
}
],
"skip": 123,
"count": 123,
"hasNext": true
}
List payouts for a merchant.
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": 10,
"skip": 1,
"type": "customer-payout"
}'
{
"items": [
{
"id": "<string>",
"type": "beneficiary",
"destination": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
}
},
"status": "paid",
"amount": 123,
"currency": "EUR",
"metadata": {},
"createdAt": "<any>",
"updatedAt": "<any>",
"paymentReference": "<string>"
}
],
"skip": 123,
"count": 123,
"hasNext": true
}
API key for authentication
List payouts
The response is of type object
.
Was this page helpful?