POST
/
api
/
service
/
charge
/
create

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
id
string
required
mandateId
string
required
orderId
string
subaccountId
string