post/{tenantId}/v1/billing/settle

Settle outstanding balance

Requires Authentication

Billing

Payments

Clears a wallet suspension by charging the outstanding negative

balance through the supplied (or default) payment method.

Path Parameters

Name	Type	Description
`tenantId` required	`string (uuid)`	Tenant UUID

Request Body

required

paymentMethodId

string (uuid)

- Optional; defaults to the tenant's current default method.

idempotencyKey

string (uuid)

required

acknowledgeCredits

integer (int64)

- Optional sanity-check on the outstanding credits the caller believes they owe. Refused if non-zero and doesn't match the server-computed outstanding.

Responses

Settlement charge created

Response Bodyapplication/json

transactionId

string (uuid)

status

string

enum: "succeeded" | "requires_action" | "pending_external" | "failed"

providerIntentId

string

requiresActionUrl

string

failureCode

string

failureMessage

string

Code Examples

curl -X POST 'https://api-next.checkio.co.uk/{tenantId}/v1/billing/settle' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "paymentMethodId": "00000000-0000-0000-0000-000000000000",
  "idempotencyKey": "00000000-0000-0000-0000-000000000000",
  "acknowledgeCredits": 0
}'