API reference
Place an approved order
POST
Inspect owned orders, fulfillment milestones and purchase observations.
Copy amounts and versions from the quote; do not hard-code them. Initial card top-ups are disabled. Retry the identical confirmation against the same quote; a dropped response is not permission to create another purchase. Provider fulfillment remains separately observable and unverified here.
Required scope: orders:write.
bearerAuthheader
AuthorizationBearer <token>Scoped GoodInboxes API token
application/json- body
quoteId*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidconsent*booleanamountCents*integerRange
0 < value <= 9007199254740991currency*stringMatch
^[A-Z]{3}$policyVersion*stringMatch
^\d{4}-\d{2}-\d{2}$consentVersion*stringMatch
^\d{4}-\d{2}-\d{2}$renewalConsent*booleanbyodTakeoverAccepted?booleanDefault
falsedata.orderId, status, orderStatus, paymentStatus, amountCents, currency and checkedAt
application/json- response
data*data.orderId, status, orderStatus, paymentStatus, amountCents, currency and checkedAt
requestId?stringcurl -X POST "https://example.com/api/v1/orders" \ -H "Content-Type: application/json" \ -d '{ "quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7", "consent": true, "amountCents": 1, "currency": "string", "policyVersion": "string", "consentVersion": "string", "renewalConsent": true }'{ "data": {}, "requestId": "string"}