REFERENSI API · PRODUKSI DAN SANDBOX
Batalkan order yang belum diproses
POST /orders/{id}/cancel
Scope: orders:cancel. Transaksi produksi mengikuti status layanan dan batas akun.
Parameter
| Nama | Lokasi | Wajib | Ketentuan |
|---|---|---|---|
id | path | Ya | Lihat tipe pada OpenAPI. |
Idempotency-Key | header | Ya | Pertahankan UUID yang sama untuk retry payload yang sama. |
Contoh request
curl
# Simpan API key di environment server. Pertahankan reference dan UUID untuk retry usaha yang sama.
curl --fail-with-body 'https://api.turbopulsa.com/sandbox/v1/orders/ORDER_UUID/cancel' \
-H "Authorization: Bearer $TURBOPULSA_API_KEY" \
-H 'Accept: application/json' \
-H "Idempotency-Key: $TURBOPULSA_REQUEST_UUID" \
-H 'Content-Type: application/json' \
--request POST --data 'null'Ganti placeholder dengan ID/kode dari respons API. Gunakan UUID yang sama untuk retry usaha yang sama. Nilai tujuan tidak masuk URL, log, atau analytics.
Struktur respons
Ilustrasi · kontrak lengkap tersedia di OpenAPI
{
"data": {
"id": "20000000-0000-4000-8000-000000000001",
"client_reference": "ORDER-CONTOH-1001",
"product_code": "KODE_DARI_KATALOG",
"name": "Pulsa simulasi 5.000",
"destination": "********0000",
"price": 5050,
"charged": 0,
"currency": "IDR",
"transaction_kind": "prepaid",
"channel": "api",
"environment": "sandbox",
"status": "cancelled",
"created_at": "2030-01-01T00:00:00Z",
"expires_at": "2030-01-01T00:05:00Z",
"confirmation_token": null,
"version": 2,
"bill": null
},
"meta": {
"environment": "sandbox",
"request_id": "10000000-0000-4000-8000-000000000001"
}
}