Skip to content
VoxaDocs
Navigation
Open console →

Billing

Complete a payment

POST/api/v1/billing/payments/{payment_id}/complete

The payment gateway’s callback (simulated). A created payment completes once; on success the credits are added and an invoice is issued.

Authorization

A signed-in member with the billing.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearerbilling.manageworks before activation

Path parameters

payment_idstringrequired

The payment's id.

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

outcomeenum<string>required

What the (simulated) gateway reports.

One of:successfailure

Response

200Success.

See the 200 example next to the code samples.

401No credentials, or they are invalid or revoked.
detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.
detailstring

What went wrong, in plain words.

422Validation Error
detailobject[]
Show item attributes
locstring | integer[]
msgstring
typestring
Esc