Getting Started
Capabilities
Payout Report
Charge
Banking
Customer Payout
List Customer Payouts
List all Customer Payouts made by this merchant account.
POST
/
api
/
service
/
payout
/
list
Copy
Ask AI
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
}'
Copy
Ask AI
{
"items": [
{
"id": "<string>",
"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>"
},
"paymentReference": "<string>",
"psuData": {
"username": "<string>",
"branchNumber": "<string>",
"ssn": "<string>",
"oib": "<string>",
"ipAddress": "<string>",
"psuId": "<string>",
"clientId": "<string>"
}
},
"status": "pending",
"amount": 123,
"currency": "EUR",
"metadata": {},
"createdAt": "<any>",
"updatedAt": "<any>",
"paymentReference": "<string>"
}
],
"skip": 123,
"count": 123,
"hasNext": true
}
Authorizations
API key for authentication
Body
application/json
Response
200 - application/json
Returns a list of Customer Payouts
The response is of type object
.
Copy
Ask AI
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
}'
Copy
Ask AI
{
"items": [
{
"id": "<string>",
"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>"
},
"paymentReference": "<string>",
"psuData": {
"username": "<string>",
"branchNumber": "<string>",
"ssn": "<string>",
"oib": "<string>",
"ipAddress": "<string>",
"psuId": "<string>",
"clientId": "<string>"
}
},
"status": "pending",
"amount": 123,
"currency": "EUR",
"metadata": {},
"createdAt": "<any>",
"updatedAt": "<any>",
"paymentReference": "<string>"
}
],
"skip": 123,
"count": 123,
"hasNext": true
}
Assistant
Responses are generated using AI and may contain mistakes.