Getting Started
Capabilities
Payout Report
Charge
Banking
Charge
Create a Charge
Creates a Direct Debit Charge with a valid mandate.
POST
/
api
/
service
/
charge
/
create
Copy
Ask AI
curl --request POST \
--url https://api.sand.getivy.de/api/service/charge/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"mandateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceId": "<string>",
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"idempotencyKey": "<string>",
"subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"verificationToken": "<string>"
}
}'
Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "<any>",
"subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Authorizations
API key for authentication
Body
application/json
Response
200 - application/json
The details of the charge
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://api.sand.getivy.de/api/service/charge/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"mandateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceId": "<string>",
"price": {
"total": 1.01,
"currency": "EUR",
"subTotal": 123,
"shipping": 123,
"totalNet": 123,
"vat": 123
},
"idempotencyKey": "<string>",
"subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"verificationToken": "<string>"
}
}'
Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "<any>",
"subaccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Assistant
Responses are generated using AI and may contain mistakes.