Getting Started
Capabilities
Payout Report
Charge
Banking
Customer Payout
Create a Customer Payout
Create a Customer Payout to a customer’s bank account for withdrawals or similar purposes.
POST
/
api
/
service
/
payout
/
create
Copy
curl --request POST \
--url https://api.sand.getivy.de/api/service/payout/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"amount": 123,
"currency": "EUR",
"destination": {
"orderId": "<string>",
"financialAddress": {
"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>"
}
}
},
"metadata": {},
"paymentReference": "<string>"
}'
Copy
{
"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>"
}
Authorizations
API key for authentication
Body
application/json
Response
200 - application/json
Returns a Customer Payout
The response is of type object
.
Copy
curl --request POST \
--url https://api.sand.getivy.de/api/service/payout/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"amount": 123,
"currency": "EUR",
"destination": {
"orderId": "<string>",
"financialAddress": {
"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>"
}
}
},
"metadata": {},
"paymentReference": "<string>"
}'
Copy
{
"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>"
}
Assistant
Responses are generated using AI and may contain mistakes.