Skip to main content
POST
Charge a merchant-initiated subscription on demand

Headers

ApiKey
string
required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId
string
required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment
enum<string>
required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:
live,
sandbox

Path Parameters

id
number
required

Body

application/json
amount
number
required

In the smallest currency unit (e.g. 100 cents to charge €1.00).

currency
string
required
reference
string
required

Your idempotency key — retrying with the same reference and the same amount on the same subscription never charges twice. Retry with the same reference and amount after a timeout or 5xx; the same reference with a different amount is refused with 409.

Response

id
number
required
status
enum<string>
required
Available options:
pending,
success,
failed
amount
string
required

Decimal string in major currency units, e.g. "1500.00".

transactionDate
string<date-time>
required
cybersourceReference
object | null
required

Null while the charge is still pending confirmation from Cybersource.

merchantReference
object | null
required

The reference sent when triggering this charge.

indicator
enum<string>
required
Available options:
CIT,
MIT
createdAt
string<date-time>
required