|
|
{ "info": { "_postman_id": "bf27160b-d2b4-4912-b93a-84ef985c1991", "name": "RemitonPartner.API", "description": "Documentation was updated on February 12, 2024\n\nBase URL:\n\nDev: [https://test.remiton.pro/api](https://test.remiton.pro/api) \nProd: [https://remiton.pro/api](https://remiton.pro/api)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "15414569" }, "item": [ { "name": "Auth", "item": [ { "name": "Get Access Token", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "var jsonData = JSON.parse(responseBody);\r", "pm.collectionVariables.set(\"accessToken\", jsonData.accessToken);\r", "pm.collectionVariables.set(\"refreshToken\", jsonData.refreshToken);\r", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"clientId\": \"<your-clientId>\",\r\n \"secretKey\": \"<your-secretKey>\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/auth", "host": [ "{{baseUrl}}" ], "path": [ "v2", "auth" ] }, "description": "This request is used for user authentication, allowing them to verify their identity and obtain an access token and a refresh token. The access token can be used to access protected resources, while the refresh token can be used to obtain a new access token when the current one expires.\n\nEnter the \"ClientId\" and \"SecretKey\" that you take from the dashboard to get the access token\n\nThis is the time that the token will be active.\n\nDev environment: \naccessToken - 30 min \nrefreshToken - 120 min\n\nProd environment: \naccessToken - 5 min \nrefreshToken - 15 min" }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"clientId\": \"16ba6bf52a347d58bdb17170c1c44155759952ec\",\r\n \"secretKey\": \"9a202b771c78bc3452aa1cf719413ffb46120d14fc\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/auth", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "auth" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:56:22 GMT" } ], "cookie": [], "body": "{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOi1xMTU5IiwibmFtZSI6Ik5pY2F0IEJBIiwicm9sZSI6IlN1cGVyIEFkbWluIiwiZW1haWwiOiI4IiwibmJmIjoxNzAyNDU3NzgyLCJleHAiOjE3MDI0NTk1ODIsImlhdCI6MTcwMjQ1Nzc4Mn0.X6Ck-SPRVcXEEojg0TVOOGgig6tZ_c0VTUc8ipvYvWY\",\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIxMTU5IiwibmFtZSI6Ik5pY2F0IEJBIiwicm9sZSI6IlN1cGVyIEFkbWluIiwiZW1haWwiOiI4IiwibmJmIjoxNzAyNDU3NzgyLCJleHAiOjE3MDI0NjQ5ODIsImlhdCI6MTcwMjQ1Nzc4Mn0.9whhMewvBPOTsg6cQ3ALHkkNh5yyQhaWd-bE_xCLEbs\"\n}" }, { "name": "400 - INVALID", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"clientId\": \"121212121212121212\",\r\n \"secretKey\": \"32323232323232323232323\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/auth", "host": [ "{{baseUrl}}" ], "path": [ "v2", "auth" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"code\": \"invalid.credentials\",\n \"message\": \"Invalid credentials\"\n}" } ] }, { "name": "Refresh Token", "event": [ { "listen": "test", "script": { "exec": [ "var jsonData = JSON.parse(responseBody);\r", "pm.collectionVariables.set(\"accessToken\", jsonData.token);\r", "pm.collectionVariables.set(\"refreshToken\", jsonData.refreshToken);\r", "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "refresh-token", "value": "{{refreshToken}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/auth/refresh", "host": [ "{{baseUrl}}" ], "path": [ "v2", "auth", "refresh" ] }, "description": "This request allows users to refresh an access token by providing a valid refresh token.\n\nWrite in Headers, Key - \"refresh-token\" and value - \"refreshToken\" to get Refresh Token" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "refresh-token", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4Iiw1bmFtZSI6IlN1cGVyIEFkbWluIiwicm9sZSI6IlN1cGVyIEFkbWluIiwiZW1haWwiOiI4IiwibmJmIjoxNzAxMDg5NTkxLCJleHAiOjE3MDEwOTA0OTEsImlhdCI6MTcwMTA4OTU5MX0.yw2pE7jwV5ZSzGYGpFoJmY8M9X85XyiT0vS6O4aZAqs", "type": "text" } ], "url": { "raw": "https://test.remiton.pro/api/v2/auth/refresh", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "auth", "refresh" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:56:55 GMT" } ], "cookie": [], "body": "{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4IiwibmFtZSI6IlN1cGVyIEFkbWluIiwicm9sZSI6IlN1cGVyIEFkbWluIiwiZW1haWwiOiI4IiwibmJmIjoxNzAyNDU3ODE1LCJleHAiOjE3MDI0NTk2MTUsImlhdCI6MTcwMjQ1NzgxNX0.HyK9YJ_jUbegvvyF9HIEtr24tupMKXechosAI1fmFlA\",\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4IiwibmFtZSI6IlN1cGVyIEFkbWluIiwicm9sZSI6IlN1cGVyIEFkbWluIiwiZW1haWwiOiI4IiwibmJmIjoxNzAyNDU3ODE1LCJleHAiOjE3MDI0NjUwMTUsImlhdCI6MTcwMjQ1NzgxNX0.eqDfYl6ji0vp4XcoZC0D3a1c46QP8OpTdBMvVsBYDGE\"\n}" }, { "name": "400 - INVALID", "originalRequest": { "method": "GET", "header": [ { "key": "refresh-token", "value": "1211212", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v2/auth/refresh", "host": [ "{{baseUrl}}" ], "path": [ "v2", "auth", "refresh" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"code\": \"invalid.token\",\n \"message\": \"Access Token is invalid\"\n}" } ] } ], "description": "To get an access token, you need to:\n\n1. Go to the dashboard\n2. Select \"Api Key\" at the bottom of the page\n3. click Generate button to get \"ClientId\" and \"SecretKey\" which by entering into the endpoint \"Get Access Token\" you will get access token." }, { "name": "Transaction", "item": [ { "name": "Payment", "item": [ { "name": "Two Phase", "item": [ { "name": "Cash Payment (PreCreate)", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"Claudius\",\r\n \"lastName\": \"Ronan\",\r\n \"phone\": \"994556984869\",\r\n \"address\": \"London, black st 154\",\r\n \"birthDate\": \"1996-01-01\",\r\n \"zipCode\": \"1B 1BB\",\r\n \"documentInfo\": {\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"C034548754\",\r\n \"documentIssuedCountry\": \"USA\",\r\n \"documentIssuedDate\": \"2015-05-01\",\r\n \"documentEndDate\": \"2025-05-01\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"Marcus\",\r\n \"lastName\": \"Lincoln\",\r\n \"phone\": \"994556904869\"\r\n },\r\n \"country\": \"PAK\",\r\n \"agentName\": \"UBL\",\r\n \"amount\": 1000,\r\n \"currency\": \"PKR\",\r\n \"agentTransactionId\": \"{{uuid}}\",\r\n \"callbackUrl\": \"{{callbackUrl}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/cash/pre-create", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "cash", "pre-create" ] }, "description": "This request allows users to initiate a cash withdrawal transaction, enabling them to receive the funds in cash at a specified cash point." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"Claudius\",\r\n \"lastName\": \"Ronan\",\r\n \"phone\": \"994556984869\",\r\n \"address\": \"London, black st 154\",\r\n \"birthDate\": \"1996-01-01\",\r\n \"documentInfo\": {\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"C034548754\",\r\n \"documentIssuedCountry\": \"USA\",\r\n \"documentIssuedDate\": \"2015-05-01\",\r\n \"documentEndDate\": \"2025-05-01\"\r\n },\r\n \"zipCode\": \"1B 1BB\"\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"Marcus\",\r\n \"lastName\": \"Lincoln\",\r\n \"phone\": \"994556904869\"\r\n },\r\n \"country\": \"PAK\",\r\n \"agentName\": \"UBL\",\r\n \"amount\": 10,\r\n \"currency\": \"PKR\",\r\n \"agentTransactionId\": \"TRN100000000\",\r\n \"callbackUrl\": \"https://your-domain.com/api/v1/webhook/receive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/cash", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "cash" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:57:07 GMT" } ], "cookie": [], "body": "{\n \"id\": \"5dcb7029-c817-4d4e-b1cd-9bd9a651e749\",\n \"expireDate\": \"2024-02-21T12:33:39+00\",\n \"fee\": 0\n}" } ] }, { "name": "Account Transfer (PreCreate)", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"USMAN\",\r\n \"lastName\": \"MAHMOOD\",\r\n \"phone\": \"447944466646\",\r\n \"address\": \"LONDON E7 0AP\",\r\n \"birthDate\": \"1990-09-28\",\r\n \"zipCode\": \"1B 1BB\",\r\n \"documentInfo\": {\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"MAHMO909280U99XE65\",\r\n \"documentIssuedCountry\": \"GBR\",\r\n \"documentIssuedDate\": \"2023-05-17\",\r\n \"documentEndDate\": \"2033-05-16\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"MAQSOOD AHMAD\",\r\n \"lastName\": \"AHAD\",\r\n \"phone\": \"923218787698\",\r\n \"documentInfo\": {\r\n \"documentNumber\": \"5555555555\"\r\n },\r\n \"accountInfo\": {\r\n \"accountNumber\": \"PK24MEZN0002180105429465\",\r\n \"bankName\": \"MEEZAN BANK LIMITED\"\r\n }\r\n },\r\n \"country\": \"PAK\",\r\n \"agentName\": \"MeezanBank\",\r\n \"amount\": 1000,\r\n \"currency\": \"PKR\",\r\n \"agentTransactionId\": \"{{uuid}}\",\r\n \"callbackUrl\": \"{{callbackUrl}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/account/pre-create", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "account", "pre-create" ] }, "description": "This request allows users to initiate a bank transfer, enabling them to transfer funds directly to bank account." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"USMAN\",\r\n \"lastName\": \"MAHMOOD\",\r\n \"phone\": \"447944466646\",\r\n \"address\": \"LONDON E7 0AP\",\r\n \"birthDate\": \"1990-09-28\",\r\n \"documentInfo\": {\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"MAHMO909280U99XE65\",\r\n \"documentIssuedCountry\": \"GBR\",\r\n \"documentIssuedDate\": \"2023-05-17\",\r\n \"documentEndDate\": \"2033-05-16\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"MAQSOOD AHMAD\",\r\n \"lastName\": \"AHAD\",\r\n \"phone\": \"923218787698\",\r\n \"documentInfo\": {\r\n \"documentNumber\": \"5555555555\"\r\n },\r\n \"accountInfo\": {\r\n \"accountNumber\": \"PK24MEZN0002180105429465\",\r\n \"bankName\": \"MEEZAN BANK LIMITED\"\r\n }\r\n },\r\n \"country\": \"PAK\",\r\n \"agentName\": \"MeezanBank\",\r\n \"amount\": \"10\",\r\n \"currency\": \"PKR\",\r\n \"agentTransactionId\": \"[auto-generated]\",\r\n \"callbackUrl\": \"\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/account/pre-create", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "account", "pre-create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Thu, 21 Dec 2023 09:54:02 GMT" } ], "cookie": [], "body": "{\n \"id\": \"5d1b7029-c817-4d4e-b1cd-9bd9a651e749\",\n \"expireDate\": \"2024-02-21T12:33:39+00\",\n \"fee\": 2.5\n}" } ] }, { "name": "Execute Payment", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"id\": \"2b1b6893-c60f-46d9-a595-39c0a026eebe\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/execute", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "execute" ] }, "description": "This request allows users to initiate a cash withdrawal transaction, enabling them to receive the funds in cash at a specified cash point." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"id\": \"5dcb7029-c817-4d4e-b1cd-9bd9a651e749\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/cash", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "cash" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:57:07 GMT" } ], "cookie": [], "body": "{\n \"status\": \"UNDER_PROCESS\",\n \"statusDescription\": \"Transaction under processing\",\n \"rrn\": \"GP240100012953\",\n \"fee\": 0.00,\n \"rate\": 335.4500\n}" } ] } ] }, { "name": "Cash Payment", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"Claudius\",\r\n \"lastName\": \"Ronan\",\r\n \"phone\": \"994556984869\",\r\n \"address\": \"London, black st 154\",\r\n \"birthDate\": \"1996-01-01\",\r\n \"zipCode\": \"1B 1BB\",\r\n \"documentInfo\": {\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"C034548754\",\r\n \"documentIssuedCountry\": \"USA\",\r\n \"documentIssuedDate\": \"2015-05-01\",\r\n \"documentEndDate\": \"2025-05-01\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"Marcus\",\r\n \"lastName\": \"Lincoln\",\r\n \"phone\": \"994556904869\"\r\n },\r\n \"country\": \"PAK\",\r\n \"agentName\": \"UBL\",\r\n \"amount\": 100,\r\n \"currency\": \"PKR\",\r\n \"agentTransactionId\": \"{{uuid}}\",\r\n \"callbackUrl\": \"{{callbackUrl}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/cash", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "cash" ] }, "description": "This request allows users to initiate a cash withdrawal transaction, enabling them to receive the funds in cash at a specified cash point." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"Claudius\",\r\n \"lastName\": \"Ronan\",\r\n \"phone\": \"994556984869\",\r\n \"address\": \"London, black st 154\",\r\n \"birthDate\": \"1996-01-01\",\r\n \"documentInfo\": {\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"C034548754\",\r\n \"documentIssuedCountry\": \"USA\",\r\n \"documentIssuedDate\": \"2015-05-01\",\r\n \"documentEndDate\": \"2025-05-01\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"Marcus\",\r\n \"lastName\": \"Lincoln\",\r\n \"phone\": \"994556904869\"\r\n },\r\n \"country\": \"PAK\",\r\n \"agentName\": \"UBL\",\r\n \"amount\": 10,\r\n \"currency\": \"PKR\",\r\n \"agentTransactionId\": \"TRN100000000\",\r\n \"callbackUrl\": \"https://your-domain.com/api/v1/webhook/receive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/cash", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "cash" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:57:07 GMT" } ], "cookie": [], "body": "{\n \"status\": \"UNDER_PROCESS\",\n \"statusDescription\": \"Transaction under processing\",\n \"rrn\": \"GP34702438149\",\n \"fee\": 2.00,\n \"rate\": 370.5600\n}" } ] }, { "name": "Account Transfer", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"USMAN\",\r\n \"lastName\": \"MAHMOOD\",\r\n \"phone\": \"447944466646\",\r\n \"address\": \"LONDON E7 0AP\",\r\n \"birthDate\": \"1990-09-28\",\r\n \"zipCode\": \"1B 1BB\",\r\n \"documentInfo\": {\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"MAHMO909280U99XE65\",\r\n \"documentIssuedCountry\": \"GBR\",\r\n \"documentIssuedDate\": \"2023-05-17\",\r\n \"documentEndDate\": \"2033-05-16\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"MAQSOOD AHMAD\",\r\n \"lastName\": \"AHAD\",\r\n \"phone\": \"923218787698\",\r\n \"documentInfo\": {\r\n \"documentNumber\": \"5555555555\"\r\n },\r\n \"accountInfo\": {\r\n \"accountNumber\": \"PK24MEZN0002180105429465\",\r\n \"bankName\": \"MEEZAN BANK LIMITED\"\r\n }\r\n },\r\n \"country\": \"PAK\",\r\n \"agentName\": \"MeezanBank\",\r\n \"amount\": 1,\r\n \"currency\": \"PKR\",\r\n \"agentTransactionId\": \"{{uuid}}\",\r\n \"callbackUrl\": \"{{callbackUrl}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/account", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "account" ] }, "description": "This request allows users to initiate a bank transfer, enabling them to transfer funds directly to bank account." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"USMAN\",\r\n \"lastName\": \"MAHMOOD\",\r\n \"phone\": \"447944466646\",\r\n \"address\": \"LONDON E7 0AP\",\r\n \"birthDate\": \"1990-09-28\",\r\n \"documentInfo\": {\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"MAHMO909280U99XE65\",\r\n \"documentIssuedCountry\": \"GBR\",\r\n \"documentIssuedDate\": \"2023-05-17\",\r\n \"documentEndDate\": \"2033-05-16\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"MAQSOOD AHMAD\",\r\n \"lastName\": \"AHAD\",\r\n \"phone\": \"923218787698\",\r\n \"documentInfo\": {\r\n \"documentNumber\": \"5555555555\"\r\n },\r\n \"accountInfo\": {\r\n \"accountNumber\": \"PK24MEZN0002180105429465\",\r\n \"bankName\": \"MEEZAN BANK LIMITED\"\r\n }\r\n },\r\n \"country\": \"PAK\",\r\n \"agentName\": \"MeezanBank\",\r\n \"amount\": \"10\",\r\n \"currency\": \"PKR\",\r\n \"agentTransactionId\": \"[auto-generated]\",\r\n \"callbackUrl\": \"\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/account", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Thu, 21 Dec 2023 09:54:02 GMT" } ], "cookie": [], "body": "{\n \"status\": \"UNDER_PROCESS\",\n \"statusDescription\": \"Transaction under processing\",\n \"rrn\": \"GP35509008931\",\n \"fee\": 0,\n \"rate\": 370\n}" } ] }, { "name": "SEPA", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"receiverClient\": {\r\n \"firstName\": \"Lexa\",\r\n \"lastName\": \"Clarke\",\r\n \"address\": {\r\n \"country\": \"POL\",\r\n \"city\": \"Warsaw\",\r\n \"address\": \"Mr Ronan House 066\"\r\n },\r\n \"accountInfo\": {\r\n \"accountNumber\": \"PL24101014010013972231000000\"\r\n }\r\n },\r\n \"country\": \"POL\",\r\n \"amount\": 1,\r\n \"currency\": \"EUR\",\r\n \"agentTransactionId\": \"{{uuid}}\",\r\n \"callbackUrl\": \"{{callbackUrl}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/sepa", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "sepa" ] }, "description": "This request allows users to initiate a SEPA transfer, enabling them to transfer funds directly to bank account in EUR (The list of countries can be found in the Get Sepa Countries endpoint)." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"receiverClient\": {\r\n \"firstName\": \"Lexa\",\r\n \"lastName\": \"Clarke\",\r\n \"address\": {\r\n \"country\": \"GBR\",\r\n \"city\": \"London\",\r\n \"address\": \"Ivory House 206\"\r\n },\r\n \"accountInfo\": {\r\n \"accountNumber\": \"PL24101014010013972231000000\"\r\n }\r\n },\r\n \"country\": \"POL\",\r\n \"amount\": 1,\r\n \"currency\": \"EUR\",\r\n \"agentTransactionId\": \"TRN100000000\",\r\n \"callbackUrl\": \"https://your-domain.com/api/v1/webhook/receive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/sepa", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "sepa" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:58:45 GMT" } ], "cookie": [], "body": "{\n \"status\": \"UNDER_PROCESS\",\n \"statusDescription\": \"Transaction under processing\",\n \"rrn\": \"GP34707744071\",\n \"fee\": 0\n}" } ] }, { "name": "FPS", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"receiverClient\": {\r\n \"firstName\": \"Lexa\",\r\n \"lastName\": \"Clarke\",\r\n \"accountInfo\": {\r\n \"accountNumber\": \"00057085\",\r\n \"sortCode\": \"041356\"\r\n }\r\n },\r\n \"amount\": 1,\r\n \"currency\": \"GBP\",\r\n \"agentTransactionId\": \"{{uuid}}\",\r\n \"callbackUrl\": \"{{callbackUrl}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/fps", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "fps" ] }, "description": "This request allows users to initiate a Faster Payment transfers, enabling them to transfer funds directly to bank account in GBP (only for UK).EndFragment" }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"receiverClient\": {\r\n \"firstName\": \"Lexa\",\r\n \"lastName\": \"Clarke\",\r\n \"accountInfo\": {\r\n \"accountNumber\": \"00057085\",\r\n \"sortCode\": \"041356\"\r\n }\r\n },\r\n \"amount\": 1,\r\n \"currency\": \"GBP\",\r\n \"agentTransactionId\": \"TRN100000000\",\r\n \"callbackUrl\": \"https://your-domain.com/api/v1/webhook/receive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/fps", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "fps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:59:15 GMT" } ], "cookie": [], "body": "{\n \"status\": \"UNDER_PROCESS\",\n \"statusDescription\": \"Transaction under processing\",\n \"rrn\": \"GP34707342141\",\n \"fee\": 0\n}" } ] }, { "name": "Card Payout - B2C", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"receiverClient\": {\r\n \"firstName\": \"Clarke\",\r\n \"lastName\": \"Lexa\",\r\n \"accountInfo\": {\r\n \"pan\": \"5186150310000045\"\r\n }\r\n },\r\n \"paymentType\": \"B2C\",\r\n \"amount\": 1,\r\n \"currency\": \"EUR\",\r\n \"agentTransactionId\": \"{{uuid}}\",\r\n \"callbackUrl\": \"{{callbackUrl}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/card", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "card" ] }, "description": "This endpoint allows users to initiate transactions between business (corporate) and individual customers, allowing companies to send money directly to an individual's Visa or MasterCard.\n\nDistinct from P2P transfers, this B2C process simplifies transactions without requiring sender (company) details, facilitating a simple and efficient payment flow from business (corporate) to individuals." }, "response": [ { "name": "B2C - 200 OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"receiverClient\": {\r\n \"firstName\": \"Clarke\",\r\n \"lastName\": \"Lexa\",\r\n \"accountInfo\": {\r\n \"pan\": \"5186150310000045\"\r\n }\r\n },\r\n \"paymentType\": \"B2C\",\r\n \"amount\": 1,\r\n \"currency\": \"EUR\",\r\n \"agentTransactionId\": \"TRN100000000\",\r\n \"callbackUrl\": \"https://your-domain.com/api/v1/webhook/receive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/card", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "card" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:59:28 GMT" } ], "cookie": [], "body": "{\n \"status\": \"UNDER_PROCESS\",\n \"statusDescription\": \"Transaction under processing\",\n \"rrn\": \"GP34705302495\",\n \"fee\": 0\n}" } ] }, { "name": "Card Payout - P2P", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"Claudius\",\r\n \"lastName\": \"Ronan\",\r\n \"address\": {\r\n \"country\": \"GBR\",\r\n \"city\": \"London\",\r\n \"address\": \"Ivory House 066\",\r\n \"zipCode\": \"SW11 3F\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"Clarke\",\r\n \"lastName\": \"Lexa\",\r\n \"accountInfo\": {\r\n \"pan\": \"5186150310000045\"\r\n }\r\n },\r\n \"paymentType\": \"P2P\",\r\n \"amount\": 5,\r\n \"currency\": \"EUR\",\r\n \"agentTransactionId\": \"{{uuid}}\",\r\n \"callbackUrl\": \"{{callbackUrl}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/payments/card", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payments", "card" ] }, "description": "This endpoint allows users to initiate person-to-person (P2P) Card Payout transfers, allowing individuals to send money directly to each other's Visa or MasterCard.\n\nWhen sending to Visa cards, it's crucial to include a \"zipCode\" with exactly 5 characters. Although the \"zipCode\" is also required for MasterCard transfers, the 5-character restriction applies only to Visa." }, "response": [ { "name": "P2P - 200 OK", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"senderClient\": {\r\n \"firstName\": \"Claudius\",\r\n \"lastName\": \"Ronan\",\r\n \"address\": {\r\n \"country\": \"GBR\",\r\n \"city\": \"London\",\r\n \"address\": \"Ivory House 206\",\r\n \"zipCode\": \"SW11 3F\"\r\n }\r\n },\r\n \"receiverClient\": {\r\n \"firstName\": \"Clarke\",\r\n \"lastName\": \"Lexa\",\r\n \"accountInfo\": {\r\n \"pan\": \"5186150310000045\"\r\n }\r\n },\r\n \"paymentType\": \"P2P\",\r\n \"amount\": 1,\r\n \"currency\": \"EUR\",\r\n \"agentTransactionId\": \"TRN100000000\",\r\n \"callbackUrl\": \"https://your-domain.com/api/v1/webhook/receive\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://test.remiton.pro/api/v2/payments/card", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "payments", "card" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 08:59:28 GMT" } ], "cookie": [], "body": "{\n \"status\": \"UNDER_PROCESS\",\n \"statusDescription\": \"Transaction under processing\",\n \"rrn\": \"GP34715802495\",\n \"fee\": 0\n}" } ] } ], "description": "Mandatory Fields table for different remittance types.\n\nSpecial Mandatory fields for individual banks can be viewed at the \"Get Mandatories\" endpoint\n\n| Field name | Validation | **Reqired for Transaction** |\n| --- | --- | --- |\n| firstName | Validation Rules: Letters, length: 1-50 <br> <br>Example Values: \"Ali\", \"Jack\" | All Remittance Types |\n| lastName | Validation Rules: Letters, length: 1-50 <br> <br>Example Values: \"Quliyev\", \"Smith\" | All Remittance Types |\n| phone | Validation Rules: Numbers, length: 1-50 <br> <br>Example Values: \"44123456789\", \"994123456789\" | Cash, Account |\n| address | Validation Rules: Letters, numbers, length: 1-200 <br> <br>Example Values: \"Salisbury House, 29 Finsbury Circus\", \"Suite 500 - 439 University Avenue\" | Cash, Account, SEPA, Card Payout |\n| birthDate | Validation Rules: Numbers, length: 10 <br> <br>Example Values: \"1997-05-25\", \"1965-01-27\" | Cash, Account |\n| country | Validation Rules: Letters (ISO Format), length: 3 <br> <br>Example Values: \"PAK\", \"POL\" | Cash, Account, SEPA |\n| agentName | Validation Rules: Letters, numbers, length: 1-50 <br> <br>Example Values: \"UBL\", \"MeezanBank\" | Cash, Account |\n| amount | Validation Rules: Numbers, length: 1-100000 <br> <br>Example Values: \"15000\", \"15.58\" | All Remittance Types |\n| currency | Validation Rules: Letters (ISO Format), length: 3 <br> <br>Example Values: \"EUR\", \"USD\" | All Remittance Types |\n| agentTransactionId | Validation Rules: Letters, numbers, length: 1-50 <br> <br>Example Values: \"123Z45X78C\", \"1234567890\" | All Remittance Types |\n| documentType | ENUM => PASSPORT, NATIONAL_ID, DRIVING_LICENSE | Cash and account, when sending more than 1000 GBP |\n| documentNumber | Validation Rules: Letters, numbers, length: 1-50 <br> <br>Example Values: \"123456789, \"ABC123456789\" | Cash and account, when sending more than 1000 GBP |\n| documentIssuedCountry | Validation Rules: Letters, length: 1-50 <br> <br>Example Values: \"United Kingdom, \"Azerbaijan\" | Cash and account, when sending more than 1000 GBP |\n| documentIssuedDate | Validation Rules: Numbers, length: 10 <br> <br>Example Values: \"2020-05-28\", \"2017-10-24\" | Cash and account, when sending more than 1000 GBP |\n| documentEndDate | Validation Rules: Numbers, length: 10 <br> <br>Example Values: \"2030-01-27\", \"2027-11-25\" | Cash and account, when sending more than 1000 GBP |\n| accountNumber | Validation Rules: Letters, numbers, length: 1-50 (8 for SEPA Transfers) <br> <br>Example Values: \"GB456789123AB47\", \"12345678\" | Account, SEPA, FPS |\n| bankName | Validation Rules: Letters, numbers, length: 1-50 <br> <br>Example Values: \"Guavapay LTD\", \"Meezan Bank Limited\" | Account |\n| city | Validation Rules: Letters, length: 1-50 <br> <br>Example Values: \"London\", \"Paris\" | SEPA |\n| sortCode | Validation Rules: Numbers, length: 6 <br> <br>Example Values: \"123456\", \"147369\" | FPS |\n| pan | Validation Rules: Numbers, length: 16 or 19 <br> <br>Example Values: \"1234567890123456\", \"1234567890123456789\" | Card Payout |" }, { "name": "Pay Money", "item": [ { "name": "Get by ReferenceCode", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions/code/{{referenceCode}}", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "code", "{{referenceCode}}" ] }, "description": "Using this endpoint, you can get information about the transaction so that you can later pay money to the receiver\n\nIf you want to pay the receiver use the endpoint \"Pay\"" }, "response": [] }, { "name": "Pay", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"documentType\": \"PASSPORT\",\r\n \"documentNumber\": \"AA4547845\",\r\n \"address\": \"Mr Ronan street 54/57\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/transactions/code/{{referenceCode}}/pay", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "code", "{{referenceCode}}", "pay" ] }, "description": "Using this endpoint you can pay money to the receivers, for this purpose after receiving the transaction data from the 1st endpoint (\"Get by ReferenceCode\"), you have to provide the receiver data such as \"documentType\", \"documentNumber\" and \"address\" in the body of this endpoint." }, "response": [] } ] }, { "name": "Get Transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions?pageSize=10&pageIndex=0&dateFrom=2023-12-01&dateTo=2024-05-01&sortField=amount&sortType=asc&remittanceType=ACCOUNT&rrn=GP22803144408&referenceCode=GP22803144408&country=PAK¤cy=PKR&provider=UBL&status=PAID", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions" ], "query": [ { "key": "pageSize", "value": "10" }, { "key": "pageIndex", "value": "0" }, { "key": "dateFrom", "value": "2023-12-01" }, { "key": "dateTo", "value": "2024-05-01" }, { "key": "sortField", "value": "amount" }, { "key": "sortType", "value": "asc" }, { "key": "remittanceType", "value": "ACCOUNT" }, { "key": "rrn", "value": "GP22803144408" }, { "key": "referenceCode", "value": "GP22803144408" }, { "key": "country", "value": "PAK" }, { "key": "currency", "value": "PKR" }, { "key": "provider", "value": "UBL" }, { "key": "status", "value": "PAID" } ] }, "description": "This request allows users to retrieve a list of completed transactions as well as search for them by entering one or more of the field belowEndFragment" }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/transactions?pageSize=10&pageIndex=0&dateFrom=2023-12-13&dateTo=2024-05-01&remittanceType=ACCOUNT&country=PAK", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "transactions" ], "query": [ { "key": "pageSize", "value": "10" }, { "key": "pageIndex", "value": "0" }, { "key": "dateFrom", "value": "2023-12-13" }, { "key": "dateTo", "value": "2024-05-01" }, { "key": "sortField", "value": "amount", "disabled": true }, { "key": "sortType", "value": "", "disabled": true }, { "key": "remittanceType", "value": "ACCOUNT" }, { "key": "rrn", "value": "GP22803144408", "disabled": true }, { "key": "referenceCode", "value": "GP22803144408", "disabled": true }, { "key": "country", "value": "PAK" }, { "key": "currency", "value": "PKR", "disabled": true }, { "key": "provider", "value": "UBL", "disabled": true }, { "key": "status", "value": "PAID", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:00:52 GMT" } ], "cookie": [], "body": "{\n \"list\": [\n {\n \"senderClient\": \"USMAN MAHMOOD\",\n \"receiverClient\": \"MAQSOOD AHMAD AHAD\",\n \"remittanceType\": \"ACCOUNT\",\n \"rrn\": \"GP3470753582\",\n \"referenceCode\": \"GP3470753582\",\n \"transactionDate\": \"2023-12-13T08:57:48+00\",\n \"status\": \"IN_PROGRESS\",\n \"statusDescription\": \"Request in progress\",\n \"country\": \"PAK\",\n \"provider\": \"MeezanBank\",\n \"bank\": \"\",\n \"billingAmount\": 0.03,\n \"billingCurrency\": \"GBP\",\n \"amount\": 10,\n \"currency\": \"PKR\",\n \"rate\": 370,\n \"fee\": 0,\n \"agentProfit\": 0\n },\n {\n \"senderClient\": \"USMAN MAHMOOD\",\n \"receiverClient\": \"MAQSOOD AHMAD AHAD\",\n \"remittanceType\": \"ACCOUNT\",\n \"rrn\": \"GP34705069078\",\n \"referenceCode\": \"GP34705069078\",\n \"transactionDate\": \"2023-12-13T08:57:30+00\",\n \"status\": \"IN_PROGRESS\",\n \"statusDescription\": \"Request in progress\",\n \"country\": \"PAK\",\n \"provider\": \"MeezanBank\",\n \"bank\": \"\",\n \"billingAmount\": 0.03,\n \"billingCurrency\": \"GBP\",\n \"amount\": 10,\n \"currency\": \"PKR\",\n \"rate\": 370,\n \"fee\": 0,\n \"agentProfit\": 0\n }\n ],\n \"totalCount\": 2\n}" } ] }, { "name": "Check Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions/GP34702438149/status", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "GP34702438149", "status" ] }, "description": "This request allows users to retrieve transaction details and check the status of a transaction by providing the RRN) associated with the transaction." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/transactions/GP3450952506/status", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "transactions", "GP3450952506", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:02:00 GMT" } ], "cookie": [], "body": "{\n \"referenceCode\": \"GP3450952506\",\n \"status\": \"PAID\",\n \"statusDescription\": \"Successfully completed\"\n}" }, { "name": "404 - NOT FOUND", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions/GP10000000001/status", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "GP10000000001", "status" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"code\": \"data.not.found\",\n \"message\": \"Data not found\"\n}" } ] }, { "name": "Get Transaction", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions/{{RRN}}", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "{{RRN}}" ] }, "description": "This request allows users to retrieve transaction details by providing the RRN associated with transaction." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/transactions/GP3450952506", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "transactions", "GP3450952506" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:02:52 GMT" } ], "cookie": [], "body": "{\n \"receiverClient\": {\n \"firstName\": \"a\",\n \"middleName\": \"\",\n \"lastName\": \"a\",\n \"motherName\": \"\",\n \"birthDate\": null,\n \"phone\": \"+3559787984\",\n \"address\": \"\",\n \"addressCountry\": \"\",\n \"occupation\": \"\",\n \"patornymic\": \"\",\n \"documentInfo\": {\n \"documentSeries\": \"121\",\n \"documentNumber\": \"2121\",\n \"documentType\": null,\n \"documentIssuedCity\": \"12121\",\n \"documentIssuedCountry\": \"Albanie\",\n \"documentIssuedDate\": \"2021-04-07T00:00:00+01\",\n \"documentEndDate\": \"2021-04-21T00:00:00+01\"\n },\n \"receiverRequisite\": {\n \"accountNumber\": \"\"\n }\n },\n \"senderClient\": {\n \"name\": \"Tagi\",\n \"middleName\": \"\",\n \"lastName\": \"Asad\",\n \"motherName\": \"\",\n \"birthDate\": \"1993-11-11T00:00:00+00\",\n \"phone\": \"+93434324\",\n \"address\": \"dqdwd\",\n \"addressCountry\": \"\",\n \"currency\": \"GBP\",\n \"occupation\": \"\",\n \"patornymic\": \"\",\n \"documentInfo\": {\n \"documentSeries\": \"AZE\",\n \"documentNumber\": \"13000000000\",\n \"documentType\": \"NATIONAL_ID\",\n \"documentIssuedCity\": \"AZER\",\n \"documentIssuedCountry\": \"Turkey\",\n \"documentIssuedDate\": \"2021-01-21T03:00:00+00\",\n \"documentEndDate\": \"2029-10-10T01:00:00+01\",\n \"files\": [\n {\n \"DocumentId\": 1275,\n \"DocumentType\": \"FRONT_SIDE\"\n },\n {\n \"DocumentId\": 1276,\n \"DocumentType\": \"BACK_SIDE\"\n }\n ]\n }\n },\n \"remittanceType\": \"CASH\",\n \"rrn\": \"GP3450952506\",\n \"referenceCode\": \"GP3450952506\",\n \"country\": \"PAK\",\n \"status\": \"PAID\",\n \"statusDescription\": \"Successfully completed\",\n \"transactionDate\": \"2023-12-11T13:22:08+00\",\n \"accountNumber\": \"\",\n \"pan\": \"\",\n \"integrationType\": \"\",\n \"purpose\": \"\",\n \"provider\": \"TestProductionAgent\",\n \"bank\": \"\",\n \"billingAmount\": 1,\n \"billingCurrency\": \"GBP\",\n \"amount\": 350,\n \"currency\": \"PKR\",\n \"rate\": 350,\n \"fee\": 2,\n \"agentProfit\": 3\n}" }, { "name": "404 - NOT FOUND", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions/GP10000001", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "GP10000001" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"code\": \"data.not.found\",\n \"message\": \"Data not found\"\n}" } ] }, { "name": "Get Transaction By Agent Transaction Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions/agentTransactionId/{{agentTransactionId}}", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "agentTransactionId", "{{agentTransactionId}}" ] }, "description": "This request allows users to retrieve transaction details by providing the Agent Transaction ID associated with transaction." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/transactions/agentTransactionId/78945631258", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "transactions", "agentTransactionId", "78945631258" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:04:36 GMT" } ], "cookie": [], "body": "{\n \"receiverClient\": {\n \"firstName\": \"Marcus\",\n \"middleName\": \"\",\n \"lastName\": \"Lincoln\",\n \"motherName\": \"\",\n \"birthDate\": null,\n \"phone\": \"994556904869\",\n \"address\": \"\",\n \"addressCountry\": \"\",\n \"occupation\": \"\",\n \"patornymic\": \"\",\n \"documentInfo\": {\n \"documentSeries\": \"\",\n \"documentNumber\": \"\",\n \"documentType\": null,\n \"documentIssuedCity\": \"\",\n \"documentIssuedCountry\": \"\",\n \"documentIssuedDate\": null,\n \"documentEndDate\": null\n },\n \"receiverRequisite\": {\n \"accountNumber\": \"\"\n }\n },\n \"senderClient\": {\n \"name\": \"Claudius\",\n \"middleName\": \"\",\n \"lastName\": \"Ronan\",\n \"motherName\": \"\",\n \"birthDate\": \"1996-01-01T00:00:00+00\",\n \"phone\": \"994556984869\",\n \"address\": \"London, black st 154\",\n \"addressCountry\": \"\",\n \"currency\": \"GBP\",\n \"occupation\": \"\",\n \"patornymic\": \"\",\n \"documentInfo\": {\n \"documentSeries\": \"\",\n \"documentNumber\": \"C034548754\",\n \"documentType\": null,\n \"documentIssuedCity\": \"\",\n \"documentIssuedCountry\": \"USA\",\n \"documentIssuedDate\": \"2015-05-01T00:00:00+01\",\n \"documentEndDate\": \"2025-05-01T00:00:00+01\",\n \"files\": []\n }\n },\n \"remittanceType\": \"CASH\",\n \"rrn\": \"GP34704725552\",\n \"referenceCode\": \"GP34704725552\",\n \"country\": \"PAK\",\n \"status\": \"IN_PROGRESS\",\n \"statusDescripton\": \"Request in progress\",\n \"transactionDate\": \"2023-12-13T09:04:27+00\",\n \"accountNumber\": \"\",\n \"pan\": \"\",\n \"integrationType\": \"\",\n \"purpose\": \"\",\n \"provider\": \"UBL\",\n \"bank\": \"\",\n \"billingAmount\": 0.03,\n \"billingCurrency\": \"GBP\",\n \"amount\": 10,\n \"currency\": \"PKR\",\n \"rate\": 370.56,\n \"fee\": 0,\n \"agentProfit\": 0\n}" }, { "name": "404 - NOT FOUND", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions/agentTransactionId/TRN100000000001", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "agentTransactionId", "TRN100000000001" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"code\": \"data.not.found\",\n \"message\": \"Data not found\"\n}" } ] }, { "name": "Get Document", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transactions/documents/{{documentId}}", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "documents", "{{documentId}}" ] }, "description": "This request allows users to retrieve client document details, including the side of the document and the file containing the document photo, by providing the \nDocument ID associated with the document." }, "response": [] }, { "name": "Upload Document", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "Files[0].DocumentType", "value": "PASSPORT", "type": "text" }, { "key": "Files[0].File", "type": "file", "src": "/C:/Users/TAGI/Desktop/fake-pass-back.jpg" } ] }, "url": { "raw": "{{baseUrl}}/v2/transactions/{{RRN}}/upload", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "{{RRN}}", "upload" ] }, "description": "In this request you must upload the document and the RRN number in order to attach the document to the RRN number of the transaction you made" }, "response": [] }, { "name": "Amend", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"name\": \"Claudius\",\r\n \"middleName\": \"Federico\",\r\n \"lastName\": \"Ronan\",\r\n \"phoneNumber\": \"+9945555555\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/transactions/{{RRN}}/amend", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "{{RRN}}", "amend" ] }, "description": "This endpoint allows for modifying the recipient's details of a transaction.\n\nBy entering the transaction's RRN in the endpoint, you can update the recipient's first name, middle name, last name, and phone number." }, "response": [] }, { "name": "Cancel", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"content\": \"Canceled by customer request\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/transactions/{{RRN}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transactions", "{{RRN}}", "cancel" ] }, "description": "This endpoint is used to cancel a transaction.\n\nBy providing the transaction's RRN in the endpoint and including the required content in the body of the request, the transaction will be canceled." }, "response": [] } ] }, { "name": "Agent", "item": [ { "name": "Get Accounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "accounts" ] }, "description": "This request allows you to get a list of accounts associated with the client, including account balances in different currencies." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:06:13 GMT" } ], "cookie": [], "body": "[\n {\n \"accountNumber\": \"GB07GUAV00993200002174\",\n \"currency\": \"USD\",\n \"availableAmount\": 6.01\n },\n {\n \"accountNumber\": \"GB09GUAV00993200006406\",\n \"currency\": \"EUR\",\n \"availableAmount\": 99917.00\n },\n {\n \"accountNumber\": \"GB87GUAV04135600057221\",\n \"currency\": \"GBP\",\n \"availableAmount\": 385865.20\n }\n]" } ] }, { "name": "Get Rates", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/rates?sourceCurrency=GBP&targetCurrency=PKR&remittanceType=ACCOUNT&agent=UBL", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rates" ], "query": [ { "key": "sourceCurrency", "value": "GBP" }, { "key": "targetCurrency", "value": "PKR" }, { "key": "remittanceType", "value": "ACCOUNT" }, { "key": "agent", "value": "UBL" } ] }, "description": "This request allows users to retrieve currency exchange rates between different currencies." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/rates?sourceCurrency=GBP&targetCurrency=PKR&remittanceType=ACCOUNT&agent=UBL", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rates" ], "query": [ { "key": "sourceCurrency", "value": "GBP" }, { "key": "targetCurrency", "value": "PKR" }, { "key": "remittanceType", "value": "ACCOUNT" }, { "key": "agent", "value": "UBL" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:07:58 GMT" } ], "cookie": [], "body": "[\n {\n \"sourceCurrency\": \"GBP\",\n \"targetCurrency\": \"PKR\",\n \"rate\": 370.5600,\n \"remittanceType\": \"CASH\",\n \"agent\": \"UBL\"\n },\n {\n \"sourceCurrency\": \"GBP\",\n \"targetCurrency\": \"PKR\",\n \"rate\": 377.7700,\n \"remittanceType\": \"ACCOUNT\",\n \"agent\": \"UBL\"\n },\n {\n \"sourceCurrency\": \"GBP\",\n \"targetCurrency\": \"PKR\",\n \"rate\": 208.5000,\n \"remittanceType\": \"CASH\",\n \"agent\": \"MeezanBank\"\n },\n {\n \"sourceCurrency\": \"GBP\",\n \"targetCurrency\": \"PKR\",\n \"rate\": 370.0000,\n \"remittanceType\": \"ACCOUNT\",\n \"agent\": \"MeezanBank\"\n }\n]" } ] }, { "name": "Get Agents", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents?country=PAK¤cy=PKR", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents" ], "query": [ { "key": "country", "value": "PAK" }, { "key": "currency", "value": "PKR" } ] }, "description": "This request allows users to retrieve the names of agents available for currency exchange in a specific country and currency." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents?country=PAK¤cy=PKR", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents" ], "query": [ { "key": "country", "value": "PAK" }, { "key": "currency", "value": "PKR" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:08:30 GMT" } ], "cookie": [], "body": "[\n {\n \"name\": \"JSBL\"\n },\n {\n \"name\": \"MeezanBank\"\n },\n {\n \"name\": \"UBL\"\n }\n]" } ] }, { "name": "Get Banks", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/{{agentName}}/banks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "{{agentName}}", "banks" ] }, "description": "This request allows users to retrieve a list of banks associated with a specific agent." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/UBL/banks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "UBL", "banks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:09:05 GMT" } ], "cookie": [], "body": "[\n {\n \"bankName\": \"UBL\"\n },\n {\n \"bankName\": \"JSBL\"\n }\n]" } ] }, { "name": "Get Cash Payout Banks", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/{{agentName}}/banks/cash", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "{{agentName}}", "banks", "cash" ] }, "description": "This request allows users to retrieve a list of banks associated with a specific agent." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/NECMoney/banks/cash", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "NECMoney", "banks", "cash" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:09:05 GMT" } ], "cookie": [], "body": "[\n {\n \"bankName\": \"UBL\"\n },\n {\n \"bankName\": \"JSBL\"\n }\n]" } ] }, { "name": "Get Branch Code by City", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/banks/cities/{{city}}/branches", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "banks", "cities", "{{city}}", "branches" ] }, "description": "In this request you will get Branch name, Branch code and RoutingNo by city." }, "response": [ { "name": "Get Branch Code by City", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/banks/cities/Chittagong/branches", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "banks", "cities", "Chittagong", "branches" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:10:18 GMT" } ], "cookie": [], "body": "[\n {\n \"branchName\": \"C.E.P.Z.\",\n \"branchCode\": \"10928\",\n \"routingNo\": \"095151577\"\n },\n {\n \"branchName\": \"LOHA GARA\",\n \"branchCode\": \"10929\",\n \"routingNo\": \"095154666\"\n },\n {\n \"branchName\": \"NAZIR HAT\",\n \"branchCode\": \"10887\",\n \"routingNo\": \"095155599\"\n },\n {\n \"branchName\": \"MEHDIBAGH\",\n \"branchCode\": \"10855\",\n \"routingNo\": \"095154961\"\n },\n {\n \"branchName\": \"HATHAZARI\",\n \"branchCode\": \"10746\",\n \"routingNo\": \"095153225\"\n },\n {\n \"branchName\": \"JAMAL KHAN\",\n \"branchCode\": \"11406\",\n \"routingNo\": \"095150178\"\n },\n {\n \"branchName\": \"DOHAZARI\",\n \"branchCode\": \"12271\",\n \"routingNo\": \"095152563\"\n },\n {\n \"branchName\": \"MURADPUR\",\n \"branchCode\": \"12272\",\n \"routingNo\": \"095155328\"\n },\n {\n \"branchName\": \"KHULSHI\",\n \"branchCode\": \"11905\",\n \"routingNo\": \"095154361\"\n },\n {\n \"branchName\": \"CHANDGAON\",\n \"branchCode\": \"9013\",\n \"routingNo\": \"095151485\"\n },\n {\n \"branchName\": \"PANCHLAISH\",\n \"branchCode\": \"8889\",\n \"routingNo\": \"095156048\"\n },\n {\n \"branchName\": \"RAOZAN\",\n \"branchCode\": \"8675\",\n \"routingNo\": \"095156493\"\n },\n {\n \"branchName\": \"BHATIARY\",\n \"branchCode\": \"7748\",\n \"routingNo\": \"095151214\"\n },\n {\n \"branchName\": \"HALISHAHAR\",\n \"branchCode\": \"7869\",\n \"routingNo\": \"095153162\"\n },\n {\n \"branchName\": \"SIRAJWODDOULA ROAD\",\n \"branchCode\": \"9646\",\n \"routingNo\": \"095157368\"\n },\n {\n \"branchName\": \"O.R. NIZAM ROAD\",\n \"branchCode\": \"3481\",\n \"routingNo\": \"095155807\"\n },\n {\n \"branchName\": \"AGRABAD\",\n \"branchCode\": \"3514\",\n \"routingNo\": \"095150136\"\n },\n {\n \"branchName\": \"JUBILEE ROAD\",\n \"branchCode\": \"3515\",\n \"routingNo\": \"095153641\"\n },\n {\n \"branchName\": \"STATION ROAD\",\n \"branchCode\": \"3516\",\n \"routingNo\": \"095157513\"\n },\n {\n \"branchName\": \"KHATUNGANJ\",\n \"branchCode\": \"3517\",\n \"routingNo\": \"095154279\"\n }\n]" } ] }, { "name": "Get City by Bank Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/banks/{{bankName}}/cities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "banks", "{{bankName}}", "cities" ] }, "description": "In this request, you will get the cities by Bank Name" }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/banks/NRB Global Bank Ltd/cities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "banks", "NRB Global Bank Ltd", "cities" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:11:26 GMT" } ], "cookie": [], "body": "[\n {\n \"cityName\": \"Bandarban\"\n },\n {\n \"cityName\": \"Barisal\"\n },\n {\n \"cityName\": \"Bogra\"\n },\n {\n \"cityName\": \"Chandpur\"\n },\n {\n \"cityName\": \"CHAPAI NAWABGANJ\"\n },\n {\n \"cityName\": \"Chittagong\"\n },\n {\n \"cityName\": \"Comilla\"\n },\n {\n \"cityName\": \"COXS BAZAR\"\n },\n {\n \"cityName\": \"Dhaka\"\n },\n {\n \"cityName\": \"Faridpur\"\n },\n {\n \"cityName\": \"Feni\"\n },\n {\n \"cityName\": \"Gazipur\"\n },\n {\n \"cityName\": \"JESSORE\"\n },\n {\n \"cityName\": \"Khulna\"\n },\n {\n \"cityName\": \"KISHOREGANJ\"\n },\n {\n \"cityName\": \"KUSHTIA\"\n },\n {\n \"cityName\": \"MADARIPUR\"\n },\n {\n \"cityName\": \"MUNSHIGANJ\"\n },\n {\n \"cityName\": \"MYMENSINGH\"\n },\n {\n \"cityName\": \"Narail\"\n },\n {\n \"cityName\": \"NARAYANGANJ\"\n },\n {\n \"cityName\": \"NARSHINGDI\"\n },\n {\n \"cityName\": \"Natore\"\n },\n {\n \"cityName\": \"Noakhali\"\n },\n {\n \"cityName\": \"Pabna\"\n },\n {\n \"cityName\": \"Rajshahi\"\n },\n {\n \"cityName\": \"Rangpur\"\n },\n {\n \"cityName\": \"SATKHIRA\"\n },\n {\n \"cityName\": \"SIRAJGANJ\"\n },\n {\n \"cityName\": \"Sylhet\"\n }\n]" } ] }, { "name": "Get Branch Code by Bank Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/banks/{{bankName}}/branches", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "banks", "{{bankName}}", "branches" ] }, "description": "In this request, you will get the Branch code by Bank Name" }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/banks/BANCO DO BRASIL S.A./branches", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "banks", "BANCO DO BRASIL S.A.", "branches" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:12:02 GMT" } ], "cookie": [], "body": "[\n {\n \"branchName\": \"MANAUS \",\n \"branchCode\": \"0002\"\n },\n {\n \"branchName\": \"PRESIDENTE VARGAS \",\n \"branchCode\": \"0003\"\n },\n {\n \"branchName\": \"SANTOS \",\n \"branchCode\": \"0004\"\n },\n {\n \"branchName\": \"CAMPOS GOYTACAZES \",\n \"branchCode\": \"0005\"\n },\n {\n \"branchName\": \"SALVADOR \",\n \"branchCode\": \"0006\"\n },\n {\n \"branchName\": \"RECIFE \",\n \"branchCode\": \"0007\"\n }\n]" } ] }, { "name": "Get Mandatories", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/agents/mandatories?provider=UBL&remittanceType=ACCOUNT", "host": [ "{{baseUrl}}" ], "path": [ "v2", "agents", "mandatories" ], "query": [ { "key": "provider", "value": "UBL" }, { "key": "remittanceType", "value": "ACCOUNT" } ] } }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/agents/mandatories?provider=UBL&remittanceType=ACCOUNT", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "agents", "mandatories" ], "query": [ { "key": "provider", "value": "UBL" }, { "key": "remittanceType", "value": "ACCOUNT" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"receiverClient\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"documentInfo\": {},\n \"accountInfo\": {\n \"accountNumber\": \"\"\n }\n },\n \"senderClient\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthDate\": \"\",\n \"phone\": \"\",\n \"senderAddress\": \"\",\n \"documentInfo\": {\n \"documentNumber\": \"\",\n \"documentType\": \"\",\n \"documentIssuedCountry\": \"\",\n \"documentIssuedDate\": \"\",\n \"documentEndDate\": \"\"\n }\n },\n \"amount\": 0,\n \"agentName\": \"\",\n \"country\": \"\",\n \"currency\": \"\",\n \"agentTransactionId\": \"\"\n}" } ] } ] }, { "name": "Dictionary", "item": [ { "name": "Get Countries", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/dictionaries/countries", "host": [ "{{baseUrl}}" ], "path": [ "v2", "dictionaries", "countries" ] }, "description": "In this request you will receive the available countries" }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/dictionaries/countries", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "dictionaries", "countries" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:12:24 GMT" } ], "cookie": [], "body": "[\n {\n \"code\": \"ALB\",\n \"name\": \"Albania\"\n },\n {\n \"code\": \"AUT\",\n \"name\": \"Austria\"\n },\n {\n \"code\": \"AZE\",\n \"name\": \"Azerbaijan\"\n },\n {\n \"code\": \"BGD\",\n \"name\": \"Bangladesh\"\n },\n {\n \"code\": \"BEL\",\n \"name\": \"Belgium\"\n },\n {\n \"code\": \"BRA\",\n \"name\": \"Brazil\"\n },\n {\n \"code\": \"CYP\",\n \"name\": \"Cyprus\"\n },\n {\n \"code\": \"DNK\",\n \"name\": \"Denmark\"\n },\n {\n \"code\": \"EGY\",\n \"name\": \"Egypt\"\n },\n {\n \"code\": \"EST\",\n \"name\": \"Estonia\"\n },\n {\n \"code\": \"FIN\",\n \"name\": \"Finland\"\n },\n {\n \"code\": \"FRA\",\n \"name\": \"France\"\n },\n {\n \"code\": \"DEU\",\n \"name\": \"Germany\"\n },\n {\n \"code\": \"GRC\",\n \"name\": \"Greece\"\n },\n {\n \"code\": \"IND\",\n \"name\": \"India\"\n },\n {\n \"code\": \"IDN\",\n \"name\": \"Indonesia\"\n },\n {\n \"code\": \"ISR\",\n \"name\": \"Israel\"\n },\n {\n \"code\": \"JPN\",\n \"name\": \"Japan\"\n },\n {\n \"code\": \"KZK\",\n \"name\": \"Kazakhstan\"\n },\n {\n \"code\": \"KEN\",\n \"name\": \"Kenya\"\n },\n {\n \"code\": \"KYR\",\n \"name\": \"Kyrgyzstan\"\n },\n {\n \"code\": \"LTV\",\n \"name\": \"Latvia\"\n },\n {\n \"code\": \"LTU\",\n \"name\": \"Lithuania\"\n },\n {\n \"code\": \"LUX\",\n \"name\": \"Luxembourg\"\n },\n {\n \"code\": \"MYS\",\n \"name\": \"Malaysia\"\n },\n {\n \"code\": \"MLT\",\n \"name\": \"Malta\"\n },\n {\n \"code\": \"MMR\",\n \"name\": \"Myanmar\"\n },\n {\n \"code\": \"NPL\",\n \"name\": \"Nepal\"\n },\n {\n \"code\": \"NLD\",\n \"name\": \"Netherlands\"\n },\n {\n \"code\": \"NOR\",\n \"name\": \"Norway\"\n },\n {\n \"code\": \"PAK\",\n \"name\": \"Pakistan\"\n },\n {\n \"code\": \"POL\",\n \"name\": \"Poland\"\n },\n {\n \"code\": \"PRT\",\n \"name\": \"Portugal\"\n },\n {\n \"code\": \"ROU\",\n \"name\": \"Romania\"\n },\n {\n \"code\": \"SGP\",\n \"name\": \"Singapore\"\n },\n {\n \"code\": \"SVK\",\n \"name\": \"Slovakia\"\n },\n {\n \"code\": \"SVN\",\n \"name\": \"Slovenia\"\n },\n {\n \"code\": \"KOR\",\n \"name\": \"South Korea\"\n },\n {\n \"code\": \"ESP\",\n \"name\": \"Spain\"\n },\n {\n \"code\": \"LKA\",\n \"name\": \"SriLanka\"\n },\n {\n \"code\": \"SWE\",\n \"name\": \"Sweden\"\n },\n {\n \"code\": \"CHE\",\n \"name\": \"Switzerland\"\n },\n {\n \"code\": \"TZA\",\n \"name\": \"Tanzania\"\n },\n {\n \"code\": \"TGO\",\n \"name\": \"Togo\"\n },\n {\n \"code\": \"TUR\",\n \"name\": \"Turkey\"\n },\n {\n \"code\": \"GBR\",\n \"name\": \"United Kingdom\"\n },\n {\n \"code\": \"VNM\",\n \"name\": \"Vietnam\"\n }\n]" } ] }, { "name": "Get SEPA Countries", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/dictionaries/countries/sepa", "host": [ "{{baseUrl}}" ], "path": [ "v2", "dictionaries", "countries", "sepa" ] }, "description": "From this endpoint you can get a list of countries for SEPA transfers" }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/dictionaries/countries/sepa", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "dictionaries", "countries", "sepa" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:12:54 GMT" } ], "cookie": [], "body": "[\n {\n \"code\": \"FRA\"\n },\n {\n \"code\": \"GBR\"\n },\n {\n \"code\": \"ITA\"\n },\n {\n \"code\": \"LTV\"\n },\n {\n \"code\": \"BRA\"\n },\n {\n \"code\": \"TST\"\n },\n {\n \"code\": \"POL\"\n },\n {\n \"code\": \"NLD\"\n },\n {\n \"code\": \"LTU\"\n },\n {\n \"code\": \"DEU\"\n },\n {\n \"code\": \"BEL\"\n },\n {\n \"code\": \"EST\"\n },\n {\n \"code\": \"CYP\"\n },\n {\n \"code\": \"NOR\"\n },\n {\n \"code\": \"PRT\"\n },\n {\n \"code\": \"CHE\"\n },\n {\n \"code\": \"SVK\"\n },\n {\n \"code\": \"LUX\"\n },\n {\n \"code\": \"SWE\"\n },\n {\n \"code\": \"ROU\"\n },\n {\n \"code\": \"SVN\"\n },\n {\n \"code\": \"MLT\"\n },\n {\n \"code\": \"DNK\"\n },\n {\n \"code\": \"AUT\"\n },\n {\n \"code\": \"GRC\"\n },\n {\n \"code\": \"ESP\"\n },\n {\n \"code\": \"FIN\"\n }\n]" } ] }, { "name": "Get Remittance Types", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/dictionaries/countries/{{country}}/remittance-types", "host": [ "{{baseUrl}}" ], "path": [ "v2", "dictionaries", "countries", "{{country}}", "remittance-types" ] }, "description": "From this endpoint you can get a list of available Remittance Types for a country." }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/dictionaries/countries/PAK/remittance-types", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "dictionaries", "countries", "PAK", "remittance-types" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:13:39 GMT" } ], "cookie": [], "body": "[\n {\n \"name\": \"ACCOUNT\"\n },\n {\n \"name\": \"CASH\"\n }\n]" } ] } ] }, { "name": "Additional", "item": [ { "name": "Calculate Fee", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/additional/calculate?remittanceType=ACCOUNT&billingCurrency=GBP&country=PAK¤cy=PKR&agentName=UBL&amount=5000", "host": [ "{{baseUrl}}" ], "path": [ "v2", "additional", "calculate" ], "query": [ { "key": "remittanceType", "value": "ACCOUNT" }, { "key": "billingCurrency", "value": "GBP" }, { "key": "country", "value": "PAK" }, { "key": "currency", "value": "PKR" }, { "key": "agentName", "value": "UBL" }, { "key": "amount", "value": "5000" }, { "key": "billingAmount", "value": "10", "disabled": true } ] } }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/additional/calculate?remittanceType=ACCOUNT&billingCurrency=GBP&country=PAK¤cy=PKR&agentName=UBL&billingAmount=0.03", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "additional", "calculate" ], "query": [ { "key": "remittanceType", "value": "ACCOUNT" }, { "key": "billingCurrency", "value": "GBP" }, { "key": "country", "value": "PAK" }, { "key": "currency", "value": "PKR" }, { "key": "agentName", "value": "UBL" }, { "key": "amount", "value": "500", "disabled": true }, { "key": "billingAmount", "value": "0.03" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:13:50 GMT" } ], "cookie": [], "body": "{\n \"billingAmount\": 0.03,\n \"amount\": 500,\n \"rate\": 377.77,\n \"fee\": 1.5\n}" } ] }, { "name": "IBAN Checker", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/additional/iban/{{iban}}", "host": [ "{{baseUrl}}" ], "path": [ "v2", "additional", "iban", "{{iban}}" ] }, "description": "From this endpoint you can check the IBAN and find out which country and bank it belongs to" }, "response": [ { "name": "200 - OK", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://test.remiton.pro/api/v2/additional/iban/PK36SCBL0000001123456702", "protocol": "https", "host": [ "test", "remiton", "pro" ], "path": [ "api", "v2", "additional", "iban", "PK36SCBL0000001123456702" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Server", "value": "Microsoft-IIS/10.0" }, { "key": "X-Powered-By", "value": "ASP.NET" }, { "key": "Date", "value": "Wed, 13 Dec 2023 09:13:50 GMT" } ], "cookie": [], "body": "{\n \"bic\": \"SCBLPKKXXXX\",\n \"branch\": null,\n \"bank\": \"STANDARD CHARTERED BANK (PAKISTAN) LIMITED\",\n \"country\": \"Pakistan\",\n \"city\": \"\",\n \"sepaTransfer\": false,\n \"sepaInstantTransfer\": false\n}" } ] }, { "name": "Callback", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"rrn\": \"GP34801080181\",\r\n \"referenceCode\": \"GP34801080181\",\r\n \"referenceNumber\": \"GP34801080181\",\r\n \"agentTransactionId\": \"1de4139e-c22b-4810-af31-3bca5494babb\",\r\n \"status\": \"IN_PROGRESS\",\r\n \"statusDescripton\": \"Transaction under processing\",\r\n \"transactionDate\": \"2023-12-14T08:06:55.667\",\r\n \"accountNumber\": \"\",\r\n \"pan\": \"517161******1197\",\r\n \"integrationType\": \"\",\r\n \"billingAmount\": 1,\r\n \"billingCurrency\": \"EUR\",\r\n \"amount\": 1,\r\n \"currency\": \"EUR\",\r\n \"rate\": 1,\r\n \"fee\": 0,\r\n \"agentProfit\": 0\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{callbackUrl}}", "host": [ "{{callbackUrl}}" ] }, "description": "Use a Callback URL to get real-time updates on transaction statuses.\n\nOnce you set a Callback URL, you'll automatically receive notifications when a transaction status changes.\n\nThis means you won't need to constantly check the status manually using endpoints like \"get transaction\" or \"check status\"." }, "response": [] } ], "description": "Status List\n\n| Status | Description |\n| --- | --- |\n| UNDER_PROCESS | Transaction is under process |\n| IN_PROGRESS | Transaction in process |\n| AML_APPROVE | AML approval is pending |\n| READY_FOR_PAYOUT | Transaction is ready for pickup (cash) |\n| PAID | The client has received a transfer |\n| UNSUCCESSFUL | Transaction failed |\n| CANCELED | Transaction successfully canceled |\n\nError Codes\n\nNote: Receiving an error does not mean the status has changed.\n\n| Error code | Description |\n| --- | --- |\n| data.not.found | Data entered by the user was not found |\n| duplicate.transaction | Transaction with this AgentTransactionID has already been created |\n| insufficient.balance | Not suficient funds on client account |\n| forbidden.error | The user does not have access to this endpoint |\n| internal.server.error | The server is undergoing technical works |\n| invalid.token | The token specified by the user is expired or incorrect |\n| unauthorized.error | User not authorized |\n| unexpected.error | Unexpected error. Please contact with support team |\n| validation.error | The user has entered the data incorrectly. The exact explanation will be in the description |" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "var uuid = require('uuid');", "pm.variables.set(\"uuid\", uuid.v4());", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://test.remiton.pro/api", "type": "string" }, { "key": "accessToken", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiI4IiwibmFtZSI6IlN1cGVyIEFkbWluIiwicm9sZSI6IlN1cGVyIEFkbWluIiwiZW1haWwiOiI4IiwibmJmIjoxNzAyNDcyMjczLCJleHAiOjE3NjI0NzI1NzMsImlhdCI6MTcwMjQ3MjI3M30.znKnMQtND3wE3Dz7f_y8Sle4BrAy_zbpzi7rzxmckCg", "type": "string" }, { "key": "refreshToken", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJu1W1laWQiOiI4IiwibmFtZSI6IlN1cGVyIEFkbWluIiwicm9sZSI6IlN1cGVyIEFkbWluIiwiZW1haWwiOiI4IiwibmJmIjoxNzAxMDg5NTkxLCJleHAiOjE3MDEwOTA0OTEsImlhdCI6MTcwMTA4OTU5MX0.yw2pE7jwV5ZSzGYGpFoJmY8M9X85XyiT0vS6O4aZAqs", "type": "string" }, { "key": "uuid", "value": "[auto-generated]", "type": "string" }, { "key": "RRN", "value": "GP240200012015", "type": "string" }, { "key": "documentId", "value": "1366", "type": "string" }, { "key": "country", "value": "PAK", "type": "string" }, { "key": "iban", "value": "PK36SCBL0000001123456702", "type": "string" }, { "key": "callbackUrl", "value": "", "type": "string" }, { "key": "agentTransactionId", "value": "TRN100000000", "type": "string" }, { "key": "referenceCode", "value": "GP240100011472", "type": "string" } ]}
|
