{ "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "// Set response object as internal variable", "let jsonData = {};", "try {", " jsonData = pm.response.json();", "} catch (e) {}", "", "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id", "if (jsonData?.payment_id) {", " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);", " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);", "}", "", "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));", "" ], "type": "text/javascript" } } ], "item": [ { "name": "Health check", "item": [ { "name": "New Request", "event": [ { "listen": "test", "script": { "exec": [ "// Validate status 2xx", "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {", " pm.response.to.be.success;", "});", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/health", "host": [ "{{baseUrl}}" ], "path": [ "health" ] } }, "response": [] } ] }, { "name": "Flow Testcases", "item": [ { "name": "QuickStart", "item": [ { "name": "Merchant Account - Create", "event": [ { "listen": "test", "script": { "exec": [ "// Validate status 2xx", "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {", " pm.response.to.be.success;", "});", "", "// Validate if response header has matching content-type", "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {", " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(", " \"application/json\",", " );", "});", "", "// Set response object as internal variable", "let jsonData = {};", "try {", " jsonData = pm.response.json();", "} catch (e) {}", "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id", "if (jsonData?.merchant_id) {", " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);", " console.log(", " \"- use {{merchant_id}} as collection variable for value\",", " jsonData.merchant_id,", " );", "} else {", " console.log(", " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",", " );", "}", "", "// pm.collectionVariables - Set api_key as variable for jsonData.api_key", "if (jsonData?.api_key) {", " pm.collectionVariables.set(\"api_key\", jsonData.api_key);", " console.log(", " \"- use {{api_key}} as collection variable for value\",", " jsonData.api_key,", " );", "} else {", " console.log(", " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",", " );", "}", "", "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key", "if (jsonData?.publishable_key) {", " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);", " console.log(", " \"- use {{publishable_key}} as collection variable for value\",", " jsonData.publishable_key,", " );", "} else {", " console.log(", " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",", " );", "}", "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{admin_api_key}}", "type": "string" }, { "key": "key", "value": "api-key", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}],\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"JohnTest@test.com\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"JohnTest2@test.com\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}" }, "url": { "raw": "{{baseUrl}}/accounts", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ] }, "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments." }, "response": [] }, { "name": "API Key - Create", "event": [ { "listen": "test", "script": { "exec": [ "// Validate status 2xx", "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {", " pm.response.to.be.success;", "});", "", "// Validate if response header has matching content-type", "pm.test(", " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",", " function () {", " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(", " \"application/json\",", " );", " },", ");", "", "// Set response object as internal variable", "let jsonData = {};", "try {", " jsonData = pm.response.json();", "} catch (e) {}", "", "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id", "if (jsonData?.key_id) {", " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);", " console.log(", " \"- use {{api_key_id}} as collection variable for value\",", " jsonData.key_id,", " );", "} else {", " console.log(", " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",", " );", "}", "", "// pm.collectionVariables - Set api_key as variable for jsonData.api_key", "if (jsonData?.api_key) {", " pm.collectionVariables.set(\"api_key\", jsonData.api_key);", " console.log(", " \"- use {{api_key}} as collection variable for value\",", " jsonData.api_key,", " );", "} else {", " console.log(", " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",", " );", "}", "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{admin_api_key}}", "type": "string" }, { "key": "key", "value": "api-key", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}" }, "url": { "raw": "{{baseUrl}}/api_keys/:merchant_id", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":merchant_id" ], "variable": [ { "key": "merchant_id", "value": "{{merchant_id}}" } ] } }, "response": [] }, { "name": "Payment Connector - Create", "event": [ { "listen": "test", "script": { "exec": [ "// Validate status 2xx", "pm.test(", " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",", " function () {", " pm.response.to.be.success;", " },", ");", "", "// Validate if response header has matching content-type", "pm.test(", " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",", " function () {", " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(", " \"application/json\",", " );", " },", ");", "", "// Set response object as internal variable", "let jsonData = {};", "try {", " jsonData = pm.response.json();", "} catch (e) {}", "", "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id", "if (jsonData?.merchant_connector_id) {", " pm.collectionVariables.set(", " \"merchant_connector_id\",", " jsonData.merchant_connector_id,", " );", " console.log(", " \"- use {{merchant_connector_id}} as collection variable for value\",", " jsonData.merchant_connector_id,", " );", "} else {", " console.log(", " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",", " );", "}", "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{api_key}}", "type": "string" }, { "key": "key", "value": "api-key", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\"connector_type\":\"payment_processor\",\"connector_name\":\"zsl\",\"connector_account_details\":{\"auth_type\":\"BodyKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"payment_methods_enabled\":[{\"payment_method\":\"bank_transfer\",\"payment_method_types\":[{\"payment_method_type\":\"local_bank_transfer\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":-1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}" }, "url": { "raw": "{{baseUrl}}/account/:account_id/connectors", "host": [ "{{baseUrl}}" ], "path": [ "account", ":account_id", "connectors" ], "variable": [ { "key": "account_id", "value": "{{merchant_id}}", "description": "(Required) The unique identifier for the merchant account" } ] }, "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc." }, "response": [] }, { "name": "Payments - Create", "event": [ { "listen": "test", "script": { "exec": [ "// Validate status 2xx", "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {", " pm.response.to.be.success;", "});", "", "// Validate if response header has matching content-type", "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {", " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(", " \"application/json\",", " );", "});", "", "// Validate if response has JSON Body", "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {", " pm.response.to.have.jsonBody();", "});", "", "// Set response object as internal variable", "let jsonData = {};", "try {", " jsonData = pm.response.json();", "} catch (e) {}", "", "", "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id", "if (jsonData?.payment_id) {", " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);", " console.log(", " \"- use {{payment_id}} as collection variable for value\",", " jsonData.payment_id,", " );", "} else {", " console.log(", " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",", " );", "}", "", "// Response body should have redirect_to_url as next action type", "if (jsonData?.next_action.type) {", " pm.test(", " \"[POST]::/payments:id/confirm - Next Action Check\",", " function () {", " pm.expect(jsonData.next_action.type).to.eql(\"redirect_to_url\");", " },", " );", "}", "", "// Response body should have status = requires_customer_action", "if (jsonData?.status) {", " pm.test(", " \"[POST]::/payments:id/confirm - Next Action Check\",", " function () {", " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");", " },", " );", "}", "", "", "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\"amount\":6540,\"amount_to_capture\":6540,\"authentication_type\":\"three_ds\",\"billing\":{\"address\":{\"city\":\"San Fransico\",\"country\":\"CN\",\"first_name\":\"PiX\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"state\":\"California\",\"zip\":\"94122\"}},\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"confirm\":true,\"currency\":\"CNY\",\"customer_id\":\"StripeCustomer\",\"description\":\"Its my first payment request\",\"email\":\"guest@example.com\",\"metadata\":{\"login_date\":\"2019-09-10T10:11:12Z\",\"new_customer\":\"true\",\"udf1\":\"value1\"},\"name\":\"John Doe\",\"payment_method\":\"bank_transfer\",\"payment_method_type\":\"local_bank_transfer\",\"payment_method_data\":{\"bank_transfer\":{\"local_bank_transfer\":{}}},\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"return_url\":\"https://duck.com\",\"shipping\":{\"address\":{\"city\":\"San Fransico\",\"country\":\"US\",\"first_name\":\"PiX\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"state\":\"California\",\"zip\":\"94122\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"browser_info\":{\"language\":\"en-EN\"}}" }, "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] }, "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture" }, "response": [] } ] }, { "name": "Happy Cases", "item": [ { "name": "Scenario1-Create payment with confirm true", "item": [ { "name": "Payments - Create", "event": [ { "listen": "test", "script": { "exec": [ "// Validate status 2xx", "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {", " pm.response.to.be.success;", "});", "", "// Validate if response header has matching content-type", "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {", " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(", " \"application/json\",", " );", "});", "", "// Validate if response has JSON Body", "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {", " pm.response.to.have.jsonBody();", "});", "", "// Set response object as internal variable", "let jsonData = {};", "try {", " jsonData = pm.response.json();", "} catch (e) {}", "", "", "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id", "if (jsonData?.payment_id) {", " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);", " console.log(", " \"- use {{payment_id}} as collection variable for value\",", " jsonData.payment_id,", " );", "} else {", " console.log(", " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",", " );", "}", "", "// Response body should have redirect_to_url as next action type", "if (jsonData?.next_action.type) {", " pm.test(", " \"[POST]::/payments:id/confirm - Next Action Check\",", " function () {", " pm.expect(jsonData.next_action.type).to.eql(\"redirect_to_url\");", " },", " );", "}", "", "// Response body should have status = requires_customer_action", "if (jsonData?.status) {", " pm.test(", " \"[POST]::/payments:id/confirm - Next Action Check\",", " function () {", " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");", " },", " );", "}", "", "", "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\"amount\":6540,\"amount_to_capture\":6540,\"authentication_type\":\"three_ds\",\"billing\":{\"address\":{\"city\":\"San Fransico\",\"country\":\"CN\",\"first_name\":\"PiX\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"state\":\"California\",\"zip\":\"94122\"}},\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"confirm\":true,\"currency\":\"CNY\",\"customer_id\":\"StripeCustomer\",\"description\":\"Its my first payment request\",\"email\":\"guest@example.com\",\"metadata\":{\"login_date\":\"2019-09-10T10:11:12Z\",\"new_customer\":\"true\",\"udf1\":\"value1\"},\"name\":\"John Doe\",\"payment_method\":\"bank_transfer\",\"payment_method_type\":\"local_bank_transfer\",\"payment_method_data\":{\"bank_transfer\":{\"local_bank_transfer\":{}}},\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"return_url\":\"https://duck.com\",\"shipping\":{\"address\":{\"city\":\"San Fransico\",\"country\":\"US\",\"first_name\":\"PiX\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"state\":\"California\",\"zip\":\"94122\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"browser_info\":{\"language\":\"en-EN\"}}" }, "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] }, "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture" }, "response": [] } ] } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{api_key}}", "type": "string" }, { "key": "key", "value": "api-key", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "info": { "_postman_id": "3a6c03f2-c084-4e35-a559-4dc0f2808fe9", "name": "zsl", "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [support@juspay.in](mailto:support@juspay.in)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "27028646" }, "variable": [ { "key": "baseUrl", "value": "", "type": "string" }, { "key": "admin_api_key", "value": "", "type": "string" }, { "key": "api_key", "value": "", "type": "string" }, { "key": "merchant_id", "value": "" }, { "key": "payment_id", "value": "" }, { "key": "customer_id", "value": "" }, { "key": "mandate_id", "value": "" }, { "key": "payment_method_id", "value": "" }, { "key": "refund_id", "value": "" }, { "key": "merchant_connector_id", "value": "" }, { "key": "client_secret", "value": "", "type": "string" }, { "key": "connector_api_key", "value": "", "type": "string" }, { "key": "publishable_key", "value": "", "type": "string" }, { "key": "api_key_id", "value": "", "type": "string" }, { "key": "payment_token", "value": "" }, { "key": "gateway_merchant_id", "value": "", "type": "string", "disabled": true }, { "key": "certificate", "value": "", "type": "string", "disabled": true }, { "key": "certificate_keys", "value": "", "type": "string", "disabled": true }, { "key": "connector_key1", "value": "", "type": "string" } ] }