{ "openapi": "3.1.0", "info": { "title": "Orchestration", "version": "1" }, "servers": [ { "url": "https://api.paytring.com" } ], "components": { "securitySchemes": { "sec0": { "type": "http", "scheme": "basic" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/v1/order/create": { "post": { "summary": "Authentication", "description": "", "operationId": "authentication", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"url\": \"aHR0cHM6Ly91YXQubWNzYW0uaW4vcGVnYXN1cy9hc0b2tlbi80ODg2NDUxNjAxODQzMTYwMTE=\",\n \"order_id\": \"48864xxxxxxxxxx\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "url": { "type": "string", "example": "aHR0cHM6Ly91YXQubWNzYW0uaW4vcGVnYXN1cy9hc0b2tlbi80ODg2NDUxNjAxODQzMTYwMTE=" }, "order_id": { "type": "string", "example": "48864xxxxxxxxxx" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false } }, "/api/v2/order/create": { "post": { "summary": "Create Order", "description": "This API is used to initiate a payment request for a specific order.", "operationId": "create-order", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "amount", "cname", "phone", "receipt_id", "callback_url", "hash", "email" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section", "default": "test_123" }, "amount": { "type": "integer", "description": "Amount will always be in paisa/cents.", "default": 100, "format": "int32" }, "cname": { "type": "string", "description": "End User/Payes Name", "default": "Jhon Doe" }, "phone": { "type": "string", "description": "End Users Phone", "default": "9897969594" }, "receipt_id": { "type": "string", "description": "a random string a sting provided by merchant for reference.", "default": "xx00011" }, "callback_url": { "type": "string", "description": "callback url of merchant website on which will we redirect to , once payment is done.", "default": "https://httpbin.org/post" }, "hash": { "type": "string", "description": "to be calculated by key sort of all non-object key values of this request" }, "email": { "type": "string", "description": "End User Email" }, "currency": { "type": "string", "description": "Please Get Currency Active by our team", "default": "INR" }, "billing_address": { "type": "object", "properties": { "line1": { "type": "string", "description": "does not accept any special charecter" }, "line2": { "type": "string", "description": "does not accept any special charecter" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipcode": { "type": "integer", "format": "int32" }, "country": { "type": "string" }, "phone": { "type": "string" }, "firstname": { "type": "string", "description": "min 3 chars" }, "lastname": { "type": "string", "description": "min 3 chars" } } }, "shipping_address": { "type": "object", "properties": { "line1": { "type": "string", "description": "does not accept any special charecter" }, "line2": { "type": "string", "description": "does not accept any special charecter" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipcode": { "type": "integer", "format": "int32" }, "country": { "type": "string" }, "phone": { "type": "string" }, "firstname": { "type": "string", "description": "min 3 chars" }, "lastname": { "type": "string", "description": "min 3 chars" } } }, "notes": { "type": "object", "description": "These fields can be used for reporting", "properties": { "udf1": { "type": "string", "description": "max length 255, no special chars" }, "udf2": { "type": "string", "description": "max length 255, no special chars" }, "udf3": { "type": "string", "description": "max length 255, no special chars" }, "udf4": { "type": "string", "description": "max length 255, no special chars" }, "udf5": { "type": "string", "description": "max length 255, no special chars" } } }, "pg": { "type": "string", "description": "if you pass a pg code then only that payment gateway will be used to process this transection. eg, payu" }, "pg_pool_id": { "type": "string", "description": "this can be grabbed from pg integration manager available in your dashboard.." }, "tpv": { "type": "array", "description": "add tpv info", "items": { "properties": { "account_number": { "type": "string", "description": "account number of end user" }, "name": { "type": "string", "description": "name of end user" }, "ifsc": { "type": "string", "description": "end users bank account ifsc code." } }, "type": "object" } }, "split_settlement": { "type": "array", "items": { "properties": { "vendor_id": { "type": "string", "description": "can be created via api or paytring dashboard" }, "amount": { "type": "string", "description": "amount in paise or cents in case of fixed and percent in case of percent" } }, "required": [ "vendor_id", "amount" ], "type": "object" } }, "split_type": { "type": "string", "default": "percent", "enum": [ "\"percent\"", "\"fixed\"" ] }, "autocapture": { "type": "string", "description": "if merchant wan't they can disable autocapture by sending false in request", "default": "true" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"url\": \"aHR0cHM6Ly91YXQubWNzYW0uaW4vcGVnYXN1cy9hc0b2tlbi80ODg2NDUxNjAxODQzMTYwMTE=\",\n \"order_id\": \"48864xxxxxxxxxx\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "url": { "type": "string", "example": "aHR0cHM6Ly91YXQubWNzYW0uaW4vcGVnYXN1cy9hc0b2tlbi80ODg2NDUxNjAxODQzMTYwMTE=" }, "order_id": { "type": "string", "example": "48864xxxxxxxxxx" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false } }, "/api/v2/order/fetch": { "post": { "summary": "Fetch by Order ID", "description": "This API allows you to retrieve details of a previously created order.", "operationId": "fetch-order", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant Key", "default": "test_123" }, "id": { "type": "string", "description": "pass order id of partying in this param." }, "hash": { "type": "string", "description": "hash is calculated as provided in doc." } } } } } }, "responses": { "200": { "description": "200", "content": { "text/plain": { "examples": { "Result": { "value": "{\"status\":true,\"order\":{\"order_id\":\"1111111111111111\",\"receipt_id\":\"MGI2222222222222333\",\"pg_transaction_id\":\"222222222222\",\"amount\":118,\"currency\":\"INR\",\"pg\":\"Paytm\",\"method\":\"UPI\",\"order_status\":\"success\",\"unmapped_status\":\"TXN_SUCCESS\",\"card_last_4\":\"6005\",\"card_issuer\":\"amex\",\"customer\":{\"name\":\"Jhon Doe\",\"email\":\"Jhon@doe.com\",\"phone\":\"917732887777\"},\"notes\":{\"udf1\":\"Sync with #122\",\"udf2\":\"\",\"udf3\":\"\",\"udf4\":\"\",\"udf5\":\"\",\"udf6\":\"\",\"udf8\":\"\",\"udf9\":\"\",\"udf10\":\"\"},\"billing_address\":{\"firstname\":\"Jhon\",\"lastname\":\"LastName\",\"phone\":\"917732887777\",\"line1\":\"Gurugram\",\"line2\":\"Gurugram\",\"city\":\"Gurgaon\",\"state\":\"Haryana\",\"country\":\"IN\",\"zipcode\":\"122005\"},\"shipping_address\":{\"firstname\":\"Jhon\",\"lastname\":\"LastName\",\"phone\":\"917732887777\",\"line1\":\"Gurugram\",\"line2\":\"Gurugram\",\"city\":\"Gurgaon\",\"state\":\"Haryana\",\"country\":\"IN\",\"zipcode\":\"122005\"},\"additional_charges\":0,\"mdr\":\"\",\"tpv\":[],\"created_at\":\"2024-04-05 12:19:24\",\"updated_at\":\"2024-04-05 12:23:24\"}}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "order": { "type": "object", "properties": { "order_id": { "type": "string", "example": "1111111111111111" }, "receipt_id": { "type": "string", "example": "MGI2222222222222333" }, "pg_transaction_id": { "type": "string", "example": "222222222222" }, "amount": { "type": "integer", "example": 118, "default": 0 }, "currency": { "type": "string", "example": "INR" }, "pg": { "type": "string", "example": "Paytm" }, "method": { "type": "string", "example": "UPI" }, "order_status": { "type": "string", "example": "success" }, "unmapped_status": { "type": "string", "example": "TXN_SUCCESS" }, "customer": { "type": "object", "properties": { "name": { "type": "string", "example": "Jhon Doe" }, "email": { "type": "string", "example": "Jhon@doe.com" }, "phone": { "type": "string", "example": "917732887777" } } }, "notes": { "type": "object", "properties": { "udf1": { "type": "string", "example": "Sync with #122" }, "udf2": { "type": "string", "example": "" }, "udf3": { "type": "string", "example": "" }, "udf4": { "type": "string", "example": "" }, "udf5": { "type": "string", "example": "" }, "udf6": { "type": "string", "example": "" }, "udf8": { "type": "string", "example": "" }, "udf9": { "type": "string", "example": "" }, "udf10": { "type": "string", "example": "" } } }, "billing_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "Jhon" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "917732887777" }, "line1": { "type": "string", "example": "Gurugram" }, "line2": { "type": "string", "example": "Gurugram" }, "city": { "type": "string", "example": "Gurgaon" }, "state": { "type": "string", "example": "Haryana" }, "country": { "type": "string", "example": "IN" }, "zipcode": { "type": "string", "example": "122005" } } }, "shipping_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "Jhon" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "917732887777" }, "line1": { "type": "string", "example": "Gurugram" }, "line2": { "type": "string", "example": "Gurugram" }, "city": { "type": "string", "example": "Gurgaon" }, "state": { "type": "string", "example": "Haryana" }, "country": { "type": "string", "example": "IN" }, "zipcode": { "type": "string", "example": "122005" } } }, "additional_charges": { "type": "integer", "example": 0, "default": 0 }, "mdr": { "type": "string", "example": "" }, "tpv": { "type": "array" }, "created_at": { "type": "string", "example": "2024-04-05 12:19:24" }, "updated_at": { "type": "string", "example": "2024-04-05 12:23:24" }, "card_last_4": { "type": "string", "example": "6005" }, "card_issuer": { "type": "string", "example": "amex" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \t\"code\": 202,\n \"message\":\"error message\"\n }\n}\n\n\n\n\n\n\n\n\n\n" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "code": { "type": "integer", "example": 202, "default": 0 }, "message": { "type": "string", "example": "error message" } } } } } } } } }, "deprecated": false } }, "/api/v2/order/refund": { "post": { "summary": "Refund Order", "description": "This API can trigger refund for any order of any pg.", "operationId": "refund-order", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant api key, provided in paytring dashbord" }, "id": { "type": "string", "description": "Order id provided by paytring." }, "hash": { "type": "string", "description": "to be calculated by hash logic.", "default": "null" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Refund has been initiated\",\n \"id\": \"xxxxxx-xxxx\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Refund has been initiated" }, "id": { "type": "string", "example": "xxxxxx-xxxx" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"error message here\",\n \"code\": 204\n }\n}\n" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "error message here" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false } }, "/api/v1/subscription/plan/create": { "post": { "summary": "Create Plan", "description": "", "operationId": "create-plan", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "description", "amount", "frequency", "key", "mer_reference_id", "hash", "cycle" ], "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "amount": { "type": "string" }, "currency": { "type": "string" }, "frequency": { "type": "integer", "description": "no of days", "format": "int32" }, "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "mer_reference_id": { "type": "string" }, "hash": { "type": "string", "description": "to be calculated by key sort of all non-object key values of this request" }, "notes": { "type": "object", "properties": { "udf1": { "type": "string", "description": "max length 255, no special chars" }, "udf2": { "type": "string", "description": "max length 255, no special chars" }, "udf3": { "type": "string", "description": "max length 255, no special chars" }, "udf4": { "type": "string", "description": "max length 255, no special chars" }, "udf5": { "type": "string", "description": "max length 255, no special chars" } } }, "cycle": { "type": "integer", "description": "how many times will we deduct this money.", "default": 12, "format": "int32" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [] } }, "/api/v1/subscription/plan/fetch": { "post": { "summary": "Fetch Plan", "description": "", "operationId": "fetch-plan", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "id": { "type": "string", "description": "Plan id provided by paytring." }, "hash": { "type": "string", "description": "to be calculated by key sort of all non-object key values of this request" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false, "security": [] } }, "/api/v1/subscription/create": { "post": { "summary": "Create Subscriptions", "description": "", "operationId": "create-subscriptions", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "callback_url", "cname", "email", "phone", "plan_id", "mer_reference_id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "pg": { "type": "string", "description": "code for payment gateway, which you want to use" }, "pg_pool_id": { "type": "string", "description": "pool is from which you want to choose pg" }, "callback_url": { "type": "string" }, "cname": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "initial_amount": { "type": "string" }, "plan_id": { "type": "string" }, "mer_reference_id": { "type": "string" }, "hash": { "type": "string", "description": "to be calculated by key sort of all non-object key values of this request" }, "notes": { "type": "object", "properties": { "udf1": { "type": "string", "description": "max length 255, no special chars" }, "udf2": { "type": "string", "description": "max length 255, no special chars" }, "udf3": { "type": "string", "description": "max length 255, no special chars" }, "udf4": { "type": "string", "description": "max length 255, no special chars" }, "udf5": { "type": "string", "description": "max length 255, no special chars" } } }, "billing_address": { "type": "object", "properties": { "line1": { "type": "string", "description": "does not accept any special charecter" }, "line2": { "type": "string", "description": "does not accept any special charecter" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipcode": { "type": "integer", "format": "int32" }, "country": { "type": "string" }, "phone": { "type": "string" }, "firstname": { "type": "string", "description": "min 3 chars" }, "lastname": { "type": "string", "description": "min 3 chars" } } }, "shipping_address": { "type": "object", "properties": { "line1": { "type": "string", "description": "does not accept any special charecter" }, "line2": { "type": "string", "description": "does not accept any special charecter" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipcode": { "type": "integer", "format": "int32" }, "country": { "type": "string" }, "phone": { "type": "string" }, "firstname": { "type": "string", "description": "min 3 chars" }, "lastname": { "type": "string", "description": "min 3 chars" } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false, "security": [] } }, "/api/v1/subscription/subscription/fetch": { "post": { "summary": "Fetch Subscription", "description": "", "operationId": "fetch-subscription", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "id": { "type": "string", "description": "Subscription id provided by paytring." }, "hash": { "type": "string", "description": "to be calculated by key sort of all non-object key values of this request" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"subscription\": {\n \"subscription_id\": \"677361288237548476\",\n \"mer_reference_id\": \"TXN934579\",\n \"amount\": 500,\n \"initial_amount\": null,\n \"currency\": \"USD\",\n \"subscription_status\": \"active\",\n \"pg\": \"Transactbridge\",\n \"customer\": {\n \"name\": \"Preetam Sharma\",\n \"email\": \"preetam@paytring.com\",\n \"phone\": \"7027445661\"\n },\n \"notes\": {\n \"udf1\": \"\",\n \"udf2\": \"\",\n \"udf3\": \"\",\n \"udf4\": \"\",\n \"udf5\": \"\",\n \"udf6\": \"\",\n \"udf8\": \"\",\n \"udf9\": \"\",\n \"udf10\": \"\"\n },\n \"billing_address\": {\n \"firstname\": \"FirstName\",\n \"lastname\": \"LastName\",\n \"phone\": \"9999999999\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zipcode\": \"\"\n },\n \"shipping_address\": {\n \"firstname\": \"FirstName\",\n \"lastname\": \"LastName\",\n \"phone\": \"9999999999\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zipcode\": \"\"\n }\n },\n \"request_id\": \"66ebdb6678097\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "subscription": { "type": "object", "properties": { "subscription_id": { "type": "string", "example": "677361288237548476" }, "mer_reference_id": { "type": "string", "example": "TXN934579" }, "amount": { "type": "integer", "example": 500, "default": 0 }, "initial_amount": {}, "currency": { "type": "string", "example": "USD" }, "subscription_status": { "type": "string", "example": "active" }, "pg": { "type": "string", "example": "Transactbridge" }, "customer": { "type": "object", "properties": { "name": { "type": "string", "example": "Preetam Sharma" }, "email": { "type": "string", "example": "preetam@paytring.com" }, "phone": { "type": "string", "example": "7027445661" } } }, "notes": { "type": "object", "properties": { "udf1": { "type": "string", "example": "" }, "udf2": { "type": "string", "example": "" }, "udf3": { "type": "string", "example": "" }, "udf4": { "type": "string", "example": "" }, "udf5": { "type": "string", "example": "" }, "udf6": { "type": "string", "example": "" }, "udf8": { "type": "string", "example": "" }, "udf9": { "type": "string", "example": "" }, "udf10": { "type": "string", "example": "" } } }, "billing_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "FirstName" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "9999999999" }, "line1": { "type": "string", "example": "" }, "line2": { "type": "string", "example": "" }, "city": { "type": "string", "example": "" }, "state": { "type": "string", "example": "" }, "country": { "type": "string", "example": "" }, "zipcode": { "type": "string", "example": "" } } }, "shipping_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "FirstName" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "9999999999" }, "line1": { "type": "string", "example": "" }, "line2": { "type": "string", "example": "" }, "city": { "type": "string", "example": "" }, "state": { "type": "string", "example": "" }, "country": { "type": "string", "example": "" }, "zipcode": { "type": "string", "example": "" } } } } }, "request_id": { "type": "string", "example": "66ebdb6678097" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false, "security": [] } }, "/api/v1/currency/get": { "post": { "summary": "Currency Conversion", "description": "", "operationId": "currency-conversion", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "hash", "from", "to" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "hash": { "type": "string", "description": "to be calculated by key sort of all non-object key values of this request" }, "from": { "type": "string", "description": "base currency you want conversion to happen from" }, "to": { "type": "string", "description": "final currency you want conversion to happen to" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false, "security": [] } }, "/api/v2/order/fetch/receipt": { "post": { "summary": "Fetch by Receipt ID", "description": "This API allows you to retrieve details of a previously created order.", "operationId": "fetch-order-by-receipt-id", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant Key", "default": "test_123" }, "id": { "type": "string", "description": "pass receipt id of merchant passed in create order parameters." }, "hash": { "type": "string", "description": "hash is calculated as provided in doc." } } } } } }, "responses": { "200": { "description": "200", "content": { "text/plain": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"order\": {\n \"order_id\": \"1111111111111111\",\n \"receipt_id\": \"MGI2222222222222333\",\n \"pg_transaction_id\": \"222222222222\",\n \"amount\": 118,\n \"currency\": \"INR\",\n \"pg\": \"Paytm\",\n \"method\": \"UPI\",\n \"order_status\": \"success\",\n \"unmapped_status\": \"TXN_SUCCESS\",\n \"customer\": {\n \"name\": \"Jhon Doe\",\n \"email\": \"Jhon@doe.com\",\n \"phone\": \"917732887777\"\n },\n \"notes\": {\n \"udf1\": \"Sync with #122\",\n \"udf2\": \"\",\n \"udf3\": \"\",\n \"udf4\": \"\",\n \"udf5\": \"\",\n \"udf6\": \"\",\n \"udf8\": \"\",\n \"udf9\": \"\",\n \"udf10\": \"\"\n },\n \"billing_address\": {\n \"firstname\": \"Jhon\",\n \"lastname\": \"LastName\",\n \"phone\": \"917732887777\",\n \"line1\": \"Gurugram\",\n \"line2\": \"Gurugram\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"country\": \"IN\",\n \"zipcode\": \"122005\"\n },\n \"shipping_address\": {\n \"firstname\": \"Jhon\",\n \"lastname\": \"LastName\",\n \"phone\": \"917732887777\",\n \"line1\": \"Gurugram\",\n \"line2\": \"Gurugram\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"country\": \"IN\",\n \"zipcode\": \"122005\"\n },\n \"additional_charges\": 0,\n \"mdr\": \"\",\n \"tpv\": [],\n \"created_at\": \"2024-04-05 12:19:24\",\n \"updated_at\": \"2024-04-05 12:23:24\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "order": { "type": "object", "properties": { "order_id": { "type": "string", "example": "1111111111111111" }, "receipt_id": { "type": "string", "example": "MGI2222222222222333" }, "pg_transaction_id": { "type": "string", "example": "222222222222" }, "amount": { "type": "integer", "example": 118, "default": 0 }, "currency": { "type": "string", "example": "INR" }, "pg": { "type": "string", "example": "Paytm" }, "method": { "type": "string", "example": "UPI" }, "order_status": { "type": "string", "example": "success" }, "unmapped_status": { "type": "string", "example": "TXN_SUCCESS" }, "customer": { "type": "object", "properties": { "name": { "type": "string", "example": "Jhon Doe" }, "email": { "type": "string", "example": "Jhon@doe.com" }, "phone": { "type": "string", "example": "917732887777" } } }, "notes": { "type": "object", "properties": { "udf1": { "type": "string", "example": "Sync with #122" }, "udf2": { "type": "string", "example": "" }, "udf3": { "type": "string", "example": "" }, "udf4": { "type": "string", "example": "" }, "udf5": { "type": "string", "example": "" }, "udf6": { "type": "string", "example": "" }, "udf8": { "type": "string", "example": "" }, "udf9": { "type": "string", "example": "" }, "udf10": { "type": "string", "example": "" } } }, "billing_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "Jhon" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "917732887777" }, "line1": { "type": "string", "example": "Gurugram" }, "line2": { "type": "string", "example": "Gurugram" }, "city": { "type": "string", "example": "Gurgaon" }, "state": { "type": "string", "example": "Haryana" }, "country": { "type": "string", "example": "IN" }, "zipcode": { "type": "string", "example": "122005" } } }, "shipping_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "Jhon" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "917732887777" }, "line1": { "type": "string", "example": "Gurugram" }, "line2": { "type": "string", "example": "Gurugram" }, "city": { "type": "string", "example": "Gurgaon" }, "state": { "type": "string", "example": "Haryana" }, "country": { "type": "string", "example": "IN" }, "zipcode": { "type": "string", "example": "122005" } } }, "additional_charges": { "type": "integer", "example": 0, "default": 0 }, "mdr": { "type": "string", "example": "" }, "tpv": { "type": "array" }, "created_at": { "type": "string", "example": "2024-04-05 12:19:24" }, "updated_at": { "type": "string", "example": "2024-04-05 12:23:24" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \t\"code\": 202,\n \"message\":\"error message\"\n }\n}\n\n\n\n\n\n\n\n\n\n" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "code": { "type": "integer", "example": 202, "default": 0 }, "message": { "type": "string", "example": "error message" } } } } } } } } }, "deprecated": false } }, "/api/v1/order/process": { "post": { "summary": "Process Order", "description": "This api can be used to process transaction without opening paytring checkout , also known as seamless api or custom checkout api", "operationId": "process-order", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "method", "code", "hash" ], "properties": { "key": { "type": "string", "description": "merchant api key, provided by paytring." }, "order_id": { "type": "string", "description": "order id received in response from paytring in create order api" }, "method": { "type": "string", "description": "eg. upi, nb, card, wallet, emi", "default": "upi" }, "code": { "type": "string", "description": "this parameter's value changes depending on what method it is, in case of upi you have three options collect, qr, intent .In case of nb bank code will be passed as value, incase of wallet , wallet app code will be passed. in case of card value will be card", "default": "collect" }, "vpa": { "type": "string", "description": "only required if method is upi and code is collect", "default": "example@upi" }, "card": { "type": "object", "description": "only required if method is card", "required": [ "number", "cvv", "expiry_month", "expiry_year", "holder_name" ], "properties": { "number": { "type": "string", "description": "16 to 18 digits" }, "cvv": { "type": "string", "description": "3 to 4 digits" }, "expiry_month": { "type": "string", "description": "1 to 12 range number" }, "expiry_year": { "type": "string", "description": "current or year grater then current." }, "holder_name": { "type": "string", "description": "name on card ( no special char max length 255 )" } } }, "hash": { "type": "string", "description": "to be calculated for this request" }, "device": { "type": "string", "description": "mandatory if method is upi and code is intent, eg. android, ios", "default": "android" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "UPI Intent": { "value": "{\n \"status\": true,\n \"payment_id\": \"667589021207104214\",\n \"data\": {\n \"type\": \"intent\",\n \"token\": \"66c837ca1d1a3\",\n \"url\": \"dXBpOi8vcGF5P3BhPWV4YW1wbGVAbnBjaSZwbj1UZXN0JnRyPUUyNDA2MDQ3NVhVNjRUJm1jPTgyMjAmYW09MS4wMCZjdT1JTlImdG49UGF5Jm1hbT0xLjAwJnJlZlVybD1odHRwczovL3BheS5lYXNlYnV6ei5pbg==\",\n \"param\": []\n },\n \"request_id\": \"66c837c9baf4c\"\n}" }, "UPI QR": { "value": "{\n \"status\": true,\n \"payment_id\": \"667589442466221560\",\n \"data\": {\n \"type\": \"qr\",\n \"token\": \"66c8382e65814\",\n \"url\": \"aHR0cHM6Ly9hcGkucXJzZXJ2ZXIuY29tL3YxL2NyZWF0ZS1xci1jb2RlLz9zaXplPTMwMHgzMDAmZGF0YT11cGk6Ly9wYXk/cGE9ZXhhbXBsZUBucGNpJnBuPVRlc3QmdHI9RTI0MDYwNDc1WFU2NFQmbWM9ODIyMCZhbT0xLjAwJmN1PUlOUiZ0bj1QYXkmbWFtPTEuMDAmcmVmVXJsPWh0dHBzOi8vcGF5LmVhc2VidXp6Lmlu\",\n \"param\": []\n },\n \"request_id\": \"66c8382e36db9\"\n}" }, "Card On Screen OTP": { "value": "{\n \"status\": true,\n \"payment_id\": \"638322528174997931\",\n \"data\": {\n \"type\": \"otp\",\n \"token\": \"665dbf4407239\",\n \"url\": \"aHR0cDovL2xvY2FsaG9zdDo4MDAwL2FwaS92MC9vcmRlci9zdWJtaXRPdHA=\",\n \"param\": \"srbElfodVAPxKZZP2RbSRsxmb99hhOx1YyMCe6DOo4g+Z3QrBAn1dVPNY+J5RA6DuKtrEKZmsZmw5UBJ684k2mCfTJs4n9EumJqo4zUuzEXu94pI4teAzAk3pa+pZSk9HL4wjEpLjtRUbL95MbcK13UcNItLYo7hd3uafYMmB2dZzZ8DdCm7RvgY/8taN4j9YZzJZsiLM4KxhrcwUQusWPPAQLBcWWqU/x7lTdFmRdUy5ZpZ7hVU6E5OLH9y5K0h4CI2bCJoJtC6Qm5WTLOHUbQ0eKgUCLn8bpHPGZz7tqzyA6VAy3ysMeLpncgTF8FictHj/+YczlneWdRskbJ64Q==\",\n \"resend_url\": \"aHR0cDovL2xvY2FsaG9zdDo4MDAwL2FwaS92MC9vcmRlci9yZXNlbmRPdHA=\",\n \"resend_param\": \"srbElfodVAPxKZZP2RbSRsxmb99hhOx1YyMCe6DOo4g+Z3QrBAn1dVPNY+J5RA6DuKtrEKZmsZmw5UBJ684k2mCfTJs4n9EumJqo4zUuzEXu94pI4teAzAk3pa+pZSk9HL4wjEpLjtRUbL95MbcK16E6JiXtHZKBePiJC8c4eYfEcU+5h8gX2b299Wn1GLXU4CI2bCJoJtC6Qm5WTLOHUbQ0eKgUCLn8bpHPGZz7tqzyA6VAy3ysMeLpncgTF8FictHj/+YczlneWdRskbJ64Q==\"\n },\n \"request_id\": \"665dbf3e0f276\"\n}" }, "NB, Card, Wallets Redirect": { "value": "{\n \"status\": true,\n \"payment_id\": \"638305819879804138\",\n \"no_referrer\": false,\n \"data\": {\n \"type\": \"redirect\",\n \"token\": \"665da4a523bbf\",\n \"url\": \"aHR0cDovL2xvY2FsaG9zdDo4MDAwL2FwaS92MC9vcmRlci9yZWRpcmVjdFRvQmFuaw==\",\n \"param\": \"srbElfodVAPxKZZP2RbSRvnMzoMr4ZxoXPHUzE7qqr80v9wRBsrg+56oeSStyTudKwPte1rhrmi3IR571JrQeZF6rx2YeuYa4mFTttVBH+kWMjkvqOfsjTdO0nqDWVjhGV0ValvMbd6/XDFFVIgHjkmbJt+kCAg6afwVOKjTlx2uBV3XXcvQCd+Yo6IdyjwvovzXYeWt2MAEPcq+MJ/csw1jZs+VHvMx2PD0QujxpU3/9dLLQF45DZ86cT6mEbN1sfgvM9j2PdLsMD35AeGeObM+OZY/HeeIWKbgXYpVwc5IuwKUV+aXcTApiTF0eBY+IlcnwXCBWSe9DZ9kbScmXlmj5WXYvKOkF3dklmBqUuhIuwKUV+aXcTApiTF0eBY+2YE8Uo35Q4E1/liaz4paDQjLhrLqBi4I22ebL8/CoqwXFgAh2FKP3cBfchwZtzwwDhkbnTDqMV7JJuyhcdHBKMBKf0FrHetVFL4rImV5EQviANE3SoofqyHMk2Ei3+DAhw17kJ1e5XB2+AdRRNmGfTkeMJX2DKh6VvIJ62kIaDnYIPlrAi3qh+IpKXChfrtawgSewthJEnUwwC5aJuHbuwBZVTQ9Jb7eVNjYQNB8WcIDvVlUKY8gIToONLhgVcNRut9VAHvi2HXJeu5sVzBdPBTx+H4cXxPLX2eV1p5wOe93Nc6Mh7WZurDUUYJKlysdoZL7wMo9Kpzn0uj7mKwMnpU0Gt52DhJew6JJtJ5gqgsL0AVnnQclo76Gts8WaNo19G1P5fMmC5Nw1KNeZrl3Jx9UFjW4fJK1D/vRwSsDwLDY8TQhAwDzFNCJhZQcXDfGqTNZABXfA/OKgyFCLxzEuiua5vOiBHCYVVplbP/Q2J3f8VH3WZYWuIYBNP5Id7QJI2emyB8pmkIWIyiIGXNRNxvV2OCrlr7wOTk42OQqBJgosVmLUehiiKaqTvWKPBFAr33Hlqb2O3bMsAx8airDsOYurrcRI1Adh4/cNrvdUCGpj5iMN0te9j1KP9x+UPV5z3qXX2iFSAZu09L8X30XRn8VTbWMxghYpdMK/eCXJG3xBv1QYVXevxX6EQLsnCuU5DW6ojqsYHB/UC18/hssZb0hjkc8SVOS3aTHxTG5tjLndHOFnfedhNjng26r9cF50Ir6Y6aR19VK39tr6aPWjN0BetJQXp+gzleFf6KDhFFa5rq+cLYKSvaT0DaoYuoMTRNlo6iIxFfIenO5nDIwMXeVBFZSLpMsTUmIV/SixiA=\"\n },\n \"request_id\": \"665dafae78a94\"\n}" }, "Validation Error": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Invalid Data\",\n \"code\": 103\n },\n \"validation\": {\n \"hash\": [\n \"The hash field is required.\"\n ]\n },\n \"request_id\": \"66c838e79bb52\"\n}" }, "Error": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n },\n \"request_id\": \"66c8391f9fd31\"\n}" } }, "schema": { "oneOf": [ { "title": "UPI Intent", "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "payment_id": { "type": "string", "example": "667589021207104214" }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "intent" }, "token": { "type": "string", "example": "66c837ca1d1a3" }, "url": { "type": "string", "example": "dXBpOi8vcGF5P3BhPWV4YW1wbGVAbnBjaSZwbj1UZXN0JnRyPUUyNDA2MDQ3NVhVNjRUJm1jPTgyMjAmYW09MS4wMCZjdT1JTlImdG49UGF5Jm1hbT0xLjAwJnJlZlVybD1odHRwczovL3BheS5lYXNlYnV6ei5pbg==" }, "param": { "type": "array" } } }, "request_id": { "type": "string", "example": "66c837c9baf4c" } } }, { "title": "UPI QR", "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "payment_id": { "type": "string", "example": "667589442466221560" }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "qr" }, "token": { "type": "string", "example": "66c8382e65814" }, "url": { "type": "string", "example": "aHR0cHM6Ly9hcGkucXJzZXJ2ZXIuY29tL3YxL2NyZWF0ZS1xci1jb2RlLz9zaXplPTMwMHgzMDAmZGF0YT11cGk6Ly9wYXk/cGE9ZXhhbXBsZUBucGNpJnBuPVRlc3QmdHI9RTI0MDYwNDc1WFU2NFQmbWM9ODIyMCZhbT0xLjAwJmN1PUlOUiZ0bj1QYXkmbWFtPTEuMDAmcmVmVXJsPWh0dHBzOi8vcGF5LmVhc2VidXp6Lmlu" }, "param": { "type": "array" } } }, "request_id": { "type": "string", "example": "66c8382e36db9" } } }, { "title": "Card On Screen OTP", "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "payment_id": { "type": "string", "example": "638322528174997931" }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "otp" }, "token": { "type": "string", "example": "665dbf4407239" }, "url": { "type": "string", "example": "aHR0cDovL2xvY2FsaG9zdDo4MDAwL2FwaS92MC9vcmRlci9zdWJtaXRPdHA=" }, "param": { "type": "string", "example": "srbElfodVAPxKZZP2RbSRsxmb99hhOx1YyMCe6DOo4g+Z3QrBAn1dVPNY+J5RA6DuKtrEKZmsZmw5UBJ684k2mCfTJs4n9EumJqo4zUuzEXu94pI4teAzAk3pa+pZSk9HL4wjEpLjtRUbL95MbcK13UcNItLYo7hd3uafYMmB2dZzZ8DdCm7RvgY/8taN4j9YZzJZsiLM4KxhrcwUQusWPPAQLBcWWqU/x7lTdFmRdUy5ZpZ7hVU6E5OLH9y5K0h4CI2bCJoJtC6Qm5WTLOHUbQ0eKgUCLn8bpHPGZz7tqzyA6VAy3ysMeLpncgTF8FictHj/+YczlneWdRskbJ64Q==" }, "resend_url": { "type": "string", "example": "aHR0cDovL2xvY2FsaG9zdDo4MDAwL2FwaS92MC9vcmRlci9yZXNlbmRPdHA=" }, "resend_param": { "type": "string", "example": "srbElfodVAPxKZZP2RbSRsxmb99hhOx1YyMCe6DOo4g+Z3QrBAn1dVPNY+J5RA6DuKtrEKZmsZmw5UBJ684k2mCfTJs4n9EumJqo4zUuzEXu94pI4teAzAk3pa+pZSk9HL4wjEpLjtRUbL95MbcK16E6JiXtHZKBePiJC8c4eYfEcU+5h8gX2b299Wn1GLXU4CI2bCJoJtC6Qm5WTLOHUbQ0eKgUCLn8bpHPGZz7tqzyA6VAy3ysMeLpncgTF8FictHj/+YczlneWdRskbJ64Q==" } } }, "request_id": { "type": "string", "example": "665dbf3e0f276" } } }, { "title": "NB, Card, Wallets Redirect", "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "payment_id": { "type": "string", "example": "638305819879804138" }, "no_referrer": { "type": "boolean", "example": false, "default": true }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "redirect" }, "token": { "type": "string", "example": "665da4a523bbf" }, "url": { "type": "string", "example": "aHR0cDovL2xvY2FsaG9zdDo4MDAwL2FwaS92MC9vcmRlci9yZWRpcmVjdFRvQmFuaw==" }, "param": { "type": "string", "example": "srbElfodVAPxKZZP2RbSRvnMzoMr4ZxoXPHUzE7qqr80v9wRBsrg+56oeSStyTudKwPte1rhrmi3IR571JrQeZF6rx2YeuYa4mFTttVBH+kWMjkvqOfsjTdO0nqDWVjhGV0ValvMbd6/XDFFVIgHjkmbJt+kCAg6afwVOKjTlx2uBV3XXcvQCd+Yo6IdyjwvovzXYeWt2MAEPcq+MJ/csw1jZs+VHvMx2PD0QujxpU3/9dLLQF45DZ86cT6mEbN1sfgvM9j2PdLsMD35AeGeObM+OZY/HeeIWKbgXYpVwc5IuwKUV+aXcTApiTF0eBY+IlcnwXCBWSe9DZ9kbScmXlmj5WXYvKOkF3dklmBqUuhIuwKUV+aXcTApiTF0eBY+2YE8Uo35Q4E1/liaz4paDQjLhrLqBi4I22ebL8/CoqwXFgAh2FKP3cBfchwZtzwwDhkbnTDqMV7JJuyhcdHBKMBKf0FrHetVFL4rImV5EQviANE3SoofqyHMk2Ei3+DAhw17kJ1e5XB2+AdRRNmGfTkeMJX2DKh6VvIJ62kIaDnYIPlrAi3qh+IpKXChfrtawgSewthJEnUwwC5aJuHbuwBZVTQ9Jb7eVNjYQNB8WcIDvVlUKY8gIToONLhgVcNRut9VAHvi2HXJeu5sVzBdPBTx+H4cXxPLX2eV1p5wOe93Nc6Mh7WZurDUUYJKlysdoZL7wMo9Kpzn0uj7mKwMnpU0Gt52DhJew6JJtJ5gqgsL0AVnnQclo76Gts8WaNo19G1P5fMmC5Nw1KNeZrl3Jx9UFjW4fJK1D/vRwSsDwLDY8TQhAwDzFNCJhZQcXDfGqTNZABXfA/OKgyFCLxzEuiua5vOiBHCYVVplbP/Q2J3f8VH3WZYWuIYBNP5Id7QJI2emyB8pmkIWIyiIGXNRNxvV2OCrlr7wOTk42OQqBJgosVmLUehiiKaqTvWKPBFAr33Hlqb2O3bMsAx8airDsOYurrcRI1Adh4/cNrvdUCGpj5iMN0te9j1KP9x+UPV5z3qXX2iFSAZu09L8X30XRn8VTbWMxghYpdMK/eCXJG3xBv1QYVXevxX6EQLsnCuU5DW6ojqsYHB/UC18/hssZb0hjkc8SVOS3aTHxTG5tjLndHOFnfedhNjng26r9cF50Ir6Y6aR19VK39tr6aPWjN0BetJQXp+gzleFf6KDhFFa5rq+cLYKSvaT0DaoYuoMTRNlo6iIxFfIenO5nDIwMXeVBFZSLpMsTUmIV/SixiA=" } } }, "request_id": { "type": "string", "example": "665dafae78a94" } } }, { "title": "Validation Error", "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Invalid Data" }, "code": { "type": "integer", "example": 103, "default": 0 } } }, "validation": { "type": "object", "properties": { "hash": { "type": "array", "items": { "type": "string", "example": "The hash field is required." } } } }, "request_id": { "type": "string", "example": "66c838e79bb52" } } }, { "title": "Error", "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } }, "request_id": { "type": "string", "example": "66c8391f9fd31" } } } ] } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"exception\": {\n \"identifier\": \"known\",\n \"message\": \"Invalid Data\",\n \"log_id\": \"63b3d80490503\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "exception": { "type": "object", "properties": { "identifier": { "type": "string", "example": "known" }, "message": { "type": "string", "example": "Invalid Data" }, "log_id": { "type": "string", "example": "63b3d80490503" } } } } } } } } }, "deprecated": false, "security": [] } }, "/api/v2/payout/create": { "post": { "summary": "Create Payout", "description": "Send money to accounts or via imps , rtgs or upi transfer", "operationId": "create-payout", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "pg", "method", "account_number", "beneficiary_id", "receipt_id", "amount", "pg_pool_id" ], "properties": { "pg": { "type": "string", "description": "eg. decentro" }, "method": { "type": "string", "description": "eg. upi or imps" }, "account_number": { "type": "string", "description": "account no of to be debited from" }, "beneficiary_id": { "type": "string", "description": "beneficiary id to be added" }, "receipt_id": { "type": "string" }, "amount": { "type": "string", "description": "Amount will always be in paisa/cents." }, "pg_pool_id": { "type": "string", "description": "Payment Gateway pool id" }, "notes": { "type": "object", "properties": { "udf1": { "type": "string", "description": "max length 255, no special chars" }, "udf2": { "type": "string", "description": "max length 255, no special chars" }, "udf3": { "type": "string", "description": "max length 255, no special chars" }, "udf4": { "type": "string", "description": "max length 255, no special chars" }, "udf5": { "type": "string", "description": "max length 255, no special chars" } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"payment_status\": \"success\",\n \"message\": \"Amount transfered successfully\",\n \"transfer_id\": \"XXXXXXXXXXXXX\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "payment_status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Amount transfered successfully" }, "transfer_id": { "type": "string", "example": "XXXXXXXXXXXXX" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash not verified.\",\n \"code\": 158\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash not verified." }, "code": { "type": "integer", "example": 158, "default": 0 } } } } } } } } }, "deprecated": false } }, "/api/v2/settlement/fetch": { "post": { "summary": "Fetch by Date", "description": "", "operationId": "fetch-settlement-by-date", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "date", "pg" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "date": { "type": "string", "description": "the date you want to fetch settlements for", "format": "date" }, "pg": { "type": "string", "description": "if you want to fetch details of a particular pg. only, please pass it's pg code" }, "offset": { "type": "string", "description": "It specifies the starting point from which to return results" }, "limit": { "type": "string", "description": "It specifies the maximum number of records to return in a response" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"data\": [\n {\n \"order_id\": null,\n \"pg_transaction_id\": \"xxxx83793xxxxxxxxx\",\n \"order_date\": \"2xxx-0x-xx 2x:0x:xx\",\n \"utr\": \"xxxx4791xxxxxx\",\n \"settlement_date\": \"2xxx-0x-xx 00:xx:00\",\n \"order_status\": \"success\",\n \"pg_status\": \"Shipped\",\n \"payment_mode\": \"UPI\",\n \"amount\": 1xxxxxx,\n \"mer_service_fee\": 0,\n \"mer_service_tax\": 0,\n \"merchant_subvention_amount\": \"0.00\",\n \"cgst\": \"0.00\",\n \"igst\": \"0.00\",\n \"sgst\": \"0.00\",\n \"settled_amount\": 1xxxxx,\n \"dispute_id\": null,\n \"description\": null\n },\n ],\n \"is_last_page\": false, // If it is the last page, it will return true.\n \"request_id\": \"67bf1xxxxxxx4\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v1/info/vpa": { "post": { "summary": "Validate VPA", "description": "This api is for merchants integrating order process api and want to check if customer provided vpa is valid or not.", "operationId": "validate-vpa", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "vpa", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "vpa": { "type": "string", "description": "vpa you want to be validated." }, "hash": { "type": "string", "description": "to be calculated for this request" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true, \n \"isVPAValid\": true, \n \"payerAccountName\": \"User Name\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [] } }, "/api/v1/info/bin": { "post": { "summary": "Validate Card", "description": "This api is for merchants integrating order process api and want to check if customer provided vpa is valid or not.", "operationId": "validate-card", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "bin", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "bin": { "type": "string", "description": "card bin you want to be validated.( first 6 digits of card number )" }, "hash": { "type": "string", "description": "to be calculated for this request" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [] } }, "/vendor/create": { "post": { "summary": "Create Vendor", "description": "The API provides a means for merchants or administrators to add new vendors to the system with essential details.", "operationId": "create-vendor", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "vendor_id", "name", "email" ], "properties": { "vendor_id": { "type": "string", "description": "provided by merchant" }, "name": { "type": "string", "description": "Vendor Name, this field will not accept any special char other then space", "default": "Vendor Name" }, "email": { "type": "string", "description": "a valid email address" }, "phone": { "type": "string" }, "upi_id": { "type": "string", "description": "vpa of merchant, if provided will be used as a default option" }, "bank_details": { "type": "object", "required": [ "account_no", "ifsc_code" ], "properties": { "account_no": { "type": "string", "description": "bank account number" }, "ifsc_code": { "type": "string", "description": "Bank IFSC code" } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"message\": \"Vendor added successfully\",\n \"vendor_id\": \"unique_vendor_id\",\n \"id\": \"unique_vendor_platform_id\"\n}\n" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Vendor added successfully" }, "vendor_id": { "type": "string", "example": "unique_vendor_id" }, "id": { "type": "string", "example": "unique_vendor_platform_id" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v2/payout/fetch": { "post": { "summary": "Fetch Payout Status", "description": "Check status of a payout created via paytring", "operationId": "fetch-payout", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Payout ID received in response on create payout API.", "default": "58833954xxxxxxx" }, "fetch_type": { "type": "string", "description": "This option allow user to do a hard pull of info directly from PG when required.", "default": "normal", "enum": [ "normal", "advance" ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"payout\": {\n \"transfer_status\": boolean,\n \"error\": string,\n \"transfer_id\": string,\n \"ut_no\": null,\n \"amount\": 111,\n \"fund_source\": \"Cashfree\",\n \"method\": \"neft\",\n \"processed_at\": \"2020-12-16 09:17:42\",\n \"transfer_status\": \"failed\",\n \"beneficiary\": {\n \"name\": \"Preetam\",\n \"email\": \"preetam@mcsam.in\",\n \"phone\": \"7027445661\",\n \"vpa\": \"7027445661@paytm\",\n \"account\": {\n \"account_no\": \"917027445660\",\n \"ifsc\": \"PYTM0123456\"\n }\n },\n \"ack\": \"\"\n }\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t \"status\": true,\n \"error_code\": int,\n \"error_message\": string\n}" } } } } } }, "deprecated": false } }, "/api/v2/payout/balance": { "post": { "summary": "Check Accounts Balance", "description": "This APi get you your account balance of each pg., or a specific one.", "operationId": "check-payout-accounts-balance", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pg": { "type": "string", "description": "if not provided response will he data of all PG accounts added to paytring.", "default": "decentro" }, "account_number": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": " {\n \"status\":\"true\",\n \"account\":[\n \"decentro\":[\n \"account_no\" : \"917027445661\"\n \"balance\" : \"99cr\"\n ]\n ]\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v2/payout/accounts": { "post": { "summary": "Fetch All Accounts", "description": "", "operationId": "fetch-accounts", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pg": { "type": "string", "description": "pg of which acounts needs to be fetched" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"accounts\": {\n \"cashfree\": {\n \"status\": false,\n \"error\": {\n \"message\": \"Internal Server Error, Invalid response received from payment gateway.\",\n \"code\": \"INTERNAL_SERVER_ERROR\"\n }\n },\n \"decentro\": {\n \"status\": true,\n \"data\": [\n {\n \"account_number\": \"936551184xxxxxxxxxxxx77\",\n \"ifsc_code\": \"Dxxxxxxx11\",\n \"account_type\": \"VIRTUAL\",\n \"currency\": \"INR\",\n \"available_balance\": 0,\n \"account_balance\": 0,\n \"minimum_balance\": 0,\n \"hold_fund\": null,\n \"overdraft\": null,\n \"transaction_limit\": 1000000\n }\n ]\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "accounts": { "type": "object", "properties": { "cashfree": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Internal Server Error, Invalid response received from payment gateway." }, "code": { "type": "string", "example": "INTERNAL_SERVER_ERROR" } } } } }, "decentro": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "account_number": { "type": "string", "example": "936551184xxxxxxxxxxxx77" }, "ifsc_code": { "type": "string", "example": "Dxxxxxxx11" }, "account_type": { "type": "string", "example": "VIRTUAL" }, "currency": { "type": "string", "example": "INR" }, "available_balance": { "type": "integer", "example": 0, "default": 0 }, "account_balance": { "type": "integer", "example": 0, "default": 0 }, "minimum_balance": { "type": "integer", "example": 0, "default": 0 }, "hold_fund": {}, "overdraft": {}, "transaction_limit": { "type": "integer", "example": 1000000, "default": 0 } } } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false } }, "/api/v2/payout/beneficiary/create": { "post": { "summary": "Add Beneficiary", "description": "", "operationId": "add-beneficiary", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "phone", "email", "address", "account_number", "ifsc", "vpa" ], "properties": { "name": { "type": "string", "description": "Name of Beneficiary", "default": "user" }, "phone": { "type": "string", "description": "Phone no of Beneficiary. eg. 9900990099" }, "email": { "type": "string", "description": "Email of Beneficiary" }, "address": { "type": "string", "description": "Address of Beneficiary", "default": "delhi" }, "account_number": { "type": "string", "description": "Account Number of Beneficiary" }, "ifsc": { "type": "string", "description": "IFS Code of Beneficiary Account" }, "vpa": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Beneficiary Account Added successfully.\",\n \"beneficiary_id\": \"59113xxxxxxxxx6\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Beneficiary Account Added successfully." }, "beneficiary_id": { "type": "string", "example": "59113xxxxxxxxx6" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false } }, "/api/v2/payout/beneficiary/fetch": { "post": { "summary": "Fetch Beneficiary", "description": "", "operationId": "fetch-beneficiary", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "beneficiary_id , you got in response of add beneficiary api", "default": "5000193xxxxxxxxx" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Beneficiary Account Details Fetched successfully.\",\n \"data\": {\n \"beneficiary_id\": 59113xxxxxxxxxxxx06,\n \"name\": \"Anxxxx\",\n \"vpa\": \"4nxxxd@okhdfcbank\",\n \"account_number\": \"91965xxxxxx3\",\n \"ifsc\": \"PYTM0123456\",\n \"phone\": \"965xxxxxx3\",\n \"email\": \"a@mxxx.in\",\n \"address\": \"Gurgaon\"\n }\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v2/order/capture": { "post": { "summary": "Capture Order", "description": "This API allows you to capture the authorized payment of a previously created order.", "operationId": "capture-order", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant Key", "default": "test_123" }, "id": { "type": "string", "description": "pass order id of partying in this param." }, "hash": { "type": "string", "description": "hash is calculated as provided in doc." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Order captured successfully.\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Order captured successfully." } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \t\"code\": 202,\n \"message\":\"error message\"\n }\n}\n\n\n\n\n\n\n\n\n\n" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "code": { "type": "integer", "example": 202, "default": 0 }, "message": { "type": "string", "example": "error message" } } } } } } } } }, "deprecated": false } }, "/api/v1/subscription/subscription/fetch/receipt": { "post": { "summary": "Fetch Subscription By Receipt ID", "description": "", "operationId": "fetch-subscription-by-receipt", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "id": { "type": "string", "description": "Merchant reference subscription id (receipt id)" }, "hash": { "type": "string", "description": "to be calculated by key sort of all non-object key values of this request" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"subscription\": {\n \"subscription_id\": \"677361288237548476\",\n \"mer_reference_id\": \"TXN934579\",\n \"amount\": 500,\n \"initial_amount\": null,\n \"currency\": \"USD\",\n \"subscription_status\": \"active\",\n \"pg\": \"Transactbridge\",\n \"customer\": {\n \"name\": \"Preetam Sharma\",\n \"email\": \"preetam@paytring.com\",\n \"phone\": \"7027445661\"\n },\n \"notes\": {\n \"udf1\": \"\",\n \"udf2\": \"\",\n \"udf3\": \"\",\n \"udf4\": \"\",\n \"udf5\": \"\",\n \"udf6\": \"\",\n \"udf8\": \"\",\n \"udf9\": \"\",\n \"udf10\": \"\"\n },\n \"billing_address\": {\n \"firstname\": \"FirstName\",\n \"lastname\": \"LastName\",\n \"phone\": \"9999999999\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zipcode\": \"\"\n },\n \"shipping_address\": {\n \"firstname\": \"FirstName\",\n \"lastname\": \"LastName\",\n \"phone\": \"9999999999\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zipcode\": \"\"\n }\n },\n \"request_id\": \"66ebdb6678097\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "subscription": { "type": "object", "properties": { "subscription_id": { "type": "string", "example": "677361288237548476" }, "mer_reference_id": { "type": "string", "example": "TXN934579" }, "amount": { "type": "integer", "example": 500, "default": 0 }, "initial_amount": {}, "currency": { "type": "string", "example": "USD" }, "subscription_status": { "type": "string", "example": "active" }, "pg": { "type": "string", "example": "Transactbridge" }, "customer": { "type": "object", "properties": { "name": { "type": "string", "example": "Preetam Sharma" }, "email": { "type": "string", "example": "preetam@paytring.com" }, "phone": { "type": "string", "example": "7027445661" } } }, "notes": { "type": "object", "properties": { "udf1": { "type": "string", "example": "" }, "udf2": { "type": "string", "example": "" }, "udf3": { "type": "string", "example": "" }, "udf4": { "type": "string", "example": "" }, "udf5": { "type": "string", "example": "" }, "udf6": { "type": "string", "example": "" }, "udf8": { "type": "string", "example": "" }, "udf9": { "type": "string", "example": "" }, "udf10": { "type": "string", "example": "" } } }, "billing_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "FirstName" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "9999999999" }, "line1": { "type": "string", "example": "" }, "line2": { "type": "string", "example": "" }, "city": { "type": "string", "example": "" }, "state": { "type": "string", "example": "" }, "country": { "type": "string", "example": "" }, "zipcode": { "type": "string", "example": "" } } }, "shipping_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "FirstName" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "9999999999" }, "line1": { "type": "string", "example": "" }, "line2": { "type": "string", "example": "" }, "city": { "type": "string", "example": "" }, "state": { "type": "string", "example": "" }, "country": { "type": "string", "example": "" }, "zipcode": { "type": "string", "example": "" } } } } }, "request_id": { "type": "string", "example": "66ebdb6678097" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Hash is not verified\",\n \"code\": 204\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Hash is not verified" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false, "security": [] } }, "/api/v1/subscription/cancel": { "post": { "summary": "Cancel Subscription", "description": "", "operationId": "cancel-subscription", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "id": { "type": "string", "description": "Subscription id provided by paytring." }, "hash": { "type": "string", "description": "to be calculated by key sort of all non-object key values of this request" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"subscription\": {\n \"subscription_id\": \"677419479528901910\",\n \"mer_reference_id\": \"TXN9387493\",\n \"amount\": 500,\n \"initial_amount\": null,\n \"currency\": \"USD\",\n \"subscription_status\": \"canceled\",\n \"pg\": \"Transactbridge\",\n \"customer\": {\n \"name\": \"Preetam Sharma\",\n \"email\": \"preetam@paytring.com\",\n \"phone\": \"7027445661\"\n },\n \"notes\": {\n \"udf1\": \"\",\n \"udf2\": \"\",\n \"udf3\": \"\",\n \"udf4\": \"\",\n \"udf5\": \"\",\n \"udf6\": \"\",\n \"udf8\": \"\",\n \"udf9\": \"\",\n \"udf10\": \"\"\n },\n \"billing_address\": {\n \"firstname\": \"FirstName\",\n \"lastname\": \"LastName\",\n \"phone\": \"9999999999\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zipcode\": \"\"\n },\n \"shipping_address\": {\n \"firstname\": \"FirstName\",\n \"lastname\": \"LastName\",\n \"phone\": \"9999999999\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zipcode\": \"\"\n }\n },\n \"request_id\": \"66ec2b68cb6f4\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "subscription": { "type": "object", "properties": { "subscription_id": { "type": "string", "example": "677419479528901910" }, "mer_reference_id": { "type": "string", "example": "TXN9387493" }, "amount": { "type": "integer", "example": 500, "default": 0 }, "initial_amount": {}, "currency": { "type": "string", "example": "USD" }, "subscription_status": { "type": "string", "example": "canceled" }, "pg": { "type": "string", "example": "Transactbridge" }, "customer": { "type": "object", "properties": { "name": { "type": "string", "example": "Preetam Sharma" }, "email": { "type": "string", "example": "preetam@paytring.com" }, "phone": { "type": "string", "example": "7027445661" } } }, "notes": { "type": "object", "properties": { "udf1": { "type": "string", "example": "" }, "udf2": { "type": "string", "example": "" }, "udf3": { "type": "string", "example": "" }, "udf4": { "type": "string", "example": "" }, "udf5": { "type": "string", "example": "" }, "udf6": { "type": "string", "example": "" }, "udf8": { "type": "string", "example": "" }, "udf9": { "type": "string", "example": "" }, "udf10": { "type": "string", "example": "" } } }, "billing_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "FirstName" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "9999999999" }, "line1": { "type": "string", "example": "" }, "line2": { "type": "string", "example": "" }, "city": { "type": "string", "example": "" }, "state": { "type": "string", "example": "" }, "country": { "type": "string", "example": "" }, "zipcode": { "type": "string", "example": "" } } }, "shipping_address": { "type": "object", "properties": { "firstname": { "type": "string", "example": "FirstName" }, "lastname": { "type": "string", "example": "LastName" }, "phone": { "type": "string", "example": "9999999999" }, "line1": { "type": "string", "example": "" }, "line2": { "type": "string", "example": "" }, "city": { "type": "string", "example": "" }, "state": { "type": "string", "example": "" }, "country": { "type": "string", "example": "" }, "zipcode": { "type": "string", "example": "" } } } } }, "request_id": { "type": "string", "example": "66ec2b68cb6f4" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"Subscription already cancelled.\",\n \"code\": 1035\n },\n \"request_id\": \"66ebf29a7f9b5\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Subscription already cancelled." }, "code": { "type": "integer", "example": 1035, "default": 0 } } }, "request_id": { "type": "string", "example": "66ebf29a7f9b5" } } } } } } }, "deprecated": false, "security": [] } }, "/api/v2/order/cancel": { "post": { "summary": "Cancel Order", "description": "This API allows you to cancel the authorized payment of a previously authorized order.", "operationId": "cancel-order", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant Key", "default": "test_123" }, "id": { "type": "string", "description": "pass order id of partying in this param." }, "hash": { "type": "string", "description": "hash is calculated as provided in doc." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Order canceled successfully.\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Order canceled successfully." } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \t\"code\": 202,\n \"message\":\"error message\"\n }\n}\n\n\n\n\n\n\n\n\n\n" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "code": { "type": "integer", "example": 202, "default": 0 }, "message": { "type": "string", "example": "error message" } } } } } } } } }, "deprecated": false } }, "/api/v2/order/refund/partial": { "post": { "summary": "Partial Refund Order", "description": "This API can trigger partial refund for any order of any pg.", "operationId": "partial-refund-order", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "amount", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant api key, provided in paytring dashbord" }, "id": { "type": "string", "description": "Order id provided by paytring." }, "amount": { "type": "integer", "description": "Amount should be in paise/cents and it should be based on order currency", "format": "int32" }, "hash": { "type": "string", "description": "to be calculated by hash logic." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"ORDER_PARTIALLY_REFUNDED_SUCCESSFULLY\",\n \"id\": \"xxxxxxxxxxx\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "ORDER_PARTIALLY_REFUNDED_SUCCESSFULLY" }, "id": { "type": "string", "example": "xxxxxxxxxxx" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"error\": {\n \"message\": \"error message here\",\n \"code\": 204\n }\n}\n" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "error": { "type": "object", "properties": { "message": { "type": "string", "example": "error message here" }, "code": { "type": "integer", "example": 204, "default": 0 } } } } } } } } }, "deprecated": false } }, "/api/v2/subscription/adhoc": { "post": { "summary": "ADHOC Charge", "description": "in case of an SI ( standing Instructions ) this api can be used to charge end users accounts as per merchant needs.", "operationId": "adhoc-charge", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "amount", "currency", "hash" ], "properties": { "key": { "type": "string" }, "id": { "type": "string", "description": "subscription id" }, "amount": { "type": "string", "description": "in cents / paisa" }, "currency": { "type": "string", "description": "3 char currency code , insure it as subscription currency" }, "hash": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"transaction\": {\n \"id\": \"7027355691xxx\",\n \"amount\": 200,\n \"currency\": \"SGD\",\n \"status\": \"success\",\n \"payment_attempt_at\": \"2023-11-28T06:58:23.000000Z\"\n },\n \"request_id\": \"674814xxxxx560\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "transaction": { "type": "object", "properties": { "id": { "type": "string", "example": "7027355691xxx" }, "amount": { "type": "integer", "example": 200, "default": 0 }, "currency": { "type": "string", "example": "SGD" }, "status": { "type": "string", "example": "success" }, "payment_attempt_at": { "type": "string", "example": "2023-11-28T06:58:23.000000Z" } } }, "request_id": { "type": "string", "example": "674814xxxxx560" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v2/order/refund/fetch": { "post": { "summary": "Refund Status", "description": "The refund status is tracked via the Refund ID", "operationId": "refund-status", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant Account API" }, "id": { "type": "string", "description": "Refund Id will be provided in refund order api or refund attempts api" }, "hash": { "type": "string", "description": "Only required in V1 API . Pass NULL IN V2 API", "default": "null" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Refund Data Fetched Successfully\",\n \"data\": {\n \"refund_id\": \"7230436xxxxxxxx056\",\n \"amount\": 100,\n \"type\": \"Full\",\n \"status\": \"initiated\",\n \"rrn\": \"xxxxxxxxxxxxxxxxxxx\",\n \"attempted_at\": \"2xxx-0x-2xT07:55:30.000000Z\"\n },\n \"request_id\": \"6xxf20axxxxxf\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Refund Data Fetched Successfully" }, "data": { "type": "object", "properties": { "refund_id": { "type": "string", "example": "7230436xxxxxxxx056" }, "amount": { "type": "integer", "example": 100, "default": 0 }, "type": { "type": "string", "example": "Full" }, "status": { "type": "string", "example": "initiated" }, "rrn": { "type": "string", "example": "xxxxxxxxxxxxxxxxxxx" }, "attempted_at": { "type": "string", "example": "2xxx-0x-2xT07:55:30.000000Z" } } }, "request_id": { "type": "string", "example": "6xxf20axxxxxf" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v2/order/refund/attempts": { "post": { "summary": "Refund Attempts", "description": "This takes an order id and returns all associated refunds with that Order ID.", "operationId": "refund-attempts", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "order_id", "hash" ], "properties": { "key": { "type": "string", "description": "Merchant API key" }, "order_id": { "type": "string", "description": "Utilise the order ID provided in the response from Paytring's create order API." }, "hash": { "type": "string", "description": "Only required in V1 API . Pass NULL IN V2 API", "default": "null" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Refund attempts fetched successfully\",\n \"data\": [\n {\n \"refund_id\": \"7230436xxxxxx48056\",\n \"amount\": 100,\n \"type\": \"Full\",\n \"status\": \"success\",\n \t\"rrn\": \"xxxxxxxxxxxxxxxxxxx\",\n \"attempted_at\": \"2xxx-0x-23T07:55:30.000000Z\"\n }\n ],\n \"request_id\": x67af25xxxxxxx\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v2/info/methods": { "post": { "summary": "Method API by OrderID", "description": "It includes what methods are available on Paytring Order Id", "operationId": "method-api-by-order-id", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "key", "id" ], "properties": { "key": { "type": "string", "description": "Merchant key, available in dashboard profile section" }, "id": { "type": "string", "description": "Paytring Order ID" }, "HASH": { "type": "string", "description": "Only required in V1 API . Pass NULL IN V2 API" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n {\n\n \"status\": true,\n\n \"data\": {\n\n \"netbanking\": {\n\n \"priority\": 0,\n\n \"data\": [\n\n {\n\n \"code\": \"INB1134\",\n\n \"title\": \"Development Credit Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"KOTAK\",\n\n \"title\": \"Kotak Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"BCCO\",\n\n \"title\": \"Bassien Catholic Coop Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n \n {\n\n \"code\": \"CANARA\",\n\n \"title\": \"Canara Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n\n {\n\n \"code\": \"PNBCO\",\n\n \"title\": \"Punjab National Bank - Corporate Banking\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"DIGIDBS\",\n\n \"title\": \"Digibank by DBS\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n\n {\n\n \"code\": \"FINCARER\",\n\n \"title\": \"Fincare Bank - Retail\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"HDFC\",\n\n \"title\": \"HDFC Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"IDFC\",\n\n \"title\": \"IDFC FIRST Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"PNBSB\",\n\n \"title\": \"Punjab and Sindh Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n \n {\n\n \"code\": \"RBLBKCO\",\n\n \"title\": \"RBL Bank Limited - Corporate Banking\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"SBI\",\n\n \"title\": \"State bank Of India\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n\n {\n\n \"code\": \"AXIS\",\n\n \"title\": \"AXIS Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"YESBK\",\n\n \"title\": \"Yes Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n ]\n\n },\n\n \"debitcard\": {\n\n \"priority\": 1,\n\n \"data\": [\n\n {\n\n \"code\": \"VI\",\n\n \"title\": \"Visa Credit Card\"\n\n },\n\n {\n\n \"code\": \"MC\",\n\n \"title\": \"Master Card Credit Card\"\n\n },\n\n {\n\n \"code\": \"RU\",\n\n \"title\": \"Rupay Credit Card\"\n\n },\n\n {\n\n \"code\": \"AX\",\n\n \"title\": \"Amex Credit Card\"\n\n },\n\n ]\n\n },\n\n \"creditcard\": {\n\n \"priority\": 1,\n\n \"data\": [\n\n {\n\n \"code\": \"VI\",\n\n \"title\": \"Visa Credit Card\"\n\n },\n\n {\n\n \"code\": \"MC\",\n\n \"title\": \"Master Card Credit Card\"\n\n },\n\n {\n\n \"code\": \"RU\",\n\n \"title\": \"Rupay Credit Card\"\n\n },\n\n {\n\n \"code\": \"AX\",\n\n \"title\": \"Amex Credit Card\"\n\n },\n\n ]\n\n },\n\n \"upi\": {\n\n \"priority\": 2,\n\n \"data\": {\n\n \"UPI\": \"UPI\"\n\n }\n\n },\n\n \"intent\": false,\n\n \"wallet\": false,\n\n \"emi\": false,\n\n \"scanAndPay\": false,\n\n \"upiQr\": true,\n\n \"convenience_fee\": false\n\n },\n\n \"request_id\": x67xxxxxxxx19a\"\n\n}\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v2/info/payment/methods": { "post": { "summary": "Method API", "description": "It includes fetch methods for payment data.", "operationId": "method-api", "parameters": [ { "name": "user-agent", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "string", "description": "in cents/paisa" }, "currency": { "type": "string", "description": "3 char currency code" }, "callback": { "type": "string", "description": "callback url" }, "udf1": { "type": "string", "description": "user defined fields" }, "pg": { "type": "string", "description": "Payment Gateway" }, "pg_pool_id": { "type": "string", "description": "Payment Gateway pool id" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n {\n\n \"status\": true,\n\n \"data\": {\n\n \"netbanking\": {\n\n \"priority\": 0,\n\n \"data\": [\n\n {\n\n \"code\": \"INB1134\",\n\n \"title\": \"Development Credit Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"KOTAK\",\n\n \"title\": \"Kotak Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"BCCO\",\n\n \"title\": \"Bassien Catholic Coop Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n \n {\n\n \"code\": \"CANARA\",\n\n \"title\": \"Canara Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n\n {\n\n \"code\": \"PNBCO\",\n\n \"title\": \"Punjab National Bank - Corporate Banking\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"DIGIDBS\",\n\n \"title\": \"Digibank by DBS\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n\n {\n\n \"code\": \"FINCARER\",\n\n \"title\": \"Fincare Bank - Retail\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"HDFC\",\n\n \"title\": \"HDFC Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"IDFC\",\n\n \"title\": \"IDFC FIRST Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"PNBSB\",\n\n \"title\": \"Punjab and Sindh Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n \n {\n\n \"code\": \"RBLBKCO\",\n\n \"title\": \"RBL Bank Limited - Corporate Banking\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"SBI\",\n\n \"title\": \"State bank Of India\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n\n {\n\n \"code\": \"AXIS\",\n\n \"title\": \"AXIS Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n {\n\n \"code\": \"YESBK\",\n\n \"title\": \"Yes Bank\",\n\n \"health\": true,\n\n \"favorite\": true,\n\n \"image\": \"https://cdn.paytring.com/cdn/bank/inb1134.svg\"\n\n },\n\n ]\n\n },\n\n \"debitcard\": {\n\n \"priority\": 1,\n\n \"data\": [\n\n {\n\n \"code\": \"VI\",\n\n \"title\": \"Visa Credit Card\"\n\n },\n\n {\n\n \"code\": \"MC\",\n\n \"title\": \"Master Card Credit Card\"\n\n },\n\n {\n\n \"code\": \"RU\",\n\n \"title\": \"Rupay Credit Card\"\n\n },\n\n {\n\n \"code\": \"AX\",\n\n \"title\": \"Amex Credit Card\"\n\n },\n\n ]\n\n },\n\n \"creditcard\": {\n\n \"priority\": 1,\n\n \"data\": [\n\n {\n\n \"code\": \"VI\",\n\n \"title\": \"Visa Credit Card\"\n\n },\n\n {\n\n \"code\": \"MC\",\n\n \"title\": \"Master Card Credit Card\"\n\n },\n\n {\n\n \"code\": \"RU\",\n\n \"title\": \"Rupay Credit Card\"\n\n },\n\n {\n\n \"code\": \"AX\",\n\n \"title\": \"Amex Credit Card\"\n\n },\n\n ]\n\n },\n\n \"upi\": {\n\n \"priority\": 2,\n\n \"data\": {\n\n \"UPI\": \"UPI\"\n\n }\n\n },\n\n \"intent\": false,\n\n \"wallet\": false,\n\n \"emi\": false,\n\n \"scanAndPay\": false,\n\n \"upiQr\": true,\n\n \"convenience_fee\": false\n\n },\n\n \"request_id\": x67xxxxxxxx19a\"\n\n}\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/api/v2/webhook/list": { "post": { "summary": "List Webhooks", "description": "Fetch a list of all webhook endpoints associated with your merchant account.", "operationId": "list-webhooks", "tags": [ "Webhook V2" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Filter webhooks by status (true for active, false for inactive)." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "topics": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "created_at": { "type": "string" } } } } } } } } } }, "deprecated": false } }, "/api/v2/webhook/create": { "post": { "summary": "Create Webhook", "description": "Create a new webhook endpoint to receive notifications for specific events.", "operationId": "create-webhook", "tags": [ "Webhook V2" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL where notifications will be sent." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "List of event types to subscribe to." }, "active": { "type": "boolean", "description": "Set to true to enable the webhook immediately.", "default": true } } } } } }, "responses": { "200": { "description": "Webhook created successfully" } }, "deprecated": false } }, "/api/v2/webhook/{id}/update": { "post": { "summary": "Fetch Webhook Details", "description": "Retrieve configuration details for a specific webhook endpoint.", "operationId": "fetch-webhook", "tags": [ "Webhook V2" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique ID of the webhook." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "topics": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "created_at": { "type": "string" } } } } } } } } }, "deprecated": false } }, "/api/v2/webhook/{id}": { "post": { "summary": "Update Webhook", "description": "Modify an existing webhook endpoint's configuration.", "operationId": "update-webhook", "tags": [ "Webhook V2" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique ID of the webhook." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "topics": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Webhook updated successfully" } }, "deprecated": false } }, "/api/v2/webhook/topics": { "post": { "summary": "List Topics", "description": "Retrieve a list of all available webhook event types (topics) that you can subscribe to.", "operationId": "list-webhook-topics", "tags": [ "Webhook V2" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": false }, "x-readme-fauxas": true }