{ "item": [ { "name": "Events", "description": "Commerce event ingestion — the write path for orders and customers.", "item": [ { "id": "f6088819-ad0c-4239-8768-56dab45efb8a", "name": "Send events (single or batch)", "request": { "name": "Send events (single or batch)", "description": { "content": "Requires the `ingest` scope. Single event: optional `Idempotency-Key`\nheader (derived from the event refs when absent). Batch: up to 100\nevents; each event's `id` is its idempotency key. Replayed events\nreturn the original result with `replayed: true`. Processing is\nasynchronous — poll `GET /v1/events/{id}` or subscribe to webhooks.\n", "type": "text/plain" }, "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"customer.updated\",\n \"email\": \"\",\n \"id\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\",\n \"occurred_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fe55844b-3afc-47af-a6d4-1ebcccf66f24", "name": "Replayed — this idempotency key was already processed.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"customer.updated\",\n \"email\": \"\",\n \"id\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\",\n \"occurred_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"failed\",\n \"replayed\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc40995f-8d6e-4812-ad90-14d3aa2885b6", "name": "Accepted (batch responses report per-event outcomes).", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"customer.updated\",\n \"email\": \"\",\n \"id\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\",\n \"occurred_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"failed\",\n \"replayed\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b99ace11-f7b7-482f-a54c-39fc9fb30597", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"customer.updated\",\n \"email\": \"\",\n \"id\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\",\n \"occurred_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5748c31d-901a-4ea4-8738-9e3bb7bb30d1", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"customer.updated\",\n \"email\": \"\",\n \"id\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\",\n \"occurred_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8b69662-aad4-4698-9527-466505e4bfe8", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"customer.updated\",\n \"email\": \"\",\n \"id\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\",\n \"occurred_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da7a4815-4c73-40ad-a8af-13c253b26a71", "name": "Rate limit exceeded (Retry-After header set).", "originalRequest": { "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"customer.updated\",\n \"email\": \"\",\n \"id\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\",\n \"occurred_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0c5f340-c226-4981-8713-49b783fee3a6", "name": "Event processing status", "request": { "name": "Event processing status", "description": {}, "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "957294bc-92c3-4858-bb8b-95312cb3a621", "name": "Status and resulting ledger entries.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"failed\",\n \"error\": \"\",\n \"ledger_entry_ids\": [\n \"\",\n \"\"\n ],\n \"received_at\": \"\",\n \"processed_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1ab43d6-fbc3-46fe-b63f-69594cc813b1", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Members", "description": "Enrollment, profiles, balances, ledgers, referrals.", "item": [ { "id": "f86aaf08-bd4d-4ce0-a3dd-bf088a91db69", "name": "List members", "request": { "name": "List members", "description": {}, "url": { "path": [ "v1", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of prospect,registered,active,suspended,deleted)", "type": "text/plain" }, "key": "state", "value": "active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "42ef9d54-d26d-45e0-8462-85db966a7617", "name": "Page of members.", "originalRequest": { "url": { "path": [ "v1", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of prospect,registered,active,suspended,deleted)", "type": "text/plain" }, "key": "state", "value": "active" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"referral_code\": \"\",\n \"tier\": {\n \"name\": \"\",\n \"level\": \"\",\n \"earn_multiplier\": \"\",\n \"benefits\": {\n \"key_0\": false\n }\n },\n \"balances\": {\n \"available_cents\": \"\",\n \"pending_cents\": \"\",\n \"lifetime_earned_cents\": \"\",\n \"lifetime_redeemed_cents\": \"\"\n },\n \"enrolled_at\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"referral_code\": \"\",\n \"tier\": {\n \"name\": \"\",\n \"level\": \"\",\n \"earn_multiplier\": \"\",\n \"benefits\": {\n \"key_0\": 8979.620075623807\n }\n },\n \"balances\": {\n \"available_cents\": \"\",\n \"pending_cents\": \"\",\n \"lifetime_earned_cents\": \"\",\n \"lifetime_redeemed_cents\": \"\"\n },\n \"enrolled_at\": \"\"\n }\n ],\n \"pagination\": {\n \"cursor\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdaaf4f8-36aa-4e44-bbe1-356904b0c083", "name": "Enroll or upsert a member", "request": { "name": "Enroll or upsert a member", "description": { "content": "Requires the `act` scope. Email anchors identity; a mobile owned by a different member is a 409.", "type": "text/plain" }, "url": { "path": [ "v1", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f978be18-8f2d-46f4-bd96-314cc21a9b03", "name": "Already enrolled (possibly enriched).", "originalRequest": { "url": { "path": [ "v1", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"referral_code\": \"\",\n \"tier\": {\n \"name\": \"\",\n \"level\": \"\",\n \"earn_multiplier\": \"\",\n \"benefits\": {\n \"key_0\": 492.17215104510046,\n \"key_1\": true,\n \"key_2\": 2517,\n \"key_3\": 845\n }\n },\n \"balances\": {\n \"available_cents\": \"\",\n \"pending_cents\": \"\",\n \"lifetime_earned_cents\": \"\",\n \"lifetime_redeemed_cents\": \"\"\n },\n \"enrolled_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20a6111a-6e6c-4bb1-8ff9-b7db50e94274", "name": "Enrolled.", "originalRequest": { "url": { "path": [ "v1", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"referral_code\": \"\",\n \"tier\": {\n \"name\": \"\",\n \"level\": \"\",\n \"earn_multiplier\": \"\",\n \"benefits\": {\n \"key_0\": 492.17215104510046,\n \"key_1\": true,\n \"key_2\": 2517,\n \"key_3\": 845\n }\n },\n \"balances\": {\n \"available_cents\": \"\",\n \"pending_cents\": \"\",\n \"lifetime_earned_cents\": \"\",\n \"lifetime_redeemed_cents\": \"\"\n },\n \"enrolled_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e46255-c587-4fdc-9483-1a350dac8d9f", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec699a13-3164-40b8-9c71-59101ec77922", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"phone\": \"\",\n \"external_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2088a21-e6c9-4cba-947a-ad36324fb637", "name": "Member profile, tier and balances", "request": { "name": "Member profile, tier and balances", "description": {}, "url": { "path": [ "v1", "members", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Public member id (M-…)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b1e64fe8-e295-4f0d-baf7-7e41bfd6e9ca", "name": "The member.", "originalRequest": { "url": { "path": [ "v1", "members", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Public member id (M-…)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"referral_code\": \"\",\n \"tier\": {\n \"name\": \"\",\n \"level\": \"\",\n \"earn_multiplier\": \"\",\n \"benefits\": {\n \"key_0\": 492.17215104510046,\n \"key_1\": true,\n \"key_2\": 2517,\n \"key_3\": 845\n }\n },\n \"balances\": {\n \"available_cents\": \"\",\n \"pending_cents\": \"\",\n \"lifetime_earned_cents\": \"\",\n \"lifetime_redeemed_cents\": \"\"\n },\n \"enrolled_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7d2ccc8-6d36-4bb0-b3a1-59915041b99d", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Public member id (M-…)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ff0b3af-1a76-436e-8d96-4eec12af5a6b", "name": "Member ledger (all statuses)", "request": { "name": "Member ledger (all statuses)", "description": {}, "url": { "path": [ "v1", "members", ":id", "ledger" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9605e620-9c5b-4436-8b85-a527b271654a", "name": "Ledger entries, oldest first.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "ledger" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"expire\",\n \"status\": \"\",\n \"amount_cents\": \"\",\n \"currency\": \"\",\n \"reason_code\": \"\",\n \"rule\": \"\",\n \"parent_entry_id\": \"\",\n \"release_at\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"adjust\",\n \"status\": \"\",\n \"amount_cents\": \"\",\n \"currency\": \"\",\n \"reason_code\": \"\",\n \"rule\": \"\",\n \"parent_entry_id\": \"\",\n \"release_at\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"pagination\": {\n \"cursor\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a81bb412-60b2-4afb-a8ff-1211979abf4f", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "ledger" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9712a97f-35d5-42ab-bf8c-1ac56fcfa28f", "name": "Referral code, link and stats", "request": { "name": "Referral code, link and stats", "description": {}, "url": { "path": [ "v1", "members", ":id", "referral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c477d87b-8271-45fc-a98c-cdcc159df487", "name": "Referral details.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "referral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"code\": \"\",\n \"link\": \"\",\n \"stats\": {\n \"pending\": \"\",\n \"qualified\": \"\",\n \"rewarded\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "530289fe-1e7d-42de-a7f5-acb6e1fda676", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "referral" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "593a57ec-47a9-4bdd-bf57-5ecbd0d255bb", "name": "Manual credit or debit", "request": { "name": "Manual credit or debit", "description": { "content": "Requires the `act` scope. `reason_code` is mandatory; the API key is the audited actor.", "type": "text/plain" }, "url": { "path": [ "v1", "members", ":id", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"reason_code\": \"\",\n \"note\": \"\",\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bf2bad21-da0e-4392-9673-637f537a35e1", "name": "Adjustment written.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"reason_code\": \"\",\n \"note\": \"\",\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"ledger_entry_id\": \"\",\n \"amount_cents\": \"\",\n \"reason_code\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bebe679d-5bbf-443b-943c-bf94204b3eb9", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"reason_code\": \"\",\n \"note\": \"\",\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84eb07eb-9a29-4aea-995b-37748d37c34f", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"reason_code\": \"\",\n \"note\": \"\",\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd6fbbfb-7dd1-421f-b6fb-e7eb8328f6ca", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"reason_code\": \"\",\n \"note\": \"\",\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Redemptions", "description": "Vouchers and direct redemptions.", "item": [ { "id": "58927017-13f1-40e8-a8b7-125476909464", "name": "Redeem points (voucher or direct)", "request": { "name": "Redeem points (voucher or direct)", "description": { "content": "Requires the `act` scope. `voucher` (default) debits the wallet and\nreturns a unique code to honor at your POS/cart — then confirm or\nvoid it; unconfirmed vouchers auto-void after the program TTL.\n`direct` debits and finalizes in one call (requires `order_ref`).\n", "type": "text/plain" }, "url": { "path": [ "v1", "members", ":id", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"mode\": \"voucher\",\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "64c7abdd-a9c8-4d34-ada7-1f89429e1b44", "name": "Redemption created (value already debited).", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"mode\": \"voucher\",\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"status\": \"failed\",\n \"mode\": \"\",\n \"amount_cents\": \"\",\n \"code\": \"\",\n \"order_ref\": \"\",\n \"ledger_entry_id\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68aaee7a-2376-4f3d-8e6d-e048b19e6ebf", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"mode\": \"voucher\",\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0507917-b65c-4f89-a7c2-b8b8b9775549", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"mode\": \"voucher\",\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c432c75-9c5b-4d3a-9699-52a8507eabee", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "members", ":id", "redemptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount_cents\": \"\",\n \"mode\": \"voucher\",\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f5b5d1a-3c2f-45e2-b3b6-cd800b0d2245", "name": "Confirm a voucher (idempotent)", "request": { "name": "Confirm a voucher (idempotent)", "description": {}, "url": { "path": [ "v1", "redemptions", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ac219e62-9329-4003-b145-f7ea087a73e9", "name": "Confirmed.", "originalRequest": { "url": { "path": [ "v1", "redemptions", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"status\": \"failed\",\n \"mode\": \"\",\n \"amount_cents\": \"\",\n \"code\": \"\",\n \"order_ref\": \"\",\n \"ledger_entry_id\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b50a1ba-a382-420c-af2a-54b1fb9a6ad3", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "redemptions", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9a46bf5-748f-4846-86fe-7bbf79b9d74c", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "redemptions", ":id", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2dcbb6be-121c-476f-8e80-e89474031831", "name": "Void a voucher and restore value (idempotent)", "request": { "name": "Void a voucher and restore value (idempotent)", "description": {}, "url": { "path": [ "v1", "redemptions", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "483dbbf6-4b46-4777-9674-17eecdf290d5", "name": "Voided; value restored to the wallet.", "originalRequest": { "url": { "path": [ "v1", "redemptions", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"status\": \"failed\",\n \"mode\": \"\",\n \"amount_cents\": \"\",\n \"code\": \"\",\n \"order_ref\": \"\",\n \"ledger_entry_id\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1dfb553-9bad-472a-be59-d7a008c1c18c", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "redemptions", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38e0619c-91ab-4e04-9059-30c867f05d11", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "redemptions", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Program", "description": "Program configuration and finance.", "item": [ { "id": "04d8d688-a2df-482e-a31f-676dde738a9b", "name": "Verify a key", "request": { "name": "Verify a key", "description": {}, "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9ade3f7c-2484-4318-9afd-4a24e90a8e99", "name": "Key is valid.", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"pong\": \"\",\n \"mode\": \"test\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "485bfd3e-750b-418f-bb01-c212272295e3", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2b93d0e-b3ff-4c16-9b2f-11e7d2e146bb", "name": "Active earning configuration", "request": { "name": "Active earning configuration", "description": {}, "url": { "path": [ "v1", "programs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a19d8e1c-4d84-4563-81bc-1372feda5576", "name": "Rules and tiers currently in force.", "originalRequest": { "url": { "path": [ "v1", "programs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"program_name\": \"\",\n \"currency_name\": \"\",\n \"rules\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"version\": \"\",\n \"earn_rate_pct\": \"\",\n \"timing\": \"manual\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"min_order_cents\": \"\",\n \"cap_per_order_cents\": \"\",\n \"expiry_months\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"version\": \"\",\n \"earn_rate_pct\": \"\",\n \"timing\": \"immediate\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"min_order_cents\": \"\",\n \"cap_per_order_cents\": \"\",\n \"expiry_months\": \"\"\n }\n ],\n \"tiers\": [\n {\n \"name\": \"\",\n \"level\": \"\",\n \"threshold_type\": \"\",\n \"threshold_value\": \"\",\n \"criteria\": [\n {\n \"metric\": \"orders\",\n \"threshold\": \"\"\n },\n {\n \"metric\": \"orders\",\n \"threshold\": \"\"\n }\n ],\n \"criteria_mode\": \"any\",\n \"window\": \"custom\",\n \"window_days\": \"\",\n \"earn_multiplier\": \"\",\n \"benefits\": {\n \"key_0\": 8593.11830518898\n }\n },\n {\n \"name\": \"\",\n \"level\": \"\",\n \"threshold_type\": \"\",\n \"threshold_value\": \"\",\n \"criteria\": [\n {\n \"metric\": \"orders\",\n \"threshold\": \"\"\n },\n {\n \"metric\": \"points\",\n \"threshold\": \"\"\n }\n ],\n \"criteria_mode\": \"any\",\n \"window\": \"lifetime\",\n \"window_days\": \"\",\n \"earn_multiplier\": \"\",\n \"benefits\": {\n \"key_0\": 4269.398816726515,\n \"key_1\": true\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4b57206-da40-4684-a6bc-42bfc3e4b1f7", "name": "Finance summary", "request": { "name": "Finance summary", "description": {}, "url": { "path": [ "v1", "tenant", "liability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f0e502fe-7ea5-4d0c-bd1f-4f06bd153dcb", "name": "Outstanding and lifetime value.", "originalRequest": { "url": { "path": [ "v1", "tenant", "liability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"outstanding_cents\": \"\",\n \"available_cents\": \"\",\n \"pending_cents\": \"\",\n \"lifetime_issued_cents\": \"\",\n \"lifetime_redeemed_cents\": \"\",\n \"members\": \"\",\n \"as_of\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Webhooks", "description": "Outbound webhook endpoint management.", "item": [ { "id": "17e7d748-166a-4022-b6e5-9c2a37f685d0", "name": "List webhook endpoints", "request": { "name": "List webhook endpoints", "description": {}, "url": { "path": [ "v1", "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "12b6aa23-7a04-4c43-b405-2ff4ddc48f53", "name": "Endpoints (secrets are never shown again).", "originalRequest": { "url": { "path": [ "v1", "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"member.enrolled\",\n \"redemption.created\"\n ],\n \"status\": \"active\",\n \"failure_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"reward.expiring_soon\",\n \"reward.expiring_soon\"\n ],\n \"status\": \"active\",\n \"failure_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1594382-0621-4c9a-904a-29df68b273b8", "name": "Create a webhook endpoint", "request": { "name": "Create a webhook endpoint", "description": { "content": "Requires the `webhooks` scope. The signing secret is returned ONCE.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"tier.changed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "12777636-03b6-4540-847f-1f8a701bfbca", "name": "Created — save the secret now.", "originalRequest": { "url": { "path": [ "v1", "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"tier.changed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"reward.expiring_soon\",\n \"redemption.voided\"\n ],\n \"status\": \"active\",\n \"failure_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"secret\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2332e5d3-d193-43c0-b609-c146a7dd27b6", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "webhook_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"tier.changed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d92b3a8d-72b1-4205-8aaf-64840166ef96", "name": "Delete a webhook endpoint", "request": { "name": "Delete a webhook endpoint", "description": {}, "url": { "path": [ "v1", "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "697a4ad2-01b2-4f8e-b805-20619e57e8ad", "name": "Deleted.", "originalRequest": { "url": { "path": [ "v1", "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ab323f7-a8d7-45bd-9b42-9053bf0f1fb4", "name": "RFC 9457 problem.", "originalRequest": { "url": { "path": [ "v1", "webhook_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://stickytier.com" } ], "info": { "_postman_id": "32ff2794-c412-42fb-878e-15216cac8e44", "name": "StickyTier API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Run loyalty, tiers and referrals on any commerce stack — WooCommerce,\nMagento, custom carts, POS. Send commerce events; read members, ledgers\nand liability; enroll, adjust and redeem.\n\n**Conventions**: money in minor units (paise), times ISO 8601 UTC,\nresponses wrapped in `{ data, pagination? }`, errors are RFC 9457\n`application/problem+json`.\n", "type": "text/plain" } } }