Secret API Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Acccount Id
\n"},{"key":"x-signature","value":"{{x-signature}}","description":"Generate body payload hash using the API signature key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 500,\n \"currency\": \"PKR\",\n \"payment_method_types\": \"card\",\n \"customer\": {\n \"name\": \"Necibe Mirzai\",\n \"email\": \"necibe.mirzai@xstak.com\",\n \"phone\": \"905374182171\",\n \"vip_customer\": \"No\", // optional\n \"previous_customer\": \"false\" // optional\n },\n \"shipping\": {\n // Omit the entire `shipping` object if shipping details are not required\n \"address1\": \"Model Town Block C\", // optional\n \"city\": \"Karachi\", // optional\n \"country\": \"Pakistan\", // optional\n \"zip\": \"75500\", // optional\n \"shipping_method\": \"Standard\", // optional\n \"province\": \"Punjab\" // optional\n },\n \"billingAddress\": {\n // Omit the entire `billingAddress` object if billing details are not required\n \"address1\": \"DHA Phase 2\", // optional\n \"city\": \"Islamabad\", // optional\n \"country\": \"Pakistan\", // optional\n \"zip\": \"44000\", // optional\n \"shipping_method\": \"Standard\", // optional\n \"province\": \"Islamabad\" // optional\n },\n \"product\": {\n // Omit the entire `product` object if product details are not required\n \"product_category\": \"Transport\", // optional\n \"product_name\": \"Intercity Travel\", // optional\n \"no_of_items\": \"2\" // optional\n },\n \"gateway_instance_id\": \"gateway_pk_01\", // Add when routing payment through a specific gateway instance\n \"metadata\": {\n \"order_reference\": \"3242424234r23er\",\n \"check_network_blocklist\": false, // Add to check whether the user/network is blocked at XPay level\n \"skip_blocklist\": true, // Add when blocklist is enabled but should be skipped\n \"continue_payment\": true // Add when token limit is exceeded but payment should continue\n }\n}"},"url":"{{base_url}}/public/v1/payment/intent","description":"XPay considers the order ID as idempotency key and once a PI is created using an order ID, the subsequent create PI API calls with the same order ID will return the object returned on the first attempt.
\nSo, if you want to update the amount or another value after a PI is created, the update PI API is to be used.
\nYou can add multiple PSPs in XPay. Add a gateway instance in the store gateway settings and add the ID of the instance in the gateway_instance_id field. By adding this you can support multiple payment gateways and MIDs for currencies on the same XPay account.
\nTo authorize an amount and capture it later, add the following in the PI API payload.
\n\"capture_method\": \"manual\"\n\nSecret API Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"},{"key":"x-signature","value":"{{x-signature}}","description":"Generate body payload hash using the API signature key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10 //only add an amount if you need to capture partial amount.\n}"},"url":"{{base_url}}/public/v1/payment/intent/capture?pi_client_secret={{pi_client_secret}}","description":"This API allows you to capture funds against a payment that has already been successfully authorized, completing the transaction by transferring the authorized amount to the merchant.
\n","urlObject":{"path":["public","v1","payment","intent","capture"],"host":["{{base_url}}"],"query":[{"key":"pi_client_secret","value":"{{pi_client_secret}}"}],"variable":[]}},"response":[{"id":"58e6bf20-1393-48f8-ac53-d94e63e01534","name":"Capture an authorized amount","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"x-signature","value":"{{x-signature}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10 //only add an amount if you need to capture partial amount.\n}"},"url":{"raw":"{{base_url}}/public/v1/payment/intent/capture?pi_client_secret={{pi_client_secret}}","host":["{{base_url}}"],"path":["public","v1","payment","intent","capture"],"query":[{"key":"pi_client_secret","value":"{{pi_client_secret}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 09 Jan 2026 10:01:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2118"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com data:; img-src 'self' https://js.xstak.com data:; require-trusted-types-for 'script';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"846-pJNz3itPsCEXh+sALoGD4BHf3Es\""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"responseStatus\": \"OK\",\n \"message\": \"Request processed successfully.\",\n \"data\": {\n \"_id\": \"xpay_pi_439da7d745c851457f347d6e840abc2177d3d33febc32d3599d4d089260e8ad5\",\n \"pi_client_secret\": \"xpay_pi_439da7d745c851457f347d6e840abc2177d3d33febc32d3599d4d089260e8ad5_cs_912161d25e980fc4add787dc97c53e53ba409a1847ab42e63b7524ee4ba22d59\",\n \"created_at\": \"2026-01-09T10:01:10.273Z\",\n \"last_update\": \"2026-01-09T10:01:27.318Z\",\n \"amount\": 500,\n \"currency\": \"PKR\",\n \"refund\": {\n \"refunded_amount\": 0,\n \"refund_object_id\": null\n },\n \"object_name\": \"payment_intent\",\n \"payment_method_types\": \"card\",\n \"customer\": {\n \"name\": \"Guest User\",\n \"email\": \"necibe.mirzai@xstak.com\",\n \"phone\": \"905374182171\"\n },\n \"description\": \"\",\n \"pi_status\": \"succeeded\",\n \"pm_token\": \"\",\n \"shipping\": {\n \"address1\": \"Model Town Block C\",\n \"address2\": \"\",\n \"city\": \"Karachi\",\n \"country\": \"Pakistan\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"province\": \"Punjab\",\n \"zip\": \"75500\",\n \"shipping_method\": \"Standard\"\n },\n \"metadata\": {\n \"order_reference\": \"32424ew24e234r23er\",\n \"check_network_blocklist\": false,\n \"skip_blocklist\": true,\n \"continue_payment\": true\n },\n \"token\": \"\",\n \"capture_method\": \"manual\",\n \"return_url\": null,\n \"bank_response\": {},\n \"last_payment_response\": {\n \"error\": false,\n \"status\": \"PAYMENT_PARTIALLY_CAPTURED\",\n \"message\": \"The payment was completed successfully\",\n \"token\": \"\"\n },\n \"encryptionKey\": \"-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAurrqnO+Jr22aprjFycPc\\niYSapjNU2wuUP8Gj37ENopiohrKTukjXrB93q3b1b8rhwqoGwwZrV295jpAEyPeh\\n1e5OAOQotY0jeU5RHxq6etCBTNdt76JwhJj5g+d+l1cvABgLUSHr+C7zSu/hrPc6\\nYnWNlFrCYo/fUJO7mX96b/5x4znqovomrOcclbXs7hCDyazucRCN9TAhPK13pcFy\\n4qxBuud4WHh1btR7E7zQA0zgrtKTjPQVWM83XFygzrWFkmGSVMVH0tDi9opbY38X\\nKw4sa+8B3MHEOH483o3mzPP9SwppZJgk858ANsK+pwhKbYI4hWKdWCkvI3bK8fzK\\nfQIDAQAB\\n-----END PUBLIC KEY-----\\n\",\n \"product\": {\n \"product_name\": \"Intercity Travel\",\n \"product_category\": \"Transport\",\n \"no_of_items\": \"2\",\n \"_id\": \"6960d1e6e8c395c64805bef3\"\n },\n \"billingAddress\": {\n \"address1\": \"DHA Phase 2\",\n \"city\": \"Islamabad\",\n \"country\": \"Pakistan\",\n \"province\": \"Islamabad\",\n \"zip\": \"44000\",\n \"shipping_method\": \"Standard\"\n },\n \"routing_rules_history\": [],\n \"gateway\": \"bank-alfalah\",\n \"subscription\": {},\n \"checkout_page_url\": null,\n \"dqr_data\": null\n }\n}"}],"_postman_id":"3f8de28b-6f1a-448d-8e52-8889cef8b9d3"},{"name":"Retrieve Payment Intent","id":"f3342589-a938-4557-b512-47d3b0f5b3df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret API Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"}],"url":"{{base_url}}/public/v1/payment/intent/details/:pi_id","urlObject":{"path":["public","v1","payment","intent","details",":pi_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"pi_id"}]}},"response":[{"id":"bf4f13a3-c7f2-4cbc-b05f-56d3af3eb5af","name":"Retrieve Payment Intent","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"}],"url":{"raw":"{{base_url}}/public/v1/payment/intent/details/:pi_id","host":["{{base_url}}"],"path":["public","v1","payment","intent","details",":pi_id"],"variable":[{"key":"pi_id","value":"xpay_pi_439da7d745c851457f347d6e840abc2177d3d33febc32d3599d4d089260e8ad5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 09 Jan 2026 10:02:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2118"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com data:; img-src 'self' https://js.xstak.com data:; require-trusted-types-for 'script';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"846-pJNz3itPsCEXh+sALoGD4BHf3Es\""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"responseStatus\": \"OK\",\n \"message\": \"Request processed successfully.\",\n \"data\": {\n \"_id\": \"xpay_pi_439da7d745c851457f347d6e840abc2177d3d33febc32d3599d4d089260e8ad5\",\n \"pi_client_secret\": \"xpay_pi_439da7d745c851457f347d6e840abc2177d3d33febc32d3599d4d089260e8ad5_cs_912161d25e980fc4add787dc97c53e53ba409a1847ab42e63b7524ee4ba22d59\",\n \"created_at\": \"2026-01-09T10:01:10.273Z\",\n \"last_update\": \"2026-01-09T10:01:27.318Z\",\n \"amount\": 500,\n \"currency\": \"PKR\",\n \"refund\": {\n \"refunded_amount\": 0,\n \"refund_object_id\": null\n },\n \"object_name\": \"payment_intent\",\n \"payment_method_types\": \"card\",\n \"customer\": {\n \"name\": \"Guest User\",\n \"email\": \"necibe.mirzai@xstak.com\",\n \"phone\": \"905374182171\"\n },\n \"description\": \"\",\n \"pi_status\": \"succeeded\",\n \"pm_token\": \"\",\n \"shipping\": {\n \"address1\": \"Model Town Block C\",\n \"address2\": \"\",\n \"city\": \"Karachi\",\n \"country\": \"Pakistan\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"province\": \"Punjab\",\n \"zip\": \"75500\",\n \"shipping_method\": \"Standard\"\n },\n \"metadata\": {\n \"order_reference\": \"32424ew24e234r23er\",\n \"check_network_blocklist\": false,\n \"skip_blocklist\": true,\n \"continue_payment\": true\n },\n \"token\": \"\",\n \"capture_method\": \"manual\",\n \"return_url\": null,\n \"bank_response\": {},\n \"last_payment_response\": {\n \"error\": false,\n \"status\": \"PAYMENT_PARTIALLY_CAPTURED\",\n \"message\": \"The payment was completed successfully\",\n \"token\": \"\"\n },\n \"encryptionKey\": \"-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAurrqnO+Jr22aprjFycPc\\niYSapjNU2wuUP8Gj37ENopiohrKTukjXrB93q3b1b8rhwqoGwwZrV295jpAEyPeh\\n1e5OAOQotY0jeU5RHxq6etCBTNdt76JwhJj5g+d+l1cvABgLUSHr+C7zSu/hrPc6\\nYnWNlFrCYo/fUJO7mX96b/5x4znqovomrOcclbXs7hCDyazucRCN9TAhPK13pcFy\\n4qxBuud4WHh1btR7E7zQA0zgrtKTjPQVWM83XFygzrWFkmGSVMVH0tDi9opbY38X\\nKw4sa+8B3MHEOH483o3mzPP9SwppZJgk858ANsK+pwhKbYI4hWKdWCkvI3bK8fzK\\nfQIDAQAB\\n-----END PUBLIC KEY-----\\n\",\n \"product\": {\n \"product_name\": \"Intercity Travel\",\n \"product_category\": \"Transport\",\n \"no_of_items\": \"2\",\n \"_id\": \"6960d1e6e8c395c64805bef3\"\n },\n \"billingAddress\": {\n \"address1\": \"DHA Phase 2\",\n \"city\": \"Islamabad\",\n \"country\": \"Pakistan\",\n \"province\": \"Islamabad\",\n \"zip\": \"44000\",\n \"shipping_method\": \"Standard\"\n },\n \"routing_rules_history\": [],\n \"gateway\": \"bank-alfalah\",\n \"subscription\": {},\n \"checkout_page_url\": null,\n \"dqr_data\": null\n }\n}"}],"_postman_id":"f3342589-a938-4557-b512-47d3b0f5b3df"},{"name":"Delete Payment Intent","id":"0c78b9f7-c2ea-4972-a767-c37de98b87a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"}],"url":"{{base_url}}/public/v1/payment/Intent/:pi_id","urlObject":{"path":["public","v1","payment","Intent",":pi_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":null,"key":"pi_id"}]}},"response":[],"_postman_id":"0c78b9f7-c2ea-4972-a767-c37de98b87a3"},{"name":"Update Payment Intent","id":"6d229498-e1e0-4778-b05d-de6f224e9cef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret API Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"},{"key":"x-signature","value":"{{x-signature}}","description":"Generate body payload hash using the API signature key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/payment/intent/:pi_id","description":"The Payment Intent can only be updated if it's status is either Requires_Action or Requires_Payment_Method
\n","urlObject":{"path":["public","v1","payment","intent",":pi_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"pi_id"}]}},"response":[{"id":"99c719fa-3234-4e6a-9563-00b78d4af645","name":"Update Payment Intent","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"x-signature","value":"{{x-signature}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/public/v1/payment/intent/:pi_id","host":["{{base_url}}"],"path":["public","v1","payment","intent",":pi_id"],"variable":[{"key":"pi_id","value":"xpay_pi_c0979f8b3abdf3c24d99088b593de250dbae0f869db0fe6f910adc8604bf4a9c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 09 Jan 2026 10:02:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2050"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com data:; img-src 'self' https://js.xstak.com data:; require-trusted-types-for 'script';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"802-WPxpLgSMwzMb5j/bQ1rIrCZRwMU\""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"responseStatus\": \"OK\",\n \"message\": \"Request processed successfully.\",\n \"data\": {\n \"_id\": \"xpay_pi_c0979f8b3abdf3c24d99088b593de250dbae0f869db0fe6f910adc8604bf4a9c\",\n \"pi_client_secret\": \"xpay_pi_c0979f8b3abdf3c24d99088b593de250dbae0f869db0fe6f910adc8604bf4a9c_cs_ece262c5bcb16adba2fc2dccc98038c9ae4785b05f3fffd942f418723ceb68ca\",\n \"created_at\": \"2026-01-09T10:02:49.929Z\",\n \"amount\": 10,\n \"currency\": \"PKR\",\n \"refund\": {\n \"refunded_amount\": 0,\n \"refund_object_id\": null\n },\n \"object_name\": \"payment_intent\",\n \"payment_method_types\": \"card\",\n \"customer\": {\n \"name\": \"Necibe Mirzai\",\n \"email\": \"necibe.mirzai@xstak.com\",\n \"phone\": \"905374182171\",\n \"vip_customer\": \"No\",\n \"previous_customer\": \"false\"\n },\n \"description\": \"\",\n \"pi_status\": \"requires_payment_method\",\n \"pm_token\": \"\",\n \"shipping\": {\n \"address1\": \"Model Town Block C\",\n \"address2\": \"\",\n \"city\": \"Karachi\",\n \"country\": \"Pakistan\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"province\": \"Punjab\",\n \"zip\": \"75500\",\n \"shipping_method\": \"Standard\"\n },\n \"metadata\": {\n \"order_reference\": \"32424ew24e2e34r23er\",\n \"check_network_blocklist\": false,\n \"skip_blocklist\": true,\n \"continue_payment\": true\n },\n \"token\": null,\n \"capture_method\": \"manual\",\n \"return_url\": null,\n \"html_response\": {\n \"hidden\": true\n },\n \"bank_response\": {},\n \"last_payment_response\": {\n \"token\": null\n },\n \"encryptionKey\": \"-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAz8NTbh/yGmhFRtxB9ky+\\n7zKEWa0QtGxbnOZuydDzfQiVsbDTWagBhHxl6chuYk/i6NhO4zOuFOuLb/PLJJK8\\nUbD7AewWwo8cj2IFwPVebjnzQEFE0zVKfHnjkilwUY3aUdxwy46/kQmjiXCccDch\\nCHpGQj9xEpBmw9vSKKLfgG+Jnrv5gHyUxYxOKkdTZ1OKbnWS7O9AhEo3+q41uS9x\\n/BWsYg5Y8a1vlsrAf2fme3B8II2TTN6374lH/fsT0XU4lUShBCDAo5WN4dQwqXYv\\nM6H6sH6HDgN16pm69UK8sWrgX6wbS/c9uDQrvoYesa48UWWB0LeZZuJ8Sof3N6Bg\\nBQIDAQAB\\n-----END PUBLIC KEY-----\\n\",\n \"product\": {\n \"product_name\": \"Intercity Travel\",\n \"product_category\": \"Transport\",\n \"no_of_items\": \"2\",\n \"_id\": \"6960d249a7be3a7efaa35be4\"\n },\n \"billingAddress\": {\n \"address1\": \"DHA Phase 2\",\n \"city\": \"Islamabad\",\n \"country\": \"Pakistan\",\n \"province\": \"Islamabad\",\n \"zip\": \"44000\",\n \"shipping_method\": \"Standard\"\n },\n \"routing_rules_history\": [],\n \"subscription\": {},\n \"checkout_page_url\": null,\n \"dqr_data\": null\n }\n}"}],"_postman_id":"6d229498-e1e0-4778-b05d-de6f224e9cef"},{"name":"Fetch all payment intents","id":"7ca898c6-e0e5-4ed3-ba63-b11738bc93a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret API Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"}],"url":"{{base_url}}/public/v1/payment/intent?offset=0&limit=2","description":"This API can be used to retrieve all payments based on the parameters provided in the request. The response is paginated, and data can be fetched page-wise using the offset and limit parameters.
Find a specific email address
\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"Find a specific phone number
\n","type":"text/plain"},"key":"phone","value":""},{"disabled":true,"description":{"content":"Find a specific by order ID
\n","type":"text/plain"},"key":"order","value":""},{"disabled":true,"description":{"content":"Find a specific using intent id
\n","type":"text/plain"},"key":"paymentIntentId","value":""},{"disabled":true,"description":{"content":"format: 2024-10-03
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"format: 2024-10-03
\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"Find a specific using payment method : card | wallet
\n","type":"text/plain"},"key":"paymentType","value":""},{"description":{"content":"start offset
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Max value should 100
\n","type":"text/plain"},"key":"limit","value":"2"}],"variable":[]}},"response":[{"id":"0b97b9d2-a09e-43eb-a85b-63cee4f0bed5","name":"Fetch all payment intents","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret API Key"},{"key":"x-account-id","value":"{{x-account-id}}","description":"XStak Account ID"}],"url":{"raw":"{{base_url}}/public/v1/payment/intent?offset=0&limit=2","host":["{{base_url}}"],"path":["public","v1","payment","intent"],"query":[{"key":"email","value":"","description":"Find a specific email address","disabled":true},{"key":"phone","value":"","description":"Find a specific phone number","disabled":true},{"key":"order","value":"","description":"Find a specific by order ID","disabled":true},{"key":"paymentIntentId","value":"","description":"Find a specific using intent id","disabled":true},{"key":"start_date","value":"","description":"format: 2024-10-03","disabled":true},{"key":"end_date","value":"","description":"format: 2024-10-03","disabled":true},{"key":"paymentType","value":"","description":"Find a specific using payment method : card | wallet","disabled":true},{"key":"offset","value":"0","description":"start offset"},{"key":"limit","value":"2","description":"Max value should 100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 09 Jan 2026 10:05:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3334"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com data:; img-src 'self' https://js.xstak.com data:; require-trusted-types-for 'script';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"d06-s6jV5Sviu8EsM9fL4tDaODL5Dto\""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"responseStatus\": \"OK\",\n \"message\": \"Request processed successfully.\",\n \"data\": {\n \"docs\": [\n {\n \"_id\": \"xpay_pi_c0979f8b3abdf3c24d99088b593de250dbae0f869db0fe6f910adc8604bf4a9c\",\n \"account_id\": \"0ddb82950784f875\",\n \"store_id\": \"670cc16ca4f54be748916396\",\n \"metadata\": {\n \"order_reference\": \"32424ew24e2e34r23er\",\n \"check_network_blocklist\": false,\n \"skip_blocklist\": true,\n \"continue_payment\": true\n },\n \"pi_client_secret\": \"xpay_pi_c0979f8b3abdf3c24d99088b593de250dbae0f869db0fe6f910adc8604bf4a9c_cs_ece262c5bcb16adba2fc2dccc98038c9ae4785b05f3fffd942f418723ceb68ca\",\n \"status\": \"requires_payment_method\",\n \"created_at\": \"2026-01-09T10:02:49.929Z\",\n \"last_used\": null,\n \"mode\": \"test\",\n \"refund_data\": {\n \"refunded_amount\": 0,\n \"refund_obj_id\": null\n },\n \"__v\": 0,\n \"createdAt\": \"2026-01-09T10:02:49.929Z\",\n \"webhook_data\": [],\n \"api_log\": [],\n \"routing_rules_history\": [],\n \"gateway_retry_attempts_history\": [],\n \"ip_address\": [],\n \"is_currency_conversion_applied\": false,\n \"is_checkout_flow\": false,\n \"amount\": 10,\n \"billingAddress\": {\n \"address1\": \"DHA Phase 2\",\n \"city\": \"Islamabad\",\n \"country\": \"Pakistan\",\n \"province\": \"Islamabad\",\n \"zip\": \"44000\",\n \"shipping_method\": \"Standard\"\n },\n \"capture_method\": \"manual\",\n \"currency\": \"PKR\",\n \"customer\": {\n \"name\": \"Necibe Mirzai\",\n \"email\": \"necibe.mirzai@xstak.com\",\n \"phone\": \"905374182171\",\n \"vip_customer\": \"No\",\n \"previous_customer\": \"false\"\n },\n \"original_amount\": \"500\",\n \"payment_method_types\": \"card\",\n \"shipping\": {\n \"address1\": \"Model Town Block C\",\n \"city\": \"Karachi\",\n \"country\": \"Pakistan\",\n \"province\": \"Punjab\",\n \"zip\": \"75500\",\n \"shipping_method\": \"Standard\"\n },\n \"updatedAt\": \"2026-01-09T10:02:56.324Z\"\n },\n {\n \"_id\": \"xpay_pi_439da7d745c851457f347d6e840abc2177d3d33febc32d3599d4d089260e8ad5\",\n \"account_id\": \"0ddb82950784f875\",\n \"store_id\": \"670cc16ca4f54be748916396\",\n \"metadata\": {\n \"order_reference\": \"32424ew24e234r23er\",\n \"check_network_blocklist\": false,\n \"skip_blocklist\": true,\n \"continue_payment\": true\n },\n \"pi_client_secret\": \"xpay_pi_439da7d745c851457f347d6e840abc2177d3d33febc32d3599d4d089260e8ad5_cs_912161d25e980fc4add787dc97c53e53ba409a1847ab42e63b7524ee4ba22d59\",\n \"status\": \"succeeded\",\n \"created_at\": \"2026-01-09T10:01:10.273Z\",\n \"last_used\": null,\n \"mode\": \"test\",\n \"refund_data\": {\n \"refunded_amount\": 0,\n \"refund_obj_id\": null\n },\n \"__v\": 0,\n \"createdAt\": \"2026-01-09T10:01:10.273Z\",\n \"webhook_data\": [],\n \"api_log\": [],\n \"routing_rules_history\": [],\n \"gateway_retry_attempts_history\": [],\n \"ip_address\": [\n \"122.129.66.220\"\n ],\n \"is_currency_conversion_applied\": false,\n \"is_checkout_flow\": false,\n \"amount\": 500,\n \"billingAddress\": {\n \"address1\": \"DHA Phase 2\",\n \"city\": \"Islamabad\",\n \"country\": \"Pakistan\",\n \"province\": \"Islamabad\",\n \"zip\": \"44000\",\n \"shipping_method\": \"Standard\"\n },\n \"capture_method\": \"manual\",\n \"currency\": \"PKR\",\n \"customer\": {\n \"name\": \"Guest User\",\n \"email\": \"necibe.mirzai@xstak.com\",\n \"phone\": \"905374182171\"\n },\n \"original_amount\": \"500\",\n \"payment_method_types\": \"card\",\n \"shipping\": {\n \"address1\": \"Model Town Block C\",\n \"city\": \"Karachi\",\n \"country\": \"Pakistan\",\n \"province\": \"Punjab\",\n \"zip\": \"75500\",\n \"shipping_method\": \"Standard\"\n },\n \"updatedAt\": \"2026-01-09T10:01:27.803Z\",\n \"hashed_card_number\": \"f04b3ffd0d3baea01f39ed58b277ca740560097b4ad7476aea52f55cd086c4e0\",\n \"card_detail\": {\n \"bin\": \"512345\",\n \"card_number\": \"512345xxxxxx2346\",\n \"last_four_digits\": \"2346\"\n },\n \"last_update\": \"2026-01-09T10:01:27.318Z\",\n \"last_payment_response\": {\n \"status\": \"PAYMENT_PARTIALLY_CAPTURED\",\n \"error\": false,\n \"message\": \"The payment was completed successfully\"\n },\n \"mpgs_authorization_transaction_id\": \"trans-3hLJqO18Ip\",\n \"token\": \"\",\n \"captured_amount\": 10\n }\n ],\n \"totalDocs\": 18378\n }\n}"}],"_postman_id":"7ca898c6-e0e5-4ed3-ba63-b11738bc93a7"},{"name":"Void Authorized Transaction","id":"398f8455-84ed-41c4-a4fd-59309eadd127","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret Api Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"}],"url":"{{base_url}}/public/v1/payment/intent/void?pi_client_secret={{pi_client_secret}}","description":"This API allows you to void a previously authorized payment, after which the transaction can no longer be captured.
\n","urlObject":{"path":["public","v1","payment","intent","void"],"host":["{{base_url}}"],"query":[{"key":"pi_client_secret","value":"{{pi_client_secret}}"}],"variable":[]}},"response":[{"id":"64fc7b00-69b9-4eda-8045-744adafa79ba","name":"Void Authorized Transaction","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret Api Key"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id"}],"url":{"raw":"{{base_url}}/public/v1/payment/intent/void?pi_client_secret={{pi_client_secret}}","host":["{{base_url}}"],"path":["public","v1","payment","intent","void"],"query":[{"key":"pi_client_secret","value":"{{pi_client_secret}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 09 Jan 2026 12:25:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2143"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com data:; img-src 'self' https://js.xstak.com data:; require-trusted-types-for 'script';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"85f-nerb3rAb15MPP03/ZXXZk169tYE\""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"responseStatus\": \"OK\",\n \"message\": \"Request processed successfully.\",\n \"data\": {\n \"_id\": \"xpay_pi_e223c68aac14f549d502021e3c3ddac0bbad2fa4836c44146ac54ebf1db83b79\",\n \"pi_client_secret\": \"xpay_pi_e223c68aac14f549d502021e3c3ddac0bbad2fa4836c44146ac54ebf1db83b79_cs_d10a6fed383b454f3e5100757315e28956c8ab2d546214f956bd152baa3b6e56\",\n \"created_at\": \"2026-01-09T12:18:34.569Z\",\n \"last_update\": \"2026-01-09T12:20:05.427Z\",\n \"amount\": 500,\n \"currency\": \"PKR\",\n \"refund\": {\n \"refunded_amount\": 0,\n \"refund_object_id\": null\n },\n \"object_name\": \"payment_intent\",\n \"payment_method_types\": \"card\",\n \"customer\": {\n \"name\": \"Guest User\",\n \"email\": \"necibe.mirzai@xstak.com\",\n \"phone\": \"905374182171\"\n },\n \"description\": \"\",\n \"pi_status\": \"voided\",\n \"pm_token\": \"\",\n \"shipping\": {\n \"address1\": \"Model Town Block C\",\n \"address2\": \"\",\n \"city\": \"Karachi\",\n \"country\": \"Pakistan\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"province\": \"Punjab\",\n \"zip\": \"75500\",\n \"shipping_method\": \"Standard\"\n },\n \"metadata\": {\n \"order_reference\": \"wedfokwewwwmdowee\",\n \"check_network_blocklist\": false,\n \"skip_blocklist\": true,\n \"continue_payment\": true\n },\n \"token\": null,\n \"capture_method\": \"manual\",\n \"return_url\": null,\n \"html_response\": {\n \"next_action\": \"\",\n \"hidden\": false\n },\n \"bank_response\": {},\n \"last_payment_response\": {\n \"error\": false,\n \"status\": \"PAYMENT_VOIDED\",\n \"message\": \"Payment Voided Successfully\",\n \"token\": \"\"\n },\n \"encryptionKey\": \"-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2NSRRY9uKjTo/DEBw9jC\\n481/mIzhst5cpJfF93kUH0UYubBv1/mZuk7yNXmhfX2JO/ZqjDag0cO1GAAh51kZ\\ngi0bwv8DlLtDSyomu3FSHSTEG4LWqLJJcQ0aF6Rx9gST57wHw0QfbJFKFkQIYsR3\\nQX0/3F35VAu10oQInXlLHhGWxZB44IjxdBm5p64444mqZ+cJWpJVJXuniQ34x4Ai\\n0R8t3wN2J1LWFXos45cmqod3Hjjxi9ZIaHnZh/1UgIoHhdC6hwcz9H8E62SCRwNT\\nV3J2zcVGeDl+KDXpk3SJNf5SzuRM6h9MdWvG5mnekOSMyG/bx9Njkr/3YKjNJqG3\\n5QIDAQAB\\n-----END PUBLIC KEY-----\\n\",\n \"product\": {\n \"product_name\": \"Intercity Travel\",\n \"product_category\": \"Transport\",\n \"no_of_items\": \"2\",\n \"_id\": \"6960f21af4dfb1d20a37a341\"\n },\n \"billingAddress\": {\n \"address1\": \"DHA Phase 2\",\n \"city\": \"Islamabad\",\n \"country\": \"Pakistan\",\n \"province\": \"Islamabad\",\n \"zip\": \"44000\",\n \"shipping_method\": \"Standard\"\n },\n \"routing_rules_history\": [],\n \"gateway\": \"bank-alfalah\",\n \"subscription\": {},\n \"checkout_page_url\": null,\n \"dqr_data\": null\n }\n}"}],"_postman_id":"398f8455-84ed-41c4-a4fd-59309eadd127"}],"id":"37e89934-27dd-4414-aa14-69cb2a359e4c","_postman_id":"37e89934-27dd-4414-aa14-69cb2a359e4c","description":""},{"name":"Refund","item":[{"name":"Create a refund","event":[{"listen":"prerequest","script":{"id":"8e54fd6d-1221-4f72-b609-5408db3d2f27","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"75bf7d62-1c28-4388-8ae6-4bb4696c89f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret API Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"},{"key":"x-signature","value":"{{x-signature}}","description":"Generate body payload hash using the API signature key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payment_intent_id\": \"xpay_pi_ea9f31223dc3b66ca93a73d0c6594f7bdc37bbbaf3e449e4be4b0620516062a7\",\n \"reason\": \"Customer Request\",\n \"refunded_amount\": 500\n}"},"url":"{{base_url}}/public/v1/refund","urlObject":{"path":["public","v1","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"99dfce0c-60a1-4641-b52f-c1e273877bed","name":"Create a refund","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key-sk}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"x-signature","value":"{{x-signature}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payment_intent_id\": \"xpay_pi_ea9f31223dc3b66ca93a73d0c6594f7bdc37bbbaf3e449e4be4b0620516062a7\",\n \"reason\": \"Customer Request\",\n \"refunded_amount\": 500\n}"},"url":"https://xstak-pay-stg.xstak.com/public/v1/refund"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 09 Jan 2026 11:14:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"524"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com data:; img-src 'self' https://js.xstak.com data:; require-trusted-types-for 'script';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"20c-8JwYi9lnmllKijAIy4/6MB/9V6A\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"responseStatus\": \"OK\",\n \"message\": \"Request processed successfully.\",\n \"data\": {\n \"_id\": \"xpay_ref_5065402c420c6f0b20a7ed50a6c13657546f33ab80055dccc017b1f7963fe012\",\n \"payment_intent_id\": \"xpay_pi_ea9f31223dc3b66ca93a73d0c6594f7bdc37bbbaf3e449e4be4b0620516062a7\",\n \"account_id\": \"0ddb82950784f875\",\n \"created_at\": \"2026-01-09T11:14:42.967Z\",\n \"last_used\": null,\n \"object_name\": \"refund\",\n \"refunded_amount\": 500,\n \"currency\": \"PKR\",\n \"reason\": \"Customer Request\",\n \"mode\": \"test\",\n \"status\": \"refunded\",\n \"refund_initiator_id\": \"Refund API\",\n \"__v\": 0\n }\n}"}],"_postman_id":"75bf7d62-1c28-4388-8ae6-4bb4696c89f8"},{"name":"Update a refund","event":[{"listen":"prerequest","script":{"id":"246c0bbe-d962-42c5-a0aa-b969385180ab","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9f0a71d0-d8e1-4531-9944-4e4becce666b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret API Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"},{"key":"x-signature","value":"{{x-signature}}","description":"Generate body payload hash using the API signature key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payment_intent_id\": \"xpay_pi_6adcdd2e4c615017eff318bbb3204f15bf186a523fd53bc2678bd068680bb8a2\",\n \"refunded_amount\": 200\n}"},"url":"{{base_url}}/public/v1/refund/:refund_id","urlObject":{"path":["public","v1","refund",":refund_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"refund_id"}]}},"response":[{"id":"ab9d2b7b-f141-4ce6-8c63-d75039b70a89","name":"Update a refund","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"{{x-api-key-sk}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"x-signature","value":"{{x-signature}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payment_intent_id\": \"xpay_pi_6adcdd2e4c615017eff318bbb3204f15bf186a523fd53bc2678bd068680bb8a2\",\n \"refunded_amount\": 200\n}"},"url":{"raw":"https://xstak-pay-stg.xstak.com/public/v1/refund/:refund_id","protocol":"https","host":["xstak-pay-stg","xstak","com"],"path":["public","v1","refund",":refund_id"],"variable":[{"key":"refund_id","value":"xpay_ref_07dd3df22897684a931f1a7323194f0ca57cd5a1649fe6730fc8dd7da4424bfb"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 09 Jan 2026 11:18:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"534"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com data:; img-src 'self' https://js.xstak.com data:; require-trusted-types-for 'script';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"216-5fD0YIAS/96uktUuMUB0eTq41j4\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"responseStatus\": \"OK\",\n \"message\": \"Request processed successfully.\",\n \"data\": {\n \"_id\": \"xpay_ref_07dd3df22897684a931f1a7323194f0ca57cd5a1649fe6730fc8dd7da4424bfb\",\n \"payment_intent_id\": \"xpay_pi_6adcdd2e4c615017eff318bbb3204f15bf186a523fd53bc2678bd068680bb8a2\",\n \"account_id\": \"0ddb82950784f875\",\n \"created_at\": \"2026-01-09T11:16:54.411Z\",\n \"last_used\": null,\n \"object_name\": \"refund\",\n \"refunded_amount\": 300,\n \"currency\": \"PKR\",\n \"reason\": \"Customer Request\",\n \"mode\": \"test\",\n \"status\": \"partially_refunded\",\n \"refund_initiator_id\": \"Refund API\",\n \"__v\": 0\n }\n}"}],"_postman_id":"9f0a71d0-d8e1-4531-9944-4e4becce666b"},{"name":"Retrieve a refund","id":"1b37bed1-442e-41ea-a68b-8224f50ef73b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret API Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"}],"url":"{{base_url}}/public/v1/refund/:refund_id","urlObject":{"path":["public","v1","refund",":refund_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"refund_id"}]}},"response":[{"id":"6aea3219-240c-4539-9ff8-67fcce6dfb96","name":"Retrieve a refund","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key-sk}}"},{"key":"x-account-id","value":"{{x-account-id}}"}],"url":{"raw":"https://xstak-pay-stg.xstak.com/public/v1/refund/:refund_id","protocol":"https","host":["xstak-pay-stg","xstak","com"],"path":["public","v1","refund",":refund_id"],"variable":[{"key":"refund_id","value":"xpay_ref_07dd3df22897684a931f1a7323194f0ca57cd5a1649fe6730fc8dd7da4424bfb"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 09 Jan 2026 11:18:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"534"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' https://fonts.googleapis.com; font-src 'self' https://fonts.gstatic.com data:; img-src 'self' https://js.xstak.com data:; require-trusted-types-for 'script';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"ETag","value":"W/\"216-5fD0YIAS/96uktUuMUB0eTq41j4\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"responseStatus\": \"OK\",\n \"message\": \"Request processed successfully.\",\n \"data\": {\n \"_id\": \"xpay_ref_07dd3df22897684a931f1a7323194f0ca57cd5a1649fe6730fc8dd7da4424bfb\",\n \"payment_intent_id\": \"xpay_pi_6adcdd2e4c615017eff318bbb3204f15bf186a523fd53bc2678bd068680bb8a2\",\n \"account_id\": \"0ddb82950784f875\",\n \"created_at\": \"2026-01-09T11:16:54.411Z\",\n \"last_used\": null,\n \"object_name\": \"refund\",\n \"refunded_amount\": 300,\n \"currency\": \"PKR\",\n \"reason\": \"Customer Request\",\n \"mode\": \"test\",\n \"status\": \"partially_refunded\",\n \"refund_initiator_id\": \"Refund API\",\n \"__v\": 0\n }\n}"}],"_postman_id":"1b37bed1-442e-41ea-a68b-8224f50ef73b"}],"id":"7a7911e5-3dd2-42a7-a163-f335e3909054","_postman_id":"7a7911e5-3dd2-42a7-a163-f335e3909054","description":""},{"name":"Tokenization","item":[{"name":"Pay with merchant Token","id":"3da0ef0a-e270-4f61-a632-63ca43a686d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret Api Key
\n","type":"text"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n","type":"text"},{"key":"x-signature","value":"{{x-signature}}","description":"Generate body payload hash using the API signature key
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": 10,\n\t\"currency\": \"PKR\",\n\t\"payment_method_types\": \"token\",\n\t\"customer\": {\n \t\"name\": \"Guest User\",\n \t\"email\": \"guest@gmail.com\",\n \t\"phone\":\"03415555555\"\n\t},\n\t\"shipping\": {\n \t\"address1\": \"abc\",\n \t\"city\": \"Islamabad\",\n \t\"country\": \"Pakistan\",\n \t\"phone\": \"03415555555\",\n \t\"zip\": \"12345\",\n \t\"shipping_method\": \"Standard\"\n\t},\n\t\"metadata\": {\n \t\"order_reference\": \"XX-Order-1\"\n\t},\n\t\"token\":\"xpay_token_a5d1e0ef0d23082992a\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v2/payment/intent/tokenized/payment","urlObject":{"path":["public","v2","payment","intent","tokenized","payment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3da0ef0a-e270-4f61-a632-63ca43a686d3"},{"name":"Fetch Token Details","id":"d249bc20-8153-4d7c-9b7f-53a0c9c2b539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret APi Key
\n","type":"text"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n","type":"text"}],"url":"{{base_url}}/public/v1/token/:token","urlObject":{"path":["public","v1","token",":token"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"token"}]}},"response":[],"_postman_id":"d249bc20-8153-4d7c-9b7f-53a0c9c2b539"},{"name":"Delete a token","id":"d87589af-d237-4a10-a432-80430dfb2bd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret APi Key
\n","type":"text"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n","type":"text"}],"url":"{{base_url}}/public/v1/token/:token","urlObject":{"path":["public","v1","token",":token"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"token"}]}},"response":[],"_postman_id":"d87589af-d237-4a10-a432-80430dfb2bd1"},{"name":"Get all saved tokens / payment methods","id":"11a40d79-39fd-42fd-95c3-6156f46f5a5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret Api Key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account ID
\n"}],"url":"{{base_url}}/public/v1/token","description":"This API can be used to get all saved tokens and saved payment methods. To use this API starting from June 26, 2024, you will need to create new tokens by adding reason: \"token\" in the Create PI API payload metadata.
Support will be provided later for live tokens on-demand.
\n","urlObject":{"path":["public","v1","token"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Get active tokens only
\n","type":"text/plain"},"key":"enabled","value":"true"},{"disabled":true,"description":{"content":"Fetch using email
\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"Fetch using phone
\n","type":"text/plain"},"key":"phone","value":""}],"variable":[]}},"response":[],"_postman_id":"11a40d79-39fd-42fd-95c3-6156f46f5a5e"}],"id":"b6229270-ed71-4221-950f-0da40d073efb","description":"Token Creation
\nCreate a payment intent by passing a specific key-value in metadata.
\nConfirm Payment SDK will work as usual.
\nThe token will be returned in the webhook with details.
\nTokenized Payment
\nCreate a Payment Intent object with all the required fields and pass the reason in the metadata field with a value token, which will indicate that this Payment Intent object will create a merchant token.
\nCreate PI Request body change
\nmetadata: {\n\"reason\": \"token\"\n}\n\n2. Confirm Payment Intent with Card Details
\nNo changes are required in this API
\nIf the Transaction is Successfully Captured, the created TOKEN will be returned via webhook.
\nThe maximum limit of tokens against each user (email/phone number) is 5.
\nIf the token limit is reached, to continue normal payments without saving tokens, the following key-value pair can be added in Create PI API. Otherwise, the payments will be declined.
\nmetadata: {\n\"continue_payment\": true\n}\n\nSecret Api key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"}],"url":"{{base_url}}/public/v1/bin/config/:bin","urlObject":{"path":["public","v1","bin","config",":bin"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"bin"}]}},"response":[],"_postman_id":"0b96c3f8-6a94-488a-8f08-3470a15e5681"},{"name":"Fetch BIN details via custom ID","id":"6ebf7ea5-8917-4eb8-b87c-89d4d1442e53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret Api key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"}],"url":"{{base_url}}/public/v1/bin/config/id/:id","urlObject":{"path":["public","v1","bin","config","id",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"6ebf7ea5-8917-4eb8-b87c-89d4d1442e53"}],"id":"072461a4-90c3-4fd5-b317-a713d9787ce0","_postman_id":"072461a4-90c3-4fd5-b317-a713d9787ce0","description":""}],"id":"3cd732c7-6a5d-4a99-924d-83a3c6e74bda","description":"XPay Fusion is a PCI DSS-compliant payment solution to collect payments from your customers on your webapp without them having to redirect to a third-party payment page.
\nTo integrate XPay Fusion with your eCommerce store, you need to:
\nIntegrate Fusion APIs on the server side and
\nAdd the Fusion embedded element on the client side by using XPay JS SDK.
\nWhen your customer comes to the checkout page, they enter their card details into the card details form rendered in a secure iframe, enabled by the Fusion Embedded Element. They then click the Place Order button.
\nThe Fusion Embedded Element can be added to your frontend project as follows:
\nnpm i @xstak/xpay-element-stage-v4\n\n3. Import the XPay provider and add the required keys
\nimport { XPay } from '@xstak/xpay-element-stage-v4';\nfunction XPayPayment() {\nreturn (\n<XPay xpay={{ publishableKey: \"\", accountId: \"\", hmacSecret: \"\"}}>\n<Payment />\n</XPay>\n)}\n\n4. Render the Fusion Embedded Element
\nimport React, { useState } from 'react';\nimport { PaymentElement, useXpay } from '@xstak/xpay-element-stage-v4';\nexport const Payment = () => {\n const options = {\n override: true,\n fields: {\n creditCard: {\n placeholder: \"4234 1234 1234 1234\",\n label: \"Enter your credit card\",\n },\n exp: {\n placeholder: \"Exp. Date\",\n },\n },\n style: {\n \".input\": {\n \"border\": \"1px solid black\",\n \"border-radius\": \"15px\"\n },\n \".invalid\": {},\n \".label\": {\n \"font-size\": \"18px\"\n },\n \":focus\": {},\n \":hover\": {},\n \"::placeholder\": {},\n \"::selection\": {},\n },\n };\n const xpay = useXpay();\n const pay = async() => { \nconst { message, error } = await xpay.confirmPayment(\"card\", payment_intent_client_secret,{name: 'Dane Joe'}, encryptionKey);\n//if payment is successful, request backend to create order.\n//else if payment is unsuccessful, show error message\n }\n return(\n <>\n <PaymentElement options={options} onReady={(event) => {\n console.log(\"ready event\", event);\n }} />\n <Button type=\"primary\" onClick={pay}>\n Pay Now\n </Button>\n )\n}\n\nImportant: XPay SDK supports custom styling and changing labels and placeholder texts of input fields as per your design to provide a seamless experience to your customers.
\n5. When the customer clicks on the Place Order button, the frontend requests the backend to start the payment processing by passing relevant details about the cart (cart id, cart total etc) and the customer (customer name and contact details etc). Since the order would not have been created as yet, it is recommended that the cart id be used at this step.
\n6. The backend receives this request from the frontend and creates a payment intent by calling the Create Payment Intent API and returns the response to the frontend:
\na. The cart id should be added in the metadata object, with the key of order_reference, of Create Payment Intent call payload to reference it later. However, any other key/value can also be added in the metadata object.
\nb. Important: Payment Intent id is the single source of truth in XPay Fusion and it will be used as a reference for the payment and any possible future actions such as refund, etc.
\nc. Payment intent client secret and encryptionKey are included in the response of the Create Payment Intent call. This client secret and encryptionKey will be needed to capture the payment and pass in confirmPayment SDK method as shown below.
\n7. Once the frontend receives the payment intent from the backend, it will call the confirmPayment method of the XPay JS SDK and pass it the payment intent client secret.
\nconst { message, error } = await xpay.confirmPayment(\"card\", payment_intent_client_secret,{name: 'Dane Joe'}, encryptionKey);\n\n8. This confirmPayment SDK method will return a promise which will be resolved with a response object citing either success or failure message with the reason.
\na. If successful, the frontend can request the backend to create the order. It is recommended that the backend retrieve the payment intent from XPay by calling the Retrieve Payment Intent API, verify the payment information and then create the order and inform the frontend.
\nb. If unsuccessful, the frontend should show an error message to the customer.
\nc. You can also set up webhooks to get notified of payment status asynchronously.
\nWe have an event named ready which will return true if all fields have been filled by user and form is ready to be submitted.
\nIt will ensure that the website only enables the payment button if all required data has been added to the iframe form.
\n // React\n<PaymentElement options={options} onReady={(event) => {\n console.log(\"ready event\", event);\n }} />\n// Veniala Js\nxpay.on(\"ready\", function (event) {\n console.log(event, \"onready\");\n});\n\nTo use API, you must authenticate your requests with HMAC. For HMAC authentication please use the SHA256 algorithm. You will need to generate an HMAC signature using HMAC shared secret API key and request payload by passing it in JSON.stringify() format.
\nThe signature should be added to the request headers as follows:
\nCommon Header Parameters:
\nTo generate the HMAC signature, you should use API Signature key and JSON stringify request body payload that is described below:
\nHow to generate signatures using Python
\nThis python code will generate a HMAC signature:
\nimport requests\nimport hmac\nimport hashlib\nimport json\nsecret_key = 'API Signature key'\ndata = {\n \"order\": {\n \"id\": \"testOrder-001\",\n \"currency\": \"PKR\",\n \"order_amount\": 20\n },\n \"customer\": {\n \"name\": \"John\",\n \"email\": \"john@gmail.com\",\n \"phone\": \"12345678990\"\n },\n \"metadata\": {\n \"key\": \"value\"\n },\n \"description\": \"any description\"\n}\nmessage = json.dumps(data, separators=(',', ':'))\nsignature = hmac.new(secret_key, message, hashlib.sha256).hexdigest()\n\nPHP code to generate a HMAC signature:
\n$payload = array(\n \"order\" => array(\n \"id\" => \"testOrder-999\",\n \"currency\" => \"PKR\",\n \"order_amount\" => 20,\n ),\n \"customer\" => array(\n \"name\" => \"John\",\n \"email\" => \"john@gmail.com\",\n \"phone\" => \"12345678990\",\n ),\n \"metadata\" => array(\n \"key\" => \"value\",\n ),\n \"description\" => \"any description\",\n);\n$data = json_encode($payload);\n$hmac_sc_api = 'API Signature key';\n$hash = hash_hmac('sha256', $data, $hmac_sc_api);\necho $hash;\n?>\n\nTo add HMAC signature to a REST API request in Express you can follow these steps:
\nInstall the crypto-js package which provides the HMAC algorithm implementation for Node.js: npm install crypto-js
\nCreate a function that will be used to generate the HMAC signature for the request. This function should accept the HTTP method, request URL, request body, and the secret key as arguments.
\nconst crypto = require('crypto');\nconst body = {\n \"order\": {\n \"id\": \"testOrder-999\",\n \"currency\": \"PKR\",\n \"order_amount\": 20\n },\n \"customer\": {\n \"name\": \"John\",\n \"email\": \"john@gmail.com\",\n \"phone\": \"12345678990\"\n },\n \"metadata\": {\n \"key\": \"value\"\n },\n \"description\": \"any description\"\n}\n const data = JSON.stringify(body);\n const secretKey = 'API Signature key';\n const signature = crypto.createHmac('SHA256', secretKey).update(data).digest('hex');\n return signature;\n\nSecret Api key
\n"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id
\n"},{"key":"x-signature","value":"{{x-signature}}","description":"Generate body payload hash using the API signature key
\n"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"id\": \"testOrder-007\",\n \"currency\": \"PKR\",\n \"order_amount\": 20\n },\n \"customer\": {\n \"name\": \"John\",\n \"email\": \"john@gmail.com\",\n \"phone\": \"12345678990\"\n },\n \"metadata\": {\n \"key\": \"value\"\n },\n \"description\": \"any description\"\n}"},"url":"{{base_url}}/public/v1/payment/link","urlObject":{"path":["public","v1","payment","link"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"34fcb8d4-69b1-464b-add1-a58ce603c21a","name":"Succes response","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}","description":"Secret Api Key"},{"key":"x-account-id","value":"{{x-account-id}}","description":"Account Id"},{"key":"x-signature","value":"{{x-signature}}","description":"Generate body payload hash using the API signature key"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"id\": \"testOrder-000\",\n \"currency\": \"PKR\",\n \"order_amount\": 20\n },\n \"customer\": {\n \"name\": \"John\",\n \"email\": \"john@gmail.com\",\n \"phone\": \"12345678990\"\n },\n \"metadata\": {\n \"key\": \"value\"\n },\n \"description\": \"any description\"\n}"},"url":"{{base_url}}/public/v1/payment/link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Mar 2023 07:46:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"300"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"12c-440udH3My+Xgt8xk55d462UTHZk\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Payment link created successfully\",\n \"payment_link\": \"dev.xta.ac/66ac09\",\n \"order\": {\n \"id\": \"testOrder-000\",\n \"currency\": \"PKR\",\n \"order_amount\": 20\n },\n \"customer\": {\n \"name\": \"John\",\n \"email\": \"john@gmail.com\",\n \"phone\": \"12345678990\"\n },\n \"metadata\": {\n \"key\": \"value\"\n },\n \"description\": \"any description\"\n}"}],"_postman_id":"334f02f0-3c23-404a-a587-ba5d1e869711"}],"id":"e2279371-76d3-4f8f-aba5-95d8ed7956e8","description":"The API is used to generate a shortened payment link that can be shared with customers. This link will redirect the customer to the secure payment page where they can complete the payment process.
\nThe customer object should contain the following parameters:
\nThe Customer object requires a name, as well as either an email or phone number.
\nThe Order object should contain the following parameters:
\nAmount and currency can be added explicitly to override the price of products.
\n","urlObject":{"path":["public","v1","plan"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8890e913-196b-44cc-8d8c-939da0c154d5"},{"name":"Delete a plan","id":"3c73adfd-4008-4f98-93df-111528b99018","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"User-Agent","value":"Apidog/1.0.0 (https://apidog.com)"},{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/public/v1/plan/xpay_plan_1d36ea0b8c1f4b0a83a624de153e94c0","urlObject":{"path":["public","v1","plan","xpay_plan_1d36ea0b8c1f4b0a83a624de153e94c0"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c73adfd-4008-4f98-93df-111528b99018"},{"name":"Get a plan","id":"a61f32ba-05f9-4834-bc21-da602339e7d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"User-Agent","value":"Apidog/1.0.0 (https://apidog.com)"},{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/public/v1/plan/xpay_plan_2937a89c90724c779b8acd219961d3c2","urlObject":{"path":["public","v1","plan","xpay_plan_2937a89c90724c779b8acd219961d3c2"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a61f32ba-05f9-4834-bc21-da602339e7d1"},{"name":"Get all plans","id":"7d1e1ff3-e40b-41fc-9435-9c9159e4dbf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"User-Agent","value":"Apidog/1.0.0 (https://apidog.com)"},{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/public/v1/plan","urlObject":{"path":["public","v1","plan"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d1e1ff3-e40b-41fc-9435-9c9159e4dbf6"}],"id":"5acdb842-e210-4cbd-9c6e-f3f9bb38cd69","_postman_id":"5acdb842-e210-4cbd-9c6e-f3f9bb38cd69","description":""},{"name":"Subscriptions","item":[{"name":"Create a subscription","id":"8e47bf3a-90ac-4c66-8955-781a637990df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"User-Agent","value":"Apidog/1.0.0 (https://apidog.com)"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"plan_id\": \"\",\n \"start_date\": \"2024-07-16T11:39:00Z\",\n \"payment\": {\n \"token\": \"\",\n \"amount\": 100, // optional field\n \"currency\": \"\" // optional field\n },\n \"timezone\": \"Asia/Karachi\",\n \"collect_advance\": true, //boolean\n \"failure_action\": \"\", //'CONTINUE' | 'CANCEL';\n \"payment_retries_timing\": [ // optional but if added should be equal to number of retries\n {\n \"date\": 0,\n \"hour\": 0,\n \"minute\": 3\n }\n \n ],\n \"product\": [\n {\n \"product_id\": \"\",\n \"quantity\": 2\n }\n ]\n\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/subscription","urlObject":{"path":["public","v1","subscription"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e47bf3a-90ac-4c66-8955-781a637990df"},{"name":"Skip a subscription","id":"e56fe1cd-f435-412e-bafe-1c0ea7bd6b28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"User-Agent","value":"Apidog/1.0.0 (https://apidog.com)"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"invoice_id\",\n \"invoice_id\": \"xpay_invoice_bfb7bf8b09a54850b273e5333abdb58a\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/subscription/xpay_subs_af8fae336b12448593ce63c45b4989eb/skip","urlObject":{"path":["public","v1","subscription","xpay_subs_af8fae336b12448593ce63c45b4989eb","skip"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e56fe1cd-f435-412e-bafe-1c0ea7bd6b28"},{"name":"unskip a subscription","id":"591ba7a9-8685-4cc6-95a1-80915cf3f035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"User-Agent","value":"Apidog/1.0.0 (https://apidog.com)"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"invoice_id\",\n \"invoice_id\": \"xpay_invoice_bfb7bf8b09a54850b273e5333abdb58a\",\n \"override\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/subscription/xpay_subs_af8fae336b12448593ce63c45b4989eb/unskip","urlObject":{"path":["public","v1","subscription","xpay_subs_af8fae336b12448593ce63c45b4989eb","unskip"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"591ba7a9-8685-4cc6-95a1-80915cf3f035"},{"name":"cancel a subscription","id":"8f84c467-d763-4af1-919d-58b444c06b84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"User-Agent","value":"Apidog/1.0.0 (https://apidog.com)"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"end_of_invoice\": true //optional field to cancel subscription at the end of current billing cycle. XPay will trigger a webhook when a subscription gets cancelled.\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/subscription/xpay_subs_97fbb0eaefe54f5ebb980fa7b8a96ba5/cancel","description":"\"end_of_invoice\": true
It is an optional field to cancel a subscription at the end of the current billing cycle. XPay will trigger a webhook when a subscription gets canceled.
\n","urlObject":{"path":["public","v1","subscription","xpay_subs_97fbb0eaefe54f5ebb980fa7b8a96ba5","cancel"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f84c467-d763-4af1-919d-58b444c06b84"},{"name":"resume a subscription","id":"0c7fbc23-4451-413e-ae30-0b0c3dcced8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"User-Agent","value":"Apidog/1.0.0 (https://apidog.com)"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"billing_cycle\": \"\" // [\"retain\", \"now\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/subscription/xpay_subs_ebe492d05af544eaa1cd099a9b59e457/resume","description":"If you want to keep the same billing cycle while resuming your subscription, you can add value retain and if you want to start from the time it is being resumed, pass now.
retain: same billing cycle
now: new billing cycle
The create an invoice API can be used to manually create and schedule invoice in existing subscription.
\n","urlObject":{"path":["public","v1","invoice"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3f00634-3ea7-4112-8b3c-cf22041745d0"},{"name":"Update an invoice","id":"0870d8ea-ddd9-41a7-aab3-0ab7398170db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"state\":\"paid\",\n \"currency\":\"PKR\",\n \"amount\":\"140\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/invoice/xpay_invoice_346e530db6a0471c8ffe95a17157c3e0","urlObject":{"path":["public","v1","invoice","xpay_invoice_346e530db6a0471c8ffe95a17157c3e0"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0870d8ea-ddd9-41a7-aab3-0ab7398170db"},{"name":"Pay an invoice","id":"d9fcebc7-a2e1-4464-b754-e7c0fb302868","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"send_payment_link_on_failure\":\"true\" \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/invoice/xpay_invoice_63c6b3045b9542f8bd5c71ddfd2acd25/pay","urlObject":{"path":["public","v1","invoice","xpay_invoice_63c6b3045b9542f8bd5c71ddfd2acd25","pay"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d9fcebc7-a2e1-4464-b754-e7c0fb302868"},{"name":"Refund an invoice","id":"3cdaf8d4-f230-4c9d-9f60-98584323c5cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}"},{"key":"x-account-id","value":"{{x-account-id}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/public/v1/invoice/xpay_invoice_63c6b3045b9542f8bd5c71ddfd2acd25/refund","urlObject":{"path":["public","v1","invoice","xpay_invoice_63c6b3045b9542f8bd5c71ddfd2acd25","refund"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3cdaf8d4-f230-4c9d-9f60-98584323c5cd"}],"id":"db488967-e671-44d2-a0c0-a89d9cc9b0cc","_postman_id":"db488967-e671-44d2-a0c0-a89d9cc9b0cc","description":""}],"id":"4f29fab3-89e1-43e1-935b-e46941b917c8","description":"Please refer to https://xpay-subscription.notion.site/XPay-Subscription-010c885fdaff46dc86cfe1c63cf3d546 for detailed documentation of Subscription.
\n","_postman_id":"4f29fab3-89e1-43e1-935b-e46941b917c8"}]}