Skip to main content
POST
Start a credit top-up checkout

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Body

application/json
organizationId
string
required
Minimum string length: 1
credits
integer
required
Required range: 400 <= x <= 9007199254740991
successUrl
string
Minimum string length: 1
idempotencyKey
string
Minimum string length: 1

Response

Checkout result for the top-up.

paymentUrl
string | null
required

Hosted checkout URL to redirect the customer to. null when the change was applied directly without a payment step.