Safepay is a regulated payments service provider that enables developers to orchestrate money movement between customers and businesses with ease and speed. The Safepay API makes it simple for businesses and financial platforms to create payment sessions, manage subscriptions, issue invoices and exchange value by sending and receiving money. Our API is based upon REST principles, returns JSON responses, and uses standard HTTP response codes.
\nSafepay offers two environments to developers - production and sandbox . Any transaction performed in our sandbox environment will not have any financial impact. We also provide test credentials for payment instruments that can be used while integrating.
To begin integrating, we recommend you sign up for our sandbox account - its free to do so and will give you access to all of Safepay's APIs. Once you've completed your integration, please reach out to a member of our team who will guide you on how to create a production account and complete our onboarding process.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3342320","collectionId":"cec9379a-c788-4741-bce5-d8028457cf41","publishedId":"2s9YJaXPJe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"6685DF"},"publishDate":"2023-10-02T07:19:47.000Z"},"item":[{"name":"API Authentication","item":[{"name":"Login Company","event":[{"listen":"test","script":{"id":"e4804d4e-a897-4cb7-b85b-e53a3553767d","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"clientToken\", jsonData.data.token);"],"type":"text/javascript"}}],"id":"ac83b9db-a3fa-498b-8906-3c72a2819b98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"zparekh@getsafepay.com\",\n\t\"password\": \"azazazazaz\"\n}"},"url":"{{baseUrl}}{{auth-port}}/v1/company/login","urlObject":{"path":["v1","company","login"],"host":["{{baseUrl}}{{auth-port}}"],"query":[],"variable":[]}},"response":[{"id":"1d367db5-7295-4679-8bf8-53dfcfef19f1","name":"Login Company","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"ausmani@getsafepay.com\",\n\t\"password\": \"azazazazaz\"\n}"},"url":"{{baseUrl}}{{auth-port}}/v1/company/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization, X-SFPY-MERCHANT-KEY"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 30 Nov 2022 05:59:04 GMT"},{"key":"Server","value":"nginx/1.19.1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Ratelimit-Limit","value":"50"},{"key":"X-Ratelimit-Remaining","value":"49"},{"key":"X-Ratelimit-Reset","value":"Wed, 30 Nov 2022 06:00:03 UTC"},{"key":"Content-Length","value":"340"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"count\": 1,\n \"list\": [\n {\n \"token\": \"client_bc9b141a-edce-429a-88f0-90230d0b66f1\",\n \"name\": \"Safepay Demo\",\n \"description\": \"\",\n \"email\": \"ausmani@getsafepay.com\",\n \"phone\": \"\",\n \"api_key\": \"sec_f1c179f6-780a-46dd-8a15-0aa57b704c01\",\n \"avatar\": \"\",\n \"website\": \"\",\n \"payout_terms\": \"\",\n \"active\": 0,\n \"suspended\": 0,\n \"suspend_reason\": \"\",\n \"email_settings\": null,\n \"api_settings\": null,\n \"organization\": null,\n \"verification\": null,\n \"verified\": 1,\n \"created_at\": \"2022-11-29T08:56:36Z\",\n \"updated_at\": \"2022-11-29T08:56:36Z\"\n }\n ]\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"}],"_postman_id":"ac83b9db-a3fa-498b-8906-3c72a2819b98"},{"name":"Create Merchant JWT","event":[{"listen":"test","script":{"id":"9881fce1-b552-4d9e-871a-4b159132361e","exec":["var jsonData = JSON.parse(responseBody);","if (jsonData.data && jsonData.data.session) {"," pm.collectionVariables.set(\"jwtToken\", jsonData.data.session);","}"],"type":"text/javascript"}}],"id":"928e9e61-048b-4460-9e6b-7726d4bb5b21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\t\n\t\"client\": \"client_bb1d600f-f174-49dc-a34f-a79c77e237c8\",\n\t\"email\": \"zparekh@getsafepay.com\",\n\t\"password\": \"azazazazaz\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/auth/v1/company/authenticate","description":"Use the client email and password fields to generate a JWT token. The email and password are that of the user who created the account, referred to as the Admin user.
A successful request will generate the following response
\n{\n \"data\": {\n \"session\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTU4OTk1OTQsImlhdCI6MTY5NTg5NTk5NCwidmVyc2lvbiI6InYxIiwiZW1haWwiOiJ6cGFyZWtoQGdldHNhZmVwYXkuY29tIiwidG9rZW4iOiJjbGllbnRfMDcxZjljMjUtYzI5MS00ZGNmLWEyMWUtNzliNTc2ZGRkMGZkIiwidmVyaWZpZWQiOjEsIm1hc2siOjJ9.kLJAACzeeo-D7U1ZWLeNpbnLuvCX6LN9W5TdA3wVyXo\",\n \"token\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\"\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nThe JWT token can be extracted by indexing the data object at the session property. Each session token is valid for a 24 hour period
Use the type, email and password fields to generate a JWT token for a Safepay Shopper. The JWT may be used to authenticate payment requests.
Use the type, email and password fields to generate a JWT token for a Safepay Shopper. The JWT may be used to authenticate payment requests.
Register a guest user. The result is a JWT token for a guest session. This can be used to authenticate the Payments Order API.
\nA successful request will generate the following response
\n{\n \"data\": {\n \"session\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTcyNjc0NzcsImlhdCI6MTY5NjY2MjY3NywidmVyc2lvbiI6InYxIiwiZW1haWwiOiJoemFpZGlAZ2V0c2FmZXBheS5jb20iLCJ0b2tlbiI6Imd1ZXN0XzRjYTU1ZTU2LTQ1ZTYtNDZkZi04ZDY0LTY4Y2E4Njg2N2JlNSIsIm1hc2siOjR9.ADESUILYB1Nii8wysYe1MW5xF3LisW1uSuaklO8BQCo\",\n \"token\": \"guest_4ca55e56-45e6-46df-8d64-68ca86867be5\"\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nThe JWT token can be extracted by indexing the data object at the session property. Each session token is valid for a 7 day period.
All accounts are automatically provisioned with an API key when they are created. However, if for some reason, your account does not have an API key, you can use this endpoint to create one. Alternatively, you can also create an API key from your dashboard.
\nAPI keys can only be created once. To rotate or update your API key, please refer to the Rotate Api Key endpoint.
Rotating an API key will revoke access from any API endpoints that are configured with any previously generated API key. Use this endpoint only if you feel that your API key has been exposed or compromised.
\n\n\nThis endpoint only supports JWT based authentication
\n
This endpoint does not require a payload
\nA successful request will generate the following response
\n{\n \"data\": {\n \"token\": \"api_b3db2bd8-5fa3-4ec4-ab47-0733dacfed69\",\n \"client_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"webhook_secret\": \"c44e1b93160e1ccd34ea9c40e79f5f11ea276105b563c53d9ca59e4eb8477686\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nThe API Key can be extracted from data.webhook_secret and does not have an expiration date. Use this API key to authenticate against all requests that support API key based authentication
Use your merchant Secret key to generate a time-based token.
\nThe token can be extracted from data and has an expiration of 2 minutes. Use this token to authenticate against all requests that support time-based token authentication.
To authenticate, you must set the Authorization header to Bearer followed by the time-based token.
For server-to-server communication, Safepay supports authentication through JWT tokens as well as API secret keys. Most APIs support both JWT and Secret Key based authentication but where an API supports a specific type of authentication, it will be mentioned.
\nTo use a JWT token, set the Authorization header to Bearer. To authenticate as a merchant, set a header called X-SFPY-MERCHANT-SECRET and use the merchant Secret Key as the value. The Secret Key can be found in the Developer section on the merchant dashboard.
For client-to-server requests, a time-based token may first be generated server-side using your Secret key. This is passed similarly to the JWT token i.e. setting the Authorization header to Bearer followed by the time-based token (as opposed to a JWT).
Retrieves details for an API key that is linked to the Safepay account
\n\n\nThis endpoint only supports JWT based authentication
\n
A successful request to this endpoint will return the following response
\n{\n \"data\": {\n \"token\": \"api_b3db2bd8-5fa3-4ec4-ab47-0733dacfed69\",\n \"client_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"webhook_secret\": \"c44e1b93160e1ccd34ea9c40e79f5f11ea276105b563c53d9ca59e4eb8477686\",\n \"created_at\": \"2023-09-28T10:37:38Z\",\n \"updated_at\": \"2023-09-28T10:37:38Z\"\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nThe API Key can be extracted from data.webhook_secret and does not have an expiration date. Use this API key to authenticate against all requests that support API key based authentication
The update endpoint generates a new API Key. If you run this endpoint, any previous implementations where the old API Key is being used will no longer work.
\n\n\nThis endpoint only supports JWT based authentication
\n
Response:
\nA successful request to this endpoint will generate the following response
\n{\n \"data\": {\n \"token\": \"api_b3db2bd8-5fa3-4ec4-ab47-0733dacfed69\",\n \"client_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"webhook_secret\": \"74b1848b1c876158414d47937f392b7f67cf060ec2a1f44aae4d8a02072d1b69\",\n \"created_at\": \"2023-09-28T10:37:38Z\",\n \"updated_at\": \"2023-09-28T10:37:38Z\"\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nThe new API Key can be accessed by indexing the data object at the webhook_secret property.
API Key management can be performed using these endpoints. An account can have at most one API Key at any given time. This can be retrieved using the Find Api Key endpoint and it can be updated (rotated) using the Update Api Key endpoint.
\n","_postman_id":"d688a7f7-ebfd-4ff4-a7c9-0daefa412940"},{"name":"Merchant Shoppers","item":[{"name":"CRUD","item":[{"name":"Create Customer","id":"58553474-c95a-4edf-8840-3a18a1695cf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Create a new Customer. Once created, customers may be attached to trackers for performing payments.
Before you create a new customer, make sure that the customer doesn’t already exist (with the same email or contact details). Creating multiple customer entries for the same customer can cause you problems later on, such as when you need to reconcile transaction history or coordinate saved payment methods.
\nIf you do not have the customer's contact information, you may instruct the API to generate synthetic data for you.
\n{\n \"use_synthetic\": true\n}\n\nNote that the email defaults to null@getsafepay.com and no email notifications will be created for these customers.
If you have partial data, you may pass that into the request using the fields above and the API will only generate values for the missing fields.
\n","urlObject":{"path":["user","customers","v1",""],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"a171ee35-63db-4bfb-9460-af0aaacc839b","name":"201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"email\": \"hzaidi@getsafepay.com\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"PK\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/customers/v1/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 14:47:16 GMT"},{"key":"Content-Length","value":"428"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"cus_e927d58d-3796-4f36-a209-384906d712ea\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"email\": \"hzaidi@getsafepay.com\",\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"PK\",\n \"is_guest\": true,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1697986036,\n \"nanos\": 25310172\n },\n \"updated_at\": {\n \"seconds\": 1697986036,\n \"nanos\": 25310589\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"0c368b47-7fb1-4c8c-aab8-31379505bf40","name":"201 - Synthetic","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"use_synthetic\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/customers/v1/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Mar 2025 08:43:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"428"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=BFR7VLFxCL3nrozUYylbc24%2BpF2UQYSNV8XaR4zhRe9hN6V%2BgO81QLdfJIfviPYT9KfPf%2Fa3kF5uVhA3FSEvCT8c1Ms%2BvtddtZbod62wHGECT7fv22g2UjntSN%2Bk8xAqyI2SIfgv0sYKA3S4\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9233ec20b8ae167a-KHI"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=27834&min_rtt=26515&rtt_var=10885&sent=4&recv=5&lost=0&retrans=0&sent_bytes=2334&recv_bytes=1004&delivery_rate=108617&cwnd=251&unsent_bytes=0&cid=12b597a3f9b16329&ts=989&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"cus_ac370da3-ca11-4d7c-9699-e2a1503f3113\",\n \"merchant_api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"email\": \"null@getsafepay.com\",\n \"first_name\": \" Talib\",\n \"last_name\": \"Agha\",\n \"phone_number\": \"+923361270164\",\n \"country\": \"PK\",\n \"is_guest\": false,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1742460212,\n \"nanos\": 136429183\n },\n \"updated_at\": {\n \"seconds\": 1742460212,\n \"nanos\": 136429793\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"d7ec0f9c-a5a7-4626-acb9-759ec28d5538","name":"400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"email\": \"hzaidi@getsafepay.com\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"P\",\n \"is_guest\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/customers/v1/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:03:33 GMT"},{"key":"Content-Length","value":"108"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"country: country code unrecognized or not supported.\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"21b8ed93-e6d4-4ba9-b861-dc82c568a10f","name":"401","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"email\": \"hzaidi@getsafepay.com\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"PK\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/customers/v1/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:06:33 GMT"},{"key":"Content-Length","value":"222"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/secret: could not fetch client, error: Resource with this identifier not found, strategies/tbt: missing time based token]\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"58553474-c95a-4edf-8840-3a18a1695cf6"},{"name":"Update Customer","id":"2c3da977-83fd-4a27-a8bc-aa023e057192","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Update details on the customer.
\n","urlObject":{"path":["user","customers","v1","cus_2fc20245-e0f8-447f-af75-fa651cfd54aa"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"15c38e78-e050-4d34-a9c0-b8219b260247","name":"200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Syed\",\n \"last_name\": \"Arsalan\",\n \"email\": \"syed@getsafepay.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/customers/v1/cus_2fc20245-e0f8-447f-af75-fa651cfd54aa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:11:02 GMT"},{"key":"Content-Length","value":"1315"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"cus_2fc20245-e0f8-447f-af75-fa651cfd54aa\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"email\": \"syed@getsafepay.com\",\n \"first_name\": \"Syed\",\n \"last_name\": \"Arsalan\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"PK\",\n \"wallet\": [\n {\n \"token\": \"pm_bea00774-22ba-44ce-82c5-3cdd1a342e89\",\n \"customer\": \"cus_2fc20245-e0f8-447f-af75-fa651cfd54aa\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"kind\": 1,\n \"max_usage\": 1,\n \"usage_interval\": 0,\n \"is_deleted\": false,\n \"cybersource\": {\n \"token\": \"tms_b8543301-95ad-4eae-a86f-8d90a5ece0c7\",\n \"customer_payment_method\": \"pm_bea00774-22ba-44ce-82c5-3cdd1a342e89\",\n \"scheme\": 2,\n \"bin\": \"520000\",\n \"last_four\": \"1096\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2023\",\n \"created_at\": {\n \"seconds\": 1697697321\n },\n \"updated_at\": {\n \"seconds\": 1697697321\n }\n },\n \"usage_count\": 0,\n \"expires_at\": {\n \"seconds\": 1697783722\n },\n \"created_at\": {\n \"seconds\": 1697697321\n },\n \"updated_at\": {\n \"seconds\": 1697697321\n }\n }\n ],\n \"is_guest\": true,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1697550728\n },\n \"updated_at\": {\n \"seconds\": 1697550728\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"2c397df3-e002-4ccc-ba0a-158c52bcb589","name":"400","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Syed\",\n \"last_name\": \"Zaidi\",\n \"email\": \"syed@getsafepay.com\",\n \"phone_number\": \"+01234567\",\n \"country\": \"PK\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/customers/v1/cus_17febb02-b2cd-4cf8-b299-7a447530ef52"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:06:04 GMT"},{"key":"Content-Length","value":"91"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"phone_number: invalid country code.\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"18d71e99-18fc-4db5-893e-c5657ad121e0","name":"401","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Syed\",\n \"last_name\": \"Arsalan\",\n \"email\": \"syed@getsafepay.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/customers/v1/cus_17febb02-b2cd-4cf8-b299-7a447530ef52"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:07:22 GMT"},{"key":"Content-Length","value":"222"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/secret: could not fetch client, error: Resource with this identifier not found, strategies/tbt: missing time based token]\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"0d89e8aa-ac5c-4fd1-a172-bd6bbae6bcff","name":"404","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Syed\",\n \"last_name\": \"Arsalan\",\n \"email\": \"syed@getsafepay.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/customers/v1/cus_17febb02-b2cd-4cf8-b299-7a447530ef52"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:08:18 GMT"},{"key":"Content-Length","value":"74"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"customer not found\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"2c3da977-83fd-4a27-a8bc-aa023e057192"},{"name":"Find Customer","id":"26c44bb0-73b8-40cd-95f1-917c24fb18d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Fetch details for the customer. If the user has any payment methods saved to their wallet, they will be included in the response.
\n","urlObject":{"path":["user","customers","v1","cus_11db365b-4d86-494b-acca-79d6e09efa67"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"1e46d49a-7ed1-464c-88c1-c07d34de56e4","name":"200","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cus_2fc20245-e0f8-447f-af75-fa651cfd54aa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:31:20 GMT"},{"key":"Content-Length","value":"1315"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"cus_2fc20245-e0f8-447f-af75-fa651cfd54aa\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"email\": \"syed@getsafepay.com\",\n \"first_name\": \"Syed\",\n \"last_name\": \"Arsalan\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"PK\",\n \"wallet\": [\n {\n \"token\": \"pm_bea00774-22ba-44ce-82c5-3cdd1a342e89\",\n \"customer\": \"cus_2fc20245-e0f8-447f-af75-fa651cfd54aa\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"kind\": 1,\n \"max_usage\": 1,\n \"usage_interval\": 0,\n \"is_deleted\": false,\n \"cybersource\": {\n \"token\": \"tms_b8543301-95ad-4eae-a86f-8d90a5ece0c7\",\n \"customer_payment_method\": \"pm_bea00774-22ba-44ce-82c5-3cdd1a342e89\",\n \"scheme\": 2,\n \"bin\": \"520000\",\n \"last_four\": \"1096\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2023\",\n \"created_at\": {\n \"seconds\": 1697697321\n },\n \"updated_at\": {\n \"seconds\": 1697697321\n }\n },\n \"usage_count\": 0,\n \"expires_at\": {\n \"seconds\": 1697783722\n },\n \"created_at\": {\n \"seconds\": 1697697321\n },\n \"updated_at\": {\n \"seconds\": 1697697321\n }\n }\n ],\n \"is_guest\": true,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1697550728\n },\n \"updated_at\": {\n \"seconds\": 1697550728\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"61f3a12e-5c66-477e-b994-81c872daec49","name":"400","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cust_2fc20245-e0f8-447f-af75-fa651cfd54aa"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 18:13:55 GMT"},{"key":"Content-Length","value":"131"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"incorrect merchant customer token cust_2fc20245-e0f8-447f-af75-fa651cfd54aa\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"ed54fa35-321c-4b5e-8634-b814f0c12075","name":"401","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cus_2fc20245-e0f8-447f-af75-fa651cfd54aa"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:31:37 GMT"},{"key":"Content-Length","value":"222"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/secret: could not fetch client, error: Resource with this identifier not found, strategies/tbt: missing time based token]\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"8e3ba0fe-b9d0-4e04-b6fb-f0aa57cb1a4a","name":"404","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cus_17febb02-b2cd-4cf8-b299-7a447530ef52"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 17:09:35 GMT"},{"key":"Content-Length","value":"74"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"customer not found\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"26c44bb0-73b8-40cd-95f1-917c24fb18d3"},{"name":"Delete Customer","id":"33a362e5-f6f1-4be6-a3b0-ed8e684b215a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Mark the customer as deleted. The response returns the token that identifies that customer and a deleted property that denotes whether the deletion was successful.
Fetch all customers. The following query modifiers are supported.
\n","urlObject":{"path":["user","customers","v1",""],"host":["https://sandbox.api.getsafepay.com"],"query":[{"key":"limit","value":"20"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"f88af5b4-f775-436c-9a75-2b976b7fde6a","name":"200","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":{"raw":"https://dev.api.getsafepay.com/user/customers/v1/?limit=20&page=1","host":["https://dev.api.getsafepay.com"],"path":["user","customers","v1",""],"query":[{"key":"limit","value":"20"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 18:41:30 GMT"},{"key":"Content-Length","value":"1785"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"customers\": [\n {\n \"token\": \"cus_c79ef0ed-a787-4dee-98db-f0911044614c\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"email\": \"hzaidi@getsafepay.com\",\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"phone_number\": \"+913331234567\",\n \"country\": \"PK\",\n \"is_guest\": true,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1697994236\n },\n \"updated_at\": {\n \"seconds\": 1697994236\n }\n },\n {\n \"token\": \"cus_c3664cbc-3988-49b8-a3c7-6ad958793cf5\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"email\": \"hzaidi@getsafepay.com\",\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"PK\",\n \"is_guest\": true,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1697994232\n },\n \"updated_at\": {\n \"seconds\": 1697994232\n }\n },\n {\n \"token\": \"cus_bc04ca6f-2bd5-45df-8ace-8c81f8172bf4\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"email\": \"hzaidi@getsafepay.com\",\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"P\",\n \"is_guest\": true,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1697986055\n },\n \"updated_at\": {\n \"seconds\": 1697986055\n }\n },\n {\n \"token\": \"cus_e927d58d-3796-4f36-a209-384906d712ea\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"email\": \"hzaidi@getsafepay.com\",\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"PK\",\n \"is_guest\": true,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1697986036\n },\n \"updated_at\": {\n \"seconds\": 1697986036\n }\n },\n {\n \"token\": \"cus_2fc20245-e0f8-447f-af75-fa651cfd54aa\",\n \"merchant_api_key\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"email\": \"syed@getsafepay.com\",\n \"first_name\": \"Syed\",\n \"last_name\": \"Arsalan\",\n \"phone_number\": \"+923331234567\",\n \"country\": \"PK\",\n \"is_guest\": true,\n \"is_deleted\": false,\n \"created_at\": {\n \"seconds\": 1697550728\n },\n \"updated_at\": {\n \"seconds\": 1697550728\n }\n }\n ],\n \"count\": 5\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"bf35b08c-195c-4d8a-ab18-d61df9af9482","name":"400","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":{"raw":"https://dev.api.getsafepay.com/user/customers/v1/?limit=20&page=-1","host":["https://dev.api.getsafepay.com"],"path":["user","customers","v1",""],"query":[{"key":"limit","value":"20"},{"key":"page","value":"-1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 18:42:16 GMT"},{"key":"Content-Length","value":"85"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"page: must be no less than 1.\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"81d87499-f4e0-4847-a335-4150cdc41069","name":"401","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":{"raw":"https://dev.api.getsafepay.com/user/customers/v1/?limit=20&page=0","host":["https://dev.api.getsafepay.com"],"path":["user","customers","v1",""],"query":[{"key":"limit","value":"20"},{"key":"page","value":"0"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 18:42:33 GMT"},{"key":"Content-Length","value":"222"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/secret: could not fetch client, error: Resource with this identifier not found, strategies/tbt: missing time based token]\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"3e786570-62fd-4520-953b-809e092a4eb8"}],"id":"0d63472a-d71f-4814-88d1-8b7a5d2ab2be","description":"Manage your customers.
\n","_postman_id":"0d63472a-d71f-4814-88d1-8b7a5d2ab2be"},{"name":"Customer Payment Methods","item":[{"name":"Find Payment Method","id":"84ed7202-22f1-4131-8324-1ca2d8292992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Fetch details for the payment method.
\n","urlObject":{"path":["user","customers","v1","cus_2fc20245-e0f8-447f-af75-fa651cfd54aa","wallet","pm_bea00774-22ba-44ce-82c5-3cdd1a342e89"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"c7631295-6fb3-4b9b-af7b-4ceb2047c4af","name":"200","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cus_2fc20245-e0f8-447f-af75-fa651cfd54aa/wallet/pm_bea00774-22ba-44ce-82c5-3cdd1a342e89"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 19:06:15 GMT"},{"key":"Content-Length","value":"964"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"pm_3b4a7c47-99cc-4fda-9b4c-b46b11e2cd18\",\n \"customer\": \"cus_a03d1304-d088-4a60-801f-b6a3d44b445d\",\n \"merchant_api_key\": \"sec_efbce898-4cc4-4c00-ba45-f00001804a60\",\n \"kind\": 1,\n \"max_usage\": 1,\n \"usage_interval\": 0,\n \"is_deleted\": false,\n \"billing_address\": {\n \"token\": \"address_25f9c917-9d73-4e45-964a-916df314d388\",\n \"owner\": \"cus_a03d1304-d088-4a60-801f-b6a3d44b445d\",\n \"street1\": \"house\",\n \"city\": \"Houstan\",\n \"state\": \"TX\",\n \"postal_code\": \"77027\",\n \"country\": \"US\",\n \"is_default\": false,\n \"created_at\": {\n \"seconds\": 1700724454\n },\n \"updated_at\": {\n \"seconds\": 1700724454\n }\n },\n \"cybersource\": {\n \"token\": \"tms_eb5660d2-e0d6-4898-8fb0-51f53ff49022\",\n \"customer_payment_method\": \"pm_3b4a7c47-99cc-4fda-9b4c-b46b11e2cd18\",\n \"fingerprint\": \"7d7c3ca2d742e36733aca5a7a595ed822eaaf2b7295cc9599819e3928ce85fc9\",\n \"scheme\": 2,\n \"bin\": \"520000\",\n \"last_four\": \"1096\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2028\",\n \"created_at\": {\n \"seconds\": 1700724455\n },\n \"updated_at\": {\n \"seconds\": 1700724455\n }\n },\n \"usage_count\": 0,\n \"expires_at\": {\n \"seconds\": 1700810855\n },\n \"created_at\": {\n \"seconds\": 1700724455\n },\n \"updated_at\": {\n \"seconds\": 1700724455\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"c6b30a2e-c76b-456f-8ad5-c642ad7c0028","name":"400","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cus_2fc20245-e0f8-447f-af75-fa651cfd54aa/wallet/pfd_bea00774-22ba-44ce-82c5-3cdd1a342e89"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 19:39:09 GMT"},{"key":"Content-Length","value":"136"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"incorrect customer payment method token pfd_bea00774-22ba-44ce-82c5-3cdd1a342e89\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"a251824a-1287-45c6-b625-b5d91f75d37d","name":"401","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cus_2fc20245-e0f8-447f-af75-fa651cfd54aa/wallet/pm_bea00774-22ba-44ce-82c5-3cdd1a342e89"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 19:40:25 GMT"},{"key":"Content-Length","value":"222"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/secret: could not fetch client, error: Resource with this identifier not found, strategies/tbt: missing time based token]\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"cc4a5232-a963-44a8-9bcd-42607f561f68","name":"403","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cus_2fc20245-e0f8-447f-af75-fa651cfd54aa/wallet/pm_bea00774-22ba-44ce-82c5-3cdd1a342e8"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 19:30:40 GMT"},{"key":"Content-Length","value":"126"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"the requested payment method does not belong to this customer's wallet\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"d2aef341-bbba-4703-83af-cc2742918aca","name":"404","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://dev.api.getsafepay.com/user/customers/v1/cus_2fc20245-e0f8-447f-af75-fa61cfd54aa/wallet/pm_bea00774-22ba-44ce-82c5-3cdd1a342e89"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sun, 22 Oct 2023 19:40:10 GMT"},{"key":"Content-Length","value":"74"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"customer not found\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"84ed7202-22f1-4131-8324-1ca2d8292992"},{"name":"Delete Payment Method","id":"abca60ca-aa3a-496f-81f6-117aac7bce1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Mark the payment method as deleted. The response returns the token that identifies that payment method and a deleted property that denotes whether the deletion was successful.
Fetch all payment methods belonging to a customer.
\nThe wallet property will contain the list of payment methods that have been searched for while the count will indicate how many results were returned.
Manage payment methods belonging to your customers' wallets. To create payment methods, a customer must go through a checkout session and consent to saving their payment method details for future use.
\nThe kind may take the following values:
1 - CYBERSOURCE
2 - MPGS
The usage_interval may take the following values:
0 - LIFETIME
1 - DAY
Example: a max_usage of 5 with usage_interval 1 signifies that a payment method may be used up to a maximum of 5 times within a day. A max_usage of -1 denotes unlimited use.
The Cybersource object is document below:
\nThe scheme may take the following values:
1 - Visa
2 - Mastercard
Create a new address. You must authenticate with your secret key. Once created, an address may be passed to the checkout session to be used as the billing details for the payment.
\n","urlObject":{"path":["user","address","v2",""],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"363b51c3-e8f5-4182-8b9c-66efa6bec9f0","name":"201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"street1\": \"House 54, St 11A\",\n \"street2\": \"Royal Canyon Vistas\",\n \"city\": \"Islamabad\",\n \"state\": \"Capital Territory\",\n \"postal_code\": \"44000\",\n \"country\": \"PK\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.api.getsafepay.com/user/address/v2/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Nov 2023 18:06:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"379"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8258f23de8d8d1f4-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"address_5ce54f87-a823-4da6-8990-7b26d048ce00\",\n \"street1\": \"House 54, St 11A\",\n \"street2\": \"Royal Canyon Vistas\",\n \"city\": \"Islamabad\",\n \"state\": \"Capital Territory\",\n \"postal_code\": \"44000\",\n \"country\": \"PK\",\n \"is_default\": false,\n \"created_at\": {\n \"seconds\": 1699898762,\n \"nanos\": 38301558\n },\n \"updated_at\": {\n \"seconds\": 1699898762,\n \"nanos\": 38302407\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"78a58b4a-9290-4543-bbb1-f654d06ce85d","name":"400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \n}","options":{"raw":{"language":"json"}}},"url":"https://dev.api.getsafepay.com/user/address/v2/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Nov 2023 18:05:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"157"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8258f1800eefd1f4-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"city: cannot be blank; country: country code unrecognized or not supported; street1: cannot be blank.\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"c2b4a49d-3a43-4f23-af6f-91c6f04f453f","name":"401","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"street1\": \"House 54, St 11A\",\n \"street2\": \"Royal Canyon Vistas\",\n \"city\": \"Islamabad\",\n \"state\": \"Capital Territory\",\n \"postal_code\": \"44000\",\n \"country\": \"PK\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.api.getsafepay.com/user/address/v2/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Nov 2023 18:06:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"222"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8258f2cb5c15d1f4-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/secret: could not fetch client, error: Resource with this identifier not found, strategies/tbt: missing time based token]\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"b4f401ad-ea42-48d0-9055-9f743b92303e"},{"name":"Update Address","id":"f359701f-ec57-438a-8a03-1edfbdcbc90b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Update an address. You must authenticate with your secret key.
\n","urlObject":{"path":["user","address","v2","address_5ce54f87-a823-4da6-8990-7b26d048ce00"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"cf624782-236a-4a11-8f1a-1e3ae357447a","name":"200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"street1\": \"House 34, St 12A\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.api.getsafepay.com/user/address/v2/address_5ce54f87-a823-4da6-8990-7b26d048ce00"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Nov 2023 18:12:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8258fb5f9ebbd1f4-MCT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"address_5ce54f87-a823-4da6-8990-7b26d048ce00\",\n \"street1\": \"House 34, St 12A\",\n \"street2\": \"Royal Canyon Vistas\",\n \"city\": \"Islamabad\",\n \"state\": \"Capital Territory\",\n \"postal_code\": \"44000\",\n \"country\": \"PK\",\n \"is_default\": false,\n \"created_at\": {\n \"seconds\": 1699898762\n },\n \"updated_at\": {\n \"seconds\": 1699899136,\n \"nanos\": 49865133\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"8b34fcf7-bb50-4f34-ba96-7532a34d2cdc","name":"400","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"country\": \"Pakistan\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.api.getsafepay.com/user/address/v2/address_5ce54f87-a823-4da6-8990-7b26d048ce00"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Nov 2023 18:12:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"108"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8258fc50ed60d1f4-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"country: country code unrecognized or not supported.\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"7ee3ca98-f3b1-4e31-8f5a-62809fa28d8e","name":"401","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"country\": \"PK\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.api.getsafepay.com/user/address/v2/address_5ce54f87-a823-4da6-8990-7b26d048ce00"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Nov 2023 18:13:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"222"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8258fce7d9a5d1f4-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/secret: could not fetch client, error: Resource with this identifier not found, strategies/tbt: missing time based token]\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"960841d5-b474-4748-8183-cf1da7e3c68f","name":"404","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"country\": \"PK\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.api.getsafepay.com/user/address/v2/address_5ce54f87-a823-4da6-8990-7b26d048ce09"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Nov 2023 18:14:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8258fe812a5ed1f4-MCT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"address not found\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"f359701f-ec57-438a-8a03-1edfbdcbc90b"},{"name":"Find Address","id":"50ea3738-beb0-4f77-b465-9d3afc159a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Find an address using its token. You must authenticate using your secret key.
Create addresses to associate with customer payment methods. Creating addresses server-side allows you to pre-populate addresses for your customers. These can then be passed to the checkout session, saving the customer from having to re-enter their billing details.
\nCreate and manage customers linked to your store. The customer object encapsulates the contact details of a user along with payment methods that a user wants to save to their wallet. Customers may also be marked as guests to support one time payments.
All customer related endpoints may be authenticated with your merchant Secret key.
Create a tracker with mode payment.
Create a tracker with mode payment.
Create a tracker with mode instrument. This tracker will save a payment method for future use.
For cards, there is an option to save the payment method with a zero amount authorization. To achieve this, add the following to the request body:
\n\"is_account_verification\": true
Note that if this is set then there is no need to perform a reversal as is required in the standard flow.
\n","urlObject":{"path":["order","payments","v3",""],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"3acbafa5-12f9-45df-81a0-392c78a006dd","name":"201 - flex","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\", \n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"instrument\",\n \"currency\": \"PKR\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Nov 2024 17:35:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"623"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8dbda46d29174619-SIN"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_c6ee552a-f166-4ec2-bae1-5f38a9b45c8d\",\n \"client\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"instrument\",\n \"entry_mode\": \"flex\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"GENERATE_CAPTURE_CONTEXT\"\n },\n \"MPGS\": {\n \"kind\": \"NOOP\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 500\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 500\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n },\n \"metadata\": {}\n },\n \"capabilities\": {\n \"CYBERSOURCE\": true,\n \"MPGS\": true\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"78bc5e1f-74f6-4dc0-a370-c2fb85892d95","name":"201 - raw","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\", \n \"user\": \"cus_00e2092d-b54e-4d5f-8dbb-cdb96ed0eccc\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"instrument\",\n \"entry_mode\": \"raw\",\n \"currency\": \"PKR\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Nov 2024 17:36:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"614"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8dbda5c93ca84619-SIN"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_55944ce6-f1e3-4227-9ab9-56484718dc53\",\n \"client\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"instrument\",\n \"entry_mode\": \"raw\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"PAYER_AUTH_SETUP\"\n },\n \"MPGS\": {\n \"kind\": \"NOOP\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 500\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 500\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n },\n \"metadata\": {}\n },\n \"capabilities\": {\n \"CYBERSOURCE\": true,\n \"MPGS\": true\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"82d84375-2689-409f-988c-68f86a7bc47d","name":"201 - With merchant shopper","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"user\": \"cus_b4afd638-41bf-4831-af07-587b51269f38\", \n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"instrument\",\n \"entry_mode\": \"raw\",\n \"currency\": \"PKR\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Nov 2024 17:54:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"668"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8dbdbf9e7cfa401a-SIN"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_e244f1fa-4af4-4dc4-8d6f-8101b36bedf6\",\n \"client\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"instrument\",\n \"entry_mode\": \"raw\",\n \"customer\": \"cus_b4afd638-41bf-4831-af07-587b51269f38\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"PAYER_AUTH_SETUP\"\n },\n \"MPGS\": {\n \"kind\": \"NOOP\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 500\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 500\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n },\n \"metadata\": {}\n },\n \"capabilities\": {\n \"CYBERSOURCE\": true,\n \"MPGS\": true\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"e839facd-a8fa-465c-a58c-02f1b2aaf662","name":"201 - Zero amount authorization","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\", \n \"intent\": \"CYBERSOURCE\",\n \"user\": \"cus_00e2092d-b54e-4d5f-8dbb-cdb96ed0eccc\",\n \"mode\": \"instrument\",\n \"entry_mode\": \"raw\",\n \"is_account_verification\": true,\n \"currency\": \"PKR\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 05 Dec 2024 06:41:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"658"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=V9ldFt3mH9AHZNIC37r0eZ%2FHVRoRtDtrWRl%2BbqOuQuMt6jWcob%2FJ0E98iDS4nuxcVt23Sc7c11QXJWOfj5prZsWMXB0zbK9cwb7LM3adpVE26o4a88GgjS19dtfAnwb%2FoelxKW8jdCsIMxib\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ed20da7fc7f9d10-SIN"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=124159&min_rtt=123978&rtt_var=35226&sent=23&recv=22&lost=0&retrans=0&sent_bytes=4414&recv_bytes=1570&delivery_rate=34461&cwnd=253&unsent_bytes=0&cid=a721e0784bc1778a&ts=19290&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_fb614ed6-718f-414d-906b-4453b5706392\",\n \"client\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_STARTED\",\n \"payment_method_kind\": \"card\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"instrument\",\n \"entry_mode\": \"raw\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"PAYER_AUTH_SETUP\"\n },\n \"MPGS\": {\n \"kind\": \"NOOP\"\n },\n \"PAYFAST\": {\n \"kind\": \"NOOP\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\"\n },\n \"base_amount\": {\n \"currency\": \"PKR\"\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n },\n \"metadata\": {}\n },\n \"capabilities\": {\n \"CYBERSOURCE\": true,\n \"MPGS\": true,\n \"PAYFAST\": true\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"}],"_postman_id":"73d24fdb-8cf5-4af9-aa89-f2a6ff327cf2"},{"name":"Unscheduled COF","id":"62bb1994-41ba-4d71-9175-d29a5001dec0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"user\": \"cus_b4afd638-41bf-4831-af07-587b51269f38\", \n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"unscheduled_cof\",\n \"currency\": \"PKR\",\n \"amount\": 10050\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/","urlObject":{"path":["order","payments","v3",""],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"421be90f-1682-4cc7-8109-eeab1f8a1dbf","name":"201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"user\": \"cus_b4afd638-41bf-4831-af07-587b51269f38\", \n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"unscheduled_cof\",\n \"currency\": \"PKR\",\n \"amount\": 10050\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Nov 2024 18:11:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"674"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8dbdd97659b39b96-SIN"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_da499080-3c67-4f82-8f33-c4338c8020c5\",\n \"client\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"unscheduled_cof\",\n \"entry_mode\": \"tms\",\n \"customer\": \"cus_b4afd638-41bf-4831-af07-587b51269f38\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"AUTHORIZATION\"\n },\n \"MPGS\": {\n \"kind\": \"NOOP\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 10050\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 10050\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n },\n \"metadata\": {}\n },\n \"capabilities\": {\n \"CYBERSOURCE\": true,\n \"MPGS\": true\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"d21e7c51-8962-4160-80a7-7c5ffe7f69e0","name":"404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a2\",\n \"user\": \"cus_b4afd638-41bf-4831-af07-587b51269f38\", \n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"unscheduled_cof\",\n \"currency\": \"PKR\",\n \"amount\": 10050\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Nov 2024 18:11:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8dbdd8ad0afd9b96-SIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"could not find customer: sql: no rows in result set\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"62bb1994-41ba-4d71-9175-d29a5001dec0"}],"id":"7fcfa13f-bf41-4b86-80c6-5ca178d80baa","description":"Create payment trackers. A tracker captures all events that pertain to to a single order for example attempts to pay using a particular payment method, authorization responses from issuing banks, error messages and more. Before an order can be processed, a tracker needs to be created with some initial configuration.
An intent must be provided. This denotes the payment integration which will be used to pay this tracker. Note that this can be changed dynamically when a customer wishes to pay using an alternative payment method. Supported values are:
CYBERSOURCE for card payments with Visa or Mastercard branded cards.A mode may also specified when requesting creation of a tracker. The mode describes the purpose of the tracker. For now, it may take the following value:
payment for regular payments as a guest user.
instrument for saving a payment method to a customer's wallet.
subscription for recurring payments with a saved card or Network Token.
unscheduled_cof for making a merchant initiated payment using a merchant shopper's saved card.
unscheduled_raw for non-cvv and non-3Ds payments and raw card details.
\n\nNote that the legacy
\npayment-rawmode has now been deprecated and can be triggered using therawentry mode instead
\n\nNote that unscheduled_cof applies to trackers where a customer object has been attached.
\n
Support for other modes will be available in the future. If no mode is specified, then by default the mode is set to payment.
An entry_mode may also be specified to denote the way in which the customer's payment method details are collected. The options are as follows:
flex for paying via Cybersource Flex Microform transient tokens
raw for paying via payment method details in plaintext
tms for paying via Cybersource TMS (tokenization)
network_token for payments and CITs (Customer Initiated Transaction) with Network Tokens
mit for MITs (Merchant Initiated Transaction) via Cybersource TMS (tokenization)
Support for other entry modes will be available in the future. If no entry mode is specified, then by default the mode is set to flex.
Perform the GENERATE_CAPTURE_CONTEXT action. Generates a JWT token that is used to generate the card fields on the checkout form. The capture context essentially establishes a payment session.
The capture context is necessary for generating the Cybersource Flex Microform. These are card fields hosted on Cybersource that are used to capture the customer's card details. The form is embedded in your checkout UI.
\nFor more details on how to generate the form, please refer to the Microform guide. Specifically, you should refer to the Client Side documentation. This process should help you obtain the transient token JWT from the card fields which you will require for the next action.
\nThe capture context also specifies a target origin for which it is valid. By default, this is set to Safepay Checkout. However, this may be modified by authenticating as a merchant via the Secret Key and passing the origin as follows:
{\n \"payload\": {\n \"origin\": \"https://api-example.com\"\n }\n}\n\nIf targeting Safepay Checkout, this can be left as an empty body: {}. Note that setting a custom origin is only honoured when authenticated as a merchant. For merchant authentication, refer to the API Authentication section.
Perform the PROCESS_TRANSIENT_TOKEN action. This decodes and processes the provided transient token JWT to setup payer authentication.
The transient token can be obtained once the customer has entered their card details (PAN, expiry and CVV/CVN). Please refer to the Cybersource Microform documentation for details.
\nThe response for this action yields the card details along with the payer_authentication_setup object which carries the access_token and the device_data_collection_url. These are necessary for collecting the user's device data and passing the resulting fingerprint in the enrollment step.
Perform the PAYER_AUTHENTICATION_SETUP action. This action is the starting point for a tracker that has raw or tms entry modes. It is the entry point for a payment flow where we setup the 3DS enrollment journey for the customer.
Explore the example payloads to see how to pass the payment method details for raw and tms entry modes. For flex you may pass an empty body {}.
The response for this action yields the card details along with the payer_authentication_setup object which carries the access_token and the device_data_collection_url. These are necessary for collecting the user's device data and passing the resulting fingerprint in the enrollment step.
Perform the PAYER_AUTH_ENROLLMENT action. This marks the start of the payer authentication process. For details please refer to the Cybersource Payer Authentication documentation.
As the documentation states, there are 5 steps for the complete process. Note that Steps 1, 3, and 5 are to be performed server side and are handled by the Safepay API. You will need to perform Step 2: Device Data Collection before calling this action. And you will need to perform Step 4: Step-Up Iframe after receiving the response for this action.
\nTo succeed enrollment and trigger liability shift you must pass the device_fingerprint_session_id which you will obtain after performing Step 2: Device Data Collection.
You must provide the customer's billing details under payload.billing:
If you do not have this information, you may instruct the API to generate synthetic data by making use of the use_synthetic field as shown below:
\"payload\": {\n ...\n \"billing\": {\n \"use_synthetic\": true\n }\n ...\n}\n\nYou must also provide authorization configuration under payload.authorization. Additional configuration options will be made available in the future. We recommend this default:
You must also provide payer authentication configuration under payload.authentication_setup:
You must also authenticate using JWT that represents the guest user. Refer to the documentation for API Authentication.
\nNote that while device_fingerprint_session_id is optional, not passing it will default to 3DS v1 on Cybersource's end which they have dropped support for. Therefore to ensure successful enrollment and liability shift, you should include this in the request.
If enrollment is successful, you should obtain the appropriate ECI values and the access_token in the payer_authentication_enrollment object.
The response will also yield an authentication_status field that may take the following values. Here is how to interpret these:
The values for eci or eci_raw denote whether enrollment was successful:
Rendering the issuer step-up challenge is documented in Step 4: Step-Up Iframe.
\nThe user will go through the 3DS flow by entering the OTP code received on their phone (or alternative methods proposed by the issuer). On a successful response, the user will be redirected to Safepay and then ultimately to the success_url that you have provided. Similarly, failures will redirect to the failure_url.
Returning to the success_url yields a successful authorization. Note that for the frictionless flow you may proceed to authorization.
Perform the AUTHORIZATION action.
Note that you will call Authorization when enrollment was frictionless (i.e. no challenge was applicable) or if enrollment could not be completed by the issuer.If enrollment follows up with the challenge and the customer has been redirected to your checkout, then you must proceed to Capture instead.
\nFor this action, you need to pass in the authorization configuration.
Actions are chained by default by the Order API where actions that do not require additional input from the client will execute in a loop. Since CAPTURE is one such action, it will be chained and executed even when authorization.do_capture is set to false.
Setting authorization.do_capture to true essentially performs a sale as opposed to an authorization followed by capture.
If you wish to perform captures manually, you may run this request by setting use_action_chaining to false in the request body (outside of the payload). This will then only perform the AUTHORIZATION action and allow you to perform the capture (or a reversal) at a later time.
When we set the mode to payment and the entry_mode to network_token in the setup api, we are initating a CIT (Customer Initiated Transaction). When we are dealing with Network Tokens, the next action after setup will be AUTHORIZATION, so we will have to send the extra information in the Authorization request which we otherwise wouldn't have needed to. This includes the Billing information, as well as the Payment Method in the form of a Network Token. As per usual the authorization settings are also required. The response will include a TMS-Token that can be used for subsequent MITs. The response contains the tms token like so: action.token.payment_method.token: \"tms_ea7323a9......\".
When we set the mode to subscription and the entry_mode to mit in the setup api, we are initating a MIT (Merchant Initiated Transaction). MITs function fairly similarly to Subscriptions with TMS tokens, since in this case you are expected to pass a TMS token in the request alongside the authorization settings. However, a MIT must always have an attached CIT. As mentioned above a CIT can be initated using a Network Token, however a raw payment will also work, as long as the do_card_on_file setting was set to true and a pm_ token was returned in the response. This token can also be used for MITs.
Perform the CAPTURE action. The request body may be empty. Note that this action is expected for the regular 3DS flow where the customer is redirected to your checkout after enrollment.
Perform the REVERSAL action. The request body may be empty. Note that this action is expected for the regular 3DS flow where the customer is redirected to your checkout after enrollment.
This is relevant for the instrument mode used to save a payment method. In this scenario, the authoirzation hold on the customer's funds must be removed by requesting a reversal.
This request must be authenticated by a Safepay shopper or merchant shopper.
\n","urlObject":{"path":["order","payments","v3","track_1a46dc70-91f9-4892-8e25-0bb5205b69c7"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"4fd9b56a-681d-4479-929a-b43f71ccf1b6","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_1a46dc70-91f9-4892-8e25-0bb5205b69c7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 06 Oct 2023 18:58:16 GMT"},{"key":"Content-Length","value":"818"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_1a46dc70-91f9-4892-8e25-0bb5205b69c7\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_ENDED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"NOOP\",\n \"request_id\": \"req_9ea53be5-828f-4730-b187-9d3d350ab72a\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n }\n },\n \"action\": {\n \"token\": \"req_9ea53be5-828f-4730-b187-9d3d350ab72a\",\n \"payment_method\": {\n \"token\": \"card_353d4bd9-1d72-4f4d-a358-b277833795a4\",\n \"expiration_month\": \"12\",\n \"expiration_year\": \"2023\",\n \"card_type_code\": \"001\",\n \"card_type\": \"Visa\",\n \"bin_number\": \"445653\",\n \"last_four\": \"1096\"\n }\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"}],"_postman_id":"fe7c2a1b-ea88-4b80-99bf-77369ea713e2"}],"id":"250ed8ec-7f84-4dcf-843b-f169ad7f4538","description":"Process a tracker. A tracker is ultimately a state machine that tracks the life of a payment. This endpoint allows you to add progress to a tracker's state.
An important concept to understand here is next_actions for a tracker. Given an intent and a mode set during the Setup endpoint, the tracker returns the next_actions that need to be executed. For example:
{\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"GENERATE_CAPTURE_CONTEXT\"\n }\n }\n}\n\nThis means that to progress the tracker for a card payment (via Cybersource), the next action to be executed is GENERATE_CAPTURE_CONTEXT.
Executing actions requires running the Order endpoint with appropriate payloads. The client may run the Order endpoint repeatedly until no more actions remain. This is signified by the NO_OP action at which point the payment would be complete (refer to the Capture example).
The response returns the updated tracker and the result of the action inside the action object. This is often necessary for preparing the payload for the subsequent action.
All actions and their payloads are documented within the requests and their examples.
\nOur backend will try resolve the location and device information from the requests made to our server. You may want to explicitly pass these to our APIs for more accurate reporting.
\nYou may pass the IP address as in the header with key: X-SFPY-IP-ADDRESS.
And you may pass the user agent string in the header with key: X-SFPY-USER-AGENT.
Reset the tracker to its original state. This sets the default state and next_actions based on the mode and intent.
No body is required for this request but it requires user (JWT) or merchant authentication (JWT, api key, or secret key).
\n","urlObject":{"path":["order","payments","v3","track_aefeaefe-c21a-4678-ab1e-181bfe2920be"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"9a794671-8f68-4fdb-ae69-3fb2ea143638","name":"200","originalRequest":{"method":"PUT","header":[],"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_dccdef16-008e-4fae-81cc-1b7d81bf6c44"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 10:08:48 GMT"},{"key":"Content-Length","value":"611"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_dccdef16-008e-4fae-81cc-1b7d81bf6c44\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"GENERATE_CAPTURE_CONTEXT\",\n \"request_id\": \"req_f3810877-fc7c-45ca-bc6c-f2f00e72cb1a\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n }\n },\n \"capabilities\": {\n \"CYBERSOURCE\": true\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"a990974c-64a4-4f61-b3e9-69e9e44c24a7","name":"400","originalRequest":{"method":"PUT","header":[],"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_70fdbb06-bbf7-44e1-b50a-672d9f1d8b26"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 10:11:51 GMT"},{"key":"Content-Length","value":"109"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"cannot reset tracker in inactive state TRACKER_VOIDED\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"48686db8-81bd-4aa0-b99f-7a34760a8d84"},{"name":"Add Metadata","id":"cde678e3-be61-4cb4-9cc3-ed171df0f4ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Add custom metadata to the tracker as key-value pairs.
We support the following keys at this time:
\nsource For example \"shopify\", \"magento\", \"woocommerce\" or \"custom\" for SDK integrations.
order_id For tying an ID relevant to your store to this tracker for reconciliation
This request requires merchant authentication (via JWT, api key, or secret key).
\n","urlObject":{"path":["order","payments","v3","track_aa38d5b7-a3a2-45c5-bed8-586b0bae8d06","metadata"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"715fca7b-2016-4c42-8e2c-b2dd3e3af3e9","name":"201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"source\": \"shopify\",\n \"order_id\": \"41231X\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_aa38d5b7-a3a2-45c5-bed8-586b0bae8d06/metadata"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 10:32:28 GMT"},{"key":"Content-Length","value":"635"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_aa38d5b7-a3a2-45c5-bed8-586b0bae8d06\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"PROCESS_TRANSIENT_TOKEN\",\n \"request_id\": \"req_1f1382bd-826f-46a3-a2b2-fc6d5aa8a18d\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 700000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 700000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n },\n \"metadata\": {\n \"data\": {\n \"order_id\": \"41231X\",\n \"source\": \"shopify\"\n }\n }\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"69c07353-69f7-4d4c-bdb8-44605d0e3615","name":"400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"source\": \"shopify\",\n \"order_id\": \"41231X\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_70fdbb06-bbf7-44e1-b50a-672d9f1d8b26/metadata"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 10:12:57 GMT"},{"key":"Content-Length","value":"131"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"could not set metadata: cannot edit metadata when session is TRACKER_VOIDED\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"cde678e3-be61-4cb4-9cc3-ed171df0f4ad"}],"id":"ee13c297-e725-4b1f-8030-316a058f5a57","description":"A tracker may also be configured in the following ways.
Reset the next_actions and state for the tracker to the default. Note that this is only possible when the tracker is active (i.e. not paid).
For adding custom values to the tracker for example an external ID from your store.
Reverse a card authorization. You must pass the token for the authorization in question. You will find this in the tracker details page on your merchant dashboard.
\n","urlObject":{"path":["order","payments","v3","track_9d765b77-608f-46bc-84d2-5f4392753ca3","reversal"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"ea602a2e-5f7b-4ffb-8e48-c0aeb31486aa","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"authorization\": \"auth_621f9b56-9dba-46b6-92e3-3cd13516c6a5\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_9d765b77-608f-46bc-84d2-5f4392753ca3/reversal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 08:48:05 GMT"},{"key":"Content-Length","value":"565"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_9d765b77-608f-46bc-84d2-5f4392753ca3\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_REVERSED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"instrument\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"NOOP\",\n \"request_id\": \"req_55e5ef0a-9081-498b-80b2-ce65f5f0efda\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 100\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 100\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n }\n },\n \"action\": {}\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"f75dc2f1-09cf-40b1-b4c5-c5bdce36de1e","name":"400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"authorization\": \"auth_621f9b56-9dba-46b6-92e3-3cd13516c6a5\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_70fdbb06-bbf7-44e1-b50a-672d9f1d8b26/reversal"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 08:44:17 GMT"},{"key":"Content-Length","value":"101"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"cannot reverse tracker in state TRACKER_ENDED\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"0c7dd6e3-b3a3-4e3d-b2dc-84b96ba65acb","name":"401","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"authorization\": \"auth_621f9b56-9dba-46b6-92e3-3cd13516c6a5\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_9d765b77-608f-46bc-84d2-5f4392753ca3/reversal"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 08:48:33 GMT"},{"key":"Content-Length","value":"320"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/jwt: missing jwt token, strategies/jwt: missing jwt token, strategies/api_key: merchant api key not found in the request header, strategies/secret: could not fetch client, error: Resource with this identifier not found]\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"e55809d4-b8c6-4639-a3ab-527ffaa795aa"},{"name":"Refund","id":"1e7734ea-8478-42cf-9efa-94265e7777e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Perform a refund.
\nNote that card refunds are only applicable for up to 90 days after the transaction has completed.
\n","urlObject":{"path":["order","payments","v3","track_70fdbb06-bbf7-44e1-b50a-672d9f1d8b26","refund"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"dab083b0-cfef-438f-98e4-97146017e306","name":"200 - Partial","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currency\": \"PKR\",\n \"amount\": 1000\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_1a46dc70-91f9-4892-8e25-0bb5205b69c7/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 08:59:40 GMT"},{"key":"Content-Length","value":"574"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_1a46dc70-91f9-4892-8e25-0bb5205b69c7\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_PARTIAL_REFUND\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"NOOP\",\n \"request_id\": \"req_9ea53be5-828f-4730-b187-9d3d350ab72a\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n }\n },\n \"action\": {}\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"e3b8a9b5-9d4d-4f4c-8bea-309dd4f5c14d","name":"200 - Full","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currency\": \"PKR\",\n \"amount\": 600000\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_70fdbb06-bbf7-44e1-b50a-672d9f1d8b26/refund"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 09:07:00 GMT"},{"key":"Content-Length","value":"568"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_70fdbb06-bbf7-44e1-b50a-672d9f1d8b26\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_REFUNDED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"NOOP\",\n \"request_id\": \"req_41429bc1-7807-482d-b046-2cabee424314\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n }\n },\n \"action\": {}\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"e66e4a04-fb64-4035-ac2c-e35be18247f7","name":"400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"currency\": \"PKR\",\n \"amount\": 1000\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_70fdbb06-bbf7-44e1-b50a-672d9f1d8b26/refund"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 09:07:14 GMT"},{"key":"Content-Length","value":"103"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"cannot refund tracker in state TRACKER_REFUNDED\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"1e7734ea-8478-42cf-9efa-94265e7777e0"},{"name":"Void","id":"845c859f-8212-43b3-889c-3a1adcaf99c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Perform a void. You may request to void the following events:
\nVOID_CAPTURE for voiding a regular standalone capture
VOID_PAYMENT for voiding a combined authorization with capture. This is revelant for subscription payments as well as any regular payments where do_capture was set to true when configuring the authorization options.
VOID_REFUND for voiding a refund. You must provide the refund Token which can be found from the tracker details page.
Note that a void may not take effect if the settlement cycle has already run.
\n","urlObject":{"path":["order","payments","v3","track_1a46dc70-91f9-4892-8e25-0bb5205b69c7","void"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"8eb85ef4-70d6-4596-97d7-564b2d523258","name":"200 - Capture","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"kind\": \"VOID_CAPTURE\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_1a46dc70-91f9-4892-8e25-0bb5205b69c7/void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 09:49:42 GMT"},{"key":"Content-Length","value":"566"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_1a46dc70-91f9-4892-8e25-0bb5205b69c7\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_VOIDED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"NOOP\",\n \"request_id\": \"req_9ea53be5-828f-4730-b187-9d3d350ab72a\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n }\n },\n \"action\": {}\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"ff029e36-4b67-4a92-8e07-c4f54ae31666","name":"200 - Payment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"kind\": \"VOID_PAYMENT\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_70fdbb06-bbf7-44e1-b50a-672d9f1d8b26/void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 09:44:56 GMT"},{"key":"Content-Length","value":"515"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_a549b4ce-11e7-424e-80df-6efca46e598c\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_VOIDED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"subscription\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"NOOP\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 300000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 300000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n }\n },\n \"action\": {}\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"8b575623-a93c-431a-aa43-a46261c6948e","name":"200 - Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"kind\": \"VOID_REFUND\",\n \"refund\": \"refund_2054f956-d998-42ad-8e99-3f9891b33fc7\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_1a46dc70-91f9-4892-8e25-0bb5205b69c7/void"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 09:48:43 GMT"},{"key":"Content-Length","value":"574"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tracker\": {\n \"token\": \"track_1a46dc70-91f9-4892-8e25-0bb5205b69c7\",\n \"client\": \"sec_edeade52-46aa-483b-b87d-009d3ce41554\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_PARTIAL_REFUND\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"NOOP\",\n \"request_id\": \"req_9ea53be5-828f-4730-b187-9d3d350ab72a\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 600000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n }\n },\n \"action\": {}\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"59f7a7eb-cfbe-4306-bf9e-f178eaaf9f57","name":"400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"kind\": \"VOID_CAPTURE\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/order/payments/v3/track_1a46dc70-91f9-4892-8e25-0bb5205b69c7/void"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 09 Oct 2023 09:50:20 GMT"},{"key":"Content-Length","value":"99"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"cannot void tracker in state TRACKER_VOIDED\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"845c859f-8212-43b3-889c-3a1adcaf99c9"}],"id":"170e6887-a78e-492f-beea-0c5479129e85","description":"Often times you may run into situations where funds need to be returned to the customer due to unexpected circumstances. You have the following options depending on the situation:
\nIf the customer's funds have been put on hold (authorized) but not captured, you have the option of requesting a reversal. This removes the hold on the customer's funds.
\nIf you wish to cancel a capture soon after it has taken place, you may request to void the capture which will ultimately result in the funds being returned to the customer. A void on a capture will automatically trigger an authorization reversal.
\nNote that refunds may also be voided and is useful for situations where an unwanted refund must be reverted.
\nA void on a capture can only succeed if the funds have not been settled. For situations where the customer's funds must be returned long after the transaction date, you may perform a refund for a partial or full amount of the order total.
\nNote that you must authenticate as a merchant (either via api key or secret key) to execute these requests.
\n","_postman_id":"170e6887-a78e-492f-beea-0c5479129e85"},{"name":"Reporting","item":[{"name":"Fetch Payment","id":"68957253-f58e-4165-adea-ecb0fc30b328","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Fetch details for a payment using the tracker token.
\n","urlObject":{"path":["reporter","api","v1","payments","track_f865abdd-3a61-4842-8000-1cffa38f1fbc"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"d2977087-1253-42e0-a6cd-5becf47bac2f","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/reporter/api/v1/payments/track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Sep 2024 09:11:33 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8bcc5f93aa740da7-MRS"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": {\n \"token\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"environment\": \"sandbox\",\n \"state\": \"TRACKER_ENDED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"entry_mode\": \"raw\",\n \"metadata\": {\n \"order_id\": {\n \"token\": \"meta_1592f0b7-4f51-4c54-9340-17457c53495e\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"key\": \"order_id\",\n \"value\": \"rMF0crLNoQd1uyw9JCxEM1C4O\",\n \"created_at\": {\n \"seconds\": 1724659902\n },\n \"updated_at\": {\n \"seconds\": 1724659902\n }\n },\n \"source\": {\n \"token\": \"meta_5c05f186-50eb-4087-af76-078628a72670\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"key\": \"source\",\n \"value\": \"shopify\",\n \"created_at\": {\n \"seconds\": 1724659902\n },\n \"updated_at\": {\n \"seconds\": 1724659902\n }\n }\n },\n \"client\": {\n \"token\": \"client_160977e1-3ffc-49b9-88f3-88df96a78049\",\n \"api_key\": \"sec_a8e0a889-b987-4b7e-9757-a6bf28e4d4e2\",\n \"name\": \"Safepay Merchant\",\n \"email\": \"safepaymerchant@gmail.com\",\n \"avatar\": \"https://storage.googleapis.com/safepay-assets/27ed6ce0-929a-4ee7-9610-4579e58bb78d-logo.png\"\n },\n \"customer\": {\n \"token\": \"guest_d559e694-aa91-4eff-83bb-6ed8ebd18bc4\",\n \"first_name\": \"fatima\",\n \"last_name\": \"aurangzeb\",\n \"email\": \"faurangzeb@getsafepay.com\",\n \"phone\": \"+92 343 0210640\"\n },\n \"next_actions\": {\n \"CYBERSOURCE\": {\n \"kind\": \"NOOP\",\n \"request_id\": \"req_3848ba7a-22ab-4dd4-9b8a-c72d96e33c72\"\n },\n \"MPGS\": {\n \"kind\": \"CREATE_SESSION\"\n }\n },\n \"purchase_totals\": {\n \"quote_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"base_amount\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"conversion_rate\": {\n \"base_currency\": \"PKR\",\n \"quote_currency\": \"PKR\",\n \"rate\": 1\n }\n },\n \"charge\": {\n \"token\": \"ch_0eada1c4-6651-4d19-9a48-71d06d0568ac\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"client\": \"sec_a8e0a889-b987-4b7e-9757-a6bf28e4d4e2\",\n \"user\": \"guest_d559e694-aa91-4eff-83bb-6ed8ebd18bc4\",\n \"amount\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"fees\": {\n \"currency\": \"PKR\",\n \"amount\": 9503\n },\n \"tax\": {\n \"currency\": \"PKR\",\n \"amount\": 1093\n },\n \"net\": {\n \"currency\": \"PKR\",\n \"amount\": 280497\n },\n \"signature\": \"5da24f8e9085d86677afe35c72b3fa9ba5c7fdb184e9d7e32282f38258db57b7\",\n \"capture\": {\n \"token\": \"cap_4cec6b5e-fbbf-4055-b77f-a2434e61a58c\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"intent\": \"CYBERSOURCE\",\n \"cybersource_rid\": \"7246601491246940904953\",\n \"is_voidable\": true,\n \"kind\": \"CAPTURE\",\n \"totals\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"created_at\": {\n \"seconds\": 1724660149\n },\n \"updated_at\": {\n \"seconds\": 1724660149\n }\n },\n \"balance\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"created_at\": {\n \"seconds\": 1724660149\n },\n \"updated_at\": {\n \"seconds\": 1724660149\n }\n },\n \"events\": [\n {\n \"intent\": \"CYBERSOURCE\",\n \"type\": \"ENROLLMENT\",\n \"intent_request_id\": \"7246599431926829104951\",\n \"reason\": \"Successful enrollment\",\n \"created_at\": {\n \"seconds\": 1724659944\n }\n },\n {\n \"intent\": \"CYBERSOURCE\",\n \"type\": \"AUTHORIZATION\",\n \"intent_request_id\": \"7246601446636939804953\",\n \"reason\": \"Successful authorization\",\n \"purchase_totals\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"created_at\": {\n \"seconds\": 1724660146\n }\n },\n {\n \"intent\": \"CYBERSOURCE\",\n \"type\": \"CAPTURE\",\n \"intent_request_id\": \"7246601491246940904953\",\n \"reason\": \"Successful transaction\",\n \"purchase_totals\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"created_at\": {\n \"seconds\": 1724660149\n }\n }\n ],\n \"attempts\": [\n {\n \"token\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"intent\": \"CYBERSOURCE\",\n \"idempotency_key\": \"req_3848ba7a-22ab-4dd4-9b8a-c72d96e33c72\",\n \"kind\": 1,\n \"actions_performed\": [\n {\n \"token\": \"act_f89128d2-5d6c-453d-ac03-db60b3dde8ac\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"kind\": \"PAYER_AUTH_SETUP\",\n \"created_at\": {\n \"seconds\": 1724659902\n },\n \"updated_at\": {\n \"seconds\": 1724659902\n }\n },\n {\n \"token\": \"act_22092131-37f1-43f6-bc1f-5d17f3b71fbd\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"kind\": \"PAYER_AUTH_ENROLLMENT\",\n \"created_at\": {\n \"seconds\": 1724659943\n },\n \"updated_at\": {\n \"seconds\": 1724659943\n }\n },\n {\n \"token\": \"act_ed9a7951-b647-4235-ae2a-66b66146e0bb\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"kind\": \"PAYER_AUTH_VALIDATION\",\n \"created_at\": {\n \"seconds\": 1724660145\n },\n \"updated_at\": {\n \"seconds\": 1724660145\n }\n },\n {\n \"token\": \"act_f9401b2c-9c0b-4096-a169-131bc431c752\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"kind\": \"CAPTURE\",\n \"created_at\": {\n \"seconds\": 1724660149\n },\n \"updated_at\": {\n \"seconds\": 1724660149\n }\n }\n ],\n \"payment_method\": {\n \"token\": \"method_466fbc51-dcb0-4c15-9c0a-4ba558c0669b\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"last_four\": \"1096\",\n \"kind\": \"CARD\",\n \"scheme\": \"Mastercard\",\n \"bin\": \"520000\",\n \"expiration_month\": \"02\",\n \"expiration_year\": \"2029\",\n \"created_at\": {\n \"seconds\": 1724659903\n },\n \"updated_at\": {\n \"seconds\": 1724659903\n }\n },\n \"billing\": {\n \"token\": \"bill_6c2ba4f5-a31c-484c-ae0e-e5c4b2c09799\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"street_1\": \"fefeg\",\n \"city\": \"khi\",\n \"postal_code\": \"12345\",\n \"country\": \"PK\",\n \"created_at\": {\n \"seconds\": 1724659944\n },\n \"updated_at\": {\n \"seconds\": 1724659944\n }\n },\n \"enrollment\": {\n \"token\": \"enroll_9e940ccb-75a2-4cd0-96b0-c83baa14e4bc\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"cybersource_rid\": \"7246599431926829104951\",\n \"specification_version\": \"2.1.0\",\n \"veres_enrolled\": \"Y\",\n \"eci\": \"02\",\n \"created_at\": {\n \"seconds\": 1724659944\n },\n \"updated_at\": {\n \"seconds\": 1724659944\n }\n },\n \"risk\": {\n \"token\": \"risk_16a82fba-fc08-4867-ba6d-8cd961cd4d56\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"score\": \"3\",\n \"factor_codes\": [\n \"H\"\n ],\n \"info_codes\": [\n \"MM-BIN\",\n \"UNV-ADDR\",\n \"VEL-NAME\",\n \"VELI-CC\",\n \"VELI-FP\",\n \"VELI-TIP\",\n \"VELL-CC\",\n \"VELL-TIP\",\n \"VELS-CC\",\n \"VELV-CC\",\n \"ID-M-HPOS\",\n \"ID-X-HPOS\",\n \"MORPH-C\",\n \"MORPH-E\",\n \"MORPH-FB\",\n \"MORPH-FE\",\n \"MORPH-FP\",\n \"MORPH-FS\",\n \"MORPH-P\",\n \"MUL-EM\",\n \"RISK-SD\"\n ],\n \"created_at\": {\n \"seconds\": 1724660146\n },\n \"updated_at\": {\n \"seconds\": 1724660146\n }\n },\n \"authorization\": {\n \"token\": \"auth_b49e55ae-5806-4899-85f7-234e6fb1cdf9\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"intent\": \"CYBERSOURCE\",\n \"cybersource_rid\": \"7246601446636939804953\",\n \"totals\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"created_at\": {\n \"seconds\": 1724660146\n },\n \"updated_at\": {\n \"seconds\": 1724660146\n }\n },\n \"capture\": {\n \"token\": \"cap_4cec6b5e-fbbf-4055-b77f-a2434e61a58c\",\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"attempt\": \"attemp_a14d3180-47c6-4c1e-99a9-d801108f17a7\",\n \"intent\": \"CYBERSOURCE\",\n \"cybersource_rid\": \"7246601491246940904953\",\n \"is_voidable\": true,\n \"kind\": \"CAPTURE\",\n \"totals\": {\n \"currency\": \"PKR\",\n \"amount\": 290000\n },\n \"created_at\": {\n \"seconds\": 1724660149\n },\n \"updated_at\": {\n \"seconds\": 1724660149\n }\n },\n \"is_success\": true,\n \"created_at\": {\n \"seconds\": 1724659902\n },\n \"updated_at\": {\n \"seconds\": 1724659902\n },\n \"mode\": \"payment\",\n \"entry_mode\": \"raw\",\n \"customer\": {\n \"token\": \"guest_d559e694-aa91-4eff-83bb-6ed8ebd18bc4\",\n \"first_name\": \"fatima\",\n \"last_name\": \"aurangzeb\",\n \"email\": \"faurangzeb@getsafepay.com\",\n \"phone\": \"+92 343 0210640\"\n }\n }\n ],\n \"location\": {\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"token\": \"loc_8bcde9df-6bb5-4fbc-b178-91a9768dff13\",\n \"ip_address\": \"203.130.3.66\",\n \"city\": \"Karachi\",\n \"country\": \"PK\",\n \"latitude\": 24.883,\n \"longitude\": 67.058,\n \"region\": \"Sindh\",\n \"created_at\": {\n \"seconds\": 1724660149\n },\n \"updated_at\": {\n \"seconds\": 1724660149\n }\n },\n \"device\": {\n \"tracker\": \"track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1\",\n \"token\": \"dev_e33ec87f-b818-439c-94a0-f747a3efc94f\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.\",\n \"entity\": \"browser\",\n \"browser\": \"Chrome\",\n \"browser_version\": \"128.0.0.0\",\n \"device\": \"Mac\",\n \"device_type\": \"desktop\",\n \"platform\": \"macOS 10.15 Catalina\",\n \"platform_icon\": \"https://assets.userstack.com/icon/os/macosx.png\",\n \"created_at\": {\n \"seconds\": 1724660149\n },\n \"updated_at\": {\n \"seconds\": 1724660149\n }\n },\n \"created_at\": {\n \"seconds\": 1724659902\n },\n \"updated_at\": {\n \"seconds\": 1724659902\n }\n }\n}"},{"id":"8154f5e3-ac42-45a3-8d6a-a5376301116e","name":"401","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/reporter/api/v1/payments/track_ac6afa9c-7f8b-4789-b84e-b39e6422bef1"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Sep 2024 09:11:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"418"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8bcc5fe9bb170da7-MRS"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error.unauthorized_access\",\n \"message\": \"strategies/union: [strategies/jwt_client: token is malformed, strategies/jwt_user: token is malformed, strategies/jwt_user_v2: token is malformed, strategies/secret: merchant webhook secret not found in the request header, strategies/tbt: decode error: illegal base64 data at input byte 72, strategies/jwt_admin: token inactive, could not find email key against token]\"\n}"}],"_postman_id":"68957253-f58e-4165-adea-ecb0fc30b328"},{"name":"Search Payments","id":"6f7d144a-cc31-4328-969f-f8e36b04faad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Search payments based on various search criteria. The response returns a count of all trackers and a paginated list of trackers.
\nThe following search options are supported:
\nAs mentioned above, the response is paginated. To control the pagination, there are some additional options:
\nResults are sorted chronologically by the tracker's created_at timestamp in descending order.
The list response of trackers contains a minified view of the payment. However, some paramaters may be expanded to provide additional information. This can be achieved using the expand parameter which takes a list of items that may be expanded. The options are:
Limit search results to a value
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"Paginate search results
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Sort by specifies the field use to sort data e.g. created_at
Direction specifies the data sort order either ASC or DESC
\n","type":"text/plain"},"key":"direction","value":"DESC"}],"variable":[]}},"response":[{"id":"6bcde68a-ba98-4adc-b4ef-aac82d5beb87","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/reporter/api/v1/payments?limit=5&page=1&sort_by=created_at&direction=DESC","host":["https://sandbox.api.getsafepay.com"],"path":["reporter","api","v1","payments"],"query":[{"key":"limit","value":"5","description":"Limit search results to a value"},{"key":"page","value":"1","description":"Paginate search results"},{"key":"sort_by","value":"created_at","description":"Sort by specifies the field use to sort data e.g. `created_at`"},{"key":"direction","value":"DESC","description":"Direction specifies the data sort order either ASC or DESC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Sep 2024 11:22:18 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c8265583ad212ac-MRS"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"ok\": true,\n \"data\": {\n \"count\": 261,\n \"list\": [\n {\n \"token\": \"track_182657fe-b372-4751-b4c6-2e0a7369f670\",\n \"environment\": \"sandbox\",\n \"client\": {\n \"api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\"\n },\n \"customer\": {\n \"token\": \"guest_15acc00c-970b-49e9-9258-b66992c81c11\"\n },\n \"state\": \"TRACKER_ENDED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"currency\": \"PKR\",\n \"display_amount\": \"2500.00\",\n \"created_at\": {\n \"seconds\": 1727158668\n }\n },\n {\n \"token\": \"track_be811167-76da-4d7e-8099-6003a9bc3df6\",\n \"environment\": \"sandbox\",\n \"client\": {\n \"api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\"\n },\n \"customer\": {\n \"token\": \"guest_ca946bc3-2e53-4e06-bd38-53a5160252ca\"\n },\n \"state\": \"TRACKER_ENDED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"currency\": \"PKR\",\n \"display_amount\": \"2500.00\",\n \"created_at\": {\n \"seconds\": 1727155741\n }\n },\n {\n \"token\": \"track_ea2d05d4-cc27-4d34-ad33-649dacd75f5a\",\n \"environment\": \"sandbox\",\n \"client\": {\n \"api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\"\n },\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"currency\": \"PKR\",\n \"display_amount\": \"2500.00\",\n \"created_at\": {\n \"seconds\": 1727155530\n }\n },\n {\n \"token\": \"track_9ea533a0-9014-46c5-8451-0d6114ec5e55\",\n \"environment\": \"sandbox\",\n \"client\": {\n \"api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\"\n },\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"currency\": \"PKR\",\n \"display_amount\": \"2500.00\",\n \"created_at\": {\n \"seconds\": 1727155442\n }\n },\n {\n \"token\": \"track_196c8853-56b3-4f42-96a5-97b9c3eefe3d\",\n \"environment\": \"sandbox\",\n \"client\": {\n \"api_key\": \"sec_a7cc6fc1-088d-4f35-9dac-2bab2cb234a1\"\n },\n \"state\": \"TRACKER_STARTED\",\n \"intent\": \"CYBERSOURCE\",\n \"mode\": \"payment\",\n \"currency\": \"PKR\",\n \"display_amount\": \"2500.00\",\n \"created_at\": {\n \"seconds\": 1727155412\n }\n }\n ],\n \"meta\": {\n \"limit\": 5,\n \"page\": 1,\n \"offset\": 0,\n \"sort_by\": \"created_at\",\n \"direction\": \"DESC\"\n }\n }\n}"}],"_postman_id":"6f7d144a-cc31-4328-969f-f8e36b04faad"}],"id":"60f37352-fc81-4ea6-9cf2-90d04d9ea76e","description":"Fetch payment details.
\n","_postman_id":"60f37352-fc81-4ea6-9cf2-90d04d9ea76e"},{"name":"Meta","item":[{"name":"Countries","id":"f0d03259-9c61-40fa-bee4-e7bb5c7c98db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/user/meta/v2/countries?lang=en","urlObject":{"path":["user","meta","v2","countries"],"host":["https://sandbox.api.getsafepay.com"],"query":[{"key":"lang","value":"en"}],"variable":[]}},"response":[{"id":"5940ab45-54ae-4118-ba86-11e75972f3a7","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/user/meta/v2/countries?lang=en","host":["https://sandbox.api.getsafepay.com"],"path":["user","meta","v2","countries"],"query":[{"key":"lang","value":"en"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Oct 2024 10:50:04 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d712a017a25cdfd-SIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v2\",\n \"data\": [\n {\n \"code\": \"AF\",\n \"name\": \"Afghanistan\"\n },\n {\n \"code\": \"AX\",\n \"name\": \"Åland Islands\"\n },\n {\n \"code\": \"AL\",\n \"name\": \"Albania\"\n },\n {\n \"code\": \"DZ\",\n \"name\": \"Algeria\"\n },\n {\n \"code\": \"AS\",\n \"name\": \"American Samoa\"\n },\n {\n \"code\": \"AD\",\n \"name\": \"Andorra\"\n },\n {\n \"code\": \"AO\",\n \"name\": \"Angola\"\n },\n {\n \"code\": \"AI\",\n \"name\": \"Anguilla\"\n },\n {\n \"code\": \"AQ\",\n \"name\": \"Antarctica\"\n },\n {\n \"code\": \"AG\",\n \"name\": \"Antigua & Barbuda\"\n },\n {\n \"code\": \"AR\",\n \"name\": \"Argentina\"\n },\n {\n \"code\": \"AM\",\n \"name\": \"Armenia\"\n },\n {\n \"code\": \"AW\",\n \"name\": \"Aruba\"\n },\n {\n \"code\": \"AC\",\n \"name\": \"Ascension Island\"\n },\n {\n \"code\": \"AU\",\n \"name\": \"Australia\"\n },\n {\n \"code\": \"AT\",\n \"name\": \"Austria\"\n },\n {\n \"code\": \"AZ\",\n \"name\": \"Azerbaijan\"\n },\n {\n \"code\": \"BS\",\n \"name\": \"Bahamas\"\n },\n {\n \"code\": \"BH\",\n \"name\": \"Bahrain\"\n },\n {\n \"code\": \"BD\",\n \"name\": \"Bangladesh\"\n },\n {\n \"code\": \"BB\",\n \"name\": \"Barbados\"\n },\n {\n \"code\": \"BY\",\n \"name\": \"Belarus\"\n },\n {\n \"code\": \"BE\",\n \"name\": \"Belgium\"\n },\n {\n \"code\": \"BZ\",\n \"name\": \"Belize\"\n },\n {\n \"code\": \"BJ\",\n \"name\": \"Benin\"\n },\n {\n \"code\": \"BM\",\n \"name\": \"Bermuda\"\n },\n {\n \"code\": \"BT\",\n \"name\": \"Bhutan\"\n },\n {\n \"code\": \"BO\",\n \"name\": \"Bolivia\"\n },\n {\n \"code\": \"BA\",\n \"name\": \"Bosnia & Herzegovina\"\n },\n {\n \"code\": \"BW\",\n \"name\": \"Botswana\"\n },\n {\n \"code\": \"BV\",\n \"name\": \"Bouvet Island\"\n },\n {\n \"code\": \"BR\",\n \"name\": \"Brazil\"\n },\n {\n \"code\": \"IO\",\n \"name\": \"British Indian Ocean Territory\"\n },\n {\n \"code\": \"VG\",\n \"name\": \"British Virgin Islands\"\n },\n {\n \"code\": \"BN\",\n \"name\": \"Brunei\"\n },\n {\n \"code\": \"BG\",\n \"name\": \"Bulgaria\"\n },\n {\n \"code\": \"BF\",\n \"name\": \"Burkina Faso\"\n },\n {\n \"code\": \"BI\",\n \"name\": \"Burundi\"\n },\n {\n \"code\": \"KH\",\n \"name\": \"Cambodia\"\n },\n {\n \"code\": \"CM\",\n \"name\": \"Cameroon\"\n },\n {\n \"code\": \"CA\",\n \"name\": \"Canada\"\n },\n {\n \"code\": \"CV\",\n \"name\": \"Cape Verde\"\n },\n {\n \"code\": \"BQ\",\n \"name\": \"Caribbean Netherlands\"\n },\n {\n \"code\": \"KY\",\n \"name\": \"Cayman Islands\"\n },\n {\n \"code\": \"CF\",\n \"name\": \"Central African Republic\"\n },\n {\n \"code\": \"TD\",\n \"name\": \"Chad\"\n },\n {\n \"code\": \"CL\",\n \"name\": \"Chile\"\n },\n {\n \"code\": \"CN\",\n \"name\": \"China\"\n },\n {\n \"code\": \"CX\",\n \"name\": \"Christmas Island\"\n },\n {\n \"code\": \"CC\",\n \"name\": \"Cocos (Keeling) Islands\"\n },\n {\n \"code\": \"CO\",\n \"name\": \"Colombia\"\n },\n {\n \"code\": \"KM\",\n \"name\": \"Comoros\"\n },\n {\n \"code\": \"CG\",\n \"name\": \"Congo - Brazzaville\"\n },\n {\n \"code\": \"CD\",\n \"name\": \"Congo - Kinshasa\"\n },\n {\n \"code\": \"CK\",\n \"name\": \"Cook Islands\"\n },\n {\n \"code\": \"CR\",\n \"name\": \"Costa Rica\"\n },\n {\n \"code\": \"CI\",\n \"name\": \"Côte d’Ivoire\"\n },\n {\n \"code\": \"HR\",\n \"name\": \"Croatia\"\n },\n {\n \"code\": \"CU\",\n \"name\": \"Cuba\"\n },\n {\n \"code\": \"CW\",\n \"name\": \"Curaçao\"\n },\n {\n \"code\": \"CY\",\n \"name\": \"Cyprus\"\n },\n {\n \"code\": \"CZ\",\n \"name\": \"Czechia\"\n },\n {\n \"code\": \"DK\",\n \"name\": \"Denmark\"\n },\n {\n \"code\": \"DJ\",\n \"name\": \"Djibouti\"\n },\n {\n \"code\": \"DM\",\n \"name\": \"Dominica\"\n },\n {\n \"code\": \"DO\",\n \"name\": \"Dominican Republic\"\n },\n {\n \"code\": \"EC\",\n \"name\": \"Ecuador\"\n },\n {\n \"code\": \"EG\",\n \"name\": \"Egypt\"\n },\n {\n \"code\": \"SV\",\n \"name\": \"El Salvador\"\n },\n {\n \"code\": \"GQ\",\n \"name\": \"Equatorial Guinea\"\n },\n {\n \"code\": \"ER\",\n \"name\": \"Eritrea\"\n },\n {\n \"code\": \"EE\",\n \"name\": \"Estonia\"\n },\n {\n \"code\": \"ET\",\n \"name\": \"Ethiopia\"\n },\n {\n \"code\": \"FK\",\n \"name\": \"Falkland Islands\"\n },\n {\n \"code\": \"FO\",\n \"name\": \"Faroe Islands\"\n },\n {\n \"code\": \"FJ\",\n \"name\": \"Fiji\"\n },\n {\n \"code\": \"FI\",\n \"name\": \"Finland\"\n },\n {\n \"code\": \"FR\",\n \"name\": \"France\"\n },\n {\n \"code\": \"GF\",\n \"name\": \"French Guiana\"\n },\n {\n \"code\": \"PF\",\n \"name\": \"French Polynesia\"\n },\n {\n \"code\": \"TF\",\n \"name\": \"French Southern Territories\"\n },\n {\n \"code\": \"GA\",\n \"name\": \"Gabon\"\n },\n {\n \"code\": \"GM\",\n \"name\": \"Gambia\"\n },\n {\n \"code\": \"GE\",\n \"name\": \"Georgia\"\n },\n {\n \"code\": \"DE\",\n \"name\": \"Germany\"\n },\n {\n \"code\": \"GH\",\n \"name\": \"Ghana\"\n },\n {\n \"code\": \"GI\",\n \"name\": \"Gibraltar\"\n },\n {\n \"code\": \"GR\",\n \"name\": \"Greece\"\n },\n {\n \"code\": \"GL\",\n \"name\": \"Greenland\"\n },\n {\n \"code\": \"GD\",\n \"name\": \"Grenada\"\n },\n {\n \"code\": \"GP\",\n \"name\": \"Guadeloupe\"\n },\n {\n \"code\": \"GU\",\n \"name\": \"Guam\"\n },\n {\n \"code\": \"GT\",\n \"name\": \"Guatemala\"\n },\n {\n \"code\": \"GG\",\n \"name\": \"Guernsey\"\n },\n {\n \"code\": \"GN\",\n \"name\": \"Guinea\"\n },\n {\n \"code\": \"GW\",\n \"name\": \"Guinea-Bissau\"\n },\n {\n \"code\": \"GY\",\n \"name\": \"Guyana\"\n },\n {\n \"code\": \"HT\",\n \"name\": \"Haiti\"\n },\n {\n \"code\": \"HM\",\n \"name\": \"Heard & McDonald Islands\"\n },\n {\n \"code\": \"HN\",\n \"name\": \"Honduras\"\n },\n {\n \"code\": \"HK\",\n \"name\": \"Hong Kong SAR China\"\n },\n {\n \"code\": \"HU\",\n \"name\": \"Hungary\"\n },\n {\n \"code\": \"IS\",\n \"name\": \"Iceland\"\n },\n {\n \"code\": \"IN\",\n \"name\": \"India\"\n },\n {\n \"code\": \"ID\",\n \"name\": \"Indonesia\"\n },\n {\n \"code\": \"IR\",\n \"name\": \"Iran\"\n },\n {\n \"code\": \"IQ\",\n \"name\": \"Iraq\"\n },\n {\n \"code\": \"IE\",\n \"name\": \"Ireland\"\n },\n {\n \"code\": \"IM\",\n \"name\": \"Isle of Man\"\n },\n {\n \"code\": \"IL\",\n \"name\": \"Israel\"\n },\n {\n \"code\": \"IT\",\n \"name\": \"Italy\"\n },\n {\n \"code\": \"JM\",\n \"name\": \"Jamaica\"\n },\n {\n \"code\": \"JP\",\n \"name\": \"Japan\"\n },\n {\n \"code\": \"JE\",\n \"name\": \"Jersey\"\n },\n {\n \"code\": \"JO\",\n \"name\": \"Jordan\"\n },\n {\n \"code\": \"KZ\",\n \"name\": \"Kazakhstan\"\n },\n {\n \"code\": \"KE\",\n \"name\": \"Kenya\"\n },\n {\n \"code\": \"KI\",\n \"name\": \"Kiribati\"\n },\n {\n \"code\": \"XK\",\n \"name\": \"Kosovo\"\n },\n {\n \"code\": \"KW\",\n \"name\": \"Kuwait\"\n },\n {\n \"code\": \"KG\",\n \"name\": \"Kyrgyzstan\"\n },\n {\n \"code\": \"LA\",\n \"name\": \"Laos\"\n },\n {\n \"code\": \"LV\",\n \"name\": \"Latvia\"\n },\n {\n \"code\": \"LB\",\n \"name\": \"Lebanon\"\n },\n {\n \"code\": \"LS\",\n \"name\": \"Lesotho\"\n },\n {\n \"code\": \"LR\",\n \"name\": \"Liberia\"\n },\n {\n \"code\": \"LY\",\n \"name\": \"Libya\"\n },\n {\n \"code\": \"LI\",\n \"name\": \"Liechtenstein\"\n },\n {\n \"code\": \"LT\",\n \"name\": \"Lithuania\"\n },\n {\n \"code\": \"LU\",\n \"name\": \"Luxembourg\"\n },\n {\n \"code\": \"MO\",\n \"name\": \"Macau SAR China\"\n },\n {\n \"code\": \"MK\",\n \"name\": \"Macedonia\"\n },\n {\n \"code\": \"MG\",\n \"name\": \"Madagascar\"\n },\n {\n \"code\": \"MW\",\n \"name\": \"Malawi\"\n },\n {\n \"code\": \"MY\",\n \"name\": \"Malaysia\"\n },\n {\n \"code\": \"MV\",\n \"name\": \"Maldives\"\n },\n {\n \"code\": \"ML\",\n \"name\": \"Mali\"\n },\n {\n \"code\": \"MT\",\n \"name\": \"Malta\"\n },\n {\n \"code\": \"MH\",\n \"name\": \"Marshall Islands\"\n },\n {\n \"code\": \"MQ\",\n \"name\": \"Martinique\"\n },\n {\n \"code\": \"MR\",\n \"name\": \"Mauritania\"\n },\n {\n \"code\": \"MU\",\n \"name\": \"Mauritius\"\n },\n {\n \"code\": \"YT\",\n \"name\": \"Mayotte\"\n },\n {\n \"code\": \"MX\",\n \"name\": \"Mexico\"\n },\n {\n \"code\": \"FM\",\n \"name\": \"Micronesia\"\n },\n {\n \"code\": \"MD\",\n \"name\": \"Moldova\"\n },\n {\n \"code\": \"MC\",\n \"name\": \"Monaco\"\n },\n {\n \"code\": \"MN\",\n \"name\": \"Mongolia\"\n },\n {\n \"code\": \"ME\",\n \"name\": \"Montenegro\"\n },\n {\n \"code\": \"MS\",\n \"name\": \"Montserrat\"\n },\n {\n \"code\": \"MA\",\n \"name\": \"Morocco\"\n },\n {\n \"code\": \"MZ\",\n \"name\": \"Mozambique\"\n },\n {\n \"code\": \"MM\",\n \"name\": \"Myanmar (Burma)\"\n },\n {\n \"code\": \"NA\",\n \"name\": \"Namibia\"\n },\n {\n \"code\": \"NR\",\n \"name\": \"Nauru\"\n },\n {\n \"code\": \"NP\",\n \"name\": \"Nepal\"\n },\n {\n \"code\": \"NL\",\n \"name\": \"Netherlands\"\n },\n {\n \"code\": \"NC\",\n \"name\": \"New Caledonia\"\n },\n {\n \"code\": \"NZ\",\n \"name\": \"New Zealand\"\n },\n {\n \"code\": \"NI\",\n \"name\": \"Nicaragua\"\n },\n {\n \"code\": \"NE\",\n \"name\": \"Niger\"\n },\n {\n \"code\": \"NG\",\n \"name\": \"Nigeria\"\n },\n {\n \"code\": \"NU\",\n \"name\": \"Niue\"\n },\n {\n \"code\": \"NF\",\n \"name\": \"Norfolk Island\"\n },\n {\n \"code\": \"KP\",\n \"name\": \"North Korea\"\n },\n {\n \"code\": \"MP\",\n \"name\": \"Northern Mariana Islands\"\n },\n {\n \"code\": \"NO\",\n \"name\": \"Norway\"\n },\n {\n \"code\": \"OM\",\n \"name\": \"Oman\"\n },\n {\n \"code\": \"PK\",\n \"name\": \"Pakistan\"\n },\n {\n \"code\": \"PW\",\n \"name\": \"Palau\"\n },\n {\n \"code\": \"PS\",\n \"name\": \"Palestinian Territories\"\n },\n {\n \"code\": \"PA\",\n \"name\": \"Panama\"\n },\n {\n \"code\": \"PG\",\n \"name\": \"Papua New Guinea\"\n },\n {\n \"code\": \"PY\",\n \"name\": \"Paraguay\"\n },\n {\n \"code\": \"PE\",\n \"name\": \"Peru\"\n },\n {\n \"code\": \"PH\",\n \"name\": \"Philippines\"\n },\n {\n \"code\": \"PN\",\n \"name\": \"Pitcairn Islands\"\n },\n {\n \"code\": \"PL\",\n \"name\": \"Poland\"\n },\n {\n \"code\": \"PT\",\n \"name\": \"Portugal\"\n },\n {\n \"code\": \"PR\",\n \"name\": \"Puerto Rico\"\n },\n {\n \"code\": \"QA\",\n \"name\": \"Qatar\"\n },\n {\n \"code\": \"RE\",\n \"name\": \"Réunion\"\n },\n {\n \"code\": \"RO\",\n \"name\": \"Romania\"\n },\n {\n \"code\": \"RU\",\n \"name\": \"Russia\"\n },\n {\n \"code\": \"RW\",\n \"name\": \"Rwanda\"\n },\n {\n \"code\": \"WS\",\n \"name\": \"Samoa\"\n },\n {\n \"code\": \"SM\",\n \"name\": \"San Marino\"\n },\n {\n \"code\": \"ST\",\n \"name\": \"São Tomé & Príncipe\"\n },\n {\n \"code\": \"SA\",\n \"name\": \"Saudi Arabia\"\n },\n {\n \"code\": \"SN\",\n \"name\": \"Senegal\"\n },\n {\n \"code\": \"RS\",\n \"name\": \"Serbia\"\n },\n {\n \"code\": \"SC\",\n \"name\": \"Seychelles\"\n },\n {\n \"code\": \"SL\",\n \"name\": \"Sierra Leone\"\n },\n {\n \"code\": \"SG\",\n \"name\": \"Singapore\"\n },\n {\n \"code\": \"SX\",\n \"name\": \"Sint Maarten\"\n },\n {\n \"code\": \"SK\",\n \"name\": \"Slovakia\"\n },\n {\n \"code\": \"SI\",\n \"name\": \"Slovenia\"\n },\n {\n \"code\": \"SB\",\n \"name\": \"Solomon Islands\"\n },\n {\n \"code\": \"SO\",\n \"name\": \"Somalia\"\n },\n {\n \"code\": \"ZA\",\n \"name\": \"South Africa\"\n },\n {\n \"code\": \"GS\",\n \"name\": \"South Georgia & South Sandwich Islands\"\n },\n {\n \"code\": \"KR\",\n \"name\": \"South Korea\"\n },\n {\n \"code\": \"SS\",\n \"name\": \"South Sudan\"\n },\n {\n \"code\": \"ES\",\n \"name\": \"Spain\"\n },\n {\n \"code\": \"LK\",\n \"name\": \"Sri Lanka\"\n },\n {\n \"code\": \"BL\",\n \"name\": \"St. Barthélemy\"\n },\n {\n \"code\": \"SH\",\n \"name\": \"St. Helena\"\n },\n {\n \"code\": \"KN\",\n \"name\": \"St. Kitts & Nevis\"\n },\n {\n \"code\": \"LC\",\n \"name\": \"St. Lucia\"\n },\n {\n \"code\": \"MF\",\n \"name\": \"St. Martin\"\n },\n {\n \"code\": \"PM\",\n \"name\": \"St. Pierre & Miquelon\"\n },\n {\n \"code\": \"VC\",\n \"name\": \"St. Vincent & Grenadines\"\n },\n {\n \"code\": \"SD\",\n \"name\": \"Sudan\"\n },\n {\n \"code\": \"SR\",\n \"name\": \"Suriname\"\n },\n {\n \"code\": \"SJ\",\n \"name\": \"Svalbard & Jan Mayen\"\n },\n {\n \"code\": \"SZ\",\n \"name\": \"Swaziland\"\n },\n {\n \"code\": \"SE\",\n \"name\": \"Sweden\"\n },\n {\n \"code\": \"CH\",\n \"name\": \"Switzerland\"\n },\n {\n \"code\": \"SY\",\n \"name\": \"Syria\"\n },\n {\n \"code\": \"TW\",\n \"name\": \"Taiwan\"\n },\n {\n \"code\": \"TJ\",\n \"name\": \"Tajikistan\"\n },\n {\n \"code\": \"TZ\",\n \"name\": \"Tanzania\"\n },\n {\n \"code\": \"TH\",\n \"name\": \"Thailand\"\n },\n {\n \"code\": \"TL\",\n \"name\": \"Timor-Leste\"\n },\n {\n \"code\": \"TG\",\n \"name\": \"Togo\"\n },\n {\n \"code\": \"TK\",\n \"name\": \"Tokelau\"\n },\n {\n \"code\": \"TO\",\n \"name\": \"Tonga\"\n },\n {\n \"code\": \"TT\",\n \"name\": \"Trinidad & Tobago\"\n },\n {\n \"code\": \"TA\",\n \"name\": \"Tristan da Cunha\"\n },\n {\n \"code\": \"TN\",\n \"name\": \"Tunisia\"\n },\n {\n \"code\": \"TR\",\n \"name\": \"Turkey\"\n },\n {\n \"code\": \"TM\",\n \"name\": \"Turkmenistan\"\n },\n {\n \"code\": \"TC\",\n \"name\": \"Turks & Caicos Islands\"\n },\n {\n \"code\": \"TV\",\n \"name\": \"Tuvalu\"\n },\n {\n \"code\": \"UM\",\n \"name\": \"U.S. Outlying Islands\"\n },\n {\n \"code\": \"VI\",\n \"name\": \"U.S. Virgin Islands\"\n },\n {\n \"code\": \"UG\",\n \"name\": \"Uganda\"\n },\n {\n \"code\": \"UA\",\n \"name\": \"Ukraine\"\n },\n {\n \"code\": \"AE\",\n \"name\": \"United Arab Emirates\"\n },\n {\n \"code\": \"GB\",\n \"name\": \"United Kingdom\"\n },\n {\n \"code\": \"US\",\n \"name\": \"United States\"\n },\n {\n \"code\": \"UY\",\n \"name\": \"Uruguay\"\n },\n {\n \"code\": \"UZ\",\n \"name\": \"Uzbekistan\"\n },\n {\n \"code\": \"VU\",\n \"name\": \"Vanuatu\"\n },\n {\n \"code\": \"VA\",\n \"name\": \"Vatican City\"\n },\n {\n \"code\": \"VE\",\n \"name\": \"Venezuela\"\n },\n {\n \"code\": \"VN\",\n \"name\": \"Vietnam\"\n },\n {\n \"code\": \"WF\",\n \"name\": \"Wallis & Futuna\"\n },\n {\n \"code\": \"EH\",\n \"name\": \"Western Sahara\"\n },\n {\n \"code\": \"YE\",\n \"name\": \"Yemen\"\n },\n {\n \"code\": \"ZM\",\n \"name\": \"Zambia\"\n },\n {\n \"code\": \"ZW\",\n \"name\": \"Zimbabwe\"\n }\n ]\n}"}],"_postman_id":"f0d03259-9c61-40fa-bee4-e7bb5c7c98db"},{"name":"Country","id":"628d9c62-cb19-41bb-aa15-e97946542ba5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/user/meta/v2/country?cc=AE","urlObject":{"path":["user","meta","v2","country"],"host":["https://sandbox.api.getsafepay.com"],"query":[{"key":"cc","value":"AE"}],"variable":[]}},"response":[{"id":"957120c9-3245-4ae3-aab1-5cc0f302c4f2","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/user/meta/v2/country?cc=US","host":["https://sandbox.api.getsafepay.com"],"path":["user","meta","v2","country"],"query":[{"key":"cc","value":"US"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Oct 2024 10:49:39 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d7129612fb5cdfd-SIN"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v2\",\n \"data\": {\n \"required\": [\n \"AdministrativeArea\",\n \"Locality\",\n \"PostCode\",\n \"StreetAddress\"\n ],\n \"AdministrativeArea\": {\n \"name\": \"State/Province\",\n \"options\": [\n {\n \"id\": \"AL\",\n \"name\": \"Alabama\"\n },\n {\n \"id\": \"AK\",\n \"name\": \"Alaska\"\n },\n {\n \"id\": \"AZ\",\n \"name\": \"Arizona\"\n },\n {\n \"id\": \"AR\",\n \"name\": \"Arkansas\"\n },\n {\n \"id\": \"CA\",\n \"name\": \"California\"\n },\n {\n \"id\": \"CO\",\n \"name\": \"Colorado\"\n },\n {\n \"id\": \"CT\",\n \"name\": \"Connecticut\"\n },\n {\n \"id\": \"DE\",\n \"name\": \"Delaware\"\n },\n {\n \"id\": \"DC\",\n \"name\": \"District of Columbia\"\n },\n {\n \"id\": \"FL\",\n \"name\": \"Florida\"\n },\n {\n \"id\": \"GA\",\n \"name\": \"Georgia\"\n },\n {\n \"id\": \"HI\",\n \"name\": \"Hawaii\"\n },\n {\n \"id\": \"ID\",\n \"name\": \"Idaho\"\n },\n {\n \"id\": \"IL\",\n \"name\": \"Illinois\"\n },\n {\n \"id\": \"IN\",\n \"name\": \"Indiana\"\n },\n {\n \"id\": \"IA\",\n \"name\": \"Iowa\"\n },\n {\n \"id\": \"KS\",\n \"name\": \"Kansas\"\n },\n {\n \"id\": \"KY\",\n \"name\": \"Kentucky\"\n },\n {\n \"id\": \"LA\",\n \"name\": \"Louisiana\"\n },\n {\n \"id\": \"ME\",\n \"name\": \"Maine\"\n },\n {\n \"id\": \"MD\",\n \"name\": \"Maryland\"\n },\n {\n \"id\": \"MA\",\n \"name\": \"Massachusetts\"\n },\n {\n \"id\": \"MI\",\n \"name\": \"Michigan\"\n },\n {\n \"id\": \"MN\",\n \"name\": \"Minnesota\"\n },\n {\n \"id\": \"MS\",\n \"name\": \"Mississippi\"\n },\n {\n \"id\": \"MO\",\n \"name\": \"Missouri\"\n },\n {\n \"id\": \"MT\",\n \"name\": \"Montana\"\n },\n {\n \"id\": \"NE\",\n \"name\": \"Nebraska\"\n },\n {\n \"id\": \"NV\",\n \"name\": \"Nevada\"\n },\n {\n \"id\": \"NH\",\n \"name\": \"New Hampshire\"\n },\n {\n \"id\": \"NJ\",\n \"name\": \"New Jersey\"\n },\n {\n \"id\": \"NM\",\n \"name\": \"New Mexico\"\n },\n {\n \"id\": \"NY\",\n \"name\": \"New York\"\n },\n {\n \"id\": \"NC\",\n \"name\": \"North Carolina\"\n },\n {\n \"id\": \"ND\",\n \"name\": \"North Dakota\"\n },\n {\n \"id\": \"OH\",\n \"name\": \"Ohio\"\n },\n {\n \"id\": \"OK\",\n \"name\": \"Oklahoma\"\n },\n {\n \"id\": \"OR\",\n \"name\": \"Oregon\"\n },\n {\n \"id\": \"PA\",\n \"name\": \"Pennsylvania\"\n },\n {\n \"id\": \"RI\",\n \"name\": \"Rhode Island\"\n },\n {\n \"id\": \"SC\",\n \"name\": \"South Carolina\"\n },\n {\n \"id\": \"SD\",\n \"name\": \"South Dakota\"\n },\n {\n \"id\": \"TN\",\n \"name\": \"Tennessee\"\n },\n {\n \"id\": \"TX\",\n \"name\": \"Texas\"\n },\n {\n \"id\": \"UT\",\n \"name\": \"Utah\"\n },\n {\n \"id\": \"VT\",\n \"name\": \"Vermont\"\n },\n {\n \"id\": \"VA\",\n \"name\": \"Virginia\"\n },\n {\n \"id\": \"WA\",\n \"name\": \"Washington\"\n },\n {\n \"id\": \"WV\",\n \"name\": \"West Virginia\"\n },\n {\n \"id\": \"WI\",\n \"name\": \"Wisconsin\"\n },\n {\n \"id\": \"WY\",\n \"name\": \"Wyoming\"\n }\n ]\n },\n \"Locality\": {\n \"name\": \"City\"\n },\n \"StreetAddress\": {\n \"name\": \"Street Address\"\n },\n \"PostCode\": {\n \"name\": \"ZipCode\"\n }\n }\n}"}],"_postman_id":"628d9c62-cb19-41bb-aa15-e97946542ba5"}],"id":"02f52bb1-da66-4df1-8a5e-1c8ebe5b1740","description":"Meta fields for checkout.
\n","_postman_id":"02f52bb1-da66-4df1-8a5e-1c8ebe5b1740"},{"name":"Webhooks","item":[{"name":"Test Webhook","id":"4de812b1-60f2-45ab-aa4c-438a43df1456","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"Create a test webhook notification for a particular event. Supported webhook events are documented here.
\nWebhooks are crucial for a successful integration with Safepay, and the only way you'll receive automatic updates about events that are not triggered by a request from your side, for example when a shopper completes a payment, or when a store admin refunds a payment.
\nYou can use webhooks to automate business processes, for example order management or downloading reports for accounting. For more information about webhooks please follow the documentation here.
\n","_postman_id":"145c76d5-6958-46b9-bfde-5e5972408575"}],"id":"a4080e5d-51b9-42be-b049-a5d5ee54499a","description":"Create trackers and process them using the Order API.
\nPayment APIs support JWT based authorization strategies for guest users. Some endpoints also support authorization by merchant API key and secret key. Refer to the API Authentication section to understand how to use each authentication strategy.
\nFor testing against the Safepay sandbox (or development environment), we present the following payment methods that may be used to simulate various scenarios. Use any expiry in the future and any CVV e.g. 123.
Additional cards may be found here.
\n","_postman_id":"a4080e5d-51b9-42be-b049-a5d5ee54499a"},{"name":"Subscriptions","item":[{"name":"Plans","item":[{"name":"Create Plan","id":"a5deb75c-fab8-4a62-86b7-423a1e630104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"15670709dbd82556e286cc6640ebc31716b1a53b1463361d626e63ca741c16dc"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": \"100\",\n \"currency\": \"USD\",\n \"interval\": \"MONTH\",\n \"type\": \"RECURRING\",\n \"interval_count\": 1,\n \"product\": \"bananas\",\n \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/client/plans/v1/","description":"To create a Plan, choose how much and how often to charge your customers. The amount to charge can be controlled by the `amount` and `currency` fields while the frequency can be controlled by the `interval`, `interval_count` and `number_of_billing_cycles`. Safepay also allows you to provide your customers with a free trial for any number of days you specify by modifying the `trial_period_days` field.
\nA successful request to this endpoint will return the following response:
\n{\n \"data\": {\n \"request_id\": \"\",\n \"plan_id\": \"plan_d4869a78-0036-4d66-97bd-6afeb5282bcd\"\n }\n}\n\nRetrieves the plan with the given ID.
\nBy passing in the Plan ID in the URL, you can retrieve details about the Plan
\nA successful request to this endpoint will return the Plan object
\n{\n \"data\": {\n \"plan\": {\n \"token\": \"plan_d4869a78-0036-4d66-97bd-6afeb5282bcd\",\n \"merchant_api_key\": \"sec_8dcac601-4b70-442d-b198-03aadd28f12b\",\n \"name\": \"\",\n \"amount\": \"100\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MONTH\",\n \"product\": \"bananas\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-29T08:05:44Z\",\n \"updated_at\": \"2023-09-29T08:05:44Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 0,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100\"\n }\n },\n \"request_id\": \"\"\n }\n}\n\nUpdates an existing plan to match the specified parameters.
\nBy setting the active parameter to false no new subscriptions will be allowed to subscribe to this plan but existing subscriptions will continue to be charged until each subscription either runs its course or is explicitly paused or cancelled.
By changing the value of trial_period_days only new subscriptions will be affected. Existing subscriptions will continue to refer to the previous trial_period_days value.
Response:
\nA successful request to this endpoint will update the plan with the provided parameters and return the following response
\n{\n \"data\": {\n \"request_id\": \"\"\n }\n}\n\nSearch for plans you’ve previously created using the supported filters.
\nA successful request to this endpoint will return the following response
\n{\n \"data\": {\n \"plans\": [\n {\n \"token\": \"plan_d4869a78-0036-4d66-97bd-6afeb5282bcd\",\n \"merchant_api_key\": \"sec_8dcac601-4b70-442d-b198-03aadd28f12b\",\n \"name\": \"new plan name\",\n \"amount\": \"100\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MONTH\",\n \"product\": \"bananas\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 10,\n \"description\": \"\",\n \"created_at\": \"2023-09-29T08:05:44Z\",\n \"updated_at\": \"2023-09-29T08:50:58Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 0,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100\"\n }\n },\n {\n \"token\": \"plan_43834bc5-8c59-43ec-9931-296ecee37db9\",\n \"merchant_api_key\": \"sec_8dcac601-4b70-442d-b198-03aadd28f12b\",\n \"name\": \"\",\n \"amount\": \"100\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MONTH\",\n \"product\": \"bananas\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-29T07:59:16Z\",\n \"updated_at\": \"2023-09-29T07:59:16Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 0,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100\"\n }\n }\n ],\n \"count\": 2,\n \"sort_by\": \"\",\n \"direction\": \"\"\n }\n}\n\nThe data property will contain the list of plans that have been searched for while the count will indicate how many results were returned. The sort_by and direction fields are returned based on what was provided in the request
Filter for specific Plan IDs
\n","type":"text/plain"},"key":"plan_ids","value":""},{"disabled":true,"description":{"content":"Filter for specific intervals
\n","type":"text/plain"},"key":"intervals","value":""},{"disabled":true,"description":{"content":"Filter for specific products
\n","type":"text/plain"},"key":"products","value":""},{"description":{"content":"Filter for specific currencies
\n","type":"text/plain"},"key":"currencies","value":"PKR"},{"description":{"content":"Limit search results to a value
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"Paginate search results
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Sort by specifies the field use to sort data e.g. created_at
Direction specifies the data sort order either ASC or DESC
\n","type":"text/plain"},"key":"direction","value":""},{"disabled":true,"key":"currencies","value":"USD"}],"variable":[]}},"response":[{"id":"68ddbb2c-248d-48bf-8b0e-ef3ae99c90f8","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/client/plans/v1/search","host":["https://sandbox.api.getsafepay.com"],"path":["client","plans","v1","search"],"query":[{"key":"plan_ids","value":null,"description":"Filter for specific Plan IDs","type":"text","disabled":true},{"key":"intervals","value":null,"description":"Filter for specific intervals","type":"text","disabled":true},{"key":"products","value":null,"description":"Filter for specific products","type":"text","disabled":true},{"key":"currencies","value":null,"description":"Filter for specific currencies","type":"text","disabled":true},{"key":"limit","value":null,"description":"Limit search results to a value","type":"text","disabled":true},{"key":"page","value":null,"description":"Paginate search results","type":"text","disabled":true},{"key":"sort_by","value":null,"description":"Sort by specifies the field use to sort data e.g. `created_at`","type":"text","disabled":true},{"key":"direction","value":null,"description":"Direction specifies the data sort order either ASC or DESC","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Sep 2023 08:37:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80e2e77968ef21e6-KHI"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"plans\": [\n {\n \"token\": \"plan_d4869a78-0036-4d66-97bd-6afeb5282bcd\",\n \"merchant_api_key\": \"sec_8dcac601-4b70-442d-b198-03aadd28f12b\",\n \"name\": \"new plan name\",\n \"amount\": \"100\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MONTH\",\n \"product\": \"bananas\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 10,\n \"description\": \"\",\n \"created_at\": \"2023-09-29T08:05:44Z\",\n \"updated_at\": \"2023-09-29T08:29:22Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 0,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100\"\n }\n },\n {\n \"token\": \"plan_43834bc5-8c59-43ec-9931-296ecee37db9\",\n \"merchant_api_key\": \"sec_8dcac601-4b70-442d-b198-03aadd28f12b\",\n \"name\": \"\",\n \"amount\": \"100\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MONTH\",\n \"product\": \"bananas\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-29T07:59:16Z\",\n \"updated_at\": \"2023-09-29T07:59:16Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 0,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100\"\n }\n }\n ],\n \"count\": 2,\n \"sort_by\": \"\",\n \"direction\": \"\"\n }\n}"},{"id":"4ec91501-a34c-4047-a9c7-bde4a9094fb7","name":"401","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/client/plans/v1/search","host":["https://sandbox.api.getsafepay.com"],"path":["client","plans","v1","search"],"query":[{"key":"plan_ids","value":null,"description":"Filter for specific Plan IDs","type":"text","disabled":true},{"key":"intervals","value":null,"description":"Filter for specific intervals","type":"text","disabled":true},{"key":"products","value":null,"description":"Filter for specific products","type":"text","disabled":true},{"key":"currencies","value":null,"description":"Filter for specific currencies","type":"text","disabled":true},{"key":"limit","value":null,"description":"Limit search results to a value","type":"text","disabled":true},{"key":"page","value":null,"description":"Paginate search results","type":"text","disabled":true},{"key":"sort_by","value":null,"description":"Sort by specifies the field use to sort data e.g. `created_at`","type":"text","disabled":true},{"key":"direction","value":null,"description":"Direction specifies the data sort order either ASC or DESC","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Sep 2023 08:38:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"200"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80e2e8ab8af621e6-KHI"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/jwt: missing jwt token, strategies/secret: merchant webhook secret not found in the request header]\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"f26e282f-6c22-4273-9f04-46544ad6c7ff","name":"400","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/client/plans/v1/search?plan_ids=plan_d4869a78-0036-4d66-97bd-6afeb5282bcd&intervals=qsqweqwe&products=¤cies=&limit=&page=&sort_by=&direction=","host":["https://sandbox.api.getsafepay.com"],"path":["client","plans","v1","search"],"query":[{"key":"plan_ids","value":"plan_d4869a78-0036-4d66-97bd-6afeb5282bcd","description":"Filter for specific Plan IDs","type":"text"},{"key":"intervals","value":"qsqweqwe","description":"Filter for specific intervals","type":"text"},{"key":"products","value":"","description":"Filter for specific products","type":"text"},{"key":"currencies","value":"","description":"Filter for specific currencies","type":"text"},{"key":"limit","value":"","description":"Limit search results to a value","type":"text"},{"key":"page","value":"","description":"Paginate search results","type":"text"},{"key":"sort_by","value":"","description":"Sort by specifies the field use to sort data e.g. `created_at`","type":"text"},{"key":"direction","value":"","description":"Direction specifies the data sort order either ASC or DESC","type":"text"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Sep 2023 08:39:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80e2ea011f6e21e6-KHI"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"intervals: (0: must be a valid value.).\"\n}"}],"_postman_id":"0ecc0c56-e4ad-4fc7-86e5-d175c852fefa"},{"name":"Archive Plan","id":"723391b3-04f3-43de-a6a9-5f03e4dc3e15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"15670709dbd82556e286cc6640ebc31716b1a53b1463361d626e63ca741c16dc"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://sandbox.api.getsafepay.com/client/plans/v1/plan_d4869a78-0036-4d66-97bd-6afeb5282bcd/","description":"Archiving plans means new subscribers can’t be added. Existing subscribers aren’t affected. By passing in the plan_id in the URL, you can archive a plan that you no longer need. Archived plans will not show up in your search results. Archiving a plan is a one-way action, meaning that once a plan is archived, it can not be unarchived.
A successful request to this endpoint will return the following response
\n{\n \"data\": {\n \"request_id\": \"\"\n }\n}\n\nA plan is a configuration for recurring payment processing, it contains the amount to debit or credit and the frequency of payment processing. For instance, you are running a software-as-a-service business (saas), you have three service types:
\nTo debit your customer montly, you can create three plan entities on Safepay corresponding to your three service types. Plans can be easily configured using the Merchant Dashboard or through the following APIs
\n","_postman_id":"81430c7a-2d9d-49bf-a336-f670d58ffccb"},{"name":"Subscriptions","item":[{"name":"Find Subscription","id":"e8a1967c-06d6-4ae1-b2dc-1de817b84e58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"15670709dbd82556e286cc6640ebc31716b1a53b1463361d626e63ca741c16dc"}]},"isInherited":false},"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/client/subscriptions/v1/sub_c841ea40-613c-41a3-8984-7cb11f66d541","description":"Retrieves the subscription with the given ID.
\nResponse:
\nA successful request to this endpoint will return a subscription object
\n{\n \"data\": {\n \"request_id\": \"\",\n \"subscription\": {\n \"token\": \"sub_c841ea40-613c-41a3-8984-7cb11f66d541\",\n \"plan_id\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"user\": {\n \"identifier\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"contact\": {\n \"id\": 0,\n \"token\": \"\",\n \"user\": \"\",\n \"first_name\": \"wasay\",\n \"last_name\": \"Usmani\",\n \"email\": \"ausmani@getsafepay.com\",\n \"phone\": \"+92 312 3423232\",\n \"is_default\": true,\n \"created_at\": null,\n \"updated_at\": null\n },\n \"avatar\": \"\",\n \"wallet\": [\n {\n \"id\": 0,\n \"token\": \"inst_5546b317-d701-4e4b-9f3d-f448e1a36184\",\n \"user\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"kind\": \"CybersourceCard\",\n \"contact\": {\n \"id\": 0,\n \"token\": \"\",\n \"user\": \"\",\n \"first_name\": \"wasay\",\n \"last_name\": \"Usmani\",\n \"email\": \"ausmani@getsafepay.com\",\n \"phone\": \"+92 312 3423232\",\n \"is_default\": false,\n \"created_at\": null,\n \"updated_at\": null\n },\n \"created_at\": \"2023-07-28T15:53:35Z\",\n \"updated_at\": \"2023-07-28T15:53:35Z\"\n }\n ]\n },\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"CANCELED\",\n \"billing_cycle_anchor\": \"2023-09-26T07:14:24Z\",\n \"price_amount\": \"10000\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-26T07:14:24Z\",\n \"trial_start_date\": \"2023-09-26T07:14:24Z\",\n \"trial_end_date\": \"2023-09-26T07:14:24Z\",\n \"cancel_at_period_end\": false,\n \"canceled_at\": \"2023-09-26T07:14:55Z\",\n \"created_at\": \"2023-09-26T07:14:24Z\",\n \"updated_at\": \"2023-09-26T07:14:55Z\",\n \"plan\": {\n \"token\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"Safepay demo\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"Slides\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 1,\n \"description\": \"\",\n \"created_at\": \"2023-09-26T07:02:46Z\",\n \"updated_at\": \"2023-09-26T07:17:45Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 10,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n },\n \"current_period_start_date\": \"2023-09-26T07:14:24Z\",\n \"current_period_end_date\": \"2023-09-26T07:15:23Z\",\n \"never_expires\": false,\n \"number_of_billing_cycles\": 10,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n }\n }\n}\n\nSearch for subscriptions that have been created across all your plans using the provided filters below
\nA successful request to this endpoint will return the following response
\n{\n \"data\": {\n \"subscriptions\": [\n {\n \"token\": \"sub_c841ea40-613c-41a3-8984-7cb11f66d541\",\n \"plan_id\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"CANCELED\",\n \"billing_cycle_anchor\": \"2023-09-26T07:14:24Z\",\n \"price_amount\": \"10000\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-26T07:14:24Z\",\n \"trial_start_date\": \"2023-09-26T07:14:24Z\",\n \"trial_end_date\": \"2023-09-26T07:14:24Z\",\n \"cancel_at_period_end\": false,\n \"canceled_at\": \"2023-09-26T07:14:55Z\",\n \"created_at\": \"2023-09-26T07:14:24Z\",\n \"updated_at\": \"2023-09-26T07:14:55Z\",\n \"plan\": {\n \"token\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"Safepay demo\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"Slides\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 1,\n \"description\": \"\",\n \"created_at\": \"2023-09-26T07:02:46Z\",\n \"updated_at\": \"2023-09-26T07:17:45Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 10,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n },\n \"current_period_start_date\": \"2023-09-26T07:14:24Z\",\n \"current_period_end_date\": \"2023-09-26T07:15:23Z\",\n \"never_expires\": false,\n \"number_of_billing_cycles\": 10,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n }\n ],\n \"count\": \"18\",\n \"direction\": \"\",\n \"sort_by\": \"\"\n }\n}\n\nThe data property will contain the list of plans that have been searched for while the count will indicate how many total results are found. The sort_by and direction fields are returned based on what was provided in the request
Filter by subscription IDs
\n","type":"text/plain"},"key":"tokens","value":""},{"disabled":true,"description":{"content":"Filter by plan IDs
\n","type":"text/plain"},"key":"plan_ids","value":""},{"disabled":true,"description":{"content":"Filter by User IDs
\n","type":"text/plain"},"key":"user_ids","value":""},{"disabled":true,"description":{"content":"Filter by statuses
\n","type":"text/plain"},"key":"statuses","value":""},{"disabled":true,"description":{"content":"Limit search results to a value
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Paginate search results
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Sort by specifies the field use to sort data e.g. created_at
Direction specifies the data sort order either ASC or DESC
\n","type":"text/plain"},"key":"direction","value":""}],"variable":[]}},"response":[{"id":"1cc9a841-e8c8-44bb-b8cf-814791133676","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/client/subscriptions/v1/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Sep 2023 10:08:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80e36d84c84c21f5-KHI"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"subscriptions\": [\n {\n \"token\": \"sub_c841ea40-613c-41a3-8984-7cb11f66d541\",\n \"plan_id\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"CANCELED\",\n \"billing_cycle_anchor\": \"2023-09-26T07:14:24Z\",\n \"price_amount\": \"10000\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-26T07:14:24Z\",\n \"trial_start_date\": \"2023-09-26T07:14:24Z\",\n \"trial_end_date\": \"2023-09-26T07:14:24Z\",\n \"cancel_at_period_end\": false,\n \"canceled_at\": \"2023-09-26T07:14:55Z\",\n \"created_at\": \"2023-09-26T07:14:24Z\",\n \"updated_at\": \"2023-09-26T07:14:55Z\",\n \"plan\": {\n \"token\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"Safepay demo\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"Slides\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 1,\n \"description\": \"\",\n \"created_at\": \"2023-09-26T07:02:46Z\",\n \"updated_at\": \"2023-09-26T07:17:45Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 10,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n },\n \"current_period_start_date\": \"2023-09-26T07:14:24Z\",\n \"current_period_end_date\": \"2023-09-26T07:15:23Z\",\n \"never_expires\": false,\n \"number_of_billing_cycles\": 10,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n },\n {\n \"token\": \"sub_f2aecc20-deb7-4ca5-89b1-575222f23842\",\n \"plan_id\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-26T07:12:00Z\",\n \"price_amount\": \"10000\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-26T07:03:00Z\",\n \"end_date\": \"2023-09-26T07:12:05Z\",\n \"trial_start_date\": \"2023-09-26T07:03:00Z\",\n \"trial_end_date\": \"2023-09-26T07:03:00Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-26T07:03:00Z\",\n \"updated_at\": \"2023-09-26T07:12:05Z\",\n \"plan\": {\n \"token\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"Safepay demo\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"Slides\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 1,\n \"description\": \"\",\n \"created_at\": \"2023-09-26T07:02:46Z\",\n \"updated_at\": \"2023-09-26T07:17:45Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 10,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n },\n \"current_period_start_date\": \"2023-09-26T07:12:00Z\",\n \"current_period_end_date\": \"2023-09-26T07:12:59Z\",\n \"last_paid_date\": \"2023-09-26T07:12:05Z\",\n \"current_billing_cycle\": 10,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 10,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n },\n {\n \"token\": \"sub_cfd5628e-0f1d-4419-b582-a6dc511d7b22\",\n \"plan_id\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-26T06:59:34Z\",\n \"price_amount\": \"12300\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-26T06:59:34Z\",\n \"end_date\": \"2023-09-26T07:00:06Z\",\n \"trial_start_date\": \"2023-09-26T06:59:34Z\",\n \"trial_end_date\": \"2023-09-26T06:59:34Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-26T06:59:34Z\",\n \"updated_at\": \"2023-09-26T07:00:06Z\",\n \"plan\": {\n \"token\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"sada\",\n \"amount\": \"12300\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"12sa\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T11:33:57Z\",\n \"updated_at\": \"2023-09-26T07:00:33Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 1,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n \"current_period_start_date\": \"2023-09-26T06:59:34Z\",\n \"current_period_end_date\": \"2023-09-26T07:00:33Z\",\n \"last_paid_date\": \"2023-09-26T07:00:06Z\",\n \"current_billing_cycle\": 1,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 1,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n {\n \"token\": \"sub_af6ae7ee-3049-4a6a-aaf2-7d4d8e9b36bc\",\n \"plan_id\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-25T10:08:11Z\",\n \"price_amount\": \"12300\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-25T10:08:11Z\",\n \"end_date\": \"2023-09-25T10:09:06Z\",\n \"trial_start_date\": \"2023-09-25T10:08:11Z\",\n \"trial_end_date\": \"2023-09-25T10:08:11Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-25T10:08:11Z\",\n \"updated_at\": \"2023-09-25T10:09:06Z\",\n \"plan\": {\n \"token\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"sada\",\n \"amount\": \"12300\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"12sa\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T11:33:57Z\",\n \"updated_at\": \"2023-09-26T07:00:33Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 1,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n \"current_period_start_date\": \"2023-09-25T10:08:11Z\",\n \"current_period_end_date\": \"2023-09-25T10:09:10Z\",\n \"last_paid_date\": \"2023-09-25T10:09:06Z\",\n \"current_billing_cycle\": 1,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 1,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n {\n \"token\": \"sub_fc1c335d-b819-4255-b605-02e4e5af502e\",\n \"plan_id\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-25T09:48:59Z\",\n \"price_amount\": \"12300\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-25T09:48:59Z\",\n \"end_date\": \"2023-09-25T09:49:05Z\",\n \"trial_start_date\": \"2023-09-25T09:48:59Z\",\n \"trial_end_date\": \"2023-09-25T09:48:59Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-25T09:48:59Z\",\n \"updated_at\": \"2023-09-25T09:49:05Z\",\n \"plan\": {\n \"token\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"sada\",\n \"amount\": \"12300\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"12sa\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T11:33:57Z\",\n \"updated_at\": \"2023-09-26T07:00:33Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 1,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n \"current_period_start_date\": \"2023-09-25T09:48:59Z\",\n \"current_period_end_date\": \"2023-09-25T09:49:58Z\",\n \"last_paid_date\": \"2023-09-25T09:49:05Z\",\n \"current_billing_cycle\": 1,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 1,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n {\n \"token\": \"sub_91d5cde2-6cd2-46ef-97fc-d7f1bef6f436\",\n \"plan_id\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-25T09:45:50Z\",\n \"price_amount\": \"12300\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-25T09:45:50Z\",\n \"end_date\": \"2023-09-25T09:46:06Z\",\n \"trial_start_date\": \"2023-09-25T09:45:50Z\",\n \"trial_end_date\": \"2023-09-25T09:45:50Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-25T09:45:50Z\",\n \"updated_at\": \"2023-09-25T09:46:06Z\",\n \"plan\": {\n \"token\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"sada\",\n \"amount\": \"12300\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"12sa\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T11:33:57Z\",\n \"updated_at\": \"2023-09-26T07:00:33Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 1,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n \"current_period_start_date\": \"2023-09-25T09:45:50Z\",\n \"current_period_end_date\": \"2023-09-25T09:46:49Z\",\n \"last_paid_date\": \"2023-09-25T09:46:06Z\",\n \"current_billing_cycle\": 1,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 1,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n {\n \"token\": \"sub_addb5764-2e10-4b71-920a-117e0fcc9ed2\",\n \"plan_id\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-25T09:36:20Z\",\n \"price_amount\": \"12300\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-25T09:36:20Z\",\n \"end_date\": \"2023-09-25T09:37:06Z\",\n \"trial_start_date\": \"2023-09-25T09:36:20Z\",\n \"trial_end_date\": \"2023-09-25T09:36:20Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-25T09:36:20Z\",\n \"updated_at\": \"2023-09-25T09:37:06Z\",\n \"plan\": {\n \"token\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"sada\",\n \"amount\": \"12300\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"12sa\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T11:33:57Z\",\n \"updated_at\": \"2023-09-26T07:00:33Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 1,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n \"current_period_start_date\": \"2023-09-25T09:36:20Z\",\n \"current_period_end_date\": \"2023-09-25T09:37:19Z\",\n \"last_paid_date\": \"2023-09-25T09:37:06Z\",\n \"current_billing_cycle\": 1,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 1,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n {\n \"token\": \"sub_6f90a5af-c4fe-4ad7-9907-1227d570e171\",\n \"plan_id\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-25T07:08:25Z\",\n \"price_amount\": \"12300\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-25T07:08:25Z\",\n \"end_date\": \"2023-09-25T07:09:06Z\",\n \"trial_start_date\": \"2023-09-25T07:08:25Z\",\n \"trial_end_date\": \"2023-09-25T07:08:25Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-25T07:08:25Z\",\n \"updated_at\": \"2023-09-25T07:09:06Z\",\n \"plan\": {\n \"token\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"sada\",\n \"amount\": \"12300\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"12sa\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T11:33:57Z\",\n \"updated_at\": \"2023-09-26T07:00:33Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 1,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n \"current_period_start_date\": \"2023-09-25T07:08:25Z\",\n \"current_period_end_date\": \"2023-09-25T07:09:24Z\",\n \"last_paid_date\": \"2023-09-25T07:09:06Z\",\n \"current_billing_cycle\": 1,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 1,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n {\n \"token\": \"sub_a6691521-2fa6-4433-9cff-bbeee70cc32b\",\n \"plan_id\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-23T13:54:32Z\",\n \"price_amount\": \"12300\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-23T13:54:32Z\",\n \"end_date\": \"2023-09-23T13:55:06Z\",\n \"trial_start_date\": \"2023-09-23T13:54:32Z\",\n \"trial_end_date\": \"2023-09-23T13:54:32Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-23T13:54:32Z\",\n \"updated_at\": \"2023-09-23T13:55:06Z\",\n \"plan\": {\n \"token\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"sada\",\n \"amount\": \"12300\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"12sa\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T11:33:57Z\",\n \"updated_at\": \"2023-09-26T07:00:33Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 1,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n \"current_period_start_date\": \"2023-09-23T13:54:32Z\",\n \"current_period_end_date\": \"2023-09-23T13:55:31Z\",\n \"last_paid_date\": \"2023-09-23T13:55:06Z\",\n \"current_billing_cycle\": 1,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 1,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n {\n \"token\": \"sub_63b55c27-9797-4a05-961c-6ebd1a6b41cc\",\n \"plan_id\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-23T13:52:39Z\",\n \"price_amount\": \"12300\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-23T13:52:39Z\",\n \"end_date\": \"2023-09-23T13:53:07Z\",\n \"trial_start_date\": \"2023-09-23T13:52:39Z\",\n \"trial_end_date\": \"2023-09-23T13:52:39Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-23T13:52:39Z\",\n \"updated_at\": \"2023-09-23T13:53:07Z\",\n \"plan\": {\n \"token\": \"plan_a29a46d8-59aa-49b3-bbd3-659798dc7f06\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"sada\",\n \"amount\": \"12300\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"12sa\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T11:33:57Z\",\n \"updated_at\": \"2023-09-26T07:00:33Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 1,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n },\n \"current_period_start_date\": \"2023-09-23T13:52:39Z\",\n \"current_period_end_date\": \"2023-09-23T13:53:38Z\",\n \"last_paid_date\": \"2023-09-23T13:53:07Z\",\n \"current_billing_cycle\": 1,\n \"never_expires\": false,\n \"number_of_billing_cycles\": 1,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"12300\"\n }\n }\n ],\n \"count\": \"18\",\n \"direction\": \"\",\n \"sort_by\": \"\"\n }\n}"},{"id":"4b429055-4c9b-4487-95bc-3f9dffbf1ceb","name":"401","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/client/subscriptions/v1/search"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Sep 2023 10:09:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"200"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80e36e2e7cc521f5-KHI"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/jwt: missing jwt token, strategies/secret: merchant webhook secret not found in the request header]\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"5a6abf5a-de3d-4c4a-a744-b53e80dbe75b"},{"name":"Update Subscription","id":"4f45fa04-9f9d-4bcb-9696-64677aea7385","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"15670709dbd82556e286cc6640ebc31716b1a53b1463361d626e63ca741c16dc"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"billing_cycle_anchor\": \"2023-09-26T07:14:24Z\",\n \"trial_end\": \"2023-09-26T07:14:24Z\",\n \"cancel_at_period_end\": true,\n \"pause_collection\": {\n \"payment_collection_behavior\": \"KEEP_AS_READY\"\n },\n \"never_expires\": true,\n \"number_of_billing_cycles\": 1,\n \"proration_behavior\": \"CREATE_PRORATIONS\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/client/subscriptions/v1/sub_ee09b0f9-974f-4dee-b1b3-4ad8dad2e7b3","description":"Updates an existing subscription to match the specified parameters.
\nIts important to understand how updates to a subscription work especially when it comes to pausing a subscription, the proration behavior and how they work together.
\nChanging the billing_cycle_anchor will change the date the subscription is billed. Setting the value to now resets the subscription’s billing cycle anchor to the current time (in UTC).
Changing the trial_end will chage the date the trial_period ends. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value now can be provided to end the customer’s trial immediately.
Setting the trial_end to a future date and billing_cycle_anchor to now will result in an error since that is not allowed.
If the subscription is currently in a trial period, setting the billing_cycle_anchor to now will result in an error
If pause_collection is specified, payment collection for this subscription will be paused. based on the payment_collection_behavior
Proration Behavior
\nDetermines how to handle prorations when the billing cycle changes (e.g., resetting billing_cycle_anchor=now. If you don't want to prorate, set the proration_behavior to NONE_PRORATION_BEHAVIOR .The default value is CREATE_PRORATIONS
A successful request to this endpoint will return the following response
\n{\n \"data\": {\n \"request_id\": \"\",\n \"subscription\": {\n \"token\": \"sub_ee09b0f9-974f-4dee-b1b3-4ad8dad2e7b3\",\n \"plan_id\": \"plan_51591242-0f31-4d77-a712-dd27e3dddb38\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"PAUSED\",\n \"billing_cycle_anchor\": \"2023-09-22T10:52:34Z\",\n \"price_amount\": \"100000\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-22T10:52:34Z\",\n \"trial_start_date\": \"2023-09-22T10:52:34Z\",\n \"trial_end_date\": \"2023-09-22T10:52:34Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-22T10:52:34Z\",\n \"updated_at\": \"2023-09-29T10:46:05Z\",\n \"plan\": {\n \"token\": \"plan_51591242-0f31-4d77-a712-dd27e3dddb38\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"Shapatar plan\",\n \"amount\": \"100000\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"pk_102\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T10:51:48Z\",\n \"updated_at\": \"2023-09-22T10:51:48Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 10,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100000\"\n }\n },\n \"current_period_start_date\": \"2023-09-22T10:52:34Z\",\n \"current_period_end_date\": \"2023-09-22T10:53:33Z\",\n \"paused_at\": \"2023-09-29T10:46:05Z\",\n \"never_expires\": false,\n \"number_of_billing_cycles\": 10,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100000\"\n }\n }\n }\n}\n\nInitiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption transaction is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
If the subscription is in a trial phase and you set the billing_cycle_anchor to now the subscription status remains Paused till the new payment transaction is authorized.
Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.
\nNote, however, that any pending transaction items that have been created will still be charged for at the end of the period,
\nBy default, upon subscription cancellation, Safepay will stop automatic collection of all finalized payments for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription.
\nOnce cancelled, subscriptions cannot be resumed and a new subscription will have to be created. If you would like to temporarily pause payment collection for a subscription, you should Update Subscription and pass in the appropriate pause_collection_behavior parameter. Paused subscriptions can be resumed at any time but cancelled subscriptions are terminal.
Additionally, only subscriptions that are in the following states can be cancelled
\nTRAILING
INCOMPLETE
ACTIVE
A successful request to this endpoint will return the following response
\n{\n \"data\": {\n \"request_id\": \"\",\n \"subscription\": {\n \"token\": \"sub_ee09b0f9-974f-4dee-b1b3-4ad8dad2e7b3\",\n \"plan_id\": \"plan_51591242-0f31-4d77-a712-dd27e3dddb38\",\n \"user_id\": \"user_9ac8cc06-1fae-4f12-9636-a877eb8170a4\",\n \"instrument_id\": \"tms_39f40aec-ee62-411c-a759-2af2ffd3be44\",\n \"status\": \"CANCELED\",\n \"billing_cycle_anchor\": \"2023-09-26T11:21:27Z\",\n \"price_amount\": \"100000\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-22T10:52:34Z\",\n \"trial_start_date\": \"2023-09-22T10:52:34Z\",\n \"trial_end_date\": \"2023-08-26T07:14:24Z\",\n \"cancel_at_period_end\": true,\n \"canceled_at\": \"2023-09-29T11:21:36Z\",\n \"created_at\": \"2023-09-22T10:52:34Z\",\n \"updated_at\": \"2023-09-29T11:21:36Z\",\n \"plan\": {\n \"token\": \"plan_51591242-0f31-4d77-a712-dd27e3dddb38\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"Shapatar plan\",\n \"amount\": \"100000\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"pk_102\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 0,\n \"description\": \"\",\n \"created_at\": \"2023-09-22T10:51:48Z\",\n \"updated_at\": \"2023-09-22T10:51:48Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 10,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100000\"\n }\n },\n \"current_period_start_date\": \"2023-09-26T11:21:27Z\",\n \"current_period_end_date\": \"2023-09-29T11:22:26Z\",\n \"paused_at\": \"2023-09-29T10:46:05Z\",\n \"resumed_at\": \"2023-09-29T11:21:27Z\",\n \"never_expires\": false,\n \"number_of_billing_cycles\": 10,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"100000\"\n }\n }\n }\n}\n\nAs you can see the status of the subscription is now CANCELED
Now that we've learnt about Plans, lets move on to Subscriptions. While plans hold information about how you wish to charge your customer (frequency, intervals etc) along with what they are purchasing, subscriptions to that plan are created by customers when they interact with Safepay Checkout. Subscriptions are what allow Safepay to charge your customer on a recurring basis based on the parameters configured in the plan.
\nSubscriptions cannot be created using APIs since a customer has to subscribe to a plan. Subscriptions are created by a customer interacting with Safepay Checkout. You can however, use our SDKs to generate a Checkout URL that a customer can be redirected to so that they are able to subscribe to one of your plans. Refer to our Integration Guides to learn more.
\n","_postman_id":"7a7fd456-9b8c-408b-8a10-fcab6d3280e3"},{"name":"Transactions","item":[{"name":"Search Transactions","id":"10db781f-4038-493c-b091-23f9dd83d56d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"15670709dbd82556e286cc6640ebc31716b1a53b1463361d626e63ca741c16dc"}]},"isInherited":false},"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/client/transactions/v1/search?tokens&states¤cies&instrument_ids&subscription_ids&user_ids&limit=&page=&sort_by&direction","description":"Search for transactions that have been created across all subscription using the provided filters below
\nTransaction States
\nA successful request to this endpoint will return the following response
\n{\n \"data\": {\n \"transactions\": [\n {\n \"token\": \"txn_17553398-b91d-41e9-ae47-165e194d06a1\",\n \"charge_at\": \"2023-09-29T11:45:29Z\",\n \"charged\": \"2023-09-29T11:46:05Z\",\n \"status\": \"COMPLETE\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"instrument_id\": \"tms_8637b5dd-c25f-463d-8cd0-216a54d98c6e\",\n \"subscription_id\": \"sub_130aa5b2-9056-4c8e-b9c9-9149e68f17ce\",\n \"created_at\": \"2023-09-29T11:45:06Z\",\n \"updated_at\": \"2023-09-29T11:46:05Z\",\n \"failures\": [],\n \"subscription\": null,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"user_id\": \"user_ebd81ebe-f302-47f4-83f1-62dc35cd8c63\",\n \"transaction_type\": \"PAYMENT\",\n \"proration\": false,\n \"tracker\": \"\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n }\n ],\n \"count\": 58,\n \"direction\": \"\",\n \"sort_by\": \"\"\n }\n}\n\nFilter by transaction IDs
\n","type":"text/plain"},"key":"tokens","value":null},{"description":{"content":"Filter by transaction states
\n","type":"text/plain"},"key":"states","value":null},{"description":{"content":"Filter by currencies
\n","type":"text/plain"},"key":"currencies","value":null},{"description":{"content":"Filter by instrument IDs
\n","type":"text/plain"},"key":"instrument_ids","value":null},{"description":{"content":"Filter by subscription IDs
\n","type":"text/plain"},"key":"subscription_ids","value":null},{"description":{"content":"Filter by User IDs
\n","type":"text/plain"},"key":"user_ids","value":null},{"description":{"content":"Limit search results
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"Paginate search results
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Sort by specifies the field use to sort data e.g. created_at
Direction specifies the data sort order either ASC or DESC
\n","type":"text/plain"},"key":"direction","value":null}],"variable":[]}},"response":[{"id":"df262c90-b750-4766-b92d-dd3a79db05db","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/client/transactions/v1/search?tokens&states¤cies&instrument_ids&subscription_ids&user_ids&limit=1&page=1&sort_by&direction","host":["https://sandbox.api.getsafepay.com"],"path":["client","transactions","v1","search"],"query":[{"key":"tokens","value":null,"type":"text"},{"key":"states","value":null,"type":"text"},{"key":"currencies","value":null,"type":"text"},{"key":"instrument_ids","value":null,"type":"text"},{"key":"subscription_ids","value":null,"type":"text"},{"key":"user_ids","value":null,"type":"text"},{"key":"limit","value":"1","type":"text"},{"key":"page","value":"1","type":"text"},{"key":"sort_by","value":null,"type":"text"},{"key":"direction","value":null,"type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Sep 2023 11:56:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80e40ac83df921f5-KHI"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"transactions\": [\n {\n \"token\": \"txn_17553398-b91d-41e9-ae47-165e194d06a1\",\n \"charge_at\": \"2023-09-29T11:45:29Z\",\n \"charged\": \"2023-09-29T11:46:05Z\",\n \"status\": \"COMPLETE\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"instrument_id\": \"tms_8637b5dd-c25f-463d-8cd0-216a54d98c6e\",\n \"subscription_id\": \"sub_130aa5b2-9056-4c8e-b9c9-9149e68f17ce\",\n \"created_at\": \"2023-09-29T11:45:06Z\",\n \"updated_at\": \"2023-09-29T11:46:05Z\",\n \"failures\": [],\n \"subscription\": null,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"user_id\": \"user_ebd81ebe-f302-47f4-83f1-62dc35cd8c63\",\n \"transaction_type\": \"PAYMENT\",\n \"proration\": false,\n \"tracker\": \"\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n }\n ],\n \"count\": 58,\n \"direction\": \"\",\n \"sort_by\": \"\"\n }\n}"},{"id":"f5cc8634-fe48-48e6-8e59-334ab3359fd9","name":"401","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/client/transactions/v1/search?tokens&states¤cies&instrument_ids&subscription_ids&user_ids&limit=1&page=1&sort_by&direction","host":["https://sandbox.api.getsafepay.com"],"path":["client","transactions","v1","search"],"query":[{"key":"tokens","value":null,"type":"text"},{"key":"states","value":null,"type":"text"},{"key":"currencies","value":null,"type":"text"},{"key":"instrument_ids","value":null,"type":"text"},{"key":"subscription_ids","value":null,"type":"text"},{"key":"user_ids","value":null,"type":"text"},{"key":"limit","value":"1","type":"text"},{"key":"page","value":"1","type":"text"},{"key":"sort_by","value":null,"type":"text"},{"key":"direction","value":null,"type":"text"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Sep 2023 11:57:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"200"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80e40c049fea21f5-KHI"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/jwt: missing jwt token, strategies/secret: merchant webhook secret not found in the request header]\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"10db781f-4038-493c-b091-23f9dd83d56d"},{"name":"Find Transaction","id":"86c70033-d048-4224-915a-add9daee084e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-SFPY-MERCHANT-SECRET"},{"key":"value","value":"15670709dbd82556e286cc6640ebc31716b1a53b1463361d626e63ca741c16dc"}]},"isInherited":false},"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/client/transactions/v1/txn_17553398-b91d-41e9-ae47-165e194d06a1","description":"Retrieves tranasction details based on the transaction ID
\nA successful request to this endpoint will return the following response
\n{\n \"data\": {\n \"transaction\": {\n \"token\": \"txn_17553398-b91d-41e9-ae47-165e194d06a1\",\n \"charge_at\": \"2023-09-29T11:45:29Z\",\n \"charged\": \"2023-09-29T11:46:05Z\",\n \"status\": \"COMPLETE\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"instrument_id\": \"tms_8637b5dd-c25f-463d-8cd0-216a54d98c6e\",\n \"subscription_id\": \"sub_130aa5b2-9056-4c8e-b9c9-9149e68f17ce\",\n \"created_at\": \"2023-09-29T11:45:06Z\",\n \"updated_at\": \"2023-09-29T11:46:05Z\",\n \"failures\": [],\n \"subscription\": {\n \"token\": \"sub_130aa5b2-9056-4c8e-b9c9-9149e68f17ce\",\n \"plan_id\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"user_id\": \"user_ebd81ebe-f302-47f4-83f1-62dc35cd8c63\",\n \"instrument_id\": \"tms_8637b5dd-c25f-463d-8cd0-216a54d98c6e\",\n \"status\": \"ENDED\",\n \"billing_cycle_anchor\": \"2023-09-29T11:45:29Z\",\n \"price_amount\": \"10000\",\n \"price_currency\": \"PKR\",\n \"balance\": \"0\",\n \"start_date\": \"2023-09-30T11:33:49Z\",\n \"end_date\": \"2023-09-29T11:46:05Z\",\n \"trial_start_date\": \"2023-09-29T11:33:49Z\",\n \"trial_end_date\": \"2023-09-30T11:33:49Z\",\n \"cancel_at_period_end\": false,\n \"created_at\": \"2023-09-29T11:33:49Z\",\n \"updated_at\": \"2023-09-29T11:46:05Z\",\n \"plan\": {\n \"token\": \"plan_48c249c4-b947-4617-9472-b28acffd3b64\",\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"name\": \"Safepay demo\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"interval_count\": 1,\n \"interval\": \"MINUTE_TEST_INTERVAL\",\n \"product\": \"Slides\",\n \"type\": \"RECURRING\",\n \"trial_period_days\": 1,\n \"description\": \"\",\n \"created_at\": \"2023-09-26T07:02:46Z\",\n \"updated_at\": \"2023-09-26T07:17:45Z\",\n \"active\": true,\n \"archived\": false,\n \"number_of_billing_cycles\": 10,\n \"apply_amount_change_on_existing_subscriptions\": false,\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n },\n \"current_period_start_date\": \"2023-09-29T11:45:29Z\",\n \"current_period_end_date\": \"2023-09-29T11:46:28Z\",\n \"last_paid_date\": \"2023-09-29T11:46:05Z\",\n \"current_billing_cycle\": 10,\n \"paused_at\": \"2023-09-29T11:34:16Z\",\n \"resumed_at\": \"2023-09-29T11:36:29Z\",\n \"never_expires\": false,\n \"number_of_billing_cycles\": 10,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n },\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"user_id\": \"user_ebd81ebe-f302-47f4-83f1-62dc35cd8c63\",\n \"transaction_type\": \"PAYMENT\",\n \"proration\": false,\n \"tracker\": \"track_0805eb64-32bd-485f-b597-96a54e2898eb\",\n \"price_money\": {\n \"currency\": \"PKR\",\n \"amount\": \"10000\"\n }\n }\n }\n}\n\nCreate a new refund transcation based on the original transaction ID.
\nIf a tranasction already has a refund transaction associated with it, this endpoint will return an error
\nA successful request to this endpoint will return the new transcation object with transaction_type set to REFUND
{\n \"data\": {\n \"transaction\": {\n \"token\": \"txn_0d30cb5b-33c3-4ae2-b295-93c8669e523f\",\n \"charge_at\": \"2023-09-29T12:00:53.888546561Z\",\n \"status\": \"READY\",\n \"amount\": \"10000\",\n \"currency\": \"PKR\",\n \"instrument_id\": \"tms_8637b5dd-c25f-463d-8cd0-216a54d98c6e\",\n \"subscription_id\": \"sub_130aa5b2-9056-4c8e-b9c9-9149e68f17ce\",\n \"created_at\": \"2023-09-29T12:00:53.888582029Z\",\n \"updated_at\": \"2023-09-29T12:00:53.888582741Z\",\n \"failures\": [],\n \"subscription\": null,\n \"merchant_api_key\": \"sec_faed47eb-0044-4968-b7e9-2fb7d7853eb7\",\n \"user_id\": \"user_ebd81ebe-f302-47f4-83f1-62dc35cd8c63\",\n \"transaction_type\": \"REFUND\",\n \"proration\": false,\n \"tracker\": \"\"\n }\n }\n}\n\nThe Transaction APIs allow developers to search, find and refund transactions related to subscriptions. A Transaction is an object that is created as soon as a previous transaction has been processed.
\nTransactions can either be of type PAYMENT meaning that an attempt will be made to charge a customer, or of type REFUND meaning an attempt will be made to refund a customer.
Create and manage plans, subscriptions, recurring payments, and recurring revenue with the Safepay Billing APIs.
\nWith Subscriptions, customers make recurring payments for access to a plan. Subscriptions require you to retain more information about your customers than one-time purchases because you need to charge them in the future.
\nBilling APIs support both API Key and JWT based authorization strategies. Refer to the API Authentication section to understand how to use each authentication strategy
\n","_postman_id":"1758a97c-b6a4-42f2-822c-234533b8a5da"},{"name":"Quick Links","item":[{"name":"V2","item":[{"name":"Create","event":[{"listen":"prerequest","script":{"id":"fd21abcc-22c2-4b4a-ab2e-d209197dd996","exec":["var moment = require('moment');","","pm.environment.set('tomorrowDate', moment().add(1, 'days').utc().format());"],"type":"text/javascript","packages":{}}}],"id":"ec720b27-3f22-4a84-a457-c2c35b705556","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"amount\": 15000,\n\t\"currency\": \"PKR\",\n\t\"note\": \"For Zara handbag purchased through Import Fox\",\n\t\"workflow\": \"MANUAL\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v2/","urlObject":{"path":["invoice","quick-links","v2",""],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"a182b20b-258e-4398-9c13-f1150c29cd50","name":"200 - Manual Workflow","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"amount\": 15000,\n\t\"currency\": \"PKR\",\n\t\"note\": \"For Zara handbag purchased through Import Fox\",\n\t\"workflow\": \"MANUAL\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v2/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"ba88ed11-f1cc-46fd-881d-855a3bdad469","name":"200 - Email Workflow","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"amount\": 15000,\n\t\"currency\": \"PKR\",\n\t\"note\": \"For Zara handbag purchased through Import Fox\",\n\t\"workflow\": \"EMAIL\",\n \"recipients\": [\"mahmed@gmail.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v2/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"2ec90823-e8d9-4395-ac45-a0ff008449ca","name":"200 - With Expiry","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"amount\": 15000,\n\t\"currency\": \"PKR\",\n\t\"note\": \"For Zara handbag purchased through Import Fox\",\n\t\"workflow\": \"EMAIL\",\n \"recipients\": [\"mahmed@gmail.com\"],\n \"expiry\": \"{{tomorrowDate}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v2/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7c21f1d5-85a8-4435-95cc-9412c3c4e56b","name":"404 - Invalid Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"amount\": 15000,\n\t\"currency\": \"PKR\",\n\t\"note\": \"For Zara handbag purchased through Import Fox\",\n\t\"workflow\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v2/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ec720b27-3f22-4a84-a457-c2c35b705556"},{"name":"Find","event":[{"listen":"test","script":{"id":"fae59bf0-66f0-4713-9ab9-b51378826400","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"quicklinkTBT\", jsonData.data.tbt);"],"type":"text/javascript","packages":{}}}],"id":"4b337150-e13a-48a7-a2f9-58609068b569","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v2/link_291208af-ef95-4b7d-b171-aaaa16998d31","urlObject":{"path":["invoice","quick-links","v2","link_291208af-ef95-4b7d-b171-aaaa16998d31"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"fd7cfe2f-ddeb-4dd6-979f-b11bd0569e68","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v2/link_291208af-ef95-4b7d-b171-aaaa16998d31"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"634be3be-64de-4eca-93bb-4078654942f0","name":"404 - Not Found","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v2/link_291208af-ef95-4b7d-b171-aaaa16998d31"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4b337150-e13a-48a7-a2f9-58609068b569"}],"id":"39822195-8da2-4645-a6e2-ccc3cabd53a2","_postman_id":"39822195-8da2-4645-a6e2-ccc3cabd53a2","description":""},{"name":"Create Quick Link","id":"ca0d7283-b873-494e-845c-56cc2f663a05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"amount\": 15000,\n\t\"currency\": \"PKR\",\n\t\"note\": \"For Zara handbag purchased through Import Fox\",\n\t\"workflow\": \"MANUAL\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v1/","description":"Create a Quick Link by sending the following request body. All amounts are in the normal denomination of their respective currency. This means that passing in an amount as 150000 and currency as PKR will create a Quick Link requesting Rs 15,000 from the recipient.
\n\nThis endpoint only supports JWT based authentication
\n
Valid currencies that can be provided are
\nPKRUSDGBPAEDSAREURCADTo manually send the Quick Link through your own mediums (either through WhatsApp or present the link on your own platform) set the workflow value to be MANUAL.
Response:
\nA successfull request to this endpoint will generate the following response
\n{\n \"data\": {\n \"id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"92243675\",\n \"status\": \"CREATED\",\n \"note\": \"For Zara handbag purchased through Import Fox\",\n \"metadata\": [\n {\n \"id\": \"meta_e7b25fdc-a4ca-4ed1-9249-85c881d4e4f7\",\n \"quick_link_id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"payment\": null,\n \"recipients\": null,\n \"total\": 15000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2023-09-28T11:26:27.453829284Z\",\n \"updated_at\": \"2023-09-28T11:26:27.453829385Z\"\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nThe unique URL that can be sent to your customer or client can be retrieved by indexing the data object at the matadata level like so data.metadata[0].recipient_view_url
Email a Quick Link by sending the following request body. All amounts are in the normal denomination of their respective currency. This means that passing in an amount as 150000 and currency as PKR will create a Quick Link requesting Rs 15,000 from the recipient.
This endpoint is the same as the one above, however, by changing the value of the workflow and specifying a list of email addresses, Safepay will generate a unique Quick Link for each of your recipients specified in the recipients array and automatically send them an email with the Quick Link embedded inside of it.
\n\nThis endpoint only supports JWT based authentication
\n
Valid currencies that can be provided are
\nPKR
USD
GBP
AED
SAR
EUR
CAD
To have Safepay send the Quick Links through email to your recipients, set the workflow value as EMAIL and specifiy at least 1 recipient and a max of 10 recipients
A successful request to this endpoint will email each recipient a unique Quick Link and will return a response as follows
\n{\n \"data\": [\n {\n \"id\": \"link_7b6a30a6-2665-4ae6-af2f-67f9597e2bbe\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"51688111\",\n \"status\": \"CREATED\",\n \"note\": \"For Zara handbag purchased through Import Fox\",\n \"metadata\": [\n {\n \"id\": \"meta_930af5ec-f4e9-4a0f-a31a-56a263ca1a82\",\n \"quick_link_id\": \"link_7b6a30a6-2665-4ae6-af2f-67f9597e2bbe\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_7b6a30a6-2665-4ae6-af2f-67f9597e2bbe\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"payment\": null,\n \"recipients\": [\n {\n \"id\": \"recp_70a4322f-af21-4a65-946d-275842672772\",\n \"quick_link_id\": \"link_7b6a30a6-2665-4ae6-af2f-67f9597e2bbe\",\n \"email\": \"ziyadparekh@gmail.com\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"total\": 15000,\n \"currency\": \"PKR\",\n \"workflow\": \"EMAIL\",\n \"created_at\": \"2023-09-28T11:44:00.278477946Z\",\n \"updated_at\": \"2023-09-28T11:44:00.278478045Z\"\n },\n {\n \"id\": \"link_b8540e06-109e-4937-af99-c2a0a5b575cd\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"65014765\",\n \"status\": \"CREATED\",\n \"note\": \"For Zara handbag purchased through Import Fox\",\n \"metadata\": [\n {\n \"id\": \"meta_6bb54aa4-d45f-4eb7-96dc-1d6344a4056e\",\n \"quick_link_id\": \"link_b8540e06-109e-4937-af99-c2a0a5b575cd\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_b8540e06-109e-4937-af99-c2a0a5b575cd\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"payment\": null,\n \"recipients\": [\n {\n \"id\": \"recp_d1cebefe-987f-4c2a-82bb-2d02c49f9ef3\",\n \"quick_link_id\": \"link_b8540e06-109e-4937-af99-c2a0a5b575cd\",\n \"email\": \"hzaidi@gmail.com\",\n \"created_at\": \"0001-01-01T00:00:00Z\",\n \"updated_at\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"total\": 15000,\n \"currency\": \"PKR\",\n \"workflow\": \"EMAIL\",\n \"created_at\": \"2023-09-28T11:44:00.278488738Z\",\n \"updated_at\": \"2023-09-28T11:44:00.27848882Z\"\n }\n ],\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nAs you can see in the example above, for each recipient (in this case 2) Safepay has generated two Quick Links and has added each recipient in the recipients property of the Quick Link. If you customer does not receive the Quick Link on his email, you can always fetch the Quick Link, retrieve the URL and send it to them manually.
Retrieves details about the Quick Link
\nBy passing in the unique Quick Link ID in the URL params, this endpoint will fetch details about the Quick Link.
\n\n\nThis endpoint only supports JWT based authentication
\n
A successful request will generate the following response
\n{\n \"data\": {\n \"link\": {\n \"id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"92243675\",\n \"status\": \"CREATED\",\n \"note\": \"For Zara handbag purchased through Import Fox\",\n \"metadata\": [\n {\n \"id\": \"meta_e7b25fdc-a4ca-4ed1-9249-85c881d4e4f7\",\n \"quick_link_id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"created_at\": \"2023-09-28T11:26:27Z\",\n \"updated_at\": \"2023-09-28T11:26:27Z\"\n }\n ],\n \"payment\": [],\n \"recipients\": [],\n \"total\": 15000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2023-09-28T11:26:27Z\",\n \"updated_at\": \"2023-09-28T11:26:27Z\"\n },\n \"client\": {\n \"token\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"name\": \"Baked in Pakistan\",\n \"description\": \"High end pâtisserie\",\n \"email\": \"zparekh@getsafepay.com\",\n \"phone\": \"03008277879\",\n \"api_key\": \"sec_8dcac601-4b70-442d-b198-03aadd28f12b\",\n \"avatar\": \"https://storage.googleapis.com/safepay-assets/b2a545f6-b636-44ae-9023-abcfc113651a-favicon.png\",\n \"website\": \"https://www.getsafepay.com\",\n \"payout_terms\": \"\",\n \"active\": 0,\n \"suspended\": 0,\n \"suspend_reason\": \"\",\n \"email_settings\": null,\n \"api_settings\": null,\n \"organization\": null,\n \"verification\": null,\n \"verified\": 1,\n \"created_at\": \"2019-04-28T01:04:00Z\",\n \"updated_at\": \"2019-06-05T16:25:26Z\"\n }\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nA Quick Link can be updated as long as its status is not PAID. Once a Quick Link has been paid, it can no longer be updated and a new Quick Link will have to be generated.
\n\nThis endpoint only supports JWT based authentication
\n
A successful request to this endpoint will return the updated Quick Link
\n{\n \"data\": {\n \"id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"92243675\",\n \"status\": \"CREATED\",\n \"note\": \"Test Notes\",\n \"metadata\": [\n {\n \"id\": \"meta_e7b25fdc-a4ca-4ed1-9249-85c881d4e4f7\",\n \"quick_link_id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"created_at\": \"2023-09-28T11:26:27Z\",\n \"updated_at\": \"2023-09-28T11:26:27Z\"\n }\n ],\n \"payment\": [],\n \"recipients\": [],\n \"total\": 10000,\n \"currency\": \"USD\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2023-09-28T11:26:27Z\",\n \"updated_at\": \"2023-09-28T11:26:27Z\"\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nList or search for Quick Links
\nPagination is supported via the limit and page query parameters.
\n\nThis endpoint only supports JWT based authentication
\n
Response:
\nA successul request to this endpoint will return a paginated list of Quick Links as follows. The count field indicates the total number of Quick Links that have been created against your account.
{\n \"data\": {\n \"count\": 25,\n \"list\": [\n {\n \"id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"92243675\",\n \"status\": \"CREATED\",\n \"note\": \"Test Notes\",\n \"metadata\": [\n {\n \"id\": \"meta_e7b25fdc-a4ca-4ed1-9249-85c881d4e4f7\",\n \"quick_link_id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"created_at\": \"2023-09-28T11:26:27Z\",\n \"updated_at\": \"2023-09-28T12:33:08Z\"\n }\n ],\n \"payment\": [],\n \"recipients\": [],\n \"total\": 10000,\n \"currency\": \"USD\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2023-09-28T11:26:27Z\",\n \"updated_at\": \"2023-09-28T12:33:08Z\"\n },\n {\n \"id\": \"link_198f2fc2-71f2-44d0-8270-7daa7337a11c\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"61568134\",\n \"status\": \"PAID\",\n \"note\": \"Cake \",\n \"metadata\": [\n {\n \"id\": \"meta_b7618611-447d-4218-be8c-a0fef9104cd6\",\n \"quick_link_id\": \"link_198f2fc2-71f2-44d0-8270-7daa7337a11c\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_198f2fc2-71f2-44d0-8270-7daa7337a11c\",\n \"created_at\": \"2020-08-09T16:20:36Z\",\n \"updated_at\": \"2020-08-09T16:23:51Z\"\n }\n ],\n \"payment\": [\n {\n \"id\": \"pay_dd318e83-c133-4cba-9cc0-1a18f00b06f5\",\n \"quick_link_id\": \"link_198f2fc2-71f2-44d0-8270-7daa7337a11c\",\n \"sp_tracker\": \"track_de4d345f-7697-4e0a-9e9b-826cd14a225f\",\n \"sp_transaction\": \"trans_bbfbf069-26ba-47bf-a690-794cef873ce1\",\n \"sp_reference\": \"682887\",\n \"created_at\": \"2020-08-09T16:23:51Z\",\n \"updated_at\": \"2020-08-09T16:23:51Z\"\n }\n ],\n \"recipients\": [],\n \"total\": 2000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-08-09T16:20:36Z\",\n \"updated_at\": \"2020-08-09T16:23:51Z\"\n }\n ]\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n\nThe page to search for. Page serves as an offset counter starting with 1
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"How many results to return per page. A limit of 10 will return 10 Quick Links per page
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"One of EMAIL or MANUAL
\n","type":"text/plain"},"key":"workflow","value":"MANUAL"}],"variable":[]}},"response":[{"id":"f9256224-8933-4e38-8d92-188f17ac34c4","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/invoice/quick-links/v1/?page=1&limit=10&workflow=MANUAL","host":["https://sandbox.api.getsafepay.com"],"path":["invoice","quick-links","v1",""],"query":[{"key":"page","value":"1","description":"The page to search for. Page serves as an offset counter starting with 1"},{"key":"limit","value":"10","description":"How many results to return per page. A limit of 10 will return 10 Quick Links per page"},{"key":"workflow","value":"MANUAL","description":"One of EMAIL or MANUAL"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Sep 2023 12:53:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80dc219fdf5a0048-KHI"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"count\": 25,\n \"list\": [\n {\n \"id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"92243675\",\n \"status\": \"CREATED\",\n \"note\": \"Test Notes\",\n \"metadata\": [\n {\n \"id\": \"meta_e7b25fdc-a4ca-4ed1-9249-85c881d4e4f7\",\n \"quick_link_id\": \"link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_297bfa4b-f61c-4c72-80a4-368d731e890c\",\n \"created_at\": \"2023-09-28T11:26:27Z\",\n \"updated_at\": \"2023-09-28T12:33:08Z\"\n }\n ],\n \"payment\": [],\n \"recipients\": [],\n \"total\": 10000,\n \"currency\": \"USD\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2023-09-28T11:26:27Z\",\n \"updated_at\": \"2023-09-28T12:33:08Z\"\n },\n {\n \"id\": \"link_198f2fc2-71f2-44d0-8270-7daa7337a11c\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"61568134\",\n \"status\": \"PAID\",\n \"note\": \"Cake \",\n \"metadata\": [\n {\n \"id\": \"meta_b7618611-447d-4218-be8c-a0fef9104cd6\",\n \"quick_link_id\": \"link_198f2fc2-71f2-44d0-8270-7daa7337a11c\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_198f2fc2-71f2-44d0-8270-7daa7337a11c\",\n \"created_at\": \"2020-08-09T16:20:36Z\",\n \"updated_at\": \"2020-08-09T16:23:51Z\"\n }\n ],\n \"payment\": [\n {\n \"id\": \"pay_dd318e83-c133-4cba-9cc0-1a18f00b06f5\",\n \"quick_link_id\": \"link_198f2fc2-71f2-44d0-8270-7daa7337a11c\",\n \"sp_tracker\": \"track_de4d345f-7697-4e0a-9e9b-826cd14a225f\",\n \"sp_transaction\": \"trans_bbfbf069-26ba-47bf-a690-794cef873ce1\",\n \"sp_reference\": \"682887\",\n \"created_at\": \"2020-08-09T16:23:51Z\",\n \"updated_at\": \"2020-08-09T16:23:51Z\"\n }\n ],\n \"recipients\": [],\n \"total\": 2000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-08-09T16:20:36Z\",\n \"updated_at\": \"2020-08-09T16:23:51Z\"\n },\n {\n \"id\": \"link_3ad067dc-5494-44bd-82b1-eff60d23596a\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"55272702\",\n \"status\": \"PAID\",\n \"note\": \"Customised xyz\",\n \"metadata\": [\n {\n \"id\": \"meta_8e3e3760-4789-4a78-b1bb-e68a881f93e5\",\n \"quick_link_id\": \"link_3ad067dc-5494-44bd-82b1-eff60d23596a\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_3ad067dc-5494-44bd-82b1-eff60d23596a\",\n \"created_at\": \"2020-07-07T09:30:20Z\",\n \"updated_at\": \"2023-06-05T14:32:18Z\"\n }\n ],\n \"payment\": [\n {\n \"id\": \"pay_56449d40-495f-44fc-88fa-e0f2ca9ca2f4\",\n \"quick_link_id\": \"link_3ad067dc-5494-44bd-82b1-eff60d23596a\",\n \"sp_tracker\": \"track_18472652-1167-499c-a0f4-c18974f9a1a0\",\n \"sp_transaction\": \"trans_ca612e25-ce16-45c7-ad89-dfab0081d758\",\n \"sp_reference\": \"296235\",\n \"created_at\": \"2023-06-05T14:32:18Z\",\n \"updated_at\": \"2023-06-05T14:32:18Z\"\n }\n ],\n \"recipients\": [],\n \"total\": 30000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-07-07T09:30:20Z\",\n \"updated_at\": \"2023-06-05T14:32:18Z\"\n },\n {\n \"id\": \"link_a758a1b7-7dea-4bd2-9a21-883e1d74966a\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"39300799\",\n \"status\": \"PAID\",\n \"note\": \"Raza Naqvi, lunch order, protein menu, Week of 6th July\",\n \"metadata\": [\n {\n \"id\": \"meta_e2b3e5e2-4428-4d9d-9405-02ea2e39080c\",\n \"quick_link_id\": \"link_a758a1b7-7dea-4bd2-9a21-883e1d74966a\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_a758a1b7-7dea-4bd2-9a21-883e1d74966a\",\n \"created_at\": \"2020-07-06T07:14:20Z\",\n \"updated_at\": \"2023-06-05T14:35:48Z\"\n }\n ],\n \"payment\": [\n {\n \"id\": \"pay_9e79adc5-8d17-4b0f-9c1b-4a4ca7b29c9c\",\n \"quick_link_id\": \"link_a758a1b7-7dea-4bd2-9a21-883e1d74966a\",\n \"sp_tracker\": \"track_017346e3-18de-4b5d-9bd3-825527b304dc\",\n \"sp_transaction\": \"trans_c3865e66-8c21-415d-baf9-25e552979ffe\",\n \"sp_reference\": \"452104\",\n \"created_at\": \"2023-06-05T14:35:48Z\",\n \"updated_at\": \"2023-06-05T14:35:48Z\"\n }\n ],\n \"recipients\": [],\n \"total\": 3500,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-07-06T07:14:20Z\",\n \"updated_at\": \"2023-06-05T14:35:48Z\"\n },\n {\n \"id\": \"link_0a004b19-f065-4d2b-900f-c6c4a1ed01e7\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"95050186\",\n \"status\": \"PAID\",\n \"note\": \"Test for searches\",\n \"metadata\": [\n {\n \"id\": \"meta_6dcb0b5e-1325-4c3b-aec6-d02e9a504dc0\",\n \"quick_link_id\": \"link_0a004b19-f065-4d2b-900f-c6c4a1ed01e7\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_0a004b19-f065-4d2b-900f-c6c4a1ed01e7\",\n \"created_at\": \"2020-05-05T10:23:51Z\",\n \"updated_at\": \"2020-05-05T10:32:31Z\"\n }\n ],\n \"payment\": [\n {\n \"id\": \"pay_87ea6054-7fd0-41ee-9897-b2e3c4b8bc44\",\n \"quick_link_id\": \"link_0a004b19-f065-4d2b-900f-c6c4a1ed01e7\",\n \"sp_tracker\": \"track_555b4f02-83a2-4b53-8649-29cd8af23db0\",\n \"sp_transaction\": \"trans_993c40b2-50c4-4f2a-b221-393929f0af21\",\n \"sp_reference\": \"142763\",\n \"created_at\": \"2020-05-05T10:32:31Z\",\n \"updated_at\": \"2020-05-05T10:32:31Z\"\n }\n ],\n \"recipients\": [],\n \"total\": 5000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-05-05T10:23:51Z\",\n \"updated_at\": \"2020-05-05T10:32:31Z\"\n },\n {\n \"id\": \"link_15b891a9-cb17-4d54-95cb-e37766967c00\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"74632647\",\n \"status\": \"CREATED\",\n \"note\": \"Graphic Design Project for Henry Nettles - 30 April - Delivery Date\",\n \"metadata\": [\n {\n \"id\": \"meta_98e25cd5-ec96-4fc1-b0c5-4b466a5ed1ba\",\n \"quick_link_id\": \"link_15b891a9-cb17-4d54-95cb-e37766967c00\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_15b891a9-cb17-4d54-95cb-e37766967c00\",\n \"created_at\": \"2020-04-30T10:48:58Z\",\n \"updated_at\": \"2023-06-12T13:42:36Z\"\n }\n ],\n \"payment\": [],\n \"recipients\": [],\n \"total\": 200,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-04-30T10:48:58Z\",\n \"updated_at\": \"2023-06-12T13:42:36Z\"\n },\n {\n \"id\": \"link_dabc673b-d6f8-4740-abe7-95a9a698d93f\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"28948828\",\n \"status\": \"PAID\",\n \"note\": \"Wed 22/04/2020 - acupuncture session and equipment used \",\n \"metadata\": [\n {\n \"id\": \"meta_f5ea416a-8087-4b11-b9dd-322d5d7d4ea5\",\n \"quick_link_id\": \"link_dabc673b-d6f8-4740-abe7-95a9a698d93f\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_dabc673b-d6f8-4740-abe7-95a9a698d93f\",\n \"created_at\": \"2020-04-22T05:31:58Z\",\n \"updated_at\": \"2020-06-26T12:39:03Z\"\n }\n ],\n \"payment\": [\n {\n \"id\": \"pay_fc0bebd3-eb39-4289-80cf-dbcab7182bce\",\n \"quick_link_id\": \"link_dabc673b-d6f8-4740-abe7-95a9a698d93f\",\n \"sp_tracker\": \"track_76631b20-2418-472d-86ea-ac9b2d2a9c9d\",\n \"sp_transaction\": \"trans_0e6f0e8e-ff7d-4d99-9d99-617a1ecd7d0d\",\n \"sp_reference\": \"770244\",\n \"created_at\": \"2020-06-26T12:39:03Z\",\n \"updated_at\": \"2020-06-26T12:39:03Z\"\n }\n ],\n \"recipients\": [],\n \"total\": 2000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-04-22T05:31:58Z\",\n \"updated_at\": \"2020-06-26T12:39:03Z\"\n },\n {\n \"id\": \"link_41f0ad3c-4387-48c4-906a-182a52bc2cab\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"41957249\",\n \"status\": \"PAID\",\n \"note\": \"2 x paint @ Rs 1500 each\\n3 x hammer @ Rs 400 each\\n5 x washer @ Rs 30 each\",\n \"metadata\": [\n {\n \"id\": \"meta_c2ea2e4e-44cb-4b07-9191-1f2da0f3e51e\",\n \"quick_link_id\": \"link_41f0ad3c-4387-48c4-906a-182a52bc2cab\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_41f0ad3c-4387-48c4-906a-182a52bc2cab\",\n \"created_at\": \"2020-04-21T11:27:33Z\",\n \"updated_at\": \"2023-06-05T14:36:44Z\"\n }\n ],\n \"payment\": [\n {\n \"id\": \"pay_31598e13-8633-4f65-9a79-94ad0933b971\",\n \"quick_link_id\": \"link_41f0ad3c-4387-48c4-906a-182a52bc2cab\",\n \"sp_tracker\": \"track_c671e727-c31e-45c3-af5d-3a60acbdcce1\",\n \"sp_transaction\": \"trans_cd235d7f-90d7-4fc6-892f-bfde3158d959\",\n \"sp_reference\": \"896741\",\n \"created_at\": \"2023-06-05T14:36:44Z\",\n \"updated_at\": \"2023-06-05T14:36:44Z\"\n }\n ],\n \"recipients\": [],\n \"total\": 4350,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-04-21T11:27:33Z\",\n \"updated_at\": \"2023-06-05T14:36:44Z\"\n },\n {\n \"id\": \"link_0db3458e-0d64-48ff-9c2e-5ff639fbb428\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"32385047\",\n \"status\": \"CREATED\",\n \"note\": \"10 Office scanners\",\n \"metadata\": [\n {\n \"id\": \"meta_0efefb36-c849-46af-9159-61c8f34acc69\",\n \"quick_link_id\": \"link_0db3458e-0d64-48ff-9c2e-5ff639fbb428\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_0db3458e-0d64-48ff-9c2e-5ff639fbb428\",\n \"created_at\": \"2020-04-20T06:12:44Z\",\n \"updated_at\": \"2020-04-20T06:12:44Z\"\n }\n ],\n \"payment\": [],\n \"recipients\": [],\n \"total\": 500000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-04-20T06:12:44Z\",\n \"updated_at\": \"2020-04-20T06:12:44Z\"\n },\n {\n \"id\": \"link_d915f049-10b4-4c17-9095-21983fe95ba5\",\n \"merchant_id\": \"client_071f9c25-c291-4dcf-a21e-79b576ddd0fd\",\n \"number\": \"54599764\",\n \"status\": \"PAID\",\n \"note\": \"Hussain - Maths - 16 hrs a month - April\",\n \"metadata\": [\n {\n \"id\": \"meta_7fc8e59c-4506-40b5-becd-41ee5ede6e4b\",\n \"quick_link_id\": \"link_d915f049-10b4-4c17-9095-21983fe95ba5\",\n \"recipient_view_url\": \"https://sandbox.api.getsafepay.com/io/quick-link?ql=link_d915f049-10b4-4c17-9095-21983fe95ba5\",\n \"created_at\": \"2020-04-10T12:25:57Z\",\n \"updated_at\": \"2023-06-05T14:38:31Z\"\n }\n ],\n \"payment\": [\n {\n \"id\": \"pay_72eb753b-43f5-4c00-9930-ed25b416038a\",\n \"quick_link_id\": \"link_d915f049-10b4-4c17-9095-21983fe95ba5\",\n \"sp_tracker\": \"track_9da25ad4-7f5d-4622-bbb7-87e4bbbaee6a\",\n \"sp_transaction\": \"trans_d2fbd336-2e4b-4961-8c62-4ed3885c03f1\",\n \"sp_reference\": \"551894\",\n \"created_at\": \"2023-06-05T14:38:31Z\",\n \"updated_at\": \"2023-06-05T14:38:31Z\"\n }\n ],\n \"recipients\": [],\n \"total\": 20000,\n \"currency\": \"PKR\",\n \"workflow\": \"MANUAL\",\n \"created_at\": \"2020-04-10T12:25:57Z\",\n \"updated_at\": \"2023-06-05T14:38:31Z\"\n }\n ]\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"265f411c-3a31-4ad6-99ec-c46966b1681c","name":"200 (no results)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/invoice/quick-links/v1/?page=1&limit=10&workflow=MANUAL","host":["https://sandbox.api.getsafepay.com"],"path":["invoice","quick-links","v1",""],"query":[{"key":"page","value":"1","description":"The page to search for. Page serves as an offset counter starting with 1"},{"key":"limit","value":"10","description":"How many results to return per page. A limit of 10 will return 10 Quick Links per page"},{"key":"workflow","value":"MANUAL","description":"One of EMAIL or MANUAL"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Sep 2023 12:38:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80dc0b7ec9fcc904-KHI"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"count\": 0,\n \"list\": []\n },\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}"},{"id":"d30b6f9f-d369-4196-bbac-ab3d7a1e4c60","name":"401","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/invoice/quick-links/v1/?page=1&limit=10&workflow=MANUAL","host":["https://sandbox.api.getsafepay.com"],"path":["invoice","quick-links","v1",""],"query":[{"key":"page","value":"1","description":"The page to search for. Page serves as an offset counter starting with 1"},{"key":"limit","value":"10","description":"How many results to return per page. A limit of 10 will return 10 Quick Links per page"},{"key":"workflow","value":"MANUAL","description":"One of EMAIL or MANUAL"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Sep 2023 12:53:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"70"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80dc21216fef0048-KHI"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"JWT is expired\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"2ff667ed-9ef6-47f7-bd38-1ccebb6148dd","name":"417","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/invoice/quick-links/v1/?page=1&limit=10000&workflow=MANUAL","host":["https://sandbox.api.getsafepay.com"],"path":["invoice","quick-links","v1",""],"query":[{"key":"page","value":"1","description":"The page to search for. Page serves as an offset counter starting with 1"},{"key":"limit","value":"10000","description":"How many results to return per page. A limit of 10 will return 10 Quick Links per page"},{"key":"workflow","value":"MANUAL","description":"One of EMAIL or MANUAL"}]}},"status":"Expectation Failed","code":417,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Sep 2023 12:54:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"87"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, OPTIONS, PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"80dc22327af30048-KHI"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"-: must be no greater than 100.\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"53525c4c-175c-4e33-93bd-121a23a35c6c"},{"name":"Delete Quick Link","id":"086eb2e0-4302-45a0-a250-3c26c215045a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://sandbox.api.getsafepay.com/invoice/quick-links/v1/link_297bfa4b-f61c-4c72-80a4-368d731e890c","description":"Delete a Quick Link corresponding to the ID passed in the URL. This endpoint will delete a Quick Link if one is found against this ID.
\n\n\nThis endpoint only supports JWT based authentication
\n
A successful request will generate the following response
\n{\n \"data\": \"success\",\n \"status\": {\n \"errors\": [],\n \"message\": \"success\"\n }\n}\n\nQuick Links are unique payment links that can be generated and managed using these APIs. Quick Links provide a very easy, no-code way of requesting payment from customers or clients when you either need to request payment for a custom order, you dont have an ecommerce store or you're either a freelancer or service provider.
\nEach Quick Link comes with a unique URL that can be shared with your recipient through any medium. They can get open the URL and make the payment using their preferred payment method.
\nA Quick Link is valid for one-time payments meaning if a Quick Link has been marked as paid, a new one will have to be generated for new payment requests.
\n","_postman_id":"dc893b84-0ec3-425e-a969-a6446eb5a6b2"},{"name":"Safepay Shoppers","item":[{"name":"CRUD","item":[{"name":"Create Safepay Shopper","id":"30aef3a5-4067-419a-b223-90bfe803af41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n\t\"email\": \"hzaidi2@getsafepay.com\",\n\t\"phone\": \"+923331111111\",\n\t\"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/v2/","description":"Register a new Safepay shopper.
\n","urlObject":{"path":["user","v2",""],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"e12d2101-c371-49a3-b797-a17fc4defeca","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n\t\"email\": \"hzaidi2@getsafepay.com\",\n\t\"phone\": \"+923331111111\",\n\t\"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 08:32:37 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab3ffc23b19d1d8-MCT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"contacts\": [\n {\n \"token\": \"con_fff0d983-8d8a-47a0-8481-741576145891\",\n \"user\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"email\": \"hzaidi2@getsafepay.com\",\n \"phone\": \"+923331111111\",\n \"is_default\": true,\n \"created_at\": {\n \"seconds\": 1722328356,\n \"nanos\": 295749212\n },\n \"updated_at\": {\n \"seconds\": 1722328356,\n \"nanos\": 295749932\n }\n }\n ],\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"email\": \"hzaidi2@getsafepay.com\",\n \"phone\": \"+92 333 1111111\",\n \"avatar\": \"\",\n \"suspended\": 0,\n \"suspend_reason\": \"\",\n \"verified\": 0,\n \"verification\": {\n \"user_id\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"code\": \"660167\",\n \"verification_type\": 0,\n \"expires_at\": \"2024-07-31T08:32:36.972032026Z\",\n \"created_at\": \"2024-07-30T08:32:36.97203248Z\",\n \"updated_at\": \"2024-07-30T08:32:36.972032401Z\"\n },\n \"created_at\": \"2024-07-30T08:32:36.295747356Z\",\n \"updated_at\": \"2024-07-30T08:32:36.295747248Z\"\n }\n}"},{"id":"15b46d1e-7fbc-47eb-9aac-42fd19a7ac7d","name":"409","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n\t\"email\": \"hzaidi@getsafepay.com\",\n\t\"phone\": \"+923001234567\",\n\t\"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.api.getsafepay.com/user/v2/"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 08:31:59 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"131"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab3fed5ef34d1d8-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error.resource_conflict\",\n \"message\": \"User with this email already exists. Please log in or use another email to sign up.\"\n}"}],"_postman_id":"30aef3a5-4067-419a-b223-90bfe803af41"},{"name":"Find Safepay Shopper","id":"37bdd5c9-8098-4577-b81b-995bcca90cd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Fetch a Safepay shopper's details.
\n","urlObject":{"path":["user","v2",""],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"8985d966-aeb1-4dd7-8244-bc1f3211f123","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/user/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 09:22:45 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab4493afc67d1f4-MCT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"contacts\": [\n {\n \"token\": \"con_fff0d983-8d8a-47a0-8481-741576145891\",\n \"user\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"email\": \"hzaidi2@getsafepay.com\",\n \"phone\": \"+923331111111\",\n \"is_default\": true,\n \"created_at\": {\n \"seconds\": 1722328356\n },\n \"updated_at\": {\n \"seconds\": 1722328356\n }\n }\n ],\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"email\": \"hzaidi2@getsafepay.com\",\n \"phone\": \"+92 333 1111111\",\n \"avatar\": \"\",\n \"suspended\": 0,\n \"suspend_reason\": \"\",\n \"verified\": 0,\n \"verification\": {\n \"user_id\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"code\": \"660167\",\n \"verification_type\": 0,\n \"expires_at\": \"2024-07-31T08:32:37Z\",\n \"created_at\": \"2024-07-30T08:32:37Z\",\n \"updated_at\": \"2024-07-30T08:32:37Z\"\n },\n \"created_at\": \"2024-07-30T08:32:36Z\",\n \"updated_at\": \"2024-07-30T08:32:36Z\"\n }\n}"},{"id":"2d7a6080-e3b5-4b3c-921d-571a2cc42168","name":"401","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/user/v2/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 09:17:09 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"70"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab44106ae4dd1f4-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error.unauthorized_access\",\n \"message\": \"signature is invalid\"\n}"}],"_postman_id":"37bdd5c9-8098-4577-b81b-995bcca90cd9"},{"name":"Safepay Shopper Exists","id":"f52bc43e-fea8-4286-8863-1a39a39dd7bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Check if a Safepay shopper exists using their email.
\n","urlObject":{"path":["user","v2","exists"],"host":["https://sandbox.api.getsafepay.com"],"query":[{"key":"email","value":"hzaidi@getsafepay.com"}],"variable":[]}},"response":[{"id":"5d87496a-46b6-4ffc-9833-4602c457fe9b","name":"200 - Exists","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/user/v2/exists?email=hzaidi@getsafepay.com","host":["https://sandbox.api.getsafepay.com"],"path":["user","v2","exists"],"query":[{"key":"email","value":"hzaidi@getsafepay.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 20 Aug 2024 07:33:43 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b60b2631942b744-BRU"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"exists\": true,\n \"is_local\": true,\n \"has_password\": true,\n \"phone\": \"+92**********31\",\n \"email\": \"hzaidi@getsafepay.com\"\n }\n}"},{"id":"20062f88-6db3-4893-b13b-4d652d604599","name":"200 - Does not exist","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/user/v2/exists?email=hzaidi@getsafepay.co","host":["https://sandbox.api.getsafepay.com"],"path":["user","v2","exists"],"query":[{"key":"email","value":"hzaidi@getsafepay.co"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 20 Aug 2024 07:34:33 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b60b39d7ffeb744-BRU"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"exists\": false,\n \"is_local\": false,\n \"has_password\": false,\n \"phone\": \"\",\n \"email\": \"\"\n }\n}"},{"id":"4b453516-e05b-4093-854c-6383bb7e74f0","name":"400","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.api.getsafepay.com/user/v2/exists","host":["https://sandbox.api.getsafepay.com"],"path":["user","v2","exists"],"query":[{"key":"email","value":"hzaidi@getsafepay.co","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 20 Aug 2024 07:35:01 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b60b44bcb05b744-BRU"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"error.bad_request\",\n \"message\": \"Email: cannot be blank.\"\n}"}],"_postman_id":"f52bc43e-fea8-4286-8863-1a39a39dd7bc"}],"id":"d2d2927b-a398-4c4d-8b30-2013efb8fcd5","description":"Manage Safepay shoppers.
\n","_postman_id":"d2d2927b-a398-4c4d-8b30-2013efb8fcd5"},{"name":"Payment methods","item":[{"name":"List Payment Methods","id":"cc14b7e6-5b6e-4a2d-be39-1a1aab322fa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"List all payment methods belonging to a Safepay shopper.
\n","urlObject":{"path":["user","wallets","v1",""],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"abe65e8b-6d1b-46bc-afad-905e50e62179","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/user/wallets/v1/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 09:41:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab4653e286dde53-MCT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"token\": \"inst_8ed5e401-ab7b-442c-8473-dee137827448\",\n \"user\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"payment_method_token\": \"tms_80e9bb17-e1ec-4886-b234-509c6673d141\",\n \"deduplication_key\": \"$2a$10$wqRoSlQVB8IRs.H3mDYNiOPdM8aGAWvtOVSvFsl.WP0C1aNhCdet.\",\n \"intent\": \"cybersource\",\n \"last_4\": \"1111\",\n \"instrument_type\": \"Visa\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2025\",\n \"contact\": {\n \"token\": \"con_e2b4affe-ea6c-4cc7-a8ca-10750e8b89ee\",\n \"user\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"first_name\": \"Hassan\",\n \"last_name\": \"Zaidi\",\n \"email\": \"hzaidi2@getsafepay.com\",\n \"phone\": \"+92 333 1111111\",\n \"is_default\": false,\n \"created_at\": {\n \"seconds\": 1722332448\n },\n \"updated_at\": {\n \"seconds\": 1722332448\n }\n },\n \"address\": {\n \"token\": \"address_99a2fa32-71ca-4820-a69e-f7f6e396eb0d\",\n \"owner\": \"user_d75110e4-f52e-464d-96bd-490f75e7fc71\",\n \"street1\": \"St 1, Housing Society\",\n \"city\": \"Islamabad\",\n \"country\": \"PK\",\n \"is_default\": false,\n \"created_at\": {\n \"seconds\": 1722332448\n },\n \"updated_at\": {\n \"seconds\": 1722332448\n }\n },\n \"cybersource\": {\n \"token\": \"tms_80e9bb17-e1ec-4886-b234-509c6673d141\",\n \"payment_method\": \"inst_8ed5e401-ab7b-442c-8473-dee137827448\",\n \"scheme\": 1,\n \"bin\": \"411111\",\n \"last_four\": \"1111\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2025\",\n \"created_at\": {\n \"seconds\": 1722332448\n },\n \"updated_at\": {\n \"seconds\": 1722332448\n }\n },\n \"created_at\": \"2024-07-30T09:40:48Z\",\n \"updated_at\": \"2024-07-30T09:40:48Z\"\n }\n ]\n}"},{"id":"9577e9d3-750b-4993-9bfe-d3f2518c119b","name":"401","originalRequest":{"method":"GET","header":[],"url":"https://sandbox.api.getsafepay.com/user/wallets/v1/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 09:42:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"174"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab465a9e90bde53-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/jwt_user: token is malformed, strategies/jwt_user_v2: token is malformed]\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"cc14b7e6-5b6e-4a2d-be39-1a1aab322fa3"},{"name":"Delete Payment Method","id":"c9d62fa5-23ce-41aa-9e42-59ed4ae9c19a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Delete a saved payment method.
\n","urlObject":{"path":["user","wallets","v1","inst_8ed5e401-ab7b-442c-8473-dee137827448"],"host":["https://sandbox.api.getsafepay.com"],"query":[],"variable":[]}},"response":[{"id":"c5df4383-21b0-4f2d-9fb2-b8f3eae6fb56","name":"200","originalRequest":{"method":"DELETE","header":[],"url":"https://sandbox.api.getsafepay.com/user/wallets/v1/inst_8ed5e401-ab7b-442c-8473-dee137827448"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 10:29:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"19"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab4aaa6dd74d1dc-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"success\"\n}"},{"id":"6e19500a-65a4-4eab-bbc7-4709f6ae5571","name":"401","originalRequest":{"method":"DELETE","header":[],"url":"https://sandbox.api.getsafepay.com/user/wallets/v1/inst_8ed5e401-ab7b-442c-8473-dee13782744"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 10:28:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"174"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab4aa22fe40d1dc-MCT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"unauthorized\",\n \"strategies/union: [strategies/jwt_user: token is malformed, strategies/jwt_user_v2: token is malformed]\"\n ],\n \"message\": \"fail\"\n }\n}"},{"id":"dd0ffc5e-78c0-404a-877e-374d55d17494","name":"404","originalRequest":{"method":"DELETE","header":[],"url":"https://sandbox.api.getsafepay.com/user/wallets/v1/inst_8ed5e401-ab7b-442c-8473-dee137827447"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 10:28:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8ab4a9ca1d20d1dc-MCT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"status\": {\n \"errors\": [\n \"Resource with this identifier not found\"\n ],\n \"message\": \"fail\"\n }\n}"}],"_postman_id":"c9d62fa5-23ce-41aa-9e42-59ed4ae9c19a"}],"id":"d2e32307-e389-4497-a635-6c3c9b514653","description":"Manage payment methods belonging to Safepay shoppers. To create payment methods, a Safepay shopper must go through a checkout session and consent to saving their payment method details for future use.
\n","_postman_id":"d2e32307-e389-4497-a635-6c3c9b514653"}],"id":"f5e64e2f-f4f4-4e33-8e05-78eae4292eef","description":"Create and manage users linked to the Safepay network. The user object encapsulates the contact details of a Safepay shopper. Like Customers, users also have saved payment methods associated with them which employ tokenization to allow performing payments in a convenient way.
All customer related endpoints (other than registration) must be authenticated with user authentication.
\n\n\n","_postman_id":"f5e64e2f-f4f4-4e33-8e05-78eae4292eef"}],"event":[{"listen":"prerequest","script":{"id":"8601c4bb-9e10-4dea-9116-a9748aca38d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e0e4d9f0-fff5-4ef5-9518-fedf11a38f50","type":"text/javascript","exec":[""]}}],"variable":[{"key":"jwtToken","value":"","type":"string"},{"key":"apiKey","value":"15670709dbd82556e286cc6640ebc31716b1a53b1463361d626e63ca741c16dc","type":"string"},{"key":"development-base-url","value":"","type":"default"}]}Note that these APIs are currently reserved for internal use until a secure mechanism is introduced for facilitating the creation of user passwords. If you wish to make use of these APIs, reach out to us on integrations@getsafepay.com.
\n