Getting Started
Capabilities
Refund
Payout Report
Charge
Banking
Payout
Create a payout
Create a payout for a merchant.
POST
/
api
/
service
/
payout
/
create
Create a payout
Copy
Ask AI
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": 1.01,
"currency": "EUR",
"destination": {
"type": "beneficiary",
"orderId": "<string>",
"financialAddress": null
},
"metadata": {},
"paymentReference": "<string>"
}'
Copy
Ask AI
{
"id": "<string>",
"amount": 1,
"currency": "EUR",
"status": "initiated",
"orderId": "<string>"
}
Authorizations
API key for authentication
Body
application/json
Response
200 - application/json
Create a payout
The response is of type object
.
Create a payout
Copy
Ask AI
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": 1.01,
"currency": "EUR",
"destination": {
"type": "beneficiary",
"orderId": "<string>",
"financialAddress": null
},
"metadata": {},
"paymentReference": "<string>"
}'
Copy
Ask AI
{
"id": "<string>",
"amount": 1,
"currency": "EUR",
"status": "initiated",
"orderId": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.