{ "info": { "_postman_id": "09d4558b7d9c490884466a74", "name": "Surfboard Payments API", "description": "Complete API collection for the Surfboard Payments platform.\n\nThis collection includes all REST API endpoints and webhook event payloads.\n\n## Authentication\nMost API calls require the following headers:\n- `API-KEY`: Your API key\n- `API-SECRET`: Your API secret\n- `MERCHANT-ID`: Your merchant identifier\n\n## Base URL\nSet the `baseUrl` collection variable to your Surfboard API environment URL.\n\n## Getting Started\n1. Set the collection variables (apiKey, apiSecret, merchantId, baseUrl)\n2. Start with the **Authentication** folder to generate tokens\n3. Use the **Merchants** folder to manage merchant onboarding\n4. Create orders and process payments using the respective folders", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Adjustments API", "description": "Adjustments API takes care of handling additional amounts to orders like tips, surcharges, insurance payments etc included while performing a transaction.", "item": [ { "name": "Fetch Adjustments", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/adjustments/:id", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":id" ], "variable": [ { "key": "id", "value": "", "description": "id" } ], "query": [ { "key": "startDate", "value": "", "description": "Start date of the range in yyyy-mm-dd format.", "disabled": true }, { "key": "endDate", "value": "", "description": "End date of the range in yyyy-mm-dd format.", "disabled": true } ] }, "description": "Fetch all adjustments created under a merchant or store.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch Adjustments - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/adjustments/:id", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":id" ], "variable": [ { "key": "id", "value": "", "description": "id" } ], "query": [ { "key": "startDate", "value": "", "description": "Start date of the range in yyyy-mm-dd format.", "disabled": true }, { "key": "endDate", "value": "", "description": "End date of the range in yyyy-mm-dd format.", "disabled": true } ] }, "description": "Fetch all adjustments created under a merchant or store.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t\t{\n\t\t\t\"adjustmentId\": \"81efdbe975ebc800ff\",\n\t\t\t\"adjustmentType\": \"tips\",\n\t\t\t\"amount\": \"100\"\n\t\t}\n\t],\n\t\"message\": \"Adjustments fetched successfully\"\n}" } ] } ] }, { "name": "Admin Functions API", "description": "The Admin Functions API provides comprehensive administrative capabilities for managing user accounts, roles, permissions, and system configurations. These APIs enable partners and merchants to perform administrative operations programmatically, including user account management, role assignments, and system-level configurations with flexible permission controls.", "item": [ { "name": "Create Merchant Account", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/accounts", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "accounts" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@merchant.com\",\n \"role\": \"ADMIN\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a new account for a merchant with specified email and role permissions." }, "response": [ { "name": "Create Merchant Account - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/accounts", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "accounts" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@merchant.com\",\n \"role\": \"ADMIN\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a new account for a merchant with specified email and role permissions." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Initiate Signup sucessfull\"\n}" } ] }, { "name": "Create Partner Account", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/accounts", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "accounts" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@partner.com\",\n \"role\": \"ADMIN\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a new account for a partner with specified email and role permissions." }, "response": [ { "name": "Create Partner Account - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/accounts", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "accounts" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"admin@partner.com\",\n \"role\": \"ADMIN\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a new account for a partner with specified email and role permissions." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Initiate Signup sucessfull\"\n}" } ] } ] }, { "name": "AI API", "description": "The AI API provides powerful artificial intelligence capabilities for merchants to enhance their product management and branding. Generate compelling product descriptions, create professional product images, extract catalog data from images, and develop branding options using advanced AI technology.", "item": [ { "name": "Generate Branding Options", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/ai/branding", "host": [ "{{baseUrl}}" ], "path": [ "ai", "branding" ] }, "body": { "mode": "raw", "raw": "{\n\t\"url\": \"https://example-company.com\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Generate AI-powered branding options and color schemes based on a website URL. Use this API to automatically create cohesive branding themes that match your business identity and enhance your merchant portal appearance." }, "response": [ { "name": "Generate Branding Options - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/ai/branding", "host": [ "{{baseUrl}}" ], "path": [ "ai", "branding" ] }, "body": { "mode": "raw", "raw": "{\n\t\"url\": \"https://example-company.com\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Generate AI-powered branding options and color schemes based on a website URL. Use this API to automatically create cohesive branding themes that match your business identity and enhance your merchant portal appearance." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"options\": [\n\t\t\t{\n\t\t\t\t\"brandingOptions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"backgroundColor\": \"#FDFDFF\",\n\t\t\t\t\t\t\"brandColor\": \"#38488F\",\n\t\t\t\t\t\t\"accentColor\": \"#38488F\",\n\t\t\t\t\t\t\"rectShape\": \"rounded\",\n\t\t\t\t\t\t\"fontType\": \"mono\",\n\t\t\t\t\t\t\"logoUrl\": \"\",\n\t\t\t\t\t\t\"iconUrl\": \"\",\n\t\t\t\t\t\t\"footerColor\": \"#F0F0F2\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"metadata\": {\n\t\t\t\t\t\"inputTokens\": 1043,\n\t\t\t\t\t\"outputTokens\": 85,\n\t\t\t\t\t\"outputType\": \"text\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t},\n\t\"message\": \"Branding generated successfully\"\n}" } ] }, { "name": "Enhance Image", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/ai/enhance-image", "host": [ "{{baseUrl}}" ], "path": [ "ai", "enhance-image" ] }, "body": { "mode": "raw", "raw": "{\n\t\"productName\": \"Wireless Bluetooth Headphones\",\n\t\"url\": \"https://example.com/images/product-12345.jpg\",\n\t\"mode\": \"STANDARD\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Enhance product images using AI-powered image processing. This API takes a product image URL and generates enhanced versions of the image. Choose between STANDARD mode for basic enhancements or SCENE mode for contextual scene generation." }, "response": [ { "name": "Enhance Image - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/ai/enhance-image", "host": [ "{{baseUrl}}" ], "path": [ "ai", "enhance-image" ] }, "body": { "mode": "raw", "raw": "{\n\t\"productName\": \"Wireless Bluetooth Headphones\",\n\t\"url\": \"https://example.com/images/product-12345.jpg\",\n\t\"mode\": \"STANDARD\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Enhance product images using AI-powered image processing. This API takes a product image URL and generates enhanced versions of the image. Choose between STANDARD mode for basic enhancements or SCENE mode for contextual scene generation." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"imageUrls\": [\n\t\t\t\"https://cdn.example.com/enhanced/image-abc123-v1.jpg\",\n\t\t\t\"https://cdn.example.com/enhanced/image-abc123-v2.jpg\",\n\t\t\t\"https://cdn.example.com/enhanced/image-abc123-v3.jpg\"\n\t\t]\n\t},\n\t\"message\": \"Image enhanced successfully\"\n}" } ] } ] }, { "name": "Branding APIs", "description": "Branding API’s enables you to customize all customer facing pages provided by Surfboard. The branding can be configured at various levels similar to the terminal config.", "item": [ { "name": "Create Branding for Merchant", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"backgroundColor\": \"#667085\",\n \"brandColor\": \"#697085\",\n \"accentColor\": \"#787085\",\n \"rectShape\": \"rounded\",\n \"fontType\": \"sans-serif\",\n \"logoUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"iconUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"footerColor\": \"#CD5C5B\",\n \"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a branding configuration for customizable pages at merchant level" }, "response": [ { "name": "Create Branding for Merchant - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"backgroundColor\": \"#667085\",\n \"brandColor\": \"#697085\",\n \"accentColor\": \"#787085\",\n \"rectShape\": \"rounded\",\n \"fontType\": \"sans-serif\",\n \"logoUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"iconUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"footerColor\": \"#CD5C5B\",\n \"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a branding configuration for customizable pages at merchant level" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Branding configuration set successfully.\"\n}" } ] }, { "name": "Create Branding for Store", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"backgroundColor\": \"#667085\",\n \"brandColor\": \"#697085\",\n \"accentColor\": \"#787085\",\n \"rectShape\": \"rounded\",\n \"fontType\": \"sans-serif\",\n \"logoUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"iconUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"footerColor\": \"#CD5C5B\",\n \"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a branding configuration for customizable pages at store level" }, "response": [ { "name": "Create Branding for Store - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"backgroundColor\": \"#667085\",\n \"brandColor\": \"#697085\",\n \"accentColor\": \"#787085\",\n \"rectShape\": \"rounded\",\n \"fontType\": \"sans-serif\",\n \"logoUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"iconUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"footerColor\": \"#CD5C5B\",\n \"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a branding configuration for customizable pages at store level" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Branding configuration set successfully.\"\n}" } ] }, { "name": "Create Branding for Terminal", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"backgroundColor\": \"#667085\",\n \"brandColor\": \"#697085\",\n \"accentColor\": \"#787085\",\n \"rectShape\": \"rounded\",\n \"fontType\": \"sans-serif\",\n \"logoUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"iconUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"footerColor\": \"#CD5C5B\",\n \"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a branding configuration for customizable pages at terminal level" }, "response": [ { "name": "Create Branding for Terminal - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"backgroundColor\": \"#667085\",\n \"brandColor\": \"#697085\",\n \"accentColor\": \"#787085\",\n \"rectShape\": \"rounded\",\n \"fontType\": \"sans-serif\",\n \"logoUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"iconUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"footerColor\": \"#CD5C5B\",\n \"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a branding configuration for customizable pages at terminal level" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Branding configuration set successfully.\"\n}" } ] }, { "name": "Create Branding for Partner", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/branding", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "branding" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"backgroundColor\":\"#667085\",\n \"brandColor\":\"#697085\",\n \"accentColor\":\"#787085\",\n \"rectShape\":\"rounded\",\n \"fontType\":\"sans-serif\",\n \"logoUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"iconUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"footerColor\":\"#CD5C5B\",\n \"primaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a branding configuration for customizable pages at partner level" }, "response": [ { "name": "Create Branding for Partner - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/branding", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "branding" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"backgroundColor\":\"#667085\",\n \"brandColor\":\"#697085\",\n \"accentColor\":\"#787085\",\n \"rectShape\":\"rounded\",\n \"fontType\":\"sans-serif\",\n \"logoUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"iconUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\n \"footerColor\":\"#CD5C5B\",\n \"primaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a branding configuration for customizable pages at partner level" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Branding configuration set successfully.\"\n}" } ] }, { "name": "Fetch Branding for Merchant", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Fetch existing branding configuration at merchant level." }, "response": [ { "name": "Fetch Branding for Merchant - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Fetch existing branding configuration at merchant level." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"backgroundColor\": \"#F08080\",\n\t\t\"brandColor\": \"#0E44E1\",\n\t\t\"rectShape\": \"ROUNDED\",\n\t\t\"fontType\": \"serif\",\n\t\t\"accentColor\": \"#F08080\",\n\t\t\"logoUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"iconUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"footerColor\": \"#CD5C5B\",\n\t\t\"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n\t},\n\t\"message\": \"Fetched Branding successfully\"\n}" } ] }, { "name": "Fetch Branding for Store", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Fetch existing branding configuration at store level." }, "response": [ { "name": "Fetch Branding for Store - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Fetch existing branding configuration at store level." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"backgroundColor\": \"#F08080\",\n \"brandColor\": \"#0E44E1\",\n \"rectShape\": \"ROUNDED\",\n \"fontType\": \"serif\",\n \"accentColor\": \"#F08080\",\n \"logoUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"iconUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"footerColor\": \"#CD5C5B\",\n \"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n \"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n },\n \"message\": \"Fetched Branding successfully\"\n}" } ] }, { "name": "Fetch Branding for Terminal", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Fetch existing branding configuration at terminal level." }, "response": [ { "name": "Fetch Branding for Terminal - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Fetch existing branding configuration at terminal level." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"backgroundColor\": \"#F08080\",\n\t\t\"brandColor\": \"#0E44E1\",\n\t\t\"rectShape\": \"ROUNDED\",\n\t\t\"fontType\": \"serif\",\n\t\t\"accentColor\": \"#F08080\",\n\t\t\"logoUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"iconUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"footerColor\": \"#CD5C5B\",\n\t\t\"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n\t},\n\t\"message\": \"Fetched Branding successfully\"\n}" } ] }, { "name": "Fetch Branding for Partner", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/branding", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "branding" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Fetch existing branding configuration at partner level." }, "response": [ { "name": "Fetch Branding for Partner - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/branding", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "branding" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Fetch existing branding configuration at partner level." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"backgroundColor\": \"#F08080\",\n\t\t\"brandColor\": \"#0E44E1\",\n\t\t\"rectShape\": \"ROUNDED\",\n\t\t\"fontType\": \"serif\",\n\t\t\"accentColor\": \"#F08080\",\n\t\t\"logoUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"iconUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"footerColor\": \"#CD5C5B\",\n\t\t\"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n\t},\n\t\"message\": \"Fetched Branding successfully\"\n}" } ] }, { "name": "Remove Branding for Merchant", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Removes the existing branding configuration at the merchant level." }, "response": [ { "name": "Remove Branding for Merchant - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Removes the existing branding configuration at the merchant level." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Configuration deleted successfully for id [8113d3f8403b380409] and type MERCHANT\"\n}" } ] }, { "name": "Remove Branding for Store", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Removes the existing branding configuration at the store level." }, "response": [ { "name": "Remove Branding for Store - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Removes the existing branding configuration at the store level." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Configuration deleted successfully for id [8113d3f8403b380409] and type STORE\"\n}" } ] }, { "name": "Remove Branding for Terminal", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Removes the existing branding configuration at the terminal level." }, "response": [ { "name": "Remove Branding for Terminal - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "branding" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Removes the existing branding configuration at the terminal level." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Configuration deleted successfully for id [833b9e1cf983580704] and type TERMINAL\"\n}" } ] }, { "name": "Remove Branding for Partner", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/branding", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "branding" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Removes the existing branding configuration at the partner level." }, "response": [ { "name": "Remove Branding for Partner - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/branding", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "branding" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Removes the existing branding configuration at the partner level." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Configuration deleted successfully for id [8113d3f8403b380409] and type PARTNER\"\n}" } ] } ] }, { "name": "Client Auth Tokens API", "description": "These APIs are used when you would like to make requests from the client directly to Surfboard without using the API-Key and API-Secret. The generated token is restricted to perform calls limited to orders, payments and transactions.", "item": [ { "name": "Create Token", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/token", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "token" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"providerId\": \"BB72CE2C-B160-4BFE-ACB9-3FC270260C33\",\n \"providerCertificate\": \"2c95c565604048d7998a034ccbd2fbb5\",\n \"externalUserId\": \"A8895CBBCC503F\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a token for a given externalUserID. The token must be passed via the authorization header as a bearer token in subsequent requests. " }, "response": [ { "name": "Create Token - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/token", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "token" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"providerId\": \"BB72CE2C-B160-4BFE-ACB9-3FC270260C33\",\n \"providerCertificate\": \"2c95c565604048d7998a034ccbd2fbb5\",\n \"externalUserId\": \"A8895CBBCC503F\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a token for a given externalUserID. The token must be passed via the authorization header as a bearer token in subsequent requests. " }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"token\": \"4E306D4EDC9C48919671014D1125B61A4B12170F806F45D087ADD190A21869234F1D7D1D8A1547A0A38556739091BF09\",\n \"validUntil\": \"3600\"\n },\n \"message\": \"Auth token fetched successfully\"\n}" } ] } ] }, { "name": "Customers API", "description": "The Customers API enables merchants to manage customer information including personal details, addresses, contact information, and associated payment cards. This API provides functionality to create customer profiles and retrieve detailed customer information for enhanced customer relationship management.", "item": [ { "name": "Add Customer Details", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] }, "body": { "mode": "raw", "raw": "{\n\t\"firstName\": \"John\",\n\t\"middleName\": \"Doe\",\n\t\"birthDate\": \"1940/03/04\",\n\t\"countryCode\": \"SE\",\n\t\"address\": [\n\t\t{\n\t\t\t\"careOf\": \"second address at 3:40\",\n\t\t\t\"addressLine1\": \"second address at 3:40\",\n\t\t\t\"addressLine2\": \"3rd west street\",\n\t\t\t\"addressLine3\": \"B-Block\",\n\t\t\t\"city\": \"Ølstykke Stenløse\",\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"postalCode\": \"99 999\",\n\t\t\t\"role\": \"shipping\"\n\t\t}\n\t],\n\t\"phoneNumbers\": [\n\t\t{\n\t\t\t\"phoneNumber\": {\n\t\t\t\t\"code\": \"91\",\n\t\t\t\t\"number\": \"9876543210\"\n\t\t\t},\n\t\t\t\"role\": \"own\"\n\t\t}\n\t],\n\t\"cardIds\": [\n\t\t\"824c514bfe001805f0\",\n\t\t\"827a63468b993801f0\",\n\t\t\"827a63460b99380df0\"\n\t]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new customer profile with personal information, addresses, contact details, and associated payment cards. Use this API to register new customers and store their comprehensive information for future transactions and customer management." }, "response": [ { "name": "Add Customer Details - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] }, "body": { "mode": "raw", "raw": "{\n\t\"firstName\": \"John\",\n\t\"middleName\": \"Doe\",\n\t\"birthDate\": \"1940/03/04\",\n\t\"countryCode\": \"SE\",\n\t\"address\": [\n\t\t{\n\t\t\t\"careOf\": \"second address at 3:40\",\n\t\t\t\"addressLine1\": \"second address at 3:40\",\n\t\t\t\"addressLine2\": \"3rd west street\",\n\t\t\t\"addressLine3\": \"B-Block\",\n\t\t\t\"city\": \"Ølstykke Stenløse\",\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"postalCode\": \"99 999\",\n\t\t\t\"role\": \"shipping\"\n\t\t}\n\t],\n\t\"phoneNumbers\": [\n\t\t{\n\t\t\t\"phoneNumber\": {\n\t\t\t\t\"code\": \"91\",\n\t\t\t\t\"number\": \"9876543210\"\n\t\t\t},\n\t\t\t\"role\": \"own\"\n\t\t}\n\t],\n\t\"cardIds\": [\n\t\t\"824c514bfe001805f0\",\n\t\t\"827a63468b993801f0\",\n\t\t\"827a63460b99380df0\"\n\t]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new customer profile with personal information, addresses, contact details, and associated payment cards. Use this API to register new customers and store their comprehensive information for future transactions and customer management." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"customerId\": \"83018337960e2802f7\"\n\t},\n\t\"message\": \"Added customer successfully\"\n}" } ] }, { "name": "Fetch Customer Details by ID", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Retrieves customer information using the customer ID. Use this API to get detailed customer profile including personal information, addresses, contact details, and associated payment cards for customer management and transaction processing." }, "response": [ { "name": "Fetch Customer Details by ID - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId", "value": "", "description": "customerId" } ] }, "description": "Retrieves customer information using the customer ID. Use this API to get detailed customer profile including personal information, addresses, contact details, and associated payment cards for customer management and transaction processing." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"countryCode\": \"SE\",\n \"address\": [\n {\n \"careOf\": \"second address at 3:40\",\n \"addressLine1\": \"second address at 3:40\",\n \"addressLine2\": \"3rd west street\",\n \"addressLine3\": \"B-Block\",\n \"city\": \"Ølstykke Stenløse\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"99 999\",\n \"role\": \"shipping\"\n }\n ],\n \"emails\": [],\n \"phoneNumbers\": [\n {\n \"phoneNumber\": {\n \"code\": \"91\",\n \"number\": \"9876543210\"\n },\n \"role\": \"own\"\n }\n ],\n \"cardIds\": [\n \"824c514bfe001805f0\",\n \"827a63468b993801f0\",\n \"827a63460b99380df0\"\n ]\n },\n \"message\": \"Fetched customer details successfully\"\n}" } ] } ] }, { "name": "Gift Cards API", "description": "The Gift Cards API enables merchants to create, manage, and track gift cards. Gift cards can be of two types: FUND (monetary value) or ENTITLEMENT (usage-based). The API supports creating gift cards, retrieving gift card information, and tracking transactions.", "item": [ { "name": "Create Gift Card", "request": { "method": "POST", "header": [ { "key": "api-key", "value": "YOUR_API_KEY", "type": "text" }, { "key": "api-secret", "value": "YOUR_API_SECRET", "type": "text" }, { "key": "merchant-id", "value": "YOUR_MERCHANT_ID", "type": "text" } ], "url": { "raw": "{{baseUrl}}/giftcards", "host": [ "{{baseUrl}}" ], "path": [ "giftcards" ] }, "body": { "mode": "raw", "raw": "{\n\t\"cardType\": \"FUND\",\n\t\"amount\": 100.00,\n\t\"currency\": \"SEK\",\n\t\"name\": \"Holiday Gift Card\",\n\t\"accessControl\": \"OPEN\",\n\t\"expiryDate\": \"12/31/2024\",\n\t\"note\": \"Happy Holidays!\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new gift card with specified type and configuration. Gift cards can be FUND type (with monetary value) or ENTITLEMENT type (with usage limits)." }, "response": [ { "name": "Create Gift Card - Success", "originalRequest": { "method": "POST", "header": [ { "key": "api-key", "value": "YOUR_API_KEY", "type": "text" }, { "key": "api-secret", "value": "YOUR_API_SECRET", "type": "text" }, { "key": "merchant-id", "value": "YOUR_MERCHANT_ID", "type": "text" } ], "url": { "raw": "{{baseUrl}}/giftcards", "host": [ "{{baseUrl}}" ], "path": [ "giftcards" ] }, "body": { "mode": "raw", "raw": "{\n\t\"cardType\": \"FUND\",\n\t\"amount\": 100.00,\n\t\"currency\": \"SEK\",\n\t\"name\": \"Holiday Gift Card\",\n\t\"accessControl\": \"OPEN\",\n\t\"expiryDate\": \"12/31/2024\",\n\t\"note\": \"Happy Holidays!\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new gift card with specified type and configuration. Gift cards can be FUND type (with monetary value) or ENTITLEMENT type (with usage limits)." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"giftCardId\": \"83a5aea0381600045c\",\n\t\t\"pan\": \"1504703347938280\",\n\t\t\"name\": \"Birthday Gift Card\",\n\t\t\"formats\": {\n\t\t\t\"qrCode\": \"undefinedVWwIYiYXCANr202512310200\",\n\t\t\t\"nfcData\": \"undefinedVWwIYiYXCANr202512310200\",\n\t\t\t\"barcode\": \"2877866156\"\n\t\t},\n\t\t\"cardType\": \"FUND\",\n\t\t\"amount\": 100,\n\t\t\"redemptionLimit\": 0,\n\t\t\"currency\": \"SEK\",\n\t\t\"accessControl\": \"OPEN\",\n\t\t\"externalId\": \"m_iWGri3XAyTmkbKYsYtV47\",\n\t\t\"externalIdType\": \"MERCHANT\",\n\t\t\"status\": \"CREATED\",\n\t\t\"shareableLink\": \"https://slr.test.surfboard.se/afaa6fb5\"\n\t},\n\t\"message\": \"Gift card created successfully\"\n}" } ] }, { "name": "Get All Gift Cards", "request": { "method": "GET", "header": [ { "key": "api-key", "value": "Your API Key", "type": "text" }, { "key": "api-secret", "value": "Your API Secret", "type": "text" }, { "key": "merchant-id", "value": "Your Merchant ID", "type": "text" }, { "key": "x-page-number", "value": "Page number for pagination. Starts from 1.", "type": "text" } ], "url": { "raw": "{{baseUrl}}/giftcards", "host": [ "{{baseUrl}}" ], "path": [ "giftcards" ], "query": [ { "key": "type", "value": "", "description": "Filter gift cards by type. Possible values: `FUND`, `ENTITLEMENT`.", "disabled": true }, { "key": "status", "value": "", "description": "Filter gift cards by status.", "disabled": true } ] }, "description": "Retrieves a paginated list of all gift cards for a merchant. Supports filtering by type and status.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Get All Gift Cards - Success", "originalRequest": { "method": "GET", "header": [ { "key": "api-key", "value": "Your API Key", "type": "text" }, { "key": "api-secret", "value": "Your API Secret", "type": "text" }, { "key": "merchant-id", "value": "Your Merchant ID", "type": "text" }, { "key": "x-page-number", "value": "Page number for pagination. Starts from 1.", "type": "text" } ], "url": { "raw": "{{baseUrl}}/giftcards", "host": [ "{{baseUrl}}" ], "path": [ "giftcards" ], "query": [ { "key": "type", "value": "", "description": "Filter gift cards by type. Possible values: `FUND`, `ENTITLEMENT`.", "disabled": true }, { "key": "status", "value": "", "description": "Filter gift cards by status.", "disabled": true } ] }, "description": "Retrieves a paginated list of all gift cards for a merchant. Supports filtering by type and status.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"giftCardId\": \"83a2adb2fd9d58095c\",\n \"pan\": \"1802723955691673\",\n \"name\": \"Birthday Gift Card\",\n \"cardType\": \"FUND\",\n \"amount\": 100,\n \"currentAmount\": 100,\n \"usageCount\": 0,\n \"redemptionLimit\": 0,\n \"currency\": \"SEK\",\n \"accessControl\": \"OPEN\",\n \"status\": \"CREATED\",\n \"expiryDate\": \"2025-12-31T00:00:00.000Z\",\n \"transactionCount\": 0,\n \"totalRedeemed\": 0\n },\n {\n \"giftCardId\": \"83a2ac747d9d580b5c\",\n \"pan\": \"1167728279630112\",\n \"name\": \"Birthday Gift Card\",\n \"cardType\": \"FUND\",\n \"amount\": 100,\n \"currentAmount\": 100,\n \"usageCount\": 0,\n \"redemptionLimit\": 0,\n \"currency\": \"SEK\",\n \"accessControl\": \"OPEN\",\n \"status\": \"CREATED\",\n \"expiryDate\": \"2025-12-31T00:00:00.000Z\",\n \"transactionCount\": 0,\n \"totalRedeemed\": 0\n },\n {\n \"giftCardId\": \"83a256695d9d28025c\",\n \"pan\": \"1657679889602692\",\n \"name\": \"Birthday Gift Card\",\n \"cardType\": \"FUND\",\n \"amount\": 100,\n \"currentAmount\": 100,\n \"usageCount\": 0,\n \"redemptionLimit\": 0,\n \"currency\": \"SEK\",\n \"accessControl\": \"OPEN\",\n \"status\": \"CREATED\",\n \"expiryDate\": \"2025-12-31T00:00:00.000Z\",\n \"transactionCount\": 0,\n \"totalRedeemed\": 0\n }\n ],\n \"message\": \"Gift cards fetched\"\n}" } ] }, { "name": "Get Gift Card Details", "request": { "method": "GET", "header": [ { "key": "api-key", "value": "YOUR_API_KEY", "type": "text" }, { "key": "api-secret", "value": "YOUR_API_SECRET", "type": "text" }, { "key": "merchant-id", "value": "YOUR_MERCHANT_ID", "type": "text" } ], "url": { "raw": "{{baseUrl}}/giftcards/:id", "host": [ "{{baseUrl}}" ], "path": [ "giftcards", ":id" ], "variable": [ { "key": "id", "value": "", "description": "id" } ] }, "description": "Retrieves detailed information for a specific gift card using its ID or PAN. Includes customer details, transaction history summary, and format representations." }, "response": [ { "name": "Get Gift Card Details - Success", "originalRequest": { "method": "GET", "header": [ { "key": "api-key", "value": "YOUR_API_KEY", "type": "text" }, { "key": "api-secret", "value": "YOUR_API_SECRET", "type": "text" }, { "key": "merchant-id", "value": "YOUR_MERCHANT_ID", "type": "text" } ], "url": { "raw": "{{baseUrl}}/giftcards/:id", "host": [ "{{baseUrl}}" ], "path": [ "giftcards", ":id" ], "variable": [ { "key": "id", "value": "", "description": "id" } ] }, "description": "Retrieves detailed information for a specific gift card using its ID or PAN. Includes customer details, transaction history summary, and format representations." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"giftCardId\": \"83a2adb2fd9d58095c\",\n\t\t\"pan\": \"1802723955691673\",\n\t\t\"name\": \"Birthday Gift Card\",\n\t\t\"cardType\": \"FUND\",\n\t\t\"amount\": 100,\n\t\t\"currentAmount\": 75,\n\t\t\"usageCount\": 2,\n\t\t\"redemptionLimit\": 0,\n\t\t\"currency\": \"SEK\",\n\t\t\"accessControl\": \"OPEN\",\n\t\t\"externalId\": \"m_iWGri3XAyTmkbKYsYtV47\",\n\t\t\"externalIdType\": \"MERCHANT\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"expiryDate\": \"2025-12-31T00:00:00.000Z\",\n\t\t\"lastTransactionAt\": \"2024-11-15T10:30:00Z\",\n\t\t\"transactionCount\": 2,\n\t\t\"totalRedeemed\": 25,\n\t\t\"customerDetails\": {\n\t\t\t\"customerId\": \"83a2adb2fd9d58001c\",\n\t\t\t\"firstName\": \"John\",\n\t\t\t\"surname\": \"Doe\",\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"emails\": [{\"email\": \"john.doe@example.com\"}],\n\t\t\t\"phoneNumbers\": [{\"phoneNumber\": {\"countryCode\": \"+46\", \"number\": \"701234567\"}}]\n\t\t},\n\t\t\"shareableLink\": \"https://slr.test.surfboard.se/afaa6fb5\",\n\t\t\"formats\": {\n\t\t\t\"qrCode\": \"undefinedVWwIYiYXCANr202512310200\",\n\t\t\t\"nfcData\": \"undefinedVWwIYiYXCANr202512310200\",\n\t\t\t\"barcode\": \"2877866156\"\n\t\t}\n\t},\n\t\"message\": \"Gift card details retrieved successfully\"\n}" } ] }, { "name": "Get Gift Card Transactions", "request": { "method": "GET", "header": [ { "key": "api-key", "value": "Your API Key", "type": "text" }, { "key": "api-secret", "value": "Your API Secret", "type": "text" }, { "key": "merchant-id", "value": "Your Merchant ID", "type": "text" }, { "key": "x-page-number", "value": "Page number for pagination", "type": "text" } ], "url": { "raw": "{{baseUrl}}/giftcards/:giftCardId/transactions", "host": [ "{{baseUrl}}" ], "path": [ "giftcards", ":giftCardId", "transactions" ], "variable": [ { "key": "giftCardId", "value": "", "description": "giftCardId" } ], "query": [ { "key": "transactionType", "value": "", "description": "Filter transactions by type. Possible values: `ISSUED`, `CREDIT`, `DEBIT`.", "disabled": true } ] }, "description": "Retrieves a paginated list of transactions for a specific gift card. Supports filtering by transaction type.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Get Gift Card Transactions - Success", "originalRequest": { "method": "GET", "header": [ { "key": "api-key", "value": "Your API Key", "type": "text" }, { "key": "api-secret", "value": "Your API Secret", "type": "text" }, { "key": "merchant-id", "value": "Your Merchant ID", "type": "text" }, { "key": "x-page-number", "value": "Page number for pagination", "type": "text" } ], "url": { "raw": "{{baseUrl}}/giftcards/:giftCardId/transactions", "host": [ "{{baseUrl}}" ], "path": [ "giftcards", ":giftCardId", "transactions" ], "variable": [ { "key": "giftCardId", "value": "", "description": "giftCardId" } ], "query": [ { "key": "transactionType", "value": "", "description": "Filter transactions by type. Possible values: `ISSUED`, `CREDIT`, `DEBIT`.", "disabled": true } ] }, "description": "Retrieves a paginated list of transactions for a specific gift card. Supports filtering by transaction type.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"paymentId\": \"83a2adb2fd9d58095d\",\n \"transactionType\": \"ISSUED\",\n \"transactionAmount\": 100,\n \"currency\": \"SEK\",\n \"valueBefore\": 0,\n \"valueAfter\": 100,\n \"merchantId\": \"83a2adb2fd9d58001a\",\n \"storeId\": \"83a2adb2fd9d58002b\"\n },\n {\n \"paymentId\": \"83a2adb2fd9d58095e\",\n \"transactionType\": \"DEBIT\",\n \"transactionAmount\": 25,\n \"currency\": \"SEK\",\n \"valueBefore\": 100,\n \"valueAfter\": 75,\n \"orderId\": \"83a2adb2fd9d58003c\",\n \"merchantId\": \"83a2adb2fd9d58001a\",\n \"storeId\": \"83a2adb2fd9d58002b\",\n \"metadata\": {\n \"terminalId\": \"83a2adb2fd9d58004d\",\n \"transactionDate\": \"2024-11-15T10:30:00Z\"\n }\n }\n ],\n \"message\": \"Gift card transactions retrieved successfully\"\n}" } ] } ] }, { "name": "Logistics API", "description": "Partners can place orders for products (terminals and other accessories) from Surfboard. As a partner, you can provide a product catalog containing a range of product options for merchants to choose from.", "item": [ { "name": "Create Shipment", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "shipment" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n\t\"shippingAddress\": {\n\t\t\"name\": \"John Doe\",\n\t\t\"addressLine1\": \"Main Street 123\",\n\t\t\"addressLine2\": \"Building C\",\n\t\t\"addressLine3\": \"Building C\",\n\t\t\"city\": \"Stockholm\",\n\t\t\"countryCode\": \"SE\",\n\t\t\"postalCode\": \"123 45\",\n\t\t\"phoneNumber\": {\n\t\t\t\"code\": 46,\n\t\t\t\"number\": \"771890089\"\n\t\t},\n\t\t\"email\": \"developer@test.se\",\n\t\t\"deliveryInstruction\": \"XXX\"\n\t},\n\t\"lineItems\": [\n\t\t{\n\t\t\t\"productId\": \"12345\",\n\t\t\t\"quantity\": 1\n\t\t}\n\t]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a shipment order for terminals and other accessories. Use this API to initiate an order to ship terminals and other accessories to merchants." }, "response": [ { "name": "Create Shipment - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "shipment" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n\t\"shippingAddress\": {\n\t\t\"name\": \"John Doe\",\n\t\t\"addressLine1\": \"Main Street 123\",\n\t\t\"addressLine2\": \"Building C\",\n\t\t\"addressLine3\": \"Building C\",\n\t\t\"city\": \"Stockholm\",\n\t\t\"countryCode\": \"SE\",\n\t\t\"postalCode\": \"123 45\",\n\t\t\"phoneNumber\": {\n\t\t\t\"code\": 46,\n\t\t\t\"number\": \"771890089\"\n\t\t},\n\t\t\"email\": \"developer@test.se\",\n\t\t\"deliveryInstruction\": \"XXX\"\n\t},\n\t\"lineItems\": [\n\t\t{\n\t\t\t\"productId\": \"12345\",\n\t\t\t\"quantity\": 1\n\t\t}\n\t]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a shipment order for terminals and other accessories. Use this API to initiate an order to ship terminals and other accessories to merchants." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"orderId\": \"81376ad8ebedf80310\"\n\t},\n\t\"message\": \"Order for shipping terminal successfully created\"\n}" } ] }, { "name": "Get Shipment Status", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/shipment/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "shipment", ":orderId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "orderId", "value": "", "description": "orderId" } ] }, "description": "Retrieves the status of the shipment order. Use this API to get the shipment status of ordered terminals and other accessories." }, "response": [ { "name": "Get Shipment Status - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/shipment/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "shipment", ":orderId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "orderId", "value": "", "description": "orderId" } ] }, "description": "Retrieves the status of the shipment order. Use this API to get the shipment status of ordered terminals and other accessories." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"orderStatus\": \"ORDER_PENDING_FOR_STOCK\",\n \"trackingUrl\": \"\",\n \"deliveryPartner\": \"DHL\",\n \"packageDetails\": [\n {\n \"productId\": \"817361bb0a23400701\",\n \"serialNumber\": \"\"\n }\n ]\n },\n \"message\": \"Order status fetched successfully\"\n}" } ] }, { "name": "Ship Terminals in Bulk", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/logistics/orders", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "logistics", "orders" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"shippingAddress\": {\n \"name\": \"Jane Smith\",\n \"addressLine1\": \"456 Business Ave\",\n \"addressLine2\": \"Floor 2\",\n \"city\": \"Stockholm\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"12345\"\n },\n \"lineItems\": [\n {\n \"productId\": \"81bddf38fa28380101\",\n \"quantity\": 5,\n \"billingPlanId\": \"BP_001\",\n \"replacementFor\": \"82674cfdf77f500001\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates bulk shipment orders for terminals and other accessories to partners. Use this API to initiate orders to ship multiple terminals and accessories in bulk." }, "response": [ { "name": "Ship Terminals in Bulk - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/logistics/orders", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "logistics", "orders" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"shippingAddress\": {\n \"name\": \"Jane Smith\",\n \"addressLine1\": \"456 Business Ave\",\n \"addressLine2\": \"Floor 2\",\n \"city\": \"Stockholm\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"12345\"\n },\n \"lineItems\": [\n {\n \"productId\": \"81bddf38fa28380101\",\n \"quantity\": 5,\n \"billingPlanId\": \"BP_001\",\n \"replacementFor\": \"82674cfdf77f500001\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates bulk shipment orders for terminals and other accessories to partners. Use this API to initiate orders to ship multiple terminals and accessories in bulk." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"orderId\": \"83992e47b219100f28\"\n },\n \"message\": \"Return request created successfully\"\n}" } ] }, { "name": "Fetch Partner Orders", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/logistics/orders", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "logistics", "orders" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Retrieves all orders placed by a partner for terminals and accessories. Use this API to get the status and details of all orders under a partner." }, "response": [ { "name": "Fetch Partner Orders - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/logistics/orders", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "logistics", "orders" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Retrieves all orders placed by a partner for terminals and accessories. Use this API to get the status and details of all orders under a partner." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"orderId\": \"8190422d77e1400428\",\n \"trackingUrl\": \"\",\n \"status\": \"ORDER_CANCELLED\",\n \"deliveryPartner\": \"DHL\",\n \"packages\": [\n {\n \"productId\": \"817361bb0a23400701\",\n \"serialNumber\": \"\"\n }\n ]\n },\n {\n \"orderId\": \"819118d10a3d900f28\",\n \"trackingUrl\": \"\",\n \"status\": \"ORDER_CANCELLED\",\n \"deliveryPartner\": \"DHL\",\n \"packages\": [\n {\n \"productId\": \"817361bb0a23400701\",\n \"serialNumber\": \"\"\n }\n ]\n }\n ],\n \"message\": \"Orders fetched successfully\"\n}" } ] }, { "name": "Create Return", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/logistics/returns", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "logistics", "returns" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"merchantInfo\": {\n \"name\": \"Demo Store\",\n \"email\": \"demo@example.com\",\n \"phoneNumber\": {\n \"code\": \"46\",\n \"number\": \"123456789\"\n },\n \"addressLine1\": \"Demo Street 123\",\n \"addressLine2\": \"Building A\",\n \"addressLine3\": null,\n \"city\": \"Stockholm\",\n \"countryCode\": \"SE\",\n \"postalNumber\": \"12345\"\n },\n \"returnOrderLines\": [\n {\n \"serial\": \"TERM001234567\",\n \"terminalId\": \"816a0ff6bc0fb00404\",\n \"reasonForReturn\": \"NOT_USING_SERVICE\",\n \"stopBilling\": true,\n \"comment\": \"Device not working properly\"\n }\n ],\n \"deliveryInstruction\": \"Please call before delivery\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a return request for terminals using the API. This enhanced version allows for more detailed merchant information and multiple return order lines." }, "response": [ { "name": "Create Return - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/logistics/returns", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "logistics", "returns" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"merchantInfo\": {\n \"name\": \"Demo Store\",\n \"email\": \"demo@example.com\",\n \"phoneNumber\": {\n \"code\": \"46\",\n \"number\": \"123456789\"\n },\n \"addressLine1\": \"Demo Street 123\",\n \"addressLine2\": \"Building A\",\n \"addressLine3\": null,\n \"city\": \"Stockholm\",\n \"countryCode\": \"SE\",\n \"postalNumber\": \"12345\"\n },\n \"returnOrderLines\": [\n {\n \"serial\": \"TERM001234567\",\n \"terminalId\": \"816a0ff6bc0fb00404\",\n \"reasonForReturn\": \"NOT_USING_SERVICE\",\n \"stopBilling\": true,\n \"comment\": \"Device not working properly\"\n }\n ],\n \"deliveryInstruction\": \"Please call before delivery\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a return request for terminals using the API. This enhanced version allows for more detailed merchant information and multiple return order lines." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"returnId\": 80\n },\n \"message\": \"Return request created successfully\"\n}" } ] }, { "name": "Get Returns", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/logistics/returns", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "logistics", "returns" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ], "query": [ { "key": "filter", "value": "", "description": "Filter returns by status. Possible values: `APPROVED`, `CREATED`.", "disabled": true } ] }, "description": "Retrieves return requests for a specific merchant using the API. Supports filtering by status and provides detailed return information.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Get Returns - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/logistics/returns", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "logistics", "returns" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ], "query": [ { "key": "filter", "value": "", "description": "Filter returns by status. Possible values: `APPROVED`, `CREATED`.", "disabled": true } ] }, "description": "Retrieves return requests for a specific merchant using the API. Supports filtering by status and provides detailed return information.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"returnId\": 80,\n \"partnerId\": \"8113d3f8403b380409\",\n \"merchantName\": \"Demo Store\",\n \"merchantEmail\": \"demo@example.com\",\n \"merchantPhone\": \"+46123456789\",\n \"merchantAddressLine1\": \"Demo Street 123\",\n \"merchantAddressLine2\": \"Building A\",\n \"merchantAddressLine3\": \"\",\n \"merchantCity\": \"Stockholm\",\n \"merchantPostalNumber\": \"12345\",\n \"merchantCountryCode\": \"SE\",\n \"deliveryInstruction\": \"Please call before delivery\",\n \"status\": \"CREATED\",\n \"returnOrderLines\": [\n {\n \"returnOrderlineId\": 78,\n \"returnId\": 80,\n \"serial\": \"TERM001234567\",\n \"terminalId\": \"816a0ff6bc0fb00404\",\n \"merchantId\": \"m_iWGri3XAyTmkbKYsYtV47\",\n \"deviceModel\": \"Surfpad\",\n \"reasonForReturn\": \"NOT_USING_SERVICE\",\n \"createdAt\": \"2025-10-29T04:51:28.566Z\",\n \"lastChanged\": \"2025-10-29T04:51:28.566Z\",\n \"stopBilling\": true,\n \"comment\": \"Device not working properly\"\n }\n ]\n }\n ],\n \"message\": \"Return requests gotten successfully\"\n}" } ] }, { "name": "Fetch Merchant Orders", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/logistics/orders", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "logistics", "orders" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves all orders placed for a specific merchant. Use this API to get the status and details of all orders for a particular merchant." }, "response": [ { "name": "Fetch Merchant Orders - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/logistics/orders", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "logistics", "orders" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves all orders placed for a specific merchant. Use this API to get the status and details of all orders for a particular merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"orderId\": \"8190422d77e1400428\",\n \"trackingUrl\": \"\",\n \"status\": \"ORDER_CANCELLED\",\n \"deliveryPartner\": \"DHL\",\n \"packages\": [\n {\n \"productId\": \"817361bb0a23400701\",\n \"serialNumber\": \"\"\n }\n ]\n },\n {\n \"orderId\": \"819118d10a3d900f28\",\n \"trackingUrl\": \"\",\n \"status\": \"ORDER_CANCELLED\",\n \"deliveryPartner\": \"DHL\",\n \"packages\": [\n {\n \"productId\": \"817361bb0a23400701\",\n \"serialNumber\": \"\"\n }\n ]\n }\n ],\n \"message\": \"Orders fetched successfully\"\n}" } ] } ] }, { "name": "Merchant Charge & Billing Plans", "description": "This section covers the APIs used to create, update, and retrieve charges associated with a merchant, as well as manage billing plans for partners. Charges can be one-time or subscription-based, while billing plans define pricing structures for different payment methods and card brands.", "item": [ { "name": "Create Merchant Charge", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/charges", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "charges" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Fee\",\n \"currency\": \"752\",\n \"amount\": 5000000,\n \"vat\": 35,\n \"billingDate\": \"2025-02-11\",\n \"recurring\": {\n \"billingEndDate\": \"2025-02-12\",\n \"frequency\": \"daily\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new charge for a merchant. Partners can specify the charge details." }, "response": [ { "name": "Create Merchant Charge - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/charges", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "charges" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"Fee\",\n \"currency\": \"752\",\n \"amount\": 5000000,\n \"vat\": 35,\n \"billingDate\": \"2025-02-11\",\n \"recurring\": {\n \"billingEndDate\": \"2025-02-12\",\n \"frequency\": \"daily\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a new charge for a merchant. Partners can specify the charge details." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"chargeId\": \"82eb21dbb4bcf80c46\"\n },\n \"message\": \"Merchant charge created successfully\"\n}" } ] }, { "name": "Update Merchant Charge", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/charges/:chargeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "charges", ":chargeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "chargeId", "value": "", "description": "chargeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 650000,\n \"vat\": 15,\n \"recurring\": {\n \"updateType\": \"onlyNext\",\n \"billingEndDate\": \"2025-10-23\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing charge for a merchant. Partners can modify the amount, VAT, and optionally adjust the recurring settings." }, "response": [ { "name": "Update Merchant Charge - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/charges/:chargeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "charges", ":chargeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "chargeId", "value": "", "description": "chargeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 650000,\n \"vat\": 15,\n \"recurring\": {\n \"updateType\": \"onlyNext\",\n \"billingEndDate\": \"2025-10-23\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an existing charge for a merchant. Partners can modify the amount, VAT, and optionally adjust the recurring settings." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"chargeId\": \"82ed1af7b38e080146\"\n },\n \"message\": \"Merchant charge updated successfully\"\n}" } ] }, { "name": "Fetch Merchant Charge by ID", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/charges/:chargeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "charges", ":chargeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "chargeId", "value": "", "description": "chargeId" } ] }, "description": "Retrieves detailed information about a specific merchant charge, including subscription details, amount, VAT, frequency, and any associated sub-charges." }, "response": [ { "name": "Fetch Merchant Charge by ID - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/charges/:chargeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "charges", ":chargeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "chargeId", "value": "", "description": "chargeId" } ] }, "description": "Retrieves detailed information about a specific merchant charge, including subscription details, amount, VAT, frequency, and any associated sub-charges." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t \"chargeId\":\"82eb21dbb4bcf80c46\",\n\t\t\"isSubscriptionCharge\": true,\n\t\t\"description\": \"Fee\",\n\t\t\"amount\": 5000000,\n\t\t\"vat\": 35,\n\t\t\"frequency\": \"daily\",\n\t\t\"billingStartDate\": \"2025-02-18T00:00:00.000Z\",\n\t\t\"billingEndDate\": \"2025-02-20T00:00:00.000Z\",\n\t\t\"subCharges\": [\n\t\t\t{\n\t\t\t\t\"subChargeId\": \"82f1a47a1f97000446\",\n\t\t\t\t\"type\": \"PARTNER_FEE\",\n\t\t\t\t\"description\": \"Fee\",\n\t\t\t\t\"amount\": 650000,\n\t\t\t\t\"vat\": 15,\n\t\t\t\t\"status\": \"PENDING\",\n\t\t\t\t\"billingDate\": \"2025-02-18T00:00:00.000Z\"\n\t\t\t}\n\t\t]\n\t},\n\t\"message\": \"Merchant charge fetched successfully\"\n}" } ] }, { "name": "Fetch All Merchant Charges", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/charges", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "charges" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves a list of all charges associated with a particular merchant. This includes both one-time and subscription-based charges.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch All Merchant Charges - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/charges", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "charges" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves a list of all charges associated with a particular merchant. This includes both one-time and subscription-based charges.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"chargeId\": \"82ed1af7b38e080146\",\n \"subChargeId\": \"82ed1af7b38e080146\",\n \"merchantId\": \"m_iWGri3XAyTmkbKYsYtV47\",\n \"isSubscriptionCharge\": true,\n \"description\": \"Fee\",\n \"amount\": 650000,\n \"vat\": 15,\n \"status\": \"PENDING\",\n \"billingDate\": \"2025-02-11T00:00:00.000Z\"\n },\n {\n \"chargeId\": \"82eb21dbb4bcf80c46\",\n \"subChargeId\": \"82ec36fee443f80f46\",\n \"merchantId\": \"m_iWGri3XAyTmkbKYsYtV47\",\n \"isSubscriptionCharge\": true,\n \"description\": \"Fee\",\n \"amount\": 5000000,\n \"vat\": 35,\n \"status\": \"PENDING\",\n \"billingDate\": \"2025-02-09T00:00:00.000Z\"\n },\n {\n \"chargeId\": \"82eb21dbb4bcf80c46\",\n \"subChargeId\": \"82eb21dbb4bcf80c46\",\n \"merchantId\": \"m_iWGri3XAyTmkbKYsYtV47\",\n \"isSubscriptionCharge\": true,\n \"description\": \"Fee\",\n \"amount\": 5000000,\n \"vat\": 35,\n \"status\": \"PENDING\",\n \"billingDate\": \"2025-02-08T00:00:00.000Z\"\n }\n ],\n \"message\": \"Merchant charges fetched successfully\"\n}" } ] }, { "name": "Create Billing Plans", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/billing-plans", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "billing-plans" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"plans\": [\n {\n \"id\": \"SP_NOK7\",\n \"paymentMethod\": \"CARD\",\n \"cardBrand\": \"DISCOVER\",\n \"terminalType\": \"STANDARD\",\n \"planType\": \"FIXED\",\n \"description\": \"Testing 2024\",\n \"fixedPercentage\": 13.4\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates new billing plans for a partner. Billing plans define pricing structures for different payment methods, card brands, and terminal types." }, "response": [ { "name": "Create Billing Plans - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/billing-plans", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "billing-plans" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"plans\": [\n {\n \"id\": \"SP_NOK7\",\n \"paymentMethod\": \"CARD\",\n \"cardBrand\": \"DISCOVER\",\n \"terminalType\": \"STANDARD\",\n \"planType\": \"FIXED\",\n \"description\": \"Testing 2024\",\n \"fixedPercentage\": 13.4\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates new billing plans for a partner. Billing plans define pricing structures for different payment methods, card brands, and terminal types." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Billing plans created successfully\"\n}" } ] }, { "name": "Fetch Billing Plans", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "x-page-number", "value": "Page Number (e.g., 1)", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/billing-plans", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "billing-plans" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Retrieves all billing plans associated with a partner. Returns detailed information about each plan including pricing structures for different transaction types. Supports pagination through page number headers.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch Billing Plans - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "x-page-number", "value": "Page Number (e.g., 1)", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/billing-plans", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "billing-plans" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Retrieves all billing plans associated with a partner. Returns detailed information about each plan including pricing structures for different transaction types. Supports pagination through page number headers.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"billingPlanId\": \"ANCN_POS_PREMIUM_PLUS\",\n \"cardBrand\": \"VISA_MC\",\n \"terminalType\": \"STANDARD\",\n \"paymentMethod\": \"CARD\",\n \"planType\": \"VARIABLE\",\n \"description\": \"Billing Plan Description\",\n \"domesticDebitNonCommercial\": 0.49,\n \"domesticCreditNonCommercial\": 0.59,\n \"domesticDebitCommercial\": 1.95,\n \"domesticCreditCommercial\": 1.95,\n \"eeaDebitNonCommercial\": 0.49,\n \"eeaCreditNonCommercial\": 0.59,\n \"eeaDebitCommercial\": 1.95,\n \"eeaCreditCommercial\": 1.95,\n \"internationalDebitNonCommercial\": 1.95,\n \"internationalCreditNonCommercial\": 1.95,\n \"internationalDebitCommercial\": 1.95,\n \"internationalCreditCommercial\": 1.95,\n \"minimumCeiling\": 0,\n \"fixedCost\": 0.12,\n \"fixedPercentage\": 0,\n \"vatPercentage\": 0\n },\n {\n \"billingPlanId\": \"P_DKKVK_V149M000F000\",\n \"cardBrand\": \"VISA_MC\",\n \"terminalType\": \"STANDARD\",\n \"paymentMethod\": \"CARD\",\n \"planType\": \"FIXED\",\n \"description\": \"Billing Plan Description\",\n \"domesticDebitNonCommercial\": 1.49,\n \"domesticCreditNonCommercial\": 1.49,\n \"domesticDebitCommercial\": 1.49,\n \"domesticCreditCommercial\": 1.49,\n \"eeaDebitNonCommercial\": 1.49,\n \"eeaCreditNonCommercial\": 1.49,\n \"eeaDebitCommercial\": 1.49,\n \"eeaCreditCommercial\": 1.49,\n \"internationalDebitNonCommercial\": 1.49,\n \"internationalCreditNonCommercial\": 1.49,\n \"internationalDebitCommercial\": 1.49,\n \"internationalCreditCommercial\": 1.49,\n \"minimumCeiling\": 0,\n \"fixedCost\": 0,\n \"fixedPercentage\": 0,\n \"vatPercentage\": 0\n }\n ],\n \"message\": \"Partner billing plans fetched successfully\"\n}" } ] }, { "name": "Fetch Billing Plans for Merchant", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/plans", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "plans" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves billing plans specifically assigned to a merchant under a partner. This endpoint returns the billing plans that are applicable to the specified merchant." }, "response": [ { "name": "Fetch Billing Plans for Merchant - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/plans", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "plans" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves billing plans specifically assigned to a merchant under a partner. This endpoint returns the billing plans that are applicable to the specified merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"billingPlanId\": \"SP_SE_Fix119\",\n \"cardBrand\": \"VISA_MC\",\n \"terminalType\": \"STANDARD\",\n \"paymentMethod\": \"CARD\",\n \"planType\": \"FIXED\",\n \"description\": \"Billing Plan Description\",\n \"domesticDebitNonCommercial\": 1.19,\n \"domesticCreditNonCommercial\": 1.19,\n \"domesticDebitCommercial\": 1.19,\n \"domesticCreditCommercial\": 1.19,\n \"eeaDebitNonCommercial\": 1.19,\n \"eeaCreditNonCommercial\": 1.19,\n \"eeaDebitCommercial\": 1.19,\n \"eeaCreditCommercial\": 1.19,\n \"internationalDebitNonCommercial\": 1.19,\n \"internationalCreditNonCommercial\": 1.19,\n \"internationalDebitCommercial\": 1.19,\n \"internationalCreditCommercial\": 1.19,\n \"minimumCeiling\": 0.99,\n \"fixedCost\": 0,\n \"fixedPercentage\": 0,\n \"vatPercentage\": 0\n }\n ],\n \"message\": \"Billing plans for the merchant fetched successfully\"\n}" } ] }, { "name": "Fetch Billing Plan by ID", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/billing-plans/:id", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "billing-plans", ":id" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "id", "value": "", "description": "id" } ] }, "description": "Fetch detailed information for a specific billing plan using its ID." }, "response": [ { "name": "Fetch Billing Plan by ID - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/billing-plans/:id", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "billing-plans", ":id" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "id", "value": "", "description": "id" } ] }, "description": "Fetch detailed information for a specific billing plan using its ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"billingPlanId\": \"PLAN_001\",\n \"paymentMethod\": \"CARD\",\n \"cardBrand\": \"VISA\",\n \"terminalType\": \"STANDARD\",\n \"planType\": \"FIXED\",\n \"description\": \"Standard billing plan\",\n \"domesticDebitNonCommercial\": 1.49,\n \"domesticCreditNonCommercial\": 1.59\n }\n ],\n \"message\": \"Billing plan retrieved successfully\"\n}" } ] }, { "name": "Remove Billing Plan by ID", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/billing-plans/:id", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "billing-plans", ":id" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "id", "value": "", "description": "id" } ] }, "description": "Removes one or more billing plans by their IDs for a specific partner." }, "response": [ { "name": "Remove Billing Plan by ID - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/billing-plans/:id", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "billing-plans", ":id" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "id", "value": "", "description": "id" } ] }, "description": "Removes one or more billing plans by their IDs for a specific partner." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Billing plans removed from the partner successfully\"\n}" } ] } ] }, { "name": "Merchants API", "description": "A merchant is created in Surfboard with the completion of an onboarding process. Merchant creation can be initiated through ISVs who have partnered with Surfboard to offer payment solutions to their merchants in addition to their existing products.", "item": [ { "name": "Create Merchant", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n\t\"country\": \"SE\",\n\t\"organisation\": {\n\t\t\"corporateId\": \"5591631360\",\n\t\t\"legalName\": \"Year Zero Press AB\",\n\t\t\"mccCode\": \"5192\",\n\t\t\"address\": {\n\t\t\t\"careOf\": \"John Doe\",\n\t\t\t\"addressLine1\": \"Main Street 123\",\n\t\t\t\"addressLine2\": \"Building C\",\n\t\t\t\"city\": \"Stockholm\",\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"postalCode\": \"123 45\"\n\t\t},\n\t\t\"email\": \"contact@test.com\"\n\t},\n\t\"controlFields\": {\n\t\t\"transactionPricingPlan\": \"SP_SE_Fix129\",\n\t\t\"generateShortLink\": true,\n\t\t\"acquirerConfig\": {\n\t\t\t\"acquirerMID\": \"752113\",\n\t\t\t\"acquirer\": \"nets\"\n\t\t},\n\t\t\"store\": {\n\t\t\t\"name\": \"Test Store\",\n\t\t\t\"email\": \"test@test.com\",\n\t\t\t\"acquirerMID\": \"752113\",\n\t\t\t\"phoneNumber\": {\n\t\t\t\t\"code\": \"46\",\n\t\t\t\t\"number\": \"987654321\"\n\t\t\t},\n\t\t\t\"address\": {\n\t\t\t\t\"careOf\": \"Jane Doe\",\n\t\t\t\t\"addressLine1\": \"Second Street 456\",\n\t\t\t\t\"city\": \"Stockholm\",\n\t\t\t\t\"countryCode\": \"SE\",\n\t\t\t\t\"postalCode\": \"123 46\"\n\t\t\t}\n\t\t}\n\t}\n}", "options": { "raw": { "language": "json" } } }, "description": "As a partner, use the Create Merchant API to onboard your sub-merchants for using Surfboard's payment solutions. You can also display products ( terminals, accessories etc. from Surfboard) for your merchants to choose, set product pricing plans for your merchant, display the product catalogue, and pre-select products for your merchants." }, "response": [ { "name": "Create Merchant - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n\t\"country\": \"SE\",\n\t\"organisation\": {\n\t\t\"corporateId\": \"5591631360\",\n\t\t\"legalName\": \"Year Zero Press AB\",\n\t\t\"mccCode\": \"5192\",\n\t\t\"address\": {\n\t\t\t\"careOf\": \"John Doe\",\n\t\t\t\"addressLine1\": \"Main Street 123\",\n\t\t\t\"addressLine2\": \"Building C\",\n\t\t\t\"city\": \"Stockholm\",\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"postalCode\": \"123 45\"\n\t\t},\n\t\t\"email\": \"contact@test.com\"\n\t},\n\t\"controlFields\": {\n\t\t\"transactionPricingPlan\": \"SP_SE_Fix129\",\n\t\t\"generateShortLink\": true,\n\t\t\"acquirerConfig\": {\n\t\t\t\"acquirerMID\": \"752113\",\n\t\t\t\"acquirer\": \"nets\"\n\t\t},\n\t\t\"store\": {\n\t\t\t\"name\": \"Test Store\",\n\t\t\t\"email\": \"test@test.com\",\n\t\t\t\"acquirerMID\": \"752113\",\n\t\t\t\"phoneNumber\": {\n\t\t\t\t\"code\": \"46\",\n\t\t\t\t\"number\": \"987654321\"\n\t\t\t},\n\t\t\t\"address\": {\n\t\t\t\t\"careOf\": \"Jane Doe\",\n\t\t\t\t\"addressLine1\": \"Second Street 456\",\n\t\t\t\t\"city\": \"Stockholm\",\n\t\t\t\t\"countryCode\": \"SE\",\n\t\t\t\t\"postalCode\": \"123 46\"\n\t\t\t}\n\t\t}\n\t}\n}", "options": { "raw": { "language": "json" } } }, "description": "As a partner, use the Create Merchant API to onboard your sub-merchants for using Surfboard's payment solutions. You can also display products ( terminals, accessories etc. from Surfboard) for your merchants to choose, set product pricing plans for your merchant, display the product catalogue, and pre-select products for your merchants." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"applicationId\": \"8268abfc4ae6900a10\",\n\t\t\"webKybUrl\": \"https://surfkyb.com/8268abfc4ae6900a10?pi=M703SPUzM0Rhz0f91l209KundIhf-1vZnPfSEQX7UdQBnwbkR4bZIUtHZAh4WmUAiwb2J8Rjnuus10i8QrFYncEA18qbAS6QszW641AYdymGi8-PkmZd\"\n\t},\n\t\"message\": \"Merchant application created successfully.\"\n}" } ] }, { "name": "Check Application Status", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:applicationId/status", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":applicationId", "status" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "applicationId", "value": "", "description": "applicationId" } ] }, "description": "Retrieves the status of the merchant onboarding. After initiating the onboarding for the sub-merchant, use the Check Application Status API to get updates regarding the application’s progress. After the merchant is created, the Merchant ID and Store ID are also available through the webhook." }, "response": [ { "name": "Check Application Status - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:applicationId/status", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":applicationId", "status" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "applicationId", "value": "", "description": "applicationId" } ] }, "description": "Retrieves the status of the merchant onboarding. After initiating the onboarding for the sub-merchant, use the Check Application Status API to get updates regarding the application’s progress. After the merchant is created, the Merchant ID and Store ID are also available through the webhook." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"applicationId\": \"81409507c1a5f00110\",\n\t\t\"webKybUrl\": \"http://partner.surfboardpayments.com/81409507c1a5f00110\",\n\t\t\"applicationStatus\": \"MERCHANT_CREATED\",\n\t\t\"merchantId\": \"81412e2e4102f80f0e\",\n\t\t\"storeId\": \"81412e3c3b1090060f\",\n\t\t\"billingPlans\": [\n\t\t\t{\n\t\t\t\t\"planId\": \"81412e3c3b1090060f\",\n\t\t\t\t\"planName\": \"Standard Transaction Plan\"\n\t\t\t}\n\t\t],\n\t\t\"onlineOnboardingStatus\": \"PENDING_VERIFICATION\",\n\t\t\"paymentMethods\": [\n\t\t\t{\n\t\t\t\t\"methodId\": \"81412e3c3b1090060f\",\n\t\t\t\t\"methodType\": \"CARD\",\n\t\t\t\t\"enabled\": true\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"methodId\": \"81412e3c3b10900610\",\n\t\t\t\t\"methodType\": \"SWISH\",\n\t\t\t\t\"enabled\": true\n\t\t\t}\n\t\t],\n\t\t\"acquirerOnboarding\": {\n\t\t\t\"acquirerId\": \"81412e3c3b10900611\",\n\t\t\t\"status\": \"ACTIVE\",\n\t\t\t\"merchantId\": \"81412e2e4102f80f0e\"\n\t\t}\n\t},\n\t\"message\": \"Application status fetched successfully\"\n}" } ] }, { "name": "Create Multi-merchant Group", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/multi-merchant", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "multi-merchant" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"country\": \"SE\",\n \"zipCode\": \"123456\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a multi-merchant group. Partners can use this API to create a multi-merchant group that enables multiple merchants to use the same terminal. Individual merchants are tagged to this group, enabling access to all the terminals registered in this group." }, "response": [ { "name": "Create Multi-merchant Group - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/multi-merchant", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "multi-merchant" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"country\": \"SE\",\n \"zipCode\": \"123456\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a multi-merchant group. Partners can use this API to create a multi-merchant group that enables multiple merchants to use the same terminal. Individual merchants are tagged to this group, enabling access to all the terminals registered in this group." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"merchantId\": \"81660b596c7fd0000e\",\n \"storeId\": \"81660b59434440030f\"\n },\n \"message\": \"Multi Merchant created successfully\"\n}" } ] }, { "name": "Fetch All Merchant Applications", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/applications", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "applications" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Retrieves a list of all merchants applications with a specific partner.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch All Merchant Applications - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/applications", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "applications" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Retrieves a list of all merchants applications with a specific partner.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t\t{\n\t\t\t\"applicationId\": \"816e0b8aabe6580310\",\n\t\t\t\"country\": \"SE\",\n\t\t\t\"corporateId\": \"1234567898\",\n\t\t\t\"applicationStatus\": \"MERCHANT_CREATED\",\n\t\t\t\"createdAt\": \"2023-07-10T07:17:41.489Z\",\n\t\t\t\"lastUpdatedAt\": \"2023-07-10T07:17:41.519Z\",\n\t\t\t\"webKybUrl\": \"https://surfkyb.com/816e0b8aabe6580310\"\n\t\t},\n\t\t{\n\t\t\t\"applicationId\": \"816e0983abe6580a10\",\n\t\t\t\"country\": \"DK\",\n\t\t\t\"applicationStatus\": \"APPLICATION_INITIATED\",\n\t\t\t\"createdAt\": \"2023-07-10T07:00:23.106Z\",\n\t\t\t\"lastUpdatedAt\": \"2023-07-10T07:00:23.106Z\",\n\t\t\t\"webKybUrl\": \"https://surfkyb.com/816e0983abe6580a10\"\n\t\t}\n\t],\n\t\"message\": \"Applications of partner fetched successfully with partnerId: 8113d3f8403b380409.\"\n}" } ] }, { "name": "Fetch Merchant Details", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves information for a specific merchant. As a partner you can use this API to get information regarding your sub-merchants" }, "response": [ { "name": "Fetch Merchant Details - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves information for a specific merchant. As a partner you can use this API to get information regarding your sub-merchants" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"merchantId\": \"81fa6b2d8d5dc8040e\",\n \"partnerId\": \"8113d3f8403b380409\",\n \"merchantName\": \"Conroy Hane and Parker\",\n \"merchantLanguage\": \"se\",\n \"merchantLogoUrl\": \"https://firebasestorage.googleapis.com/v0/b/firebase-test-2e49.appspot.com/o/files%2F8113d3f8403b380409%2FlogoUrl_1749127943794_emoji.png?alt=media&token=61077942-b4b3-482d-bd4d-1e3526486b7e\",\n \"email\": \"ashinisb@surfboard.se\",\n \"companyId\": \"5590520507\",\n \"countryCode\": \"SE\",\n \"mccCode\": 1520,\n \"phoneNumber\": \"917676576569\",\n \"merchantType\": \"STANDARD\",\n \"currencyCode\": \"752\",\n \"acquirerMID\": \"gfprLY1dyAQO\",\n \"address\": {\n \"careOf\": \"chennai\",\n \"addressLine1\": \"Stockholm\",\n \"addressLine2\": \"Diya ssssssTowers\",\n \"addressLine3\": \"process\",\n \"city\": \"Sweden\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"22331\"\n }\n },\n \"message\": \"Successfully fetched merchant details \"\n}" } ] }, { "name": "Fetch All Multi-Merchant Groups", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/multi-merchants", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "multi-merchants" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Fetch all existing multi-merchants groups under partner.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch All Multi-Merchant Groups - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/multi-merchants", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "multi-merchants" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Fetch all existing multi-merchants groups under partner.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t\t{\n\t\t\t\"multiMerchantId\": \"817544218dd838050e\",\n\t\t\t\"multiMerchantName\": \"Multi Merchant one\",\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"postalCode\": \"12345\",\n\t\t\t\"merchants\": [\n\t\t\t\t{\n\t\t\t\t\t\"merchantId\": \"817544960dd838040e\",\n\t\t\t\t\t\"merchantName\": \"Test Merchant one\",\n\t\t\t\t\t\"countryCode\": \"SE\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"merchantId\": \"8175449a8dd8380d0e\",\n\t\t\t\t\t\"merchantName\": \"Test Merchant two\",\n\t\t\t\t\t\"countryCode\": \"SE\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"multiMerchantId\": \"81701e32ff5690020e\",\n\t\t\t\"multiMerchantName\": \"Multi Merchant two\",\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"postalCode\": \"12346\"\n\t\t}\n\t],\n\t\"message\": \"Multi merchant groups fetched successfully.\"\n}" } ] }, { "name": "Update Merchant Details", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"test@gmail.com\",\n \"phoneNumber\": {\n \"code\": 46,\n \"number\": \"771890089\"\n },\n \"merchantLogoUrl\": \"https://merchant.com/image\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the merchant details. You can use this API to edit the email address, merchant logo URL, and phone number of a merchant." }, "response": [ { "name": "Update Merchant Details - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"test@gmail.com\",\n \"phoneNumber\": {\n \"code\": 46,\n \"number\": \"771890089\"\n },\n \"merchantLogoUrl\": \"https://merchant.com/image\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the merchant details. You can use this API to edit the email address, merchant logo URL, and phone number of a merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Successfully updated the merchant details.\"\n}" } ] }, { "name": "Fetch All Merchant Terminals", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ], "query": [ { "key": "terminalType", "value": "", "description": "Optional query param to filter terminals by terminal type. Possible values: `surfpad`, `surftouch`, `surfprint`, `checkoutPro`, `checkoutX`, `PaymentPage`, `SelfHostedPage`, `MerchantInitiated`, `printer`, `surftester`.", "disabled": true } ] }, "description": "Retrieves a list of all terminals associated with a specific merchant. You can use this API to get information regarding all the terminals registered under a merchant.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch All Merchant Terminals - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ], "query": [ { "key": "terminalType", "value": "", "description": "Optional query param to filter terminals by terminal type. Possible values: `surfpad`, `surftouch`, `surfprint`, `checkoutPro`, `checkoutX`, `PaymentPage`, `SelfHostedPage`, `MerchantInitiated`, `printer`, `surftester`.", "disabled": true } ] }, "description": "Retrieves a list of all terminals associated with a specific merchant. You can use this API to get information regarding all the terminals registered under a merchant.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"terminalId\": \"tn_vw_YyrFd33ntb7_340Ob7\",\n \"terminalType\": \"surfpad\",\n \"softwareVersion\": \"0.0.0\",\n \"osType\": \"sb_firmware\",\n \"osVersion\": \"0.0.0\",\n \"deviceVendor\": \"Datecs\",\n \"deviceModel\": \"Datecs PinPad\",\n \"serialNo\": \"2922000007\",\n \"storeId\": \"st_uCRWV56JkT6eyNXjGr5F1\",\n \"linkedTerminalId\": null,\n \"terminalStatus\": \"ACTIVE\",\n \"startDate\": \"2022-11-17T09:29:51.427Z\",\n \"terminalPaymentMethods\": [\n \"CARD\"\n ],\n \"terminalName\": \"My Terminal\"\n },\n {\n \"terminalId\": \"81389f79f703e80105\",\n \"terminalType\": \"surftouch\",\n \"softwareVersion\": \"0.0.0\",\n \"osType\": \"sb_firmware\",\n \"osVersion\": \"0.0.0\",\n \"deviceVendor\": \"Datecs\",\n \"deviceModel\": \"Datecs BluePad 5500\",\n \"serialNo\": null,\n \"storeId\": \"st_uCRWV56JkT6eyNXjGr5F1\",\n \"linkedTerminalId\": null,\n \"terminalStatus\": \"ACTIVE\",\n \"startDate\": \"2022-12-15T06:50:48.746Z\",\n \"terminalPaymentMethods\": [\n \"SWISH\",\n \"CASH\"\n ],\n \"terminalName\": \"My Test Terminal\"\n }\n ],\n \"message\": \"Terminal records fetched successfully\"\n}" } ] }, { "name": "Fetch All Merchants", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Retrieves a list of all merchants associated with a specific partner. Partners can use this API to get information regarding all their sub-merchants.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch All Merchants - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "Retrieves a list of all merchants associated with a specific partner. Partners can use this API to get information regarding all their sub-merchants.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t\t{\n\t\t\t\"merchantId\": \"8248db4c5c8dd0130e\",\n\t\t\t\"partnerId\": \"8113d3f8403b380409\",\n\t\t\t\"merchantName\": \"Raynor LLC\",\n\t\t\t\"merchantLanguage\": \"sv\",\n\t\t\t\"merchantLogoUrl\": \"https://www.freepik.com/free-vector/hand-painted-watercolor-abstract.htm#query=background&position=0&from_view=keyword&\",\n\t\t\t\"email\": \"sathish@surfboard.se\",\n\t\t\t\"companyId\": \"5590890439\",\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"mccCode\": 8021,\n\t\t\t\"address\":{\n\t\t\t \"careOf\": \"somebody\",\n\t\t\t \"addressLine1\": \"Some Address\",\n\t\t\t \"addressLine2\": \"Some other address\",\n\t\t\t \"addressLine3\": null,\n\t\t\t \"city\": \"Stockholm\",\n\t\t\t \"countryCode\": \"SE\",\n\t\t\t \"postalCode\": \"12345\"\n\t\t\t},\n\t\t\t\"createdAt\": \"2024-06-06 06:03:49.125\",\n\t\t\t\"totalNumberOfTransaction\": \"11\",\n\t\t\t\"totalAmountOfTransaction\": \"2200\",\n\t\t\t\"lastTransactionAt\": \"2024-08-22 07:58:35.310568\",\n\t\t\t\"phoneNumber\": \"4623423423\",\n\t\t\t\"currencyCode\": \"752\",\n\t\t\t\"acquirerMID\": \"gkjb4ug3KAUP\"\n\t\t},\n\t\t{\n\t\t\t\"merchantId\": \"81a25a0b304ed0070e\",\n\t\t\t\"partnerId\": \"8113d3f8403b380409\",\n\t\t\t\"merchantName\": \"Conroy, Hane\",\n\t\t\t\"merchantLanguage\": \"en\",\n\t\t\t\"merchantLogoUrl\": \"https://img.freepik.com/free-vector/cartoon-style-cafe-front-shop-view_134830-697.jpg\",\n\t\t\t\"email\": \"conroy@gmail.com\",\n\t\t\t\"companyId\": null,\n\t\t\t\"countryCode\": \"SE\",\n\t\t\t\"mccCode\": 5812,\n\t\t\t\"address\":{\n\t\t\t \"careOf\": \"somebody\",\n\t\t\t \"addressLine1\": \"Some Address\",\n\t\t\t \"addressLine2\": null,\n\t\t\t \"addressLine3\": null,\n\t\t\t \"city\": \"Gothenburg\",\n\t\t\t \"countryCode\": \"SE\",\n\t\t\t \"postalCode\": \"54321\"\n\t\t\t},\n\t\t\t\"createdAt\": \"2022-11-04 13:41:46.81\",\n\t\t\t\"totalNumberOfTransaction\": \"1877\",\n\t\t\t\"totalAmountOfTransaction\": \"774628102\",\n\t\t\t\"lastTransactionAt\": \"2024-07-15 09:23:09.816546\",\n\t\t\t\"phoneNumber\": \"+468787870484\",\n\t\t\t\"currencyCode\": \"752\",\n\t\t\t\"acquirerMID\": \"kpIy8YO3ycKyhKR\"\n\t\t}\n\t],\n\t\"message\": \"Successfully fetched merchants details\"\n}" } ] }, { "name": "Fetch All Merchant Contracts", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/contracts", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "contracts" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves the list all contracts under the specific merchant." }, "response": [ { "name": "Fetch All Merchant Contracts - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/contracts", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "contracts" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves the list all contracts under the specific merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t\t{\n\t\t\t\"contractId\": \"81d9b757ea31c0013d\",\n\t\t\t\"type\": \"MERCHANT_AGREEMENT\",\n\t\t\t\"status\": \"ACTIVE\",\n\t\t\t\"contractLink\": \"https://storage.googleapis.com/test\"\n\t\t}\n\t],\n\t\"message\": \"Fetched merchant agreement contracts successfully\"\n}" } ] }, { "name": "Activate Terminal", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/ship-hardware", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "ship-hardware" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"serialNo\":\"1234567898\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API is available for partners who manage their own storage and terminal delivery solution and requires a PCI compliant storage setup. The API can be used to activate terminals that are tagged to you as a partner. This API will return an error if the entered serial number is not available to you." }, "response": [ { "name": "Activate Terminal - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/ship-hardware", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "ship-hardware" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"serialNo\":\"1234567898\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API is available for partners who manage their own storage and terminal delivery solution and requires a PCI compliant storage setup. The API can be used to activate terminals that are tagged to you as a partner. This API will return an error if the entered serial number is not available to you." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Manufactured hardware shipped successfully\"\n}" } ] }, { "name": "Fetch Transaction Analytics", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/analytics", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "analytics" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves aggregated transaction analytics for a specific merchant. This can include analytics by store, terminal, date range, card brand, and more.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch Transaction Analytics - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/analytics", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "analytics" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves aggregated transaction analytics for a specific merchant. This can include analytics by store, terminal, date range, card brand, and more.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"currency\": \"752\",\n \"terminalId\": \"82dd3f9aad1ec80f04\",\n \"terminalType\": \"sb_terminal_c\",\n \"orderType\": \"PURCHASE\",\n \"paymentMethod\": \"CARD\",\n \"cardBrand\": \"VISA\",\n \"timeSegments\": \"2025-01-21 00:00:00\",\n \"orderTransactionCount\": \"1\",\n \"totalTransactionAmount\": 150\n },\n {\n \"currency\": \"752\",\n \"terminalId\": \"82dd3f9aad1ec80f04\",\n \"terminalType\": \"sb_terminal_c\",\n \"orderType\": \"PURCHASE\",\n \"paymentMethod\": \"CARD\",\n \"cardBrand\": \"MASTERCARD\",\n \"timeSegments\": \"2025-01-21 00:00:00\",\n \"orderTransactionCount\": \"3\",\n \"totalTransactionAmount\": 450\n }\n ],\n \"message\": \"Transaction Analytics Data queried successfully\"\n}" } ] } ] }, { "name": "NFC Reading", "description": "The NFC Reading API's enables you to read NFC tags for an order.", "item": [ { "name": "Create Read Session", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"mode\": \"single\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to start a NFC reading session on the terminal." }, "response": [ { "name": "Create Read Session - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"mode\": \"single\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to start a NFC reading session on the terminal." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"sessionId\": \"827125a9d9d0301949\"\n },\n \"message\": \"NFC reading session started successfully.\"\n}" } ] }, { "name": "Fetch Sessions for Terminal", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "This API lets you fetch all reading sessions created under the terminal" }, "response": [ { "name": "Fetch Sessions for Terminal - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "This API lets you fetch all reading sessions created under the terminal" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"sessionId\": \"826e5fb507cd180849\",\n \"action\": \"end\",\n \"mode\": \"multiple\"\n },\n {\n \"sessionId\": \"826e5fff87cd181b49\",\n \"action\": \"end\",\n \"mode\": \"multiple\"\n },\n {\n \"sessionId\": \"826e600207cd180049\",\n \"action\": \"end\",\n \"mode\": \"multiple\"\n },\n {\n \"sessionId\": \"826e609587cd181249\",\n \"action\": \"end\",\n \"mode\": \"multiple\"\n }\n ],\n \"message\": \"Fetched all NFC reading sessions under terminal.\"\n}" } ] }, { "name": "Fetch Tags for Session", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions/:sessionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions", ":sessionId", "tags" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" }, { "key": "sessionId", "value": "", "description": "sessionId" } ] }, "description": "This API retrieves all the tags read during the specified session." }, "response": [ { "name": "Fetch Tags for Session - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions/:sessionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions", ":sessionId", "tags" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" }, { "key": "sessionId", "value": "", "description": "sessionId" } ] }, "description": "This API retrieves all the tags read during the specified session." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t\t{\n\t\t\t\"sessionId\": \"826e7bcc086e901149\",\n\t\t\t\"tagId\": \"MDQ2QzUwMzJDMzNCODA=\"\n\t\t}\n\t],\n\t\"message\": \"Fetched all tags under session.\"\n}" } ] }, { "name": "Fetch Session Status", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions/:sessionId/status", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions", ":sessionId", "status" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" }, { "key": "sessionId", "value": "", "description": "sessionId" } ] }, "description": "This API retrieves the current status of the NFC reading session." }, "response": [ { "name": "Fetch Session Status - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions/:sessionId/status", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions", ":sessionId", "status" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" }, { "key": "sessionId", "value": "", "description": "sessionId" } ] }, "description": "This API retrieves the current status of the NFC reading session." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"sessionStatus\": \"COMPLETED\",\n\t\t\"nfcTags\": [\n\t\t\t\"QjQ2RTE2OEY=\"\n\t\t]\n\t},\n\t\"message\": \"Fetched NFC session status.\"\n}" } ] }, { "name": "Complete NFC Reading Session", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions/:sessionId/complete", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions", ":sessionId", "complete" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" }, { "key": "sessionId", "value": "", "description": "sessionId" } ] }, "body": { "mode": "raw", "raw": "{\n \"result\": \"COMPLETED\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint completes an ongoing NFC (RFID) reading session. You must provide both the terminal ID and session ID in the path, as well as an optional result in the request body." }, "response": [ { "name": "Complete NFC Reading Session - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/sessions/:sessionId/complete", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "sessions", ":sessionId", "complete" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" }, { "key": "sessionId", "value": "", "description": "sessionId" } ] }, "body": { "mode": "raw", "raw": "{\n \"result\": \"COMPLETED\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This endpoint completes an ongoing NFC (RFID) reading session. You must provide both the terminal ID and session ID in the path, as well as an optional result in the request body." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"NFC reading session completed successfully.\"\n}" } ] } ] }, { "name": "Notifications API", "description": "The Notifications API enables merchants and partners to subscribe to event notifications via SFTP or email. It allows you to configure automated notifications for various events and manage your notification subscriptions.", "item": [ { "name": "Subscribe to Merchant Reports", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/notifications/reports", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "notifications", "reports" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"event\": \"DAILY_FILE_TRANSFER\",\n \"slackUrl\": \"https://surfboardworkspace.slack.com/archives/C039RL0LS8M\",\n \"email\": \"john@gmail.com\",\n \"sftpInfo\": {\n \"host\": \"192.168.0.211\",\n \"user\": \"surfboard-test\",\n \"port\": 8080,\n \"hostKey\": \"AAAAB3NzaC1yc2EAAAADAQABAAABgQDVjVZBKMAFE3z4m1M6xVpudb+Wcal1kAfzdpOsi64cXjBdK2VS0cuI38htYHGXhpqQ2z/XbYZ2ZfPUkzL/P0IV7Kec22ohLNSN3+r9r3jjB/EU9S46ApuHzloEFnSlPVT5xQA2d09Rs40iMjRp3hfov4pwNPwlav0ikLafSvPWZ2bUfsWq/vNdhnNGBd0au59qIAHrphkF5oyRQUjC5kssSuwZXo2GWC0zHuT06h3/t21BJMoQT4cJ2AEw5Cfvq/cUtSAUKsWaz++0wgyYBOYnYGHpxype+6c7x8gRkuAeuSyj/CdDG39CMSKLsf35CSr7bH8Tsmm6VuIPFwTr8FloGdVwthQiSOPDn15kQXeEiksmzeIMKilgpEWIxp1pgYgtrOefAXp+aoKSqNw+ccvUhiVwIpo2BXxM+l3douJMy2B7A29R+VvwOGDV1zbiYrxjbpDHqMpLjOo5vckj/YYyvHn32nnmb92Hl+A1+b9om1c/y/RN2aRgz6tgmPxhhVU=\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Subscribe to receive automated notifications for merchant events. You must provide at least one notification channel: email, slackUrl, or sftpInfo to create a notification subscription. This endpoint supports multiple notification channels including EMAIL, SLACK, and SFTP." }, "response": [ { "name": "Subscribe to Merchant Reports - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/notifications/reports", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "notifications", "reports" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"event\": \"DAILY_FILE_TRANSFER\",\n \"slackUrl\": \"https://surfboardworkspace.slack.com/archives/C039RL0LS8M\",\n \"email\": \"john@gmail.com\",\n \"sftpInfo\": {\n \"host\": \"192.168.0.211\",\n \"user\": \"surfboard-test\",\n \"port\": 8080,\n \"hostKey\": \"AAAAB3NzaC1yc2EAAAADAQABAAABgQDVjVZBKMAFE3z4m1M6xVpudb+Wcal1kAfzdpOsi64cXjBdK2VS0cuI38htYHGXhpqQ2z/XbYZ2ZfPUkzL/P0IV7Kec22ohLNSN3+r9r3jjB/EU9S46ApuHzloEFnSlPVT5xQA2d09Rs40iMjRp3hfov4pwNPwlav0ikLafSvPWZ2bUfsWq/vNdhnNGBd0au59qIAHrphkF5oyRQUjC5kssSuwZXo2GWC0zHuT06h3/t21BJMoQT4cJ2AEw5Cfvq/cUtSAUKsWaz++0wgyYBOYnYGHpxype+6c7x8gRkuAeuSyj/CdDG39CMSKLsf35CSr7bH8Tsmm6VuIPFwTr8FloGdVwthQiSOPDn15kQXeEiksmzeIMKilgpEWIxp1pgYgtrOefAXp+aoKSqNw+ccvUhiVwIpo2BXxM+l3douJMy2B7A29R+VvwOGDV1zbiYrxjbpDHqMpLjOo5vckj/YYyvHn32nnmb92Hl+A1+b9om1c/y/RN2aRgz6tgmPxhhVU=\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Subscribe to receive automated notifications for merchant events. You must provide at least one notification channel: email, slackUrl, or sftpInfo to create a notification subscription. This endpoint supports multiple notification channels including EMAIL, SLACK, and SFTP." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"notificationId\": \"839dd1b8113ff809f3\",\n \"NotificationChannel\": \"EMAIL\"\n },\n {\n \"notificationId\": \"839dd1b8113ff819f3\",\n \"NotificationChannel\": \"SLACK\"\n },\n {\n \"notificationId\": \"839dd1b8113ff82af3\",\n \"NotificationChannel\": \"SFTP\",\n \"publicKey\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCfGfO3kOLdYji5R6GNI8lvfyI5MgpQY43OF+HwAqgF96L6hg1jG/Nu58bToPZoaf+lkqp+/MDNGTIeRfMkR+3g1Q2sgZ3jGvN3lErvfbbnYGx7qDzfyMCg7i9VneVOJb4fxoSRzbja2ZG7XxbSzBPvzGky38AKqBq5EysO8/FnA6I9SNCMPcyaEq3Rs33kGjcBthOxc3X+3dRvKt0GU77xtt0tWl7vP/DHXj9m32kcjNN2647i/oRoAiM58fhtsU3UM5TQGYn6WJ0/su7X5JnBy2+WktotJvfzF7ri2Q+R5Ac7kem5g17wdMPgICaz1sDY6haxI3TuDOe8ZVybfV6T surfboard-test@34.88.179.4\"\n }\n ],\n \"message\": \"External notification for MERCHANT_ID: m_iWGri3XAyTmkbKYsYtV47 registered successfully\"\n}" } ] }, { "name": "Fetch External Notifications for Merchant", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "notifications" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ], "query": [ { "key": "event", "value": "", "description": "Filter by event type", "disabled": true }, { "key": "notificationChannel", "value": "", "description": "Filter by notification channel. Possible values: `EMAIL`, `SLACK`, `SFTP", "disabled": true }, { "key": "notificationId", "value": "", "description": "Filter by notification ID", "disabled": true } ] }, "description": "Retrieves all external notifications configured for a merchant. Supports filtering by event type, notification channel, and notification ID" }, "response": [ { "name": "Fetch External Notifications for Merchant - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "notifications" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ], "query": [ { "key": "event", "value": "", "description": "Filter by event type", "disabled": true }, { "key": "notificationChannel", "value": "", "description": "Filter by notification channel. Possible values: `EMAIL`, `SLACK`, `SFTP", "disabled": true }, { "key": "notificationId", "value": "", "description": "Filter by notification ID", "disabled": true } ] }, "description": "Retrieves all external notifications configured for a merchant. Supports filtering by event type, notification channel, and notification ID" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"notificationId\": \"839cfe66fe08b00bf3\",\n \"event\": \"WEEKLY_FILE_TRANSFER\",\n \"notificationChannel\": \"SFTP\",\n \"address\": {\n \"host\": \"192.168.0.211\",\n \"user\": \"surfboard-test\",\n \"port\": 8080,\n \"publicKey\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDPrhFN05QsXZPVGn3uHpRih3bJrRARfvqvyZ5RuRG78YXiVjfHszckpzcay7uF6fsMQes8ky4RGywHs7UfhWbXhu5EDE/swZzTtu8TRVmRhIL6K1o8VKFEEJat3+UgwgrkdKHpUyld3r2doNcViHDiBTiVW4O4JR98/XHrhR7Ge9EPxE/iVwyur+YREtt3RKdZV3d+NG+4WFRqaq70lM13z0u1lACP8PRl4dyRbjrpGoMGq2zDSvyerzS6fKg7jm1UBOt4wznu8pjIE+A+9xiNvzpnxG1q4GxwpRq8e8AY5WIvpngOpaiifEObAGWnauvWnenPwV/yvudTwK4bFQBV surfboard-test@192.168.0.211\",\n \"separator\": \",\"\n },\n \"status\": \"REGISTERED\"\n },\n {\n \"notificationId\": \"839d223b9df16805f3\",\n \"event\": \"PAYMENT_COMPLETED\",\n \"notificationChannel\": \"EMAIL\",\n \"address\": {\n \"email\": \"merchant@example.com\"\n },\n \"status\": \"SUBSCRIBED\"\n }\n ],\n \"message\": \"External notification for MERCHANT_ID: m_iWGri3XAyTmkbKYsYtV47 fetched successfully\"\n}" } ] }, { "name": "Unsubscribe Notification for Merchant", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "notifications", ":notificationId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "notificationId", "value": "", "description": "notificationId" } ] }, "description": "Unsubscribe from a specific notification for a merchant. This endpoint removes the notification subscription identified by the notification ID" }, "response": [ { "name": "Unsubscribe Notification for Merchant - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "notifications", ":notificationId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "notificationId", "value": "", "description": "notificationId" } ] }, "description": "Unsubscribe from a specific notification for a merchant. This endpoint removes the notification subscription identified by the notification ID" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"External notification unsubscribed successfully for the given ID [m_iWGri3XAyTmkbKYsYtV47] and external alert ID [839d12501df1680cf3]\"\n}" } ] }, { "name": "Subscribe to Partner Notifications", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/notifications/reports", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "notifications", "reports" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"event\": \"DAILY_FILE_TRANSFER\",\n \"slackUrl\": \"https://surfboardworkspace.slack.com/archives/C039RL0LS8M\",\n \"email\": \"john@gmail.com\",\n \"sftpInfo\": {\n \"host\": \"192.168.0.211\",\n \"user\": \"surfboard-test\",\n \"port\": 8080,\n \"hostKey\": \"AAAAB3NzaC1yc2EAAAADAQABAAABgQDVjVZBKMAFE3z4m1M6xVpudb+Wcal1kAfzdpOsi64cXjBdK2VS0cuI38htYHGXhpqQ2z/XbYZ2ZfPUkzL/P0IV7Kec22ohLNSN3+r9r3jjB/EU9S46ApuHzloEFnSlPVT5xQA2d09Rs40iMjRp3hfov4pwNPwlav0ikLafSvPWZ2bUfsWq/vNdhnNGBd0au59qIAHrphkF5oyRQUjC5kssSuwZXo2GWC0zHuT06h3/t21BJMoQT4cJ2AEw5Cfvq/cUtSAUKsWaz++0wgyYBOYnYGHpxype+6c7x8gRkuAeuSyj/CdDG39CMSKLsf35CSr7bH8Tsmm6VuIPFwTr8FloGdVwthQiSOPDn15kQXeEiksmzeIMKilgpEWIxp1pgYgtrOefAXp+aoKSqNw+ccvUhiVwIpo2BXxM+l3douJMy2B7A29R+VvwOGDV1zbiYrxjbpDHqMpLjOo5vckj/YYyvHn32nnmb92Hl+A1+b9om1c/y/RN2aRgz6tgmPxhhVU=\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Subscribe to receive automated notifications for partner events. You must provide at least one notification channel: email, slackUrl, or sftpInfo to create a notification subscription. This endpoint supports multiple notification channels including EMAIL, SLACK, and SFTP." }, "response": [ { "name": "Subscribe to Partner Notifications - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/notifications/reports", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "notifications", "reports" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"event\": \"DAILY_FILE_TRANSFER\",\n \"slackUrl\": \"https://surfboardworkspace.slack.com/archives/C039RL0LS8M\",\n \"email\": \"john@gmail.com\",\n \"sftpInfo\": {\n \"host\": \"192.168.0.211\",\n \"user\": \"surfboard-test\",\n \"port\": 8080,\n \"hostKey\": \"AAAAB3NzaC1yc2EAAAADAQABAAABgQDVjVZBKMAFE3z4m1M6xVpudb+Wcal1kAfzdpOsi64cXjBdK2VS0cuI38htYHGXhpqQ2z/XbYZ2ZfPUkzL/P0IV7Kec22ohLNSN3+r9r3jjB/EU9S46ApuHzloEFnSlPVT5xQA2d09Rs40iMjRp3hfov4pwNPwlav0ikLafSvPWZ2bUfsWq/vNdhnNGBd0au59qIAHrphkF5oyRQUjC5kssSuwZXo2GWC0zHuT06h3/t21BJMoQT4cJ2AEw5Cfvq/cUtSAUKsWaz++0wgyYBOYnYGHpxype+6c7x8gRkuAeuSyj/CdDG39CMSKLsf35CSr7bH8Tsmm6VuIPFwTr8FloGdVwthQiSOPDn15kQXeEiksmzeIMKilgpEWIxp1pgYgtrOefAXp+aoKSqNw+ccvUhiVwIpo2BXxM+l3douJMy2B7A29R+VvwOGDV1zbiYrxjbpDHqMpLjOo5vckj/YYyvHn32nnmb92Hl+A1+b9om1c/y/RN2aRgz6tgmPxhhVU=\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Subscribe to receive automated notifications for partner events. You must provide at least one notification channel: email, slackUrl, or sftpInfo to create a notification subscription. This endpoint supports multiple notification channels including EMAIL, SLACK, and SFTP." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"notificationId\": \"839dd1b8113ff809f3\",\n \"NotificationChannel\": \"EMAIL\"\n },\n {\n \"notificationId\": \"839dd1b8113ff819f3\",\n \"NotificationChannel\": \"SLACK\"\n },\n {\n \"notificationId\": \"839dd1b8113ff82af3\",\n \"NotificationChannel\": \"SFTP\",\n \"publicKey\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCfGfO3kOLdYji5R6GNI8lvfyI5MgpQY43OF+HwAqgF96L6hg1jG/Nu58bToPZoaf+lkqp+/MDNGTIeRfMkR+3g1Q2sgZ3jGvN3lErvfbbnYGx7qDzfyMCg7i9VneVOJb4fxoSRzbja2ZG7XxbSzBPvzGky38AKqBq5EysO8/FnA6I9SNCMPcyaEq3Rs33kGjcBthOxc3X+3dRvKt0GU77xtt0tWl7vP/DHXj9m32kcjNN2647i/oRoAiM58fhtsU3UM5TQGYn6WJ0/su7X5JnBy2+WktotJvfzF7ri2Q+R5Ac7kem5g17wdMPgICaz1sDY6haxI3TuDOe8ZVybfV6T surfboard-test@34.88.179.4\"\n }\n ],\n \"message\": \"External notification for PARTNER_ID: 8113d3f8403b380409 registered successfully\"\n}" } ] }, { "name": "Fetch External Notifications for Partner", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "notifications" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ], "query": [ { "key": "event", "value": "", "description": "Filter by event type", "disabled": true }, { "key": "notificationChannel", "value": "", "description": "Filter by notification channel. Possible values: `EMAIL`, `SLACK`, `SFTP", "disabled": true }, { "key": "notificationId", "value": "", "description": "Filter by notification ID", "disabled": true } ] }, "description": "Retrieves all external notifications configured for a partner. Supports filtering by event type, notification channel, and notification ID" }, "response": [ { "name": "Fetch External Notifications for Partner - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "notifications" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ], "query": [ { "key": "event", "value": "", "description": "Filter by event type", "disabled": true }, { "key": "notificationChannel", "value": "", "description": "Filter by notification channel. Possible values: `EMAIL`, `SLACK`, `SFTP", "disabled": true }, { "key": "notificationId", "value": "", "description": "Filter by notification ID", "disabled": true } ] }, "description": "Retrieves all external notifications configured for a partner. Supports filtering by event type, notification channel, and notification ID" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"notificationId\": \"839cfe66fe08b00bf3\",\n \"event\": \"WEEKLY_FILE_TRANSFER\",\n \"notificationChannel\": \"SFTP\",\n \"address\": {\n \"host\": \"192.168.0.211\",\n \"user\": \"surfboard-test\",\n \"port\": 8080,\n \"publicKey\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDPrhFN05QsXZPVGn3uHpRih3bJrRARfvqvyZ5RuRG78YXiVjfHszckpzcay7uF6fsMQes8ky4RGywHs7UfhWbXhu5EDE/swZzTtu8TRVmRhIL6K1o8VKFEEJat3+UgwgrkdKHpUyld3r2doNcViHDiBTiVW4O4JR98/XHrhR7Ge9EPxE/iVwyur+YREtt3RKdZV3d+NG+4WFRqaq70lM13z0u1lACP8PRl4dyRbjrpGoMGq2zDSvyerzS6fKg7jm1UBOt4wznu8pjIE+A+9xiNvzpnxG1q4GxwpRq8e8AY5WIvpngOpaiifEObAGWnauvWnenPwV/yvudTwK4bFQBV surfboard-test@192.168.0.211\",\n \"separator\": \",\"\n },\n \"status\": \"REGISTERED\"\n },\n {\n \"notificationId\": \"839d223b9df16805f3\",\n \"event\": \"ONLINE_STORE_ONBOARDED\",\n \"notificationChannel\": \"EMAIL\",\n \"address\": {\n \"email\": \"partner@example.com\"\n },\n \"status\": \"SUBSCRIBED\"\n }\n ],\n \"message\": \"External notification for PARTNER_ID: 8113d3f8403b380409 fetched successfully\"\n}" } ] }, { "name": "Unsubscribe Notifications for Partner", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "notifications", ":notificationId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "notificationId", "value": "", "description": "notificationId" } ] }, "description": "Unsubscribe from a specific notification for a partner. This endpoint removes the notification subscription identified by the notification ID" }, "response": [ { "name": "Unsubscribe Notifications for Partner - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "notifications", ":notificationId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "notificationId", "value": "", "description": "notificationId" } ] }, "description": "Unsubscribe from a specific notification for a partner. This endpoint removes the notification subscription identified by the notification ID" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"External notification unsubscribed successfully for the given ID [8113d3f8403b380409] and external alert ID [839d12501df1680cf3]\"\n}" } ] } ] }, { "name": "Orders API", "description": "The Orders API enables merchants to create and manage unified orders with enhanced support for retail and multi-industry workflows. It supports both purchase and refund transactions within a single order, facilitating complex exchange processes. The system automatically determines the transaction type based on order amounts and line item quantities. It also supports multi-merchant scenarios, zero-value transactions for tokenization, and advanced service provider integrations, streamlining payment operations, including tracking, receipts, refunds, and exchanges.", "item": [ { "name": "Create Order", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\": \"{{terminalId}}\",\n \"referenceId\": \"orderabc\",\n \"orderLines\": [\n {\n \"id\": \"0000CHI01\",\n \"name\": \"Nike Shoes\",\n \"quantity\": 2,\n \"amount\": {\n \"regular\": 200,\n \"campaign\": 0,\n \"shipping\": 0,\n \"total\": 200,\n \"currency\": \"752\",\n \"tax\": [\n {\n \"amount\": 0,\n \"percentage\": 0,\n \"type\": \"VAT\"\n }\n ]\n }\n }\n ],\n \"controlFunctions\": {\n \"initiatePaymentsOptions\": {\n \"paymentMethod\": \"CARD\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a new order with a minimal payload. For the full request body with all fields, see 'Create Order (Full)'." }, "response": [] }, { "name": "Create Order (Full)", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\": \"{{terminalId}}\",\n \"referenceId\": \"your-reference-id\",\n \"comments\": \"\",\n \"customer\": {\n \"customerId\": \"\",\n \"person\": {\n \"name\": {\n \"firstName\": \"John\",\n \"middleName\": \"\",\n \"lastName\": \"Doe\"\n },\n \"email\": \"merchant@example.com\",\n \"phoneNumber\": {\n \"code\": \"46\",\n \"number\": \"701234567\"\n },\n \"birthDate\": \"1990-01-15\",\n \"personalNumber\": \"9001151234\",\n \"coordinationNumber\": \"9001151234\",\n \"countryResidence\": \"\",\n \"gdNumber\": \"701234567\"\n },\n \"company\": {\n \"vatId\": \"\",\n \"poDetails\": \"\"\n }\n },\n \"billing\": {\n \"name\": {\n \"firstName\": \"John\",\n \"middleName\": \"\",\n \"lastName\": \"Doe\"\n },\n \"email\": \"merchant@example.com\",\n \"phoneNumber\": {\n \"code\": \"46\",\n \"number\": \"701234567\"\n },\n \"address\": {\n \"careOf\": \"\",\n \"addressLine1\": \"123 Main Street\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"Stockholm\",\n \"postalCode\": \"11120\",\n \"countryCode\": \"SE\"\n }\n },\n \"shipping\": {\n \"name\": {\n \"firstName\": \"John\",\n \"middleName\": \"\",\n \"lastName\": \"Doe\"\n },\n \"email\": \"merchant@example.com\",\n \"phoneNumber\": {\n \"code\": \"46\",\n \"number\": \"701234567\"\n },\n \"address\": {\n \"careOf\": \"\",\n \"addressLine1\": \"123 Main Street\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"Stockholm\",\n \"postalCode\": \"11120\",\n \"countryCode\": \"SE\"\n }\n },\n \"orderLines\": [\n {\n \"id\": \"your-id-here\",\n \"externalItemId\": \"\",\n \"name\": \"John\",\n \"categoryId\": \"\",\n \"description\": \"\",\n \"quantity\": 1,\n \"amount\": {\n \"regular\": 1000,\n \"campaign\": 0,\n \"shipping\": 0,\n \"total\": 1000,\n \"currency\": \"752\",\n \"tax\": [\n {\n \"amount\": 1000,\n \"percentage\": 25,\n \"type\": \"VAT\"\n }\n ]\n },\n \"unit\": \"nos\",\n \"gtin\": \"\",\n \"imageUrl\": \"https://example.com\",\n \"brand\": \"\",\n \"purchaseOrderId\": \"\",\n \"promotionApplied\": \"\",\n \"metadata\": \"\",\n \"storeId\": \"{{storeId}}\"\n }\n ],\n \"totalOrderAmount\": {\n \"regular\": 1000,\n \"campaign\": 0,\n \"total\": 1000,\n \"currency\": \"752\",\n \"tax\": [\n {\n \"amount\": 1000,\n \"percentage\": 25,\n \"type\": \"VAT\"\n }\n ]\n },\n \"date\": \"2026-03-15T10:00:00+01:00\",\n \"metadata\": \"\",\n \"adjustments\": [\n {\n \"type\": \"VAT\",\n \"value\": \"\",\n \"metadata\": \"\"\n }\n ],\n \"controlFunctions\": {\n \"cancelPreviousPendingOrder\": true,\n \"orderLineLevelCalculation\": true,\n \"serviceProviders\": [\n {\n \"serviceProviderId\": \"\",\n \"amount\": {\n \"percentage\": \"\",\n \"fixed\": \"\",\n \"adjustmentTypes\": []\n }\n }\n ],\n \"initiatePaymentsOptions\": {\n \"paymentMethod\": \"CARD\",\n \"amount\": 1000,\n \"paymentMethodParams\": {\n \"tokenId\": \"\",\n \"swishMode\": \"\",\n \"payeePhoneNumber\": {\n \"code\": \"46\",\n \"number\": \"701234567\"\n },\n \"giftCard\": {\n \"giftCardId\": \"\",\n \"giftCardRedemptionMode\": \"\"\n },\n \"invoice\": {\n \"invoiceDistribution\": \"\",\n \"contractReference\": \"\",\n \"debtCollectionEnabled\": true,\n \"dueDate\": \"2026-03-15T10:00:00+01:00\",\n \"invoicePaymentMethods\": [],\n \"reminder\": true\n }\n },\n \"serialSplitPaymentsMode\": [],\n \"refundProcessingParams\": {\n \"purchasePaymentId\": \"{{paymentId}}\",\n \"refundReason\": \"\",\n \"otherReason\": \"\"\n }\n },\n \"tipsMode\": \"\",\n \"cardStatementDescriptor\": \"\",\n \"includeAdjustmentsForRefund\": true,\n \"lockToPaymentMethods\": [],\n \"tapBeforeAmount\": true,\n \"delayCapture\": true,\n \"delayPayout\": \"\",\n \"fulfillmentDate\": \"2026-03-15T10:00:00+01:00\",\n \"callBackUrl\": \"https://example.com\",\n \"throwErrorIfTerminalInactiveFor\": 0,\n \"clearingCutOff\": \"\",\n \"currency\": \"752\",\n \"authMode\": \"\",\n \"receipt\": {\n \"autoPrintReceipt\": true,\n \"autoSendReceiptIfEmailAvailable\": true,\n \"sequenceNumber\": \"701234567\",\n \"cashRegisterName\": \"\",\n \"controlUnitSerialNumber\": \"nos\",\n \"receiptRedirectURL\": \"https://example.com\",\n \"cashierName\": \"\",\n \"promotionsToDisplay\": []\n },\n \"surcharges\": {\n \"domestic\": {\n \"consumer\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n },\n \"corporate\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n }\n },\n \"international\": {\n \"consumer\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n },\n \"corporate\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n }\n },\n \"eea\": {\n \"consumer\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n },\n \"corporate\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "The createOrder API lets you create and pay for an order in a single call—supporting purchases, returns, and multiple payment methods for faster checkout." }, "response": [] }, { "name": "Update Order", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "orderId" } ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\": \"{{terminalId}}\",\n \"referenceId\": \"your-reference-id\",\n \"comments\": \"\",\n \"customer\": {\n \"customerId\": \"\",\n \"person\": {\n \"name\": {\n \"firstName\": \"John\",\n \"middleName\": \"\",\n \"lastName\": \"Doe\"\n },\n \"email\": \"merchant@example.com\",\n \"phoneNumber\": {\n \"code\": \"46\",\n \"number\": \"701234567\"\n },\n \"birthDate\": \"1990-01-15\",\n \"personalNumber\": \"9001151234\",\n \"coordinationNumber\": \"9001151234\",\n \"countryResidence\": \"\",\n \"gdNumber\": \"701234567\"\n },\n \"company\": {\n \"vatId\": \"\",\n \"poDetails\": \"\"\n }\n },\n \"billing\": {\n \"name\": {\n \"firstName\": \"John\",\n \"middleName\": \"\",\n \"lastName\": \"Doe\"\n },\n \"email\": \"merchant@example.com\",\n \"phoneNumber\": {\n \"code\": \"46\",\n \"number\": \"701234567\"\n },\n \"address\": {\n \"careOf\": \"\",\n \"addressLine1\": \"123 Main Street\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"Stockholm\",\n \"postalCode\": \"11120\",\n \"countryCode\": \"SE\"\n }\n },\n \"shipping\": {\n \"name\": {\n \"firstName\": \"John\",\n \"middleName\": \"\",\n \"lastName\": \"Doe\"\n },\n \"email\": \"merchant@example.com\",\n \"phoneNumber\": {\n \"code\": \"46\",\n \"number\": \"701234567\"\n },\n \"address\": {\n \"careOf\": \"\",\n \"addressLine1\": \"123 Main Street\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"Stockholm\",\n \"postalCode\": \"11120\",\n \"countryCode\": \"SE\"\n }\n },\n \"orderLines\": [\n {\n \"id\": \"your-id-here\",\n \"externalItemId\": \"\",\n \"name\": \"John\",\n \"categoryId\": \"\",\n \"description\": \"\",\n \"quantity\": 1,\n \"amount\": {\n \"regular\": 1000,\n \"campaign\": 0,\n \"shipping\": 0,\n \"total\": 1000,\n \"currency\": \"752\",\n \"tax\": [\n {\n \"amount\": 1000,\n \"percentage\": 25,\n \"type\": \"VAT\"\n }\n ]\n },\n \"unit\": \"nos\",\n \"gtin\": \"\",\n \"imageUrl\": \"https://example.com\",\n \"brand\": \"\",\n \"purchaseOrderId\": \"\",\n \"promotionApplied\": \"\",\n \"metadata\": \"\",\n \"storeId\": \"{{storeId}}\"\n }\n ],\n \"totalOrderAmount\": {\n \"regular\": 1000,\n \"campaign\": 0,\n \"total\": 1000,\n \"currency\": \"752\",\n \"tax\": [\n {\n \"amount\": 1000,\n \"percentage\": 25,\n \"type\": \"VAT\"\n }\n ]\n },\n \"date\": \"2026-03-15T10:00:00+01:00\",\n \"metadata\": \"\",\n \"adjustments\": [\n {\n \"type\": \"VAT\",\n \"value\": \"\",\n \"metadata\": \"\"\n }\n ],\n \"controlFunctions\": {\n \"cancelPreviousPendingOrder\": true,\n \"orderLineLevelCalculation\": true,\n \"serviceProviders\": [\n {\n \"serviceProviderId\": \"\",\n \"amount\": {\n \"percentage\": \"\",\n \"fixed\": \"\",\n \"adjustmentTypes\": []\n }\n }\n ],\n \"initiatePaymentsOptions\": {\n \"paymentMethod\": \"CARD\",\n \"amount\": 1000,\n \"paymentMethodParams\": {\n \"tokenId\": \"\",\n \"swishMode\": \"\",\n \"payeePhoneNumber\": {\n \"code\": \"46\",\n \"number\": \"701234567\"\n },\n \"giftCard\": {\n \"giftCardId\": \"\",\n \"giftCardRedemptionMode\": \"\"\n },\n \"invoice\": {\n \"invoiceDistribution\": \"\",\n \"contractReference\": \"\",\n \"debtCollectionEnabled\": true,\n \"dueDate\": \"2026-03-15T10:00:00+01:00\",\n \"invoicePaymentMethods\": [],\n \"reminder\": true\n }\n },\n \"serialSplitPaymentsMode\": [],\n \"refundProcessingParams\": {\n \"purchasePaymentId\": \"{{paymentId}}\",\n \"refundReason\": \"\",\n \"otherReason\": \"\"\n }\n },\n \"tipsMode\": \"\",\n \"cardStatementDescriptor\": \"\",\n \"includeAdjustmentsForRefund\": true,\n \"lockToPaymentMethods\": [],\n \"tapBeforeAmount\": true,\n \"delayCapture\": true,\n \"delayPayout\": \"\",\n \"fulfillmentDate\": \"2026-03-15T10:00:00+01:00\",\n \"callBackUrl\": \"https://example.com\",\n \"throwErrorIfTerminalInactiveFor\": 0,\n \"clearingCutOff\": \"\",\n \"currency\": \"752\",\n \"authMode\": \"\",\n \"receipt\": {\n \"autoPrintReceipt\": true,\n \"autoSendReceiptIfEmailAvailable\": true,\n \"sequenceNumber\": \"701234567\",\n \"cashRegisterName\": \"\",\n \"controlUnitSerialNumber\": \"nos\",\n \"receiptRedirectURL\": \"https://example.com\",\n \"cashierName\": \"\",\n \"promotionsToDisplay\": []\n },\n \"surcharges\": {\n \"domestic\": {\n \"consumer\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n },\n \"corporate\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n }\n },\n \"international\": {\n \"consumer\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n },\n \"corporate\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n }\n },\n \"eea\": {\n \"consumer\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n },\n \"corporate\": {\n \"debit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n },\n \"credit\": {\n \"fixedAmount\": 1000,\n \"fixedPercentage\": 25\n }\n }\n }\n },\n \"readTags\": \"\",\n \"online\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the details of an existing order. This API allows you to modify order information while retaining the same Order ID as the original order. Once a payment has been initiated for the order, further updates are no longer permitted." }, "response": [] }, { "name": "Fetch Order Status", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/status", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "status" ], "variable": [ { "key": "orderId", "value": "", "description": "orderId" } ] }, "description": "Retrieves the status of the given order. Use this API to obtain information about the current status of the order including the respective payment and transaction details." }, "response": [ { "name": "Fetch Order Status - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/status", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "status" ], "variable": [ { "key": "orderId", "value": "", "description": "orderId" } ] }, "description": "Retrieves the status of the given order. Use this API to obtain information about the current status of the order including the respective payment and transaction details." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"orderStatus\": \"PAYMENT_COMPLETED\",\n\t\t\"payments\": [\n\t\t\t{\n\t\t\t\t\"paymentId\": \"838a071326f1330706\",\n\t\t\t\t\"paymentStatus\": \"PAYMENT_COMPLETED\",\n\t\t\t\t\"paymentMethod\": \"CARD\",\n\t\t\t\t\"amount\": 200\n\t\t\t}\n\t\t],\n\t\t\"transactions\": [\n\t\t\t{\n\t\t\t\t\"transactionId\": \"838a071326f1333319\",\n\t\t\t\t\"merchantId\": \"8280577d677b18050e\",\n\t\t\t\t\"terminalId\": \"828057b63d8e480804\",\n\t\t\t\t\"orderId\": \"838a071326f130950b\",\n\t\t\t\t\"paymentId\": \"838a071326f1330706\",\n\t\t\t\t\"rrn\": \"526506000001\",\n\t\t\t\t\"amount\": \"200\",\n\t\t\t\t\"currency\": \"752\",\n\t\t\t\t\"method\": \"CARD\",\n\t\t\t\t\"type\": \"PURCHASE\",\n\t\t\t\t\"timestamp\": \"2025-10-08T07:25:11.144Z\",\n\t\t\t\t\"voided\": false,\n\t\t\t\t\"settlementStatus\": \"NOT_SETTLED\",\n\t\t\t\t\"truncatedPan\": \"0010\",\n\t\t\t\t\"posEntryMode\": \"07\",\n\t\t\t\t\"customerResponseCode\": \"00\",\n\t\t\t\t\"cvmMethodDescription\": \"No CVM\",\n\t\t\t\t\"authMode\": \"ISSUER\",\n\t\t\t\t\"cardBrand\": \"VISA\"\n\t\t\t}\n\t\t],\n\t\t\"paymentIds\": [\n\t\t\t\"838a071326f1330706\"\n\t\t]\n\t},\n\t\"message\": \"Fetched order status successfully\"\n}" } ] }, { "name": "Fetch Order by Id", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "orderId" } ] }, "description": "Retrieves the details of an existing order using its Order Id." }, "response": [ { "name": "Fetch Order by Id - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "orderId" } ] }, "description": "Retrieves the details of an existing order using its Order Id." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"terminal$id\": \"8386af3b0f71b80b04\",\n\t\t\"referenceId\": \"838f324b016d7009\",\n\t\t\"date\": \"2025-10-14T07:39:02.812Z\",\n\t\t\"adjustments\": [\n\t\t\t{\n\t\t\t\t\"adjustmentId\": \"838f324b016d703e36\",\n\t\t\t\t\"type\": \"TIPS\",\n\t\t\t\t\"value\": \"100\"\n\t\t\t}\n\t\t],\n\t\t\"orderLines\": [\n\t\t\t{\n\t\t\t\t\"id\": \"TERM123NAL\",\n\t\t\t\t\"name\": \"Nike Shoes\",\n\t\t\t\t\"quantity\": 1,\n\t\t\t\t\"amount\": {\n\t\t\t\t\t\"regular\": 500,\n\t\t\t\t\t\"total\": 500,\n\t\t\t\t\t\"currency\": \"752\",\n\t\t\t\t\t\"tax\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"amount\": 20,\n\t\t\t\t\t\t\t\"percentage\": 20,\n\t\t\t\t\t\t\t\"type\": \"VAT\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"totalOrderAmount\": {\n\t\t\t\"regular\": 500,\n\t\t\t\"total\": 600,\n\t\t\t\"currency\": \"752\"\n\t\t},\n\t\t\"controlFunctions\": {\n\t\t\t\"cancelPreviousPendingOrder\": false,\n\t\t\t\"orderLineLevelCalculation\": false\n\t\t}\n\t},\n\t\"message\": \"Order fetched successfully\"\n}" } ] } ] }, { "name": "Payment Methods API", "description": "The Payment Methods API enables you to add, manage, and remove additional payments methods offered by Surfboard. While the CARD is the default payment method, these APIs allows for the addition and removal of other payment methods such as AMEX and SWISH. These payment methods can be added to specific merchants and/or stores, offering versatility in payment strategies.", "item": [ { "name": "Activate Payment Method", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/payment-methods", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "payment-methods" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n\t\"card\": true,\n\t\"amex\": true,\n\t\"swish\": true,\n\t\"klarna\": true,\n\t\"b2binv\": true,\n\t\"acc2acc\": true,\n\t\"vipps\": true,\n\t\"mobilepay\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Activates multiple payment methods for a merchant in a single request. Each payment method can be enabled with a boolean value or configured with specific settings using an object." }, "response": [ { "name": "Activate Payment Method - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/payment-methods", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "payment-methods" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n\t\"card\": true,\n\t\"amex\": true,\n\t\"swish\": true,\n\t\"klarna\": true,\n\t\"b2binv\": true,\n\t\"acc2acc\": true,\n\t\"vipps\": true,\n\t\"mobilepay\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Activates multiple payment methods for a merchant in a single request. Each payment method can be enabled with a boolean value or configured with specific settings using an object." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t\t{\n\t\t\t\"method\": \"b2binv\",\n\t\t\t\"paymentMethodId\": \"838f499c1f7bf00c23\",\n\t\t\t\"status\": \"SUCCESS\"\n\t\t},\n\t\t{\n\t\t\t\"method\": \"card\",\n\t\t\t\"paymentMethodId\": \"82523116c63be80123\",\n\t\t\t\"status\": \"SUCCESS\"\n\t\t},\n\t\t{\n\t\t\t\"method\": \"swish\",\n\t\t\t\"status\": \"ERROR\",\n\t\t\t\"message\": \"PM_0010 - Register payment method failed: SWISH registration already exists.\"\n\t\t},\n\t\t{\n\t\t\t\"method\": \"acc2acc\",\n\t\t\t\"paymentMethodId\": \"838f499c1f7bf01c23\",\n\t\t\t\"status\": \"SUCCESS\"\n\t\t}\n\t],\n\t\"message\": \"Processed payment method registrations\"\n}" } ] }, { "name": "Deactivate Payment Method", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/payment-methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "payment-methods", ":paymentMethodId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "paymentMethodId", "value": "", "description": "paymentMethodId" } ] }, "description": "Deactivates a specific payment method. Use this API to deactivate the payment method added to the merchant or store using its Payment Method ID." }, "response": [ { "name": "Deactivate Payment Method - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/payment-methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "payment-methods", ":paymentMethodId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "paymentMethodId", "value": "", "description": "paymentMethodId" } ] }, "description": "Deactivates a specific payment method. Use this API to deactivate the payment method added to the merchant or store using its Payment Method ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Deactivated payment method successfully\"\n}" } ] }, { "name": "Fetch Payment Method Details", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/payment-methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "payment-methods", ":paymentMethodId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "paymentMethodId", "value": "", "description": "paymentMethodId" } ] }, "description": "Retrieves information for a specific payment method. Use this API to get information regarding the payment method using its Payment Method ID." }, "response": [ { "name": "Fetch Payment Method Details - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/payment-methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "payment-methods", ":paymentMethodId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "paymentMethodId", "value": "", "description": "paymentMethodId" } ] }, "description": "Retrieves information for a specific payment method. Use this API to get information regarding the payment method using its Payment Method ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"paymentMethodId\": \"8235c0943bd9800023\",\n\t\t\"paymentMethod\": \"AMEX\",\n\t\t\"status\": \"ACTIVATED\",\n\t\t\"amexMID\": \"abcedefg\"\n\t},\n\t\"message\": \"Fetched payment method successfully\"\n}" } ] }, { "name": "Fetch All Payment Methods", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/payment-methods", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "payment-methods" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves a list of all payment methods activated for a specific merchant. You can use this API to get information regarding all the payment methods added for the merchant." }, "response": [ { "name": "Fetch All Payment Methods - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/payment-methods", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "payment-methods" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves a list of all payment methods activated for a specific merchant. You can use this API to get information regarding all the payment methods added for the merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t\t{\n\t\t\t\"paymentMethodId\": \"8235c0a33bd9800223\",\n\t\t\t\"paymentMethod\": \"SSWISH\"\n\t\t},\n\t\t{\n\t\t\t\"paymentMethodId\": \"8235c0943bd9800023\",\n\t\t\t\"paymentMethod\": \"AMEX\"\n\t\t}\n\t],\n\t\"message\": \"Fetched activated payment methods\"\n}" } ] } ] }, { "name": "Payments API", "description": "The Payments API enables merchants to initiate, check the status of, cancel, and void payments. The payment operations are performed for the orders created by the merchants. This ensures that each payment is associated with a specific order and has rich data associated with it.", "item": [ { "name": "Initiate a Payment", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] }, "body": { "mode": "raw", "raw": "{\n \"orderId\": \"838ca7fc6d7de9770b\",\n \"paymentMethod\": \"CARD\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Initiates a payment for a specific order. Use this API to initiate a payment for the order created. The default method for processing the initiated payment is via card. Additional payment methods can be enabled using the Payment Methods API." }, "response": [ { "name": "Initiate a Payment - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] }, "body": { "mode": "raw", "raw": "{\n \"orderId\": \"838ca7fc6d7de9770b\",\n \"paymentMethod\": \"CARD\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Initiates a payment for a specific order. Use this API to initiate a payment for the order created. The default method for processing the initiated payment is via card. Additional payment methods can be enabled using the Payment Methods API." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"paymentId\": \"811f9bd48c6eb80c06\",\n \"interAppJWT\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvaWQiOiI4MzA0NDdkM2U3NGQwMDBiMGIiLCJ0aWQiOiI4MmZmN2MyNTgxNDhkODA1MDQiLCJwaWQiOiI4MzA0NGIzNzAzZmVkODAxMDYiLCJwbSI6IkNBUkQiLCJhIjoxMDAwLCJjIjoiNzUyIiwiY29udHJvbEZ1bmN0aW9uc0VuY29kZXIiOiIxIiwiaXNzdWVkQnkiOiJzYi5wcyIsImlhdCI6MTc0MjIyMTI5NDE1NH0.ftXsXUKmNl-ck47jXKPIa1WXbmH0gbiM8nUAOjBbb0U\"\n },\n \"message\": \"Payment initiated successfully\"\n}" } ] }, { "name": "Cancel a Payment", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments/:paymentId", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":paymentId" ], "variable": [ { "key": "paymentId", "value": "", "description": "paymentId" } ] }, "description": "Cancels the initiated payment. You can use this API to cancel the payment instance created. However, you cannot cancel a completed payment. If the payment is already completed, you can use the Void a Payment API to void the specific payment." }, "response": [ { "name": "Cancel a Payment - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments/:paymentId", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":paymentId" ], "variable": [ { "key": "paymentId", "value": "", "description": "paymentId" } ] }, "description": "Cancels the initiated payment. You can use this API to cancel the payment instance created. However, you cannot cancel a completed payment. If the payment is already completed, you can use the Void a Payment API to void the specific payment." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"paymentStatus\": \"PAYMENT_CANCELLED\"\n },\n \"message\": \"Payment cancelled successfully.\"\n}" } ] }, { "name": "Void a Payment", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments/:paymentId/void", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":paymentId", "void" ], "variable": [ { "key": "paymentId", "value": "", "description": "paymentId" } ] }, "body": { "mode": "raw", "raw": "// No request body is required for this endpoint.", "options": { "raw": { "language": "json" } } }, "description": "Voids a completed payment. If a merchant identifies an issue with a payment soon after it has been completed, use this API to promptly void the payment, thereby preventing potential issues arising from incorrect payments. Note that payment has to be in status ‘PAYMENT_COMPLETED’ and void triggered before 23:00 UTC. For orders with delayCapture set to true, void can be initiated anytime before the capture call." }, "response": [ { "name": "Void a Payment - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments/:paymentId/void", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":paymentId", "void" ], "variable": [ { "key": "paymentId", "value": "", "description": "paymentId" } ] }, "body": { "mode": "raw", "raw": "// No request body is required for this endpoint.", "options": { "raw": { "language": "json" } } }, "description": "Voids a completed payment. If a merchant identifies an issue with a payment soon after it has been completed, use this API to promptly void the payment, thereby preventing potential issues arising from incorrect payments. Note that payment has to be in status ‘PAYMENT_COMPLETED’ and void triggered before 23:00 UTC. For orders with delayCapture set to true, void can be initiated anytime before the capture call." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"voidStatus\": \"VOID_INITIATED\"\n\t},\n\t\"message\": \"payment void status successfully retrieved from external API\"\n}" } ] }, { "name": "Capture Payment", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments/:paymentId/capture", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":paymentId", "capture" ], "variable": [ { "key": "paymentId", "value": "", "description": "paymentId" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 200\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to complete the authorisation and capture a payment while using the pre-auth flow or to capture a payment when the delayCapture flag is set." }, "response": [ { "name": "Capture Payment - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments/:paymentId/capture", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":paymentId", "capture" ], "variable": [ { "key": "paymentId", "value": "", "description": "paymentId" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 200\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to complete the authorisation and capture a payment while using the pre-auth flow or to capture a payment when the delayCapture flag is set." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\":\"SUCCESS\",\n\t\"message\":\"Payment captured successfully\"\n}" } ] }, { "name": "Check Capture Status", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments/:paymentId/capture", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":paymentId", "capture" ], "variable": [ { "key": "paymentId", "value": "", "description": "paymentId" } ] }, "description": "Retrieves the status of the capture payment request. Capture payments for delayed capture is an asynchronous request that is processed in batches. Once the initial capturePayments request is made, please make this call after approximately 30 minutes to get the response" }, "response": [ { "name": "Check Capture Status - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payments/:paymentId/capture", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":paymentId", "capture" ], "variable": [ { "key": "paymentId", "value": "", "description": "paymentId" } ] }, "description": "Retrieves the status of the capture payment request. Capture payments for delayed capture is an asynchronous request that is processed in batches. Once the initial capturePayments request is made, please make this call after approximately 30 minutes to get the response" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t \"captureStatus\":\"SUCCESS\"\n\t},\n\t\"message\": \"Capture status fetched successfully.\"\n}" } ] } ] }, { "name": "Product Catalog API", "description": "The product catalog API allows the merchants to create a catalog and organise the products with detailed specifications under their store.", "item": [ { "name": "Create Product Catalog", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog", "host": [ "{{baseUrl}}" ], "path": [ "catalog" ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\":\"8136a645a2c2d1bb0f\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API lets you to create a product catalog for your store to make an effortless product organisation in the catalog." }, "response": [ { "name": "Create Product Catalog - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog", "host": [ "{{baseUrl}}" ], "path": [ "catalog" ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\":\"8136a645a2c2d1bb0f\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API lets you to create a product catalog for your store to make an effortless product organisation in the catalog." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"catalogId\": \"8219688f18ebb8020a\"\n },\n \"message\": \"Product catalog created successfully\"\n}" } ] }, { "name": "Fetch Product Catalogs", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog", "host": [ "{{baseUrl}}" ], "path": [ "catalog" ], "query": [ { "key": "storeId", "value": "", "description": "The ID of the store for which to retrieve catalogs.", "disabled": true } ] }, "description": "Retrieves all product catalogs under the store." }, "response": [ { "name": "Fetch Product Catalogs - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog", "host": [ "{{baseUrl}}" ], "path": [ "catalog" ], "query": [ { "key": "storeId", "value": "", "description": "The ID of the store for which to retrieve catalogs.", "disabled": true } ] }, "description": "Retrieves all product catalogs under the store." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"catalogId\": [\n\t\t\t\"8187c051854a38000a\",\n\t\t\t\"818a5d4df1c258090a\",\n\t\t\t\"818bb06b93a5500b0a\",\n\t\t\t\"818f9f37bd0b58040a\"\n\t\t]\n\t},\n\t\"message\": \"Product catalog fetched for storeId: 8136a645a2c2d1bb0f\"\n}" } ] }, { "name": "Create Product", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"name\": \"SurfPad Purple Logo\",\n \"type\": \"PRODUCT\",\n \"unitType\": \"FIXED\",\n \"costPrice\": 20,\n \"sellingPrice\": 45,\n \"currencyCode\": \"752\",\n \"tax\": [\n {\n \"type\": \"VAT\",\n \"percentage\": \"3\"\n }\n ],\n \"description\": \"SurfPad Payment Terminal in Purple\",\n \"category\": \"electronics\",\n \"unit\": \"nos\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"723453\",\n \"barCode\": \"7812123454323\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to create a product in the product catalog." }, "response": [ { "name": "Create Product - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"name\": \"SurfPad Purple Logo\",\n \"type\": \"PRODUCT\",\n \"unitType\": \"FIXED\",\n \"costPrice\": 20,\n \"sellingPrice\": 45,\n \"currencyCode\": \"752\",\n \"tax\": [\n {\n \"type\": \"VAT\",\n \"percentage\": \"3\"\n }\n ],\n \"description\": \"SurfPad Payment Terminal in Purple\",\n \"category\": \"electronics\",\n \"unit\": \"nos\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"723453\",\n \"barCode\": \"7812123454323\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to create a product in the product catalog." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"productId\": \"81c30d16df28880301\"\n },\n \"message\": \"Product created successfully\"\n}" } ] }, { "name": "Update Product", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"name\": \"SurfPad Black Logo\",\n \"costPrice\": 0,\n \"sellingPrice\": 15,\n \"description\": \"SurfPad Payment Terminal in Black\",\n \"category\": \"electronics\",\n \"unit\": \"nos\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"723453\",\n \"barCode\": \"7812123454323\"\n}", "options": { "raw": { "language": "json" } } }, "description": "You can use this API to modify the products." }, "response": [ { "name": "Update Product - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"name\": \"SurfPad Black Logo\",\n \"costPrice\": 0,\n \"sellingPrice\": 15,\n \"description\": \"SurfPad Payment Terminal in Black\",\n \"category\": \"electronics\",\n \"unit\": \"nos\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"723453\",\n \"barCode\": \"7812123454323\"\n}", "options": { "raw": { "language": "json" } } }, "description": "You can use this API to modify the products." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Product updated successfully\"\n}" } ] }, { "name": "Fetch all products", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" } ], "query": [ { "key": "storeId", "value": "", "description": "The ID of the store to fetch products from.", "disabled": true } ] }, "description": "This API allows you to retrieve all products associated with a product catalog." }, "response": [ { "name": "Fetch all products - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" } ], "query": [ { "key": "storeId", "value": "", "description": "The ID of the store to fetch products from.", "disabled": true } ] }, "description": "This API allows you to retrieve all products associated with a product catalog." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"products\": [\n {\n \"productId\": \"823913d474de600e01\",\n \"name\": \"SurfPad Black Logo\",\n \"currencyCode\": \"752\",\n \"description\": \"SurfPad Payment Terminal in Black\",\n \"category\": \"electronics\",\n \"unit\": \"nos\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"723453\",\n \"barCode\": \"7812123454323\",\n \"productProperties\": {\n \"size\": \"15x5 cm\",\n \"origin\": \"sweden\",\n \"weight\": \"250 g\",\n \"manufacturer\": \"datecs\"\n },\n \"inventory\": {},\n \"unitType\": \"FIXED\",\n \"type\": \"PRODUCT\",\n \"relatedProducts\": [],\n \"sellingPrice\": 15,\n \"variants\": [],\n \"billingPlans\": [],\n \"tax\": [\n {\n \"type\": \"VAT\",\n \"percentage\": \"3\",\n \"amount\": 0\n }\n ],\n \"variantCategories\": [],\n \"campaignInfo\": [\n {\n \"campaignName\": \"First campaign\",\n \"campaignId\": \"8239b16f0a59580224\",\n \"fixedAmount\": 20,\n \"percentage\": null\n }\n ]\n }\n ],\n \"bundles\": []\n },\n \"message\": \"Products fetched successfully\"\n}" } ] }, { "name": "Fetch Product by Id", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ], "query": [ { "key": "storeId", "value": "", "description": "The unique identifier for the store.", "disabled": true } ] }, "description": "This API allows you to retrieve a specific product by its ID." }, "response": [ { "name": "Fetch Product by Id - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ], "query": [ { "key": "storeId", "value": "", "description": "The unique identifier for the store.", "disabled": true } ] }, "description": "This API allows you to retrieve a specific product by its ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"id\": \"838bfc15a601800901\",\n\t\t\"name\": \"Test Product\",\n\t\t\"sellingPrice\": 149,\n\t\t\"currencyCode\": \"752\",\n\t\t\"description\": \"Sitter som en smäck\",\n\t\t\"category\": \"TERMINAL\",\n\t\t\"popularity\": 0,\n\t\t\"unit\": \"nos\",\n\t\t\"hsnCode\": \"\",\n\t\t\"barcode\": \"\",\n\t\t\"type\": \"PRODUCT\",\n\t\t\"unitType\": \"FIXED_UNIT\",\n\t\t\"attributeValues\": [\n\t\t\t{\n\t\t\t\t\"attributeKey\": \"storlek\",\n\t\t\t\t\"displayName\": \"Storlek XL\",\n\t\t\t\t\"value\": \"XL\"\n\t\t\t}\n\t\t],\n\t\t\"tax\": [\n\t\t\t{\n\t\t\t\t\"type\": \"VAT\",\n\t\t\t\t\"percentage\": \"3\",\n\t\t\t\t\"amount\": 0\n\t\t\t}\n\t\t]\n\t},\n\t\"message\": \"Products fetched successfully\"\n}" } ] }, { "name": "Add Variant For Product", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/variants", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "variants" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"variants\": [\n {\n \"name\": \"SurfPad Blue Variant\",\n \"description\": \"Blue variant of SurfPad\",\n \"costPrice\": 10,\n \"sellingPrice\": 12,\n \"currencyCode\": \"752\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"123453\",\n \"barCode\": \"1212123454323\",\n \"attributeValues\": [\n {\n \"attributeKey\": \"colour\",\n \"displayName\": \"blue\",\n \"value\": \"#0000FF\"\n },\n {\n \"attributeKey\": \"size\",\n \"displayName\": \"medium\",\n \"value\": \"M\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to add a variant to an existing product in the product catalog." }, "response": [ { "name": "Add Variant For Product - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/variants", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "variants" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"variants\": [\n {\n \"name\": \"SurfPad Blue Variant\",\n \"description\": \"Blue variant of SurfPad\",\n \"costPrice\": 10,\n \"sellingPrice\": 12,\n \"currencyCode\": \"752\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"123453\",\n \"barCode\": \"1212123454323\",\n \"attributeValues\": [\n {\n \"attributeKey\": \"colour\",\n \"displayName\": \"blue\",\n \"value\": \"#0000FF\"\n },\n {\n \"attributeKey\": \"size\",\n \"displayName\": \"medium\",\n \"value\": \"M\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to add a variant to an existing product in the product catalog." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"variants\": [\"81c319b6c7d2080807\"]\n },\n \"message\": \"Variants added successfully\"\n}" } ] }, { "name": "Add Related Products", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/related-products", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "related-products" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"relatedProducts\": [\"818f9fc43d0b580f01\"]\n}", "options": { "raw": { "language": "json" } } }, "description": "This API helps you to tag the product with other relatable products in the catalog." }, "response": [ { "name": "Add Related Products - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/related-products", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "related-products" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"relatedProducts\": [\"818f9fc43d0b580f01\"]\n}", "options": { "raw": { "language": "json" } } }, "description": "This API helps you to tag the product with other relatable products in the catalog." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Related Products for merchant added successfully\"\n}" } ] }, { "name": "Update Product Inventory", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/inventory", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "inventory" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"operation\": \"STOCK_UP\",\n \"quantity\": 10,\n \"unit\": \"nos\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update available stocks in the product inventory using this API." }, "response": [ { "name": "Update Product Inventory - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/inventory", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "inventory" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"operation\": \"STOCK_UP\",\n \"quantity\": 10,\n \"unit\": \"nos\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update available stocks in the product inventory using this API." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Inventory updated successfully\"\n}" } ] }, { "name": "Update Variant", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/variants/:variantId", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "variants", ":variantId" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" }, { "key": "variantId", "value": "", "description": "variantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"name\": \"SurfPad Black Logo - Large\",\n \"costPrice\": 0,\n \"sellingPrice\": 18,\n \"description\": \"SurfPad Payment Terminal in Black - Large Size\",\n \"category\": \"electronics\",\n \"unit\": \"nos\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"723453\",\n \"barCode\": \"7812123454323\"\n}", "options": { "raw": { "language": "json" } } }, "description": "You can use this API to modify the product variants." }, "response": [ { "name": "Update Variant - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/variants/:variantId", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "variants", ":variantId" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" }, { "key": "variantId", "value": "", "description": "variantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"name\": \"SurfPad Black Logo - Large\",\n \"costPrice\": 0,\n \"sellingPrice\": 18,\n \"description\": \"SurfPad Payment Terminal in Black - Large Size\",\n \"category\": \"electronics\",\n \"unit\": \"nos\",\n \"productImages\": [\n \"https://res.cloudinary.com/martinsurf/image/upload/v1619101937/surfboardpayments/surfboard-icon.svg\"\n ],\n \"hsnCode\": \"723453\",\n \"barCode\": \"7812123454323\"\n}", "options": { "raw": { "language": "json" } } }, "description": "You can use this API to modify the product variants." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Variant updated successfully\"\n}" } ] }, { "name": "Update Variant Inventory", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/variants/:variantId/inventory", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "variants", ":variantId", "inventory" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" }, { "key": "variantId", "value": "", "description": "variantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"operation\": \"STOCK_UP\",\n \"quantity\": 15,\n \"unit\": \"nos\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update available stocks in the variant inventory using this API." }, "response": [ { "name": "Update Variant Inventory - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/variants/:variantId/inventory", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "variants", ":variantId", "inventory" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" }, { "key": "variantId", "value": "", "description": "variantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeId\": \"8136a645a2c2d1bb0f\",\n \"operation\": \"STOCK_UP\",\n \"quantity\": 15,\n \"unit\": \"nos\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update available stocks in the variant inventory using this API." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Variant inventory updated successfully\"\n}" } ] }, { "name": "Generate Product Description", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/ai/description", "host": [ "{{baseUrl}}" ], "path": [ "catalog", "ai", "description" ] }, "body": { "mode": "raw", "raw": "{\n\t\"productName\": \"Addidas Running Shoes\",\n\t\"maxWordLength\": 150,\n\t\"langCode\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Generate AI-powered product descriptions based on product name, word length, and language preferences. Use this API to create compelling, professional product descriptions that enhance your product listings and improve customer engagement." }, "response": [ { "name": "Generate Product Description - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/ai/description", "host": [ "{{baseUrl}}" ], "path": [ "catalog", "ai", "description" ] }, "body": { "mode": "raw", "raw": "{\n\t\"productName\": \"Addidas Running Shoes\",\n\t\"maxWordLength\": 150,\n\t\"langCode\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Generate AI-powered product descriptions based on product name, word length, and language preferences. Use this API to create compelling, professional product descriptions that enhance your product listings and improve customer engagement." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"description\": \"Unleash your peak performance with Adidas running shoes, meticulously engineered for speed, comfort, and endurance. Experience the revolutionary boost midsole technology that returns energy with every stride, propelling you forward effortlessly. The lightweight, breathable upper ensures optimal ventilation, keeping your feet cool and dry even during intense workouts. Designed with a precision fit, these shoes offer exceptional support and stability, reducing the risk of injury and enhancing your natural gait. Whether you're a seasoned marathoner or a casual jogger, Adidas running shoes provide the perfect blend of innovation and style. Conquer your goals and shatter your personal bests with the ultimate running companion. Step into a world of unparalleled performance and elevate your running experience with Adidas.\"\n\t},\n\t\"message\": \"Description generated successfully\"\n}" } ] }, { "name": "Generate Product Images", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/ai/image", "host": [ "{{baseUrl}}" ], "path": [ "catalog", "ai", "image" ] }, "body": { "mode": "raw", "raw": "{\n\t\"productName\": \"Gaming Laptop\",\n\t\"prompt\": \"sleek modern design with RGB lighting\",\n\t\"noOfImages\": 3,\n\t\"langCode\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Generate AI-powered product images based on product name, custom prompts, and specifications. Use this API to create professional product images that enhance your product catalog and marketing materials." }, "response": [ { "name": "Generate Product Images - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/ai/image", "host": [ "{{baseUrl}}" ], "path": [ "catalog", "ai", "image" ] }, "body": { "mode": "raw", "raw": "{\n\t\"productName\": \"Gaming Laptop\",\n\t\"prompt\": \"sleek modern design with RGB lighting\",\n\t\"noOfImages\": 3,\n\t\"langCode\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Generate AI-powered product images based on product name, custom prompts, and specifications. Use this API to create professional product images that enhance your product catalog and marketing materials." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"imagePath\": [\n\t\t\t\"https://storage.googleapis.com/sb-merchant-portal-ai-images/8113d3f8403b380409%2Fm_iWGri3XAyTmkbKYsYtV47%2Fadidas_t_shirt%2Fadidas_t_shirt_custom_prompt_09_08_2025_07_44_18_1.png\",\n\t\t\t\"https://storage.googleapis.com/sb-merchant-portal-ai-images/8113d3f8403b380409%2Fm_iWGri3XAyTmkbKYsYtV47%2Fadidas_t_shirt%2Fadidas_t_shirt_custom_prompt_09_08_2025_07_44_18_2.png\"\n\t\t]\n\t},\n\t\"message\": \"Images generated successfully\"\n}" } ] }, { "name": "Generate Product Catalog from Images", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/ai/scan", "host": [ "{{baseUrl}}" ], "path": [ "catalog", "ai", "scan" ] }, "body": { "mode": "raw", "raw": "{\n\t\"imgData\": [\n\t\t\"https://storage.googleapis.com/sb-merchant-portal-ai-images/testMerchant/TestMenu/menu01.png\"\n\t],\n\t\"imageType\": [\n\t\t\"png\"\n\t]\n}", "options": { "raw": { "language": "json" } } }, "description": "Generate product catalog data with images and menu information from existing image data. Use this API to extract structured product information from menu images or catalog photos, automatically creating product listings with descriptions and pricing." }, "response": [ { "name": "Generate Product Catalog from Images - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/ai/scan", "host": [ "{{baseUrl}}" ], "path": [ "catalog", "ai", "scan" ] }, "body": { "mode": "raw", "raw": "{\n\t\"imgData\": [\n\t\t\"https://storage.googleapis.com/sb-merchant-portal-ai-images/testMerchant/TestMenu/menu01.png\"\n\t],\n\t\"imageType\": [\n\t\t\"png\"\n\t]\n}", "options": { "raw": { "language": "json" } } }, "description": "Generate product catalog data with images and menu information from existing image data. Use this API to extract structured product information from menu images or catalog photos, automatically creating product listings with descriptions and pricing." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"menuData\": [\n\t\t\t[\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"The Junior\",\n\t\t\t\t\t\"description\": \"Two eggs any way, your choice of bacon, sausage, or ham, and coffee or tea.\",\n\t\t\t\t\t\"sellingPrice\": \"8.50\",\n\t\t\t\t\t\"currencyCode\": \"840\",\n\t\t\t\t\t\"category\": \"Breakfast Mains\",\n\t\t\t\t\t\"image\": \"https://storage.googleapis.com/sb-merchant-portal-ai-images/8113d3f8403b380409%2Fm_iWGri3XAyTmkbKYsYtV47%2Fthe_junior%2Fthe_junior_custom_prompt_09_08_2025_07_45_53_1.png\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"Buttermilk or Buckwheat Pancakes\",\n\t\t\t\t\t\"description\": \"Fluffy pancakes with a choice of bacon or maple sausage.\",\n\t\t\t\t\t\"sellingPrice\": \"8.00\",\n\t\t\t\t\t\"currencyCode\": \"840\",\n\t\t\t\t\t\"category\": \"Breakfast Mains\",\n\t\t\t\t\t\"image\": \"https://storage.googleapis.com/sb-merchant-portal-ai-images/8113d3f8403b380409%2Fm_iWGri3XAyTmkbKYsYtV47%2Fbuttermilk_or_buckwheat_pancakes%2Fbuttermilk_or_buckwheat_pancakes_custom_prompt_09_08_2025_07_45_52_1.png\"\n\t\t\t\t}\n\t\t\t]\n\t\t]\n\t},\n\t\"message\": \"Menu data extracted successfully\"\n}" } ] }, { "name": "Get Product Statistics", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/statistics", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "statistics" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ], "query": [ { "key": "startDate", "value": "", "description": "Start date of the statistics period in YYYY-MM-DD format.", "disabled": true }, { "key": "endDate", "value": "", "description": "End date of the statistics period in YYYY-MM-DD format.", "disabled": true } ] }, "description": "Retrieve comprehensive statistics for a specific product including sales data, inventory status, VAT breakdown, and variant performance metrics within an optional date range." }, "response": [ { "name": "Get Product Statistics - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/products/:productId/statistics", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "products", ":productId", "statistics" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" }, { "key": "productId", "value": "", "description": "productId" } ], "query": [ { "key": "startDate", "value": "", "description": "Start date of the statistics period in YYYY-MM-DD format.", "disabled": true }, { "key": "endDate", "value": "", "description": "End date of the statistics period in YYYY-MM-DD format.", "disabled": true } ] }, "description": "Retrieve comprehensive statistics for a specific product including sales data, inventory status, VAT breakdown, and variant performance metrics within an optional date range." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"productId\": \"838bfc15a601800901\",\n \"productName\": \"Test Product\",\n \"unit\": \"nos\",\n \"query\": {\n \"startDate\": \"2025-09-17\",\n \"endDate\": \"2025-12-17\"\n },\n \"statistics\": {\n \"byCurrency\": [],\n \"netUnitsSold\": 0\n },\n \"inventoryStatus\": {\n \"currentStock\": 0,\n \"stockIn\": 0,\n \"stockOut\": 0\n },\n \"vatBreakdown\": [],\n \"variants\": []\n },\n \"message\": \"Product statistics fetched successfully\"\n}" } ] }, { "name": "Get Product catalog Statistics", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/statistics", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "statistics" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" } ], "query": [ { "key": "startDate", "value": "", "description": "Start date of the statistics period in YYYY-MM-DD format.", "disabled": true }, { "key": "endDate", "value": "", "description": "End date of the statistics period in YYYY-MM-DD format.", "disabled": true } ] }, "description": "Retrieve comprehensive statistics for an entire product catalog including summary metrics, VAT breakdown, and top-selling products within an optional date range." }, "response": [ { "name": "Get Product catalog Statistics - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/catalog/:catalogId/statistics", "host": [ "{{baseUrl}}" ], "path": [ "catalog", ":catalogId", "statistics" ], "variable": [ { "key": "catalogId", "value": "", "description": "catalogId" } ], "query": [ { "key": "startDate", "value": "", "description": "Start date of the statistics period in YYYY-MM-DD format.", "disabled": true }, { "key": "endDate", "value": "", "description": "End date of the statistics period in YYYY-MM-DD format.", "disabled": true } ] }, "description": "Retrieve comprehensive statistics for an entire product catalog including summary metrics, VAT breakdown, and top-selling products within an optional date range." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"productCatalogId\": \"8372ed4bc2c0000b0a\",\n\t\t\"productCatalogName\": \"Electronics & Accessories\",\n\t\t\"query\": {\n\t\t\t\"startDate\": \"2025-07-01\",\n\t\t\t\"endDate\": \"2025-12-01\"\n\t\t},\n\t\t\"summary\": {\n\t\t\t\"totalProducts\": 5,\n\t\t\t\"totalVariants\": 2,\n\t\t\t\"byCurrency\": [\n\t\t\t\t{\n\t\t\t\t\t\"currency\": \"666\",\n\t\t\t\t\t\"totalUnitsSold\": 17,\n\t\t\t\t\t\"totalUnitsReturned\": 0,\n\t\t\t\t\t\"totalRevenue\": 20000,\n\t\t\t\t\t\"totalVat\": 1130,\n\t\t\t\t\t\"totalCampaignDiscount\": 0,\n\t\t\t\t\t\"orderCount\": 5,\n\t\t\t\t\t\"averageOrderValue\": 4000\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"currency\": \"752\",\n\t\t\t\t\t\"totalUnitsSold\": 120,\n\t\t\t\t\t\"totalUnitsReturned\": 0,\n\t\t\t\t\t\"totalRevenue\": 120000,\n\t\t\t\t\t\"totalVat\": 6780,\n\t\t\t\t\t\"totalCampaignDiscount\": 0,\n\t\t\t\t\t\"orderCount\": 30,\n\t\t\t\t\t\"averageOrderValue\": 4000\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"vatBreakdown\": [\n\t\t\t{\n\t\t\t\t\"vatPercentage\": \"6\",\n\t\t\t\t\"vatAmount\": 7910,\n\t\t\t\t\"taxableAmount\": 140000\n\t\t\t}\n\t\t],\n\t\t\"topSellingProducts\": [\n\t\t\t{\n\t\t\t\t\"productId\": \"8372ed51c2c0000701\",\n\t\t\t\t\"productName\": \"Wireless Bluetooth Headphones\",\n\t\t\t\t\"totalUnitsSold\": 92,\n\t\t\t\t\"totalRevenue\": 92000,\n\t\t\t\t\"currencyBreakdown\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"currency\": \"752\",\n\t\t\t\t\t\t\"totalUnitsSold\": 92,\n\t\t\t\t\t\t\"totalRevenue\": 92000\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"productId\": \"8393dbb7e836b00a01\",\n\t\t\t\t\"productName\": \"USB-C Charging Cable\",\n\t\t\t\t\"totalUnitsSold\": 44,\n\t\t\t\t\"totalRevenue\": 44000,\n\t\t\t\t\"currencyBreakdown\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"currency\": \"752\",\n\t\t\t\t\t\t\"totalUnitsSold\": 28,\n\t\t\t\t\t\t\"totalRevenue\": 28000\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"currency\": \"666\",\n\t\t\t\t\t\t\"totalUnitsSold\": 16,\n\t\t\t\t\t\t\"totalRevenue\": 16000\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"productId\": \"83757823162fe00501\",\n\t\t\t\t\"productName\": \"Portable Power Bank 10000mAh\",\n\t\t\t\t\"totalUnitsSold\": 1,\n\t\t\t\t\"totalRevenue\": 4000,\n\t\t\t\t\"currencyBreakdown\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"currency\": \"666\",\n\t\t\t\t\t\t\"totalUnitsSold\": 1,\n\t\t\t\t\t\t\"totalRevenue\": 4000\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t},\n\t\"message\": \"Product catalog statistics fetched successfully\"\n}" } ] } ] }, { "name": "Promotions API", "description": "The Promotions API enables businesses to manage, update and retrieve promotional campaigns effectively.", "item": [ { "name": "Create Promotion", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"First Promotion\",\n \"name\": \"Slash sale\",\n \"description\": \"Slash sale on all fruits\",\n \"assetUrl\": \"https://www.surfpayapp.com/hubfs/connect/surfpay_checkout-companion.png\",\n \"type\": \"RECEIPT_BIG\",\n \"assetOpacity\": \"0\",\n \"backgroundColor\": \"#a1a1aa\",\n \"contentTextColor\": \"#78716c\",\n \"endProductUrl\": \"https://www.timestamp-converter.com/\",\n \"endProduct\": \"12345\",\n \"buttonLabel\": \"Click\",\n \"priority\": 1,\n \"idleBigSpot\": true,\n \"receiptBig\": true,\n \"receiptSmall\": true,\n \"endDate\": \"05-05-2027\",\n \"startDate\": \"05-05-2025\"\n}", "options": { "raw": { "language": "json" } } }, "description": "The Create Promotion API enables users to create new marketing promotions by defining attributes such as title, content, schedule, and priority." }, "response": [ { "name": "Create Promotion - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"First Promotion\",\n \"name\": \"Slash sale\",\n \"description\": \"Slash sale on all fruits\",\n \"assetUrl\": \"https://www.surfpayapp.com/hubfs/connect/surfpay_checkout-companion.png\",\n \"type\": \"RECEIPT_BIG\",\n \"assetOpacity\": \"0\",\n \"backgroundColor\": \"#a1a1aa\",\n \"contentTextColor\": \"#78716c\",\n \"endProductUrl\": \"https://www.timestamp-converter.com/\",\n \"endProduct\": \"12345\",\n \"buttonLabel\": \"Click\",\n \"priority\": 1,\n \"idleBigSpot\": true,\n \"receiptBig\": true,\n \"receiptSmall\": true,\n \"endDate\": \"05-05-2027\",\n \"startDate\": \"05-05-2025\"\n}", "options": { "raw": { "language": "json" } } }, "description": "The Create Promotion API enables users to create new marketing promotions by defining attributes such as title, content, schedule, and priority." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"promotionId\": \"ca_QvDucDKihDqNVYpia1_G0\"\n },\n \"message\": \"Promotion Created Successfully\"\n}" } ] }, { "name": "Update Promotion", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions/:promotionId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions", ":promotionId" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "promotionId", "value": "", "description": "promotionId" } ] }, "body": { "mode": "raw", "raw": "{\n \"merchantId\": \"12345\",\n \"title\": \"Summer Sale\",\n \"name\": \"Summer 2024\",\n \"description\": \"Huge discounts on selected items!\",\n \"assetUrl\": \"https://example.com/summer_sale.jpg\",\n \"assetOpacity\": \"0.8\",\n \"backgroundColor\": \"#FFFFFF\",\n \"contentTextColor\": \"#000000\",\n \"endProductUrl\": \"https://example.com/product/123\",\n \"endProduct\": \"123\",\n \"buttonLabel\": \"Shop Now\",\n \"priority\": \"1\",\n \"campaignType\": \"RECEIPT_BIG\",\n \"startDate\": \"06-01-2024\",\n \"endDate\": \"08-31-2024\"\n}", "options": { "raw": { "language": "json" } } }, "description": "The Update Promotion API allows users to modify existing marketing promotions by updating attributes." }, "response": [ { "name": "Update Promotion - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions/:promotionId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions", ":promotionId" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "promotionId", "value": "", "description": "promotionId" } ] }, "body": { "mode": "raw", "raw": "{\n \"merchantId\": \"12345\",\n \"title\": \"Summer Sale\",\n \"name\": \"Summer 2024\",\n \"description\": \"Huge discounts on selected items!\",\n \"assetUrl\": \"https://example.com/summer_sale.jpg\",\n \"assetOpacity\": \"0.8\",\n \"backgroundColor\": \"#FFFFFF\",\n \"contentTextColor\": \"#000000\",\n \"endProductUrl\": \"https://example.com/product/123\",\n \"endProduct\": \"123\",\n \"buttonLabel\": \"Shop Now\",\n \"priority\": \"1\",\n \"campaignType\": \"RECEIPT_BIG\",\n \"startDate\": \"06-01-2024\",\n \"endDate\": \"08-31-2024\"\n}", "options": { "raw": { "language": "json" } } }, "description": "The Update Promotion API allows users to modify existing marketing promotions by updating attributes." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Promotion Updated Successfully\"\n}" } ] }, { "name": "Fetch Promotion by ID", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions/:promotionId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions", ":promotionId" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "promotionId", "value": "", "description": "promotionId" } ] }, "description": "The Fetch Promotion by ID API retrieves detailed information about a specific promotion using its unique promotion ID. " }, "response": [ { "name": "Fetch Promotion by ID - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions/:promotionId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions", ":promotionId" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "promotionId", "value": "", "description": "promotionId" } ] }, "description": "The Fetch Promotion by ID API retrieves detailed information about a specific promotion using its unique promotion ID. " }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"promotionId\": \"ca_UROCd1qJl9RX0tqiK0Ai5\",\n\t\t\"name\": \"Slash sale\",\n\t\t\"title\": \"First Promotion - test\",\n\t\t\"description\": \"Slash sale on all fruits\",\n\t\t\"storeId\": \"82895887ae0b900e0f\",\n\t\t\"assetUrl\": \"https://www.surfpayapp.com/hubfs/connect/surfpay_checkout-companion.png\",\n\t\t\"endProduct\": \"12345\",\n\t\t\"buttonLabel\": \"Click\",\n\t\t\"startDate\": \"2025-05-05T00:00:00.000Z\",\n\t\t\"endDate\": \"2027-05-05T00:00:00.000Z\",\n\t\t\"priority\": \"1\",\n\t\t\"assetOpacity\": \"0\",\n\t\t\"backgroundColor\": \"#a1a1aa\",\n\t\t\"contentTextColor\": \"#78716c\",\n\t\t\"endProductUrl\": \"https://www.timestamp-converter.com/\"\n\t},\n\t\"message\": \"Promotion For The Given Promotion ID Fetched Successfully\"\n}" } ] }, { "name": "Fetch Promotions", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" } ] }, "description": "The Fetch All Promotions API retrieves detailed information about all the camapigns." }, "response": [ { "name": "Fetch Promotions - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" } ] }, "description": "The Fetch All Promotions API retrieves detailed information about all the camapigns." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": [\n\t {\n\t\t\"promotionId\": \"ca_UROCd1qJl9RX0tqiK0Ai5\",\n\t\t\"name\": \"Slash sale\",\n\t\t\"title\": \"First Promotion - test\",\n\t\t\"description\": \"Slash sale on all fruits\",\n\t\t\"storeId\": \"82895887ae0b900e0f\",\n\t\t\"assetUrl\": \"https://www.surfpayapp.com/hubfs/connect/surfpay_checkout-companion.png\",\n\t\t\"endProduct\": \"12345\",\n\t\t\"buttonLabel\": \"Click\",\n\t\t\"startDate\": \"2025-05-05T00:00:00.000Z\",\n\t\t\"endDate\": \"2027-05-05T00:00:00.000Z\",\n\t\t\"priority\": \"1\",\n\t\t\"assetOpacity\": \"0\",\n\t\t\"backgroundColor\": \"#a1a1aa\",\n\t\t\"contentTextColor\": \"#78716c\",\n\t\t\"endProductUrl\": \"https://www.timestamp-converter.com/\"\n\t },\n {\n\t\t\"promotionId\": \"ca_UROCd1qJl9RX0tqiK0Ai5\",\n\t\t\"name\": \"Slash sale\",\n\t\t\"title\": \"First Promotion - test\",\n\t\t\"description\": \"Slash sale on all fruits\",\n\t\t\"storeId\": \"82895887ae0b900e0f\",\n\t\t\"assetUrl\": \"https://www.surfpayapp.com/hubfs/connect/surfpay_checkout-companion.png\",\n\t\t\"endProduct\": \"12345\",\n\t\t\"buttonLabel\": \"Click\",\n\t\t\"startDate\": \"2025-05-05T00:00:00.000Z\",\n\t\t\"endDate\": \"2027-05-05T00:00:00.000Z\",\n\t\t\"priority\": \"1\",\n\t\t\"assetOpacity\": \"0\",\n\t\t\"backgroundColor\": \"#a1a1aa\",\n\t\t\"contentTextColor\": \"#78716c\",\n\t\t\"endProductUrl\": \"https://www.timestamp-converter.com/\"\n\t }\n\t ],\n\t\"message\": \"Promotions fetched successfully\"\n}" } ] }, { "name": "Delete Promotion", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions/:promotionId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions", ":promotionId" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "promotionId", "value": "", "description": "promotionId" } ] }, "description": "The Delete Promotion by ID API allows users to remove a specific promotion by its unique promotion ID. This API permanently deletes the promotion and its associated data, ensuring that it is no longer active or visible." }, "response": [ { "name": "Delete Promotion - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:mId/stores/:sId/promotions/:promotionId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":mId", "stores", ":sId", "promotions", ":promotionId" ], "variable": [ { "key": "mId", "value": "", "description": "mId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "promotionId", "value": "", "description": "promotionId" } ] }, "description": "The Delete Promotion by ID API allows users to remove a specific promotion by its unique promotion ID. This API permanently deletes the promotion and its associated data, ensuring that it is no longer active or visible." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Promotion Deleted Successfully\"\n}" } ] } ] }, { "name": "Receipts API", "description": "Receipts API facilitates the management and retrieval of receipts for finalized transactions.", "item": [ { "name": "Email Receipt", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:id/email", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":id", "email" ], "variable": [ { "key": "id", "value": "", "description": "id" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"integrations@surfboard.se\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to send payment receipts to the required email address." }, "response": [ { "name": "Email Receipt - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:id/email", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":id", "email" ], "variable": [ { "key": "id", "value": "", "description": "id" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"integrations@surfboard.se\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to send payment receipts to the required email address." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Email Sent\"\n}" } ] }, { "name": "Print Receipt", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:id/print", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":id", "print" ], "variable": [ { "key": "id", "value": "", "description": "id" } ] }, "body": { "mode": "raw", "raw": "{\n \"language\": \"sv\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to print receipts from the terminals." }, "response": [ { "name": "Print Receipt - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:id/print", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":id", "print" ], "variable": [ { "key": "id", "value": "", "description": "id" } ] }, "body": { "mode": "raw", "raw": "{\n \"language\": \"sv\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to print receipts from the terminals." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"PNG Receipt printed successfully.\"\n}" } ] }, { "name": "Print ESCPOS Receipt", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:terminalId/escpos", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":terminalId", "escpos" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"escposCommands\":\"G0AbYQEbRQFTdXBlciBNYXJ0CjEyMyBNYWluIFN0ChtFABthAERhdGU6IDIwMjQvMTAvMDgKVGltZTogMTI6MDAgUE0KG0UBLS0tLS0tLS0tLQobRQAbYQBJdGVtIEE6IFdhdGVyClByaWNlOiAkMS4wMApJdGVtIEI6IEJyZWFkClByaWNlOiAkMi4wMAobRQEtLS0tLS0tLS0tClRvdGFsOiAkMy4wMAobRQAbYQFUaGFuayB5b3UhCgoKHVYA\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API helps you print receipts on the terminal through ECS/POS commands." }, "response": [ { "name": "Print ESCPOS Receipt - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:terminalId/escpos", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":terminalId", "escpos" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"escposCommands\":\"G0AbYQEbRQFTdXBlciBNYXJ0CjEyMyBNYWluIFN0ChtFABthAERhdGU6IDIwMjQvMTAvMDgKVGltZTogMTI6MDAgUE0KG0UBLS0tLS0tLS0tLQobRQAbYQBJdGVtIEE6IFdhdGVyClByaWNlOiAkMS4wMApJdGVtIEI6IEJyZWFkClByaWNlOiAkMi4wMAobRQEtLS0tLS0tLS0tClRvdGFsOiAkMy4wMAobRQAbYQFUaGFuayB5b3UhCgoKHVYA\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API helps you print receipts on the terminal through ECS/POS commands." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"ESCPOS Receipt printed successfully.\"\n}" } ] }, { "name": "Add Receipt Information", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "orderId" } ] }, "body": { "mode": "raw", "raw": "{\n \"sequenceNumber\": \"1234567\",\n \"cashRegisterName\": \"Test\",\n \"controlUnitSerialNumber\": \"1234567\",\n \"cashierName\": \"Amanda\",\n \"customerName\": \"Tom\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to store cash register details for receipts." }, "response": [ { "name": "Add Receipt Information - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":orderId" ], "variable": [ { "key": "orderId", "value": "", "description": "orderId" } ] }, "body": { "mode": "raw", "raw": "{\n \"sequenceNumber\": \"1234567\",\n \"cashRegisterName\": \"Test\",\n \"controlUnitSerialNumber\": \"1234567\",\n \"cashierName\": \"Amanda\",\n \"customerName\": \"Tom\"\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to store cash register details for receipts." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Receipt data updated successfully.\"\n}" } ] }, { "name": "Fetch Receipt Link", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:id/link", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":id", "link" ], "variable": [ { "key": "id", "value": "", "description": "id" } ] }, "description": "This API allows you to retrieve a direct URL link to the receipt for a particular transaction." }, "response": [ { "name": "Fetch Receipt Link - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/receipts/:id/link", "host": [ "{{baseUrl}}" ], "path": [ "receipts", ":id", "link" ], "variable": [ { "key": "id", "value": "", "description": "id" } ] }, "description": "This API allows you to retrieve a direct URL link to the receipt for a particular transaction." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"receiptURL\": \"https://surfreceipts.com/831895dac6d240060b\"\n },\n \"message\": \"Receipt URL fetched successfully.\"\n}" } ] } ] }, { "name": "Reporting APIs", "description": "Reporting APIs enable merchants to generate actionable reports about various aspects of their business. Through these APIs you gain access to precise data, enabling you to track revenue, monitor transaction volume, identify fraud, reconcile financial records, and make informed decisions for your business.", "item": [ { "name": "Fetch Settlement Reports", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/reports", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "reports" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves the list of settlement reports for a merchant. Use this API to get a summary of the merchant’s settled transactions within a specific time frame, which can be daily or monthly depending on the report type opted for the merchant.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch Settlement Reports - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/reports", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "reports" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves the list of settlement reports for a merchant. Use this API to get a summary of the merchant’s settled transactions within a specific time frame, which can be daily or monthly depending on the report type opted for the merchant.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"payoutId\": \"Q6z2e0goIOE4DXD0VYiT\",\n \"merchantId\": \"8149bdef0a2300090e\",\n \"transactionStartDate\": \"2023-08-07\",\n \"transactionEndDate\": \"2023-08-07\",\n \"settlementDate\": \"2023-08-08\",\n \"reportType\": \"DAILY\",\n \"url\": \"https://reports.surfboardpayments.com/settlementReport1.pdf\",\n \"totalSale\": 10000,\n \"totalRefund\": 100,\n \"fee\": 200,\n \"payout\": 9700\n },\n {\n \"payoutId\": \"Q6z2e0goIOE4DXD0VYiT\",\n \"merchantId\": \"8149bdef0a2300090e\",\n \"transactionStartDate\": \"2023-08-07\",\n \"transactionEndDate\": \"2023-08-07\",\n \"settlementDate\": \"2023-08-08\",\n \"reportType\": \"DAILY\",\n \"url\": \"https://reports.surfboardpayments.com/settlementReport2.pdf\",\n \"totalSale\": 10000,\n \"totalRefund\": 100,\n \"fee\": 200,\n \"payout\": 9700\n }\n ],\n \"message\": \"Settlement reports fetched successfully\"\n}" } ] } ] }, { "name": "Service Providers API", "description": "The Service Providers API allows partners to manage service provider applications, onboarding, and retrieve service provider information.", "item": [ { "name": "Create Service Provider", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/service-providers", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "service-providers" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"country\": \"SE\",\n \"organisation\": {\n \"corporateId\": \"3532007322\"\n },\n \"controlFields\": {\n \"isServiceProvider\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows partners to create a new service provider application with company information and control fields." }, "response": [ { "name": "Create Service Provider - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/service-providers", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "service-providers" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "body": { "mode": "raw", "raw": "{\n \"country\": \"SE\",\n \"organisation\": {\n \"corporateId\": \"3532007322\"\n },\n \"controlFields\": {\n \"isServiceProvider\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows partners to create a new service provider application with company information and control fields." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"applicationId\": \"838ca3a7c530200810\",\n \"webKybUrl\": \"https://web-kyb-dev.web.app/838ca3a7c530200810?pi=QGv2Kgu9q0WAdg6FjkK0iEliyh8l61yxIXnaf0M70l4psKXW_6KihWL4wcY2aL0NfI5aM69J7bYUisZ8ecrFTNMrj4KU1ZjrN5Q3O9hcqlEgc6oQACb2eLM7SwwP0006\"\n },\n \"message\": \"Merchant application created successfully.\"\n}" } ] }, { "name": "Fetch Service Provider for Partner", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/service-providers", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "service-providers" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "This API allows partners to retrieve all service providers associated with their partner account." }, "response": [ { "name": "Fetch Service Provider for Partner - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/service-providers", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "service-providers" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ] }, "description": "This API allows partners to retrieve all service providers associated with their partner account." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"serviceProviders\": [\n {\n \"serviceProviderId\": \"8385f437bc6d200b50\",\n \"personId\": null,\n \"corporateId\": \"5000008202\",\n \"nationalId\": null,\n \"serviceType\": null,\n \"name\": null,\n \"address\": {\n \"addressLine1\": \"Pacocha - Hand\",\n \"city\": \"Denesik Brook\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"61050\"\n },\n \"phoneNumber\": {\n \"number\": \"701208734\",\n \"code\": \"46\",\n \"role\": null\n },\n \"email\": \"harish@surfboard.se\"\n }\n ]\n },\n \"message\": \"Service providers fetched successfully.\"\n}" } ] }, { "name": "Fetch Service Provider for Merchant", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/service-providers", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "service-providers" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "This API allows merchants to retrieve all service providers associated with their merchant account." }, "response": [ { "name": "Fetch Service Provider for Merchant - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/service-providers", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "service-providers" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "This API allows merchants to retrieve all service providers associated with their merchant account." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"serviceProviders\": [\n {\n \"serviceProviderId\": \"8385f437bc6d200b50\",\n \"personId\": null,\n \"corporateId\": \"5000008202\",\n \"nationalId\": null,\n \"serviceType\": null,\n \"name\": null,\n \"address\": {\n \"addressLine1\": \"Pacocha - Hand\",\n \"city\": \"Denesik Brook\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"61050\"\n },\n \"phoneNumber\": {\n \"number\": \"701208734\",\n \"code\": \"46\",\n \"role\": null\n },\n \"email\": \"harish@surfboard.se\"\n }\n ]\n },\n \"message\": \"Service providers fetched successfully for merchant.\"\n}" } ] }, { "name": "Get All Service Provider Applications", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/service-providers/applications", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "service-providers", "applications" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ], "query": [ { "key": "applicationType", "value": "", "description": "Filter applications by type. Supported values are 'ONBOARDING' and 'RENEWAL'. Can be a single value or comma-separated values like 'ONBOARDING,RENEWAL'. If not provided, defaults to fetching ONBOARDING applications.", "disabled": true } ] }, "description": "This API allows partners to retrieve all service provider applications with optional filtering by application type. Supported application types are ONBOARDING and RENEWAL." }, "response": [ { "name": "Get All Service Provider Applications - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/service-providers/applications", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "service-providers", "applications" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" } ], "query": [ { "key": "applicationType", "value": "", "description": "Filter applications by type. Supported values are 'ONBOARDING' and 'RENEWAL'. Can be a single value or comma-separated values like 'ONBOARDING,RENEWAL'. If not provided, defaults to fetching ONBOARDING applications.", "disabled": true } ] }, "description": "This API allows partners to retrieve all service provider applications with optional filtering by application type. Supported application types are ONBOARDING and RENEWAL." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"applicationId\": \"838ca3a7c530200810\",\n \"country\": \"SE\",\n \"corporateId\": \"3532007322\",\n \"applicationStatus\": \"APPLICATION_INITIATED\",\n \"createdAt\": \"2025-10-10T10:32:47.565Z\",\n \"lastUpdatedAt\": \"2025-10-10T10:32:47.565Z\",\n \"webKybUrl\": \"https://web-kyb-dev.web.app/838ca3a7c530200810?pi=QGv2Kgu9q0WAdg6FjkK0iEliyh8l61yxIXnaf0M70l4psKXW_6KihWL4wcY2aL0NfI5aM69J7bYUisZ8ecrFTNMrj4KU1ZjrN5Q3O9hcqlEgc6oQACb2eLM7SwwP0006\",\n \"legalName\": \"Turner, Runte and Kemmer\"\n },\n {\n \"applicationId\": \"838ca332c530200310\",\n \"country\": \"SE\",\n \"corporateId\": \"5834862013\",\n \"applicationStatus\": \"APPLICATION_STARTED\",\n \"createdAt\": \"2025-10-10T10:28:53.740Z\",\n \"lastUpdatedAt\": \"2025-10-10T10:39:34.614Z\",\n \"webKybUrl\": \"https://web-kyb-dev.web.app/838ca332c530200310?pi=rZzanQBc-0lZgNKHpPE0_ou4KDDcH1nXxKDuqS07IdTnTOQ-k62W--U2uyB21T2-ipMtS6E7iA6LLMb8T52FYHGd54jZX9nOdzM1YA9qNlZgT3n8_AZTcyC3ljNm0002\",\n \"legalName\": \"LOCO SP OBERBRUNNER LLC\"\n }\n ],\n \"message\": \"Applications of partner fetched successfully with partnerId: 8113d3f8403b380409.\"\n}" } ] }, { "name": "Fetch Service Provider Application Status", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/service-providers/applications/:applicationId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "service-providers", "applications", ":applicationId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "applicationId", "value": "", "description": "applicationId" } ] }, "description": "This API allows partners to retrieve the status of a specific service provider application by its ID." }, "response": [ { "name": "Fetch Service Provider Application Status - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/service-providers/applications/:applicationId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "service-providers", "applications", ":applicationId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "applicationId", "value": "", "description": "applicationId" } ] }, "description": "This API allows partners to retrieve the status of a specific service provider application by its ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"onboardingStatus\": null,\n \"applicationStatus\": \"APPLICATION_INITIATED\",\n \"serviceProviderId\": null\n },\n \"message\": \"Service provider application status fetched successfully\"\n}" } ] } ] }, { "name": "Stores API", "description": "Stores represent the physical or virtual location of sales. Stores have to be created for each merchant before they can register terminals to accept payments. Onboarded merchants can have one or more stores created under them based on their business requirements.", "item": [ { "name": "Create Store", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeName\": \"Trial Store\",\n \"email\": \"TS@gmail.com\",\n \"phoneNumber\": {\n \"code\": 91,\n \"number\": \"3214576980\"\n },\n \"address\": \"10,\",\n \"city\": \"Stockholm\",\n \"zipCode\": \"103 16\",\n \"country\": \"SE\",\n \"onlineInfo\": {\n \"merchantWebshopURL\": \"https://testmerchantportal.com/home\",\n \"paymentPageHostURL\": \"https://testmerchantportal.com/payment\",\n \"termsAndConditionsURL\": \"https://testmerchantportal.com/terms\",\n \"privacyPolicyURL\": \"https://testmerchantportal.com/privacy\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a store under a merchant. Use this API to create a store to which you can register your terminals. You can create a single store or multiple stores under a merchant based on your requirements." }, "response": [ { "name": "Create Store - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeName\": \"Trial Store\",\n \"email\": \"TS@gmail.com\",\n \"phoneNumber\": {\n \"code\": 91,\n \"number\": \"3214576980\"\n },\n \"address\": \"10,\",\n \"city\": \"Stockholm\",\n \"zipCode\": \"103 16\",\n \"country\": \"SE\",\n \"onlineInfo\": {\n \"merchantWebshopURL\": \"https://testmerchantportal.com/home\",\n \"paymentPageHostURL\": \"https://testmerchantportal.com/payment\",\n \"termsAndConditionsURL\": \"https://testmerchantportal.com/terms\",\n \"privacyPolicyURL\": \"https://testmerchantportal.com/privacy\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a store under a merchant. Use this API to create a store to which you can register your terminals. You can create a single store or multiple stores under a merchant based on your requirements." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"storeId\": \"81d64e7174dcb00b0f\",\n\t\t\"merchantId\": \"818712cdbcb670070e\",\n\t\t\"name\": \"Trial Store\",\n\t\t\"address\": {\n\t\t\t\t\"addressLine1\":\"10\",\n\t\t\t\t\"addressLine2\":null ,\n\t\t\t\t\"addressLine3\":null ,\n\t\t\t\t\"city\": \"Stockholm\",\n\t\t\t\t\"countryCode\": \"SE\",\n\t\t\t\t\"postalCode\": \"103 16\"\n\t\t},\n\t\t\"phone\": \"3214576980\",\n\t\t\"email\": \"TS@gmail.com\",\n\t\t\"merchantUrlDomainVerificationKey\": \"499470649f03b53fa1175659d4389743974710260b7f410313487e6062b3d559\",\n\t \"paymentPageUrlDomainVerificationKey\": \"2179beab4f5e8c3960615205f042939a2ccc6c51a6e5923c9c068b3d9a645590\"\n\t},\n\t\"message\": \"Store Created Successfully\"\n}" } ] }, { "name": "Deactivate a Store", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Deactivates a store. Use this API to deactivate any store under a merchant. You can delete a store instantly or schedule it to be deleted at a later date. Stores can be deleted only if there are no terminals registered to it. If a store has terminals registered to it, you will have to delink the terminal from the store or change the terminal to another store under the same merchant." }, "response": [ { "name": "Deactivate a Store - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Deactivates a store. Use this API to deactivate any store under a merchant. You can delete a store instantly or schedule it to be deleted at a later date. Stores can be deleted only if there are no terminals registered to it. If a store has terminals registered to it, you will have to delink the terminal from the store or change the terminal to another store under the same merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Store deactivation initiated successfully\"\n}" } ] }, { "name": "Fetch Store Details", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Retrieves information for a specific store. Use this API to get information regarding a particular store created under a merchant." }, "response": [ { "name": "Fetch Store Details - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Retrieves information for a specific store. Use this API to get information regarding a particular store created under a merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"storeId\": \"824bd4a739dc200b0f\",\n \"merchantId\": \"81a641f8b3cfd0070e\",\n \"name\": \"TEST\",\n \"status\": \"ACTIVE\",\n \"onlineOnboardingStatus\": \"APPROVED\",\n \"address\": {\n \"careOf\": null,\n \"addressLine1\": \"Main Street 123\",\n \"addressLine2\": \"6th lane\",\n \"addressLine3\": \"Building C\",\n \"city\": \"Stockolm\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"103 16\"\n },\n \"onlineInfo\": {\n \"merchantWebshopURL\": \"https://testmerchant.com\",\n \"termsAndConditionsURL\": \"https://www.termsandconditions.com\",\n \"privacyPolicyURL\": \"https://www.privacypolicy.com\"\n },\n \"phone\": \"+46 23423423\",\n \"email\": \"test@gmail.com\"\n },\n \"message\": \"Fetched store by ID\"\n}" } ] }, { "name": "Update Store Details", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeName\": \"My Updated Store Name\",\n \"email\": \"updated.store@example.com\",\n \"phoneNumber\": {\n \"code\": 1,\n \"number\": \"5551234567\"\n },\n \"address\": \"123 Updated Main St\",\n \"careOf\": \"John Doe\",\n \"city\": \"Updated City\",\n \"onlineInfo\": {\n \"merchantWebshopURL\": \"https://www.example.com\",\n \"paymentPageHostURL\": \"https://payment.example.com\",\n \"termsAndConditionsURL\": \"https://www.example.com/terms\",\n \"privacyPolicyURL\": \"https://www.example.com/privacy\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the store details. You can use this API to edit the name, address information, email address, and phone number of a store." }, "response": [ { "name": "Update Store Details - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"storeName\": \"My Updated Store Name\",\n \"email\": \"updated.store@example.com\",\n \"phoneNumber\": {\n \"code\": 1,\n \"number\": \"5551234567\"\n },\n \"address\": \"123 Updated Main St\",\n \"careOf\": \"John Doe\",\n \"city\": \"Updated City\",\n \"onlineInfo\": {\n \"merchantWebshopURL\": \"https://www.example.com\",\n \"paymentPageHostURL\": \"https://payment.example.com\",\n \"termsAndConditionsURL\": \"https://www.example.com/terms\",\n \"privacyPolicyURL\": \"https://www.example.com/privacy\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the store details. You can use this API to edit the name, address information, email address, and phone number of a store." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\":{\n \"merchantUrlDomainVerificationKey\": \"499470649f03b53fa1175659d4389743974710260b7f410313487e6062b3d559\",\n \"paymentPageUrlDomainVerificationKey\": \"2179beab4f5e8c3960615205f042939a2ccc6c51a6e5923c9c068b3d9a645590\"\n },\n \"message\": \"Store data updated successfully\"\n}" } ] }, { "name": "Fetch All Store Terminals", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ], "query": [ { "key": "terminalType", "value": "", "description": "Optional query param to filter terminals by terminal type. Valid values: `surfpad`, `surftouch`, `surfprint`, `checkoutPro`, `checkoutX`, `PaymentPage`, `SelfHostedPage`, `MerchantInitiated`, `printer`, `surftester`.", "disabled": true } ] }, "description": "Retrieves a list of all terminals associated with a specific store. You can use this API to get information regarding all the terminals registered under a store.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch All Store Terminals - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ], "query": [ { "key": "terminalType", "value": "", "description": "Optional query param to filter terminals by terminal type. Valid values: `surfpad`, `surftouch`, `surfprint`, `checkoutPro`, `checkoutX`, `PaymentPage`, `SelfHostedPage`, `MerchantInitiated`, `printer`, `surftester`.", "disabled": true } ] }, "description": "Retrieves a list of all terminals associated with a specific store. You can use this API to get information regarding all the terminals registered under a store.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"terminalId\": \"81ff0cea07e4300105\",\n \"softwareVersion\": \"1.5.3\",\n \"osType\": \"android\",\n \"osVersion\": \"1.0.0.0\",\n \"deviceVendor\": \"Samsung\",\n \"deviceModel\": \"Galaxy N10\",\n \"serialNo\": null,\n \"storeId\": \"81fd3113680e60030f\",\n \"linkedTerminalId\": null,\n \"terminalStatus\": \"ACTIVE\",\n \"startDate\": \"2024-02-15T06:46:44.046Z\",\n \"terminalPaymentMethods\": [\n \"SWISH\",\n \"CASH\",\n \"SVEA_SWISH\"\n ],\n \"terminalName\": \"surf-touch\",\n \"terminalType\": \"unknown\",\n \"batteryPercentage\": null,\n \"powerSource\": null,\n \"deviceNetwork\": null,\n \"turnOnTime\": null,\n \"terminalCurrencyCode\": \"NA\"\n },\n {\n \"terminalId\": \"81ff0ff487e4300b04\",\n \"softwareVersion\": \"4.0.12.0\",\n \"osType\": \"pinpad\",\n \"osVersion\": \"2.0.0.0\",\n \"deviceVendor\": \"Datecs\",\n \"deviceModel\": \"Datecs Bluepad 55\",\n \"serialNo\": \"4299989999\",\n \"storeId\": \"81fd3113680e60030f\",\n \"linkedTerminalId\": null,\n \"terminalStatus\": \"REGISTERED\",\n \"startDate\": \"2024-02-15T07:12:41.658Z\",\n \"terminalPaymentMethods\": [\n \"CARD\"\n ],\n \"terminalName\": null,\n \"terminalType\": \"surfpad\",\n \"batteryPercentage\": null,\n \"powerSource\": null,\n \"deviceNetwork\": null,\n \"turnOnTime\": null,\n \"terminalCurrencyCode\": \"NA\"\n }\n ],\n \"message\": \"Terminal records fetched successfully\"\n}" } ] }, { "name": "Fetch Stores", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves a list of all stores associated with a specific merchant. You can use this API to get information regarding all the stores created under a particular merchant.\n\n\n**Supports Pagination**" }, "response": [ { "name": "Fetch Stores - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves a list of all stores associated with a specific merchant. You can use this API to get information regarding all the stores created under a particular merchant.\n\n\n**Supports Pagination**" }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"storeId\": \"824bd4a739dc200b0f\",\n \"merchantId\": \"81fa6b2d8d5dc8040e\",\n \"name\": \"Previous Store\",\n \"address\": {\n \"addressLine1\": \"No:3,10th street\",\n \"city\": \"København\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"576462\"\n },\n \"phone\": \"12345678\",\n \"email\": \"PS@gmail.com\",\n \"onlineInfo\": {\n \"merchantWebshopURL\": \"https://testmerchantportal.com/home\",\n \"paymentPageHostURL\": \"https://testmerchantportal.com/payment\",\n \"termsAndConditionsURL\": \"https://testmerchantportal.com/terms\",\n \"privacyPolicyURL\": \"https://testmerchantportal.com/privacy\"\n }\n },\n {\n \"storeId\": \"st_p5Hprp71IKuPGOCqkZSt5\",\n \"merchantId\": \"81fa6b2d8d5dc8040e\",\n \"name\": \"New Store\",\n \"address\": {\n \"addressLine1\": \"No:3,10th street\",\n \"city\": \"København\",\n \"countryCode\": \"SE\",\n \"postalCode\": \"576462\"\n },\n \"phone\": \"4775866734\",\n \"email\": \"NS@gmail.com\",\n \"onlineInfo\": {\n \"merchantWebshopURL\": \"https://testmerchantportal.com/home\",\n \"paymentPageHostURL\": \"https://testmerchantportal.com/payment\",\n \"termsAndConditionsURL\": \"https://testmerchantportal.com/terms\",\n \"privacyPolicyURL\": \"https://testmerchantportal.com/privacy\"\n }\n }\n ],\n \"message\": \"Fetched stores successfully\"\n}" } ] }, { "name": "Verify Store Domain", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId/verify", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId", "verify" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"domainType\": \"MERCHANT_WEBSHOP_URL\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to trigger a verify domain request with Surfboard." }, "response": [ { "name": "Verify Store Domain - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId/verify", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId", "verify" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"domainType\": \"MERCHANT_WEBSHOP_URL\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to trigger a verify domain request with Surfboard." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Domain verification done successfully for store: 8254c42dc430e00e0f.\"\n}" } ] }, { "name": "Fetch Store Domains", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId/online", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId", "online" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "This API retrieves the details of the store's domain." }, "response": [ { "name": "Fetch Store Domains - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/merchants/:merchantId/stores/:storeId/online", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "merchants", ":merchantId", "stores", ":storeId", "online" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "This API retrieves the details of the store's domain." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"onlineStoreStatus\": \"APPROVED\",\n \"domains\": [\n {\n \"status\": \"ACTIVE\",\n \"type\": \"PAYMENT_PAGE_HOST_URL\",\n \"name\": \"www.surfpayapp.com\",\n \"verificationKey\": \"7fd242dd862a9f9f74ae11d62216f5729a5e5600e00b8d44300db41b4efcce68\",\n \"isDomainVerified\": true\n },\n {\n \"status\": \"ACTIVE\",\n \"type\": \"MERCHANT_WEBSHOP_URL\",\n \"name\": \"test.surfboard.se\",\n \"verificationKey\": \"7fd242dd862a9f9f74ae11d62216f5729a5e5600e00b8d44300db41b4efcce68\",\n \"isDomainVerified\": true\n }\n ]\n },\n \"message\": \"Online store domain details fetched successfully.\"\n}" } ] } ] }, { "name": "Templates API", "description": "The POS Template API allows you to customize and manage the content displayed on your POS screen.", "item": [ { "name": "Create Template", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/templates", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "templates" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"paymentMethodOrder\": [\"SWISH\"],\n \"name\": \"SurfboardString\",\n \"productsPerPage\": 10,\n \"autoSet\": [\n {\n \"start\": \"06:00\",\n \"end\": \"09:00\"\n },\n {\n \"start\": \"11:00\",\n \"end\": \"18:00\"\n }\n ],\n \"product\": [\n {\n \"category\": \"electronics\",\n \"productOrder\": [\"82674cfdf77f500001\", \"82674cfdf77f500001\"]\n }\n ],\n \"terminal\": {\n \"primaryTerminal\": \"82674beadf0f700405\",\n \"terminalOrder\": [\"82674beadf0f700405\"]\n },\n \"metaData\": {\n \"we\": \"do\",\n \"do\": \"we\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to create a new POS template." }, "response": [ { "name": "Create Template - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/templates", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "templates" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"paymentMethodOrder\": [\"SWISH\"],\n \"name\": \"SurfboardString\",\n \"productsPerPage\": 10,\n \"autoSet\": [\n {\n \"start\": \"06:00\",\n \"end\": \"09:00\"\n },\n {\n \"start\": \"11:00\",\n \"end\": \"18:00\"\n }\n ],\n \"product\": [\n {\n \"category\": \"electronics\",\n \"productOrder\": [\"82674cfdf77f500001\", \"82674cfdf77f500001\"]\n }\n ],\n \"terminal\": {\n \"primaryTerminal\": \"82674beadf0f700405\",\n \"terminalOrder\": [\"82674beadf0f700405\"]\n },\n \"metaData\": {\n \"we\": \"do\",\n \"do\": \"we\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to create a new POS template." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"templateId\": \"8271dfa5782e380148\"\n },\n \"message\": \"Pos-Template Created Successfully\"\n}" } ] }, { "name": "Update Template", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:sId/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":sId", "templates", ":templateId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "templateId", "value": "", "description": "templateId" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale Template\",\n \"productsPerPage\": 12,\n \"paymentMethodOrder\": [\"cash\", \"credit_card\", \"mobile_payment\"],\n \"product\": [\n {\n \"category\": \"Beverages\",\n \"productOrder\": [\"prod123\", \"prod456\", \"prod789\"]\n },\n {\n \"category\": \"Snacks\",\n \"productOrder\": [\"prod987\", \"prod654\", \"prod321\"]\n }\n ],\n \"autoSet\": [\n {\n \"start\": \"09:00\",\n \"end\": \"12:00\"\n },\n {\n \"start\": \"14:00\",\n \"end\": \"17:00\"\n }\n ],\n \"terminal\": {\n \"primaryTerminal\": \"terminal_alpha\",\n \"secondaryTerminal\": \"terminal_beta\",\n \"terminalOrder\": [\"terminal_alpha\", \"terminal_beta\", \"terminal_gamma\"]\n },\n \"metaData\": {\n \"theme\": \"light\",\n \"location\": \"front\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to update an existing POS template." }, "response": [ { "name": "Update Template - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:sId/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":sId", "templates", ":templateId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "templateId", "value": "", "description": "templateId" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Summer Sale Template\",\n \"productsPerPage\": 12,\n \"paymentMethodOrder\": [\"cash\", \"credit_card\", \"mobile_payment\"],\n \"product\": [\n {\n \"category\": \"Beverages\",\n \"productOrder\": [\"prod123\", \"prod456\", \"prod789\"]\n },\n {\n \"category\": \"Snacks\",\n \"productOrder\": [\"prod987\", \"prod654\", \"prod321\"]\n }\n ],\n \"autoSet\": [\n {\n \"start\": \"09:00\",\n \"end\": \"12:00\"\n },\n {\n \"start\": \"14:00\",\n \"end\": \"17:00\"\n }\n ],\n \"terminal\": {\n \"primaryTerminal\": \"terminal_alpha\",\n \"secondaryTerminal\": \"terminal_beta\",\n \"terminalOrder\": [\"terminal_alpha\", \"terminal_beta\", \"terminal_gamma\"]\n },\n \"metaData\": {\n \"theme\": \"light\",\n \"location\": \"front\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "This API allows you to update an existing POS template." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Pos-Template updated Successfully for template id 8269d8d131d1100848\"\n}" } ] }, { "name": "Fetch Template by ID", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:sId/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":sId", "templates", ":templateId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "templateId", "value": "", "description": "templateId" } ] }, "description": "This API retrieves the details of a specific POS template using its ID." }, "response": [ { "name": "Fetch Template by ID - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:sId/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":sId", "templates", ":templateId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "templateId", "value": "", "description": "templateId" } ] }, "description": "This API retrieves the details of a specific POS template using its ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"templateId\": \"8267defa6150700b48\",\n\t\t\"userId\": \"u_EArLulLMogC6b-9e9Gci0\",\n\t\t\"name\": \"SurfboardString\",\n\t\t\"terminalOrder\": {\n\t\t\t\"terminalOrder\": [\n\t\t\t\t\"82674beadf0f700405\"\n\t\t\t],\n\t\t\t\"primaryTerminal\": \"82674beadf0f700405\",\n\t\t\t\"secondaryTerminal\": null\n\t\t},\n\t\t\"categoryOrder\": null,\n\t\t\"productOrder\": [\n\t\t\t{\n\t\t\t\t\"category\": \"electronics\",\n\t\t\t\t\"productOrder\": [\n\t\t\t\t\t\"82674cfdf77f500001\",\n\t\t\t\t\t\"82674cfdf77f500001\"\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\t\"paymentMethodOrder\": [\n\t\t\t\"SWISH\"\n\t\t],\n\t\t\"autoSet\": [\n\t\t\t{\n\t\t\t\t\"start\": \"06:00\",\n\t\t\t\t\"end\": \"09:00\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"start\": \"11:00\",\n\t\t\t\t\"end\": \"18:00\"\n\t\t\t}\n\t\t],\n\t\t\"deleted\": false,\n\t\t\"metadata\": {\n\t\t\t\"we\": \"do\",\n\t\t\t\"do\": \"we\"\n\t\t}\n\t},\n\t\"message\": \"Template Data fetched successfully for the template id [8267defa6150700b48]\"\n}" } ] }, { "name": "Fetch Templates", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:sId/templates", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":sId", "templates" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "sId", "value": "", "description": "sId" } ] }, "description": "This API retrieves all the POS templates created under the user." }, "response": [ { "name": "Fetch Templates - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:sId/templates", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":sId", "templates" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "sId", "value": "", "description": "sId" } ] }, "description": "This API retrieves all the POS templates created under the user." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"templateId\": \"826dcc0b62e0100248\",\n \"userId\": \"u_EArLulLMogC6b-9e9Gci0\",\n \"name\": \"SurfboardString\",\n \"terminalOrder\": {\n \"terminalOrder\": [\n \"82674beadf0f700405\"\n ],\n \"primaryTerminal\": \"82674beadf0f700405\",\n \"secondaryTerminal\": null\n },\n \"categoryOrder\": null,\n \"productOrder\": [\n {\n \"category\": \"electronics\",\n \"productOrder\": [\n \"82674cfdf77f500001\",\n \"82674cfdf77f500001\"\n ]\n }\n ],\n \"paymentMethodOrder\": [\n \"SWISH\"\n ],\n \"autoSet\": [\n {\n \"start\": \"06:00\",\n \"end\": \"09:00\"\n },\n {\n \"start\": \"11:00\",\n \"end\": \"18:00\"\n }\n ],\n \"deleted\": false\n }\n ],\n \"message\": \"Template Data fetched successfully for the user id [u_EArLulLMogC6b-9e9Gci0]\"\n}" } ] }, { "name": "Delete Template by ID", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:sId/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":sId", "templates", ":templateId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "templateId", "value": "", "description": "templateId" } ] }, "description": "Use this API to delete an existing template by Template ID." }, "response": [ { "name": "Delete Template by ID - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:sId/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":sId", "templates", ":templateId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "sId", "value": "", "description": "sId" }, { "key": "templateId", "value": "", "description": "templateId" } ] }, "description": "Use this API to delete an existing template by Template ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Template id [8271dfa5782e380148] deleted successfully\"\n}" } ] } ] }, { "name": "Terminals API", "description": "Surfboard offers a diverse range of hardware terminals along with the SoftPOS terminal that can be integrated with your existing ECRs and checkout systems. The Terminals API allows you to register and manage these terminals. For CheckoutPro integration, you can use the Terminals APIs to link the terminal to your CheckoutPro, check the linkage status, and delink the terminal from your CheckoutPro.", "item": [ { "name": "Register Device", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/devices", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "devices" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"registrationIdentifier\":\"250901\",\n \"terminalName\":\"Kiosk One\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Registers a new terminal to store. For SDK-based workflows, this API call is unnecessary as SDK methods covers terminal registration. After the terminal is registered to a store under the merchant, it cannot be repurposed to be used by another merchant. However, you can use the Change Store API to transfer the terminal to another store under the same merchant." }, "response": [ { "name": "Register Device - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/devices", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "devices" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"registrationIdentifier\":\"250901\",\n \"terminalName\":\"Kiosk One\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Registers a new terminal to store. For SDK-based workflows, this API call is unnecessary as SDK methods covers terminal registration. After the terminal is registered to a store under the merchant, it cannot be repurposed to be used by another merchant. However, you can use the Change Store API to transfer the terminal to another store under the same merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"terminalId\": \"813ca2cb12ce400405\",\n \"registrationStatus\": \"REGISTERED\"\n },\n \"message\": \"Terminal registered successfully\"\n}" } ] }, { "name": "Get Device Registration Code", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/device-registration", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "device-registration" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "This API generates a registration code and link that can be used to register devices to the store. The registration code can be entered manually on the device, or the registration link can be used for automatic registration via a QR code." }, "response": [ { "name": "Get Device Registration Code - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/device-registration", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "device-registration" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "This API generates a registration code and link that can be used to register devices to the store. The registration code can be entered manually on the device, or the registration link can be used for automatic registration via a QR code." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"registrationCode\": \"905788\",\n \"registrationLink\": \"checkoutx://com.surfboard.checkoutx/register?data=eyJyZWdpc3RyYXRpb25Db2RlIjoiOTA1Nzg4In0=\"\n },\n \"message\": \"Registration Code Generated Successfully\"\n}" } ] }, { "name": "Register Online Terminal", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/online-terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "online-terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"onlineTerminalMode\": \"PaymentPage\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Register a terminal with an online store to start accepting online payments using this API." }, "response": [ { "name": "Register Online Terminal - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/online-terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "online-terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"onlineTerminalMode\": \"PaymentPage\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Register a terminal with an online store to start accepting online payments using this API." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"terminalId\": \"813ca2cb12ce400405\"\n },\n \"message\": \"Terminal registered successfully\"\n}" } ] }, { "name": "Delink Terminal from Store", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "terminals", "deactivate" ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\": \"c_Ou8mzoVQVn6dS4hvNtKH2\",\n \"storeId\": \"st_GZVDbwmS86_G9pwc669U2\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Delinks the terminal from its registered store. Use this API to remove a terminal from its registered store. You cannot use this delinked terminal for another merchant. However, if you want to use this terminal in another store created under the same merchant, you can use the Change Store API." }, "response": [ { "name": "Delink Terminal from Store - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "terminals", "deactivate" ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\": \"c_Ou8mzoVQVn6dS4hvNtKH2\",\n \"storeId\": \"st_GZVDbwmS86_G9pwc669U2\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Delinks the terminal from its registered store. Use this API to remove a terminal from its registered store. You cannot use this delinked terminal for another merchant. However, if you want to use this terminal in another store created under the same merchant, you can use the Change Store API." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Terminal removed from store\"\n}" } ] }, { "name": "Change Store", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/change", "host": [ "{{baseUrl}}" ], "path": [ "terminals", "change" ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\":\"c_Ou8mzoVQVn6dS4hvNtKH2\",\n \"storeId\":\"st_GZVDbwmS86_G9pwc669U2\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Changes the store to which the terminal is registered. You can use this API to utilize the terminal in another store created under the same merchant. However, the Terminal ID remains unchanged." }, "response": [ { "name": "Change Store - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/change", "host": [ "{{baseUrl}}" ], "path": [ "terminals", "change" ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\":\"c_Ou8mzoVQVn6dS4hvNtKH2\",\n \"storeId\":\"st_GZVDbwmS86_G9pwc669U2\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Changes the store to which the terminal is registered. You can use this API to utilize the terminal in another store created under the same merchant. However, the Terminal ID remains unchanged." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Store successfully changed for the terminal\"\n}" } ] }, { "name": "Link Terminal", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/link", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "link" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\": \"814aae4268e6700704\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Links the terminal to the CheckoutPro. You can use this API to link the terminal to a CheckoutPro integration to accept payments." }, "response": [ { "name": "Link Terminal - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/link", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "link" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"terminal$id\": \"814aae4268e6700704\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Links the terminal to the CheckoutPro. You can use this API to link the terminal to a CheckoutPro integration to accept payments." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Terminal linked successfully\"\n}" } ] }, { "name": "Delink Terminal", "request": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/link", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "link" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Delinks the terminal from its linked CheckoutPro. Use this API to swap the terminal between different Checkouts or vice-versa." }, "response": [ { "name": "Delink Terminal - Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/link", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "link" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Delinks the terminal from its linked CheckoutPro. Use this API to swap the terminal between different Checkouts or vice-versa." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Terminal delinked successfully\"\n}" } ] }, { "name": "Check Link Status", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/link", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "link" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Retrieves the linkage status between the terminal and CheckoutPro. Use this API to obtain the current link state between the terminal and CheckoutPro." }, "response": [ { "name": "Check Link Status - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/link", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "link" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Retrieves the linkage status between the terminal and CheckoutPro. Use this API to obtain the current link state between the terminal and CheckoutPro." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"linkageStatus\": \"LINKED\"\n },\n \"message\": \"Terminal Linkage Status fetched Successfully\"\n}" } ] }, { "name": "Update Terminal Name", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"terminalName\": \"New Terminal\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update terminal name of a registered terminal using this call." }, "response": [ { "name": "Update Terminal Name - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"terminalName\": \"New Terminal\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update terminal name of a registered terminal using this call." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Terminal name updated successfully\"\n}" } ] }, { "name": "Move Terminal", "request": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/terminals/:terminalSerialNo/move", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "terminals", ":terminalSerialNo", "move" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "terminalSerialNo", "value": "", "description": "terminalSerialNo" } ] }, "body": { "mode": "raw", "raw": "{\n \"targetMerchantId\":\"81fa6b2d8d5dc8040e\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to reassign a hardware terminal to another merchant. This is limited to partners who handle their own storage and deal with terminals in bulk." }, "response": [ { "name": "Move Terminal - Success", "originalRequest": { "method": "PUT", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/partners/:partnerId/terminals/:terminalSerialNo/move", "host": [ "{{baseUrl}}" ], "path": [ "partners", ":partnerId", "terminals", ":terminalSerialNo", "move" ], "variable": [ { "key": "partnerId", "value": "{{partnerId}}", "description": "partnerId" }, { "key": "terminalSerialNo", "value": "", "description": "terminalSerialNo" } ] }, "body": { "mode": "raw", "raw": "{\n \"targetMerchantId\":\"81fa6b2d8d5dc8040e\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Use this API to reassign a hardware terminal to another merchant. This is limited to partners who handle their own storage and deal with terminals in bulk." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"Changed merchant for terminal successfully\"\n}" } ] }, { "name": "Set Terminal Config", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"serialNo\": \"123456789\",\n \"wifiSsid\": \"wifiname\",\n \"wifiPassword\": \"wifipassword\",\n \"autoSleep\": 3000,\n \"preferredNetwork\": \"WIFI\",\n \"preferredRestartTime\": \"03:00\",\n \"alwaysShowMinorUnits\": 1,\n \"language\": \"en\",\n \"showStatusBar\": true,\n \"chipReadDelay\": 500,\n \"showReceipt\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets specific configurations for an individual terminal. Use this API to configure settings and parameters for a particular terminal." }, "response": [ { "name": "Set Terminal Config - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"serialNo\": \"123456789\",\n \"wifiSsid\": \"wifiname\",\n \"wifiPassword\": \"wifipassword\",\n \"autoSleep\": 3000,\n \"preferredNetwork\": \"WIFI\",\n \"preferredRestartTime\": \"03:00\",\n \"alwaysShowMinorUnits\": 1,\n \"language\": \"en\",\n \"showStatusBar\": true,\n \"chipReadDelay\": 500,\n \"showReceipt\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets specific configurations for an individual terminal. Use this API to configure settings and parameters for a particular terminal." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"TERMINAL config updated successfully\"\n}" } ] }, { "name": "Set Merchant Terminal Config", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"serialNo\": \"123456789\",\n \"wifiSsid\": \"wifiname\",\n \"wifiPassword\": \"wifipassword\",\n \"autoSleep\": 3000,\n \"preferredNetwork\": \"WIFI\",\n \"preferredRestartTime\": \"03:00\",\n \"alwaysShowMinorUnits\": 1,\n \"language\": \"en\",\n \"showStatusBar\": true,\n \"chipReadDelay\": 500,\n \"showReceipt\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets configurations for all the terminals registered to a specific merchant. Use this API to configure uniform settings and parameters across multiple terminals associated with a specific merchant." }, "response": [ { "name": "Set Merchant Terminal Config - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"serialNo\": \"123456789\",\n \"wifiSsid\": \"wifiname\",\n \"wifiPassword\": \"wifipassword\",\n \"autoSleep\": 3000,\n \"preferredNetwork\": \"WIFI\",\n \"preferredRestartTime\": \"03:00\",\n \"alwaysShowMinorUnits\": 1,\n \"language\": \"en\",\n \"showStatusBar\": true,\n \"chipReadDelay\": 500,\n \"showReceipt\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets configurations for all the terminals registered to a specific merchant. Use this API to configure uniform settings and parameters across multiple terminals associated with a specific merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"MERCHANT config updated successfully\"\n}" } ] }, { "name": "Set Store Terminal Config", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"wifiSsid\": \"wifiname\",\n \"wifiPassword\": \"wifipassword\",\n \"autoSleep\": 3000,\n \"preferredNetwork\": \"WIFI\",\n \"preferredRestartTime\": \"03:00\",\n \"alwaysShowMinorUnits\": 1,\n \"language\": \"en\",\n \"showStatusBar\": true,\n \"chipReadDelay\": 500,\n \"showReceipt\": true,\n \"screenTimeout\": 60000,\n \"receiptScreenTimeout\": 10000\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets configurations for all the terminals registered to a specific store. Use this API to configure uniform settings and parameters across all the terminals associated with a specific store." }, "response": [ { "name": "Set Store Terminal Config - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"wifiSsid\": \"wifiname\",\n \"wifiPassword\": \"wifipassword\",\n \"autoSleep\": 3000,\n \"preferredNetwork\": \"WIFI\",\n \"preferredRestartTime\": \"03:00\",\n \"alwaysShowMinorUnits\": 1,\n \"language\": \"en\",\n \"showStatusBar\": true,\n \"chipReadDelay\": 500,\n \"showReceipt\": true,\n \"screenTimeout\": 60000,\n \"receiptScreenTimeout\": 10000\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets configurations for all the terminals registered to a specific store. Use this API to configure uniform settings and parameters across all the terminals associated with a specific store." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"STORE config updated successfully\"\n}" } ] }, { "name": "Reboot Terminal", "request": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/reboot", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "reboot" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } }, "description": "Issue a remote terminal restart command." }, "response": [ { "name": "Reboot Terminal - Success", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId/reboot", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId", "reboot" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } }, "description": "Issue a remote terminal restart command." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Reboot command published successfully\"\n}" } ] }, { "name": "Fetch Terminal Config", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/config", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "config" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Use this API to fetch all currently active configurations for the terminal." }, "response": [ { "name": "Fetch Terminal Config - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/config", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "config" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Use this API to fetch all currently active configurations for the terminal." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"preferredRestartTime\": \"02:00\",\n\t\t\"preferredNetwork\": \"WIFI\",\n\t\t\"wifiSsid\": \"surfboard\",\n\t\t\"wifiPassword\": \"surfboa\",\n\t\t\"language\": \"da\",\n\t\t\"autoSleep\": 400,\n\t\t\"alwaysShowMinorUnits\": 1,\n\t\t\"showStatusBar\": false,\n\t\t\"showReceipt\": true,\n\t\t\"chipReadDelay\": 500,\n\t\t\"openPosOnReboot\": \"enabled\",\n\t\t\"enableRefundLock\": true,\n\t\t\"screenTimeout\": 3000000,\n\t\t\"preferredGsmOperator\": 2\n\t},\n\t\"message\": \"Terminal config queried successfully\"\n}" } ] }, { "name": "Fetch Merchant Terminal Config", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/terminals/config", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "terminals", "config" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Use this API to fetch all currently active terminal configurations for the merchant." }, "response": [ { "name": "Fetch Merchant Terminal Config - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/terminals/config", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "terminals", "config" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Use this API to fetch all currently active terminal configurations for the merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"preferredRestartTime\": \"02:00\",\n\t\t\"preferredNetwork\": \"WIFI\",\n\t\t\"wifiSsid\": \"surfboard\",\n\t\t\"wifiPassword\": \"surfboa\",\n\t\t\"language\": \"da\",\n\t\t\"autoSleep\": 400,\n\t\t\"alwaysShowMinorUnits\": 1,\n\t\t\"showStatusBar\": false,\n\t\t\"showReceipt\": true,\n\t\t\"chipReadDelay\": 500,\n\t\t\"openPosOnReboot\": \"enabled\",\n\t\t\"enableRefundLock\": true,\n\t\t\"screenTimeout\": 3000000,\n\t\t\"preferredGsmOperator\": 2\n\t},\n\t\"message\": \"Merchant Terminal config queried successfully\"\n}" } ] }, { "name": "Fetch Store Terminal Config", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/config", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", "config" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Use this API to fetch all currently active configurations for the store." }, "response": [ { "name": "Fetch Store Terminal Config - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/config", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", "config" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Use this API to fetch all currently active configurations for the store." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"preferredRestartTime\": \"02:00\",\n \"preferredNetwork\": \"WIFI\",\n \"wifiSsid\": \"surfboard\",\n \"wifiPassword\": \"surfboa\",\n \"language\": \"da\",\n \"autoSleep\": 400,\n \"alwaysShowMinorUnits\": 1,\n \"showStatusBar\": false,\n \"showReceipt\": true,\n \"chipReadDelay\": 500,\n \"openPosOnReboot\": \"enabled\",\n \"enableRefundLock\": true,\n \"screenTimeout\": 3000000,\n \"preferredGsmOperator\": 2\n },\n \"message\": \"Store Terminal config queried successfully\"\n}" } ] }, { "name": "Fetch Terminal by ID", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Retrieves information about a specific terminal. Use this API to get information regarding a particular terminal registered under a merchant." }, "response": [ { "name": "Fetch Terminal by ID - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/terminals/:terminalId", "host": [ "{{baseUrl}}" ], "path": [ "terminals", ":terminalId" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Retrieves information about a specific terminal. Use this API to get information regarding a particular terminal registered under a merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\":{\n\t\t\t\"terminalId\": \"81f878852b3a280904\",\n\t\t\t\"terminalType\": \"surfpad\",\n\t\t\t\"softwareVersion\": \"0.0.0\",\n\t\t\t\"osType\": \"sb_firmware\",\n\t\t\t\"osVersion\": \"0.0.0\",\n\t\t\t\"deviceVendor\": \"Datecs\",\n\t\t\t\"deviceModel\": \"Datecs PinPad\",\n\t\t\t\"serialNo\": \"2922000007\",\n\t\t\t\"storeId\": \"81497439a52270000f\",\n\t\t\t\"linkedTerminalId\": null,\n\t\t\t\"terminalStatus\": \"ACTIVE\",\n\t\t\t\"startDate\": \"2022-11-17T09:29:51.427Z\",\n\t\t\t\"terminalPaymentMethods\": [\n\t\t\t\t\"CARD\"\n\t\t\t],\n\t\t\t\"terminalName\": \"My Terminal\",\n\t\t\t\"lastAliveAt\": \"2024-02-21T08:48:26.000Z\",\n\t\t\t\"isCharging\": false,\n\t\t\t\"batteryPercentage\": 100,\n\t\t\t\"powerSource\": \"BATTERY\",\n\t\t\t\"deviceNetwork\": \"WIFI\",\n\t\t\t\"turnOnTime\": \"2024-02-21T05:14:33.417Z\",\n\t\t\t\"terminalPublicKey\": null\n\t\t},\n\t\"message\":\"Terminal records fetched successfully\"\n}" } ] }, { "name": "Fetch APN List", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/apns", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "apns" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Retrieves the list of APN's of the terminal. The terminal has to be active for a successful read and the response will be received in exactly 10 seconds." }, "response": [ { "name": "Fetch APN List - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/:terminalId/apns", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", ":terminalId", "apns" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "description": "Retrieves the list of APN's of the terminal. The terminal has to be active for a successful read and the response will be received in exactly 10 seconds." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"apns\": [\n\t\t\t\"WIFI1\",\n\t\t\t\"WIFI2\"\n\t\t]\n\t},\n\t\"message\": \"APN list fetch successfully.\"\n}" } ] }, { "name": "Get Interapp Code", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/interapp", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", "interapp" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Use this API to generate registration code used for interapp registration." }, "response": [ { "name": "Get Interapp Code - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/terminals/interapp", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "terminals", "interapp" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Use this API to generate registration code used for interapp registration." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"registrationCode\": \"v_Z37lV0JatqBvou\"\n\t},\n\t\"message\": \"Registration Code Generated Successfully\"\n}" } ] }, { "name": "Get Interapp Details", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/merchantId/stores/:storeId/terminals/interapp/:interappcode", "host": [ "{{baseUrl}}" ], "path": [ "merchants", "merchantId", "stores", ":storeId", "terminals", "interapp", ":interappcode" ], "variable": [ { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "interappcode", "value": "", "description": "interappcode" } ] }, "description": "Make use of this API to fetch the current status of the interapp registration." }, "response": [ { "name": "Get Interapp Details - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/merchantId/stores/:storeId/terminals/interapp/:interappcode", "host": [ "{{baseUrl}}" ], "path": [ "merchants", "merchantId", "stores", ":storeId", "terminals", "interapp", ":interappcode" ], "variable": [ { "key": "storeId", "value": "{{storeId}}", "description": "storeId" }, { "key": "interappcode", "value": "", "description": "interappcode" } ] }, "description": "Make use of this API to fetch the current status of the interapp registration." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"registrationStatus\": \"REGISTERED\",\n\t\t\"terminalId\": \"81f878852b3a280904\"\n\t},\n\t\"message\": \"Registration status checked successfully\"\n}" } ] } ] }, { "name": "Tips APIs", "description": "Tips APIs enable merchants to integrate tipping functionality directly into the payment terminals. These APIs provide options for adding either preset or custom tip amounts to the overall payment amount on the terminal screen. When customers make payments, they can choose from these displayed preset tip values or decide to enter a custom amount based on their preference. Tips can be configured at the merchant, store, or terminal levels, allowing for flexibility to match your unique operational requirements.", "item": [ { "name": "Set Merchant Tips Config", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "tips" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"tipConfig\": \"ENABLED\",\n \"tipLevel1\": 10,\n \"tipLevel2\": 20,\n \"tipLevel3\": 30,\n \"defaultCustomAmount\": 5,\n \"displayCalculatedAmount\": \"ENABLED\",\n \"tipDisplayFormat\": \"PERCENTAGE\",\n \"freeAmountEnabled\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets tips configurations for all the terminals registered to a specific merchant. Use this API to configure the same tips configurations across multiple terminals associated with a specific merchant." }, "response": [ { "name": "Set Merchant Tips Config - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "tips" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "body": { "mode": "raw", "raw": "{\n \"tipConfig\": \"ENABLED\",\n \"tipLevel1\": 10,\n \"tipLevel2\": 20,\n \"tipLevel3\": 30,\n \"defaultCustomAmount\": 5,\n \"displayCalculatedAmount\": \"ENABLED\",\n \"tipDisplayFormat\": \"PERCENTAGE\",\n \"freeAmountEnabled\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets tips configurations for all the terminals registered to a specific merchant. Use this API to configure the same tips configurations across multiple terminals associated with a specific merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"message\": \"MERCHANT config updated successfully\"\n}" } ] }, { "name": "Set Store Tips Config", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "tips" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"tipConfig\": \"ENABLED\",\n \"tipLevel1\": 10,\n \"tipLevel2\": 20,\n \"tipLevel3\": 30\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets tips configurations for all the terminals registered to a specific store. Use this API to configure the same tips configurations across multiple terminals associated with a specific store." }, "response": [ { "name": "Set Store Tips Config - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "tips" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "body": { "mode": "raw", "raw": "{\n \"tipConfig\": \"ENABLED\",\n \"tipLevel1\": 10,\n \"tipLevel2\": 20,\n \"tipLevel3\": 30\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets tips configurations for all the terminals registered to a specific store. Use this API to configure the same tips configurations across multiple terminals associated with a specific store." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"STORE config updated successfully\"\n}" } ] }, { "name": "Set Terminal Tips Config", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/merchantId/stores/storeId/terminals/:terminalId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", "merchantId", "stores", "storeId", "terminals", ":terminalId", "tips" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"tipConfig\": \"ENABLED\",\n \"tipLevel1\": 10,\n \"tipLevel2\": 20,\n \"tipLevel3\": 30\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets tips configuration for an individual terminal. Use this API to configure tips for a particular terminal." }, "response": [ { "name": "Set Terminal Tips Config - Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/merchantId/stores/storeId/terminals/:terminalId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", "merchantId", "stores", "storeId", "terminals", ":terminalId", "tips" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] }, "body": { "mode": "raw", "raw": "{\n \"tipConfig\": \"ENABLED\",\n \"tipLevel1\": 10,\n \"tipLevel2\": 20,\n \"tipLevel3\": 30\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets tips configuration for an individual terminal. Use this API to configure tips for a particular terminal." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"TERMINAL config updated successfully\"\n}" } ] }, { "name": "Fetch Merchant Tips Config", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "tips" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves the tips configurations for all terminals registered to a specific merchant. Use this API to get all the tips configurations for all the terminals registered to a merchant." }, "response": [ { "name": "Fetch Merchant Tips Config - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "tips" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" } ] }, "description": "Retrieves the tips configurations for all terminals registered to a specific merchant. Use this API to get all the tips configurations for all the terminals registered to a merchant." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"tipConfig\": \"ENABLED\",\n\t\t\"tipLevel1\": 10,\n\t\t\"tipLevel2\": 20,\n\t\t\"tipLevel3\": 30,\n\t\t\"displayCustomAmount\": 2341,\n\t\t\"displayCalculatedAmount\": \"ENABLED\",\n\t\t\"tipDisplayFormat\": \"AMOUNT\"\n\t},\n\t\"message\": \"merchant config queried successfully\"\n}" } ] }, { "name": "Fetch Store Tips Config", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "tips" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Retrieves the tips configurations for all terminals registered to a specific store. Use this API to get all the tips configurations for all the terminals registered to a store." }, "response": [ { "name": "Fetch Store Tips Config - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/stores/:storeId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "stores", ":storeId", "tips" ], "variable": [ { "key": "merchantId", "value": "{{merchantId}}", "description": "merchantId" }, { "key": "storeId", "value": "{{storeId}}", "description": "storeId" } ] }, "description": "Retrieves the tips configurations for all terminals registered to a specific store. Use this API to get all the tips configurations for all the terminals registered to a store." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"tipConfig\": \"ENABLED\",\n \"tipLevel1\": 10,\n \"tipLevel2\": 20,\n \"tipLevel3\": 30,\n \"defaultCustomAmount\": 2341,\n \"displayCalculatedAmount\": \"ENABLED\",\n \"tipDisplayFormat\": \"AMOUNT\"\n },\n \"message\": \"store config queried successfully\"\n}" } ] }, { "name": "Fetch Terminal Tips Config", "request": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/merchantId/stores/storeId/terminals/:terminalId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", "merchantId", "stores", "storeId", "terminals", ":terminalId", "tips" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] } }, "response": [ { "name": "Fetch Terminal Tips Config - Success", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "API-SECRET", "value": "{{apiSecret}}", "type": "text" }, { "key": "MERCHANT-ID", "value": "{{merchantId}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/merchants/merchantId/stores/storeId/terminals/:terminalId/tips", "host": [ "{{baseUrl}}" ], "path": [ "merchants", "merchantId", "stores", "storeId", "terminals", ":terminalId", "tips" ], "variable": [ { "key": "terminalId", "value": "{{terminalId}}", "description": "terminalId" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"tipConfig\": \"ENABLED\",\n \"tipLevel1\": 10,\n \"tipLevel2\": 20,\n \"tipLevel3\": 30,\n \"displayCustomAmount\": 2341,\n \"displayCalculatedAmount\": \"ENABLED\",\n \"tipDisplayFormat\": \"AMOUNT\"\n },\n \"message\": \"terminal config queried successfully\"\n}" } ] } ] }, { "name": "Webhooks", "description": "Webhook events sent by Surfboard to your configured webhook URLs. These are example payloads for each event type.\n\nNote: These requests represent incoming webhooks FROM Surfboard TO your server. Use them as reference for the payload structure.", "item": [ { "name": "Logistics Events", "description": "The Logistics events reference details the notifications and triggers associated with product shipment orders, specifically terminals and accessories, made with the Logistics API. These events offer real-time updates on product order statuses from placement to delivery. By monitoring these events, partners can ensure efficient order tracking and timely fulfillment for the products for the merchants.", "item": [ { "name": "Logistics Order Update", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"logistics.orderupdate\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"merchantId\": \"81412e2e4102f80f0e\",\n \"orderId\": \"81376ad8ebedf80310\",\n \"orderStatus\": \"ORDER_SHIPPED\",\n \"trackingUrl\": \"https://www.dhl.com/home/tracking.html\",\n \"packageDetails\": [\n\t {\n\t\t \"productId\": \"817361bb0a23400701\",\n\t\t \"serial\": \"658364\"\n\t\t}\n\t]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Logistics Order Update\n\nThis event is triggered whenever there's a change in the shipment status of the terminals and accessories ordered.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] } ] }, { "name": "Merchant Application Events", "description": "The Merchant application events reference details the various events that arise during the merchant onboarding process in Surfboard. From the moment a partner initiates the onboarding by creating a merchant application, to the Know Your Business (KYB) step, theses webhooks provides real-time updates on the progress of each merchant application. By tracking these events, partners can ensure timely and accurate completion of merchant onboarding, enhancing the overall efficiency of the onboarding experience.", "item": [ { "name": "Application Initiated", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.initiated\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"APPLICATION_INITIATED\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Initiated\n\nThis event is triggered when the merchant application is created, and the KYB URL is generated. At this point, the merchant needs to provide the necessary details via the Web KYB.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Application Submitted", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.submitted\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"APPLICATION_SUBMITTED\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Submitted\n\nThis event is triggered once the merchant has completed and submitted the KYB for review.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Application Signed", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.signed\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"APPLICATION_SIGNED\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Signed\n\nThis event is triggered when both the merchant signatories and UBOs have signed the application.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Application Started", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.started\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"APPLICATION_INITIATED\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Started\n\nThis event is triggered once the merchant has started filling out the application.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Application Pending Merchant Information", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.pendingMerchantInformation\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"APPLICATION_PENDING_INFORMATION\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Pending Merchant Information\n\nThis event is triggered when the application is being processed but requires additional data from the merchant for completion.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Application Completed", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.completed\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"APPLICATION_COMPLETED\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Completed\n\nThis event is triggered when the application has been processed and accepted. The next steps involve merchant creation and onboarding.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Application Merchant Created", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.merchantCreated\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"MERCHANT_CREATED\",\n \"merchantId\": \"81412e2e4102f80f0e\",\n \"storeId\": \"81412e3c3b1090060f\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Merchant Created\n\nThis event is triggered when the merchant is created in Surfboard. The accompanying event data will include both the Merchant ID and Store ID.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Application Expired", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.expired\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"APPLICATION_EXPIRED\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Expired\n\nThis event is triggered when the merchant application has reached its expiration. For the continuation of the onboarding process, a new application must be created for the merchant.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Application Rejected", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"application.rejected\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"applicationId\": \"81376ad8ebedf80310\",\n \"applicationStatus\": \"APPLICATION_REJECTED\",\n \"corporateId\": \"12345678901\",\n \"companyName\": \"Surfboard\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Application Rejected\n\nThis event is triggered post-processing when the merchant application doesn't meet the necessary criteria and is subsequently rejected by Surfboard.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] } ] }, { "name": "Order Events", "description": "The Order events reference details the various triggers and notifications associated with order processes. These events provide real-time updates on the status and progress of orders, from initiation to completion. By monitoring order events, you can obtain insights into the payment flow, detect issues, and optimize the checkout experience. Each event is linked to specific order attributes, enabling detailed tracking, ensuring seamless order and payment management.", "item": [ { "name": "Order Updated", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"eventType\": \"order.updated\",\n\t\"metadata\": {\n\t\t\"eventId\": \"81a214e74b107801ff\",\n\t\t\"created\": 1695793998732,\n\t\t\"retryAttempt\": 0,\n\t\t\"terminalId\": \"830acac336f6d80b04\",\n\t\t\"originalCreated\": 1745821536443,\n\t\t\"webhookEventId\": \"81a214e7455ed01cff\"\n\t},\n\t\"data\": {\n\t\t\"orderId\": \"81a214e2ece7d00b0b\",\n\t\t\"merchantId\": \"8248db4c5c8dd0130e\",\n\t\t\"adjustments\": [\n\t\t\t{\n\t\t\t\t\"adjustmentType\": \"Discounts\",\n\t\t\t\t\"amount\": \"10\"\n\t\t\t}\n\t\t]\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Updated\n\nThis event is triggered when an order is updated.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Order Payment Initiated", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"order.paymentinitiated\",\n \"metadata\": {\n \"eventId\": \"81a2189d4b107816ff\",\n \"created\": 1695795898049,\n \"retryAttempt\": 0,\n \"terminalId\": \"830acac336f6d80b04\",\n \"originalCreated\": 1745821536443,\n \"webhookEventId\": \"81a2189e455ed00bff\"\n },\n \"data\": {\n \"orderId\": \"81a2189aece7d00f0b\",\n \"merchantId\": \"8248db4c5c8dd0130e\",\n \"paymentStatus\": \"PAYMENT_INITIATED\",\n \"orderStatus\": \"PAYMENT_INITIATED\",\n \"adjustments\": [\n {\n \"adjustmentType\": \"Discounts\",\n \"amount\": \"10\"\n }\n ],\n \"paymentMethod\": \"CARD\",\n \"paymentId\": \"81a2189ccb10783206\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Payment Initiated\n\nThis event is triggered when a payment is initiated for an order.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Order Payment Processed", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"order.paymentprocessed\",\n \"metadata\": {\n \"eventId\": \"81a211564b107819ff\",\n \"created\": 1695792172665,\n \"retryAttempt\": 0,\n \"terminalId\": \"830acac336f6d80b04\",\n \"originalCreated\": 1745821536443,\n \"webhookEventId\": \"81a21156c55ed00bff\"\n },\n \"data\": {\n \"orderId\": \"81a211506ce7d00e0b\",\n \"merchantId\": \"8248db4c5c8dd0130e\",\n \"paymentStatus\": \"PAYMENT_PROCESSED\",\n \"orderStatus\": \"PAYMENT_PROCESSED\",\n \"adjustments\": [\n {\n \"adjustmentType\": \"Discounts\",\n \"amount\": \"10\"\n }\n ],\n \"paymentMethod\": \"CARD\",\n \"paymentId\": \"81a211504b10783706\",\n \"truncatedPan\": \"007\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Payment Processed\n\nThis event is triggered when a payment is processed for an order.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Order Payment Completed", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"eventType\": \"order.paymentcompleted\",\n\t\"metadata\": {\n\t\t\"eventId\": \"831fc2f040bf405fff\",\n\t\t\"created\": 1745821536443,\n\t\t\"retryAttempt\": 0,\n\t\t\"terminalId\": \"830acac336f6d80b04\",\n\t\t\"originalCreated\": 1745821536443,\n\t\t\"webhookEventId\": \"831fc2f02a031015ff\"\n\t},\n\t\"data\": {\n\t\t\"orderId\": \"831fc2de72fed0000b\",\n\t\t\"referenceId\": \"r_3\",\n\t\t\"adjustments\": [\n\t\t\t{\n\t\t\t\t\"adjustmentType\": \"Discounts\",\n\t\t\t\t\"amount\": \"10\"\n\t\t\t}\n\t\t],\n\t\t\"paymentStatus\": \"PAYMENT_COMPLETED\",\n\t\t\"paymentMethod\": \"CARD\",\n\t\t\"paymentId\": \"831fc2ebc0bf400a06\",\n\t\t\"truncatedPan\": \"0102\",\n\t\t\"amount\": \"310\",\n\t\t\"merchantId\": \"82e48bd833d7d80c0e\",\n\t\t\"type\": \"PURCHASE\",\n\t\t\"transactionDetails\": [\n\t\t\t{\n\t\t\t\t\"transactionId\": \"831fc2ebc0bf401419\",\n\t\t\t\t\"terminalId\": \"830acac336f6d80b04\",\n\t\t\t\t\"rrn\": \"511806000002\",\n\t\t\t\t\"amount\": \"310\",\n\t\t\t\t\"currency\": \"752\",\n\t\t\t\t\"method\": \"CARD\",\n\t\t\t\t\"truncatedPan\": \"0102\",\n\t\t\t\t\"cardLabel\": \"MASTERCARD DEBIT\",\n\t\t\t\t\"posEntryMode\": \"07\",\n\t\t\t\t\"aid\": \"a0000000041010\",\n\t\t\t\t\"customerResponseCode\": \"00\",\n\t\t\t\t\"cvmMethod\": \"5e\",\n\t\t\t\t\"cvmMethodDescription\": \"Signature\",\n\t\t\t\t\"authMode\": \"ISSUER\",\n\t\t\t\t\"cardBrand\": \"MASTERCARD\",\n\t\t\t\t\"terminalVerificationResult\": \"0400008001\"\n\t\t\t}\n\t\t]\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Payment Completed\n\nThis event is triggered when a payment is completed for an order.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Order Payment Failed", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"eventType\": \"order.paymentfailed\",\n\t\"metadata\": {\n\t\t\"eventId\": \"831fc72840bf401fff\",\n\t\t\"created\": 1745823696789,\n\t\t\"retryAttempt\": 0,\n\t\t\"terminalId\": \"83134bb823ce380f04\",\n\t\t\"originalCreated\": 1745823696789,\n\t\t\"webhookEventId\": \"831fc728aa03100bff\"\n\t},\n\t\"data\": {\n\t\t\"metadata\": [\n\t\t\t{\n\t\t\t\t\"name\": \"Henry\"\n\t\t\t}\n\t\t],\n\t\t\"orderId\": \"831fc71d72fed00a0b\",\n\t\t\"adjustments\": [\n\t\t\t{\n\t\t\t\t\"adjustmentType\": \"test\",\n\t\t\t\t\"amount\": \"100\"\n\t\t\t}\n\t\t],\n\t\t\"orderStatus\": \"PAYMENT_FAILED\",\n\t\t\"paymentId\": \"831fc2ebc0bf400a06\",\n\t\t\"referenceId\": \"abc6\",\n\t\t\"merchantId\": \"81a641f8b3cfd0070e\",\n\t\t\"failedTransactionDetails\": {\n\t\t\t\"paymentId\": \"831fc2ebc0bf401419\",\n\t\t\t\"terminalId\": \"830acac336f6d80b04\",\n\t\t\t\"rrn\": \"511806000002\",\n\t\t\t\"amount\": 310,\n\t\t\t\"currency\": \"752\",\n\t\t\t\"method\": \"CARD\",\n\t\t\t\"cardLabel\": \"MASTERCARD DEBIT\",\n\t\t\t\"posEntryMode\": \"07\",\n\t\t\t\"aid\": \"a0000000041010\",\n\t\t\t\"cardBrand\": \"MASTERCARD\",\n\t\t\t\"terminalVerificationResult\": \"0400008001\",\n\t\t\t\"customerResponseDescription\":\"Description of the customer response code\"\n\t\t}\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Payment Failed\n\nThis event is triggered when a payment for an order is failed.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Order Payment Cancelled", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"eventType\": \"order.paymentcancelled\",\n\t\"metadata\": {\n\t\t\"eventId\": \"831fc72840bf401fff\",\n\t\t\"created\": 1745823696789,\n\t\t\"retryAttempt\": 0,\n\t\t\"terminalId\": \"83134bb823ce380f04\",\n\t\t\"originalCreated\": 1745823696789,\n\t\t\"webhookEventId\": \"831fc728aa03100bff\"\n\t},\n\t\"data\": {\n\t\t\"metadata\": [\n\t\t\t{\n\t\t\t\t\"name\": \"Henry\"\n\t\t\t}\n\t\t],\n\t\t\"orderId\": \"831fc71d72fed00a0b\",\n\t\t\"adjustments\": [\n\t\t\t{\n\t\t\t\t\"adjustmentType\": \"test\",\n\t\t\t\t\"amount\": \"100\"\n\t\t\t}\n\t\t],\n\t\t\"orderStatus\": \"PAYMENT_CANCELLED\",\n\t\t\"paymentId\": \"831fc72240bf400006\",\n\t\t\"referenceId\": \"abc6\",\n\t\t\"merchantId\": \"81a641f8b3cfd0070e\",\n\t\t\"cancelledTransactionDetails\": {\n\t\t\t\"paymentId\": \"831fc2ebc0bf400a06\",\n\t\t\t\"terminalId\": \"830acac336f6d80b04\",\n\t\t\t\"rrn\": \"511806000002\",\n\t\t\t\"amount\": 310,\n\t\t\t\"currency\": \"752\",\n\t\t\t\"method\": \"CARD\",\n\t\t\t\"cardLabel\": \"MASTERCARD DEBIT\",\n\t\t\t\"posEntryMode\": \"07\",\n\t\t\t\"aid\": \"a0000000041010\",\n\t\t\t\"cardBrand\": \"MASTERCARD\",\n\t\t\t\"terminalVerificationResult\": \"0400008001\",\n\t\t\t\"customerResponseDescription\":\"Description of the customer response code\"\n\t\t}\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Payment Cancelled\n\nThis event is triggered when a payment for an order is cancelled.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Order Cancelled", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"eventType\": \"order.cancelled\",\n\t\"metadata\": {\n\t\t\"eventId\": \"831fc72840bf401fff\",\n\t\t\"created\": 1745823696789,\n\t\t\"retryAttempt\": 0,\n\t\t\"terminalId\": \"83134bb823ce380f04\",\n\t\t\"originalCreated\": 1745823696789,\n\t\t\"webhookEventId\": \"831fc728aa03100bff\"\n\t},\n\t\"data\": {\n\t\t\"metadata\": [\n\t\t\t{\n\t\t\t\t\"name\": \"Henry\"\n\t\t\t}\n\t\t],\n\t\t\"orderId\": \"831fc71d72fed00a0b\",\n\t\t\"adjustments\": [\n\t\t\t{\n\t\t\t\t\"adjustmentType\": \"test\",\n\t\t\t\t\"amount\": \"100\"\n\t\t\t}\n\t\t],\n\t\t\"orderStatus\": \"PAYMENT_CANCELLED\",\n\t\t\"paymentId\": \"831fc72240bf400006\",\n\t\t\"referenceId\": \"abc6\",\n\t\t\"merchantId\": \"81a641f8b3cfd0070e\"\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Cancelled\n\nThis event is triggered when an order is cancelled.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Order Customer Identity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"eventType\": \"order.customer.identify\",\n\t\"metadata\": {\n\t\t\"eventId\": \"832cf9fe1806581dff\",\n\t\t\"created\": 1747553660038,\n\t\t\"retryAttempt\": 0,\n\t\t\"webhookEventId\": \"81a214e74b107801ff\"\n\t},\n\t\"data\": {\n\t\t\"orderId\": \"832cf9f93d2fd0410b\",\n\t\t\"cardId\": \"c550c29e80908c887a\"\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Customer Identity\n\nThis event is triggered when a customer taps their card on the terminal, enabling you to identify the customer during a transaction and personalize the experience.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] }, { "name": "Order Terminal Event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"order.terminal.event\",\n \"metadata\": {\n \"eventId\": \"81a214e74b107801ff\",\n \"created\": 1695793998732,\n \"retryAttempt\": 0,\n \"webhookEventId\": \"81a214e7455ed01cff\"\n },\n \"data\": {\n \"orderId\": \"81b5f2624b16e0080b\",\n \"merchantId\": \"8248db4c5c8dd0130e\",\n \"paymentId\": \"81b5f26215e9583a06\",\n \"terminalTransactionStatus\": \"STARTED\",\n \"orderStatus\": \"PAYMENT_INITIATED\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{webhookUrl}}", "host": [ "{{webhookUrl}}" ] }, "description": "**Webhook Event:** Order Terminal Event\n\nThis event is triggered for every state the terminal undergoes during a transaction.\n\nThis is a webhook event that Surfboard sends to your configured webhook URL. The request body below shows an example payload." }, "response": [] } ] } ] } ], "variable": [ { "key": "baseUrl", "value": "https://carbon.surfgw.com/api", "type": "string" }, { "key": "apiKey", "value": "YOUR_API_KEY", "type": "string" }, { "key": "apiSecret", "value": "YOUR_API_SECRET", "type": "string" }, { "key": "merchantId", "value": "YOUR_MERCHANT_ID", "type": "string" }, { "key": "partnerId", "value": "YOUR_PARTNER_ID", "type": "string" }, { "key": "storeId", "value": "YOUR_STORE_ID", "type": "string" }, { "key": "terminalId", "value": "YOUR_TERMINAL_ID", "type": "string" }, { "key": "orderId", "value": "YOUR_ORDER_ID", "type": "string" }, { "key": "paymentId", "value": "YOUR_PAYMENT_ID", "type": "string" }, { "key": "providerId", "value": "YOUR_PROVIDER_ID", "type": "string" }, { "key": "externalUserId", "value": "YOUR_EXTERNAL_USER_ID", "type": "string" }, { "key": "webhookUrl", "value": "https://your-server.com/webhooks", "type": "string" }, { "key": "authToken", "value": "", "type": "string" } ] }