Tizondocs
ReferenceTest helpers

Resolve a pending order

POST
/v1/test_helpers/orders/{order_id}/complete

The provider resolves an order that is still pending, as the sandbox offer off_test_stays_pending always is. failed credits the price back to the wallet. An order that is already resolved is 409 order_already_resolved.

Authorization

ApiKey
AuthorizationBearer <token>

An account API key, sent as Authorization: Bearer tz_live_…. The prefix selects the mode: tz_test_ for sandbox, tz_live_ for real money.

In: header

Path Parameters

order_id*string

Header Parameters

Idempotency-Key*string

A client-generated key, unique per intended operation, that makes this request safe to retry. The same key returns the original response; the same key with a different request is rejected. Missing: 400 idempotency_key_required.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/test_helpers/orders/string/complete" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "outcome": "fulfilled"  }'
{  "id": "string",  "object": "order",  "quote_id": "string",  "offer_id": "string",  "status": "pending",  "price": {    "amount": 1450,    "currency": "USD"  },  "deliverable": {    "type": "esim_profile",    "iccid": "string",    "lpa": "LPA:1$smdp.example.com$MBGNW-2IMOY-XAKHK-CPNCJ",    "activation_code": "string",    "smdp_address": "smdp.example.com",    "confirmation_code": "string"  },  "failure_reason": "string",  "upstream": {    "transaction_id": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "resolved_at": "2019-08-24T14:15:22Z"}