{ "info": { "_postman_id": "10781d31-149e-4c3a-9525-c863e4e0dbf0", "name": "PayOrc Remote APIs Copy 2", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "39698070", "_collection_link": "https://go.postman.co/collection/39698070-10781d31-149e-4c3a-9525-c863e4e0dbf0?source=collection_link" }, "item": [ { "name": "Orders", "item": [ { "name": "Payment Request API", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}" }, { "key": "merchant-secret", "value": "{{hosted-secret}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"class\": \"ECOM\",\n \"action\": \"SALE\",\n \"capture_method\": \"\",\n \"customer_details\": {\n \"m_customer_id\": \"CUST-1234\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"mobile\": \"9876543210\",\n \"code\": \"91\"\n },\n \"order_details\": {\n \"m_order_id\": \"ORD-2024-001\",\n \"amount\": 100,\n \"quantity\": 1,\n \"convenience_fee\": 0,\n \"currency\": \"AED\",\n \"description\": \"Test order\"\n },\n \"billing_details\": {\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"John Doe\",\n \"shipping_email\": \"john@example.com\",\n \"shipping_code\": \"\",\n \"shipping_mobile\": \"\",\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\",\n \"location_pin\": \"\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": 0\n },\n \"urls\": {\n \"success\": \"https://yourdomain.com/payment/success\",\n \"cancel\": \"https://yourdomain.com/payment/cancel\",\n \"failure\": \"https://yourdomain.com/payment/failure\",\n \"webhook_url\": \"https://yourdomain.com/webhook\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/create", "host": [ "{{orders-url}}" ], "path": [ "create" ] }, "description": "Create a hosted payment order (ECOM + SALE). Same POST /orders/v1/create body as other order types \u2014 includes optional items, urls.webhook_url, parameters, and custom_data." }, "response": [] }, { "name": "AUTH REVERSAL (Add Card)", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}" }, { "key": "merchant-secret", "value": "{{hosted-secret}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"class\": \"ECOM\",\n \"action\": \"AUTH_REVERSAL\",\n \"capture_method\": \"AUTOMATIC\",\n \"customer_details\": {\n \"m_customer_id\": \"CUST-1234\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"mobile\": \"9876543210\",\n \"code\": \"91\"\n },\n \"order_details\": {\n \"m_order_id\": \"TOKEN-2024-001\",\n \"amount\": 1,\n \"quantity\": 1,\n \"convenience_fee\": 0,\n \"currency\": \"AED\",\n \"description\": \"Card tokenization\"\n },\n \"billing_details\": {\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"John Doe\",\n \"shipping_email\": \"john@example.com\",\n \"shipping_code\": \"\",\n \"shipping_mobile\": \"\",\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\",\n \"location_pin\": \"\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": 0\n },\n \"urls\": {\n \"success\": \"https://yourdomain.com/payment/success\",\n \"cancel\": \"https://yourdomain.com/payment/cancel\",\n \"failure\": \"https://yourdomain.com/payment/failure\",\n \"webhook_url\": \"https://yourdomain.com/webhook\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/create", "host": [ "{{orders-url}}" ], "path": [ "create" ] }, "description": "Tokenize a card without charging (AUTH then VOID). m_customer_id is required. m_payment_token is returned via webhook after customer completes the hosted page. Uses the same /orders/v1/create schema as Payment Request API (items, urls.webhook_url, parameters are optional but included in this example)." }, "response": [] }, { "name": "Pay By Token", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}" }, { "key": "merchant-secret", "value": "{{hosted-secret}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"class\": \"CAUTH\",\n \"action\": \"SALE\",\n \"capture_method\": \"\",\n \"payment_token\": \"REPLACE_WITH_M_PAYMENT_TOKEN\",\n \"customer_details\": {\n \"m_customer_id\": \"CUST-1234\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"mobile\": \"9876543210\",\n \"code\": \"91\"\n },\n \"order_details\": {\n \"m_order_id\": \"ORD-2024-002\",\n \"amount\": 200,\n \"quantity\": 1,\n \"convenience_fee\": 0,\n \"currency\": \"AED\",\n \"description\": \"Subscription payment\"\n },\n \"billing_details\": {\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"John Doe\",\n \"shipping_email\": \"john@example.com\",\n \"shipping_code\": \"\",\n \"shipping_mobile\": \"\",\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\",\n \"location_pin\": \"\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": 0\n },\n \"urls\": {\n \"success\": \"https://yourdomain.com/payment/success\",\n \"cancel\": \"https://yourdomain.com/payment/cancel\",\n \"failure\": \"https://yourdomain.com/payment/failure\",\n \"webhook_url\": \"https://yourdomain.com/webhook\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/create", "host": [ "{{orders-url}}" ], "path": [ "create" ] }, "description": "Charge a stored card using payment_token from AUTH REVERSAL. Requires class CAUTH, payment_token, and m_customer_id. CAUTH MID must be enabled. Uses the same /orders/v1/create schema as Payment Request API (items, urls.webhook_url, parameters are optional but included in this example)." }, "response": [] }, { "name": "Split Payment", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}" }, { "key": "merchant-secret", "value": "{{hosted-secret}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"class\": \"ECOM\",\n \"action\": \"SALE\",\n \"capture_method\": \"AUTOMATIC\",\n \"customer_details\": {\n \"m_customer_id\": \"CUST-1234\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"mobile\": \"9876543210\",\n \"code\": \"91\"\n },\n \"order_details\": {\n \"m_order_id\": \"SPLIT-2024-001\",\n \"amount\": 100,\n \"quantity\": 1,\n \"convenience_fee\": 0,\n \"currency\": \"AED\",\n \"description\": \"Split payment order\"\n },\n \"billing_details\": {\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"John Doe\",\n \"shipping_email\": \"john@example.com\",\n \"shipping_code\": \"\",\n \"shipping_mobile\": \"\",\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\",\n \"location_pin\": \"\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": 0\n },\n \"urls\": {\n \"success\": \"https://yourdomain.com/payment/success\",\n \"cancel\": \"https://yourdomain.com/payment/cancel\",\n \"failure\": \"https://yourdomain.com/payment/failure\",\n \"webhook_url\": \"https://yourdomain.com/webhook\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"|SPLIT_PAYMENT\"\n },\n {\n \"beta\": \"|100,P,2\"\n },\n {\n \"gamma\": \"|101,F,50\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/create", "host": [ "{{orders-url}}" ], "path": [ "create" ] }, "description": "Split payment via custom_data array. Live mode only. alpha: |SPLIT_PAYMENT, beta-gamma: |{split_id},{P|F},{value}. Split IDs from PayOrc. Uses the same /orders/v1/create schema as Payment Request API (items, urls.webhook_url, parameters are optional but included in this example)." }, "response": [] }, { "name": "MID Group", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}" }, { "key": "merchant-secret", "value": "{{hosted-secret}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"class\": \"ECOM\",\n \"action\": \"SALE\",\n \"capture_method\": \"AUTOMATIC\",\n \"customer_details\": {\n \"m_customer_id\": \"CUST-1234\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"mobile\": \"9876543210\",\n \"code\": \"91\"\n },\n \"order_details\": {\n \"m_order_id\": \"MID-2024-001\",\n \"amount\": 500,\n \"quantity\": 1,\n \"convenience_fee\": 0,\n \"currency\": \"AED\",\n \"description\": \"MID group routed order\"\n },\n \"billing_details\": {\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"John Doe\",\n \"shipping_email\": \"john@example.com\",\n \"shipping_code\": \"\",\n \"shipping_mobile\": \"\",\n \"address_line1\": \"123 Main Street\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\",\n \"location_pin\": \"\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": 0\n },\n \"urls\": {\n \"success\": \"https://yourdomain.com/payment/success\",\n \"cancel\": \"https://yourdomain.com/payment/cancel\",\n \"failure\": \"https://yourdomain.com/payment/failure\",\n \"webhook_url\": \"https://yourdomain.com/webhook\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"MID_GROUP\"\n },\n {\n \"beta\": \"INS_HEALTH\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/create", "host": [ "{{orders-url}}" ], "path": [ "create" ] }, "description": "Route transaction to a MID Group label configured in Merchant Portal. custom_data array: alpha=MID_GROUP, beta=group label. Uses the same /orders/v1/create schema as Payment Request API (items, urls.webhook_url, parameters are optional but included in this example)." }, "response": [] }, { "name": "Capture", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"CAPTURE\",\n \"transaction_id\": \"REPLACE_WITH_TRANSACTION_ID\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 100\n },\n \"reason\": \"Order shipped - full capture\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/transaction", "host": [ "{{orders-url}}" ], "path": [ "transaction" ] }, "description": "Capture an authorized payment (AUTH + MANUAL). Request is validated in service-orders then forwarded to connector-switch `/transaction/followups`. Flat body (not nested under data)." }, "response": [ { "name": "Capture Success", "originalRequest": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}" }, { "key": "merchant-secret", "value": "{{hosted-secret}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"CAPTURE\",\n \"transaction_id\": \"1000010118\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 100\n },\n \"reason\": \"Order shipped - full capture\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/transaction", "host": [ "{{orders-url}}" ], "path": [ "transaction" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"status\": \"CAPTURED\",\n \"m_order_id\": \"ORD-2024-001\",\n \"p_order_id\": 1000010228,\n \"transaction_id\": 1000010223,\n \"amount\": \"100.00\",\n \"currency\": \"AED\",\n \"date\": \"04/08/2023\"\n },\n \"message\": \"Transaction successfully Captured.\",\n \"status\": \"success\",\n \"code\": \"00\"\n}" } ] }, { "name": "Void", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"VOID\",\n \"transaction_id\": \"REPLACE_WITH_TRANSACTION_ID\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 150\n },\n \"reason\": \"Customer cancelled order before shipment\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/transaction", "host": [ "{{orders-url}}" ], "path": [ "transaction" ] }, "description": "Void an authorized (not yet captured) payment. Forwarded to connector-switch `/transaction/followups`. MID must have allowVoid enabled." }, "response": [ { "name": "Void Success", "originalRequest": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}" }, { "key": "merchant-secret", "value": "{{hosted-secret}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"VOID\",\n \"transaction_id\": \"1000010118\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 150\n },\n \"reason\": \"Customer cancelled order before shipment\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/transaction", "host": [ "{{orders-url}}" ], "path": [ "transaction" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"status\": \"VOID\",\n \"m_order_id\": \"ORD-2024-001\",\n \"p_order_id\": 1000010228,\n \"transaction_id\": 1000010223,\n \"amount\": \"150.00\",\n \"currency\": \"AED\",\n \"date\": \"04/08/2023\"\n },\n \"message\": \"Transaction successfully void.\",\n \"status\": \"success\",\n \"code\": \"00\"\n}" } ] }, { "name": "Refund", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"REFUND\",\n \"transaction_id\": \"REPLACE_WITH_TRANSACTION_ID\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 100\n },\n \"reason\": \"Customer returned item - full refund\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/transaction", "host": [ "{{orders-url}}" ], "path": [ "transaction" ] }, "description": "Refund a captured/SALE payment (full or partial). Forwarded to connector-switch `/transaction/followups`. MID must have allowRefunds enabled. Success uses status + transaction_id + m_order_id (same shape as Capture/Void)." }, "response": [ { "name": "Refund Success", "originalRequest": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}" }, { "key": "merchant-secret", "value": "{{hosted-secret}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"REFUND\",\n \"transaction_id\": \"1000010118\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 100\n },\n \"reason\": \"Customer returned item - full refund\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{orders-url}}/transaction", "host": [ "{{orders-url}}" ], "path": [ "transaction" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"status\": \"REFUNDED\",\n \"m_order_id\": \"ORD-2024-001\",\n \"p_order_id\": 1000010228,\n \"transaction_id\": 1000010223,\n \"amount\": \"100.00\",\n \"currency\": \"AED\",\n \"date\": \"04/08/2023\"\n },\n \"message\": \"Refunded Successfully.\",\n \"status\": \"success\",\n \"code\": \"00\"\n}" } ] }, { "name": "DETAILS", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" } ], "url": { "raw": "{{orders-url}}/transaction-details?p_order_id=", "host": [ "{{orders-url}}" ], "path": [ "transaction-details" ], "query": [ { "key": "p_order_id", "value": "" } ] } }, "response": [] }, { "name": "TRANSACTION LIST", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" } ], "url": { "raw": "{{orders-url}}/transaction-list?perpage=10&page=1&p_order_id=&transaction_id=&status=&payment_method=&card_bin=&processor=¤cy_code=&to_date=&from_date=&min_amount=&max_amount=&m_customer_id=&customer_email=&customer_mobile=&customer_country=&payment_method_id=&m_payment_token=", "host": [ "{{orders-url}}" ], "path": [ "transaction-list" ], "query": [ { "key": "perpage", "value": "10" }, { "key": "page", "value": "1" }, { "key": "p_order_id", "value": "" }, { "key": "transaction_id", "value": "" }, { "key": "status", "value": "" }, { "key": "payment_method", "value": "" }, { "key": "card_bin", "value": "" }, { "key": "processor", "value": "" }, { "key": "currency_code", "value": "" }, { "key": "to_date", "value": "" }, { "key": "from_date", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" }, { "key": "m_customer_id", "value": "" }, { "key": "customer_email", "value": "" }, { "key": "customer_mobile", "value": "" }, { "key": "customer_country", "value": "" }, { "key": "payment_method_id", "value": "" }, { "key": "m_payment_token", "value": "" } ] } }, "response": [] } ] }, { "name": "Payment Links", "item": [ { "name": "ADD", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{paymentlink-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{paymentlink-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"amount\": {\r\n \"currency\": \"AED\",\r\n \"value\": \"100\"\r\n },\r\n \"shipping_fee\": \"50\",\r\n \"convenience_fee\": \"20\",\r\n \"no_quantity_per_transaction\": \"9\",\r\n \"no_of_transactions_per_user\": {\r\n \"no_limit\": \"no\",\r\n \"quantity\": \"3\",\r\n \"frequency\": \"per_day\"\r\n },\r\n \"total_quantity_allowed\": {\r\n \"no_limit\": \"no\",\r\n \"quantity\": \"10\",\r\n \"frequency\": \"per_day\"\r\n },\r\n \"link_expiry\": {\r\n \"end_date\": \"2024-02-15\",\r\n \"is_expiry\": \"no\"\r\n },\r\n \"customer_name\": \"customer name\",\r\n \"customer_email\": \"customeremail@example.com\",\r\n \"product_details\": \"some product description\",\r\n \"m_order_id\": \"ORD-2026-001\",\r\n \"m_customer_id\": \"CUST-123\",\r\n \"customer_mobile\": \"9876543210\",\r\n \"customer_mobile_code\": \"91\",\r\n \"description\": \"This is the payment link.\",\r\n \"split_bill\": \"0\",\r\n \"tip\": \"0\",\r\n \"urls\": {\r\n \"success\": \"https://example.com/success\",\r\n \"failure\": \"https://example.com/failure\",\r\n \"cancel\": \"https://example.com/cancel\",\r\n \"webhook_url\": \"https://example.com/webhook\"\r\n },\r\n \"error_msg\": \"Error message\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{payment-links-url}}/add", "host": [ "{{payment-links-url}}" ], "path": [ "add" ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const id = json && json.data_id;", "if (id) {", " pm.collectionVariables.set('paymentlink-data-id', id);", " console.log('Saved paymentlink-data-id:', id);", "}" ], "type": "text/javascript" } } ] }, { "name": "UPDATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{paymentlink-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{paymentlink-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{paymentlink-data-id}}\",\r\n \"amount\": {\r\n \"currency\": \"AED\",\r\n \"value\": \"100\"\r\n },\r\n \"shipping_fee\": \"50\",\r\n \"convenience_fee\": \"20\",\r\n \"no_quantity_per_transaction\": \"9\",\r\n \"no_of_transactions_per_user\": {\r\n \"no_limit\": \"no\",\r\n \"quantity\": \"3\",\r\n \"frequency\": \"per_day\"\r\n },\r\n \"total_quantity_allowed\": {\r\n \"no_limit\": \"no\",\r\n \"quantity\": \"10\",\r\n \"frequency\": \"per_day\"\r\n },\r\n \"link_expiry\": {\r\n \"end_date\": \"2024-02-15\",\r\n \"is_expiry\": \"no\"\r\n },\r\n \"customer_name\": \"customer name\",\r\n \"customer_email\": \"customeremail@example.com\",\r\n \"product_details\": \"some product description\",\r\n \"m_order_id\": \"ORD-2026-001\",\r\n \"m_customer_id\": \"CUST-123\",\r\n \"customer_mobile\": \"9876543210\",\r\n \"customer_mobile_code\": \"91\",\r\n \"description\": \"This is the payment link.\",\r\n \"split_bill\": \"0\",\r\n \"tip\": \"0\",\r\n \"urls\": {\r\n \"success\": \"https://example.com/success\",\r\n \"failure\": \"https://example.com/failure\",\r\n \"cancel\": \"https://example.com/cancel\",\r\n \"webhook_url\": \"https://example.com/webhook\"\r\n },\r\n \"error_msg\": \"Error message\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{payment-links-url}}/update", "host": [ "{{payment-links-url}}" ], "path": [ "update" ] } }, "response": [] }, { "name": "DEACTIVATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{paymentlink-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{paymentlink-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{paymentlink-data-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{payment-links-url}}/deactivate", "host": [ "{{payment-links-url}}" ], "path": [ "deactivate" ] } }, "response": [] }, { "name": "ACTIVATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{paymentlink-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{paymentlink-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{paymentlink-data-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{payment-links-url}}/activate", "host": [ "{{payment-links-url}}" ], "path": [ "activate" ] } }, "response": [] }, { "name": "DETAILS", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{paymentlink-key}}" }, { "key": "merchant-secret", "value": "{{paymentlink-secret}}" } ], "url": { "raw": "{{payment-links-url}}/details?data_id={{paymentlink-data-id}}", "host": [ "{{payment-links-url}}" ], "path": [ "details" ], "query": [ { "key": "data_id", "value": "{{paymentlink-data-id}}" } ] }, "description": "Returns payment link details. Response `data.urls` includes optional redirect/webhook URLs (`success`, `failure`, `cancel`, `webhook_url`) \u2014 empty strings when not set." }, "response": [] }, { "name": "LIST", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "merchant-key", "value": "{{paymentlink-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{paymentlink-secret}}", "type": "text" } ], "url": { "raw": "{{payment-links-url}}/list?perpage=1&page=1&amount_condition=&amount=¤cy=&customer_name=customer&customer_email=customer@example.com&product_details=description", "host": [ "{{payment-links-url}}" ], "path": [ "list" ], "query": [ { "key": "status", "value": "Active", "disabled": true }, { "key": "description", "value": "", "disabled": true }, { "key": "perpage", "value": "1" }, { "key": "page", "value": "1" }, { "key": "expiry_from_date", "value": "", "disabled": true }, { "key": "expiry_to_date", "value": "", "disabled": true }, { "key": "is_expiry", "value": "", "disabled": true }, { "key": "amount_condition", "value": "" }, { "key": "amount", "value": "" }, { "key": "currency", "value": "" }, { "key": "customer_name", "value": "customer" }, { "key": "customer_email", "value": "customer@example.com" }, { "key": "product_details", "value": "description" } ] }, "description": "Returns paginated payment links. Each item in `data` includes `urls` (`success`, `failure`, `cancel`, `webhook_url`) \u2014 empty strings when not set on the link." }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const id = json && json.data && json.data[0] && json.data[0].data_id;", "if (id) {", " pm.collectionVariables.set('paymentlink-data-id', id);", " console.log('Saved paymentlink-data-id:', id);", "}" ], "type": "text/javascript" } } ] }, { "name": "BULK UPLOAD", "request": { "method": "POST", "header": [ { "key": "merchant-secret", "value": "{{paymentlink-secret}}" }, { "key": "merchant-key", "value": "{{paymentlink-key}}" } ], "body": { "mode": "formdata", "formdata": [ { "type": "file", "key": "payment_link_file", "src": "/Users/apple/PayOrc Microservices/service-paymentlink/app/src/public/payment-link/payment_link_bulk.xlsx" } ] }, "url": { "raw": "{{payment-links-url}}/bulk-upload", "host": [ "{{payment-links-url}}" ], "path": [ "bulk-upload" ] }, "description": "Generated from cURL: curl --location 'https://dev-gateway.payorc.com/paymentlink/api/v1/open/payment_links/bulk' \\\n--header 'merchant-secret: sec-CB1RBA21SK' \\\n--header 'merchant-key: test-QZ112TI2149' \\\n--form 'payment_link_file=@\"/Users/apple/PayOrc Microservices/service-paymentlink/app/src/public/payment-link/payment_link_bulk.xlsx\"'" }, "response": [] } ] }, { "name": "Subscription", "item": [ { "name": "Plan", "item": [ { "name": "ADD", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}" }, { "key": "merchant-secret", "value": "{{subscription-secret}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"plan_name\": \"Plan name\",\r\n \"plan_description\": \"\",\r\n \"billing_frequency\": {\r\n \"frequency\": \"daily\",\r\n \"interval\": 1\r\n },\r\n \"installment_amount\": {\r\n \"currency\": \"AED\",\r\n \"value\": 200\r\n },\r\n \"terms\": {\r\n \"unlimited\": \"no\",\r\n \"value\": 1,\r\n \"discount_term\": 1,\r\n \"discount_amount\": 90.5\r\n },\r\n \"initial_payment_amount\": 100,\r\n \"final_payment_amount\": 90,\r\n \"shipping_fee\": 30,\r\n \"convenience_fee\": 10,\r\n \"start_date\": \"2026-07-08 23:50\",\r\n \"expiry_date\": \"2026-12-31 23:59\",\r\n \"note\": \"\",\r\n \"customer_emails\": \"\",\r\n \"customer_email_cc\": \"\",\r\n \"subject\": \"\",\r\n \"product_details\": \"\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{subscriptions-url}}/add", "host": [ "{{subscriptions-url}}" ], "path": [ "add" ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "if (json.data_id) {", " pm.collectionVariables.set('plan-data-id', json.data_id);", " console.log('Saved plan-data-id:', json.data_id);", "}" ], "type": "text/javascript" } } ] }, { "name": "UPDATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{plan-data-id}}\",\r\n \"plan_name\": \"Plan name\",\r\n \"plan_description\": \"\",\r\n \"billing_frequency\": {\r\n \"frequency\": \"daily\",\r\n \"interval\": 2\r\n },\r\n \"installment_amount\": {\r\n \"currency\": \"AED\",\r\n \"value\": 300\r\n },\r\n \"terms\": {\r\n \"unlimited\": \"no\",\r\n \"value\": 20,\r\n \"discount_term\": 5,\r\n \"discount_amount\": 90\r\n },\r\n \"initial_payment_amount\": 109,\r\n \"final_payment_amount\": 80,\r\n \"shipping_fee\": 30,\r\n \"convenience_fee\": 10,\r\n \"start_date\": \"2026-07-08 23:50\",\r\n \"expiry_date\": \"2026-12-31 23:59\",\r\n \"note\": \"\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{subscriptions-url}}/update", "host": [ "{{subscriptions-url}}" ], "path": [ "update" ] } }, "response": [] }, { "name": "SEND EMAIL", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{plan-data-id}}\",\r\n \"client_email\": \"\",\r\n \"email\": \"prospect@example.com\",\r\n \"subject\": \"Your subscription plan\",\r\n \"plan_description\": \"\",\r\n \"billing_frequency\": {\r\n \"frequency\": \"daily\",\r\n \"interval\": 1\r\n },\r\n \"installment_amount\": {\r\n \"currency\": \"AED\",\r\n \"value\": 200\r\n },\r\n \"terms\": {\r\n \"unlimited\": \"no\",\r\n \"value\": 1,\r\n \"discount_term\": 1,\r\n \"discount_amount\": 90.5\r\n },\r\n \"initial_payment_amount\": 100,\r\n \"final_payment_amount\": 90,\r\n \"shipping_fee\": 30,\r\n \"convenience_fee\": 10,\r\n \"start_date\": \"2026-07-08 23:50\",\r\n \"expiry_date\": \"2026-12-31 23:59\",\r\n \"note\": \"\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{subscriptions-url}}/send_mail", "host": [ "{{subscriptions-url}}" ], "path": [ "send_mail" ] } }, "response": [] }, { "name": "DEACTIVATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{plan-data-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{subscriptions-url}}/deactivate", "host": [ "{{subscriptions-url}}" ], "path": [ "deactivate" ] } }, "response": [] }, { "name": "ACTIVATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{plan-data-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{subscriptions-url}}/activate", "host": [ "{{subscriptions-url}}" ], "path": [ "activate" ] } }, "response": [] }, { "name": "DETAILS", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}" }, { "key": "merchant-secret", "value": "{{subscription-secret}}" } ], "url": { "raw": "{{subscriptions-url}}/details?data_id={{plan-data-id}}", "host": [ "{{subscriptions-url}}" ], "path": [ "details" ], "query": [ { "key": "data_id", "value": "{{plan-data-id}}", "description": "Encrypted plan ID from ADD or Plan LIST" } ] } }, "response": [] }, { "name": "LIST", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" } ], "url": { "raw": "{{subscriptions-url}}/list?perpage=10&page=1", "host": [ "{{subscriptions-url}}" ], "path": [ "list" ], "query": [ { "key": "perpage", "value": "10", "description": "Required" }, { "key": "page", "value": "1", "description": "Required" }, { "key": "plan_id_or_name", "value": "", "disabled": true, "description": "Filter by plan ID or name" }, { "key": "created_from_date", "value": "2026-01-01", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "created_to_date", "value": "2026-12-31", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "modified_from_date", "value": "2026-01-01", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "modified_to_date", "value": "2026-12-31", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "subscribe_from_date", "value": "2026-01-01", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "subscribe_to_date", "value": "2026-12-31", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "currency", "value": "AED", "disabled": true, "description": "3-letter code" }, { "key": "status", "value": "Active", "disabled": true, "description": "Active | Deactivated | Expired" }, { "key": "billing_interval", "value": "1", "disabled": true }, { "key": "billing_frequency", "value": "daily", "disabled": true, "description": "yearly | monthly | weekly | daily" }, { "key": "installment_amount", "value": "200", "disabled": true }, { "key": "total_terms", "value": "12", "disabled": true } ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "if (Array.isArray(json.data) && json.data[0]?.data_id) {", " pm.collectionVariables.set('plan-data-id', json.data[0].data_id);", " console.log('Saved plan-data-id:', json.data[0].data_id);", "}" ], "type": "text/javascript" } } ] } ] }, { "name": "Contract List", "item": [ { "name": "DETAILS", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" } ], "url": { "raw": "{{subscriptions-url}}/contract/details?subscription_id={{contract-subscription-id}}", "host": [ "{{subscriptions-url}}" ], "path": [ "contract", "details" ], "query": [ { "key": "subscription_id", "value": "{{contract-subscription-id}}", "description": "Encrypted ID from Contract LIST (not plain contract_id)" } ] } }, "response": [] }, { "name": "LIST", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" } ], "url": { "raw": "{{subscriptions-url}}/contract/list?perpage=10&page=1", "host": [ "{{subscriptions-url}}" ], "path": [ "contract", "list" ], "query": [ { "key": "perpage", "value": "10", "description": "Required" }, { "key": "page", "value": "1", "description": "Required" }, { "key": "contract_id", "value": "", "disabled": true, "description": "Plain display contract ID (integer)" }, { "key": "subscriber_id", "value": "", "disabled": true, "description": "Plain display subscriber ID (integer)" }, { "key": "subscriber_email_or_mobile", "value": "", "disabled": true }, { "key": "subscription_from_date", "value": "2026-01-01", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "subscription_to_date", "value": "2026-12-31", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "payment_from_date", "value": "2026-01-01", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "payment_to_date", "value": "2026-12-31", "disabled": true, "description": "YYYY-MM-DD" }, { "key": "last_payment_status", "value": "PAID", "disabled": true, "description": "PAID | FAILED" }, { "key": "currency", "value": "AED", "disabled": true }, { "key": "status", "value": "Active", "disabled": true, "description": "Active | Deactivated" }, { "key": "billing_interval", "value": "1", "disabled": true }, { "key": "billing_frequency", "value": "daily", "disabled": true, "description": "yearly | monthly | weekly | daily" }, { "key": "installment_amount", "value": "200", "disabled": true }, { "key": "total_terms", "value": "12", "disabled": true } ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "if (Array.isArray(json.data) && json.data[0]?.contract_details?.subscription_id) {", " pm.collectionVariables.set('contract-subscription-id', json.data[0].contract_details.subscription_id);", " console.log('Saved contract-subscription-id:', json.data[0].contract_details.subscription_id);", "}" ], "type": "text/javascript" } } ] }, { "name": "CANCEL SUBSCRIPTION", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"subscription_id\": \"{{contract-subscription-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{subscriptions-url}}/contract/cancel_subscription", "host": [ "{{subscriptions-url}}" ], "path": [ "contract", "cancel_subscription" ] } }, "response": [] } ] }, { "name": "Subscribers", "item": [ { "name": "DETAILS", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}" }, { "key": "merchant-secret", "value": "{{subscription-secret}}" } ], "url": { "raw": "{{subscriptions-url}}/subscriber/details?data_id={{subscriber-data-id}}", "host": [ "{{subscriptions-url}}" ], "path": [ "subscriber", "details" ], "query": [ { "key": "data_id", "value": "{{subscriber-data-id}}", "description": "Encrypted subscriber ID from Subscriber LIST" } ] } }, "response": [] }, { "name": "LIST", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{subscription-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{subscription-secret}}", "type": "text" } ], "url": { "raw": "{{subscriptions-url}}/subscriber/list?perpage=10&page=1", "host": [ "{{subscriptions-url}}" ], "path": [ "subscriber", "list" ], "query": [ { "key": "perpage", "value": "10", "description": "Required" }, { "key": "page", "value": "1", "description": "Required" }, { "key": "subscriber_email_mobile", "value": "", "disabled": true, "description": "Filter by email or mobile" }, { "key": "subscriber_id", "value": "", "disabled": true, "description": "Plain display subscriber ID (integer)" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "if (Array.isArray(json.data) && json.data[0]?.data_id) {", " pm.collectionVariables.set('subscriber-data-id', json.data[0].data_id);", " console.log('Saved subscriber-data-id:', json.data[0].data_id);", "}" ], "type": "text/javascript" } } ] } ] } ], "description": "Subscription Open API (service-open-subscription). Base URL: {{subscriptions-url}}. Use Subscription channel merchant-key and merchant-secret. Run Plan LIST or ADD first to populate {{plan-data-id}}; Contract LIST populates {{contract-subscription-id}}; Subscriber LIST populates {{subscriber-data-id}}." }, { "name": "Invoices", "item": [ { "name": "Line Items", "item": [ { "name": "ADD", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}" }, { "key": "merchant-secret", "value": "{{invoice-secret}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"item_name\": \"Apple1x1\",\r\n \"item_rate_per_unit\": \"1000\",\r\n \"item_category\": \"Electronic\",\r\n \"item_description\": \"This is the invoice item.\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/items/add", "host": [ "{{invoices-url}}" ], "path": [ "items", "add" ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const id = json && json.data && json.data.data_id;", "if (id) {", " pm.collectionVariables.set('invoice-item-id', id);", " console.log('Saved invoice-item-id:', id);", "}" ], "type": "text/javascript" } } ] }, { "name": "UPDATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-item-id}}\",\r\n \"item_name\": \"Orange\",\r\n \"item_rate_per_unit\": \"1000\",\r\n \"item_category\": \"Electronic\",\r\n \"item_description\": \"This is the invoice item.\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/items/update", "host": [ "{{invoices-url}}" ], "path": [ "items", "update" ] } }, "response": [] }, { "name": "DEACTIVATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-item-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/items/deactivate", "host": [ "{{invoices-url}}" ], "path": [ "items", "deactivate" ] } }, "response": [] }, { "name": "ACTIVATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-item-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/items/activate", "host": [ "{{invoices-url}}" ], "path": [ "items", "activate" ] } }, "response": [] }, { "name": "DELETE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-item-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/items/delete", "host": [ "{{invoices-url}}" ], "path": [ "items", "delete" ] } }, "response": [] }, { "name": "DETAILS", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "url": { "raw": "{{invoices-url}}/items/details?data_id={{invoice-item-id}}", "host": [ "{{invoices-url}}" ], "path": [ "items", "details" ], "query": [ { "key": "data_id", "value": "{{invoice-item-id}}" } ] } }, "response": [] }, { "name": "LIST", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "url": { "raw": "{{invoices-url}}/items/list?perpage=10&page=1&status=", "host": [ "{{invoices-url}}" ], "path": [ "items", "list" ], "query": [ { "key": "perpage", "value": "10" }, { "key": "page", "value": "1" }, { "key": "status", "value": "" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const id = json && json.data && json.data[0] && json.data[0].data_id;", "if (id) {", " pm.collectionVariables.set('invoice-item-id', id);", " console.log('Saved invoice-item-id:', id);", "}" ], "type": "text/javascript" } } ] } ] }, { "name": "Clients", "item": [ { "name": "ADD", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}" }, { "key": "merchant-secret", "value": "{{invoice-secret}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"customer_details\": {\r\n \"name_prefix\": \"Miss\",\r\n \"name\": \"Pooja K\",\r\n \"email\": \"email@company.com\",\r\n \"code\": \"91\",\r\n \"mobile\": \"9991234567\"\r\n },\r\n \"billing_details\": {\r\n \"address\": \"Po Box 12322, address\",\r\n \"country\": \"IN\",\r\n \"state\": \"Maharashtra\",\r\n \"city\": \"Nagpur\",\r\n \"zip_code\": \"44044\"\r\n },\r\n \"shipping_details\": {\r\n \"same_as_billing_address\": \"no\",\r\n \"address\": \"Po Box 12322\",\r\n \"country\": \"IN\",\r\n \"state\": \"Maharashtra\",\r\n \"city\": \"Nagpur\",\r\n \"zip_code\": \"54044\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/customers/add", "host": [ "{{invoices-url}}" ], "path": [ "customers", "add" ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const id = json && json.data && json.data.data_id;", "if (id) {", " pm.collectionVariables.set('invoice-customer-id', id);", " console.log('Saved invoice-customer-id:', id);", "}" ], "type": "text/javascript" } } ] }, { "name": "UPDATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"customer_details\": {\r\n \"data_id\": \"{{invoice-customer-id}}\",\r\n \"name_prefix\": \"Miss\",\r\n \"name\": \"Pooja Kushwaha\",\r\n \"email\": \"pooja@company.com\",\r\n \"code\": \"91\",\r\n \"mobile\": \"9991234567\"\r\n },\r\n \"billing_details\": {\r\n \"address\": \"456 New Street\",\r\n \"country\": \"AE\",\r\n \"state\": \"Dubai\",\r\n \"city\": \"Dubai\",\r\n \"zip_code\": \"12345\"\r\n },\r\n \"shipping_details\": {\r\n \"same_as_billing_address\": \"no\",\r\n \"address\": \"Po Box 12322\",\r\n \"country\": \"IN\",\r\n \"state\": \"Maharashtra\",\r\n \"city\": \"Nagpur\",\r\n \"zip_code\": \"54044\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/customers/update", "host": [ "{{invoices-url}}" ], "path": [ "customers", "update" ] } }, "response": [] }, { "name": "DEACTIVATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-customer-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/customers/deactivate", "host": [ "{{invoices-url}}" ], "path": [ "customers", "deactivate" ] } }, "response": [] }, { "name": "ACTIVATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-customer-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/customers/activate", "host": [ "{{invoices-url}}" ], "path": [ "customers", "activate" ] } }, "response": [] }, { "name": "DELETE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-customer-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/customers/delete", "host": [ "{{invoices-url}}" ], "path": [ "customers", "delete" ] } }, "response": [] }, { "name": "DETAILS", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "url": { "raw": "{{invoices-url}}/customers/details?data_id={{invoice-customer-id}}", "host": [ "{{invoices-url}}" ], "path": [ "customers", "details" ], "query": [ { "key": "data_id", "value": "{{invoice-customer-id}}" } ] } }, "response": [] }, { "name": "LIST", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "url": { "raw": "{{invoices-url}}/customers/list?perpage=10&page=1&status=&name_or_email_mobile=&billing_country=&customer_id=&from_date=&to_date=", "host": [ "{{invoices-url}}" ], "path": [ "customers", "list" ], "query": [ { "key": "perpage", "value": "10" }, { "key": "page", "value": "1" }, { "key": "status", "value": "", "description": "Active | Deactivated" }, { "key": "name_or_email_mobile", "value": "" }, { "key": "billing_country", "value": "", "description": "ISO 3166-1 alpha-2 code" }, { "key": "customer_id", "value": "", "description": "Display customer ID" }, { "key": "from_date", "value": "", "description": "Created date filter (YYYY-MM-DD)" }, { "key": "to_date", "value": "", "description": "Created date filter (YYYY-MM-DD); must be >= from_date" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const id = json && json.data && json.data[0] && json.data[0].data_id;", "if (id) {", " pm.collectionVariables.set('invoice-customer-id', id);", " console.log('Saved invoice-customer-id:', id);", "}" ], "type": "text/javascript" } } ] } ] }, { "name": "Invoices", "item": [ { "name": "ADD", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"currency\": \"AED\",\n \"issue_date\": \"2024-01-20\",\n \"expiry_date\": \"2024-10-20\",\n \"customer_id\": \"{{invoice-customer-id}}\",\n \"merchant_invoice_no\": \"INV0025\",\n \"shipping_fee\": \"5\",\n \"shipping_vat_rate\": \"10\",\n \"convenience_fee\": \"5\",\n \"convenience_vat_rate\": \"10\",\n \"item_data\": [\n {\n \"data_id\": \"{{invoice-item-id}}\",\n \"rate\": \"200\",\n \"quantity\": \"5\",\n \"discount\": \"10.00\",\n \"tax\": \"11.34\"\n },\n {\n \"data_id\": \"{{invoice-item-id}}\",\n \"rate\": \"1000.00\",\n \"quantity\": \"1\",\n \"discount\": \"10\",\n \"tax\": \"10.00\"\n }\n ],\n \"description\": \"This is the invoice.\",\n \"note\": \"Note\",\n \"payment_terms\": \"terms\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/add", "host": [ "{{invoices-url}}" ], "path": [ "add" ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const id = json && json.data && json.data[0] && json.data[0].data_id;", "if (id) {", " pm.collectionVariables.set('invoice-data-id', id);", " console.log('Saved invoice-data-id:', id);", "}" ], "type": "text/javascript" } } ] }, { "name": "UPDATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data_id\": \"{{invoice-data-id}}\",\n \"currency\": \"AED\",\n \"issue_date\": \"2024-01-20\",\n \"expiry_date\": \"2024-09-20\",\n \"customer_id\": \"{{invoice-customer-id}}\",\n \"merchant_invoice_no\": \"INFE23232\",\n \"shipping_fee\": \"5\",\n \"shipping_vat_rate\": \"10\",\n \"convenience_fee\": \"5\",\n \"convenience_vat_rate\": \"10\",\n \"item_data\": [\n {\n \"data_id\": \"{{invoice-item-id}}\",\n \"rate\": \"320\",\n \"quantity\": \"1\",\n \"discount\": \"10.00\",\n \"tax\": \"11.34\"\n }\n ],\n \"description\": \"This is the payment link.\",\n \"note\": \"Note\",\n \"payment_terms\": \"Payment terms\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/update", "host": [ "{{invoices-url}}" ], "path": [ "update" ] } }, "response": [] }, { "name": "CANCEL", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-data-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/cancel", "host": [ "{{invoices-url}}" ], "path": [ "cancel" ] } }, "response": [] }, { "name": "SEND INVOICE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-data-id}}\",\r\n \"cc_email\":\"\",\r\n \"subject\":\"Merchant Invoice Ref. INFE23232\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/send", "host": [ "{{invoices-url}}" ], "path": [ "send" ] } }, "response": [] }, { "name": "DELETE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data_id\": \"{{invoice-data-id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{invoices-url}}/delete", "host": [ "{{invoices-url}}" ], "path": [ "delete" ] } }, "response": [] }, { "name": "DETAILS", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "url": { "raw": "{{invoices-url}}/details?data_id={{invoice-data-id}}", "host": [ "{{invoices-url}}" ], "path": [ "details" ], "query": [ { "key": "data_id", "value": "{{invoice-data-id}}" } ] } }, "response": [] }, { "name": "LIST", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{invoice-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{invoice-secret}}", "type": "text" } ], "url": { "raw": "{{invoices-url}}/list?status=&perpage=10&page=1&expiry_from_date=&expiry_to_date=&email=&mobile=¤cy=&customer_id=&invoice_no=", "host": [ "{{invoices-url}}" ], "path": [ "list" ], "query": [ { "key": "status", "value": "" }, { "key": "perpage", "value": "10" }, { "key": "page", "value": "1" }, { "key": "expiry_from_date", "value": "" }, { "key": "expiry_to_date", "value": "" }, { "key": "email", "value": "" }, { "key": "mobile", "value": "" }, { "key": "currency", "value": "" }, { "key": "customer_id", "value": "" }, { "key": "invoice_no", "value": "" } ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const id = json && json.data && json.data[0] && json.data[0].data_id;", "if (id) {", " pm.collectionVariables.set('invoice-data-id', id);", " console.log('Saved invoice-data-id:', id);", "}" ], "type": "text/javascript" } } ] } ] } ] }, { "name": "S2S APIs", "item": [ { "name": "Payment", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"AUTH\",\n \"class\": \"ECOM\",\n \"capture_method\": \"MANUAL\",\n \"payment_token\": \"\",\n \"type\": \"CARD\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"john.d@gmail.com\",\n \"mobile\": \"987654321\",\n \"code\": \"971\"\n },\n \"order_details\": {\n \"m_order_id\": \"123460\",\n \"amount\": \"1\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"233\",\n \"description\": \"description\",\n \"return_url\": \"https://merchant.example.com/return\"\n },\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ],\n \"card_details\": {\n \"card_holder_name\": \"John Doe\",\n \"card_number\": \"4111111111111111\",\n \"cvv\": \"123\",\n \"expiry\": \"04/2026\",\n \"tokenize\": \"0\"\n },\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"5404\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"JOHN\",\n \"shipping_email\": \"shippingemail@test.com\",\n \"shipping_code\": \"91\",\n \"shipping_mobile\": \"9xxxxxxxx\",\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"540445\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": \"56\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] } }, "response": [] }, { "name": "Payment- MOTO", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"AUTH\",\n \"class\": \"MOTO\",\n \"capture_method\": \"MANUAL\",\n \"payment_token\": \"\",\n \"type\": \"CARD\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"john.d@gmail.com\",\n \"mobile\": \"987654321\",\n \"code\": \"971\"\n },\n \"order_details\": {\n \"m_order_id\": \"123460\",\n \"amount\": \"1\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"233\",\n \"description\": \"description\",\n \"return_url\": \"https://merchant.example.com/return\"\n },\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ],\n \"card_details\": {\n \"card_holder_name\": \"John Doe\",\n \"card_number\": \"4111111111111111\",\n \"cvv\": \"123\",\n \"expiry\": \"04/2026\",\n \"tokenize\": \"0\"\n },\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"5404\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"JOHN\",\n \"shipping_email\": \"shippingemail@test.com\",\n \"shipping_code\": \"91\",\n \"shipping_mobile\": \"9xxxxxxxx\",\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"540445\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": \"56\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] } }, "response": [] }, { "name": "Payment-CAUTH", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"SALE\",\n \"class\": \"CAUTH\",\n \"capture_method\": \"AUTOMATIC\",\n \"payment_token\": \"\",\n \"type\": \"CARD\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"john.d@gmail.com\",\n \"mobile\": \"987654321\",\n \"code\": \"971\"\n },\n \"order_details\": {\n \"m_order_id\": \"ORD-CAUTH-001\",\n \"amount\": \"10\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"0\",\n \"description\": \"Subscription charge\",\n \"return_url\": \"https://merchant.example.com/return\"\n },\n \"items\": [\n {\n \"title\": \"Monthly plan\",\n \"quantity\": 1,\n \"unit_price\": \"10.00\",\n \"discount_amount\": \"0.00\",\n \"is_refundable\": true\n }\n ],\n \"card_details\": {\n \"payment_token\": \"REPLACE_WITH_PAYMENT_TOKEN_FROM_AUTH_REVERSAL\"\n },\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"5404\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"JOHN\",\n \"shipping_email\": \"shippingemail@test.com\",\n \"shipping_code\": \"91\",\n \"shipping_mobile\": \"9xxxxxxxx\",\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"540445\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": \"56\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] }, "description": "S2S Pay by Token (CAUTH). Full payment body required. payment_token must be inside card_details (not top-level). Requires m_customer_id matching the token and merchant_id from API credentials. PSP routed from stored mandate: Telr, Paymob, or NI." }, "response": [] }, { "name": "SADAD", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"SALE\",\n \"class\": \"ECOM\",\n \"capture_method\": \"MANUAL\",\n \"payment_token\": \"\",\n \"type\": \"SADAD\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"john.d@gmail.com\",\n \"mobile\": \"500000001\",\n \"code\": \"966\"\n },\n \"order_details\": {\n \"m_order_id\": \"123460\",\n \"amount\": \"1\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"233\",\n \"description\": \"description\",\n \"return_url\": \"http://localhost/status\"\n },\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ],\n \"sadad_details\": {\n \"bill_type\": \"0\",\n \"nat_id\": \"1123456789\",\n \"dob\": \"2020/01/01\",\n \"father_name\": \"john\",\n \"grand_father_name\": \"john\"\n },\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"5404\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"JOHN\",\n \"shipping_email\": \"shippingemail@test.com\",\n \"shipping_code\": \"91\",\n \"shipping_mobile\": \"9xxxxxxxx\",\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"540445\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": \"56\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] } }, "response": [] }, { "name": "URPAY", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"SALE\",\n \"class\": \"ECOM\",\n \"capture_method\": \"MANUAL\",\n \"payment_token\": \"\",\n \"type\": \"URPAY\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"john.d@gmail.com\",\n \"mobile\": \"500000001\",\n \"code\": \"966\"\n },\n \"order_details\": {\n \"m_order_id\": \"123460\",\n \"amount\": \"1\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"233\",\n \"description\": \"description\",\n \"return_url\": \"http://localhost/status\"\n },\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ],\n \"urpay_details\": {\n \"id\": \"\"\n },\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"5404\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"JOHN\",\n \"shipping_email\": \"shippingemail@test.com\",\n \"shipping_code\": \"91\",\n \"shipping_mobile\": \"9xxxxxxxx\",\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"540445\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": \"56\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] } }, "response": [] }, { "name": "STCPAY", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"SALE\",\n \"class\": \"ECOM\",\n \"capture_method\": \"MANUAL\",\n \"payment_token\": \"\",\n \"type\": \"STCPAY\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"john.d@gmail.com\",\n \"mobile\": \"500000001\",\n \"code\": \"966\"\n },\n \"order_details\": {\n \"m_order_id\": \"123460\",\n \"amount\": \"1\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"233\",\n \"description\": \"description\",\n \"return_url\": \"http://localhost/status\"\n },\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ],\n \"stcpay_details\": {\n \"id\": \"\"\n },\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"5404\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_code\": \"\",\n \"shipping_mobile\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"pin\": \"\",\n \"shipping_currency\": \"\",\n \"shipping_amount\": \"\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] } }, "response": [] }, { "name": "TABBY", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"AUTH\",\n \"class\": \"ECOM\",\n \"capture_method\": \"MANUAL\",\n \"payment_token\": \"\",\n \"type\": \"TABBY\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"otp.success@tabby.ai\",\n \"mobile\": \"500000001\",\n \"code\": \"971\"\n },\n \"order_details\": {\n \"m_order_id\": \"123460\",\n \"amount\": \"1\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"233\",\n \"description\": \"description\",\n \"return_url\": \"http://localhost/status\"\n },\n \"items\": [\n {\n \"title\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1,\n \"unit_price\": \"0.00\",\n \"discount_amount\": \"0.00\",\n \"reference_id\": \"string\",\n \"image_url\": \"http://example.com\",\n \"product_url\": \"http://example.com\",\n \"gender\": \"Male\",\n \"category\": \"string\",\n \"color\": \"string\",\n \"product_material\": \"string\",\n \"size_type\": \"string\",\n \"size\": \"string\",\n \"brand\": \"string\",\n \"is_refundable\": true\n }\n ],\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"5404\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"JOHN\",\n \"shipping_email\": \"shippingemail@test.com\",\n \"shipping_code\": \"91\",\n \"shipping_mobile\": \"9xxxxxxxx\",\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"Jebel Ali Free Zone\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"540445\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": \"56\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] } }, "response": [] }, { "name": "Apple Pay", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"SALE\",\n \"class\": \"ECOM\",\n \"capture_method\": \"AUTOMATIC\",\n \"type\": \"APPLE_PAY\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"john.d@gmail.com\",\n \"mobile\": \"987654321\",\n \"code\": \"971\"\n },\n \"order_details\": {\n \"m_order_id\": \"ORD-APPLE-001\",\n \"amount\": \"100\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"0\",\n \"description\": \"Apple Pay order\",\n \"return_url\": \"https://merchant.example.com/return\"\n },\n \"items\": [\n {\n \"title\": \"Product\",\n \"quantity\": 1,\n \"unit_price\": \"100.00\",\n \"discount_amount\": \"0.00\",\n \"is_refundable\": true\n }\n ],\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"John Doe\",\n \"shipping_email\": \"shippingemail@test.com\",\n \"shipping_code\": \"971\",\n \"shipping_mobile\": \"9876543210\",\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": \"0\"\n },\n \"token\": {\n \"paymentData\": {\n \"data\": \"BASE64_ENCRYPTED_DATA\",\n \"signature\": \"BASE64_SIGNATURE\",\n \"header\": {\n \"publicKeyHash\": \"HASH\",\n \"ephemeralPublicKey\": \"BASE64_KEY\",\n \"transactionId\": \"TXN_ID\"\n },\n \"version\": \"EC_v1\"\n },\n \"paymentMethod\": {\n \"displayName\": \"Visa 1234\",\n \"network\": \"Visa\",\n \"type\": \"credit\"\n },\n \"transactionIdentifier\": \"APPLE_TXN_ID\"\n },\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] }, "description": "S2S Apple Pay. type: APPLE_PAY, token in data.token (not card_details). PSP: Telr or Paymob." }, "response": [] }, { "name": "Google Pay", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"action\": \"SALE\",\n \"class\": \"ECOM\",\n \"capture_method\": \"AUTOMATIC\",\n \"type\": \"GOOGLE_PAY\",\n \"customer_details\": {\n \"m_customer_id\": \"1234\",\n \"name\": \"John Doe\",\n \"email\": \"john.d@gmail.com\",\n \"mobile\": \"987654321\",\n \"code\": \"971\"\n },\n \"order_details\": {\n \"m_order_id\": \"ORD-GPAY-001\",\n \"amount\": \"100\",\n \"currency\": \"AED\",\n \"convenience_fee\": \"0\",\n \"description\": \"Google Pay order\",\n \"return_url\": \"https://merchant.example.com/return\"\n },\n \"items\": [\n {\n \"title\": \"Product\",\n \"quantity\": 1,\n \"unit_price\": \"100.00\",\n \"discount_amount\": \"0.00\",\n \"is_refundable\": true\n }\n ],\n \"billing_details\": {\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"John Doe\",\n \"shipping_email\": \"shippingemail@test.com\",\n \"shipping_code\": \"971\",\n \"shipping_mobile\": \"9876543210\",\n \"address_line1\": \"Po Box 12322\",\n \"address_line2\": \"\",\n \"city\": \"Dubai\",\n \"province\": \"Dubai\",\n \"country\": \"AE\",\n \"pin\": \"54044\",\n \"shipping_currency\": \"AED\",\n \"shipping_amount\": \"0\"\n },\n \"token\": {\n \"apiVersion\": 2,\n \"apiVersionMinor\": 0,\n \"paymentMethodData\": {\n \"description\": \"Visa \u2022\u2022\u2022\u2022 1234\",\n \"tokenizationData\": {\n \"type\": \"PAYMENT_GATEWAY\",\n \"token\": \"GOOGLE_PAY_TOKEN_JSON_STRING\"\n },\n \"type\": \"CARD\"\n }\n },\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"https://merchant.example.com/webhook\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/payment", "host": [ "{{s2s-url}}" ], "path": [ "payment" ] }, "description": "S2S Google Pay. type: GOOGLE_PAY, token in data.token. May return redirect_url for 3DS." }, "response": [] }, { "name": "Capture", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"CAPTURE\",\n \"transaction_id\": \"REPLACE_WITH_TRANSACTION_ID\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 100\n },\n \"reason\": \"Order shipped - full capture\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/orders/transaction", "host": [ "{{s2s-url}}" ], "path": [ "orders", "transaction" ] }, "description": "S2S capture. Validated in service-s2s, forwarded to connector-switch `/transaction/followups`. Same flat body as hosted manage payment." }, "response": [] }, { "name": "Void", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"VOID\",\n \"transaction_id\": \"REPLACE_WITH_TRANSACTION_ID\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 100\n },\n \"reason\": \"Customer cancelled before capture\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/orders/transaction", "host": [ "{{s2s-url}}" ], "path": [ "orders", "transaction" ] }, "description": "S2S void. Same request shape as hosted Capture/Void/Refund." }, "response": [] }, { "name": "Refund", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"REFUND\",\n \"transaction_id\": \"REPLACE_WITH_TRANSACTION_ID\",\n \"amount\": {\n \"currencyCode\": \"AED\",\n \"value\": 100\n },\n \"reason\": \"Customer return - full refund\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{s2s-url}}/orders/transaction", "host": [ "{{s2s-url}}" ], "path": [ "orders", "transaction" ] }, "description": "S2S refund. Response uses unified data shape (status, m_order_id, p_order_id, transaction_id, amount, currency, date)." }, "response": [] }, { "name": "Fetch Order", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{s2s-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{s2s-secret}}", "type": "text" } ], "url": { "raw": "{{s2s-url}}/orders/{{p_order_id}}", "host": [ "{{s2s-url}}" ], "path": [ "orders", "{{p_order_id}}" ] }, "description": "Fetch S2S order/transaction details by PayOrc order ID (path param). Requires S2S API credentials + IP whitelist." }, "response": [] } ] }, { "name": "Settlements", "description": "Settlement Open API (service-settlements). Base URL: {{settlement-url}}. Uses the HOSTED channel merchant-key/merchant-secret. NOTE: Settlement APIs are available in live mode only; test/sandbox credentials return \"Settlement is not available for test mode.\"", "item": [ { "name": "SETTLEMENT DETAILS", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" } ], "url": { "raw": "{{settlement-url}}/details?settlement_id=1000010002", "host": [ "{{settlement-url}}" ], "path": [ "details" ], "query": [ { "key": "settlement_id", "value": "1000010002", "description": "Required. Settlement/payout ID to fetch details for." } ] } }, "response": [] }, { "name": "SETTLEMENT LIST", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" } ], "url": { "raw": "{{settlement-url}}/list", "host": [ "{{settlement-url}}" ], "path": [ "list" ] } }, "response": [] }, { "name": "SETTLEMENT PENDING LIST", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" } ], "url": { "raw": "{{settlement-url}}/pending/list", "host": [ "{{settlement-url}}" ], "path": [ "pending", "list" ] } }, "response": [] }, { "name": "SETTLEMENT DUE LIST", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" } ], "url": { "raw": "{{settlement-url}}/due/list", "host": [ "{{settlement-url}}" ], "path": [ "due", "list" ] } }, "response": [] }, { "name": "SETTLEMENT INFO", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{hosted-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{hosted-secret}}", "type": "text" } ], "url": { "raw": "{{settlement-url}}/info?mid_label=my-store", "host": [ "{{settlement-url}}" ], "path": [ "info" ], "query": [ { "key": "mid_label", "value": "my-store", "description": "Required. The MID Label name." } ] } }, "response": [] } ] }, { "name": "Payouts", "description": "Payout API (service-payouts). Base URL: {{payout-url}} (= https://payout.payorc.com/v1). Live-only: payout-key/payout-secret on GET /token, then Bearer {{payout-bearer-token}} on all other requests.", "item": [ { "name": "CREATE TOKEN", "event": [ { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "const token = json && json.data && json.data.token;", "if (token) {", " pm.collectionVariables.set('payout-bearer-token', token);", " console.log('Saved payout-bearer-token');", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{payout-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{payout-secret}}", "type": "text" } ], "url": { "raw": "{{payout-url}}/token", "host": [ "{{payout-url}}" ], "path": [ "token" ] } }, "response": [] }, { "name": "TRANSFER", "event": [ { "listen": "prerequest", "script": { "exec": [ "const body = {", " reference_no: pm.collectionVariables.get('payout-reference-no') || 'REF-001',", " payment_mode: 'NEFT',", " amount: '100.00',", " remark: 'Test payout',", " currency: 'INR',", " callback_url: 'https://your.site/webhooks/payout',", " beneficiary: {", " account_number: '200060539673',", " account_type: 'SA',", " ifsc: 'INDB0000539',", " branch: '',", " name: 'John Doe',", " email: 'johndoe@gmail.com',", " mobile: '9876543210',", " mmid: '',", " lei_code: '',", " nre_flag: 'EX'", " }", "};", "const b = body.beneficiary;", "const canonical = [", " body.reference_no, body.amount, body.currency,", " body.payment_mode, b.account_number, b.account_type, body.callback_url", "].join('|');", "const checksum = CryptoJS.SHA256(canonical).toString();", "body.checksum = checksum;", "pm.collectionVariables.set('payout-transfer-body', JSON.stringify(body, null, 2));", "pm.collectionVariables.set('payout-checksum', checksum);" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "const json = pm.response.json();", "if (json && json.data) {", " if (json.data.reference_no) {", " pm.collectionVariables.set('payout-reference-no', json.data.reference_no);", " console.log('Saved payout-reference-no:', json.data.reference_no);", " }", " if (json.data.transaction_id) {", " pm.collectionVariables.set('payout-transaction-id', json.data.transaction_id);", " console.log('Saved payout-transaction-id:', json.data.transaction_id);", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{payout-bearer-token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{{payout-transfer-body}}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{payout-url}}/transfer", "host": [ "{{payout-url}}" ], "path": [ "transfer" ] } }, "response": [] }, { "name": "PAYOUT STATUS", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{payout-bearer-token}}", "type": "text" } ], "url": { "raw": "{{payout-url}}/status/{{payout-reference-no}}", "host": [ "{{payout-url}}" ], "path": [ "status", "{{payout-reference-no}}" ] } }, "response": [] }, { "name": "PAYOUT STATEMENT", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{payout-bearer-token}}", "type": "text" } ], "url": { "raw": "{{payout-url}}/statement?perpage=10&page=1", "host": [ "{{payout-url}}" ], "path": [ "statement" ], "query": [ { "key": "payout_id", "value": "{{payout-transaction-id}}", "description": "Optional. Filter by PayOrc transaction ID.", "disabled": true }, { "key": "reference_no", "value": "{{payout-reference-no}}", "description": "Optional. Filter by merchant reference.", "disabled": true }, { "key": "status", "value": "queued", "description": "Optional. queued, processing, success, failed, cancelled.", "disabled": true }, { "key": "from_date", "value": "2026-01-01", "description": "Optional. YYYY-MM-DD.", "disabled": true }, { "key": "to_date", "value": "2026-12-31", "description": "Optional. YYYY-MM-DD.", "disabled": true }, { "key": "perpage", "value": "10" }, { "key": "page", "value": "1" } ] } }, "response": [] }, { "name": "BALANCE", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{payout-bearer-token}}", "type": "text" } ], "url": { "raw": "{{payout-url}}/balance?currency=INR", "host": [ "{{payout-url}}" ], "path": [ "balance" ], "query": [ { "key": "currency", "value": "INR" } ] } }, "response": [] }, { "name": "BULK PAYOUT", "event": [ { "listen": "prerequest", "script": { "exec": [ "const requestId = pm.collectionVariables.get('payout-bulk-request-id') || 'REQ-001';", "const callbackUrl = 'https://your.site/webhooks/payout';", "const remark = 'Bulk test';", "const canonical = [requestId, callbackUrl, remark].join('|');", "const checksum = CryptoJS.SHA256(canonical).toString();", "pm.collectionVariables.set('payout-bulk-checksum', checksum);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{payout-bearer-token}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "request_id", "value": "{{payout-bulk-request-id}}", "type": "text" }, { "key": "currency", "value": "INR", "type": "text" }, { "key": "payout_file", "type": "file", "src": [], "description": "Excel file with bulk payout rows" }, { "key": "callback_url", "value": "https://your.site/webhooks/payout", "type": "text" }, { "key": "remark", "value": "Bulk test", "type": "text" }, { "key": "checksum", "value": "{{payout-bulk-checksum}}", "type": "text" } ] }, "url": { "raw": "{{payout-url}}/bulk/payouts", "host": [ "{{payout-url}}" ], "path": [ "bulk", "payouts" ] } }, "response": [] } ] }, { "name": "POS", "item": [ { "name": "PAYMENT", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{posweb-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{posweb-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"customer_details\": {\n \"m_customer_id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"code\": \"\"\n },\n \"order_details\": {\n \"pos_terminal_id\": \"E3929707\",\n \"txn_type\": \"CARD\",// UPI\n \"m_order_id\": \"\",\n \"amount\": \"1\",\n \"quantity\": \"\",\n \"convenience_fee\": \"\",\n \"currency\": \"INR\",\n \"description\": \"\"\n },\n \"billing_details\": {\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"pin\": \"\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_code\": \"\",\n \"shipping_mobile\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"pin\": \"\",\n \"location_pin\": \"\",\n \"shipping_currency\": \"\",\n \"shipping_amount\": \"\"\n },\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{pos-url}}/payment", "host": [ "{{pos-url}}" ], "path": [ "payment" ] } }, "response": [] }, { "name": "ORDERS CREATE", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{posweb-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{posweb-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"customer_details\": {\n \"m_customer_id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"code\": \"\"\n },\n \"order_details\": {\n \"m_order_id\": \"\",\n \"amount\": \"1\",\n \"quantity\": \"\",\n \"convenience_fee\": \"\",\n \"currency\": \"INR\",\n \"description\": \"\"\n },\n \"billing_details\": {\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"pin\": \"\"\n },\n \"shipping_details\": {\n \"shipping_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_code\": \"\",\n \"shipping_mobile\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"country\": \"\",\n \"pin\": \"\",\n \"location_pin\": \"\",\n \"shipping_currency\": \"\",\n \"shipping_amount\": \"\"\n },\n \"urls\": {\n \"success\": \"\",\n \"cancel\": \"\",\n \"failure\": \"\",\n \"webhook_url\": \"\"\n },\n \"parameters\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ],\n \"custom_data\": [\n {\n \"alpha\": \"\"\n },\n {\n \"beta\": \"\"\n },\n {\n \"gamma\": \"\"\n },\n {\n \"delta\": \"\"\n },\n {\n \"epsilon\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{pos-url}}/orders", "host": [ "{{pos-url}}" ], "path": [ "orders" ] } }, "response": [] }, { "name": "INITIATE PAYMENT", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{posweb-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{posweb-secret}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"order_id\": \"1000010035\",\n \"pos_terminal_id\": \"E3929707\",\n \"txn_type\": \"CARD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{pos-url}}/initiate-payment", "host": [ "{{pos-url}}" ], "path": [ "initiate-payment" ] } }, "response": [] }, { "name": "GET ORDER", "request": { "method": "GET", "header": [ { "key": "merchant-key", "value": "{{posweb-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{posweb-secret}}", "type": "text" } ], "url": { "raw": "{{pos-url}}/orders/{{p_order_id}}", "host": [ "{{pos-url}}" ], "path": [ "orders", "{{p_order_id}}" ] } }, "response": [] }, { "name": "CANCEL ORDER", "request": { "method": "POST", "header": [ { "key": "merchant-key", "value": "{{posweb-key}}", "type": "text" }, { "key": "merchant-secret", "value": "{{posweb-secret}}", "type": "text" } ], "url": { "raw": "{{pos-url}}/orders/{{p_order_id}}/cancel", "host": [ "{{pos-url}}" ], "path": [ "orders", "{{p_order_id}}", "cancel" ] } }, "response": [] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "orders-url", "value": "https://api.payorc.com/orders/v1" }, { "key": "payment-links-url", "value": "https://api.payorc.com/payment-links/v1" }, { "key": "subscriptions-url", "value": "https://api.payorc.com/subscriptions/v1" }, { "key": "invoices-url", "value": "https://api.payorc.com/invoice/v1" }, { "key": "s2s-url", "value": "https://api.payorc.com/s2s/v1" }, { "key": "settlement-url", "value": "https://api.payorc.com/settlements/v1" }, { "key": "pos-url", "value": "https://api.payorc.com/pos/v1" }, { "key": "hosted-key", "value": "YOUR_HOSTED_KEY" }, { "key": "hosted-secret", "value": "YOUR_HOSTED_SECRET" }, { "key": "paymentlink-key", "value": "YOUR_PAYMENTLINK_KEY" }, { "key": "paymentlink-secret", "value": "YOUR_PAYMENTLINK_SECRET" }, { "key": "subscription-key", "value": "YOUR_SUBSCRIPTION_KEY" }, { "key": "subscription-secret", "value": "YOUR_SUBSCRIPTION_SECRET" }, { "key": "invoice-key", "value": "YOUR_INVOICE_KEY" }, { "key": "invoice-secret", "value": "YOUR_INVOICE_SECRET" }, { "key": "s2s-key", "value": "YOUR_S2S_KEY" }, { "key": "s2s-secret", "value": "YOUR_S2S_SECRET" }, { "key": "posweb-key", "value": "YOUR_POSWEB_KEY" }, { "key": "posweb-secret", "value": "YOUR_POSWEB_SECRET" }, { "key": "p_order_id", "value": "1000011812" }, { "key": "plan-data-id", "value": "", "description": "Encrypted plan data_id from ADD or Plan LIST" }, { "key": "contract-subscription-id", "value": "", "description": "Encrypted subscription_id from Contract LIST" }, { "key": "subscriber-data-id", "value": "", "description": "Encrypted data_id from Subscriber LIST" }, { "key": "paymentlink-data-id", "value": "", "description": "Encrypted data_id captured from Payment Links ADD/LIST" }, { "key": "invoice-item-id", "value": "", "description": "Encrypted data_id captured from Invoice Line Items ADD/LIST" }, { "key": "invoice-customer-id", "value": "", "description": "Encrypted data_id captured from Invoice Clients ADD/LIST" }, { "key": "invoice-data-id", "value": "", "description": "Encrypted data_id captured from Invoices ADD/LIST" }, { "key": "payout-url", "value": "https://payout.payorc.com/v1" }, { "key": "payout-key", "value": "YOUR_PAYOUT_KEY" }, { "key": "payout-secret", "value": "YOUR_PAYOUT_SECRET" }, { "key": "payout-bearer-token", "value": "", "description": "JWT from CREATE TOKEN" }, { "key": "payout-reference-no", "value": "REF-001", "description": "Merchant reference from TRANSFER" }, { "key": "payout-transaction-id", "value": "", "description": "PayOrc transaction_id from TRANSFER" }, { "key": "payout-bulk-request-id", "value": "REQ-001", "description": "Unique bulk upload request_id" }, { "key": "payout-checksum", "value": "", "description": "Auto-computed transfer checksum" }, { "key": "payout-bulk-checksum", "value": "", "description": "Auto-computed bulk checksum" }, { "key": "payout-transfer-body", "value": "", "description": "Auto-built transfer JSON body" } ] }