{ "item": [ { "name": "All endpoints", "description": "All endpoints", "item": [ { "name": "Payment runs - Payment runs", "item": [ { "id": "0303d571-8f4e-4090-960a-551ea6930765", "name": "Create a payment run", "request": { "name": "Create a payment run", "description": { "content": "Create a new payment run containing a list of outstanding supplier payments.\n\nNote that all the supplier payments in a payment run is limited to one currency. The currency of the payment run are enabled upon the Buyer’s registration.\n\n\nRequired user role: `CREATOR`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{creatorBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"payments\": [\n\t\t{\n\t\t\t\"reference\": \"{{$timestamp}}\",\n\t\t\t\"paymentAmount\": {\n\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\"amount\": 100\n\t\t\t},\n\t\t\t\"externalRef\": \"{{$guid}}\",\n\t\t\t\"paymentRef\": \"{{$guid}}\",\n\t\t\t\"supplier\": {\n\t\t\t\t\"name\": \"Test Supplier\",\n\t\t\t\t\"bankAccountDetails\": {\n\t\t\t\t\t\"accountNumber\": \"{{$randomBankAccount}}\",\n\t\t\t\t\t\"sortCode\": \"{{random_sort_code}}\"\n\t\t\t\t},\n\t\t\t\t\"type\": \"BUSINESS\"\n\t\t\t}\n\t\t}\n\t],\n\t\"paymentRunRef\": \"{{$guid}}\",\n\t\"tag\": \"tag\",\n\t\"description\": \"{{$randomLoremSentence}}\"\n}" } }, "response": [ { "id": "36df58b3-50e0-4a43-904c-acb820438912", "name": "OK", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": \"labo\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"ToENcB9XkDclpiMQXc\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"17069395\",\n \"sortCode\": \"423296\",\n \"secondaryReference\": \"in dolor\"\n },\n \"name\": \" Ad-Y9\",\n \"address\": \"aliqua officia commodo in Ut\",\n \"bankName\": \"reprehenderit qui in anim\",\n \"bankAddress\": \"Lorem\",\n \"bankCountry\": \"HE\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"AC01\",\n \"accountName\": \"labore adipisicing qui anim\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"OPTO\",\n \"accountName\": \"nisi nulla\"\n }\n }\n ]\n },\n {\n \"id\": \"non sit esse\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"aC\",\n \"status\": \"PENDING_FUNDING\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"65573693\",\n \"sortCode\": \"415607\",\n \"secondaryReference\": \"ex dolor officia\"\n },\n \"name\": \"*37 B\",\n \"address\": \"culpa in magna qui\",\n \"bankName\": \"esse occaecat\",\n \"bankAddress\": \"sit laboris commodo officia\",\n \"bankCountry\": \"JC\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"EXACT_MATCH\",\n \"reasonCode\": \"CASS\",\n \"accountName\": \"sed\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"BAMM\",\n \"accountName\": \"dolore non in nulla\"\n }\n }\n ]\n }\n ],\n \"id\": \"88acF21fecad06cfA881CfC7\",\n \"status\": \"QUEUED\",\n \"createdAt\": \"1970-07-08T07:46:31.450Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"Ak3YYrT\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"Lorem ea cupidatat et\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e3813e5-db78-4efe-ad14-4fb129d0f4a3", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f03c9dbe-bd3f-4f65-8c4b-4fa2dce5a77b", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91b76fea-8f7d-46a0-a99f-95bd43a449d6", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a3a73bc-8fb3-468b-88fc-ef09419f6b3c", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"IDEMPOTENT_REQUEST_IN_PROGRESS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cb65f34-c849-46b9-8376-9fed87c73cc2", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "050c8c3d-ec13-46be-aedd-4746650ee529", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1730d9b7-5cd1-476b-b9f1-e751987f3058", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8d3a307-426d-4537-a2cd-4e7e2e1ac055", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c88e2e8b-e835-4c7e-9c36-56a2467f96d2", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2bc96330-6f15-467e-a1af-2d3b8783ba63", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"creatorBearerToken\")) { throw new Error(\"Token 'creatorBearerToken' missing, log in as user with appropriate role.\"); }\nlet randomSortCode = Math.floor(Math.random() * 1000000).toString().padStart(6, '0');\npm.variables.set(\"random_sort_code\", randomSortCode);", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 201\", function () {\n\tpm.response.to.have.status(201);\n});\npm.environment.set(\"payment_run_id\", pm.response.json().id);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dae2cc6f-b007-4595-84d5-52df8e67ff01", "name": "Get payment runs", "request": { "name": "Get payment runs", "description": { "content": "Retrieve the list of payment runs belonging to the buyer that the logged-in user belongs to.\n\nRequired user roles: `CONTROLLER` OR `CREATOR`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "limit", "value": "100", "description": "The limit of the results for paging, starting at the offset. Limit is always capped at 100." }, { "disabled": false, "key": "offset", "value": "0", "description": "The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results." }, { "disabled": false, "key": "tag", "value": "", "description": "Filter by tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries." }, { "disabled": false, "key": "tag", "value": "", "description": "Filter by tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries." }, { "disabled": false, "key": "status", "value": "" }, { "disabled": false, "key": "reference", "value": "" }, { "disabled": false, "key": "min_amount", "value": "" }, { "disabled": false, "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{creatorBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "85b049b8-f45a-4ccd-afe8-1a23189e07ff", "name": "OK", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "tag", "value": "" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "reference", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 10,\n \"paymentRuns\": [\n {\n \"payments\": [\n {\n \"id\": \"nulla voluptate labore\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"bLe27f\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \" \",\n \"address\": \"ullamco\",\n \"bankName\": \"Duis eu ipsum\",\n \"bankAddress\": \"cupidatat ex et\",\n \"bankCountry\": \"AY\",\n \"type\": \"PERSONAL\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"aliqua ullamco Ut eiusmod velit\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"Pn9LhZC\",\n \"status\": \"QUEUED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \"a8\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ],\n \"id\": \"CAab75809Cc2Cf21c432E6D5\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"createdAt\": \"2020-10-10T12:25:57.448Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"4\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"fugiat pariatur nisi sit dolore\"\n },\n {\n \"payments\": [\n {\n \"id\": \"do dolore\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"S2GV3y7.\",\n \"status\": \"COMPLETED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \" 3#r;ScM4\",\n \"address\": \"qui amet\",\n \"bankName\": \"in nulla dolore\",\n \"bankAddress\": \"culpa officia magna exercitation\",\n \"bankCountry\": \"GG\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"laboris et\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"3GRtvhNaMSQOZtuy\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \"x\",\n \"address\": \"enim ut est eu minim\",\n \"bankName\": \"id aliquip ex ut\",\n \"bankAddress\": \"deserunt\",\n \"bankCountry\": \"KF\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ],\n \"id\": \"4129B4A2Ea62Ba9c32ec07A9\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"createdAt\": \"2024-06-09T04:09:11.617Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"xeomxTENr\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"do nisi\"\n }\n ],\n \"responseCount\": 100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "822542a7-7696-46f3-bfbf-359ceb1c20cd", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "tag", "value": "" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "reference", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f72ed9f-6570-46d7-8efb-129c9e9bffc7", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "tag", "value": "" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "reference", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b7e92f1-532c-48ef-b9ab-59b9baaadff8", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "tag", "value": "" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "reference", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b0250c4-e732-456b-a0af-9c942273b3b3", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "tag", "value": "" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "reference", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71eb888a-cd1c-4607-b70c-5e16a16ac1d0", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "tag", "value": "" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "reference", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af5c6b13-e248-48ef-8e96-e9dc1295a727", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "tag", "value": "" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "reference", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "adad8fe4-c119-4ec2-8f3d-1ff6ac15fce3", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "100" }, { "key": "offset", "value": "0" }, { "key": "tag", "value": "" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "reference", "value": "" }, { "key": "min_amount", "value": "" }, { "key": "max_amount", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"creatorBearerToken\")) { throw new Error(\"Token 'creatorBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1737d69-3d0c-41bb-8afe-211b855092d1", "name": "Get a payment run", "request": { "name": "Get a payment run", "description": { "content": "Retrieve a payment run belonging to the buyer that the logged-in user belongs to.\n\n\nRequired user roles: `CONTROLLER` OR `CREATOR`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs", "{{payment_run_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{creatorBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "4f867676-c627-4d98-9fce-d44e09e4a448", "name": "OK", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": \"anim ut\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"APt9\",\n \"status\": \"COMPLETED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"21628280\",\n \"sortCode\": \"838251\",\n \"secondaryReference\": \"Lorem reprehenderit exercitatio\"\n },\n \"name\": \"-\\n R K\",\n \"address\": \"consequat in deserunt\",\n \"bankName\": \"elit ipsum Duis dolore\",\n \"bankAddress\": \"pariatu\",\n \"bankCountry\": \"QY\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"IVCR\",\n \"accountName\": \"dolor aliqua ex pariatur\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"MBAM\",\n \"accountName\": \"cupidatat esse nisi qui\"\n }\n }\n ]\n },\n {\n \"id\": \"cupidatat tempor ea in\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"UTTHmsh\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"28413658\",\n \"sortCode\": \"539044\",\n \"secondaryReference\": \"ea amet non elit\"\n },\n \"name\": \"&/3c\",\n \"address\": \"quis veniam in sint\",\n \"bankName\": \"occaecat ad anim in Duis\",\n \"bankAddress\": \"enim Ut cillum\",\n \"bankCountry\": \"SD\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"OPTO\",\n \"accountName\": \"est nisi\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"ACNS\",\n \"accountName\": \"sunt ad tempor\"\n }\n }\n ]\n }\n ],\n \"id\": \"e28DCDCb04f69FeCcAAFeaC0\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"createdAt\": \"1956-01-13T00:10:10.715Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"YhXTPKuotVY\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"dolor nulla \"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b58d56d0-8136-4fd1-8980-707959b4adfe", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54299321-dfee-4791-b95b-8e984b6ee988", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d24f285-43b3-414d-b3fc-53a74bf09dcf", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40401161-a74d-4240-b006-3bee97a22bd2", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca340628-ed84-45c7-b05c-9342be339ab8", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "768f80d3-1816-4124-9d98-7ac90fb0a457", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dabdfbe1-660b-4068-b262-b6013e8d3b16", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8b02b82-4253-44e4-8465-45f90209a4d8", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"creatorBearerToken\")) { throw new Error(\"Token 'creatorBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43fd472f-9273-4388-8311-788cb37a09a3", "name": "Update a payment", "request": { "name": "Update a payment", "description": { "content": "Update the details of a payment identified by the paymentId that is in the `PENDING_CONFIRMATION` state.\n\n\nRequired user role: `CREATOR`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs", "{{payment_run_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8fcdc4f7-1f06-4ed2-86da-4274abc44c5b", "name": "No Content", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [{ "key": "Content-Type", "value": "text/plain" }], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52ddad3e-089a-4a82-937e-31d5e87a5afb", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d429783-e345-4e10-a135-3ad0ee24aff5", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2fde098-1013-442b-9ec8-160133a32aa1", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0628c8a2-a466-446c-992f-2e98a83d5fdc", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8097ad6-8ed6-4370-9dc7-26f7eb50cf53", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"MISSING_SUPPLIER_TYPE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63135b81-205a-4731-8552-66c53263f578", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "695e221f-b112-480f-a96d-e7871ada482c", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "895dc2f3-9ce8-4aa5-ae2b-e84384cc8934", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ef80d68-f5c7-41a9-94a6-45cc498c884a", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"paymentId\": \"\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b0b3c4d-b871-44eb-ba9f-06f394e6749b", "name": "Confirm a payment run", "request": { "name": "Confirm a payment run", "description": { "content": "Confirm that a payment run can be executed.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": [ "v1", "payment_runs", "{{payment_run_id}}", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "76042a53-ccc2-45a6-ae47-9af261cc48d0", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": \"dolore ea velit\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"bp4T6maCVp-.\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"47425563\",\n \"sortCode\": \"720148\",\n \"secondaryReference\": \"dolore anim\"\n },\n \"name\": \" 0 W V\\r&\",\n \"address\": \"d\",\n \"bankName\": \"labore laborum eu\",\n \"bankAddress\": \"Lorem et Ut\",\n \"bankCountry\": \"BG\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"MBAM\",\n \"accountName\": \"Lorem Duis\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"IVCR\",\n \"accountName\": \"aliquip voluptate\"\n }\n }\n ]\n },\n {\n \"id\": \"molli\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"kiOZD5sKK\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"75665387\",\n \"sortCode\": \"918194\",\n \"secondaryReference\": \"Lorem dolor\"\n },\n \"name\": \"t y\",\n \"address\": \"ut cupidatat\",\n \"bankName\": \"dolore est do\",\n \"bankAddress\": \"dolor cillum Lorem ad\",\n \"bankCountry\": \"GZ\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"BAMM\",\n \"accountName\": \"in laborum\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"PANM\",\n \"accountName\": \"ullamco sint\"\n }\n }\n ]\n }\n ],\n \"id\": \"d5cc035aFd80b10b534BF66D\",\n \"status\": \"PENDING_CHALLENGE\",\n \"createdAt\": \"1958-05-19T11:11:41.411Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"Bvm6hCV\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"deserunt ex\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f12a14d-920c-49f2-849f-081d8f691ae3", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb9bd0d5-a545-4124-a8fa-1e05f030c14a", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "abbbf0ac-23e2-42f6-8f6c-b66b2f9e1236", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02889ad2-dd0c-4c6b-b88f-271a8d57a32d", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9843477-6c10-49f3-8181-4c221309b77b", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"ZERO_BALANCE_ACCOUNT_INVALID_STATE\",\n \"message\": \"ipsum nulla enim anim\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f3ecdf8-549e-4fba-ba4d-59670af4762c", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53e7b62a-b79c-45b4-94bd-f1af9492ff4b", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f600759c-7739-4b8e-94b0-c22da55dd14f", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc1862f7-2150-4a59-9a67-92da3b9087de", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b2f76e5-e164-4495-a6f7-4f7f4e1d5be5", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1949b433-7299-425b-95f3-8878c6a272ab", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_pr_confirmation\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "300bd28a-0482-4a10-a44f-b147e232e06b", "name": "Get a payment run funding instructions", "request": { "name": "Get a payment run funding instructions", "description": { "content": "Start the the funding process of a payment run.\n\nSpecify the funding source of the payment run by providing an id to an already linked account.\n\nDepending on the maximum payment amount constraints imposed by the bank that is providing the account, the payment run may be split in 2 or more groups. Note that you'll need to complete a funding process for each instruction returned.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs", "{{payment_run_id}}", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds[]", "value": "{{linked_account_id}}", "disabled": false } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "8f53c36f-0f5e-41ff-8bda-9fc0152f8a9a", "name": "OK", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 10,\n \"responseCount\": 100,\n \"fundingInstructions\": [\n {\n \"reference\": \"eu culpa fugiat\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"status\": \"EXECUTING\",\n \"payments\": [\n {\n \"id\": \"magna culpa quis dolore ea\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"s0WskmTCiFPc\",\n \"status\": \"FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \"e\",\n \"address\": \"dolore\",\n \"bankName\": \"velit minim mollit\",\n \"bankAddress\": \"velit esse tempor\",\n \"bankCountry\": \"OF\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"laborum\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"2Imy1cC6lR94RiV\",\n \"status\": \"CANCELLED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \" \",\n \"address\": \"nostrud\",\n \"bankName\": \"anim cillum\",\n \"bankAddress\": \"ut ullamco\",\n \"bankCountry\": \"VA\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ],\n \"fundingDate\": \"1992-07-21T07:19:41.224Z\"\n },\n {\n \"reference\": \"nulla\",\n \"totalAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"status\": \"COMPLETED\",\n \"payments\": [\n {\n \"id\": \"id ad pariatur\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"UU2ozqn.aRvb\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \"\\\"F
L=W\",\n \"address\": \"nulla do laborum labore sunt\",\n \"bankName\": \"qui ut enim\",\n \"bankAddress\": \"occaecat est laboris irure\",\n \"bankCountry\": \"UE\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"dolore elit qui\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"0Pn2vKHPPNyZX5j5l\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \"%U\\\"\\n5\",\n \"address\": \"culpa eu ad\",\n \"bankName\": \"sit mollit minim\",\n \"bankAddress\": \"veniam\",\n \"bankCountry\": \"KV\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ],\n \"fundingDate\": \"1984-08-05T01:26:58.245Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef5b1e7a-ca57-4930-9986-749d91eb6649", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc702f4-3fa7-41f8-a6ea-2a826758794e", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1210780b-b370-4f35-8516-b2690a3f20ad", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f499ec7-7f9c-41a8-a03d-f32e358a3345", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b18bbcb5-c92b-488f-a2ed-1b9ee74fa476", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"BANK_ACCOUNT_CANNOT_BE_LINKED_ACCOUNT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9bdc79-5ede-487f-9f4e-aecc98b307b9", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d0bd771-377b-468b-b193-7b5d880177d1", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f9094cf-8901-4921-8a90-c93997d065e6", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5346dee7-0527-4565-9b8a-163c336a51a1", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set('payment_run_group_reference', pm.response.json().fundingInstructions[0].reference);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f83292c-f1db-4ec1-bf5a-653259ee7d9a", "name": "Cancel a payment run", "request": { "name": "Cancel a payment run", "description": { "content": "Cancel a payment run. \n\nNote that a payment run can be cancelled when it is in the states `QUEUED`, `PENDING_CONFIRMATION`, `PENDING_CHALLENGE`, OR `PENDING_FUNDING`\n\n\nRequired user roles: `CONTROLLER` OR `CREATOR`", "type": "text/plain" }, "url": { "path": [ "v1", "payment_runs", "{{payment_run_id}}", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{creatorBearerToken}}" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d4197797-16eb-4514-8ed8-902b3ed819fa", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de240d30-59dc-416a-8a6b-8a7c62774173", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c043d3c2-b6ef-4cf1-8aa4-70b640157e14", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d34906f6-9cd7-449e-904b-21c88e917ade", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bbf6466-0925-404f-88d8-a63c1cabe9f9", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aa4f82e-04c7-498a-9af7-91f8e1f6462d", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CANNOT_CANCEL_PAYMENT_RUN\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78a27ac0-c975-4054-ac8f-5df9bb005f48", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ddd0989-42ae-4802-94e6-b237792e294c", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "481718b2-6f22-4f62-9e82-dd310d2b68d9", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87ea5a1e-006c-4efe-b140-b0c6cf5f9b06", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f1d3eacf-4e08-4b5d-a923-60561185cca3", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a8ce8fb-3a52-4b6a-aa10-2135f9056c71", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"creatorBearerToken\")) { throw new Error(\"Token 'creatorBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02545066-a09a-4219-b20d-96a437b37fe5", "name": "Cancel a payment", "request": { "name": "Cancel a payment", "description": { "content": "Cancel a payment within a payment run. \n\nNote that a payment can be cancelled when it is in the state `PENDING_CONFIRMATION`.\n\n\nRequired user roles: `CONTROLLER` OR `CREATOR`", "type": "text/plain" }, "url": { "path": [ "v1", "payment_runs", "{{payment_run_id}}", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "961f9b5f-1c4f-44f9-bd64-07850e42a736", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c531e571-de0e-42b5-b9bc-873ba6242b7a", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24a4bf92-1171-4adf-b2b6-a8db219700b5", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7697ebbc-6301-43d9-8ce3-f249a1783415", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "437e3e90-a21d-4f69-ab76-8c99968056a1", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "695324c2-a6f6-4afa-aa1c-6768907afc6d", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PAYMENT_RUN_PAYMENT_INVALID_STATE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "642a8a24-86f7-491d-91c1-59e64c301a55", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f6e066f-90cf-41c3-8ce6-3e7ac5925a68", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "020e3434-af95-4e49-b96d-d1bc456d6d35", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18bc3b81-b90d-4198-80fe-a92837c13f79", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a41dc292-8018-4963-b1a1-1a99ad6e2427", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a5eb71a-12ce-4fcf-b24e-775984a89475", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "cancel", "payments" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"paymentIds\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "552c2eaf-ce20-48c5-aa97-849daa40c627", "name": "Restart a payment run", "request": { "name": "Restart a payment run", "description": { "content": "Restart a payment run after it has entered status `SCA_FAILED`.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": [ "v1", "payment_runs", "{{payment_run_id}}", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "b3101224-2a63-4113-b144-b807c59a2e51", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a727ae2d-393b-4a92-9bbe-ad8ee9a4dd2d", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cca2f837-34ea-44c7-85f7-bcdf115a3816", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f93a800-aed5-47c3-b123-3de4ff0a044c", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f96f0a90-412c-4495-b781-fea5e860eb59", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "553dccac-c3b5-43b6-9f66-e91b511b1354", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PAYMENT_RUN_INVALID_STATE\",\n \"message\": \"Excepteur commodo proident id\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71509870-2d1c-4199-95ad-9e1c5402ee86", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87295667-7433-4640-b426-a331cd77b4a3", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3bc72e8e-933b-4a61-acdb-53b750fd7d08", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0410fbf6-4953-45ad-997c-b1284bb5ac0e", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "199c942b-6f94-4c35-938e-47d6d8793454", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3bf81114-526e-4cbb-aab2-ff59bdb6cb70", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "restart" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81232927-66d9-492c-b314-6b63baa51254", "name": "Cancel a payment run group", "request": { "name": "Cancel a payment run group", "description": { "content": "Cancel a payment run group\nNote that a payment run group can only be cancelled when it is in the state `AWAITING_FUNDS`.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": [ "v1", "payment_runs", "{{payment_run_id}}", "group", "{{group_reference}}", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "76b6e34b-b76c-4e4a-b6e7-d88e45adf139", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d99ed88a-838e-4042-827b-5d00a4051664", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5496ffca-9e68-44c9-a272-80da4490ddd4", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40e707d5-518d-4d7e-8534-6130253ac184", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69862893-6846-4ca3-9634-1259a88f86c1", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "598ee22c-f81a-4b1c-8933-7b0e5f68a8ad", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PAYMENT_RUN_GROUP_INVALID_STATE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e27483ed-8952-45e0-9fd4-b02cc62d208e", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff85d21e-40cb-49a4-a80e-c25370c8f8a4", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aaee573b-7f2f-4c27-a7ea-2fe4f7adff31", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "414cc97a-180b-4459-8a08-8f04c144edfd", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "227f5837-5b30-488d-b483-7bc32737f7bb", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41df4fb4-ec51-47d2-8b22-78f964b4698e", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "group", ":group_reference", "cancel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." }, { "disabled": false, "type": "any", "value": "", "key": "group_reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Identities - Buyers", "item": [ { "id": "8f1eee58-02d2-4460-b437-30eec6b36c9b", "name": "Create a buyer", "request": { "name": "Create a buyer", "description": { "content": "Buyers are identities representing a business. Once on-boarded, Buyers can create and manage their own instruments via your plugin. \n\nThe information provided must be accurate and will be passed on for KYB verification with our partner.\n", "type": "text/plain" }, "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"tag\": \"tag\",\n\t\"acceptedTerms\": true,\n\t\"ipAddress\": \"{{$randomIP}}\",\n\t\"company\": {\n\t\t\"name\": \"{{buyer_company_name}}\",\n\t\t\"type\": \"LLC\",\n\t\t\"countryOfRegistration\": \"GB\",\n\t\t\"registrationNumber\": \"C89893\",\n\t\t\"businessAddress\": {\n\t\t\t\"addressLine1\": \"{{$randomStreetAddress}}\",\n\t\t\t\"addressLine2\": \"address2\",\n\t\t\t\"city\": \"{{$randomCity}}\",\n\t\t\t\"postCode\": \"postc\",\n\t\t\t\"country\": \"GB\",\n\t\t\t\"state\": \"Some State\"\n\t\t}\n\t},\n\t\"adminUser\": {\n\t\t\"name\": \"{{admin_first_name}}\",\n\t\t\"surname\": \"{{admin_last_name}}\",\n\t\t\"email\": \"{{buyer_name}}@example.com\",\n\t\t\"mobile\": {\n\t\t\t\"countryCode\": \"+356\",\n\t\t\t\"number\": \"{{mt_mobile}}\"\n\t\t},\n\t\t\"companyPosition\": \"DIRECTOR\"\n\t},\n\t\"supportedCurrencies\": [\n\t\t\"GBP\"\n\t]\n}" } }, "response": [ { "id": "a6bd9bf8-4c44-498a-8d3f-ad852c10289e", "name": "Success", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"716\",\n \"adminUser\": {\n \"id\": \"069\",\n \"email\": \"XOKj8TrnuP7vSCV@hsIWzxMfI.gn\",\n \"name\": \"consectet\",\n \"surname\": \"deserunt officia ips\",\n \"mobile\": {\n \"number\": \"69342313538\",\n \"countryCode\": \"+576\"\n },\n \"active\": true,\n \"emailVerified\": true,\n \"mobileNumberVerified\": true,\n \"companyPosition\": \"AUTHORISED_REPRESENTATIVE\",\n \"roles\": [\n \"CREATOR\"\n ],\n \"dateOfBirth\": {\n \"year\": 2006,\n \"month\": 4,\n \"day\": 11\n }\n },\n \"company\": {\n \"name\": \"eiusmod aliquip pariatur deserunt\",\n \"type\": \"LLC\",\n \"countryOfRegistration\": \"RO\",\n \"registrationNumber\": \"incidi\",\n \"businessAddress\": {\n \"addressLine1\": \"consectetur mollit\",\n \"city\": \"ullamco incididunt \",\n \"postCode\": \"1FR\",\n \"country\": \"AC\",\n \"addressLine2\": \"eiusmod in\",\n \"state\": \"voluptate est qui quis ea\"\n },\n \"registeredAddress\": {\n \"addressLine1\": \"commodo amet sunt\",\n \"city\": \"elit sunt in Duis\",\n \"country\": \"RT\",\n \"addressLine2\": \"culpa dolore dolore ea\",\n \"postCode\": \"G\",\n \"state\": \"ullamco do consequat\"\n },\n \"incorporatedOn\": {\n \"year\": 2032,\n \"month\": 1,\n \"day\": 30\n }\n },\n \"acceptedTerms\": true,\n \"creationTimestamp\": -54650904,\n \"supportedCurrencies\": [\n {\n \"currency\": \"GBP\",\n \"status\": \"PENDING_KYB_APPROVAL\"\n },\n {\n \"currency\": \"EUR\",\n \"status\": \"PENDING_KYB_APPROVAL\"\n }\n ],\n \"tag\": \"tB1\",\n \"ipAddress\": \"eu in\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9231abae-d9c0-44d9-9841-4eacfccfeaca", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca307c4-0d89-43c3-90c4-4363dde695d9", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ebd9d87-9445-4bc8-8ece-4f72de302aae", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "510b702d-382c-42a1-bcb8-de77fb8cb6e7", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CURRENCY_UNSUPPORTED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fc8bdb7-dbb1-4080-aeb2-c724665eaf56", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0be1ac3-7b48-45f7-a757-a599b7e17252", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc644f5a-ba9b-497c-8812-09f4c4fe8757", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cf77c72-bbd7-458e-9350-1d3d0a1be235", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7784883c-eb59-4927-8f79-358796c8796c", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab7ce653-e317-41bf-8af6-cef27c418a33", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "let rand = Math.floor(Date.now() / 1000);\npm.environment.set(\"buyer_name\", \"corp\" + rand);\n\nif (!pm.environment.has(\"buyer_company_name\")) {\n pm.variables.set(\"buyer_company_name\", pm.environment.get(\"buyer_name\"));\n}\n\nif (!pm.environment.has(\"admin_first_name\")) {\n pm.variables.set(\"admin_first_name\", pm.variables.replaceIn(\"{{$randomFirstName}}\"));\n}\n\nif (!pm.environment.has(\"admin_last_name\")) {\n pm.variables.set(\"admin_last_name\", pm.variables.replaceIn(\"{{$randomLastName}}\"));\n}\n\nlet prefixes = ['79','99'];\nlet prefix = prefixes[Math.floor(Math.random() * prefixes.length)];\nlet suffix = Math.floor(100000 + Math.random() * 900000); // 6 digits\n\npm.environment.set(\"mt_mobile\", prefix + suffix);\n\n\npm.environment.unset(\"buyer_id\");\npm.environment.unset(\"admin_user_id\");\npm.environment.unset(\"channel\");\npm.environment.unset(\"bearerToken\");\npm.environment.unset(\"payment_run_id\");", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"channel\", \"SMS\");\npm.environment.set(\"admin_user_id\", pm.response.json().id);\npm.environment.set(\"buyer_id\", pm.response.json().id);\nif (!pm.environment.has(\"preferred_ob_institution\")) pm.environment.set(\"preferred_ob_institution\", pm.response.json().supportedCurrencies?.includes(\"EUR\") ? \"unicajabanco-sandbox\" : \"natwest-sandbox\");", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2002da6c-f349-442d-8548-52ed0770c559", "name": "Get buyer details", "request": { "name": "Get buyer details", "description": { "content": "Retrieve the details of the buyer that the logged-in user belongs to.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "2c52b286-bc46-4f3c-94b6-34f78b8ca0d8", "name": "Success", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0935572\",\n \"adminUser\": {\n \"id\": \"395098173\",\n \"email\": \"gMocwv@PIjInyLJzZAQLhm.tst\",\n \"name\": \"in quis non occaecat mollit\",\n \"surname\": \"do in sunt\",\n \"mobile\": {\n \"number\": \"15639380\",\n \"countryCode\": \"+08\"\n },\n \"active\": false,\n \"emailVerified\": false,\n \"mobileNumberVerified\": false,\n \"companyPosition\": \"AUTHORISED_REPRESENTATIVE\",\n \"roles\": [\n \"CONTROLLER\"\n ],\n \"dateOfBirth\": {\n \"year\": 2072,\n \"month\": 10,\n \"day\": 14\n }\n },\n \"company\": {\n \"name\": \"sit adipisicing aute ullamco ut\",\n \"type\": \"PUBLIC_LIMITED_COMPANY\",\n \"countryOfRegistration\": \"RO\",\n \"registrationNumber\": \"pariatu\",\n \"businessAddress\": {\n \"addressLine1\": \"sunt\",\n \"city\": \"officia in Duis\",\n \"postCode\": \"zNf\",\n \"country\": \"SF\",\n \"addressLine2\": \"fugiat sit\",\n \"state\": \"sed \"\n },\n \"registeredAddress\": {\n \"addressLine1\": \"anim\",\n \"city\": \"reprehenderit officia\",\n \"country\": \"KN\",\n \"addressLine2\": \"sit\",\n \"postCode\": \"Td\",\n \"state\": \"mollit ullamco\"\n },\n \"incorporatedOn\": {\n \"year\": 1999,\n \"month\": 3,\n \"day\": 23\n }\n },\n \"acceptedTerms\": false,\n \"creationTimestamp\": -58071909,\n \"supportedCurrencies\": [\n {\n \"currency\": \"GBP\",\n \"status\": \"STEPUP_LOGIN_REQUIRED\"\n },\n {\n \"currency\": \"EUR\",\n \"status\": \"STEPUP_LOGIN_REQUIRED\"\n }\n ],\n \"tag\": \"lV\",\n \"ipAddress\": \"et Lorem aliquip non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d128a637-09d8-4356-99c0-cd3e5a79e031", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6dc4438-2549-48ba-a9b0-021c21b8edf3", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e63b883-6713-4efd-906e-fecde3a0e717", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6aaced73-5f73-4167-a13c-a54e1796be51", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53e58c57-2e1b-4fcb-88ce-af9316751403", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "addf5e74-097e-4d9b-8159-db8b498f0bfc", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6e1f0da-97b9-44ed-8d49-f0124af5a835", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de19b277-be93-453a-b266-7c8840964880", "name": "Update a buyer", "request": { "name": "Update a buyer", "description": { "content": "Update the buyer currencies and admin roles.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"adminUser\": {\n\t\t\"roles\": [\n\t\t\t\"ADMIN\",\n\t\t\t\"CREATOR\",\n\t\t\t\"CONTROLLER\"\n\t\t]\n\t}\n}" } }, "response": [ { "id": "b1c2e7a1-cb88-4aee-82d2-c189c84c5ef3", "name": "Success", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0\",\n \"adminUser\": {\n \"id\": \"742619\",\n \"email\": \"MXnm2eb3F7@C.qvhq\",\n \"name\": \"dolore aliqua\",\n \"surname\": \"ea qui Excepteur \",\n \"mobile\": {\n \"number\": \"027645186\",\n \"countryCode\": \"+1558\"\n },\n \"active\": false,\n \"emailVerified\": false,\n \"mobileNumberVerified\": true,\n \"companyPosition\": \"AUTHORISED_REPRESENTATIVE\",\n \"roles\": [\n \"CREATOR\"\n ],\n \"dateOfBirth\": {\n \"year\": 1939,\n \"month\": 1,\n \"day\": 24\n }\n },\n \"company\": {\n \"name\": \"in occaecat exercitati\",\n \"type\": \"LLC\",\n \"countryOfRegistration\": \"MT\",\n \"registrationNumber\": \"dolor no\",\n \"businessAddress\": {\n \"addressLine1\": \"ex qui fugiat\",\n \"city\": \"adipisicing magna\",\n \"postCode\": \"-WxI\",\n \"country\": \"VO\",\n \"addressLine2\": \"cillum\",\n \"state\": \"dolor\"\n },\n \"registeredAddress\": {\n \"addressLine1\": \"id\",\n \"city\": \"commodo Excepteur magna adipisici\",\n \"country\": \"BI\",\n \"addressLine2\": \"incididunt occaecat\",\n \"postCode\": \"\",\n \"state\": \"par\"\n },\n \"incorporatedOn\": {\n \"year\": 2016,\n \"month\": 4,\n \"day\": 5\n }\n },\n \"acceptedTerms\": true,\n \"creationTimestamp\": 73088535,\n \"supportedCurrencies\": [\n {\n \"currency\": \"EUR\",\n \"status\": \"ACTIVE\"\n },\n {\n \"currency\": \"EUR\",\n \"status\": \"PENDING_CREATION\"\n }\n ],\n \"tag\": \"t0sHw8TAdqX\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f4cc8a8-e6ea-4b59-be5a-d94a0d3c7e5a", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce45d638-9f5c-4b8d-b220-8a7bd3f59eff", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e92cf39d-c6ea-47bd-83e7-d5d8d84d6a76", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"STEP_UP_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8de3ab70-e747-4e9e-961f-3744289e9b3a", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CURRENCY_UNSUPPORTED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4356a5c7-dbd6-42ff-b01f-be292b2bf9a1", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a31b4eab-1111-4c88-ac04-a000a233e244", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "538cf2a3-8ea7-4011-9dc4-8e1b1ba9055b", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdf95678-6197-4735-83cb-b1e0bc4a7f99", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"roles\": [\n \"\"\n ]\n },\n \"supportedCurrencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb3d200f-092c-427b-a9ab-5ef846ff1317", "name": "Start admin user email verification", "request": { "name": "Start admin user email verification", "description": { "content": "The first step in verifying a admin user's email. The admin user whose email address is to be verified is sent an email containing a randomly generated code.\n\nThis code must then be provided in the _buyerAdminUserEmailVerify_ operation to verify the admin user's email address.\n\n_Note that on the Sandbox Environment, the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{buyer_name}}@example.com\"\n}" } }, "response": [ { "id": "65209d4b-06b9-49ff-a246-aae5b202d7d1", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be8c698c-fcff-4dfc-9cac-c1ba0c04c5a4", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9823881a-3019-4342-8598-5f8ac85ba99f", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ea0cc97-4d9b-4092-a62b-e9e58d7ab2a0", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86f4925d-75ed-4190-9c48-11000b0b5066", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"ALREADY_VERIFIED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c444b12-b882-4772-8ee4-59cd3c97829b", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32b66c4c-23f1-47a0-8440-d198dd8127b1", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bccef2bd-0045-4510-83ff-d151e3465961", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff499383-2d18-4e23-96ec-47780ee9363e", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e442a229-18ae-417b-9a33-dd65178e535a", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15fa08a8-ec89-4b30-b238-8b85564628e8", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8353982a-bd37-4bc1-a739-0ba82ab59731", "name": "Verify admin user email", "request": { "name": "Verify admin user email", "description": { "content": "The second step in verifying the admin user's email. The randomly generated code sent to the admin user via\nemail, using the _buyerAdminUserEmailVerificationCodeSend_ operation, is submitted here to verify the admin user's email.\n\nThis is needed as part of the verification process for basic due diligence.\n\n_Note that on the Sandbox Environment, the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "buyers", "verification", "email", "verify"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{buyer_name}}@example.com\",\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "02fd87d4-de40-4755-a477-9c9dca878f12", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a161d2a9-b661-4296-b038-4720630a955b", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c3be7f7-5106-4324-88d7-121e84dfdf96", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61b2cd97-4594-405d-a822-c4b22f40754e", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8bab37d-0dd5-4d35-b12b-23634573b996", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"VERIFICATION_CODE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b14281ae-0d26-4a3a-bc20-ebb51c8dc413", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "37aff53b-2510-476a-8143-ddda1f0a056c", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98d8b231-be9e-4f16-833c-87872e0115fc", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e115a552-5139-4009-bd80-3a16e4533615", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd32c250-9aaa-4e6c-b818-e3438a99cfc4", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8961f4a2-e896-4f79-a653-3bf49328ff55", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe0ef587-50e7-4c98-abfa-3c3ec1ee9a2f", "name": "Start buyer KYB", "request": { "name": "Start buyer KYB", "description": { "content": "Buyers need to complete due diligence (KYB) before they can create payment runs and pay their suppliers.\n\nThis operation initiates the due diligence process for the buyer that the logged-in user belongs to.\n\nDue Diligence is handled by a KYB provider - you will need to embed the KYB UI Component in your application so that the buyer will be able to perform the KYB process.\n\nTo initialise the KYB UI Component, you need a `reference` that is given you in the response of this operation.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "76a3a0f4-f3a5-4f9d-b275-8769825e5a61", "name": "Success", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reference\": \"7700727797\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "317ae2da-7cae-45c1-9e92-7ac6bb806b27", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d38614c-dcb4-46a9-be40-408320319acf", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51ebbfae-d832-434d-b084-15424cbc4968", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b3de018-ec24-48b1-b89d-bb5eb9c1d356", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"KYB_PENDING_REVIEW\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e06697ae-f990-4cb0-a13d-21af5f1657d0", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21218438-858d-4db6-bce0-35b08b9b1742", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4a4267eb-895b-4e5d-acc0-e78a12ced828", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3129a04-554b-4ceb-b6f4-f09475289850", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a505b4a-818c-41c3-a1f7-0dfc2dc53f9d", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5576eb32-2c11-4368-bc8d-8269335c0147", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_kyb\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff17bd40-b4a1-4044-80cf-d63fe207cc56", "name": "Get buyer KYB status", "request": { "name": "Get buyer KYB status", "description": { "content": "Returns the KYB status for the buyer that the logged-in user belongs to.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "1e652e3b-045d-4e69-b58b-b058cb927fb3", "name": "Success", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"kybStatus\": \"INITIATED\",\n \"ongoingKybStatus\": \"APPROVED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36d58ba0-db0d-4249-94c9-645b1f09bfd1", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "148ecc3e-8d36-4b91-92c6-7190a39df0f5", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17fd18c9-3889-4b99-b7d6-6b8660f9a771", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96d73b45-ebd1-4348-bd5e-ae56ed3b246a", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39a72f81-c33d-4470-88a1-00696ed329b0", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "189c112d-077a-46d5-9cdc-2e4b0a77fbd1", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cb591cf-71cb-41dd-889e-7babc235d784", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37d33851-7a54-4652-aa17-a026e59c2e4c", "name": "Update Buyer's KYB details", "request": { "name": "Update Buyer's KYB details", "description": { "content": "Update the details of the buyer that the logged-in user belongs to.\n\nThe following Buyer details are verified during due diligence (KYB) and cannot be updated via the API once the Buyer has been verified:\n- Admin User Name\n- Admin User Surname\n- Admin User Email\n- Admin User Mobile Country Code\n- Admin User Mobile Number\n- Admin Date of Birth\n- Company Business Address\n\n*If these details need to be changed after due diligence is completed, please contact Customer Support to restart the Due Diligence process.*\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a25e2e4f-aaac-4776-9741-cf908f34e183", "name": "Success", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0\",\n \"adminUser\": {\n \"id\": \"742619\",\n \"email\": \"MXnm2eb3F7@C.qvhq\",\n \"name\": \"dolore aliqua\",\n \"surname\": \"ea qui Excepteur \",\n \"mobile\": {\n \"number\": \"027645186\",\n \"countryCode\": \"+1558\"\n },\n \"active\": false,\n \"emailVerified\": false,\n \"mobileNumberVerified\": true,\n \"companyPosition\": \"AUTHORISED_REPRESENTATIVE\",\n \"roles\": [\n \"CREATOR\"\n ],\n \"dateOfBirth\": {\n \"year\": 1939,\n \"month\": 1,\n \"day\": 24\n }\n },\n \"company\": {\n \"name\": \"in occaecat exercitati\",\n \"type\": \"LLC\",\n \"countryOfRegistration\": \"MT\",\n \"registrationNumber\": \"dolor no\",\n \"businessAddress\": {\n \"addressLine1\": \"ex qui fugiat\",\n \"city\": \"adipisicing magna\",\n \"postCode\": \"-WxI\",\n \"country\": \"VO\",\n \"addressLine2\": \"cillum\",\n \"state\": \"dolor\"\n },\n \"registeredAddress\": {\n \"addressLine1\": \"id\",\n \"city\": \"commodo Excepteur magna adipisici\",\n \"country\": \"BI\",\n \"addressLine2\": \"incididunt occaecat\",\n \"postCode\": \"\",\n \"state\": \"par\"\n },\n \"incorporatedOn\": {\n \"year\": 2016,\n \"month\": 4,\n \"day\": 5\n }\n },\n \"acceptedTerms\": true,\n \"creationTimestamp\": 73088535,\n \"supportedCurrencies\": [\n {\n \"currency\": \"EUR\",\n \"status\": \"ACTIVE\"\n },\n {\n \"currency\": \"EUR\",\n \"status\": \"PENDING_CREATION\"\n }\n ],\n \"tag\": \"t0sHw8TAdqX\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddde9717-6265-48cf-8a64-096db790ab56", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a2f64b1-d4b3-4c3e-b0f1-bee357bad340", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4df95ba-d2e9-4c5d-b947-04e2e4de3b90", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea9dd0e-4181-4b99-9901-b5257935636b", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CURRENCY_UNSUPPORTED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a31842d-756b-4c07-a489-b2849cbee3f7", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfe61461-9353-40c1-9e04-81914ace8ae8", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ef8f52c-ecb9-455c-adc2-4e9828367d60", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dd041e1c-b8ad-4396-b976-4ac67090927f", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"company\": {\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Instruments - Linked Accounts", "item": [ { "id": "842fad6f-5a76-453f-b7f0-2ac85f6e6b14", "name": "Get Linked accounts", "request": { "name": "Get Linked accounts", "description": { "content": "Retrieves the linked accounts belonging to the buyer that the logged-in user belongs to.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "f3c153ae-69c6-46e6-a4d8-2ef268952414", "name": "OK", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"linkedAccounts\": [\n {\n \"id\": \"652d25b73541d8084a88a38d\",\n \"accountIdentification\": {\n \"accountNumber\": \"23403156\",\n \"sortCode\": \"397834\",\n \"secondaryReference\": \"esse c\"\n },\n \"currency\": \"EUR\",\n \"institution\": {\n \"countries\": [\n \"GB\",\n \"SI\"\n ],\n \"displayName\": \"labore\",\n \"images\": {\n \"icon\": \"ut incididunt pariatur\",\n \"logo\": \"sint veniam commodo laborum\"\n },\n \"info\": {\n \"loginUrl\": \"dolore exercitation occaecat laboris deserunt\",\n \"helplinePhoneNumber\": \"dolore Lorem incidid\"\n }\n },\n \"consent\": {\n \"expiresAt\": \"1983-06-15T13:07:01.371Z\",\n \"expiresIn\": -25065302,\n \"status\": \"EXPIRED\"\n },\n \"status\": \"UNLINKED\",\n \"friendlyName\": \"tempor nostrud\"\n },\n {\n \"id\": \"652d25b73541d8084a88a38d\",\n \"accountIdentification\": {\n \"accountNumber\": \"84908480\",\n \"sortCode\": \"349179\",\n \"secondaryReference\": \"officia consectetur reprehenderit Duis\"\n },\n \"currency\": \"GBP\",\n \"institution\": {\n \"countries\": [\n \"ES\",\n \"HU\"\n ],\n \"displayName\": \"ut in dolore exercitation\",\n \"images\": {\n \"icon\": \"velit reprehender\",\n \"logo\": \"ni\"\n },\n \"info\": {\n \"loginUrl\": \"irure elit anim adipisicing aute\",\n \"helplinePhoneNumber\": \"ea id quis\"\n }\n },\n \"consent\": {\n \"expiresAt\": \"1969-01-13T08:07:19.629Z\",\n \"expiresIn\": -51757873,\n \"status\": \"ACTIVE\"\n },\n \"status\": \"LINKED\",\n \"friendlyName\": \"cillum\"\n }\n ],\n \"count\": 49874675,\n \"responseCount\": -46205383\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b77ceea7-e7d4-4d09-919c-08cdc922efb2", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feea8b8d-84cc-4be0-a69b-df33e20b7e6c", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "749afc8e-bf07-4f63-869b-edb17d0503e1", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2c63201-c977-4a66-ad61-e493246d9460", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f93b05c-a6e5-4096-a81a-0e4492a1ee82", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aafbf060-5af1-47b5-9474-9c1109d1ff04", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4207796-4c8f-4c55-9b91-c6c4094d8b28", "name": "Error", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\nconst institutionId = pm.environment.get(\"useMockBank\") ? \"mock-bank\" : (pm.environment.get(\"preferred_ob_institution\") ?? \"natwest-sandbox\");\nconst foundLinkedAccount = pm.response.json().linkedAccounts?.find((acc) => acc?.status === \"LINKED\" && acc?.consent?.status === \"ACTIVE\");\npm.test(\"Linked account using \" + institutionId + \" is returned\", function() { pm.expect(foundLinkedAccount).to.be.ok; });\npm.environment.set('linked_account_id', foundLinkedAccount?.id);\npm.environment.set('consent_id', foundLinkedAccount?.consentId);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61c34234-3c62-4447-aef1-81d0e984e9e4", "name": "Get Linked account", "request": { "name": "Get Linked account", "description": { "content": "Retrieves a linked account of the buyer that the logged-in user belongs to.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": ["v1", "linked_accounts", "{{linked_account_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "ba03642c-64ed-4899-95eb-df33d12f9396", "name": "OK", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"652d25b73541d8084a88a38d\",\n \"accountIdentification\": {\n \"accountNumber\": \"38575004\",\n \"sortCode\": \"817615\",\n \"secondaryReference\": \"culpa nostrud consequat mollit\"\n },\n \"currency\": \"EUR\",\n \"institution\": {\n \"countries\": [\n \"AT\",\n \"BG\"\n ],\n \"displayName\": \"cillum pariatur velit est\",\n \"images\": {\n \"icon\": \"minim eiusmod qui\",\n \"logo\": \"amet sed dolor consectetur ipsu\"\n },\n \"info\": {\n \"loginUrl\": \"occaecat ut\",\n \"helplinePhoneNumber\": \"do ut velit\"\n }\n },\n \"consent\": {\n \"expiresAt\": \"1978-08-07T17:51:11.583Z\",\n \"expiresIn\": 87716939,\n \"status\": \"REVOKED\"\n },\n \"status\": \"PENDING_VERIFICATION\",\n \"friendlyName\": \"culpa officia ad\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1959f094-3eb2-4533-9972-c52aefe0a9fc", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f3e325f-77e6-4bc9-a130-d3b262873550", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eee0806e-69f0-4b21-bd13-5a4c08f001d1", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ab5bed8-b730-4bd4-97b6-8f9df899b2c4", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd7a71e6-1a56-4889-ad83-4fad18df88d4", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8639353b-69b9-45e0-92aa-a6805875d3ce", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e64790e0-0b99-4806-bb04-fee073413ae8", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6dbeaf9c-5b5a-4343-984b-0119012178f6", "name": "Error", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9bcacec-d577-49bd-ad0f-1ddaee9fba4d", "name": "Update a linked account", "request": { "name": "Update a linked account", "description": { "content": "Updates properties of a linked account such as friendly name.\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": ["v1", "linked_accounts", "{{linked_account_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4c2b65c9-3e1d-43d9-a1d0-297804bd1ffa", "name": "OK", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"652d25b73541d8084a88a38d\",\n \"accountIdentification\": {\n \"accountNumber\": \"38575004\",\n \"sortCode\": \"817615\",\n \"secondaryReference\": \"culpa nostrud consequat mollit\"\n },\n \"currency\": \"EUR\",\n \"institution\": {\n \"countries\": [\n \"AT\",\n \"BG\"\n ],\n \"displayName\": \"cillum pariatur velit est\",\n \"images\": {\n \"icon\": \"minim eiusmod qui\",\n \"logo\": \"amet sed dolor consectetur ipsu\"\n },\n \"info\": {\n \"loginUrl\": \"occaecat ut\",\n \"helplinePhoneNumber\": \"do ut velit\"\n }\n },\n \"consent\": {\n \"expiresAt\": \"1978-08-07T17:51:11.583Z\",\n \"expiresIn\": 87716939,\n \"status\": \"REVOKED\"\n },\n \"status\": \"PENDING_VERIFICATION\",\n \"friendlyName\": \"culpa officia ad\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5adcb8f7-fa3a-4adf-aca3-6c9c774223a2", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc5b2502-26cc-42ec-bdc6-1571f8965ecb", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc31d800-00a6-4de3-aa50-c5e91926bf8e", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da000508-f030-4d2b-98b1-ff9b6a0412f2", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7d60164-a50e-4f83-a71a-6683ec67b32b", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"LINKED_ACCOUNT_INVALID_STATE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98223480-e74e-43f9-831a-d86f343a7dd8", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fa9d3d01-7d3a-4c53-9ee8-0144a2438ad2", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f9f0e82-2149-4484-b3fb-010deef3f3f4", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60593ddc-caeb-45d8-915c-204bc258c0cc", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "25a4dce1-ecda-4441-a344-7b2fcee45ceb", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "44eecd9d-85af-4347-8ca3-0ca4afd2388d", "name": "Error", "originalRequest": { "url": { "path": ["v1", "linked_accounts", ":linked_account_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"friendlyName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d6a35b3-891f-464b-9a3a-a4315faf1d1b", "name": "Unlink a linked account", "request": { "name": "Unlink a linked account", "description": { "content": "Unlinks a linked account identified by the `linked_account_id`.\n\nThis action is not reversible and if the buyer wants to use this linked account again to fund payment runs, they will have to re-link the account. More information on how to link an account can be found [here](https://docs.weavr.io/payment-run/instruments/link-account/).\n\nDetails of an unlinked account, can still be retrieved via the [Get linked accounts](#operation/getLinkedAccounts) and [Get linked account](#operation/getLinkedAccountsId) endpoints.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": [ "v1", "linked_accounts", "{{linked_account_id}}", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "a3b40f50-a422-467b-849f-04f0687f038e", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"652d25b73541d8084a88a38d\",\n \"accountIdentification\": {\n \"accountNumber\": \"38575004\",\n \"sortCode\": \"817615\",\n \"secondaryReference\": \"culpa nostrud consequat mollit\"\n },\n \"currency\": \"EUR\",\n \"institution\": {\n \"countries\": [\n \"AT\",\n \"BG\"\n ],\n \"displayName\": \"cillum pariatur velit est\",\n \"images\": {\n \"icon\": \"minim eiusmod qui\",\n \"logo\": \"amet sed dolor consectetur ipsu\"\n },\n \"info\": {\n \"loginUrl\": \"occaecat ut\",\n \"helplinePhoneNumber\": \"do ut velit\"\n }\n },\n \"consent\": {\n \"expiresAt\": \"1978-08-07T17:51:11.583Z\",\n \"expiresIn\": 87716939,\n \"status\": \"REVOKED\"\n },\n \"status\": \"PENDING_VERIFICATION\",\n \"friendlyName\": \"culpa officia ad\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f11e483-7bc1-4a9c-9ddd-2d5a9f8710c6", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bc8176c-bd72-47f8-9035-199746fc50f6", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2333bc06-e6d9-4db6-881a-644a3db62983", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a24eac50-fd9b-448b-94a2-e738d3bf8b4f", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30cfd943-cd3d-4f55-b4ee-0610fcdfcddb", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"LINKED_ACCOUNT_INVALID_STATE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3db43cec-23b2-4725-a149-ecf6bd2aaa3e", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3847c7d6-c523-4e40-b4e1-9a7acd2f6966", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c9125019-8ee9-4cae-9d0c-8f57e9c7ae49", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "30d3b9db-9283-4916-b767-b4bfc4cb8e94", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "13cecbc6-defb-4972-b143-f9b855203739", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "77d32e83-6789-4b6d-8af7-8f946f0ad147", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "linked_accounts", ":linked_account_id", "unlink" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) The unique identifier of the linked account." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Institutions - Institutions", "item": [ { "id": "a6b30267-f0b6-4877-8b98-5831c16f6c5a", "name": "Get Institutions", "request": { "name": "Get Institutions", "description": { "content": "Retrieves the `Institutions` supported by Embedded Payment Run. The response payload should list all the institutions.\n\nPayment runs are funded from linked bank accounts provided by one of the supported institutions.\n\nWe recommend that you enable Buyers to check if their banks are supported before they start the registration and onboarding process.\n", "type": "text/plain" }, "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "DE", "disabled": false }, { "key": "institutionIds[]", "value": "ing", "disabled": false }, { "key": "institutionName", "value": "ing", "disabled": false }, { "key": "market", "value": "EEA", "disabled": false }, { "key": "offset", "value": "0", "disabled": false }, { "key": "limit", "value": "100", "disabled": false } ], "variable": [] }, "header": [{ "key": "Accept", "value": "application/json" }], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b96f5585-f3a2-43e2-bfe9-441c7de0e0d5", "name": "OK", "originalRequest": { "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionName", "value": "" }, { "key": "market", "value": "" }, { "key": "market", "value": "" }, { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 10,\n \"institutions\": [\n {\n \"id\": \"est voluptate eu Duis\",\n \"countries\": [\n \"incididunt culpa\",\n \"do sunt\"\n ],\n \"displayName\": \"in\",\n \"markets\": [\n \"UK\",\n \"EEA\"\n ],\n \"currencies\": [\n \"EUR\",\n \"EUR\"\n ],\n \"images\": {\n \"logo\": \"http://DhwdOxkQWHsNQqakBf.hdsQgngxeJmINdcRhZc-NLjrmtFWMGYOsREWqa0,uU.I+RJtCroYKww5soZGJkXFqv62J\",\n \"icon\": \"http://XLF.nmmhjIXHd.I2fpG-obeSYKcFSTjSkzKLWF9tFmZr3b\"\n }\n },\n {\n \"id\": \"Excepteur fugiat\",\n \"countries\": [\n \"ad dolor proident nisi occaecat\",\n \"dolor eu\"\n ],\n \"displayName\": \"in aliquip laboris ex\",\n \"markets\": [\n \"EEA\",\n \"UK\"\n ],\n \"currencies\": [\n \"EUR\",\n \"EUR\"\n ],\n \"images\": {\n \"logo\": \"http://Zba.tyiqLbTwtzVIWQJ4aJw7Jb4WluCDCA-MXg\",\n \"icon\": \"http://mGgcAQXqKUwQJ.vjYr2mJG\"\n }\n }\n ],\n \"responseCount\": 100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd4d4f93-7d97-4795-bf4b-26307e6be6b9", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionName", "value": "" }, { "key": "market", "value": "" }, { "key": "market", "value": "" }, { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4ee7285-0ea4-4bcf-8084-b870226cb348", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionName", "value": "" }, { "key": "market", "value": "" }, { "key": "market", "value": "" }, { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dc0f602b-e751-411d-9421-f23c8468b7a9", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionName", "value": "" }, { "key": "market", "value": "" }, { "key": "market", "value": "" }, { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e6c3afa-ab75-4a9d-89ee-74f4a3819d53", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionName", "value": "" }, { "key": "market", "value": "" }, { "key": "market", "value": "" }, { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf1d8d08-d31d-4273-af3d-b09f058eafe9", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionName", "value": "" }, { "key": "market", "value": "" }, { "key": "market", "value": "" }, { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1367ced2-6b33-4fe5-b781-7d87f7aaecf8", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionName", "value": "" }, { "key": "market", "value": "" }, { "key": "market", "value": "" }, { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a8402e9a-d91d-4034-8cff-1b4726af1d1d", "name": "Error", "originalRequest": { "url": { "path": ["v1", "institutions"], "host": ["{{baseUrl}}"], "query": [ { "key": "country", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionIds", "value": "" }, { "key": "institutionName", "value": "" }, { "key": "market", "value": "" }, { "key": "market", "value": "" }, { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Simulators - Simulator", "item": [ { "id": "b7460b58-0994-4ba8-8661-99b47ea0623d", "name": "Simulate Fund a Payment run", "request": { "name": "Simulate Fund a Payment run", "description": { "content": "Simulate funding a payment run using a linked account.\n\n*This endpoint will only function in Sandbox and should not be used in the Live environment.*\n", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "payment_runs", "{{payment_run_id}}", "fund_group", "{{reference}}" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [{ "key": "Accept", "value": "application/json" }], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d0d9ab24-5ede-4e03-a66a-4cc152b5dd45", "name": "Success", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [{ "key": "Content-Type", "value": "text/plain" }], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "271533c4-4175-4987-b4ac-2a0aa6d33368", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f61fb26-1036-45fe-8062-bbdd799fe199", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d1ebc34-ac49-4552-aafc-2c7c2922a51b", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2fc8d7d-3650-4281-bc9b-f3b9cf3c92d9", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7185015c-dcb0-4977-b54d-4769f72bc7ed", "name": "Conflict", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"BUYER_ID_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "624607b8-0348-482c-a7df-53e397c0d95b", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c300ff4a-2537-4d91-ac4d-248374af614f", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "50c32867-3354-47c9-979b-d4afa7d89cf8", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_runs", ":payment_run_id", "fund_group", ":reference" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "reference", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fbab829-20b2-4dcf-88ef-fee7cfc1ce4d", "name": "Simulate creation of a linked account", "request": { "name": "Simulate Creating a Linked Account via Open Banking", "description": { "content": "The Linked Account Simulator allows you to create a simulated linked account that can be used for funding payment runs.\n\n*This endpoint will only function in Sandbox and should not be used in the Live environment.*\n", "type": "text/plain" }, "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"institutionId\": \"modelo-sandbox\",\n\t\"buyerId\": \"{{buyer_id}}\",\n\t\"createdBy\": \"{{user_id}}\",\n\t\"accountIdentification\": {\n\t\t\"accountNumber\": \"{{$randomBankAccount}}\",\n\t\t\"sortCode\": \"{{random_sort_code}}\"\n\t}\n}" } }, "response": [ { "id": "f874dd9a-67f8-4fdd-8581-44592344325f", "name": "OK", "originalRequest": { "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"buyerId\": \"\",\n \"accountIdentification\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"institutionId\": \"\",\n \"createdBy\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"652d25b73541d8084a88a38d\",\n \"accountIdentification\": {\n \"accountNumber\": \"51265944\",\n \"sortCode\": \"859989\",\n \"secondaryReference\": \"ipsum Excepteur laborum velit ullamco\"\n },\n \"currency\": \"EUR\",\n \"institution\": {\n \"countries\": [\n \"IE\",\n \"BE\"\n ],\n \"displayName\": \"exercitation mollit\",\n \"images\": {\n \"icon\": \"culpa esse\",\n \"logo\": \"exer\"\n },\n \"info\": {\n \"loginUrl\": \"culpa dolor \",\n \"helplinePhoneNumber\": \"quis exercitation ullamco\"\n }\n },\n \"consent\": {\n \"expiresAt\": \"1992-06-27T12:58:34.025Z\",\n \"expiresIn\": -22999221,\n \"status\": \"ACTIVE\"\n },\n \"status\": \"PENDING_CHALLENGE\",\n \"friendlyName\": \"consequat quis qui\",\n \"createdAt\": \"Duis deserunt\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d30016e-2a57-455a-a263-822ad99b87d1", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"buyerId\": \"\",\n \"accountIdentification\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"institutionId\": \"\",\n \"createdBy\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80067b57-5fd5-4c92-8827-a3ef78bc429e", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"buyerId\": \"\",\n \"accountIdentification\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"institutionId\": \"\",\n \"createdBy\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "324c3f84-e5fb-4795-9632-a2e877c820be", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"buyerId\": \"\",\n \"accountIdentification\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"institutionId\": \"\",\n \"createdBy\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a923ae5-2660-4b3f-ad77-5f2d4d7f6ed4", "name": "Conflict", "originalRequest": { "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"buyerId\": \"\",\n \"accountIdentification\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"institutionId\": \"\",\n \"createdBy\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"BUYER_ID_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d283a2a-7cac-44d6-b1a4-daab2e178049", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"buyerId\": \"\",\n \"accountIdentification\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"institutionId\": \"\",\n \"createdBy\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "542ca6b8-054e-48db-b920-cd8cb688476b", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"buyerId\": \"\",\n \"accountIdentification\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"institutionId\": \"\",\n \"createdBy\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21b7f222-e113-4e82-b545-146d6f6c2a13", "name": "Error", "originalRequest": { "url": { "path": ["simulate", "v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"buyerId\": \"\",\n \"accountIdentification\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"institutionId\": \"\",\n \"createdBy\": \"\",\n \"currency\": \"GBP\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "let randomSortCode = Math.floor(Math.random() * 1000000).toString().padStart(6, '0');\npm.environment.set(\"random_sort_code\", randomSortCode);", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 201\", function () {\n\tpm.response.to.have.status(201);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f392e71f-19a6-4b03-9dd2-02810cd0a1d2", "name": "Simulate Control Check via Test Funding Transaction", "request": { "name": "Simulate Control Check via Test Funding Transaction", "description": { "content": "Simulate Control Check via Test Funding Transaction", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "linked_accounts", "{{linked_account_id}}", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [{ "key": "Accept", "value": "application/json" }], "method": "POST", "auth": null }, "response": [ { "id": "9cd24a99-f0dc-424c-a6fe-39ac7b3d93d5", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "828890a0-56bb-49b4-bd97-4d20987e030e", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6078c4c9-7a8f-4671-93e3-0adea23156dd", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4226503e-e8f8-4968-878e-f9805c9b3782", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92739856-a74a-4370-8ad4-68ba9c24e8f1", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbfd5525-7e99-4984-bbb2-04fc16b487c8", "name": "Conflict", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"STATE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dd7e037-676a-4e85-a8a8-3138aeea5e4c", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb23590c-d0d5-4e8a-809d-c023a177aee0", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8750539e-ba22-4a44-9fe4-904d558f043e", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id", "fund" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2572b53-5f38-496f-aede-d18f2dd6f61e", "name": "KYB simulate verify", "request": { "name": "Simulate Buyer KYB Verify", "description": { "content": "Simulates due diligence (KYB) for Buyers.\n\n*This endpoint will only function in Sandbox and should not be used in the Live environment.*\n", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "buyers", "{{buyer_id}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "programme-key", "value": "{{apiKey}}" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0985ff27-b3b9-4d4a-bd11-e9a9420e9fe9", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83a94b4e-3641-4ed1-b59a-20d8d6ca5130", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3173bf0-9ccc-4089-8dff-d4869b0bd9c3", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d58eb2f-58ba-4f91-ad76-79b695dc5092", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5918fef9-d627-490a-8eae-333e7e46960f", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb26859e-bc2b-427d-b1c7-0e4215bdb23e", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d04a37a5-8d5e-4531-9bbf-6cfd91bc4fa6", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e09e91a9-fe5c-45af-96c9-d751184799f0", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_kyb\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"multiUrl\")) { pm.environment.set(\"multiUrl\", 'https://qa.weavr.io'); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});\nsetTimeout(function() {\n console.log(\"Add a delay to give time for verification to be registered on the simulator.\");\n}, 10000);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59a3d322-ba64-41d6-a0eb-6b0987117e54", "name": "Simulate AIS consent status change", "request": { "name": "Simulate AIS consent status change", "description": { "content": "Simulate AIS consent status change.\n\n*This endpoint will only function in Sandbox and should not be used in the Live environment.*\n", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "consents", "{{linked_account_id}}", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "04441c84-c255-48d8-87df-98ae0fa5992a", "name": "No Content", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [{ "key": "Content-Type", "value": "text/plain" }], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce36c1b4-04af-4074-a47f-9ef71c2cff18", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23780611-dd06-4a9a-877d-e3ab1f9253ad", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4e2efbcb-91af-4209-871f-8c85f301f782", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "707f3d2b-80fd-4775-a279-95c8e8213a9e", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4817f3a-7300-4beb-af24-a89811c2a6e1", "name": "Conflict", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"LINKED_ACCOUNT_NOT_FOUND\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e82b6b8-a640-41ed-a906-46689db7baa9", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "90d17316-7c1e-4eb5-81bf-9a6c55dc0f7a", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0f805bd-bf0c-4383-8d37-77c5560b0045", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":linked_account_id", "change_status" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d384afcc-8ed6-4ee3-a464-764dc9f5e0c6", "name": "Simulate issuing a Payment Run SCA Challenge", "request": { "name": "Simulate issuing a Payment Run SCA Challenge", "description": { "content": "Simulates issuing the SCA challenge for a payment run.\n\n*This endpoint will only function in Sandbox and should not be used in the Live environment.*\n", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "payment_run_sca", "{{payment_run_id}}", "challenges", "otp", "{{channel}}" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [{ "key": "Accept", "value": "application/json" }], "method": "POST", "auth": null }, "response": [ { "id": "2df8e5a2-68ab-4db6-87bd-05e905a41bb1", "name": "No Content", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [{ "key": "Content-Type", "value": "text/plain" }], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47351b48-074f-4e23-bb96-bb44ff9735a9", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f686ae0d-05b0-4b6d-bd3f-24feb60be479", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47d5b203-1753-4315-8390-9f7d7db2424a", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7d22002-21e3-48cb-91fc-aab426905964", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c794a92-57c3-4f7d-ac47-97bbc0679d10", "name": "Conflict", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHANNEL_NOT_SUPPORTED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fb8d178-ab12-47cf-a80e-54157f20d0ce", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbc69371-9731-4c1b-bfad-dd7569c43be2", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7560eb6e-a879-4a9c-bcd0-070367aef93c", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd1c10cf-01fe-4083-b878-3442aa764cd3", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67c27bc5-81db-48d2-8ee7-0776c112f6fe", "name": "Simulate verifying a payment run SCA Challenge", "request": { "name": "Simulate verifying a payment run SCA Challenge", "description": { "content": "Simulates verifying the SCA challenge for a payment run.\n\n*This endpoint will only function in Sandbox and should not be used in the Live environment.*\n", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "payment_run_sca", "{{payment_run_id}}", "challenges", "otp", "{{channel}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "39c8e9f6-20a4-438a-adbf-82094464e82c", "name": "No Content", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [{ "key": "Content-Type", "value": "text/plain" }], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e227c124-c8ea-4759-9bd7-bc1df2d320a0", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8eb32be-67bd-4e91-ade2-87f1ae4db789", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "920cd43c-bc88-4e55-8f7f-f238af7ee499", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a24853b1-62bf-4d2a-a5cd-545af0acc936", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "914cef1f-9f8b-41cf-a964-331fd5731d2a", "name": "Conflict", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"VERIFICATION_CODE_EXPIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac379d9-366b-4aae-9cdf-8c37bbcf2675", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7428bcc9-fe5e-4c1d-87a4-e0facbcf3311", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a9b0026-6508-4b3e-99c4-9959c7ea07ba", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2671a259-5c7d-43fe-986b-6df7abc86694", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "payment_run_sca", ":payment_run_id", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." }, { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier for the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Identities - Buyer Authorised Users", "item": [ { "id": "fd3880e6-3552-4eaa-ac32-015d1d405451", "name": "Create a user", "request": { "name": "Create a user", "description": { "content": "Creates a user that belongs to the buyer that the logged-in user belongs to. To Create an Authorised User you would need a stepped-up token. After calling this endpoint you need to step-up ( issue a challenge `/stepup/challenges/otp/{channel}` ). More details on how to step-up a token can be found here [Step-Up](https://docs.weavr.io/payment-run/plugin-api/plugin-api-authentication-stepup/).\n\nOnce on-boarded, users have access and manage the buyer's payment runs.\n\nUsers are assigned `roles` which limit the level of access they have and what they can do on behalf of the buyer.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"name\": \"{{user_first_name}}\",\n\t\"surname\": \"{{user_last_name}}\",\n\t\"email\": \"{{$randomEmail}}\",\n\t\"mobile\": {\n\t\t\"countryCode\": \"+356\",\n\t\t\"number\": \"{{mt_mobile}}\"\n\t},\n\t\"dateOfBirth\": {\n\t\t\"year\": 1987,\n\t\t\"month\": 6,\n\t\t\"day\": 4\n\t},\n\t\"roles\": [\n\t\t\"CREATOR\",\n\t\t\"CONTROLLER\"\n\t]\n}" } }, "response": [ { "id": "104c0c61-76da-475b-9b27-21dcecd3f592", "name": "Success", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"active\": true,\n \"buyerId\": \"8695454\",\n \"email\": \"GLPnzgo3Wa2D0-b@drVWWQAgSaknTysVYGO.feqq\",\n \"id\": \"53773669\",\n \"name\": \"ut est labore\",\n \"roles\": [\n \"CONTROLLER\"\n ],\n \"surname\": \"ut cillum \",\n \"mobile\": {\n \"number\": \"33967\",\n \"countryCode\": \"+45\"\n },\n \"dateOfBirth\": {\n \"year\": 2099,\n \"month\": 3,\n \"day\": 3\n },\n \"addedBy\": {\n \"userId\": \"3835\",\n \"rolesNames\": [\n \"ADMIN\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d9e07a-bbf9-4ac6-8eb3-712bc64bda13", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d900b2e-682c-426a-8e6d-2882206cc60c", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "056e7324-2a5d-4f93-a24b-13ca04204732", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"STEP_UP_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "149145fe-f72e-4db6-8229-7c68eb597964", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"MOBILE_OR_COUNTRY_CODE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ffd8db-4b6b-4fff-8af9-fcd0ebb1e298", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82c35014-907e-43c8-90fe-f5862ff47e58", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f910e51c-7d97-4ff4-a9ed-9440fba3bb96", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70b52f20-6495-44c1-9b32-2423bee877f0", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f61c4763-ec36-4f8b-b099-d7fc22fb2749", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f4f5bba-f4b3-4a68-b4c5-c232a0bd6e3a", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }\nif (!pm.environment.has(\"user_first_name\")) {\n pm.variables.set(\"user_first_name\", pm.variables.replaceIn(\"{{$randomFirstName}}\"));\n}\n\nif (!pm.environment.has(\"user_last_name\")) {\n pm.variables.set(\"user_last_name\", pm.variables.replaceIn(\"{{$randomLastName}}\"));\n}\n", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"user_id\", pm.response.json().id);\npm.environment.set(\"created_user_id\", pm.response.json().id);\npm.environment.set(\"created_user_email\", pm.response.json().email);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb0f5707-0014-43f4-95cb-3b9cabf6c652", "name": "Get all users", "request": { "name": "Get all users", "description": { "content": "Fetches all authorised users associated with the buyer that the logged-in user belongs to.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "disabled": false, "key": "offset", "value": "0", "description": "The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results." }, { "disabled": false, "key": "limit", "value": "100", "description": "The limit of the results for paging, starting at the offset. Limit is always capped at 100." }, { "disabled": false, "key": "active", "value": "" }, { "disabled": false, "key": "email", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "96d50762-faae-4b08-9479-483181264384", "name": "Success", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "100" }, { "key": "active", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"users\": [\n {\n \"active\": true,\n \"buyerId\": \"9\",\n \"email\": \"6RJ6If7tQjwH@dvuGnAzDP.vuhs\",\n \"id\": \"249352767\",\n \"name\": \"Excepteur exercitation adipisicing\",\n \"roles\": [\n \"CREATOR\"\n ],\n \"surname\": \"Excepteur cillum\",\n \"mobile\": {\n \"number\": \"84083188\",\n \"countryCode\": \"+34\"\n },\n \"dateOfBirth\": {\n \"year\": 1998,\n \"month\": 1,\n \"day\": 25\n },\n \"addedBy\": {\n \"userId\": \"08865\",\n \"rolesNames\": [\n \"ADMIN\"\n ]\n }\n },\n {\n \"active\": true,\n \"buyerId\": \"115044\",\n \"email\": \"YROqrzafe@HtNfPyIbvGQMwaQWzQcyExmtNyBIXuUXQ.ze\",\n \"id\": \"3713829736\",\n \"name\": \"labore quis exercitation\",\n \"roles\": [\n \"CONTROLLER\"\n ],\n \"surname\": \"nulla incididunt cillum\",\n \"mobile\": {\n \"number\": \"4099090\",\n \"countryCode\": \"+76726\"\n },\n \"dateOfBirth\": {\n \"year\": 1946,\n \"month\": 8,\n \"day\": 15\n },\n \"addedBy\": {\n \"userId\": \"954037\",\n \"rolesNames\": [\n \"ADMIN\"\n ]\n }\n }\n ],\n \"count\": 60380850,\n \"responseCount\": 47284496\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7570c5a5-c22e-4aca-b07b-70526f2f3771", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "100" }, { "key": "active", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "355cf812-885a-4a1b-8ba7-f5c243c5ceab", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "100" }, { "key": "active", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d20ff1a-1843-415a-bf12-6926818c44b4", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "100" }, { "key": "active", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36cb6b85-8787-4e68-aa94-dd970f71338d", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "100" }, { "key": "active", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b51aa756-26ab-4a31-bb1a-b8d1cb84cf2b", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "100" }, { "key": "active", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "90fda516-4a68-47f1-9d33-e641c8885ed6", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "100" }, { "key": "active", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f79d5d49-50d4-460b-b2b0-6eb5b737e156", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "100" }, { "key": "active", "value": "" }, { "key": "email", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "976fa757-5c90-4d86-9407-19fcbd8a1e2e", "name": "Get a user", "request": { "name": "Get a user", "description": { "content": "Retrieves the user identified by the `user_id` path parameter.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users", "{{user_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "2b88d3de-6913-4180-8c6a-fcd053822e1a", "name": "Success", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"active\": true,\n \"buyerId\": \"8695454\",\n \"email\": \"GLPnzgo3Wa2D0-b@drVWWQAgSaknTysVYGO.feqq\",\n \"id\": \"53773669\",\n \"name\": \"ut est labore\",\n \"roles\": [\n \"CONTROLLER\"\n ],\n \"surname\": \"ut cillum \",\n \"mobile\": {\n \"number\": \"33967\",\n \"countryCode\": \"+45\"\n },\n \"dateOfBirth\": {\n \"year\": 2099,\n \"month\": 3,\n \"day\": 3\n },\n \"addedBy\": {\n \"userId\": \"3835\",\n \"rolesNames\": [\n \"ADMIN\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00bac118-b28e-475d-89c0-6abb061115cd", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17923af0-6979-4ccd-80dc-0ff3d399299d", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4fbe166a-35dc-48be-9bd9-8e688e86a705", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba82b3f3-11ba-4089-82f0-4d2a70dca36d", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f67ae97-1590-4c1b-9146-f7b3655f0610", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34283f76-515e-4a7e-b150-8a99e5043076", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb482e51-ea14-495a-ae2d-78273998bdb2", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af98c01d-ed6a-463a-85e2-0c88e8f46b2a", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "908ee2ed-2750-4d0f-aee4-e7beb1822970", "name": "Update a user", "request": { "name": "Update a user", "description": { "content": "Update the details of a user identified by the user_id in the the path parameter. After calling this endpoint you need to step-up ( issue a challenge /stepup/challenges/otp/{channel} ). More details on how to step-up a token can be found here [Step-Up](https://docs.weavr.io/payment-run/plugin-api/plugin-api-authentication-stepup/)..\n\nOnly the fields that are specified in the request body will be updated. All other fields will remain unchanged.\n\nWhen patching a mobile number, the new mobile number should be enrolled for Additional Factors.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users", "{{user_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"name\": \"{{user_first_name}}\",\n\t\"surname\": \"{{user_last_name}}\",\n\t\"email\": \"{{$randomEmail}}\",\n\t\"mobile\": {\n\t\t\"countryCode\": \"+356\",\n\t\t\"number\": \"{{mt_mobile}}\"\n\t},\n\t\"dateOfBirth\": {\n\t\t\"year\": 1987,\n\t\t\"month\": 6,\n\t\t\"day\": 4\n\t},\n\t\"roles\": [\n\t\t\"CREATOR\",\n\t\t\"CONTROLLER\"\n\t]\n}" } }, "response": [ { "id": "c54b95e4-f707-4914-aac3-7b1deccc863d", "name": "Success", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"active\": true,\n \"buyerId\": \"8695454\",\n \"email\": \"GLPnzgo3Wa2D0-b@drVWWQAgSaknTysVYGO.feqq\",\n \"id\": \"53773669\",\n \"name\": \"ut est labore\",\n \"roles\": [\n \"CONTROLLER\"\n ],\n \"surname\": \"ut cillum \",\n \"mobile\": {\n \"number\": \"33967\",\n \"countryCode\": \"+45\"\n },\n \"dateOfBirth\": {\n \"year\": 2099,\n \"month\": 3,\n \"day\": 3\n },\n \"addedBy\": {\n \"userId\": \"3835\",\n \"rolesNames\": [\n \"ADMIN\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b02c1ca-7d1f-448f-9c4c-4756b74ed097", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2db11767-2bb5-43be-98b2-c509310168fc", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2123fbc3-f537-42ef-8b25-e7fe84c46ee1", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49cf1119-00b2-451c-895b-e6bded77e4e0", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c419749d-75b4-4e8a-b36e-4d2b6a9180e6", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"MOBILE_NO_CHANGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3e76b59-6bb9-4b47-b840-4b4c46f54e50", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ceffc13-e384-4263-bf99-75f848f7cfba", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d74bf073-685e-4fe0-a773-adf0ea04bff7", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "afb227e8-0a32-42ac-b985-00020c6bbf3c", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n \"roles\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "988d5029-eb8b-4b12-b315-f21afe13ff83", "name": "Activate a user", "request": { "name": "Activate a user", "description": { "content": "Activate the user identified by the `user_id` path parameter.\n\nBy default, any new users created will be automatically activated. This operation needs to be used only if the user was previously de-activated using the _userDeactivate_ operation, or if the user was de-activated automatically after multiple incorrect login attempts.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users", "{{user_id}}", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "c6ada53c-0946-4a80-bae1-f89b1a36fd25", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f394592a-bef6-4628-b6f5-7242a7cb35a2", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34534ca1-d2a1-4f1a-aeb7-4bca868b09be", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "41becbf9-2d0e-4b91-93a1-f77184114137", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52f5b3cf-e6c8-4fa1-a7cf-aba58956d75b", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52dafe9b-864c-4755-95fd-eb2af397d8f8", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"IDEMPOTENT_REQUEST_IN_PROGRESS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f54060c4-17d3-47f1-8a38-547e7ae5b2b9", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33955c69-e665-4f40-8a7a-5d0300cb365c", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29f14e92-b164-4084-bbc0-6d932e2b5cd5", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c9f59e5-b5d4-417a-bbf2-1dbf609e0820", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d6c49c3b-1878-49ae-94f2-7d060c00f64c", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffcc2e98-3f07-44b0-8c8d-d5a062b41f67", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "activate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a87e247d-db39-47ce-9e85-c27d408e94fc", "name": "Deactivate a user", "request": { "name": "Deactivate a user", "description": { "content": "De-activate the user identified by the `user_id` path parameter.\n\nDeactivated users cannot log in or execute any operations with their credentials.\n\nThis operations is not final and a user can be re-activated using the userActivate operation. Note that another active user would need to log in so as to re-activate the de-activated user.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users", "{{user_id}}", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "8d35b146-c1da-426a-822b-a11b3a3eec56", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62b781e4-a9af-42cb-9db6-8b3a306827e8", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6de66c70-7b3c-4cc5-882e-80690fdf5281", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a53646bf-7f70-4de4-a387-ae172e1ddb3e", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0f5e7aa-1e54-46c5-8168-b49af84eab94", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31976488-be15-4848-a659-ca5f8dd86353", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"IDEMPOTENT_REQUEST_IN_PROGRESS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93e07bfd-5210-40f2-b005-a44bdfa140fb", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b79aab80-73bc-457b-af87-474e401d0a09", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de921610-b4ec-4129-b1be-2cef187a0565", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a86ec10b-229d-4590-afa8-30367364e810", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4dc1481-b3ae-46c4-a88a-6bf8550d66ed", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "abc51345-f6ec-4325-863f-9ee339b003bb", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "deactivate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dad48153-1ae5-4a2e-b806-feb051ee89eb", "name": "Send a user invite", "request": { "name": "Send a user invite", "description": { "content": "Once a user is created using the _userCreate_ operation, the user needs to setup his/her password.\n\nAn invitation needs to be sent to the user in order to be able to set up the password for the first time. The invitation email, which remains valid for 1 month, will contain a URL having all information required to setup the password via the _userInviteConsume_.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users", "{{user_id}}", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "b9acb5b4-fb88-4ce2-9b62-bb64a304e9b1", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ae8f7777-a5c0-4008-9f41-46b781ee32ae", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "248ef43d-5e20-425a-b3ee-b3db2e739c4d", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "edb3a95b-622e-4bb3-b8b5-9e000937ac75", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c027eecb-0a72-4ba2-98ef-b540762fe653", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e14ea0c7-ca53-4b5d-8c42-ff6dbcb9da50", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INVITE_ALREADY_CONSUMED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aba1f7cc-ee83-4878-a0f4-322819ef6297", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5c2b2ec-b629-4d51-bb50-65d4fe0c0a8e", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53ecbb00-c4f8-42be-95da-f7ca471ef723", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a325ae72-0899-4521-b9cb-bea8ab01fb81", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2cd3fdf-c0d8-482a-8396-6faa58f5cb92", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea97a418-ba90-4a70-a2dd-8c26a8b8996d", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b16324a-c405-497d-9df2-f6f613f01c4f", "name": "Validate a user invite", "request": { "name": "Validate a user invite", "description": { "content": "Check if a user's invite is still valid. This operation is useful\nto avoid having the user fill in a form only to be held by a validation issue\n(eg. expired invite).\n", "type": "text/plain" }, "url": { "path": ["v1", "users", "{{user_id}}", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "08ab677e-3e7c-4fd2-b07a-baef4f4261af", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b6846048-4b17-4fad-886f-ec1e2071f955", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1685bd8d-6317-4571-9f35-23a8640b26dc", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b09bcc0-b9e5-4eb5-9752-6d61864b8940", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec2e1dc3-f740-420b-b416-6e8d5f38e808", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf30fb1a-2a18-4c33-84ec-5989fb864f84", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INVITE_OR_INVITE_CODE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dbd4e2d-24c4-46e1-8b16-ef61b9419b14", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1616151-a124-4480-8137-5273e81f3e29", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ebc2d5c3-ba7a-48e2-90f7-9be53e015dee", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "305369ee-dd25-4a91-a524-74e61a400d9d", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89815d02-c593-4bdf-8699-28048f7aeb1c", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49c8e21d-b8a2-48ad-9ce6-351ad8277335", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b9927f0-af66-4303-a5f1-e1dcf6b1a6b6", "name": "Consume a user invite", "request": { "name": "Consume a user invite", "description": { "content": "Consumes an invitation previously sent to the user via _userInviteSend_. This is needed so that the invited user sets up the password.\n\n_Note that on the Sandbox Environment, the `inviteCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "users", "{{user_id}}", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "48738b24-d9c9-441d-89dd-f7bc29829fb7", "name": "Success", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"laborum Lorem\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f641627b-2d91-4e4f-8d14-8c6abe712741", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4644e38-1d87-4440-9c85-f94f9f9ec70e", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40b80db5-47d4-43c5-8475-74e16dea218c", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb3419fb-0fc1-49ba-b100-5541c8705923", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7f8fca1-43ed-4f65-a7cd-592e2b722e24", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PASSWORD_KEY_ALREADY_IN_USE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14b1b8ed-c8dd-4589-9ade-3aec3fa904ea", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5349eefb-ef4f-406a-8ea1-aed655665e2a", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54c81274-7c7c-4b28-b300-331cef44bf4f", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53318c3e-d7ce-462a-919a-fdd0f5898b1d", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e52cfe49-7e40-41af-8f40-156b43b4742b", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "958ef598-3a01-49d9-bff6-928134f39cdf", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users", ":user_id", "invite", "consume"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inviteCode\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8c9c2b2-d8a3-4d2f-b42f-115d04537b6d", "name": "Send an email verification code to the authorised user", "request": { "name": "Send an email verification code to the authorised user", "description": { "content": "The first step in verifying an authorised user's email. The authorised user whose email address is to be verified is sent an email containing a randomly generated code.\n\nThis code must then be provided in the _authorisedUserEmailVerify_ operation to verify the authorised user's email address.\n\n_Note that on the Sandbox Environment, the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{created_user_email}}\"\n}" } }, "response": [ { "id": "b32e8bb6-d0e6-4111-9a04-19e07d4cd965", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5b85dff-50c5-4370-8b4d-ba87f67be0fc", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36ce80e6-f9c1-4039-8468-573f5583949c", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc4f7d14-2060-439a-9275-04051eee9a08", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b0c613b-0fec-45f6-a5bf-a1d27aa2f1de", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"IDEMPOTENT_REQUEST_IN_PROGRESS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bff516e5-8f4b-4187-9ec2-3f2a592f78b2", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be851b9a-1670-4f85-952d-c5ba50aae4ae", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c0fbf00-0f9e-43a3-b5da-7a9b950666d0", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d2d24a5a-fc7d-4002-a46b-8494594cb24b", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "103f529a-e9c8-44ba-a6aa-fd30d6ca6694", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fce5c857-fd6a-4eb3-814d-6b63ce85701f", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "678d45ab-b579-4d77-9f69-84d0eb4749b2", "name": "Verify email of the authorised user", "request": { "name": "Verify email of the authorised user", "description": { "content": "The second step in verifying the authorised user's email. The randomly generated code sent to the authorised user via\nemail, using the _authorisedUserEmailVerificationCodeSend_ operation, is submitted here to verify the authorised user's email.\n\nThis is needed as part of the verification process for basic due diligence.\n\n_Note that on the Sandbox Environment, the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "users", "verification", "email", "verify"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{created_user_email}}\",\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "6ffd5095-7def-4e54-a4c7-1a5c374f2b80", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "261fc565-db56-4e29-a66f-d1ddbc246de4", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d876dadd-794e-4e1b-85e8-5b4596b92783", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7befb213-3d8d-4f0f-a906-e32bc70d073a", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "211c305c-b6e6-4ce6-b0dd-7013fdb7eaf7", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"VERIFICATION_CODE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4207120-6f5e-4907-aa7d-b54bcc6cf6f9", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2bd63b2-4577-4752-8101-b0e7f22af592", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6aaac10b-46ac-4a88-a3a4-732add78a721", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ace9f8b-694c-474c-8c3c-dfad2b3c7f1e", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2c1c80f-6573-4d48-90be-a6effdeab710", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91d53376-15f9-4f51-95cf-27c1f9cd6181", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "users", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Authorisation - Additional Factors", "item": [ { "id": "443f2fb0-e30e-43ad-85d0-5fbdff2cbd0a", "name": "Enrol a user device for authentication using one-time passwords", "request": { "name": "Enrol a user device for authentication using one-time passwords", "description": { "content": "This is the first step in enrolling the logged-in user's mobile device, where a one-time password is sent to the device.\n\n_Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "authentication_factors", "otp", "{{channel}}" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "9ebab0a9-da86-4a36-840c-0a7a301dab23", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09dde4ad-1e92-47f4-9836-507373f0a5a0", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13374dd-8999-4454-8b6d-21ac50448824", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95d108ab-caa3-4bb8-b06a-31a69cf2c52c", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd451d01-5e2f-415d-82e8-71add8f863e7", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4beb1f1-066f-4bea-826f-e91c91d8ebb0", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHANNEL_ALREADY_REGISTERED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09354acb-eca4-4c30-b802-a87af4cafb02", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a0c58d1-1cd1-4e52-93fd-87540c6a8fa8", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95f58230-2e61-4941-908a-b64d4bc2639a", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11fc63ea-6223-4912-82bc-f99d537054f9", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }\npm.environment.set(\"channel\", \"SMS\");", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a5fb608-4a9f-4b1c-ad10-3d5cead89091", "name": "Verify enrolment of a user device for authentication using one-time passwords", "request": { "name": "Verify enrolment of a user device for authentication using one-time passwords", "description": { "content": "The second step in enrolling the logged-in user (root or authorised user) to use one-time-passwords to enable verification of transactions.\n\n_Note that on the Sandbox Environment, text messages are not sent and the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "authentication_factors", "otp", "{{channel}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "7cdbff73-2071-44f5-9b33-3347f310ee94", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47a4ab09-687d-4b6e-b333-c8b7a2f6327e", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9e5f382-98e4-4556-8cdb-a3d54fa43630", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f784b22-b446-4ae9-b2c2-a28fd1d42152", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f78ec4-450c-4332-9e10-d03a27c4e0cd", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cec47e6-3192-4e0f-8c08-ba397b05060f", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHANNEL_ALREADY_REGISTERED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bfb05e0-e5ea-4ea1-a118-6fe0d9b69f24", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd2aa8e7-7e67-4425-bfa6-4436eddf1321", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "743eb4fa-5512-4de9-b7e9-aa12f5344fa7", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ba27a47c-9fd0-4527-8a05-a7607afeb063", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }\npm.environment.set(\"channel\", \"SMS\");", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Authentication - Tokens", "item": [ { "id": "6126f56d-4703-4d43-829d-8f4c423d8cc7", "name": "Acquire auth token", "request": { "name": "Acquire auth token", "description": { "content": "Authenticate a user with the `email` and `password` that they provided when registering.\n\nGiven that the user credentials are correct, this returns a `token` that can then be used to authorise\nother secured operations. In case the password is expired, a temporary `token` is returned, which can be used\nsolely for updating the password.\n\nThe token returned is valid for 5 minutes from last activity.\n", "type": "text/plain" }, "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{buyer_name}}@example.com\",\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "27e1ab7a-a12f-438e-8981-f4f5ad9a29f9", "name": "OK", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"nulla id cupidatat\",\n \"tokenType\": \"AUTH\",\n \"identity\": {\n \"type\": \"BUYER\",\n \"id\": \"3453556667\"\n },\n \"credentials\": {\n \"type\": \"ADMIN\",\n \"id\": \"79221754373\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5da64f-049a-4f18-b540-fdbeef6f826a", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "378ab356-0b21-4611-930d-04c2ca396973", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53f57a66-0958-48d5-92a3-130aeec090ea", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a9f410-9287-4f40-bbe8-c68b40cbd158", "name": "The user's password has expired. Use the returned temporary token to update their password via the '_/passwords/update_' endpoint.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"id ad ut consectetur\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74bbc9a9-8154-4688-a0c3-befa87d7a2bb", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40b56f5c-7169-4573-8764-821a5926070c", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce043739-1bd4-4626-9d76-117afc9043aa", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f78be61f-d4dc-4837-9939-d28c2d26d06e", "name": "Error", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"adminBearerToken\", pm.response.json().token);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7bf27fc-e36e-4cc4-bcbb-b4723742aa47", "name": "Logout", "request": { "name": "Logout", "description": { "content": "Logs out the user and terminates the session identified by the\n`auth_token` in the Authorization Header.\n", "type": "text/plain" }, "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{creatorBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "72064602-2f23-42b6-9175-44983c223b54", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1b640257-76d0-440b-a2c7-85f2c79b4632", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "144533ac-a5d9-4c3f-9481-728a8be81eb9", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73098111-8125-419f-a96d-07407297ee26", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8151f854-97bf-4886-9399-e356896dea84", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39d803e6-3be6-4a8e-8392-8c1c68c06d0d", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31287733-ccba-44ce-9a15-398ee0dbfce8", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2e1aa1c6-11a6-4fb4-bf00-920f7659a41d", "name": "Error", "originalRequest": { "url": { "path": ["v1", "logout"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"creatorBearerToken\")) { throw new Error(\"Token 'creatorBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});\npm.environment.clear(\"creatorBearerToken\");", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Authentication - Passwords", "item": [ { "id": "782ade12-b024-4677-946c-5bd3dc20d2aa", "name": "Create a password", "request": { "name": "Create a password", "description": { "content": "Create a new password for the user identified by the `user_id` path parameter.", "type": "text/plain" }, "url": { "path": ["v1", "password", "{{user_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "83a1301b-81e6-44f3-aa9d-072bc46fbd54", "name": "OK", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"passwordInfo\": {\n \"buyerId\": \"26083907\",\n \"expiryDate\": 49738017\n },\n \"token\": \"amet et labore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "357f41ef-4ed1-4f90-b954-b1cff335bd59", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e92610a-7598-4b15-a9da-3c3f8e183671", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fca794c2-e9e6-4028-a620-97f05e35970f", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176b8a24-7caa-4cfa-939c-19dc4d8bbf9f", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7249648e-1293-4cf5-9f7e-fe07296a0453", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PASSWORD_TOO_SIMPLE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5bba16f-cc9d-454c-83d2-249381f70d3a", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0046175-0455-4d40-9000-0bb9833c5838", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcb23835-31ab-42cb-ae48-03326ea15d8b", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42445617-7ad3-4af0-9e50-9209b5129175", "name": "Error", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"adminBearerToken\", pm.response.json().token);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d0d8712-c70f-4d2d-9765-88662b2522e6", "name": "Update a password", "request": { "name": "Update a password", "description": { "content": "Update the password for the logged-in user.", "type": "text/plain" }, "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"oldPassword\": {\n\t\t\"value\": \"Pass1234!\"\n\t},\n\t\"newPassword\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "990a42bd-72b5-406f-b679-ef5d609dbf24", "name": "OK", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"passwordInfo\": {\n \"buyerId\": \"26083907\",\n \"expiryDate\": 49738017\n },\n \"token\": \"amet et labore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "472d09f0-d3be-4413-aa14-936829cd8d38", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78b4f35b-d7c6-4c38-b415-8c34ad684b60", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34c325c1-b98a-40c8-a320-4618a8b7e48c", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "797bc2aa-6447-4503-8868-2577bcc6a40d", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PASSWORD_INCORRECT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "122c167b-2fb9-49fa-b688-6c3c07d0039d", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "23e0223b-dcf2-4a92-962e-f6dc4902e98e", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47a9bd14-6db8-4277-97fd-3898144f4002", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eca465c1-870f-4284-98b8-a1a4f4fca090", "name": "Error", "originalRequest": { "url": { "path": ["v1", "passwords", "update"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPassword\": {\n \"value\": \"\"\n },\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6cf6b63-f1a3-43ed-b1a2-4ffdc435b1b1", "name": "Validate a password", "request": { "name": "Validate a password", "description": { "content": "Check that a password adheres to all complexity checks.", "type": "text/plain" }, "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "975b1caa-0b83-4f32-b770-7e1005cf2a7c", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "970971da-ad57-4b2a-ae50-4ee2fce97592", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d11994b-547c-46c9-a9d9-b06fae001113", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d520be61-5e90-42a2-b320-acf6bb5cea18", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a4d8f32-d92e-40d6-9b33-af2691b66d71", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PASSWORD_INCORRECT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3464ea74-c200-4dc1-ae36-c6123be186b7", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71cd9031-b44b-4fa1-9d55-59fe7166af7f", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "272d2403-ec9e-4844-a7df-7e25a9da0ea7", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9efc742-6e09-4bd6-b15d-c9edfe6b52ed", "name": "Error", "originalRequest": { "url": { "path": ["v1", "passwords", "validate"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3433ae5-1221-45c9-9645-0fad6da73ce9", "name": "Initiate lost password process", "request": { "name": "Initiate lost password process", "description": { "content": "Initiate the lost password process.\n\nIf the email address provided is associated with an active user, an email will be sent, containing a URL that redirects the user to change their password.\nThe URL contains request parameters for all of the parameters required to change the password for the user via the `/passwords/lost_password/resume` POST endpoint.\n", "type": "text/plain" }, "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{created_user_email}}\"\n}" } }, "response": [ { "id": "ec89f912-04bd-4a6f-8c14-cb2b48858ad2", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59c0e573-3aa2-4a40-8b93-d93ae9da0d13", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36a05c56-6f84-4f60-93ef-0548451cc7a5", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "907074f5-4942-4bae-b6f1-9255c5f11f25", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4de56f20-2e8d-467f-b381-8c7cdfce6c20", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"ACCOUNT_NOT_FOUND\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c247ce3-8c20-4d16-b8f7-06d7312f1e76", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d28f75e5-c47b-48b1-a951-978500a5a4fb", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a906e91-5479-4bb8-9d2c-44f2dffdf0f8", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95661365-c8b5-4936-b7bf-ef45681d640c", "name": "Error", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "start"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac40cbac-8dc5-44c3-97da-01223960c8c8", "name": "Resume lost password process", "request": { "name": "Resume lost password process", "description": { "content": "This is the second and final step in updating the password of a user who forgot their password.\n", "type": "text/plain" }, "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{created_user_email}}\",\n\t\"nonce\": \"123456\",\n\t\"newPassword\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "2d24278a-3e99-4459-901f-ab011f201ccd", "name": "OK", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"laborum Lorem\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c809f5d-e940-45fd-baf8-0689ec06aae5", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2acb5874-c7f1-4736-8de2-649bd8d9538f", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7fa3b110-dfd1-476f-9274-8b3b95ef0ef3", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c971cc31-2cb5-4619-a4aa-47a02df187e2", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PASSWORD_INCORRECT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "808b16d2-698f-44ff-8c3e-54ca9549df70", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9d20fb31-349b-4220-825f-8e594fadfac6", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1bf5478a-d379-4d9c-99d0-a81416cb9dbb", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "75d85c8c-1714-4558-9b25-217a8cf9b9f9", "name": "Error", "originalRequest": { "url": { "path": ["v1", "passwords", "lost_password", "resume"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"nonce\": \"\",\n \"newPassword\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Authorisation - Step up", "item": [ { "id": "9fcc8026-33e6-4c89-852c-12bcf392e4b9", "name": "Issue a one-time password that can be used to step-up a token", "request": { "name": "Issue a one-time password that can be used to step-up a token", "description": { "content": "Initiates the step-up token process by sending an SMS with an one-time-password to a device belonging to the logged-in user that was previously enrolled through `/authentication_factors/otp/{channel}` endpoint.\n\nThis process is required for endpoints that require a step-up token to complete the call.\n\n_Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "stepup", "challenges", "otp", "{{channel}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "d394ec20-303b-4f6d-bccd-99869b8396d8", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee22485f-1982-4558-b060-c6ab740bb18e", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7690f772-a3bc-4c0e-a1d8-40248a490098", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33b749a8-0232-4027-8ced-fb0e5dc9c138", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d60046-8030-4b0f-b9b6-6b85d3b62055", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58595ce7-a4f9-4c21-bac6-460051574179", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"MOBILE_NUMBER_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78f64dfb-fd92-4157-9607-3d667d6db53e", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf810f92-c174-482b-af1a-65b49ccd38f7", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee27c7d2-42fb-4132-800a-a24e8ad808ad", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0405fdc4-9dbd-42c8-9720-3f10412ba61d", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a97cc697-db9a-48c5-bbce-474baeed1641", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce32e23f-1923-4d0b-b630-245349531e59", "name": "Error", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cabeb4fb-1489-4035-a033-9f4bf07d7c2f", "name": "Verify a step-up token using a one-time password", "request": { "name": "Verify a step-up token using a one-time password", "description": { "content": "Completes the verification process for a step up token.\n\n_Note that on the Sandbox Environment, text messages are not sent and the `verificationCode` is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "stepup", "challenges", "otp", "{{channel}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "f7f8f090-fd7b-480f-a294-f689ce653b07", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e8f7e00-600d-41c6-8456-0b355f77f4b8", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a30accf3-f398-42f2-9e26-c632f281522e", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "973c8775-f47a-484d-9689-aeaa1c594e26", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d33193ad-a4c5-4843-915e-47d2a3a322a9", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f50bbd9d-aa2c-4121-92ff-164b052f8ab7", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHALLENGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25ebc943-8142-46f4-a892-c8825d655685", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d31649ff-ff44-4e6c-af24-05126ed885bd", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7cf1135-6bc8-4a23-8b67-623744dac549", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a773eda3-d551-4435-88e9-72899b9a8d08", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "240b706d-8a98-45cc-948f-fb37734bb664", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8f70a04-c064-4ac5-9767-d6eab9225178", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Simulator Linked accounts", "item": [ { "id": "35913796-fc09-40d6-b28c-99c15979c92e", "name": "Simulate Extend AIS consent", "request": { "name": "Simulate Extend AIS consent", "description": { "content": "Simulate Extend AIS consent", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "consents", "{{consent_id}}", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [{ "key": "Accept", "value": "application/json" }], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "91ec1469-1d2c-40f3-98b4-0acfd365a379", "name": "No Content", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [{ "key": "Content-Type", "value": "text/plain" }], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d08ca7d-11ab-46b8-b4fd-1fa31c1db017", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3c708f4-65c5-47ab-a37b-54805bc50b36", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1694ca37-abbc-4d88-843b-ff8625cc41b1", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aca179b4-d7ca-4f35-bfd9-d60efdbf8d81", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc61b3ad-2a92-4f48-9fc6-98c125a27fdb", "name": "Conflict", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CONSENT_EXPIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001abf1a-69e5-4568-8e4c-91308b26196a", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9800c23b-4b0a-446c-acc1-9541aa2c7664", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf81453b-5170-4f1e-9167-a459b79893a3", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "consents", ":consent_id", "extend" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "consent_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e08534ad-7ff2-4834-a501-45c9cd953a30", "name": "Simulate Delete linked account", "request": { "name": "Simulate Delete linked account", "description": { "content": "Simulate deletion of a linked account", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "linked_accounts", "{{linked_account_id}}" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [{ "key": "Accept", "value": "application/json" }], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6d218372-96f4-453e-aac6-34c3a0914df5", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "989e41c1-3bcb-4b2e-a93f-a83c29c64b3e", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9020d67-5280-43f2-813c-fd7fd8d1dce8", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f7c8c8f-9080-457e-b67e-fd7a8df932a1", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2576fa0a-f17a-4c2f-8249-27b1ed818786", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e655a3c9-f912-4306-92ee-fd1cbe2c3bb9", "name": "Conflict", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"STATE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "997a81af-de8d-4a43-a73a-403f0779370c", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "886381e2-40c8-4cf1-8e68-6f07802a8808", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cfc20d1-11f6-4f8d-984b-6adc1fc43529", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "linked_accounts", ":linked_account_id" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "linked_account_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "Workflows", "description": "Workflows", "item": [ { "name": "1. Onboard Buyer", "description": "Onboard a new buyer.", "item": [ { "id": "44218aed-4be9-4403-aa78-748b0ba61828", "name": "Create a buyer", "request": { "name": "Create a buyer", "description": { "content": "Buyers are identities representing a business. Once on-boarded, Buyers can create and manage their own instruments via your plugin. \n\nThe information provided must be accurate and will be passed on for KYB verification with our partner.\n", "type": "text/plain" }, "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"tag\": \"tag\",\n\t\"acceptedTerms\": true,\n\t\"ipAddress\": \"{{$randomIP}}\",\n\t\"company\": {\n\t\t\"name\": \"{{buyer_company_name}}\",\n\t\t\"type\": \"LLC\",\n\t\t\"countryOfRegistration\": \"GB\",\n\t\t\"registrationNumber\": \"C89893\",\n\t\t\"businessAddress\": {\n\t\t\t\"addressLine1\": \"{{$randomStreetAddress}}\",\n\t\t\t\"addressLine2\": \"address2\",\n\t\t\t\"city\": \"{{$randomCity}}\",\n\t\t\t\"postCode\": \"postc\",\n\t\t\t\"country\": \"GB\",\n\t\t\t\"state\": \"Some State\"\n\t\t}\n\t},\n\t\"adminUser\": {\n\t\t\"name\": \"{{admin_first_name}}\",\n\t\t\"surname\": \"{{admin_last_name}}\",\n\t\t\"email\": \"{{buyer_name}}@example.com\",\n\t\t\"mobile\": {\n\t\t\t\"countryCode\": \"+356\",\n\t\t\t\"number\": \"{{mt_mobile}}\"\n\t\t},\n\t\t\"companyPosition\": \"DIRECTOR\"\n\t},\n\t\"supportedCurrencies\": [\n\t\t\"GBP\"\n\t]\n}" } }, "response": [ { "id": "a6bd9bf8-4c44-498a-8d3f-ad852c10289e", "name": "Success", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"716\",\n \"adminUser\": {\n \"id\": \"069\",\n \"email\": \"XOKj8TrnuP7vSCV@hsIWzxMfI.gn\",\n \"name\": \"consectet\",\n \"surname\": \"deserunt officia ips\",\n \"mobile\": {\n \"number\": \"69342313538\",\n \"countryCode\": \"+576\"\n },\n \"active\": true,\n \"emailVerified\": true,\n \"mobileNumberVerified\": true,\n \"companyPosition\": \"AUTHORISED_REPRESENTATIVE\",\n \"roles\": [\n \"CREATOR\"\n ],\n \"dateOfBirth\": {\n \"year\": 2006,\n \"month\": 4,\n \"day\": 11\n }\n },\n \"company\": {\n \"name\": \"eiusmod aliquip pariatur deserunt\",\n \"type\": \"LLC\",\n \"countryOfRegistration\": \"RO\",\n \"registrationNumber\": \"incidi\",\n \"businessAddress\": {\n \"addressLine1\": \"consectetur mollit\",\n \"city\": \"ullamco incididunt \",\n \"postCode\": \"1FR\",\n \"country\": \"AC\",\n \"addressLine2\": \"eiusmod in\",\n \"state\": \"voluptate est qui quis ea\"\n },\n \"registeredAddress\": {\n \"addressLine1\": \"commodo amet sunt\",\n \"city\": \"elit sunt in Duis\",\n \"country\": \"RT\",\n \"addressLine2\": \"culpa dolore dolore ea\",\n \"postCode\": \"G\",\n \"state\": \"ullamco do consequat\"\n },\n \"incorporatedOn\": {\n \"year\": 2032,\n \"month\": 1,\n \"day\": 30\n }\n },\n \"acceptedTerms\": true,\n \"creationTimestamp\": -54650904,\n \"supportedCurrencies\": [\n {\n \"currency\": \"GBP\",\n \"status\": \"PENDING_KYB_APPROVAL\"\n },\n {\n \"currency\": \"EUR\",\n \"status\": \"PENDING_KYB_APPROVAL\"\n }\n ],\n \"tag\": \"tB1\",\n \"ipAddress\": \"eu in\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9231abae-d9c0-44d9-9841-4eacfccfeaca", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ca307c4-0d89-43c3-90c4-4363dde695d9", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ebd9d87-9445-4bc8-8ece-4f72de302aae", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "510b702d-382c-42a1-bcb8-de77fb8cb6e7", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CURRENCY_UNSUPPORTED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fc8bdb7-dbb1-4080-aeb2-c724665eaf56", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0be1ac3-7b48-45f7-a757-a599b7e17252", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc644f5a-ba9b-497c-8812-09f4c4fe8757", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cf77c72-bbd7-458e-9350-1d3d0a1be235", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7784883c-eb59-4927-8f79-358796c8796c", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab7ce653-e317-41bf-8af6-cef27c418a33", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adminUser\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"companyPosition\": \"\",\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n },\n \"company\": {\n \"name\": \"\",\n \"type\": \"\",\n \"countryOfRegistration\": \"\",\n \"registrationNumber\": \"\",\n \"businessAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"postCode\": \"\",\n \"country\": \"\",\n \"addressLine2\": \"\",\n \"state\": \"\"\n }\n },\n \"acceptedTerms\": \"\",\n \"ipAddress\": \"\",\n \"supportedCurrencies\": [\n \"\"\n ],\n \"tag\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "let rand = Math.floor(Date.now() / 1000);\npm.environment.set(\"buyer_name\", \"corp\" + rand);\n\nif (!pm.environment.has(\"buyer_company_name\")) {\n pm.variables.set(\"buyer_company_name\", pm.environment.get(\"buyer_name\"));\n}\n\nif (!pm.environment.has(\"admin_first_name\")) {\n pm.variables.set(\"admin_first_name\", pm.variables.replaceIn(\"{{$randomFirstName}}\"));\n}\n\nif (!pm.environment.has(\"admin_last_name\")) {\n pm.variables.set(\"admin_last_name\", pm.variables.replaceIn(\"{{$randomLastName}}\"));\n}\n\nlet prefixes = ['79','99'];\nlet prefix = prefixes[Math.floor(Math.random() * prefixes.length)];\nlet suffix = Math.floor(100000 + Math.random() * 900000); // 6 digits\n\npm.environment.set(\"mt_mobile\", prefix + suffix);\n\n\npm.environment.unset(\"buyer_id\");\npm.environment.unset(\"admin_user_id\");\npm.environment.unset(\"channel\");\npm.environment.unset(\"bearerToken\");\npm.environment.unset(\"payment_run_id\");", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"channel\", \"SMS\");\npm.environment.set(\"admin_user_id\", pm.response.json().id);\npm.environment.set(\"buyer_id\", pm.response.json().id);\nif (!pm.environment.has(\"preferred_ob_institution\")) pm.environment.set(\"preferred_ob_institution\", pm.response.json().supportedCurrencies?.includes(\"EUR\") ? \"unicajabanco-sandbox\" : \"natwest-sandbox\");", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "512d5a7b-10fe-4bed-b1c2-156eaa54a1ec", "name": "Create password for admin user", "request": { "name": "Create a password", "description": { "content": "Create a new password for the user identified by the `user_id` path parameter.", "type": "text/plain" }, "url": { "path": ["v1", "password", "{{user_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "83a1301b-81e6-44f3-aa9d-072bc46fbd54", "name": "OK", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"passwordInfo\": {\n \"buyerId\": \"26083907\",\n \"expiryDate\": 49738017\n },\n \"token\": \"amet et labore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "357f41ef-4ed1-4f90-b954-b1cff335bd59", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e92610a-7598-4b15-a9da-3c3f8e183671", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fca794c2-e9e6-4028-a620-97f05e35970f", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176b8a24-7caa-4cfa-939c-19dc4d8bbf9f", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7249648e-1293-4cf5-9f7e-fe07296a0453", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PASSWORD_TOO_SIMPLE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5bba16f-cc9d-454c-83d2-249381f70d3a", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0046175-0455-4d40-9000-0bb9833c5838", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcb23835-31ab-42cb-ae48-03326ea15d8b", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42445617-7ad3-4af0-9e50-9209b5129175", "name": "Error", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"adminBearerToken\", pm.response.json().token);", "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": "pm.environment.set(\"user_id\", pm.environment.get(\"admin_user_id\"));", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9d5f14f-8a57-4204-8c9e-4bed386f6720", "name": "Start admin user email verification", "request": { "name": "Start admin user email verification", "description": { "content": "The first step in verifying a admin user's email. The admin user whose email address is to be verified is sent an email containing a randomly generated code.\n\nThis code must then be provided in the _buyerAdminUserEmailVerify_ operation to verify the admin user's email address.\n\n_Note that on the Sandbox Environment, the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{buyer_name}}@example.com\"\n}" } }, "response": [ { "id": "65209d4b-06b9-49ff-a246-aae5b202d7d1", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be8c698c-fcff-4dfc-9cac-c1ba0c04c5a4", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9823881a-3019-4342-8598-5f8ac85ba99f", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ea0cc97-4d9b-4092-a62b-e9e58d7ab2a0", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86f4925d-75ed-4190-9c48-11000b0b5066", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"ALREADY_VERIFIED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c444b12-b882-4772-8ee4-59cd3c97829b", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32b66c4c-23f1-47a0-8440-d198dd8127b1", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bccef2bd-0045-4510-83ff-d151e3465961", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff499383-2d18-4e23-96ec-47780ee9363e", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e442a229-18ae-417b-9a33-dd65178e535a", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15fa08a8-ec89-4b30-b238-8b85564628e8", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers", "verification", "email", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49523bfe-f6d5-4b29-9d3a-d3bac9acc8bb", "name": "Verify admin user email", "request": { "name": "Verify admin user email", "description": { "content": "The second step in verifying the admin user's email. The randomly generated code sent to the admin user via\nemail, using the _buyerAdminUserEmailVerificationCodeSend_ operation, is submitted here to verify the admin user's email.\n\nThis is needed as part of the verification process for basic due diligence.\n\n_Note that on the Sandbox Environment, the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "buyers", "verification", "email", "verify"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{buyer_name}}@example.com\",\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "02fd87d4-de40-4755-a477-9c9dca878f12", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a161d2a9-b661-4296-b038-4720630a955b", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c3be7f7-5106-4324-88d7-121e84dfdf96", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61b2cd97-4594-405d-a822-c4b22f40754e", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8bab37d-0dd5-4d35-b12b-23634573b996", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"VERIFICATION_CODE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b14281ae-0d26-4a3a-bc20-ebb51c8dc413", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "37aff53b-2510-476a-8143-ddda1f0a056c", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98d8b231-be9e-4f16-833c-87872e0115fc", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e115a552-5139-4009-bd80-3a16e4533615", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd32c250-9aaa-4e6c-b818-e3438a99cfc4", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8961f4a2-e896-4f79-a653-3bf49328ff55", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "buyers", "verification", "email", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "156eefd4-9287-49dc-8690-a329d698646d", "name": "Start buyer KYB", "request": { "name": "Start buyer KYB", "description": { "content": "Buyers need to complete due diligence (KYB) before they can create payment runs and pay their suppliers.\n\nThis operation initiates the due diligence process for the buyer that the logged-in user belongs to.\n\nDue Diligence is handled by a KYB provider - you will need to embed the KYB UI Component in your application so that the buyer will be able to perform the KYB process.\n\nTo initialise the KYB UI Component, you need a `reference` that is given you in the response of this operation.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "76a3a0f4-f3a5-4f9d-b275-8769825e5a61", "name": "Success", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reference\": \"7700727797\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "317ae2da-7cae-45c1-9e92-7ac6bb806b27", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d38614c-dcb4-46a9-be40-408320319acf", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51ebbfae-d832-434d-b084-15424cbc4968", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b3de018-ec24-48b1-b89d-bb5eb9c1d356", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"KYB_PENDING_REVIEW\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e06697ae-f990-4cb0-a13d-21af5f1657d0", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21218438-858d-4db6-bce0-35b08b9b1742", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4a4267eb-895b-4e5d-acc0-e78a12ced828", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3129a04-554b-4ceb-b6f4-f09475289850", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a505b4a-818c-41c3-a1f7-0dfc2dc53f9d", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5576eb32-2c11-4368-bc8d-8269335c0147", "name": "Error", "originalRequest": { "url": { "path": ["v1", "buyers", "kyb"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_kyb\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "248a43f3-4c9b-4711-9522-e8abdae6bf32", "name": "KYB simulate verify", "request": { "name": "Simulate Buyer KYB Verify", "description": { "content": "Simulates due diligence (KYB) for Buyers.\n\n*This endpoint will only function in Sandbox and should not be used in the Live environment.*\n", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "buyers", "{{buyer_id}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "programme-key", "value": "{{apiKey}}" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0985ff27-b3b9-4d4a-bd11-e9a9420e9fe9", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83a94b4e-3641-4ed1-b59a-20d8d6ca5130", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3173bf0-9ccc-4089-8dff-d4869b0bd9c3", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d58eb2f-58ba-4f91-ad76-79b695dc5092", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5918fef9-d627-490a-8eae-333e7e46960f", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb26859e-bc2b-427d-b1c7-0e4215bdb23e", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d04a37a5-8d5e-4531-9bbf-6cfd91bc4fa6", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e09e91a9-fe5c-45af-96c9-d751184799f0", "name": "Error", "originalRequest": { "url": { "path": [ "simulate", "v1", "buyers", ":buyer_id", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "buyer_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_kyb\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"multiUrl\")) { pm.environment.set(\"multiUrl\", 'https://qa.weavr.io'); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});\nsetTimeout(function() {\n console.log(\"Add a delay to give time for verification to be registered on the simulator.\");\n}, 10000);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "376b281b-e5c0-46f6-a7af-3b02a136f254", "name": "Enrol a user device for authentication using one-time passwords", "request": { "name": "Enrol a user device for authentication using one-time passwords", "description": { "content": "This is the first step in enrolling the logged-in user's mobile device, where a one-time password is sent to the device.\n\n_Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "authentication_factors", "otp", "{{channel}}" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "9ebab0a9-da86-4a36-840c-0a7a301dab23", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09dde4ad-1e92-47f4-9836-507373f0a5a0", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13374dd-8999-4454-8b6d-21ac50448824", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95d108ab-caa3-4bb8-b06a-31a69cf2c52c", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd451d01-5e2f-415d-82e8-71add8f863e7", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4beb1f1-066f-4bea-826f-e91c91d8ebb0", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHANNEL_ALREADY_REGISTERED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09354acb-eca4-4c30-b802-a87af4cafb02", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a0c58d1-1cd1-4e52-93fd-87540c6a8fa8", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95f58230-2e61-4941-908a-b64d4bc2639a", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11fc63ea-6223-4912-82bc-f99d537054f9", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }\npm.environment.set(\"channel\", \"SMS\");", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29a1ee42-ad1a-40c4-a4d6-296ce13eda6e", "name": "Verify enrolment of a user device for authentication using one-time passwords", "request": { "name": "Verify enrolment of a user device for authentication using one-time passwords", "description": { "content": "The second step in enrolling the logged-in user (root or authorised user) to use one-time-passwords to enable verification of transactions.\n\n_Note that on the Sandbox Environment, text messages are not sent and the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "authentication_factors", "otp", "{{channel}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "7cdbff73-2071-44f5-9b33-3347f310ee94", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47a4ab09-687d-4b6e-b333-c8b7a2f6327e", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9e5f382-98e4-4556-8cdb-a3d54fa43630", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f784b22-b446-4ae9-b2c2-a28fd1d42152", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f78ec4-450c-4332-9e10-d03a27c4e0cd", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cec47e6-3192-4e0f-8c08-ba397b05060f", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHANNEL_ALREADY_REGISTERED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bfb05e0-e5ea-4ea1-a118-6fe0d9b69f24", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd2aa8e7-7e67-4425-bfa6-4436eddf1321", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "743eb4fa-5512-4de9-b7e9-aa12f5344fa7", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ba27a47c-9fd0-4527-8a05-a7607afeb063", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }\npm.environment.set(\"channel\", \"SMS\");", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d857b3d7-b8fd-406b-9b5d-64e13430d95c", "name": "Acquire auth token", "request": { "name": "Acquire auth token", "description": { "content": "Authenticate a user with the `email` and `password` that they provided when registering.\n\nGiven that the user credentials are correct, this returns a `token` that can then be used to authorise\nother secured operations. In case the password is expired, a temporary `token` is returned, which can be used\nsolely for updating the password.\n\nThe token returned is valid for 5 minutes from last activity.\n", "type": "text/plain" }, "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{buyer_name}}@example.com\",\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "27e1ab7a-a12f-438e-8981-f4f5ad9a29f9", "name": "OK", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"nulla id cupidatat\",\n \"tokenType\": \"AUTH\",\n \"identity\": {\n \"type\": \"BUYER\",\n \"id\": \"3453556667\"\n },\n \"credentials\": {\n \"type\": \"ADMIN\",\n \"id\": \"79221754373\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5da64f-049a-4f18-b540-fdbeef6f826a", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "378ab356-0b21-4611-930d-04c2ca396973", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53f57a66-0958-48d5-92a3-130aeec090ea", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a9f410-9287-4f40-bbe8-c68b40cbd158", "name": "The user's password has expired. Use the returned temporary token to update their password via the '_/passwords/update_' endpoint.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"id ad ut consectetur\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74bbc9a9-8154-4688-a0c3-befa87d7a2bb", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40b56f5c-7169-4573-8764-821a5926070c", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce043739-1bd4-4626-9d76-117afc9043aa", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f78be61f-d4dc-4837-9939-d28c2d26d06e", "name": "Error", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"adminBearerToken\", pm.response.json().token);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ba8201d-fed7-4346-ac27-eeced28c9a71", "name": "Issue a one-time password that can be used to step-up a token", "request": { "name": "Issue a one-time password that can be used to step-up a token", "description": { "content": "Initiates the step-up token process by sending an SMS with an one-time-password to a device belonging to the logged-in user that was previously enrolled through `/authentication_factors/otp/{channel}` endpoint.\n\nThis process is required for endpoints that require a step-up token to complete the call.\n\n_Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "stepup", "challenges", "otp", "{{channel}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "d394ec20-303b-4f6d-bccd-99869b8396d8", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee22485f-1982-4558-b060-c6ab740bb18e", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7690f772-a3bc-4c0e-a1d8-40248a490098", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33b749a8-0232-4027-8ced-fb0e5dc9c138", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d60046-8030-4b0f-b9b6-6b85d3b62055", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58595ce7-a4f9-4c21-bac6-460051574179", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"MOBILE_NUMBER_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78f64dfb-fd92-4157-9607-3d667d6db53e", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf810f92-c174-482b-af1a-65b49ccd38f7", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee27c7d2-42fb-4132-800a-a24e8ad808ad", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0405fdc4-9dbd-42c8-9720-3f10412ba61d", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a97cc697-db9a-48c5-bbce-474baeed1641", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce32e23f-1923-4d0b-b630-245349531e59", "name": "Error", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cdcd1e98-e2af-4b1c-803b-12318af71d2a", "name": "Verify a step-up token using a one-time password", "request": { "name": "Verify a step-up token using a one-time password", "description": { "content": "Completes the verification process for a step up token.\n\n_Note that on the Sandbox Environment, text messages are not sent and the `verificationCode` is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "stepup", "challenges", "otp", "{{channel}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "f7f8f090-fd7b-480f-a294-f689ce653b07", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e8f7e00-600d-41c6-8456-0b355f77f4b8", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a30accf3-f398-42f2-9e26-c632f281522e", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "973c8775-f47a-484d-9689-aeaa1c594e26", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d33193ad-a4c5-4843-915e-47d2a3a322a9", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f50bbd9d-aa2c-4121-92ff-164b052f8ab7", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHALLENGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25ebc943-8142-46f4-a892-c8825d655685", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d31649ff-ff44-4e6c-af24-05126ed885bd", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7cf1135-6bc8-4a23-8b67-623744dac549", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a773eda3-d551-4435-88e9-72899b9a8d08", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "240b706d-8a98-45cc-948f-fb37734bb664", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8f70a04-c064-4ac5-9767-d6eab9225178", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "2. Set up authorised users", "description": "Create users with CREATOR and CONTROLLER roles.", "item": [ { "id": "10b4d911-1a87-4300-b963-89af9081e1d9", "name": "Create user with CREATOR role", "request": { "name": "Create a user", "description": { "content": "Creates a user that belongs to the buyer that the logged-in user belongs to. To Create an Authorised User you would need a stepped-up token. After calling this endpoint you need to step-up ( issue a challenge `/stepup/challenges/otp/{channel}` ). More details on how to step-up a token can be found here [Step-Up](https://docs.weavr.io/payment-run/plugin-api/plugin-api-authentication-stepup/).\n\nOnce on-boarded, users have access and manage the buyer's payment runs.\n\nUsers are assigned `roles` which limit the level of access they have and what they can do on behalf of the buyer.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"name\": \"{{user_first_name}}\",\n\t\"surname\": \"{{user_last_name}}\",\n\t\"email\": \"{{$randomEmail}}\",\n\t\"mobile\": {\n\t\t\"countryCode\": \"+356\",\n\t\t\"number\": \"{{mt_mobile}}\"\n\t},\n\t\"dateOfBirth\": {\n\t\t\"year\": 1987,\n\t\t\"month\": 6,\n\t\t\"day\": 4\n\t},\n\t\"roles\": [\n\t\t\"CREATOR\"\n\t]\n}" } }, "response": [ { "id": "104c0c61-76da-475b-9b27-21dcecd3f592", "name": "Success", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"active\": true,\n \"buyerId\": \"8695454\",\n \"email\": \"GLPnzgo3Wa2D0-b@drVWWQAgSaknTysVYGO.feqq\",\n \"id\": \"53773669\",\n \"name\": \"ut est labore\",\n \"roles\": [\n \"CONTROLLER\"\n ],\n \"surname\": \"ut cillum \",\n \"mobile\": {\n \"number\": \"33967\",\n \"countryCode\": \"+45\"\n },\n \"dateOfBirth\": {\n \"year\": 2099,\n \"month\": 3,\n \"day\": 3\n },\n \"addedBy\": {\n \"userId\": \"3835\",\n \"rolesNames\": [\n \"ADMIN\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d9e07a-bbf9-4ac6-8eb3-712bc64bda13", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d900b2e-682c-426a-8e6d-2882206cc60c", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "056e7324-2a5d-4f93-a24b-13ca04204732", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"STEP_UP_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "149145fe-f72e-4db6-8229-7c68eb597964", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"MOBILE_OR_COUNTRY_CODE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ffd8db-4b6b-4fff-8af9-fcd0ebb1e298", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82c35014-907e-43c8-90fe-f5862ff47e58", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f910e51c-7d97-4ff4-a9ed-9440fba3bb96", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70b52f20-6495-44c1-9b32-2423bee877f0", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f61c4763-ec36-4f8b-b099-d7fc22fb2749", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f4f5bba-f4b3-4a68-b4c5-c232a0bd6e3a", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_creator_user\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }\nif (!pm.environment.has(\"user_first_name\")) {\n pm.variables.set(\"user_first_name\", pm.variables.replaceIn(\"{{$randomFirstName}}\"));\n}\n\nif (!pm.environment.has(\"user_last_name\")) {\n pm.variables.set(\"user_last_name\", pm.variables.replaceIn(\"{{$randomLastName}}\"));\n}\n", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"creator_email\", pm.response.json().email);\npm.environment.set(\"creator_user_id\", pm.response.json().id);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4700d6f-ea66-4055-97e0-41084cdec802", "name": "Set password for CREATOR user", "request": { "name": "Create a password", "description": { "content": "Create a new password for the user identified by the `user_id` path parameter.", "type": "text/plain" }, "url": { "path": ["v1", "password", "{{user_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "83a1301b-81e6-44f3-aa9d-072bc46fbd54", "name": "OK", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"passwordInfo\": {\n \"buyerId\": \"26083907\",\n \"expiryDate\": 49738017\n },\n \"token\": \"amet et labore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "357f41ef-4ed1-4f90-b954-b1cff335bd59", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e92610a-7598-4b15-a9da-3c3f8e183671", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fca794c2-e9e6-4028-a620-97f05e35970f", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176b8a24-7caa-4cfa-939c-19dc4d8bbf9f", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7249648e-1293-4cf5-9f7e-fe07296a0453", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PASSWORD_TOO_SIMPLE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5bba16f-cc9d-454c-83d2-249381f70d3a", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0046175-0455-4d40-9000-0bb9833c5838", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcb23835-31ab-42cb-ae48-03326ea15d8b", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42445617-7ad3-4af0-9e50-9209b5129175", "name": "Error", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"creatorBearerToken\", pm.response.json().token);", "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_creator_user\")) pm.execution.skipRequest();\npm.environment.set(\"user_id\", pm.environment.get(\"creator_user_id\"));", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d78a3b88-b35d-475a-8d16-4f9ac8a29561", "name": "Create user with CONTROLLER role", "request": { "name": "Create a user", "description": { "content": "Creates a user that belongs to the buyer that the logged-in user belongs to. To Create an Authorised User you would need a stepped-up token. After calling this endpoint you need to step-up ( issue a challenge `/stepup/challenges/otp/{channel}` ). More details on how to step-up a token can be found here [Step-Up](https://docs.weavr.io/payment-run/plugin-api/plugin-api-authentication-stepup/).\n\nOnce on-boarded, users have access and manage the buyer's payment runs.\n\nUsers are assigned `roles` which limit the level of access they have and what they can do on behalf of the buyer.\n\n\nRequired user role: `ADMIN`", "type": "text/plain" }, "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"name\": \"{{user_first_name}}\",\n\t\"surname\": \"{{user_last_name}}\",\n\t\"email\": \"{{$randomEmail}}\",\n\t\"mobile\": {\n\t\t\"countryCode\": \"+356\",\n\t\t\"number\": \"{{mt_mobile}}\"\n\t},\n\t\"dateOfBirth\": {\n\t\t\"year\": 1987,\n\t\t\"month\": 6,\n\t\t\"day\": 4\n\t},\n\t\"roles\": [\n\t\t\"CONTROLLER\"\n\t]\n}" } }, "response": [ { "id": "104c0c61-76da-475b-9b27-21dcecd3f592", "name": "Success", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"active\": true,\n \"buyerId\": \"8695454\",\n \"email\": \"GLPnzgo3Wa2D0-b@drVWWQAgSaknTysVYGO.feqq\",\n \"id\": \"53773669\",\n \"name\": \"ut est labore\",\n \"roles\": [\n \"CONTROLLER\"\n ],\n \"surname\": \"ut cillum \",\n \"mobile\": {\n \"number\": \"33967\",\n \"countryCode\": \"+45\"\n },\n \"dateOfBirth\": {\n \"year\": 2099,\n \"month\": 3,\n \"day\": 3\n },\n \"addedBy\": {\n \"userId\": \"3835\",\n \"rolesNames\": [\n \"ADMIN\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d9e07a-bbf9-4ac6-8eb3-712bc64bda13", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d900b2e-682c-426a-8e6d-2882206cc60c", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "056e7324-2a5d-4f93-a24b-13ca04204732", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"STEP_UP_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "149145fe-f72e-4db6-8229-7c68eb597964", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"MOBILE_OR_COUNTRY_CODE_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20ffd8db-4b6b-4fff-8af9-fcd0ebb1e298", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82c35014-907e-43c8-90fe-f5862ff47e58", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f910e51c-7d97-4ff4-a9ed-9440fba3bb96", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70b52f20-6495-44c1-9b32-2423bee877f0", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f61c4763-ec36-4f8b-b099-d7fc22fb2749", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f4f5bba-f4b3-4a68-b4c5-c232a0bd6e3a", "name": "Error", "originalRequest": { "url": { "path": ["v1", "users"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"roles\": [\n \"\"\n ],\n \"mobile\": {\n \"number\": \"\",\n \"countryCode\": \"\"\n },\n \"dateOfBirth\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_controller_user\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }\nif (!pm.environment.has(\"user_first_name\")) {\n pm.variables.set(\"user_first_name\", pm.variables.replaceIn(\"{{$randomFirstName}}\"));\n}\n\nif (!pm.environment.has(\"user_last_name\")) {\n pm.variables.set(\"user_last_name\", pm.variables.replaceIn(\"{{$randomLastName}}\"));\n}\n", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"controller_email\", pm.response.json().email);\npm.environment.set(\"controller_user_id\", pm.response.json().id);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e0dd369-5533-4b5c-9ee5-86338d520d8b", "name": "Set password for CONTROLLER user", "request": { "name": "Create a password", "description": { "content": "Create a new password for the user identified by the `user_id` path parameter.", "type": "text/plain" }, "url": { "path": ["v1", "password", "{{user_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "83a1301b-81e6-44f3-aa9d-072bc46fbd54", "name": "OK", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"passwordInfo\": {\n \"buyerId\": \"26083907\",\n \"expiryDate\": 49738017\n },\n \"token\": \"amet et labore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "357f41ef-4ed1-4f90-b954-b1cff335bd59", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e92610a-7598-4b15-a9da-3c3f8e183671", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fca794c2-e9e6-4028-a620-97f05e35970f", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176b8a24-7caa-4cfa-939c-19dc4d8bbf9f", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7249648e-1293-4cf5-9f7e-fe07296a0453", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"PASSWORD_TOO_SIMPLE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5bba16f-cc9d-454c-83d2-249381f70d3a", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0046175-0455-4d40-9000-0bb9833c5838", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcb23835-31ab-42cb-ae48-03326ea15d8b", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42445617-7ad3-4af0-9e50-9209b5129175", "name": "Error", "originalRequest": { "url": { "path": ["v1", "password", ":user_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "user_id", "description": "(Required) The unique identifier for the user." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"controllerBearerToken\", pm.response.json().token);", "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_controller_user\")) pm.execution.skipRequest();\npm.environment.set(\"user_id\", pm.environment.get(\"controller_user_id\"));", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c317a3d-b04d-45d9-b670-e22e3917a2ac", "name": "Enrol CONTROLLER's device for authentication using one-time passwords", "request": { "name": "Enrol a user device for authentication using one-time passwords", "description": { "content": "This is the first step in enrolling the logged-in user's mobile device, where a one-time password is sent to the device.\n\n_Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "authentication_factors", "otp", "{{channel}}" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "9ebab0a9-da86-4a36-840c-0a7a301dab23", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09dde4ad-1e92-47f4-9836-507373f0a5a0", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13374dd-8999-4454-8b6d-21ac50448824", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95d108ab-caa3-4bb8-b06a-31a69cf2c52c", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd451d01-5e2f-415d-82e8-71add8f863e7", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4beb1f1-066f-4bea-826f-e91c91d8ebb0", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHANNEL_ALREADY_REGISTERED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09354acb-eca4-4c30-b802-a87af4cafb02", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a0c58d1-1cd1-4e52-93fd-87540c6a8fa8", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95f58230-2e61-4941-908a-b64d4bc2639a", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11fc63ea-6223-4912-82bc-f99d537054f9", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_controller_user\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }\npm.environment.set(\"channel\", \"SMS\");", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfdc0d17-3b1a-4bf8-b38c-31a27d14fb6c", "name": "Verify enrolment of a CONTROLLER's device for authentication using one-time passwords", "request": { "name": "Verify enrolment of a user device for authentication using one-time passwords", "description": { "content": "The second step in enrolling the logged-in user (root or authorised user) to use one-time-passwords to enable verification of transactions.\n\n_Note that on the Sandbox Environment, text messages are not sent and the `verificationCode` is always set to \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "authentication_factors", "otp", "{{channel}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "7cdbff73-2071-44f5-9b33-3347f310ee94", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47a4ab09-687d-4b6e-b333-c8b7a2f6327e", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9e5f382-98e4-4556-8cdb-a3d54fa43630", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f784b22-b446-4ae9-b2c2-a28fd1d42152", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f78ec4-450c-4332-9e10-d03a27c4e0cd", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cec47e6-3192-4e0f-8c08-ba397b05060f", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHANNEL_ALREADY_REGISTERED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bfb05e0-e5ea-4ea1-a118-6fe0d9b69f24", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd2aa8e7-7e67-4425-bfa6-4436eddf1321", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "743eb4fa-5512-4de9-b7e9-aa12f5344fa7", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ba27a47c-9fd0-4527-8a05-a7607afeb063", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "authentication_factors", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_controller_user\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "3. Create Payment Run", "description": "Create a new payment run.", "item": [ { "id": "82ae57e1-c920-4539-bc50-d214868ee6fd", "name": "Create a payment run", "request": { "name": "Create a payment run", "description": { "content": "Create a new payment run containing a list of outstanding supplier payments.\n\nNote that all the supplier payments in a payment run is limited to one currency. The currency of the payment run are enabled upon the Buyer’s registration.\n\n\nRequired user role: `CREATOR`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{creatorBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"payments\": [\n\t\t{\n\t\t\t\"reference\": \"{{$timestamp}}\",\n\t\t\t\"paymentAmount\": {\n\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\"amount\": 100\n\t\t\t},\n\t\t\t\"externalRef\": \"{{$guid}}\",\n\t\t\t\"paymentRef\": \"{{$guid}}\",\n\t\t\t\"supplier\": {\n\t\t\t\t\"name\": \"Test Supplier\",\n\t\t\t\t\"bankAccountDetails\": {\n\t\t\t\t\t\"accountNumber\": \"{{$randomBankAccount}}\",\n\t\t\t\t\t\"sortCode\": \"{{random_sort_code}}\"\n\t\t\t\t},\n\t\t\t\t\"type\": \"BUSINESS\"\n\t\t\t}\n\t\t}\n\t],\n\t\"paymentRunRef\": \"{{$guid}}\",\n\t\"tag\": \"tag\",\n\t\"description\": \"{{$randomLoremSentence}}\"\n}" } }, "response": [ { "id": "36df58b3-50e0-4a43-904c-acb820438912", "name": "OK", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": \"labo\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"ToENcB9XkDclpiMQXc\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"17069395\",\n \"sortCode\": \"423296\",\n \"secondaryReference\": \"in dolor\"\n },\n \"name\": \" Ad-Y9\",\n \"address\": \"aliqua officia commodo in Ut\",\n \"bankName\": \"reprehenderit qui in anim\",\n \"bankAddress\": \"Lorem\",\n \"bankCountry\": \"HE\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"AC01\",\n \"accountName\": \"labore adipisicing qui anim\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"OPTO\",\n \"accountName\": \"nisi nulla\"\n }\n }\n ]\n },\n {\n \"id\": \"non sit esse\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"aC\",\n \"status\": \"PENDING_FUNDING\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"65573693\",\n \"sortCode\": \"415607\",\n \"secondaryReference\": \"ex dolor officia\"\n },\n \"name\": \"*37 B\",\n \"address\": \"culpa in magna qui\",\n \"bankName\": \"esse occaecat\",\n \"bankAddress\": \"sit laboris commodo officia\",\n \"bankCountry\": \"JC\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"EXACT_MATCH\",\n \"reasonCode\": \"CASS\",\n \"accountName\": \"sed\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"BAMM\",\n \"accountName\": \"dolore non in nulla\"\n }\n }\n ]\n }\n ],\n \"id\": \"88acF21fecad06cfA881CfC7\",\n \"status\": \"QUEUED\",\n \"createdAt\": \"1970-07-08T07:46:31.450Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"Ak3YYrT\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"Lorem ea cupidatat et\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e3813e5-db78-4efe-ad14-4fb129d0f4a3", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f03c9dbe-bd3f-4f65-8c4b-4fa2dce5a77b", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91b76fea-8f7d-46a0-a99f-95bd43a449d6", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a3a73bc-8fb3-468b-88fc-ef09419f6b3c", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"IDEMPOTENT_REQUEST_IN_PROGRESS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cb65f34-c849-46b9-8376-9fed87c73cc2", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "050c8c3d-ec13-46be-aedd-4746650ee529", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1730d9b7-5cd1-476b-b9f1-e751987f3058", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8d3a307-426d-4537-a2cd-4e7e2e1ac055", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c88e2e8b-e835-4c7e-9c36-56a2467f96d2", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2bc96330-6f15-467e-a1af-2d3b8783ba63", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"reference\": \"\",\n \"paymentAmount\": {\n \"currency\": \"\",\n \"amount\": 454321\n },\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"\",\n \"sortCode\": \"\",\n \"secondaryReference\": \"\"\n },\n \"name\": \"\",\n \"address\": \"\",\n \"bankName\": \"\",\n \"bankAddress\": \"\",\n \"bankCountry\": \"\",\n \"type\": \"\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"amount\": false\n }\n ],\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"\",\n \"description\": \"September payment run 01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"creatorBearerToken\")) { throw new Error(\"Token 'creatorBearerToken' missing, log in as user with appropriate role.\"); }\nlet randomSortCode = Math.floor(Math.random() * 1000000).toString().padStart(6, '0');\npm.variables.set(\"random_sort_code\", randomSortCode);", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 201\", function () {\n\tpm.response.to.have.status(201);\n});\npm.environment.set(\"payment_run_id\", pm.response.json().id);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bf4bfcc-6769-4421-a12b-a16e702808fe", "name": "Get a payment run", "request": { "name": "Get a payment run", "description": { "content": "Retrieve a payment run belonging to the buyer that the logged-in user belongs to.\n\n\nRequired user roles: `CONTROLLER` OR `CREATOR`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs", "{{payment_run_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{creatorBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "4f867676-c627-4d98-9fce-d44e09e4a448", "name": "OK", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": \"anim ut\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"APt9\",\n \"status\": \"COMPLETED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"21628280\",\n \"sortCode\": \"838251\",\n \"secondaryReference\": \"Lorem reprehenderit exercitatio\"\n },\n \"name\": \"-\\n R K\",\n \"address\": \"consequat in deserunt\",\n \"bankName\": \"elit ipsum Duis dolore\",\n \"bankAddress\": \"pariatu\",\n \"bankCountry\": \"QY\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"IVCR\",\n \"accountName\": \"dolor aliqua ex pariatur\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"MBAM\",\n \"accountName\": \"cupidatat esse nisi qui\"\n }\n }\n ]\n },\n {\n \"id\": \"cupidatat tempor ea in\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"UTTHmsh\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"28413658\",\n \"sortCode\": \"539044\",\n \"secondaryReference\": \"ea amet non elit\"\n },\n \"name\": \"&/3c\",\n \"address\": \"quis veniam in sint\",\n \"bankName\": \"occaecat ad anim in Duis\",\n \"bankAddress\": \"enim Ut cillum\",\n \"bankCountry\": \"SD\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"OPTO\",\n \"accountName\": \"est nisi\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"ACNS\",\n \"accountName\": \"sunt ad tempor\"\n }\n }\n ]\n }\n ],\n \"id\": \"e28DCDCb04f69FeCcAAFeaC0\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"createdAt\": \"1956-01-13T00:10:10.715Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"YhXTPKuotVY\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"dolor nulla \"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b58d56d0-8136-4fd1-8980-707959b4adfe", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54299321-dfee-4791-b95b-8e984b6ee988", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d24f285-43b3-414d-b3fc-53a74bf09dcf", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40401161-a74d-4240-b006-3bee97a22bd2", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca340628-ed84-45c7-b05c-9342be339ab8", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "768f80d3-1816-4124-9d98-7ac90fb0a457", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dabdfbe1-660b-4068-b262-b6013e8d3b16", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8b02b82-4253-44e4-8465-45f90209a4d8", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"creatorBearerToken\")) { throw new Error(\"Token 'creatorBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f858dbb-ac19-435a-94db-b696a96dbe3c", "name": "Confirm a payment run", "request": { "name": "Confirm a payment run", "description": { "content": "Confirm that a payment run can be executed.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": [ "v1", "payment_runs", "{{payment_run_id}}", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "76042a53-ccc2-45a6-ae47-9af261cc48d0", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": \"dolore ea velit\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"bp4T6maCVp-.\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"47425563\",\n \"sortCode\": \"720148\",\n \"secondaryReference\": \"dolore anim\"\n },\n \"name\": \" 0 W V\\r&\",\n \"address\": \"d\",\n \"bankName\": \"labore laborum eu\",\n \"bankAddress\": \"Lorem et Ut\",\n \"bankCountry\": \"BG\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"MBAM\",\n \"accountName\": \"Lorem Duis\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"IVCR\",\n \"accountName\": \"aliquip voluptate\"\n }\n }\n ]\n },\n {\n \"id\": \"molli\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"kiOZD5sKK\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"75665387\",\n \"sortCode\": \"918194\",\n \"secondaryReference\": \"Lorem dolor\"\n },\n \"name\": \"t y\",\n \"address\": \"ut cupidatat\",\n \"bankName\": \"dolore est do\",\n \"bankAddress\": \"dolor cillum Lorem ad\",\n \"bankCountry\": \"GZ\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"BAMM\",\n \"accountName\": \"in laborum\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"PANM\",\n \"accountName\": \"ullamco sint\"\n }\n }\n ]\n }\n ],\n \"id\": \"d5cc035aFd80b10b534BF66D\",\n \"status\": \"PENDING_CHALLENGE\",\n \"createdAt\": \"1958-05-19T11:11:41.411Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"Bvm6hCV\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"deserunt ex\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f12a14d-920c-49f2-849f-081d8f691ae3", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb9bd0d5-a545-4124-a8fa-1e05f030c14a", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "abbbf0ac-23e2-42f6-8f6c-b66b2f9e1236", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02889ad2-dd0c-4c6b-b88f-271a8d57a32d", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9843477-6c10-49f3-8181-4c221309b77b", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"ZERO_BALANCE_ACCOUNT_INVALID_STATE\",\n \"message\": \"ipsum nulla enim anim\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f3ecdf8-549e-4fba-ba4d-59670af4762c", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53e7b62a-b79c-45b4-94bd-f1af9492ff4b", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f600759c-7739-4b8e-94b0-c22da55dd14f", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc1862f7-2150-4a59-9a67-92da3b9087de", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b2f76e5-e164-4495-a6f7-4f7f4e1d5be5", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1949b433-7299-425b-95f3-8878c6a272ab", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "payment_runs", ":payment_run_id", "confirm" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (pm.environment.get(\"skip_pr_confirmation\")) pm.execution.skipRequest();\nif (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "4. Get Payment Run Groups", "description": "Get payment run groups.", "item": [ { "id": "3b572e38-709c-455e-82f0-3aaaa9a12913", "name": "Get Linked accounts", "request": { "name": "Get Linked accounts", "description": { "content": "Retrieves the linked accounts belonging to the buyer that the logged-in user belongs to.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "f3c153ae-69c6-46e6-a4d8-2ef268952414", "name": "OK", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"linkedAccounts\": [\n {\n \"id\": \"652d25b73541d8084a88a38d\",\n \"accountIdentification\": {\n \"accountNumber\": \"23403156\",\n \"sortCode\": \"397834\",\n \"secondaryReference\": \"esse c\"\n },\n \"currency\": \"EUR\",\n \"institution\": {\n \"countries\": [\n \"GB\",\n \"SI\"\n ],\n \"displayName\": \"labore\",\n \"images\": {\n \"icon\": \"ut incididunt pariatur\",\n \"logo\": \"sint veniam commodo laborum\"\n },\n \"info\": {\n \"loginUrl\": \"dolore exercitation occaecat laboris deserunt\",\n \"helplinePhoneNumber\": \"dolore Lorem incidid\"\n }\n },\n \"consent\": {\n \"expiresAt\": \"1983-06-15T13:07:01.371Z\",\n \"expiresIn\": -25065302,\n \"status\": \"EXPIRED\"\n },\n \"status\": \"UNLINKED\",\n \"friendlyName\": \"tempor nostrud\"\n },\n {\n \"id\": \"652d25b73541d8084a88a38d\",\n \"accountIdentification\": {\n \"accountNumber\": \"84908480\",\n \"sortCode\": \"349179\",\n \"secondaryReference\": \"officia consectetur reprehenderit Duis\"\n },\n \"currency\": \"GBP\",\n \"institution\": {\n \"countries\": [\n \"ES\",\n \"HU\"\n ],\n \"displayName\": \"ut in dolore exercitation\",\n \"images\": {\n \"icon\": \"velit reprehender\",\n \"logo\": \"ni\"\n },\n \"info\": {\n \"loginUrl\": \"irure elit anim adipisicing aute\",\n \"helplinePhoneNumber\": \"ea id quis\"\n }\n },\n \"consent\": {\n \"expiresAt\": \"1969-01-13T08:07:19.629Z\",\n \"expiresIn\": -51757873,\n \"status\": \"ACTIVE\"\n },\n \"status\": \"LINKED\",\n \"friendlyName\": \"cillum\"\n }\n ],\n \"count\": 49874675,\n \"responseCount\": -46205383\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b77ceea7-e7d4-4d09-919c-08cdc922efb2", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feea8b8d-84cc-4be0-a69b-df33e20b7e6c", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "749afc8e-bf07-4f63-869b-edb17d0503e1", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2c63201-c977-4a66-ad61-e493246d9460", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f93b05c-a6e5-4096-a81a-0e4492a1ee82", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aafbf060-5af1-47b5-9474-9c1109d1ff04", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4207796-4c8f-4c55-9b91-c6c4094d8b28", "name": "Error", "originalRequest": { "url": { "path": ["v1", "linked_accounts"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\nconst institutionId = pm.environment.get(\"useMockBank\") ? \"mock-bank\" : (pm.environment.get(\"preferred_ob_institution\") ?? \"natwest-sandbox\");\nconst foundLinkedAccount = pm.response.json().linkedAccounts?.find((acc) => acc?.status === \"LINKED\" && acc?.consent?.status === \"ACTIVE\");\npm.test(\"Linked account using \" + institutionId + \" is returned\", function() { pm.expect(foundLinkedAccount).to.be.ok; });\npm.environment.set('linked_account_id', foundLinkedAccount?.id);\npm.environment.set('consent_id', foundLinkedAccount?.consentId);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e562731f-eab2-4958-a0d6-e5148a9538f3", "name": "Get a payment run funding instructions", "request": { "name": "Get a payment run funding instructions", "description": { "content": "Start the the funding process of a payment run.\n\nSpecify the funding source of the payment run by providing an id to an already linked account.\n\nDepending on the maximum payment amount constraints imposed by the bank that is providing the account, the payment run may be split in 2 or more groups. Note that you'll need to complete a funding process for each instruction returned.\n\n\nRequired user role: `CONTROLLER`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs", "{{payment_run_id}}", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds[]", "value": "{{linked_account_id}}", "disabled": false } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{controllerBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "8f53c36f-0f5e-41ff-8bda-9fc0152f8a9a", "name": "OK", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 10,\n \"responseCount\": 100,\n \"fundingInstructions\": [\n {\n \"reference\": \"eu culpa fugiat\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"status\": \"EXECUTING\",\n \"payments\": [\n {\n \"id\": \"magna culpa quis dolore ea\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"s0WskmTCiFPc\",\n \"status\": \"FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \"e\",\n \"address\": \"dolore\",\n \"bankName\": \"velit minim mollit\",\n \"bankAddress\": \"velit esse tempor\",\n \"bankCountry\": \"OF\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"laborum\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"2Imy1cC6lR94RiV\",\n \"status\": \"CANCELLED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \" \",\n \"address\": \"nostrud\",\n \"bankName\": \"anim cillum\",\n \"bankAddress\": \"ut ullamco\",\n \"bankCountry\": \"VA\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ],\n \"fundingDate\": \"1992-07-21T07:19:41.224Z\"\n },\n {\n \"reference\": \"nulla\",\n \"totalAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"status\": \"COMPLETED\",\n \"payments\": [\n {\n \"id\": \"id ad pariatur\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"UU2ozqn.aRvb\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \"\\\"F
L=W\",\n \"address\": \"nulla do laborum labore sunt\",\n \"bankName\": \"qui ut enim\",\n \"bankAddress\": \"occaecat est laboris irure\",\n \"bankCountry\": \"UE\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"dolore elit qui\",\n \"paymentAmount\": {\n \"currency\": \"GBP\",\n \"amount\": 454321\n },\n \"reference\": \"0Pn2vKHPPNyZX5j5l\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"sortCode\": {\n \"value\": \"\"\n },\n \"secondaryReference\": {\n \"value\": \"\"\n }\n },\n \"name\": \"%U\\\"\\n5\",\n \"address\": \"culpa eu ad\",\n \"bankName\": \"sit mollit minim\",\n \"bankAddress\": \"veniam\",\n \"bankCountry\": \"KV\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": {\n \"value\": \"\"\n },\n \"reasonCode\": {\n \"value\": \"\"\n },\n \"accountName\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ],\n \"fundingDate\": \"1984-08-05T01:26:58.245Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef5b1e7a-ca57-4930-9986-749d91eb6649", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc702f4-3fa7-41f8-a6ea-2a826758794e", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1210780b-b370-4f35-8516-b2690a3f20ad", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f499ec7-7f9c-41a8-a03d-f32e358a3345", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b18bbcb5-c92b-488f-a2ed-1b9ee74fa476", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"BANK_ACCOUNT_CANNOT_BE_LINKED_ACCOUNT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9bdc79-5ede-487f-9f4e-aecc98b307b9", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d0bd771-377b-468b-b193-7b5d880177d1", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f9094cf-8901-4921-8a90-c93997d065e6", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5346dee7-0527-4565-9b8a-163c336a51a1", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id", "fund"], "host": ["{{baseUrl}}"], "query": [ { "key": "linkedAccountIds", "value": "652d25b73541d8084a88a38d" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"controllerBearerToken\")) { throw new Error(\"Token 'controllerBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set('payment_run_group_reference', pm.response.json().fundingInstructions[0].reference);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "5. Simulate Funding", "description": "Simulate funding.", "item": [ { "id": "3fc6644e-360a-40bd-b9e5-501cc7e47b4e", "name": "Managed account simulate deposit", "request": { "name": "Managed account simulate deposit", "description": { "content": "Managed account simulate deposit", "type": "text/plain" }, "url": { "path": [ "simulate", "v1", "payment_runs", "{{payment_run_id}}", "fund_group", "{{group_reference}}" ], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "body": {}, "method": "POST", "auth": null }, "response": [], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }\nvar ref = pm.environment.get(\"payment_run_group_reference\");\npm.environment.set(\"group_reference\", ref);", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "console.log(\"✅ Simulated deposit sent to Multi - deposit should trigger webhook\");\nsetTimeout(function() {\n console.log(\"Add a short delay for payment processing to complete.\");\n }, 65000);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4c32ac3-bab1-453f-937b-84077a1d3f65", "name": "Check if payment run is completed", "request": { "name": "Get a payment run", "description": { "content": "Retrieve a payment run belonging to the buyer that the logged-in user belongs to.\n\n\nRequired user roles: `CONTROLLER` OR `CREATOR`", "type": "text/plain" }, "url": { "path": ["v1", "payment_runs", "{{payment_run_id}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{creatorBearerToken}}" } ], "method": "GET", "auth": null }, "response": [ { "id": "4f867676-c627-4d98-9fce-d44e09e4a448", "name": "OK", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": \"anim ut\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"APt9\",\n \"status\": \"COMPLETED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"21628280\",\n \"sortCode\": \"838251\",\n \"secondaryReference\": \"Lorem reprehenderit exercitatio\"\n },\n \"name\": \"-\\n R K\",\n \"address\": \"consequat in deserunt\",\n \"bankName\": \"elit ipsum Duis dolore\",\n \"bankAddress\": \"pariatu\",\n \"bankCountry\": \"QY\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"NO_MATCH\",\n \"reasonCode\": \"IVCR\",\n \"accountName\": \"dolor aliqua ex pariatur\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"MBAM\",\n \"accountName\": \"cupidatat esse nisi qui\"\n }\n }\n ]\n },\n {\n \"id\": \"cupidatat tempor ea in\",\n \"paymentAmount\": {\n \"currency\": \"EUR\",\n \"amount\": 454321\n },\n \"reference\": \"UTTHmsh\",\n \"status\": \"SCA_FAILED\",\n \"supplier\": {\n \"bankAccountDetails\": {\n \"accountNumber\": \"28413658\",\n \"sortCode\": \"539044\",\n \"secondaryReference\": \"ea amet non elit\"\n },\n \"name\": \"&/3c\",\n \"address\": \"quis veniam in sint\",\n \"bankName\": \"occaecat ad anim in Duis\",\n \"bankAddress\": \"enim Ut cillum\",\n \"bankCountry\": \"SD\",\n \"type\": \"BUSINESS\"\n },\n \"externalRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"paymentRef\": \"c99cd66c-82fc-4a01-977b-61a2f5a247a1\",\n \"validationOutcomes\": [\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"OPTO\",\n \"accountName\": \"est nisi\"\n }\n },\n {\n \"category\": \"UK_CONFIRMATION_OF_PAYEE\",\n \"categoryResult\": {\n \"match\": \"CLOSE_MATCH\",\n \"reasonCode\": \"ACNS\",\n \"accountName\": \"sunt ad tempor\"\n }\n }\n ]\n }\n ],\n \"id\": \"e28DCDCb04f69FeCcAAFeaC0\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"createdAt\": \"1956-01-13T00:10:10.715Z\",\n \"createdBy\": \"110747174434373672\",\n \"paymentRunRef\": \"94fddfb2-297d-423d-9157-4200b7beb834\",\n \"tag\": \"YhXTPKuotVY\",\n \"description\": \"September payment run 01\",\n \"statusReason\": \"dolor nulla \"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b58d56d0-8136-4fd1-8980-707959b4adfe", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54299321-dfee-4791-b95b-8e984b6ee988", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d24f285-43b3-414d-b3fc-53a74bf09dcf", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40401161-a74d-4240-b006-3bee97a22bd2", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca340628-ed84-45c7-b05c-9342be339ab8", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "768f80d3-1816-4124-9d98-7ac90fb0a457", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dabdfbe1-660b-4068-b262-b6013e8d3b16", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8b02b82-4253-44e4-8465-45f90209a4d8", "name": "Error", "originalRequest": { "url": { "path": ["v1", "payment_runs", ":payment_run_id"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "payment_run_id", "description": "(Required) The unique identifier of the payment run." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"creatorBearerToken\")) { throw new Error(\"Token 'creatorBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "const paymentRun = pm.response.json();\nconsole.log(`Payment run status: ${paymentRun.status}`);\nconsole.log(`Payment line status: ${paymentRun.payments[0].status}`);\n\npm.test(\"Status code is 200\", function() { pm.response.to.have.status(200); });\npm.test(\"Payment run status is COMPLETED\", function() { pm.expect(paymentRun.status).to.equal(\"COMPLETED\"); });\npm.test(\"Payment run line status is COMPLETED\", function() { pm.expect(paymentRun.payments[0].status).to.equal(\"COMPLETED\"); });", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Log in all users", "description": "Logs in all users created before and steps up tokens for ADMIN and USER MANAGER. This workflow may be useful to resume work with a previously created buyer after the tokens expire.", "item": [ { "id": "b138c903-68a1-4412-b313-99fbc095cbf7", "name": "Acquire auth token", "request": { "name": "Acquire auth token", "description": { "content": "Authenticate a user with the `email` and `password` that they provided when registering.\n\nGiven that the user credentials are correct, this returns a `token` that can then be used to authorise\nother secured operations. In case the password is expired, a temporary `token` is returned, which can be used\nsolely for updating the password.\n\nThe token returned is valid for 5 minutes from last activity.\n", "type": "text/plain" }, "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{buyer_name}}@example.com\",\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "27e1ab7a-a12f-438e-8981-f4f5ad9a29f9", "name": "OK", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"nulla id cupidatat\",\n \"tokenType\": \"AUTH\",\n \"identity\": {\n \"type\": \"BUYER\",\n \"id\": \"3453556667\"\n },\n \"credentials\": {\n \"type\": \"ADMIN\",\n \"id\": \"79221754373\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5da64f-049a-4f18-b540-fdbeef6f826a", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "378ab356-0b21-4611-930d-04c2ca396973", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53f57a66-0958-48d5-92a3-130aeec090ea", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a9f410-9287-4f40-bbe8-c68b40cbd158", "name": "The user's password has expired. Use the returned temporary token to update their password via the '_/passwords/update_' endpoint.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"id ad ut consectetur\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74bbc9a9-8154-4688-a0c3-befa87d7a2bb", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40b56f5c-7169-4573-8764-821a5926070c", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce043739-1bd4-4626-9d76-117afc9043aa", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f78be61f-d4dc-4837-9939-d28c2d26d06e", "name": "Error", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"adminBearerToken\", pm.response.json().token);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6235bd6-f217-4cbc-961c-72a9cc63fdfa", "name": "Issue a one-time password that can be used to step-up a token", "request": { "name": "Issue a one-time password that can be used to step-up a token", "description": { "content": "Initiates the step-up token process by sending an SMS with an one-time-password to a device belonging to the logged-in user that was previously enrolled through `/authentication_factors/otp/{channel}` endpoint.\n\nThis process is required for endpoints that require a step-up token to complete the call.\n\n_Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": ["v1", "stepup", "challenges", "otp", "{{channel}}"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null }, "response": [ { "id": "d394ec20-303b-4f6d-bccd-99869b8396d8", "name": "Success - No Content.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee22485f-1982-4558-b060-c6ab740bb18e", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7690f772-a3bc-4c0e-a1d8-40248a490098", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33b749a8-0232-4027-8ced-fb0e5dc9c138", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d60046-8030-4b0f-b9b6-6b85d3b62055", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58595ce7-a4f9-4c21-bac6-460051574179", "name": "Conflict", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"MOBILE_NUMBER_INVALID\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78f64dfb-fd92-4157-9607-3d667d6db53e", "name": "Content Too Large", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf810f92-c174-482b-af1a-65b49ccd38f7", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee27c7d2-42fb-4132-800a-a24e8ad808ad", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0405fdc4-9dbd-42c8-9720-3f10412ba61d", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a97cc697-db9a-48c5-bbce-474baeed1641", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce32e23f-1923-4d0b-b630-245349531e59", "name": "Error", "originalRequest": { "url": { "path": ["v1", "stepup", "challenges", "otp", ":channel"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d14c58cf-2cd4-4e8b-b82a-7368d1e1bd59", "name": "Verify a step-up token using a one-time password", "request": { "name": "Verify a step-up token using a one-time password", "description": { "content": "Completes the verification process for a step up token.\n\n_Note that on the Sandbox Environment, text messages are not sent and the `verificationCode` is always \\\"123456\\\"._\n", "type": "text/plain" }, "url": { "path": [ "v1", "stepup", "challenges", "otp", "{{channel}}", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "key": "idempotency-ref", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{adminBearerToken}}" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"verificationCode\": \"123456\"\n}" } }, "response": [ { "id": "f7f8f090-fd7b-480f-a294-f689ce653b07", "name": "Success - No Content.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e8f7e00-600d-41c6-8456-0b355f77f4b8", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a30accf3-f398-42f2-9e26-c632f281522e", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "973c8775-f47a-484d-9689-aeaa1c594e26", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d33193ad-a4c5-4843-915e-47d2a3a322a9", "name": "Not found - The requested resource couldn't be found.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f50bbd9d-aa2c-4121-92ff-164b052f8ab7", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"CHALLENGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25ebc943-8142-46f4-a892-c8825d655685", "name": "Content Too Large", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d31649ff-ff44-4e6c-af24-05126ed885bd", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7cf1135-6bc8-4a23-8b67-623744dac549", "name": "Too many requests.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a773eda3-d551-4435-88e9-72899b9a8d08", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "240b706d-8a98-45cc-948f-fb37734bb664", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8f70a04-c064-4ac5-9767-d6eab9225178", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "stepup", "challenges", "otp", ":channel", "verify" ], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "channel", "description": "(Required) The unique identifier for the channel." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "disabled": false, "description": "A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.", "key": "idempotency-ref", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"verificationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "exec": "if (!pm.environment.has(\"adminBearerToken\")) { throw new Error(\"Token 'adminBearerToken' missing, log in as user with appropriate role.\"); }", "type": "text/javascript" } }, { "listen": "test", "script": { "exec": "pm.test(\"Status code is 204\", function () {\n\tpm.response.to.have.status(204);\n});", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4035b94e-2492-4c4d-acda-db2f121ec22d", "name": "Log in CREATOR user", "request": { "name": "Acquire auth token", "description": { "content": "Authenticate a user with the `email` and `password` that they provided when registering.\n\nGiven that the user credentials are correct, this returns a `token` that can then be used to authorise\nother secured operations. In case the password is expired, a temporary `token` is returned, which can be used\nsolely for updating the password.\n\nThe token returned is valid for 5 minutes from last activity.\n", "type": "text/plain" }, "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{creator_email}}\",\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "27e1ab7a-a12f-438e-8981-f4f5ad9a29f9", "name": "OK", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"nulla id cupidatat\",\n \"tokenType\": \"AUTH\",\n \"identity\": {\n \"type\": \"BUYER\",\n \"id\": \"3453556667\"\n },\n \"credentials\": {\n \"type\": \"ADMIN\",\n \"id\": \"79221754373\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5da64f-049a-4f18-b540-fdbeef6f826a", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "378ab356-0b21-4611-930d-04c2ca396973", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53f57a66-0958-48d5-92a3-130aeec090ea", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a9f410-9287-4f40-bbe8-c68b40cbd158", "name": "The user's password has expired. Use the returned temporary token to update their password via the '_/passwords/update_' endpoint.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"id ad ut consectetur\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74bbc9a9-8154-4688-a0c3-befa87d7a2bb", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40b56f5c-7169-4573-8764-821a5926070c", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce043739-1bd4-4626-9d76-117afc9043aa", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f78be61f-d4dc-4837-9939-d28c2d26d06e", "name": "Error", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"creatorBearerToken\", pm.response.json().token);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec3b2a8a-60af-44fd-b0ac-9070caaa04b3", "name": "Log in CONTROLLER user", "request": { "name": "Acquire auth token", "description": { "content": "Authenticate a user with the `email` and `password` that they provided when registering.\n\nGiven that the user credentials are correct, this returns a `token` that can then be used to authorise\nother secured operations. In case the password is expired, a temporary `token` is returned, which can be used\nsolely for updating the password.\n\nThe token returned is valid for 5 minutes from last activity.\n", "type": "text/plain" }, "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n\t\"email\": \"{{controller_email}}\",\n\t\"password\": {\n\t\t\"value\": \"Pass1234!\"\n\t}\n}" } }, "response": [ { "id": "27e1ab7a-a12f-438e-8981-f4f5ad9a29f9", "name": "OK", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"nulla id cupidatat\",\n \"tokenType\": \"AUTH\",\n \"identity\": {\n \"type\": \"BUYER\",\n \"id\": \"3453556667\"\n },\n \"credentials\": {\n \"type\": \"ADMIN\",\n \"id\": \"79221754373\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5da64f-049a-4f18-b540-fdbeef6f826a", "name": "Bad Request Error - Your request is invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"in ipsum sint\",\n \"syntaxErrors\": {\n \"invalidFields\": [\n {\n \"params\": [\n \"dolor consequat labore laboris\",\n \"eiusmod aute ex nisi\"\n ],\n \"fieldName\": \"Ut do\",\n \"error\": \"REQUIRED\"\n },\n {\n \"params\": [\n \"reprehenderit dolore fugia\",\n \"Ut Excepteur\"\n ],\n \"fieldName\": \"officia Excepteur laborum fugiat ullamco\",\n \"error\": \"AT_LEAST\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "378ab356-0b21-4611-930d-04c2ca396973", "name": "Unauthorized - Your credentials or access token are invalid.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53f57a66-0958-48d5-92a3-130aeec090ea", "name": "Forbidden - Access to the requested resource or action is forbidden.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorCode\": \"INSUFFICIENT_PERMISSIONS\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a9f410-9287-4f40-bbe8-c68b40cbd158", "name": "The user's password has expired. Use the returned temporary token to update their password via the '_/passwords/update_' endpoint.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"id ad ut consectetur\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74bbc9a9-8154-4688-a0c3-befa87d7a2bb", "name": "Too many requests.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) Example: `20, 10;w=60, 20;w=3600, 200;w=86400`\nThe first number (20) is the limit that has been exceeded.\nThe remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example `20;w=3600` was exceeded. 20 calls in 3600secs (1hr)\n", "key": "x-ratelimit-limit", "value": "sint Lorem est elit" }, { "disabled": false, "description": "(Required) The number of seconds until the window is reset.", "key": "x-ratelimit-reset", "value": "42645534" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40b56f5c-7169-4573-8764-821a5926070c", "name": "Internal Server Error - There is a problem with the server. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce043739-1bd4-4626-9d76-117afc9043aa", "name": "Service Unavailable - We're temporarily offline for maintenance. Please try again later.", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "disabled": false, "description": "(Required) A request identifier. Providing this reference when contacting our support team will help us investigate your query.", "key": "request-ref", "value": "sint Lorem est elit" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f78be61f-d4dc-4837-9939-d28c2d26d06e", "name": "Error", "originalRequest": { "url": { "path": ["v1", "login_with_password"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"culpa laboris pariatur ipsu\",\n \"message\": \"incididunt tempor non\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "exec": "pm.test(\"Status code is 200\", function () {\n\tpm.response.to.have.status(200);\n});\npm.environment.set(\"controllerBearerToken\", pm.response.json().token);", "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "event": [], "variable": [ { "type": "string", "value": "https://sandbox.weavr.io/payment-run", "key": "baseUrl" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "f243d60e-73de-4b06-b96b-410ac64b4438", "name": "Weavr Embedded Payment Run API - GBP / UK", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Weavr Payment Run Plug-in API provides a simple and flexible way for Embedders to add payment execution capabilities in their application.\n\nBy integrating Weavr Payment Run plug-in API in your application, you can embed banking and payment capabilities within your app to boost productivity for your users in a seamless experience.\n\n# Authentication\nEach request to the API must include an `api_key` that represents your account. You can obtain an API Key by registering for a Embedder account [here](https://portal.weavr.io/register/?plugin=payment-run).\n\nAlmost all endpoints require a secondary authentication token `auth_token` that represents the user for whom the request is being executed.\n\n# Postman Collection\nTo help you get started with your integration, you can download the [Postman](https://postman.com) collection [here](https://sandbox.weavr.io/payment-run/v1/postman). The collection includes the steps you’ll need to follow to integrate Embedded Payment Run within your app. \n\nThe collection makes use of environment variables to pre-fill details associated with your Sandbox account, such as your account’s API Key. You can download your Sandbox Account environment file from the [Sandbox Portal](https://portal.weavr.io/register/?plugin=payment-run).\n\n\n\n\n# Setup\n\nPlease add the following variables to your environment:\n\n* `baseUrl` your base url e.g. `https://qa.weavr.io/payment-run`\n* `apiKey` your Api Key\n* `useMockBank` (optional) set to \"1\" if you want to use the mock bank API instead of NatWest Sandbox\n\n# Roles\n\nThere are three distinct roles in the system (ADMIN, CREATOR, CONTROLLER) with different sets of permissions. Requests in the workflows are set up to use appropriate roles. In case of errors, please make sure you run requests in proper order as outlined in the Workflows folder.\n\n", "type": "text/plain" } } }