{ "openapi": "3.1.0", "info": { "title": "LemonPay Hong Kong sandbox API", "version": "20261029-v3", "description": "Read-only owner queries and authenticated demo webhook receipts. Not the official Jincheng bank protocol." }, "servers": [ { "url": "https://api.lemonpay.hk" } ], "paths": { "/v1/ping": { "get": { "summary": "Authenticated client and scopes", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/capabilities": { "get": { "summary": "Enabled read and receipt capabilities", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/accounts": { "get": { "summary": "Owner-scoped receiving accounts", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/incoming": { "get": { "summary": "Owner-scoped incoming payments", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ] } }, "/v1/overview": { "get": { "summary": "Owner overview", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/wallets": { "get": { "summary": "Per-currency synthetic wallet balances", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/wallet-entries": { "get": { "summary": "Owner wallet entries", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/remittances": { "get": { "summary": "Disabled remittance framework", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/fx": { "get": { "summary": "Disabled FX framework", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/cny-clearing": { "get": { "summary": "Disabled clearing framework", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/webhook-receipts": { "get": { "summary": "Latest 100 client receipts", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "403": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "429": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "502": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/incoming/{receiveNo}": { "get": { "summary": "Read one scoped resource", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "parameters": [ { "name": "receiveNo", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "404": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/webhook-receipts/{eventId}": { "get": { "summary": "Read one scoped resource", "security": [ { "BearerKey": [] }, { "ApiKeyHeader": [] } ], "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "404": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/healthz": { "get": { "summary": "Service and original demo reachability", "security": [], "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "503": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/events": { "post": { "summary": "Durably record a signed demo event; no business execution", "servers": [ { "url": "https://hooks.lemonpay.hk" } ], "security": [], "parameters": [ { "name": "X-LemonPay-Event-Id", "in": "header", "required": true, "description": "Stable event ID; reuse for retries", "schema": { "type": "string" } }, { "name": "X-LemonPay-Timestamp", "in": "header", "required": true, "description": "Unix seconds within ±300 seconds", "schema": { "type": "string" } }, { "name": "X-LemonPay-Signature", "in": "header", "required": true, "description": "v1=hex(HMAC-SHA256(timestamp.eventId.rawBody, webhook_secret))", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoEvent" } } } }, "responses": { "200": { "description": "Demo response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "409": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "413": { "description": "Rejected by ingress or application; response body may be gateway-generated." }, "415": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "422": { "description": "Error envelope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } } } }, "/v1/banks/jincheng/notifications": { "post": { "summary": "Jincheng customer status, incoming and RFI notification entry; bank contract not configured", "servers": [ { "url": "https://webhook.lemonpay.hk" } ], "security": [], "responses": { "503": { "description": "Bank callback processing is disabled in this sandbox." } }, "description": "Reserved callback. The Hong Kong sandbox returns HTTP 503 until the bank integration is enabled.", "deprecated": true } }, "/v1/banks/jincheng/notifications/common": { "post": { "summary": "Common bank notifications, including registration result", "servers": [ { "url": "https://webhook.lemonpay.hk" } ], "security": [], "responses": { "503": { "description": "Bank callback processing is disabled in this sandbox." } }, "description": "Reserved callback. The Hong Kong sandbox returns HTTP 503 until the bank integration is enabled." } }, "/v1/banks/jincheng/notifications/incoming": { "post": { "summary": "Electronic ledger incoming-funds notifications", "servers": [ { "url": "https://webhook.lemonpay.hk" } ], "security": [], "responses": { "503": { "description": "Bank callback processing is disabled in this sandbox." } }, "description": "Reserved callback. The Hong Kong sandbox returns HTTP 503 until the bank integration is enabled." } } }, "components": { "securitySchemes": { "BearerKey": { "type": "http", "scheme": "bearer", "description": "Scoped demo API key, server-side use only" }, "ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key" } }, "schemas": { "Meta": { "type": "object", "properties": { "environment": { "const": "demo" }, "requestId": { "type": "string" }, "apiVersion": { "const": "v1" } } }, "DemoEvent": { "type": "object", "required": [ "type", "data" ], "properties": { "type": { "enum": [ "demo.connection.test", "demo.incoming.notification" ] }, "eventId": { "type": "string", "description": "Optional; must equal the header ID" }, "data": { "type": "object" } } } } } }