POST
/
api
/
service
/
charge
/
create
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 '{
  "subaccountId": "<string>",
  "mandateId": "<string>",
  "price": {
    "total": 123,
    "currency": "EUR",
    "subTotal": 123,
    "shipping": 123,
    "totalNet": 123,
    "vat": 123
  },
  "referenceId": "<string>",
  "idempotencyKey": "<string>",
  "metadata": {
    "verificationToken": "<string>"
  }
}'
{
  "id": "<string>",
  "mandateId": "<string>",
  "orderId": "<string>",
  "subaccountId": "<string>"
}

Authorizations

​
X-Ivy-Api-Key
string
header
required

Body

application/json
​
mandateId
string
required

A valid mandate id of the customer's bank account. This can be retrieved from the mandate_setup_succeeded event.

​
price
object
required

The price to be charged.

​
referenceId
string
required

An internal reference id which will be stored with the charge & corresponding order. Needs to be unique per merchant per order and can be up to 200 characters. We recommend to use your internal order id here.

Maximum length: 200
​
idempotencyKey
string
required

A unique key to ensure the charge is not processed twice.

​
subaccountId
string

The subaccount id to be used for the charge.

​
metadata
object

Additional data to be stored with the charge.

Response

200 - application/json
The details of the charge
​
id
string
required
​
mandateId
string
required
​
orderId
string
​
subaccountId
string
Update an orderRevoke a Mandate