{"openapi":"3.0.3","info":{"title":"Rendo API","version":"1.1.0","description":"Merchant-issued reward points: earn on orders, redeem at checkout, refunds and reversals on an immutable ledger.\n\nMoney is integer minor units (GHS 12.50 = 1250). Points are decimal strings with up to six places, never floats.\nWrites that move value take an Idempotency-Key. Secret keys (sk_...) are for your server only; browsers get short-lived member or checkout tokens.\n\n## Webhooks\nRegister an endpoint with POST /v1/webhook-endpoints. The response carries `signing_secret` once; store it. Every delivery is a POST of a JSON body with these headers:\n\n- `X-123-Event-Id`: the event id; deliveries are at least once, so de-duplicate on it.\n- `X-123-Timestamp`: unix seconds.\n- `X-123-Signature`: `v1=<hex HMAC-SHA256 of \"<timestamp>.<raw body>\" with your signing secret>`. While a secret is being rotated there are two `v1=` values, separated by a comma.\n\nVerify against the raw bytes before parsing, reject timestamps more than 5 minutes old, and answer 2xx quickly; other answers are retried with backoff. The `@123/webhook-verifier` package does all of this.\n\nExample delivery:\n\n```\nx-123-event-id: evt_4281e0352a554007a5f848cae1e324cf\nx-123-timestamp: 1793806794\nx-123-signature: v1=EXAMPLE_HEX_HMAC_SHA256\ncontent-type: application/json\n\n{\n  \"event_id\": \"evt_4281e0352a554007a5f848cae1e324cf\",\n  \"event_type\": \"wallet.points.earned\",\n  \"schema_version\": \"1.1\",\n  \"occurred_at\": \"2026-11-04T15:39:53.590Z\",\n  \"merchant_id\": \"ten_5e7a0e16e3cb472abc76a2817f759dbe\",\n  \"programme_id\": \"prg_b3a07621bd6046208917fc70f19cb0a9\",\n  \"wallet_id\": \"acc_fc41fa6d4055418c9fe1cba691af1b4a\",\n  \"journal_id\": \"jrn_91dae5f82a8641c091d45499e38ca41b\",\n  \"points\": \"1.845000\",\n  \"external_order_id\": \"ORDER-1001\",\n  \"correlation_id\": \"req_6c7b708729b54bfba588c1bb23bb7edf\",\n  \"data\": {\n    \"state\": \"AVAILABLE\",\n    \"points\": \"1.845000\",\n    \"currency\": \"GHS\",\n    \"order_id\": \"ord_5d301e36b5a949acb2f4ecab2b5656a3\",\n    \"member_id\": \"mem_f8f88725ab684bf7be30f49c70f8361d\",\n    \"tier_code\": \"BRONZE\",\n    \"cashback_bps\": 100,\n    \"birthday_month\": false,\n    \"cashback_minor\": 500,\n    \"point_multiplier\": \"1.000\",\n    \"external_order_id\": \"ORDER-1001\",\n    \"policy_version_id\": \"cfg_3b2f5b5f2bed4919bae0714352202a5b\"\n  },\n  \"id\": \"evt_4281e0352a554007a5f848cae1e324cf\",\n  \"type\": \"wallet.points.earned\",\n  \"created_at\": \"2026-11-04T15:39:53.590Z\",\n  \"api_version\": \"2026-10-01\"\n}\n```"},"servers":[{"url":"https://api.rendo.ds7.online"}],"tags":[{"name":"Programme"},{"name":"Members"},{"name":"Wallets"},{"name":"Orders"},{"name":"Reports"},{"name":"Redemptions"},{"name":"Checkout widget"},{"name":"Rendo Hub"},{"name":"Rendo linking"},{"name":"Webhooks"},{"name":"Rendo wallet"},{"name":"Website"}],"paths":{"/v1/programmes/current":{"get":{"tags":["Programme"],"summary":"The programme this key belongs to, with its current rules","operationId":"get_programmes_current","security":[{"secretKey":[]}],"x-required-scope":"programme:read","parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"prg_b3a07621bd6046208917fc70f19cb0a9","public_name":"Example Shop","slug":"example-shop","currency":"GHS","timezone":"Africa/Accra","locale":"en-GH","config_version":1,"theme":{},"environment":"SANDBOX","reward_points":{"points_per_cashback_unit":"0.369","point_value_minor":271,"precision":6,"birthday_multiplier_applies":true,"redeemable":true},"tier_qualification":"MANUAL","tiers":[{"code":"BRONZE","name":"Bronze","rank":1,"cashback_bps":100,"birthday_multiplier":"1"},{"code":"SILVER","name":"Silver","rank":2,"cashback_bps":200,"birthday_multiplier":"2"}],"initial_tier":"BRONZE","redemption":{"max_percent_of_eligible":100}}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/members":{"post":{"tags":["Members"],"summary":"Enrol a customer","operationId":"post_members","security":[{"secretKey":[]}],"x-required-scope":"members:write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":320,"nullable":true},"mobile":{"type":"string","maxLength":40,"nullable":true},"first_name":{"type":"string","maxLength":100,"nullable":true},"last_name":{"type":"string","maxLength":100,"nullable":true},"date_of_birth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"external_customer_id":{"type":"string","minLength":1,"maxLength":200}},"required":["external_customer_id"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"mem_0a54dda828544a199b39815545072024","external_customer_id":"CUST-1002","email":"kofi@example.com","mobile":null,"first_name":"Kofi","last_name":"Boateng","date_of_birth":"1990-05-14","status":"ACTIVE","programme_membership":{"id":"pms_86f6808f6996470fbd756c72b3400720","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","tier":{"code":"BRONZE","name":"Bronze"},"enrolled_at":"2026-11-04T15:39:56.281Z"},"reward_account_id":"acc_aa2a0eed11ac4b798109661c9c81ac34"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/members/by-external-id/{externalId}":{"put":{"tags":["Members"],"summary":"Create or update a customer by your own customer id","operationId":"put_members_by_external_id_externalId","security":[{"secretKey":[]}],"x-required-scope":"members:write","parameters":[{"name":"externalId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":320,"nullable":true},"mobile":{"type":"string","maxLength":40,"nullable":true},"first_name":{"type":"string","maxLength":100,"nullable":true},"last_name":{"type":"string","maxLength":100,"nullable":true},"date_of_birth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"mem_f8f88725ab684bf7be30f49c70f8361d","external_customer_id":"CUST-1001","email":"ama@example.com","mobile":null,"first_name":"Ama","last_name":"Mensah","date_of_birth":null,"status":"ACTIVE","programme_membership":{"id":"pms_5bf531a7f2b348fcbb91402b1307da7a","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","tier":{"code":"BRONZE","name":"Bronze"},"enrolled_at":"2026-11-04T15:39:53.538Z"},"reward_account_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Members"],"summary":"Find a customer by your own customer id","operationId":"get_members_by_external_id_externalId","security":[{"secretKey":[]}],"x-required-scope":"members:read","parameters":[{"name":"externalId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"mem_0a54dda828544a199b39815545072024","external_customer_id":"CUST-1002","email":"kofi@example.com","mobile":null,"first_name":"Kofi","last_name":"Boateng","date_of_birth":"1990-05-14","status":"ACTIVE","programme_membership":{"id":"pms_86f6808f6996470fbd756c72b3400720","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","tier":{"code":"BRONZE","name":"Bronze"},"enrolled_at":"2026-11-04T15:39:56.281Z"},"reward_account_id":"acc_aa2a0eed11ac4b798109661c9c81ac34"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/members/{id}":{"get":{"tags":["Members"],"summary":"Get a customer","operationId":"get_members_id","security":[{"secretKey":[]}],"x-required-scope":"members:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"mem_0a54dda828544a199b39815545072024","external_customer_id":"CUST-1002","email":"kofi@example.com","mobile":null,"first_name":"Kofi","last_name":"Boateng","date_of_birth":"1990-05-14","status":"ACTIVE","programme_membership":{"id":"pms_86f6808f6996470fbd756c72b3400720","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","tier":{"code":"BRONZE","name":"Bronze"},"enrolled_at":"2026-11-04T15:39:56.281Z"},"reward_account_id":"acc_aa2a0eed11ac4b798109661c9c81ac34"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Members"],"summary":"Update a customer","operationId":"patch_members_id","security":[{"secretKey":[]}],"x-required-scope":"members:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":320,"nullable":true},"mobile":{"type":"string","maxLength":40,"nullable":true},"first_name":{"type":"string","maxLength":100,"nullable":true},"last_name":{"type":"string","maxLength":100,"nullable":true},"date_of_birth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"mem_0a54dda828544a199b39815545072024","external_customer_id":"CUST-1002","email":"kofi@example.com","mobile":"+233200000002","first_name":"Kofi","last_name":"Boateng","date_of_birth":"1990-05-14","status":"ACTIVE","programme_membership":{"id":"pms_86f6808f6996470fbd756c72b3400720","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","tier":{"code":"BRONZE","name":"Bronze"},"enrolled_at":"2026-11-04T15:39:56.281Z"},"reward_account_id":"acc_aa2a0eed11ac4b798109661c9c81ac34"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/members/{id}/reward-account":{"get":{"tags":["Members"],"summary":"Balances, tier and next expiry","operationId":"get_members_id_reward_account","security":[{"secretKey":[]}],"x-required-scope":"rewards:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"member_id":"mem_f8f88725ab684bf7be30f49c70f8361d","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","environment":"SANDBOX","tier":{"code":"BRONZE","name":"Bronze","cashback_bps":100,"birthday_multiplier":"1","qualification":"MANUAL"},"reward_wallet":{"unit":"REWARD_POINTS","pending_points":"0.000000","available_points":"1.845000","reserved_points":"0.000000","recovery_due_points":"0.000000","expired_points":"0.000000","status":"ACTIVE","currency":"GHS","point_value_minor":271,"available_value_minor":499,"redeemable":true,"next_expiry_at":null}}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/members/{id}/reward-history":{"get":{"tags":["Members"],"summary":"Ledger history, newest first","operationId":"get_members_id_reward_history","security":[{"secretKey":[]}],"x-required-scope":"rewards:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"reference","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"data":[{"journal_id":"jrn_91dae5f82a8641c091d45499e38ca41b","type":"EARN","value_type":"REWARD_POINTS","entry_type":"POINTS_EARNED","currency":"GHS","reference":"ORDER-1001","occurred_at":"2026-11-04T15:39:53.598Z","effect":{"available_points":"1.845000"}}],"has_more":false,"next_cursor":null}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/members/{id}/statement":{"get":{"tags":["Members"],"summary":"Statement with opening and closing balances (JSON or CSV)","operationId":"get_members_id_statement","security":[{"secretKey":[]}],"x-required-scope":"rewards:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"from":"2000-01-01T00:00:00.000Z","to":"2026-11-04T15:39:56.316Z","opening_balance_points":"0.000000","lines":[{"date":"2026-11-04T15:39:53.590Z","description":"POINTS_EARNED","reference":"ORDER-1001","credit_points":"1.845000","debit_points":null,"balance_points":"1.845000"},{"date":"2026-11-04T15:39:53.685Z","description":"REDEMPTION_COMMIT","reference":"PAY-5521","credit_points":null,"debit_points":"1.841329","balance_points":"0.003671"}],"closing_balance_points":"0.003671","issued_entry_types":["POINTS_EARNED_PENDING","POINTS_EARNED"]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/merchant-customers/upsert":{"post":{"tags":["Wallets"],"summary":"Create or update a merchant customer (v1.1)","operationId":"post_merchant_customers_upsert","security":[{"secretKey":[]}],"x-required-scope":"members:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_customer_id":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":320,"nullable":true},"display_name":{"type":"string","maxLength":120,"nullable":true},"verified_birth_month":{"type":"integer","minimum":1,"maximum":12,"nullable":true}},"required":["external_customer_id"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"mem_f8f88725ab684bf7be30f49c70f8361d","merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","external_customer_id":"CUST-1001","created":true}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/wallets/provision":{"post":{"tags":["Wallets"],"summary":"Open the customer's wallet for this programme (v1.1)","operationId":"post_wallets_provision","security":[{"secretKey":[]}],"x-required-scope":"members:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"programme_id":{"type":"string"},"merchant_customer_id":{"type":"string"}},"required":["merchant_customer_id"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","merchant_name":"Example Shop","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","programme_name":"Example Shop","points_asset_id":"pas_e439ef84cff247f583f3477187789fd6","member_id":"mem_f8f88725ab684bf7be30f49c70f8361d","tier_code":"BRONZE","tier_name":"Bronze","status":"ACTIVE","unit":"REWARD_POINTS","currency":"GHS","point_value_minor":271,"pooled_spendable":false,"balances":{"pending":"0.000000","available":"0.000000","reserved":"0.000000","locked":"0.000000","expired":"0.000000","recovery_due":"0.000000"},"next_expiry_at":null,"available_actions":["REDEEM_AT_CHECKOUT","VIEW_STATEMENT"],"branding":{"programme_name":"Example Shop","theme":{}},"environment":"SANDBOX"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/wallets/{id}":{"get":{"tags":["Wallets"],"summary":"A wallet with its six balances and available actions","operationId":"get_wallets_id","security":[{"secretKey":[]},{"memberToken":[]}],"x-required-scope":"rewards:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","merchant_name":"Example Shop","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","programme_name":"Example Shop","points_asset_id":"pas_e439ef84cff247f583f3477187789fd6","member_id":"mem_f8f88725ab684bf7be30f49c70f8361d","tier_code":"BRONZE","tier_name":"Bronze","status":"ACTIVE","unit":"REWARD_POINTS","currency":"GHS","point_value_minor":271,"pooled_spendable":false,"balances":{"pending":"0.000000","available":"1.845000","reserved":"0.000000","locked":"0.000000","expired":"0.000000","recovery_due":"0.000000"},"next_expiry_at":null,"available_actions":["REDEEM_AT_CHECKOUT","VIEW_STATEMENT"],"branding":{"programme_name":"Example Shop","theme":{}},"environment":"SANDBOX"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/wallets/{id}/transactions":{"get":{"tags":["Wallets"],"summary":"Wallet journal, one row per business event","operationId":"get_wallets_id_transactions","security":[{"secretKey":[]},{"memberToken":[]}],"x-required-scope":"rewards:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"reference","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"items":[{"journal_id":"jrn_91dae5f82a8641c091d45499e38ca41b","type":"EARN","points":"1.845000","effect":{"available_points":"1.845000"},"source_order_id":"ORDER-1001","posted_at":"2026-11-04T15:39:53.598Z","entry_type":"POINTS_EARNED"}],"next_cursor":null}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/order-events":{"post":{"tags":["Orders"],"summary":"Report an order event: paid, fulfilled, refunded or cancelled (v1.1)","operationId":"post_order_events","security":[{"secretKey":[]}],"x-required-scope":"orders:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"merchant_id":{"type":"string"},"programme_id":{"type":"string"},"merchant_customer_id":{"type":"string"},"external_customer_id":{"type":"string","minLength":1,"maxLength":200},"external_event_id":{"type":"string","minLength":1,"maxLength":128},"external_order_id":{"type":"string","minLength":1,"maxLength":128},"event_type":{"type":"string","description":"One of ORDER_PAID, ORDER_FULFILLED, ORDER_CANCELLED, ORDER_REFUNDED. Other values are rejected with UNSUPPORTED_EVENT_TYPE."},"event_time":{"type":"string","format":"date-time"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"eligible_amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,6})?$"},"gross_amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,6})?$"},"original_order_id":{"type":"string","maxLength":128,"nullable":true},"external_refund_id":{"type":"string","maxLength":200,"nullable":true},"refund_amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,6})?$"},"lines":{"type":"array","items":{"type":"object","properties":{"external_line_id":{"type":"string","minLength":1,"maxLength":100},"eligible_amount":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,6})?$"},"line_total":{"type":"string","pattern":"^(0|[1-9][0-9]*)(\\.[0-9]{1,6})?$"},"sku":{"type":"string","maxLength":200},"quantity":{"type":"string"}},"required":["external_line_id","eligible_amount"],"additionalProperties":false},"maxItems":500,"default":[]}},"required":["external_event_id","external_order_id","event_type","event_time","currency","eligible_amount"],"additionalProperties":false}}}},"responses":{"202":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"event_id":"oev_788324971b314df7bc0d817f5d1b4bf0","status":"ACCEPTED","request_id":"req_6c7b708729b54bfba588c1bb23bb7edf","processing_state":"APPLIED","hold_reason":null,"order_id":"ord_5d301e36b5a949acb2f4ecab2b5656a3","refund_id":null,"external_event_id":"evt-1001","event_type":"ORDER_PAID"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Orders"],"summary":"Order events you sent and what happened to each","operationId":"get_order_events","security":[{"secretKey":[]}],"x-required-scope":"rewards:read","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"external_order_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"data":[{"event_id":"oev_788324971b314df7bc0d817f5d1b4bf0","status":"APPLIED","request_id":"req_67aa1edfadb64e6bb238a8cd2b36af06","processing_state":"APPLIED","hold_reason":null,"order_id":"ord_5d301e36b5a949acb2f4ecab2b5656a3","refund_id":null,"external_event_id":"evt-1001","event_type":"ORDER_PAID","received_at":"2026-11-04T15:39:53.590Z","processed_at":"2026-11-04T15:39:53.590Z","event_time":"2026-11-04T10:15:00.000Z","external_order_id":"ORDER-1001"}]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders":{"post":{"tags":["Orders"],"summary":"Submit an order (v1.0; prefer order events)","operationId":"post_orders","security":[{"secretKey":[]}],"x-required-scope":"orders:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_order_id":{"type":"string","minLength":1,"maxLength":200},"channel_id":{"type":"string"},"member":{"type":"object","properties":{"external_customer_id":{"type":"string","minLength":1,"maxLength":200},"id":{"type":"string"}},"additionalProperties":false},"status":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"gross_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"eligible_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"tax_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"shipping_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"discount_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"order_time":{"type":"string","format":"date-time"},"lines":{"type":"array","items":{"type":"object","properties":{"external_line_id":{"type":"string","minLength":1,"maxLength":100},"product_id":{"type":"string","maxLength":200},"sku":{"type":"string","maxLength":200},"category_id":{"type":"string","maxLength":200},"quantity":{"type":"string","pattern":"^\\d+(\\.\\d{1,6})?$"},"unit_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"line_total_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"eligible_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["external_line_id","quantity","line_total_minor","eligible_amount_minor"],"additionalProperties":false},"maxItems":500}},"required":["external_order_id","member","status","currency","gross_amount_minor","eligible_amount_minor","order_time"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"ord_380718414bee45f9987cae7122ab2035","external_order_id":"ORDER-2001","status":"REWARD_POSTED","member":{"id":"mem_0a54dda828544a199b39815545072024","external_customer_id":"CUST-1002"},"currency":"GHS","gross_amount_minor":25000,"eligible_amount_minor":25000,"refunded_amount_minor":0,"order_time":"2026-11-04T09:30:00.000Z","reward_calculation":{"config_version_id":"cfg_3b2f5b5f2bed4919bae0714352202a5b","tier_code":"BRONZE","eligible_amount_minor":25000,"currency":"GHS","cashback_bps":100,"cashback_amount":"2.5","cashback_minor":250,"points_per_cashback_unit":"0.369","point_multiplier":"1.000","reward_points_awarded":"0.922500","reward_state":"AVAILABLE","birthday_month":false},"refunds":[]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/by-external-id/{externalId}":{"get":{"tags":["Orders"],"summary":"Find an order by your order id","operationId":"get_orders_by_external_id_externalId","security":[{"secretKey":[]}],"x-required-scope":"rewards:read","parameters":[{"name":"externalId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"ord_380718414bee45f9987cae7122ab2035","external_order_id":"ORDER-2001","status":"REWARD_POSTED","member":{"id":"mem_0a54dda828544a199b39815545072024","external_customer_id":"CUST-1002"},"currency":"GHS","gross_amount_minor":25000,"eligible_amount_minor":25000,"refunded_amount_minor":0,"order_time":"2026-11-04T09:30:00.000Z","reward_calculation":{"config_version_id":"cfg_3b2f5b5f2bed4919bae0714352202a5b","tier_code":"BRONZE","eligible_amount_minor":25000,"currency":"GHS","cashback_bps":100,"cashback_amount":"2.5","cashback_minor":250,"points_per_cashback_unit":"0.369","point_multiplier":"1.000","reward_points_awarded":"0.922500","reward_state":"AVAILABLE","birthday_month":false},"refunds":[]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}":{"get":{"tags":["Orders"],"summary":"Get an order","operationId":"get_orders_id","security":[{"secretKey":[]}],"x-required-scope":"rewards:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"ord_380718414bee45f9987cae7122ab2035","external_order_id":"ORDER-2001","status":"REWARD_POSTED","member":{"id":"mem_0a54dda828544a199b39815545072024","external_customer_id":"CUST-1002"},"currency":"GHS","gross_amount_minor":25000,"eligible_amount_minor":25000,"refunded_amount_minor":0,"order_time":"2026-11-04T09:30:00.000Z","reward_calculation":{"config_version_id":"cfg_3b2f5b5f2bed4919bae0714352202a5b","tier_code":"BRONZE","eligible_amount_minor":25000,"currency":"GHS","cashback_bps":100,"cashback_amount":"2.5","cashback_minor":250,"points_per_cashback_unit":"0.369","point_multiplier":"1.000","reward_points_awarded":"0.922500","reward_state":"AVAILABLE","birthday_month":false},"refunds":[]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}/refunds":{"post":{"tags":["Orders"],"summary":"Refund part or all of an order (v1.0; prefer order events)","operationId":"post_orders_id_refunds","security":[{"secretKey":[]}],"x-required-scope":"orders:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_refund_id":{"type":"string","minLength":1,"maxLength":200},"refund_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"eligible_refund_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"refund_time":{"type":"string","format":"date-time"}},"required":["external_refund_id","refund_amount_minor","eligible_refund_amount_minor","currency","refund_time"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rfd_ff479068fc5847a8b79876ca69664d68","external_refund_id":"REFUND-2001","order_id":"ord_380718414bee45f9987cae7122ab2035","currency":"GHS","refund_amount_minor":5000,"eligible_refund_amount_minor":5000,"reversal":{"reward_points_reversed":"0.184500","reward_points_shortfall":"0.000000"},"order_status":"PARTIALLY_REFUNDED","refund_time":"2026-11-04T11:00:00.000Z"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/merchant/reports/wallet-liability":{"get":{"tags":["Reports"],"summary":"Outstanding points and their value, by state","operationId":"get_merchant_reports_wallet_liability","security":[{"secretKey":[]}],"x-required-scope":"rewards:read","parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","as_of":"2026-11-04","environment":"SANDBOX","points_outstanding":"0.003671","by_state":{"pending":"0.000000","available":"0.003671","reserved":"0.000000","recovery_due":"0.000000"},"wallets_with_activity":1,"valuation_policy_status":"NOT_APPROVED","monetary_liability_value":null,"currency":"GHS"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/redemptions/quote":{"post":{"tags":["Redemptions"],"summary":"Quote how much of a basket points can pay","operationId":"post_redemptions_quote","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"member_id":{"type":"string"},"external_customer_id":{"type":"string"},"cart_reference":{"type":"string","minLength":1,"maxLength":200},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"eligible_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"requested_reward_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"basket":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":200},"quantity":{"anyOf":[{"type":"number","exclusiveMinimum":true,"minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,6})?$"}]},"line_total_minor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sku","quantity","line_total_minor"],"additionalProperties":false},"minItems":1,"maxItems":500},"basket_hash":{"type":"string","pattern":"^sha256:[0-9a-f]{64}$"}},"required":["cart_reference","currency","eligible_amount_minor"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"quote_id":"rq_8e0c0fcfe92240c0a1fde8b1855efa8e","member_id":"mem_f8f88725ab684bf7be30f49c70f8361d","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","currency":"GHS","eligible_amount_minor":3000,"available_points":"1.845000","available_value_minor":499,"point_value_minor":271,"max_redeemable_minor":499,"approved_reward_minor":499,"points_to_redeem":"1.841329","cash_remainder_minor":2501,"restrictions":["REQUEST_REDUCED_TO_MAXIMUM"],"expires_at":"2026-11-04T15:54:53.655Z","basket_hash":"sha256:fc1954f44c3758fc993e9accddff63074bb5ecbc791a2638b9776a5624fcabae","config_version":1,"policy_version_id":"cfg_3b2f5b5f2bed4919bae0714352202a5b","environment":"SANDBOX","quote_token":"EXAMPLE_QUOTE_TOKEN"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/redemptions/reserve":{"post":{"tags":["Redemptions"],"summary":"Reserve points with a signed quote token (v1.1)","operationId":"post_redemptions_reserve","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quote_id":{"type":"string"},"quote_token":{"type":"string","minLength":20,"maxLength":1000},"external_order_id":{"type":"string","minLength":1,"maxLength":128},"basket":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":200},"quantity":{"anyOf":[{"type":"number","exclusiveMinimum":true,"minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,6})?$"}]},"line_total_minor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sku","quantity","line_total_minor"],"additionalProperties":false},"minItems":1,"maxItems":500},"basket_hash":{"type":"string","pattern":"^sha256:[0-9a-f]{64}$"}},"required":["quote_id","quote_token","external_order_id"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","reservation_id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","quote_id":"rq_8e0c0fcfe92240c0a1fde8b1855efa8e","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","status":"RESERVED","state":"RESERVED","currency":"GHS","amount_minor":499,"points":"1.841329","cart_reference":"CART-77","cash_remainder_minor":2501,"external_order_id":"ORDER-1002","merchant_payment_reference":null,"release_reason":null,"refunded_minor":0,"refunded_points":"0.000000","reservation_expires_at":"2026-11-04T15:54:53.665Z","expires_at":"2026-11-04T15:54:53.665Z","committed_at":null,"released_at":null,"external_redemption_reference":null,"journal_id":"jrn_cfbc8cf384db4ffda09d2a7a454dd936"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/redemptions/{quoteId}/reserve":{"post":{"tags":["Redemptions"],"summary":"Reserve points for a quote (v1.0)","operationId":"post_redemptions_quoteId_reserve","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[{"name":"quoteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"basket":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":200},"quantity":{"anyOf":[{"type":"number","exclusiveMinimum":true,"minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,6})?$"}]},"line_total_minor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sku","quantity","line_total_minor"],"additionalProperties":false},"minItems":1,"maxItems":500}},"required":["basket"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rdm_55f46cc0d415462882eed4af0fc8f284","reservation_id":"rdm_55f46cc0d415462882eed4af0fc8f284","quote_id":"rq_3a99d17aadb7417c987cf4f29f378b7f","wallet_id":"acc_aa2a0eed11ac4b798109661c9c81ac34","status":"RESERVED","state":"RESERVED","currency":"GHS","amount_minor":100,"points":"0.369004","cart_reference":"CART-90","cash_remainder_minor":900,"external_order_id":null,"merchant_payment_reference":null,"release_reason":null,"refunded_minor":0,"refunded_points":"0.000000","reservation_expires_at":"2026-11-04T15:54:56.382Z","expires_at":"2026-11-04T15:54:56.382Z","committed_at":null,"released_at":null,"external_redemption_reference":null,"journal_id":"jrn_cc6d9a0a3bf4485293bc3e162c127b99"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/redemptions/{id}":{"get":{"tags":["Redemptions"],"summary":"Get a reservation","operationId":"get_redemptions_id","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","reservation_id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","quote_id":"rq_8e0c0fcfe92240c0a1fde8b1855efa8e","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","status":"RESERVED","state":"RESERVED","currency":"GHS","amount_minor":499,"points":"1.841329","cart_reference":"CART-77","cash_remainder_minor":2501,"external_order_id":"ORDER-1002","merchant_payment_reference":null,"release_reason":null,"refunded_minor":0,"refunded_points":"0.000000","reservation_expires_at":"2026-11-04T15:54:53.665Z","expires_at":"2026-11-04T15:54:53.665Z","committed_at":null,"released_at":null,"external_redemption_reference":null,"journal_id":"jrn_cfbc8cf384db4ffda09d2a7a454dd936"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/redemptions/{id}/commit":{"post":{"tags":["Redemptions"],"summary":"Commit a reservation after payment succeeds","operationId":"post_redemptions_id_commit","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_redemption_reference":{"type":"string","minLength":1,"maxLength":200},"external_order_id":{"type":"string","minLength":1,"maxLength":128},"merchant_payment_reference":{"type":"string","minLength":1,"maxLength":200}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","reservation_id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","quote_id":"rq_8e0c0fcfe92240c0a1fde8b1855efa8e","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","status":"COMMITTED","state":"COMMITTED","currency":"GHS","amount_minor":499,"points":"1.841329","cart_reference":"CART-77","cash_remainder_minor":2501,"external_order_id":"ORDER-1002","merchant_payment_reference":"PAY-5521","release_reason":null,"refunded_minor":0,"refunded_points":"0.000000","reservation_expires_at":"2026-11-04T15:54:53.665Z","expires_at":"2026-11-04T15:54:53.665Z","committed_at":"2026-11-04T15:39:53.685Z","released_at":null,"external_redemption_reference":null,"journal_id":"jrn_fbac37dce73b40dd98ba2cc723ccc596"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/redemptions/{id}/release":{"post":{"tags":["Redemptions"],"summary":"Release a reservation (payment failed, abandoned, cancelled)","operationId":"post_redemptions_id_release","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","enum":["PAYMENT_FAILED","ABANDONED","ORDER_CANCELLED","EXPIRED","MANUAL_REVIEW"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rdm_55f46cc0d415462882eed4af0fc8f284","reservation_id":"rdm_55f46cc0d415462882eed4af0fc8f284","quote_id":"rq_3a99d17aadb7417c987cf4f29f378b7f","wallet_id":"acc_aa2a0eed11ac4b798109661c9c81ac34","status":"RELEASED","state":"RELEASED","currency":"GHS","amount_minor":100,"points":"0.369004","cart_reference":"CART-90","cash_remainder_minor":900,"external_order_id":null,"merchant_payment_reference":null,"release_reason":"ABANDONED","refunded_minor":0,"refunded_points":"0.000000","reservation_expires_at":"2026-11-04T15:54:56.382Z","expires_at":"2026-11-04T15:54:56.382Z","committed_at":null,"released_at":"2026-11-04T15:39:56.396Z","external_redemption_reference":null,"journal_id":"jrn_b12991df63654ee086332487e7014b3e"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/redemptions/{id}/refunds":{"post":{"tags":["Redemptions"],"summary":"Give back points used on a refunded order","operationId":"post_redemptions_id_refunds","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_refund_id":{"type":"string","minLength":1,"maxLength":200},"amount_minor":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":9007199254740991}},"required":["external_refund_id","amount_minor"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","reservation_id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","quote_id":"rq_8e0c0fcfe92240c0a1fde8b1855efa8e","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","status":"COMMITTED","state":"COMMITTED","currency":"GHS","amount_minor":499,"points":"1.841329","cart_reference":"CART-77","cash_remainder_minor":2501,"external_order_id":"ORDER-1002","merchant_payment_reference":"PAY-5521","release_reason":null,"refunded_minor":100,"refunded_points":"0.369003","reservation_expires_at":"2026-11-04T15:54:53.665Z","expires_at":"2026-11-04T15:54:53.665Z","committed_at":"2026-11-04T15:39:53.685Z","released_at":null,"external_redemption_reference":null,"journal_id":"jrn_fbac37dce73b40dd98ba2cc723ccc596"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/redemptions/{id}/receipt":{"get":{"tags":["Redemptions"],"summary":"Receipt for a committed redemption","operationId":"get_redemptions_id_receipt","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"receipt_number":"RCPT-9C6DE44FFDF4","transaction_id":"rdm_9c6de44ffdf44ff78a71df73420f6bd6","status":"COMMITTED","merchant":{"id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","name":"Example Shop","programme":"Example Shop"},"member_id":"mem_f8f88725ab684bf7be30f49c70f8361d","external_order_id":"ORDER-1002","merchant_payment_reference":"PAY-5521","points_redeemed":"1.841329","discount_minor":499,"currency":"GHS","points_restored":"0.000000","discount_refunded_minor":0,"reserved_at":"2026-11-04T15:39:53.665Z","committed_at":"2026-11-04T15:39:53.685Z","released_at":null}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/checkout-sessions":{"post":{"tags":["Checkout widget"],"summary":"Open a checkout session and get a token for <reward-checkout>","operationId":"post_checkout_sessions","security":[{"secretKey":[]}],"x-required-scope":"redemptions:write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"member_id":{"type":"string"},"external_customer_id":{"type":"string","maxLength":128},"cart_reference":{"type":"string","minLength":1,"maxLength":200},"external_order_id":{"type":"string","minLength":1,"maxLength":128},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"eligible_amount_minor":{"type":"integer","minimum":0,"maximum":9007199254740991},"basket":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":200},"quantity":{"anyOf":[{"type":"number","exclusiveMinimum":true,"minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,6})?$"}]},"line_total_minor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sku","quantity","line_total_minor"],"additionalProperties":false},"minItems":1,"maxItems":500}},"required":["cart_reference","external_order_id","currency","eligible_amount_minor","basket"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"checkout_token":"EXAMPLE_CHECKOUT_TOKEN","expires_in":900,"wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","widget_script_url":"http://localhost:4000/widget/v1/reward-checkout.js"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/member-sessions":{"post":{"tags":["Rendo Hub"],"summary":"Short-lived token that opens the Rendo Hub for one customer","operationId":"post_member_sessions","security":[{"secretKey":[]}],"x-required-scope":"members:read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"member_id":{"type":"string"},"external_customer_id":{"type":"string","maxLength":128}},"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"token":"EXAMPLE_TOKEN","expires_in":600,"rewards_hub_url":"http://localhost:3001/#token=EXAMPLE_TOKEN"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/identity-link-tokens":{"post":{"tags":["Rendo linking"],"summary":"Proof your signed-in customer owns their wallet, for linking to Rendo","operationId":"post_identity_link_tokens","security":[{"secretKey":[]}],"x-required-scope":"members:write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"member_id":{"type":"string"},"external_customer_id":{"type":"string","maxLength":128}},"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"claim_token":"EXAMPLE_CLAIM_TOKEN","merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","expires_at":"2026-11-04T15:49:53.716Z","link_url":"http://localhost:3001/#link=lct_oHN0J9x3rDIwpTwezOz67MMtzRzPOXsp&merchant=ten_5e7a0e16e3cb472abc76a2817f759dbe"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-endpoints":{"get":{"tags":["Webhooks"],"summary":"List webhook endpoints","operationId":"get_webhook_endpoints","security":[{"secretKey":[]}],"x-required-scope":"webhooks:manage","parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"data":[{"id":"whe_d0b1a78863c84910b47b837619242b40","url":"http://host.docker.internal:39902/hook","description":"Order system","event_types":["wallet.points.earned","wallet.points.redeemed"],"status":"ACTIVE","health":"HEALTHY","consecutive_failures":0,"secret_hint":"whsec_iSv9…Ecxs","rotated_at":null,"previous_secret_active_until":null,"last_success_at":null,"last_failure_at":null,"created_at":"2026-11-04T15:39:53.575Z"}]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Webhooks"],"summary":"Add a webhook endpoint (the signing secret is shown once)","operationId":"post_webhook_endpoints","security":[{"secretKey":[]}],"x-required-scope":"webhooks:manage","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","maxLength":2000},"event_types":{"type":"array","items":{"type":"string","enum":["member.created","member.updated","member.tier.changed","wallet.points.earned","wallet.points.available","wallet.points.reversed","wallet.points.redeemed","wallet.points.expired","wallet.points.restored","wallet.reservation.created","wallet.reservation.released","wallet.reservation.expired","wallet.balance.adjusted","wallet.recovery.due","wallet.account.frozen","wallet.account.unfrozen","wallet.reconciliation.exception","order.event.held","identity.link.revoked","webhook.test"]},"minItems":1},"description":{"type":"string","maxLength":200}},"required":["url","event_types"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"whe_d0b1a78863c84910b47b837619242b40","url":"http://host.docker.internal:39902/hook","description":"Order system","event_types":["wallet.points.earned","wallet.points.redeemed"],"status":"ACTIVE","health":"HEALTHY","consecutive_failures":0,"secret_hint":"whsec_iSv9…Ecxs","rotated_at":null,"previous_secret_active_until":null,"last_success_at":null,"last_failure_at":null,"created_at":"2026-11-04T15:39:53.575Z","signing_secret":"whsec_EXAMPLE_shown_only_once"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-endpoints/{id}":{"patch":{"tags":["Webhooks"],"summary":"Change an endpoint's URL, events or status","operationId":"patch_webhook_endpoints_id","security":[{"secretKey":[]}],"x-required-scope":"webhooks:manage","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","maxLength":2000},"event_types":{"type":"array","items":{"type":"string","enum":["member.created","member.updated","member.tier.changed","wallet.points.earned","wallet.points.available","wallet.points.reversed","wallet.points.redeemed","wallet.points.expired","wallet.points.restored","wallet.reservation.created","wallet.reservation.released","wallet.reservation.expired","wallet.balance.adjusted","wallet.recovery.due","wallet.account.frozen","wallet.account.unfrozen","wallet.reconciliation.exception","order.event.held","identity.link.revoked","webhook.test"]},"minItems":1},"description":{"type":"string","maxLength":200,"nullable":true},"status":{"type":"string","enum":["ACTIVE","DISABLED"]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"whe_d0b1a78863c84910b47b837619242b40","url":"http://host.docker.internal:39902/hook","description":"Order system (production)","event_types":["wallet.points.earned","wallet.points.redeemed"],"status":"ACTIVE","health":"HEALTHY","consecutive_failures":0,"secret_hint":"whsec_jCMw…v_MQ","rotated_at":"2026-11-04T15:39:53.732Z","previous_secret_active_until":"2026-11-05T15:39:53.732Z","last_success_at":"2026-11-04T15:39:54.218Z","last_failure_at":null,"created_at":"2026-11-04T15:39:53.575Z"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-endpoints/{id}/rotate-secret":{"post":{"tags":["Webhooks"],"summary":"Rotate the signing secret (the old one works for 24 hours)","operationId":"post_webhook_endpoints_id_rotate_secret","security":[{"secretKey":[]}],"x-required-scope":"webhooks:manage","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"whe_d0b1a78863c84910b47b837619242b40","url":"http://host.docker.internal:39902/hook","description":"Order system","event_types":["wallet.points.earned","wallet.points.redeemed"],"status":"ACTIVE","health":"HEALTHY","consecutive_failures":0,"secret_hint":"whsec_jCMw…v_MQ","rotated_at":"2026-11-04T15:39:53.732Z","previous_secret_active_until":"2026-11-05T15:39:53.732Z","last_success_at":null,"last_failure_at":null,"created_at":"2026-11-04T15:39:53.575Z","signing_secret":"whsec_EXAMPLE_shown_only_once"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-endpoints/{id}/test":{"post":{"tags":["Webhooks"],"summary":"Send a test event","operationId":"post_webhook_endpoints_id_test","security":[{"secretKey":[]}],"x-required-scope":"webhooks:manage","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"event_id":"evt_c68acde588e040ba93e564fc5bc2f383"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-deliveries":{"get":{"tags":["Webhooks"],"summary":"Recent deliveries and their attempts","operationId":"get_webhook_deliveries","security":[{"secretKey":[]}],"x-required-scope":"webhooks:manage","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"endpoint_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"data":[{"id":"whd_4393e3cf283742b893e35b405481ff39","event_id":"evt_4281e0352a554007a5f848cae1e324cf","event_type":"wallet.points.earned","endpoint_id":"whe_d0b1a78863c84910b47b837619242b40","url":"http://host.docker.internal:39902/hook","status":"SUCCEEDED","attempts":1,"next_attempt_at":null,"last_attempt_at":"2026-11-04T15:39:54.203Z","last_response_status":200,"last_duration_ms":9,"last_error":null,"created_at":"2026-11-04T15:39:54.181Z"},{"id":"whd_d2b2c266a9e54fe283d7d77850bd824f","event_id":"evt_ea86a2c8252a4b9385372b1a977e352b","event_type":"wallet.points.redeemed","endpoint_id":"whe_d0b1a78863c84910b47b837619242b40","url":"http://host.docker.internal:39902/hook","status":"SUCCEEDED","attempts":1,"next_attempt_at":null,"last_attempt_at":"2026-11-04T15:39:54.213Z","last_response_status":200,"last_duration_ms":2,"last_error":null,"created_at":"2026-11-04T15:39:54.181Z"}]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-deliveries/{id}":{"get":{"tags":["Webhooks"],"summary":"One delivery","operationId":"get_webhook_deliveries_id","security":[{"secretKey":[]}],"x-required-scope":"webhooks:manage","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"whd_4a954b893bbb4818b3e91eeaf3538990","event_id":"evt_e01ebf804ed944a7a9df071d7899a34d","event_type":"webhook.test","endpoint_id":"whe_20f6e5aec050499fa68b30cda6f2c79d","url":"http://host.docker.internal:9/unreachable","status":"PENDING","attempts":[{"attempt":1,"requested_at":"2026-11-04T15:39:59.211Z","response_status":null,"duration_ms":0,"response_excerpt":null,"error":"fetch failed"}],"next_attempt_at":"2026-11-04T15:40:29.211Z","last_attempt_at":"2026-11-04T15:39:59.211Z","last_response_status":null,"last_duration_ms":0,"last_error":"fetch failed","created_at":"2026-11-04T15:39:59.181Z"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-deliveries/{id}/retry":{"post":{"tags":["Webhooks"],"summary":"Retry a failed delivery","operationId":"post_webhook_deliveries_id_retry","security":[{"secretKey":[]}],"x-required-scope":"webhooks:manage","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"whd_4a954b893bbb4818b3e91eeaf3538990","status":"PENDING"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/reward-account":{"get":{"tags":["Rendo Hub"],"summary":"The signed-in customer's balances and tier","operationId":"get_me_reward_account","security":[{"memberToken":[]}],"parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"member":{"first_name":"Ama","tier":{"code":"BRONZE","name":"Bronze"}},"member_id":"mem_8eaf86804a9b474c88f945b00d3600db","programme_id":"prg_bfd6107dc64c4239a721d83f74d39c14","environment":"SANDBOX","tier":{"code":"BRONZE","name":"Bronze","cashback_bps":100,"birthday_multiplier":"1","qualification":"MANUAL"},"reward_wallet":{"unit":"REWARD_POINTS","pending_points":"0.000000","available_points":"6.642000","reserved_points":"0.000000","recovery_due_points":"0.000000","expired_points":"0.000000","status":"ACTIVE","currency":"GHS","point_value_minor":271,"available_value_minor":1799,"redeemable":true,"next_expiry_at":null}}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/reward-history":{"get":{"tags":["Rendo Hub"],"summary":"The signed-in customer's history","operationId":"get_me_reward_history","security":[{"memberToken":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"reference","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"data":[{"journal_id":"jrn_efdcc90ddbf3493aa351cc454bcf52ba","type":"EARN","value_type":"REWARD_POINTS","entry_type":"POINTS_EARNED","currency":"GHS","reference":"TL-SEED-001","occurred_at":"2026-11-04T14:33:50.449Z","effect":{"available_points":"6.642000"}}],"has_more":false,"next_cursor":null}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/statement":{"get":{"tags":["Rendo Hub"],"summary":"The signed-in customer's statement","operationId":"get_me_statement","security":[{"memberToken":[]}],"parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"from":"2000-01-01T00:00:00.000Z","to":"2026-11-04T15:39:59.623Z","opening_balance_points":"0.000000","lines":[{"date":"2026-11-04T14:33:50.443Z","description":"POINTS_EARNED","reference":"TL-SEED-001","credit_points":"6.642000","debit_points":null,"balance_points":"6.642000"}],"closing_balance_points":"6.642000","issued_entry_types":["POINTS_EARNED_PENDING","POINTS_EARNED"]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/programme":{"get":{"tags":["Rendo Hub"],"summary":"Public programme rules and branding","operationId":"get_me_programme","security":[{"memberToken":[]}],"parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"prg_bfd6107dc64c4239a721d83f74d39c14","public_name":"Tiptoe Lane Rewards","slug":"tiptoe-rewards","currency":"GHS","timezone":"Africa/Accra","locale":"en-GH","config_version":1,"theme":{"brand":"#c2532b"},"environment":"SANDBOX","reward_points":{"points_per_cashback_unit":"0.369","point_value_minor":271,"precision":6,"birthday_multiplier_applies":true,"redeemable":true},"tier_qualification":"MANUAL","tiers":[{"code":"BRONZE","name":"Bronze","rank":1,"cashback_bps":100,"birthday_multiplier":"1"},{"code":"SILVER","name":"Silver","rank":2,"cashback_bps":200,"birthday_multiplier":"2"}],"initial_tier":"BRONZE","redemption":{"max_percent_of_eligible":100}}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/notifications":{"get":{"tags":["Rendo Hub"],"summary":"Notices built from ledger events","operationId":"get_me_notifications","security":[{"memberToken":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"unread_count":2,"data":[{"id":"ntf_1a3e1121719e48ea8656ce1c9652ce0a","category":"TRANSACTIONAL","kind":"EARN_CONFIRMED","title":"You earned 6.642 points","body":"6.642 Reward Points on order TL-SEED-001 are ready to use at Tiptoe Lane Rewards.","created_at":"2026-11-04T14:33:53.711Z","read":false},{"id":"ntf_4511be554e0a43a887af6d8b38f5d0e2","category":"SECURITY","kind":"LINK_ADDED","title":"Added to a Rendo wallet","body":"Your rewards here are now shown in a Rendo wallet. They still can only be used at this store. If you did not do this, contact the store.","created_at":"2026-11-04T14:33:50.579Z","read":false}]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/notifications/read-all":{"post":{"tags":["Rendo Hub"],"summary":"Mark every notice read","operationId":"post_me_notifications_read_all","security":[{"memberToken":[]}],"parameters":[],"responses":{"204":{"description":"Success. No content."},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/notifications/{id}/read":{"post":{"tags":["Rendo Hub"],"summary":"Mark one notice read","operationId":"post_me_notifications_id_read","security":[{"memberToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success. No content."},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/notification-preferences":{"get":{"tags":["Rendo Hub"],"summary":"Email and marketing choices","operationId":"get_me_notification_preferences","security":[{"memberToken":[]}],"parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"in_app":{"transactional":true,"security":true,"note":"Notices about your points and account always appear in the Rendo Hub."},"email_transactional":true,"email_security":true,"marketing_consent":false,"marketing_consent_at":null}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Rendo Hub"],"summary":"Change email and marketing choices","operationId":"post_me_notification_preferences","security":[{"memberToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email_transactional":{"type":"boolean"},"marketing_consent":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"in_app":{"transactional":true,"security":true,"note":"Notices about your points and account always appear in the Rendo Hub."},"email_transactional":true,"email_security":true,"marketing_consent":false,"marketing_consent_at":null}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/support-cases":{"get":{"tags":["Rendo Hub"],"summary":"The customer's questions to support","operationId":"get_me_support_cases","security":[{"memberToken":[]}],"parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"data":[{"id":"sup_38c93b2cd6a5408aa3b3da31b871f5af","reference":"SUP-000002","category":"MISSING_POINTS","subject":"Points from ORDER-1001 are missing","status":"OPEN","journal_id":null,"external_order_id":"ORDER-1001","resolution":null,"created_at":"2026-11-04T15:39:59.647Z","updated_at":"2026-11-04T15:39:59.647Z","resolved_at":null,"messages":[{"from":"Member","body":"I paid for ORDER-1001 but the points have not appeared.","internal":false,"at":"2026-11-04T15:39:59.647Z"}]}]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Rendo Hub"],"summary":"Ask support about points or a transaction","operationId":"post_me_support_cases","security":[{"memberToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"type":"string","enum":["MISSING_POINTS","WRONG_AMOUNT","REDEMPTION_PROBLEM","REFUND","ACCOUNT_ACCESS","OTHER"]},"subject":{"type":"string","minLength":3,"maxLength":200},"message":{"type":"string","minLength":5,"maxLength":4000},"journal_id":{"type":"string"},"external_order_id":{"type":"string","maxLength":128}},"required":["category","subject","message"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"sup_38c93b2cd6a5408aa3b3da31b871f5af","reference":"SUP-000002","category":"MISSING_POINTS","subject":"Points from ORDER-1001 are missing","status":"OPEN","journal_id":null,"external_order_id":"ORDER-1001","resolution":null,"created_at":"2026-11-04T15:39:59.647Z","updated_at":"2026-11-04T15:39:59.647Z","resolved_at":null,"messages":[{"from":"Member","body":"I paid for ORDER-1001 but the points have not appeared.","internal":false,"at":"2026-11-04T15:39:59.647Z"}]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/missions":{"get":{"tags":["Rendo Hub"],"summary":"Live missions of the merchant with exact progress (empty when the module is off)","operationId":"get_me_missions","security":[{"memberToken":[]}],"parameters":[],"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/rewards":{"get":{"tags":["Rendo Hub"],"summary":"Rewards on offer and your claims (empty when the module is off)","operationId":"get_me_rewards","security":[{"memberToken":[]}],"parameters":[],"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/rewards/{id}/claim":{"post":{"tags":["Rendo Hub"],"summary":"Swap available points for a reward; returns a claim code","operationId":"post_me_rewards_id_claim","security":[{"memberToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/vault":{"get":{"tags":["Rendo Hub"],"summary":"Vault settings and your locks (enabled: false when off)","operationId":"get_me_vault","security":[{"memberToken":[]}],"parameters":[],"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/vault/locks":{"post":{"tags":["Rendo Hub"],"summary":"Lock some available points until a date","operationId":"post_me_vault_locks","security":[{"memberToken":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"points":{"type":"string","pattern":"^\\d{1,9}(\\.\\d{1,6})?$"},"days":{"type":"integer","minimum":1,"maximum":365}},"required":["points","days"],"additionalProperties":false}}}},"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/groups":{"get":{"tags":["Rendo Hub"],"summary":"Group goals on offer and your groups with progress (empty when the module is off)","operationId":"get_me_groups","security":[{"memberToken":[]}],"parameters":[],"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Rendo Hub"],"summary":"Start a group for a goal","operationId":"post_me_groups","security":[{"memberToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"goal_id":{"type":"string"},"name":{"type":"string","minLength":2,"maxLength":60}},"required":["goal_id","name"],"additionalProperties":false}}}},"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/groups/join":{"post":{"tags":["Rendo Hub"],"summary":"Join a group with a single-use invite","operationId":"post_me_groups_join","security":[{"memberToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":10,"maxLength":100}},"required":["token"],"additionalProperties":false}}}},"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/groups/{id}/invite":{"post":{"tags":["Rendo Hub"],"summary":"Make a single-use invite for a group you belong to","operationId":"post_me_groups_id_invite","security":[{"memberToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/groups/{id}/leave":{"post":{"tags":["Rendo Hub"],"summary":"Leave a group","operationId":"post_me_groups_id_leave","security":[{"memberToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/vault/locks/{id}/unlock":{"post":{"tags":["Rendo Hub"],"summary":"Unlock early: every point returns, the bonus is forfeited","operationId":"post_me_vault_locks_id_unlock","security":[{"memberToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"2XX":{"description":"Success"},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/support-cases/{id}/messages":{"post":{"tags":["Rendo Hub"],"summary":"Reply on a support case","operationId":"post_me_support_cases_id_messages","security":[{"memberToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":4000}},"required":["message"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"sup_38c93b2cd6a5408aa3b3da31b871f5af","reference":"SUP-000002","category":"MISSING_POINTS","subject":"Points from ORDER-1001 are missing","status":"OPEN","journal_id":null,"external_order_id":"ORDER-1001","resolution":null,"created_at":"2026-11-04T15:39:59.647Z","updated_at":"2026-11-04T15:39:59.659Z","resolved_at":null,"messages":[{"from":"Member","body":"I paid for ORDER-1001 but the points have not appeared.","internal":false,"at":"2026-11-04T15:39:59.647Z"},{"from":"Member","body":"Any update on this, please?","internal":false,"at":"2026-11-04T15:39:59.659Z"}]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/platform/auth/start":{"post":{"tags":["Rendo wallet"],"summary":"Email a one-time sign-in code","operationId":"post_platform_auth_start","security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":320}},"required":["email"],"additionalProperties":false}}}},"responses":{"202":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"status":"CODE_SENT","message":"If this address can receive email, a 6-digit code is on its way."}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/platform/auth/verify":{"post":{"tags":["Rendo wallet"],"summary":"Exchange the code for a session","operationId":"post_platform_auth_verify","security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":320},"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["email","code"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"token":"EXAMPLE_TOKEN","expires_in":3600,"platform_user_id":"pu_27de8620bd9a48f399fcbee10e2197e7","created":false}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/public/demo-requests":{"post":{"tags":["Website"],"summary":"Ask the Rendo team for a demo (rate-limited; no payment details)","operationId":"post_public_demo_requests","security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":120},"work_email":{"type":"string","format":"email","maxLength":254},"company":{"type":"string","minLength":2,"maxLength":160},"role":{"type":"string","maxLength":120},"website":{"type":"string","maxLength":300},"platform":{"type":"string","enum":["SHOPIFY","WOOCOMMERCE","MAGENTO","CUSTOM","OTHER","NOT_SURE"]},"monthly_orders":{"type":"string","enum":["UNDER_1K","1K_10K","10K_100K","OVER_100K"]},"message":{"type":"string","maxLength":2000},"consent":{"type":"boolean","enum":[true]},"company_fax":{"type":"string","maxLength":200}},"required":["name","work_email","company","platform","consent"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"reference":"DEMO-1A2B3C4D","status":"RECEIVED","message":"Thanks. Someone from Rendo will reply to your work email."}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/platform/me":{"get":{"tags":["Rendo wallet"],"summary":"The signed-in Rendo user","operationId":"get_platform_me","security":[{"platformToken":[]}],"parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"pu_27de8620bd9a48f399fcbee10e2197e7","email":"a••@example.com","created_at":"2026-11-04T14:33:50.488Z","last_sign_in_at":"2026-11-04T15:39:59.546Z","linked_wallets":2}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/platform/sessions/revoke":{"post":{"tags":["Rendo wallet"],"summary":"Sign out everywhere","operationId":"post_platform_sessions_revoke","security":[{"platformToken":[]}],"parameters":[],"responses":{"204":{"description":"Success. No content."},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/identity-links/preview":{"get":{"tags":["Rendo linking"],"summary":"What linking this merchant wallet will show and share","operationId":"get_identity_links_preview","security":[{"platformToken":[]}],"parameters":[{"name":"merchant_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"claim_token","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","merchant_name":"Example Shop","programme_name":"Example Shop","consent_version":"link-consent-2026-10","consent_text":["Show this merchant wallet (balance, tier and activity) in your Rendo wallet.","Your points stay with this merchant: they cannot be spent at, moved to or combined with another merchant."],"expires_at":"2026-11-04T15:49:59.560Z"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/identity-links/claims":{"post":{"tags":["Rendo linking"],"summary":"Consent to link a merchant wallet; a code is emailed","operationId":"post_identity_links_claims","security":[{"platformToken":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"merchant_id":{"type":"string"},"claim_token":{"type":"string","minLength":10,"maxLength":200},"consent_version":{"type":"string"}},"required":["merchant_id","claim_token","consent_version"],"additionalProperties":false}}}},"responses":{"202":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"claim_id":"clm_66b4fe406acb41cba619c1134501f98f","status":"AWAITING_VERIFICATION","merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","merchant_name":"Example Shop","verification_method":"EMAIL_CODE","expires_at":"2026-11-04T15:49:59.570Z","link_id":null}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/identity-links/{id}/verify":{"post":{"tags":["Rendo linking"],"summary":"Confirm the link with the emailed code","operationId":"post_identity_links_id_verify","security":[{"platformToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"verification_token":{"type":"string","pattern":"^\\d{6}$"}},"required":["verification_token"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"lnk_9a6d14d82615415b9ae436530c6669f3","status":"ACTIVE","merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","merchant_name":"Example Shop","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","programme_name":"Example Shop","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","consent_version":"link-consent-2026-10","consented_at":"2026-11-04T15:39:59.570Z","verified_at":"2026-11-04T15:39:59.580Z","revoked_at":null}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/identity-links":{"get":{"tags":["Rendo linking"],"summary":"Linked merchant wallets","operationId":"get_identity_links","security":[{"platformToken":[]}],"parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"data":[{"id":"lnk_c12e2910badc4699a390ad822986c5d6","status":"ACTIVE","merchant_id":"ten_0ac1689e3ccb46f09ac28f8d39403b47","merchant_name":"Tiptoe Lane","programme_id":"prg_bfd6107dc64c4239a721d83f74d39c14","programme_name":"Tiptoe Lane Rewards","wallet_id":"acc_18bce02bdb98497abb3e4bfe10026420","consent_version":"link-consent-2026-10","consented_at":"2026-11-04T14:33:50.564Z","verified_at":"2026-11-04T14:33:50.579Z","revoked_at":null},{"id":"lnk_ed2126f1205c46ee83475d9ebee859a5","status":"ACTIVE","merchant_id":"ten_6b4273e0161248acb149963df9fe2bbf","merchant_name":"Example Shop","programme_id":"prg_a26c56753aac404c99c7672afae149be","programme_name":"Example Shop","wallet_id":"acc_569ca8d170e14f7d9ee1a53575019296","consent_version":"link-consent-2026-10","consented_at":"2026-11-04T15:39:24.602Z","verified_at":"2026-11-04T15:39:24.613Z","revoked_at":null}]}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/identity-links/{id}":{"delete":{"tags":["Rendo linking"],"summary":"Remove a wallet from the Rendo view (the wallet itself is unchanged)","operationId":"delete_identity_links_id","security":[{"platformToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","maxLength":1000}},"additionalProperties":false}}}},"responses":{"204":{"description":"Success. No content."},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/linked-wallets":{"get":{"tags":["Rendo wallet"],"summary":"One card per linked wallet; never a pooled balance","operationId":"get_me_linked_wallets","security":[{"platformToken":[]}],"parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"pooled_redemption_enabled":false,"wallets":[{"id":"acc_18bce02bdb98497abb3e4bfe10026420","merchant_id":"ten_0ac1689e3ccb46f09ac28f8d39403b47","merchant_name":"Tiptoe Lane","programme_id":"prg_bfd6107dc64c4239a721d83f74d39c14","programme_name":"Tiptoe Lane Rewards","points_asset_id":"pas_5d963fa30c2440bca208b5ef11dd3e79","member_id":"mem_8eaf86804a9b474c88f945b00d3600db","tier_code":"BRONZE","tier_name":"Bronze","status":"ACTIVE","unit":"REWARD_POINTS","currency":"GHS","point_value_minor":271,"pooled_spendable":false,"balances":{"pending":"0.000000","available":"6.642000","reserved":"0.000000","locked":"0.000000","expired":"0.000000","recovery_due":"0.000000"},"next_expiry_at":null,"available_actions":["REDEEM_AT_CHECKOUT","VIEW_STATEMENT"],"branding":{"programme_name":"Tiptoe Lane Rewards","theme":{"brand":"#c2532b"}},"environment":"SANDBOX","link_id":"lnk_c12e2910badc4699a390ad822986c5d6","linked_at":"2026-11-04T14:33:50.579Z"},{"id":"acc_569ca8d170e14f7d9ee1a53575019296","merchant_id":"ten_6b4273e0161248acb149963df9fe2bbf","merchant_name":"Example Shop","programme_id":"prg_a26c56753aac404c99c7672afae149be","programme_name":"Example Shop","points_asset_id":"pas_5c9fa2b2a2e84826853b01424f78ea10","member_id":"mem_0877127386e14c8aa482c721117f28cc","tier_code":"BRONZE","tier_name":"Bronze","status":"ACTIVE","unit":"REWARD_POINTS","currency":"GHS","point_value_minor":271,"pooled_spendable":false,"balances":{"pending":"0.000000","available":"0.372674","reserved":"0.000000","locked":"0.000000","expired":"0.000000","recovery_due":"0.000000"},"next_expiry_at":null,"available_actions":["REDEEM_AT_CHECKOUT","VIEW_STATEMENT"],"branding":{"programme_name":"Example Shop","theme":{}},"environment":"SANDBOX","link_id":"lnk_ed2126f1205c46ee83475d9ebee859a5","linked_at":"2026-11-04T15:39:24.613Z"}],"informational_total":{"available_value_minor":2001,"currency":"GHS","spendable":false,"note":"For information only. Each merchant's points can be spent only at that merchant."}}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/me/linked-wallets/{linkId}/session":{"post":{"tags":["Rendo wallet"],"summary":"Open one merchant's Rendo Hub from the wallet","operationId":"post_me_linked_wallets_linkId_session","security":[{"platformToken":[]}],"parameters":[{"name":"linkId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"token":"EXAMPLE_TOKEN","expires_in":600}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/widget/session":{"get":{"tags":["Checkout widget"],"summary":"Wallet and cart for this checkout token","operationId":"get_widget_session","security":[{"checkoutToken":[]}],"parameters":[],"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"wallet":{"id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","merchant_id":"ten_5e7a0e16e3cb472abc76a2817f759dbe","merchant_name":"Example Shop","programme_id":"prg_b3a07621bd6046208917fc70f19cb0a9","programme_name":"Example Shop","points_asset_id":"pas_e439ef84cff247f583f3477187789fd6","member_id":"mem_f8f88725ab684bf7be30f49c70f8361d","tier_code":"BRONZE","tier_name":"Bronze","status":"ACTIVE","unit":"REWARD_POINTS","currency":"GHS","point_value_minor":271,"pooled_spendable":false,"balances":{"pending":"0.000000","available":"0.372674","reserved":"0.000000","locked":"0.000000","expired":"0.000000","recovery_due":"0.000000"},"next_expiry_at":null,"available_actions":["REDEEM_AT_CHECKOUT","VIEW_STATEMENT"],"branding":{"programme_name":"Example Shop","theme":{}},"environment":"SANDBOX"},"cart":{"cart_reference":"CART-95","external_order_id":"ORDER-3001","currency":"GHS","eligible_amount_minor":2000},"expires_at":"2026-11-04T15:54:59.000Z"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/widget/quote":{"post":{"tags":["Checkout widget"],"summary":"Quote points for this basket only","operationId":"post_widget_quote","security":[{"checkoutToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requested_reward_minor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"quote_id":"rq_cab81f8c66a847b58841d9ea70fa93e9","member_id":"mem_f8f88725ab684bf7be30f49c70f8361d","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","currency":"GHS","eligible_amount_minor":2000,"available_points":"0.372674","available_value_minor":100,"point_value_minor":271,"max_redeemable_minor":100,"approved_reward_minor":100,"points_to_redeem":"0.369004","cash_remainder_minor":1900,"restrictions":[],"expires_at":"2026-11-04T15:54:59.691Z","basket_hash":"sha256:e8139944d6fc93ebcc6001d8436b97e0941726df73b994a3ce37323c660f5df2","config_version":1,"policy_version_id":"cfg_3b2f5b5f2bed4919bae0714352202a5b","environment":"SANDBOX","quote_token":"EXAMPLE_QUOTE_TOKEN"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/widget/reserve":{"post":{"tags":["Checkout widget"],"summary":"Reserve points for this basket only; commit stays on your server","operationId":"post_widget_reserve","security":[{"checkoutToken":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quote_id":{"type":"string"},"quote_token":{"type":"string","minLength":20,"maxLength":1000}},"required":["quote_id","quote_token"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rdm_24e59e4e3da441deb02e4df2df895473","reservation_id":"rdm_24e59e4e3da441deb02e4df2df895473","quote_id":"rq_cab81f8c66a847b58841d9ea70fa93e9","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","status":"RESERVED","state":"RESERVED","currency":"GHS","amount_minor":100,"points":"0.369004","cart_reference":"CART-95","cash_remainder_minor":1900,"external_order_id":"ORDER-3001","merchant_payment_reference":null,"release_reason":null,"refunded_minor":0,"refunded_points":"0.000000","reservation_expires_at":"2026-11-04T15:54:59.699Z","expires_at":"2026-11-04T15:54:59.699Z","committed_at":null,"released_at":null,"external_redemption_reference":null,"journal_id":"jrn_e830d53e5a14485ea81ca2738110a2a7"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/widget/release":{"post":{"tags":["Checkout widget"],"summary":"Remove points from this checkout","operationId":"post_widget_release","security":[{"checkoutToken":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":255},"description":"Any unique string per operation. Retrying with the same key and body returns the first result; the same key with a different body is refused."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reservation_id":{"type":"string"}},"required":["reservation_id"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success. The example is a real response from the sandbox, with secrets replaced by placeholders.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":{"id":"rdm_24e59e4e3da441deb02e4df2df895473","reservation_id":"rdm_24e59e4e3da441deb02e4df2df895473","quote_id":"rq_cab81f8c66a847b58841d9ea70fa93e9","wallet_id":"acc_fc41fa6d4055418c9fe1cba691af1b4a","status":"RELEASED","state":"RELEASED","currency":"GHS","amount_minor":100,"points":"0.369004","cart_reference":"CART-95","cash_remainder_minor":1900,"external_order_id":"ORDER-3001","merchant_payment_reference":null,"release_reason":"ABANDONED","refunded_minor":0,"refunded_points":"0.000000","reservation_expires_at":"2026-11-04T15:54:59.699Z","expires_at":"2026-11-04T15:54:59.699Z","committed_at":null,"released_at":"2026-11-04T15:39:59.714Z","external_redemption_reference":null,"journal_id":"jrn_f6ccea7d8a4f4dab8f1bab294067ca03"}}}},"4XX":{"description":"Refused: see error.code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Server error; safe to retry with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"secretKey":{"type":"http","scheme":"bearer","description":"Programme API key, sk_test_... or sk_live_.... Server-side only."},"memberToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"From POST /v1/member-sessions. One customer, read-mostly, short-lived."},"checkoutToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"From POST /v1/checkout-sessions. One customer and one basket, 15 minutes."},"platformToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Rendo wallet sign-in, from POST /v1/platform/auth/verify."}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","example":"INSUFFICIENT_POINTS"},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","additionalProperties":true}}}}}}}}