{ "uuid": "badfab22-d956-4582-a85a-5c2af31570d4", "lastMigration": 29, "name": "Issuing: Balance Platform API", "endpointPrefix": "bcl/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "4dc0cb44-fd96-4eab-b06c-c45f34bfa225", "documentation": "Create an account holder.", "method": "post", "endpoint": "accountHolders", "responses": [ { "uuid": "423b92fb-7dc8-4499-b9d4-af1d013fff8c", "body": "{\n \"balancePlatform\": \"\",\n \"capabilities\": {},\n \"contactDetails\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"email\": \"\",\n \"phone\": {\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'Landline' 'Mobile')}}\"\n },\n \"webAddress\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"legalEntityId\": \"\",\n \"primaryBalanceAccount\": \"\",\n \"reference\": \"\",\n \"status\": \"{{oneOf (array 'Active' 'Closed' 'Inactive' 'Suspended')}}\",\n \"sweepConfigurations\": {}\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5fa32fc4-68b9-44f0-81c6-4e8865b71b94", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "26362223-ca3f-4550-894b-23913e16b6c3", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f1e3a2df-5d1b-4120-bad7-92ae49449250", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c5af64d4-232b-47e5-863a-1bc7c3b45e23", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "34717e98-c42e-4d3c-a703-13cc10367c78", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5eaafd12-11d0-4a42-893a-b8625678b82f", "documentation": "Retrieve an account holder.", "method": "get", "endpoint": "accountHolders/:id", "responses": [ { "uuid": "d7a018f0-efc8-42fe-864e-94881a58bb3e", "body": "{\n \"balancePlatform\": \"\",\n \"capabilities\": {},\n \"contactDetails\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"email\": \"\",\n \"phone\": {\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'Landline' 'Mobile')}}\"\n },\n \"webAddress\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"legalEntityId\": \"\",\n \"primaryBalanceAccount\": \"\",\n \"reference\": \"\",\n \"status\": \"{{oneOf (array 'Active' 'Closed' 'Inactive' 'Suspended')}}\",\n \"sweepConfigurations\": {}\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7a76c72e-7a3f-4153-9a24-c268f138284f", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "06b4359d-eb16-4e2c-a489-a5b3dc0d3ee9", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8dbe924c-025d-4f6d-add0-8ced0e53e0d4", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bab9d4d7-abb0-4087-9d21-90c2a644878e", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dc6f7c2a-d479-40cb-b95d-0f461ed5623d", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1200f3d7-d475-42b5-bf43-64a5a0334ecd", "documentation": "Update an account holder.", "method": "patch", "endpoint": "accountHolders/:id", "responses": [ { "uuid": "c158cf59-b7aa-4a78-a99d-2734c8993b48", "body": "{\n \"balancePlatform\": \"\",\n \"capabilities\": {},\n \"contactDetails\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"email\": \"\",\n \"phone\": {\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'Landline' 'Mobile')}}\"\n },\n \"webAddress\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"legalEntityId\": \"\",\n \"primaryBalanceAccount\": \"\",\n \"reference\": \"\",\n \"status\": \"{{oneOf (array 'Active' 'Closed' 'Inactive' 'Suspended')}}\",\n \"sweepConfigurations\": {}\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "22346c2c-359c-4e10-9ce4-c795f2c12bab", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ab9ca205-a50d-4ba5-81e8-48c96bc7f8c0", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "784a368f-95e8-4f06-b94e-881cd67f2e66", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "136c6294-0a9f-44ac-8a07-9863623a0277", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "04cf64af-1967-47f0-b186-69aeb8f754e8", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "decd0859-4e4e-456f-ba16-1a4e97a6ceda", "documentation": "Retrieve all balance accounts of a specific account holder.", "method": "get", "endpoint": "accountHolders/:id/balanceAccounts", "responses": [ { "uuid": "5a23126c-ab0c-49c7-a236-686df6bd9593", "body": "{\n \"balanceAccounts\": [\n {\n \"accountHolderId\": \"\",\n \"balances\": [\n {\n \"available\": {{faker 'number.int' max=99999}},\n \"balance\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"reserved\": {{faker 'number.int' max=99999}}\n }\n ],\n \"defaultCurrencyCode\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"paymentInstruments\": [\n {\n \"id\": \"\"\n }\n ],\n \"reference\": \"\",\n \"status\": \"\",\n \"sweepConfigurations\": {}\n }\n ],\n \"hasNext\": {{faker 'datatype.boolean'}},\n \"hasPrevious\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b13d814e-3d6b-4ba0-8e16-e4db1545723c", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "285958db-3959-44fd-93c3-bbe64c2c1639", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b7eb912f-4281-4de8-b430-025fb30011d5", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b22e5fb3-7d4f-4e1e-802d-a29ede7870ed", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e96fcf17-722d-49c3-8b8d-af10e8ac62a6", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "549f169c-65a3-4a4a-8926-95d32fd5f6d8", "documentation": "Create a balance account.", "method": "post", "endpoint": "balanceAccounts", "responses": [ { "uuid": "41784a51-8530-4550-a626-c5cf57e137f9", "body": "{\n \"accountHolderId\": \"\",\n \"balances\": [\n {\n \"available\": {{faker 'number.int' max=99999}},\n \"balance\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"reserved\": {{faker 'number.int' max=99999}}\n }\n ],\n \"defaultCurrencyCode\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"paymentInstruments\": [\n {\n \"id\": \"\"\n }\n ],\n \"reference\": \"\",\n \"status\": \"\",\n \"sweepConfigurations\": {}\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cd7f11fd-64de-4655-ada7-e3d1347a27d8", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5c4f606a-69be-45dc-97af-b9d8953fd2a0", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "957e2064-e88c-4d02-8fa5-c2b8ffbcca01", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c99f745a-dd69-46ad-84c9-d1e584f7d64d", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fda2c465-444e-4105-9556-417fa72d875a", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e695d884-947a-4a67-8693-82cdabeff8ae", "documentation": "Retrieve a balance account.", "method": "get", "endpoint": "balanceAccounts/:id", "responses": [ { "uuid": "a6d179c5-5e97-4954-aa4f-10b4f46e0912", "body": "{\n \"accountHolderId\": \"\",\n \"balances\": [\n {\n \"available\": {{faker 'number.int' max=99999}},\n \"balance\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"reserved\": {{faker 'number.int' max=99999}}\n }\n ],\n \"defaultCurrencyCode\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"paymentInstruments\": [\n {\n \"id\": \"\"\n }\n ],\n \"reference\": \"\",\n \"status\": \"\",\n \"sweepConfigurations\": {}\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "04897091-6915-4ecb-8f8f-02db83303b0f", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d3dee3c3-a5d9-40f9-92ae-109dc7d7e598", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "992aa0cd-e6dc-4edd-abc8-f9544e0020ac", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ae783b5f-2b2d-42c3-9aa7-70ed786264da", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f485e119-a56a-40f5-8d54-009fa8776a02", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2e22da94-455d-47ee-9773-432b75bea03b", "documentation": "Update a balance account.", "method": "patch", "endpoint": "balanceAccounts/:id", "responses": [ { "uuid": "ae3d46c7-fce9-4873-b3e6-2f34cdb96b77", "body": "{\n \"accountHolderId\": \"\",\n \"balances\": [\n {\n \"available\": {{faker 'number.int' max=99999}},\n \"balance\": {{faker 'number.int' max=99999}},\n \"currency\": \"\",\n \"reserved\": {{faker 'number.int' max=99999}}\n }\n ],\n \"defaultCurrencyCode\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"paymentInstruments\": [\n {\n \"id\": \"\"\n }\n ],\n \"reference\": \"\",\n \"status\": \"\",\n \"sweepConfigurations\": {}\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "01375237-f71e-46de-ba4d-ea384cd665a8", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef609b63-0394-4964-9109-19e7c24984b5", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9925695d-321d-4a69-888d-859b0415bf80", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "10707998-7d66-48b2-8003-691b21cf16ed", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f855b1ae-c12c-4955-b9bf-9aa5e0747d67", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f393b696-ef81-400e-bb55-4cc66a4d8b40", "documentation": "Retrieve all payment instruments for a specific balance account.", "method": "get", "endpoint": "balanceAccounts/:id/paymentInstruments", "responses": [ { "uuid": "658bad39-de18-4b96-be6d-b75e60b31df0", "body": "{\n \"hasNext\": {{faker 'datatype.boolean'}},\n \"hasPrevious\": {{faker 'datatype.boolean'}},\n \"paymentInstruments\": [\n {\n \"balanceAccountId\": \"\",\n \"card\": {\n \"authentication\": {\n \"password\": \"\",\n \"phone\": {\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'Landline' 'Mobile')}}\"\n }\n },\n \"bin\": \"\",\n \"brand\": \"\",\n \"brandVariant\": \"\",\n \"cardholderName\": \"\",\n \"configuration\": {\n \"activation\": \"\",\n \"activationUrl\": \"\",\n \"bulkAddress\": {\n \"city\": \"\",\n \"company\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"houseNumberOrName\": \"\",\n \"mobile\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"cardImageId\": \"\",\n \"carrier\": \"\",\n \"carrierImageId\": \"\",\n \"configurationProfileId\": \"\",\n \"currency\": \"\",\n \"envelope\": \"\",\n \"insert\": \"\",\n \"language\": \"\",\n \"logoImageId\": \"\",\n \"pinMailer\": \"\",\n \"shipmentMethod\": \"\"\n },\n \"cvc\": \"\",\n \"deliveryContact\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"email\": \"\",\n \"fullPhoneNumber\": \"\",\n \"name\": {\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"personalData\": {\n \"dateOfBirth\": \"\",\n \"idNumber\": \"\",\n \"nationality\": \"\"\n },\n \"phoneNumber\": {\n \"phoneCountryCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneType\": \"{{oneOf (array 'Fax' 'Landline' 'Mobile' 'SIP')}}\"\n },\n \"webAddress\": \"\"\n },\n \"expiration\": {\n \"month\": \"\",\n \"year\": \"\"\n },\n \"formFactor\": \"{{oneOf (array 'physical' 'unknown' 'virtual')}}\",\n \"lastFour\": \"\",\n \"number\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"issuingCountryCode\": \"\",\n \"paymentInstrumentGroupId\": \"\",\n \"reference\": \"\",\n \"status\": \"{{oneOf (array 'Active' 'Closed' 'Inactive' 'Lost' 'Requested' 'Stolen' 'Suspended')}}\",\n \"type\": \"{{oneOf (array 'bankAccount' 'card' 'unknown')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "86d4858b-e275-45b7-bb39-a6ef6089af20", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8ab075e0-8281-4067-b727-9b7453341f9c", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7c46e5d5-8ada-44f0-9f84-f6fa5f60dd41", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "223a6660-6c43-4594-bc2e-02f8b7349eaf", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6534b92f-8733-4860-ac33-33dde7f07620", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4787aeb6-a80d-48c2-8b91-aa5cf3c9661f", "documentation": "Retrieve a balance platform.", "method": "get", "endpoint": "balancePlatforms/:id", "responses": [ { "uuid": "404184fc-4c1c-4a9e-880e-09ad00bdcdb7", "body": "{\n \"description\": \"\",\n \"id\": \"\",\n \"status\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "48241fb6-ce4b-44b3-b736-99b4206a922a", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cd61cf84-1018-4ee9-a039-9cf7d72f50ac", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d7735339-c833-4082-8605-54565881dd27", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1a15028a-8a6c-4f42-b9d0-a1e9f227dc98", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7a203b7a-a4f7-4c77-a622-dcd555a55274", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "92e37adc-2e40-45e6-bc01-2d89f3a44eb0", "documentation": "Retrieve all account holders under a specific balance platform.", "method": "get", "endpoint": "balancePlatforms/:id/accountHolders", "responses": [ { "uuid": "81c147e7-0aae-47f8-b840-7a60645a49ed", "body": "{\n \"accountHolders\": [\n {\n \"balancePlatform\": \"\",\n \"capabilities\": {},\n \"contactDetails\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"email\": \"\",\n \"phone\": {\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'Landline' 'Mobile')}}\"\n },\n \"webAddress\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"legalEntityId\": \"\",\n \"primaryBalanceAccount\": \"\",\n \"reference\": \"\",\n \"status\": \"{{oneOf (array 'Active' 'Closed' 'Inactive' 'Suspended')}}\",\n \"sweepConfigurations\": {}\n }\n ],\n \"hasNext\": {{faker 'datatype.boolean'}},\n \"hasPrevious\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9273160c-e1b5-45d2-897c-80695f402042", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e656267f-b7ff-4f72-88c9-dc0b630bb0ce", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9876e22f-0dfc-4543-abd6-7d908351993b", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5a5023ee-3453-4a18-aa1e-d9902d7dab80", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ff9bcf4e-db16-4d0d-9d1e-2ca4422f5f64", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "83e850d3-2927-4ab2-a836-4e0fa10bb46b", "documentation": "Upload a document for verification checks.", "method": "post", "endpoint": "documents", "responses": [ { "uuid": "6fe70115-80c9-4f47-8886-98204f7fc914", "body": "{\n \"attachment\": {\n \"content\": \"\",\n \"contentType\": \"\",\n \"filename\": \"\",\n \"pageType\": \"\"\n },\n \"attachments\": [\n {\n \"content\": \"\",\n \"contentType\": \"\",\n \"filename\": \"\",\n \"pageType\": \"\"\n }\n ],\n \"description\": \"\",\n \"expiryDate\": \"\",\n \"id\": \"\",\n \"issuerCountry\": \"\",\n \"issuerState\": \"\",\n \"number\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"{{oneOf (array 'bankStatement' 'driversLicense' 'identityCard' 'nationalIdNumber' 'passport' 'proofOfAddress' 'proofOfNationalIdNumber' 'proofOfResidency' 'registrationDocument' 'taxDocument')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "36da4a75-9295-4640-baa3-715657b8cb81", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dd6683ba-459e-46b0-9957-7e41155237d2", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a66e0da7-d2e5-4971-9528-619d6ee475ba", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0cd6ac3d-c34b-4560-b56c-ff96a46222e5", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5747af34-14b0-44dc-aeb0-b2d8a81ffbd0", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fafec601-7a02-4199-9ac5-2518fc6f23d5", "documentation": "Delete a document.", "method": "delete", "endpoint": "documents/:id", "responses": [ { "uuid": "2428de69-a945-4cf3-bb7d-c74df2642795", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6de021bf-e44e-46f4-9ab7-9e47d58e9dd9", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "408f6317-6700-44f0-9bc3-4a6e68637eb0", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1738ce5e-0096-4b80-ae87-11e728973e1f", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4284eff5-1f1d-424f-9d37-9b0fc788cc60", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "55ad46f0-8fa3-41cb-90a3-5bd652517aff", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cf3ac2b8-89b4-4aec-8859-90286cae29bf", "documentation": "Retrieve a document.", "method": "get", "endpoint": "documents/:id", "responses": [ { "uuid": "8f5e089f-b9ea-4928-970f-e07391e8f35a", "body": "{\n \"attachment\": {\n \"content\": \"\",\n \"contentType\": \"\",\n \"filename\": \"\",\n \"pageType\": \"\"\n },\n \"attachments\": [\n {\n \"content\": \"\",\n \"contentType\": \"\",\n \"filename\": \"\",\n \"pageType\": \"\"\n }\n ],\n \"description\": \"\",\n \"expiryDate\": \"\",\n \"id\": \"\",\n \"issuerCountry\": \"\",\n \"issuerState\": \"\",\n \"number\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"{{oneOf (array 'bankStatement' 'driversLicense' 'identityCard' 'nationalIdNumber' 'passport' 'proofOfAddress' 'proofOfNationalIdNumber' 'proofOfResidency' 'registrationDocument' 'taxDocument')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0eec7598-62e4-445d-b0c5-75c8b582d09d", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b2258a28-f91b-442f-9f36-4492898636e9", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0bae848c-bf95-4479-9a85-1d4d3340b810", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "46e8545e-b567-47c4-82d9-3f8241237614", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2759f5e5-3c71-4885-863b-e5fdaa6e30a6", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "57f86780-75dd-455b-80e2-0f090e815632", "documentation": "Update a document.", "method": "patch", "endpoint": "documents/:id", "responses": [ { "uuid": "023136c2-85d1-450e-ab5b-0eb307e2ba5c", "body": "{\n \"attachment\": {\n \"content\": \"\",\n \"contentType\": \"\",\n \"filename\": \"\",\n \"pageType\": \"\"\n },\n \"attachments\": [\n {\n \"content\": \"\",\n \"contentType\": \"\",\n \"filename\": \"\",\n \"pageType\": \"\"\n }\n ],\n \"description\": \"\",\n \"expiryDate\": \"\",\n \"id\": \"\",\n \"issuerCountry\": \"\",\n \"issuerState\": \"\",\n \"number\": \"\",\n \"owner\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"type\": \"{{oneOf (array 'bankStatement' 'driversLicense' 'identityCard' 'nationalIdNumber' 'passport' 'proofOfAddress' 'proofOfNationalIdNumber' 'proofOfResidency' 'registrationDocument' 'taxDocument')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0e8cd309-e4d5-4bae-9cad-55c59d8f7afe", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b7e64095-f511-47cc-9421-2fdd99dad26e", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "62175d41-16e7-487a-b627-ead446c29521", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c460bcc0-fc6e-44ce-a857-492c1b6fd895", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2cfad67a-2c9c-4a19-93be-5343a7226079", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9f3f3fb1-cca3-4f56-aa52-23bf5ecf8657", "documentation": "Create a legal entity.", "method": "post", "endpoint": "legalEntities", "responses": [ { "uuid": "b47742b5-b762-4c8b-928a-bad954c2e4ef", "body": "{\n \"documents\": [\n {\n \"id\": \"\"\n }\n ],\n \"entityAssociations\": [\n {\n \"jobTitle\": \"\",\n \"legalEntityId\": \"\",\n \"type\": \"{{oneOf (array 'signatory' 'uboThroughControl' 'uboThroughOwnership')}}\"\n }\n ],\n \"id\": \"\",\n \"individual\": {\n \"birthData\": {\n \"dateOfBirth\": \"\"\n },\n \"email\": \"\",\n \"identificationData\": {\n \"expiryDate\": \"\",\n \"issuerCountry\": \"\",\n \"issuerState\": \"\",\n \"nationalIdExempt\": {{faker 'datatype.boolean'}},\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'bankStatement' 'driversLicense' 'identityCard' 'nationalIdNumber' 'passport' 'proofOfAddress' 'proofOfNationalIdNumber' 'proofOfResidency' 'registrationDocument' 'taxDocument')}}\"\n },\n \"name\": {\n \"firstName\": \"\",\n \"infix\": \"\",\n \"lastName\": \"\"\n },\n \"nationality\": \"\",\n \"phone\": {\n \"countryCode\": \"\",\n \"number\": \"\",\n \"type\": \"\"\n },\n \"residentialAddress\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"webData\": {\n \"appAddress\": \"\",\n \"webAddress\": \"\"\n }\n },\n \"organization\": {\n \"description\": \"\",\n \"doingBusinessAs\": \"\",\n \"email\": \"\",\n \"legalName\": \"\",\n \"phone\": {\n \"countryCode\": \"\",\n \"number\": \"\",\n \"type\": \"\"\n },\n \"principalPlaceOfBusiness\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"registeredAddress\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"registrationNumber\": \"\",\n \"stockData\": {\n \"marketIdentifier\": \"\",\n \"stockNumber\": \"\",\n \"tickerSymbol\": \"\"\n },\n \"taxId\": \"\",\n \"taxIdAbsenceReason\": \"{{oneOf (array 'industryExemption' 'belowTaxThreshold')}}\",\n \"type\": \"{{oneOf (array 'associationIncorporated' 'governmentalOrganization' 'listedPublicCompany' 'nonProfit' 'partnershipIncorporated' 'privateCompany')}}\",\n \"webData\": {\n \"appAddress\": \"\",\n \"webAddress\": \"\"\n }\n },\n \"transferInstruments\": [\n {\n \"id\": \"\"\n }\n ],\n \"type\": \"{{oneOf (array 'individual' 'organization')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a9e1f29b-4a96-4d4c-9a6d-619d18f861fd", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "644b5edf-015e-489b-854b-9c776cd2f00c", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ff07c014-31fc-4d07-8e69-3544b6a52f20", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f21b2365-ed64-4fda-aa2b-cbaac311fa4f", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ba76bc08-3ce1-46bf-8f0d-4c84338ad8ab", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4cc01881-58ca-4ebd-8eea-593560f88c56", "documentation": "Retrieve a legal entity.", "method": "get", "endpoint": "legalEntities/:id", "responses": [ { "uuid": "b0944e42-48df-4a4b-8ef2-bac2d91ef76c", "body": "{\n \"documents\": [\n {\n \"id\": \"\"\n }\n ],\n \"entityAssociations\": [\n {\n \"jobTitle\": \"\",\n \"legalEntityId\": \"\",\n \"type\": \"{{oneOf (array 'signatory' 'uboThroughControl' 'uboThroughOwnership')}}\"\n }\n ],\n \"id\": \"\",\n \"individual\": {\n \"birthData\": {\n \"dateOfBirth\": \"\"\n },\n \"email\": \"\",\n \"identificationData\": {\n \"expiryDate\": \"\",\n \"issuerCountry\": \"\",\n \"issuerState\": \"\",\n \"nationalIdExempt\": {{faker 'datatype.boolean'}},\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'bankStatement' 'driversLicense' 'identityCard' 'nationalIdNumber' 'passport' 'proofOfAddress' 'proofOfNationalIdNumber' 'proofOfResidency' 'registrationDocument' 'taxDocument')}}\"\n },\n \"name\": {\n \"firstName\": \"\",\n \"infix\": \"\",\n \"lastName\": \"\"\n },\n \"nationality\": \"\",\n \"phone\": {\n \"countryCode\": \"\",\n \"number\": \"\",\n \"type\": \"\"\n },\n \"residentialAddress\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"webData\": {\n \"appAddress\": \"\",\n \"webAddress\": \"\"\n }\n },\n \"organization\": {\n \"description\": \"\",\n \"doingBusinessAs\": \"\",\n \"email\": \"\",\n \"legalName\": \"\",\n \"phone\": {\n \"countryCode\": \"\",\n \"number\": \"\",\n \"type\": \"\"\n },\n \"principalPlaceOfBusiness\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"registeredAddress\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"registrationNumber\": \"\",\n \"stockData\": {\n \"marketIdentifier\": \"\",\n \"stockNumber\": \"\",\n \"tickerSymbol\": \"\"\n },\n \"taxId\": \"\",\n \"taxIdAbsenceReason\": \"{{oneOf (array 'industryExemption' 'belowTaxThreshold')}}\",\n \"type\": \"{{oneOf (array 'associationIncorporated' 'governmentalOrganization' 'listedPublicCompany' 'nonProfit' 'partnershipIncorporated' 'privateCompany')}}\",\n \"webData\": {\n \"appAddress\": \"\",\n \"webAddress\": \"\"\n }\n },\n \"transferInstruments\": [\n {\n \"id\": \"\"\n }\n ],\n \"type\": \"{{oneOf (array 'individual' 'organization')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fe583d62-d76f-441f-95f5-e5eff64985e6", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "41a18196-ceff-4344-ae42-56952b81ec2f", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "18df7caa-5911-4324-b44b-4c111a9a4342", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "083f82ff-e8cf-4e26-92ce-7f112d4bab2a", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e43945d6-2eac-4a6c-8db5-cfc9175fe131", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9fb4c722-9dff-4775-85a5-3d01ddd958e6", "documentation": "Update a legal entity.", "method": "patch", "endpoint": "legalEntities/:id", "responses": [ { "uuid": "0cabbcb6-1971-44a3-a10d-0d7d99e2c471", "body": "{\n \"documents\": [\n {\n \"id\": \"\"\n }\n ],\n \"entityAssociations\": [\n {\n \"jobTitle\": \"\",\n \"legalEntityId\": \"\",\n \"type\": \"{{oneOf (array 'signatory' 'uboThroughControl' 'uboThroughOwnership')}}\"\n }\n ],\n \"id\": \"\",\n \"individual\": {\n \"birthData\": {\n \"dateOfBirth\": \"\"\n },\n \"email\": \"\",\n \"identificationData\": {\n \"expiryDate\": \"\",\n \"issuerCountry\": \"\",\n \"issuerState\": \"\",\n \"nationalIdExempt\": {{faker 'datatype.boolean'}},\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'bankStatement' 'driversLicense' 'identityCard' 'nationalIdNumber' 'passport' 'proofOfAddress' 'proofOfNationalIdNumber' 'proofOfResidency' 'registrationDocument' 'taxDocument')}}\"\n },\n \"name\": {\n \"firstName\": \"\",\n \"infix\": \"\",\n \"lastName\": \"\"\n },\n \"nationality\": \"\",\n \"phone\": {\n \"countryCode\": \"\",\n \"number\": \"\",\n \"type\": \"\"\n },\n \"residentialAddress\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"webData\": {\n \"appAddress\": \"\",\n \"webAddress\": \"\"\n }\n },\n \"organization\": {\n \"description\": \"\",\n \"doingBusinessAs\": \"\",\n \"email\": \"\",\n \"legalName\": \"\",\n \"phone\": {\n \"countryCode\": \"\",\n \"number\": \"\",\n \"type\": \"\"\n },\n \"principalPlaceOfBusiness\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"registeredAddress\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\",\n \"street2\": \"\"\n },\n \"registrationNumber\": \"\",\n \"stockData\": {\n \"marketIdentifier\": \"\",\n \"stockNumber\": \"\",\n \"tickerSymbol\": \"\"\n },\n \"taxId\": \"\",\n \"taxIdAbsenceReason\": \"{{oneOf (array 'industryExemption' 'belowTaxThreshold')}}\",\n \"type\": \"{{oneOf (array 'associationIncorporated' 'governmentalOrganization' 'listedPublicCompany' 'nonProfit' 'partnershipIncorporated' 'privateCompany')}}\",\n \"webData\": {\n \"appAddress\": \"\",\n \"webAddress\": \"\"\n }\n },\n \"transferInstruments\": [\n {\n \"id\": \"\"\n }\n ],\n \"type\": \"{{oneOf (array 'individual' 'organization')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e8fa1c21-670a-4ac6-ba02-15952e03c662", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6adf00e7-cf6c-4b1a-aeef-9f2da5300062", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f6ef6d63-f1a4-4e45-a405-0fecbfa614c7", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "33689da8-236c-4c6b-921c-e46e06871336", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2386f510-f2d0-481d-81f5-72e2837fd6c7", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "31937c93-b74d-4fa9-baa3-af1bb63b7fb5", "documentation": "Create a payment instrument group.", "method": "post", "endpoint": "paymentInstrumentGroups", "responses": [ { "uuid": "1d53dc64-fa1e-41b8-923e-b1c82ce60d5c", "body": "{\n \"balancePlatform\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"reference\": \"\",\n \"txVariant\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9defabe9-47f5-46d7-8528-8819614dfcfe", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1c607897-78e5-44dd-a8af-e4af77df4dfd", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d3da33af-7a9e-41e0-b66a-43882e7a6a45", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cd0acf6a-bfd4-4d41-9519-5acf7d0f782d", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c03449f5-fd1b-4bbb-91d6-46466eab75ba", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "743c68c7-db97-4302-a96f-139af3c7f711", "documentation": "Retrieve a payment instrument group.", "method": "get", "endpoint": "paymentInstrumentGroups/:id", "responses": [ { "uuid": "c60fc101-0e43-4eee-a196-568ae5062ebb", "body": "{\n \"balancePlatform\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"reference\": \"\",\n \"txVariant\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "612cc0dc-bdde-44a8-a44e-a4201cf04f9a", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0c5f4939-cee2-419c-a777-93c84aa90dcb", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0a871ac3-07cc-4d10-bdf2-e2f886180aa8", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9cb9cd5b-27ee-46c8-a085-202b02061beb", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f42186cc-fa2f-4774-923c-9ba207ba3680", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6edd03ab-f37f-4dc3-bc88-c211ea24f8f8", "documentation": "Retrieve all transaction rules for a specific payment instruments group.", "method": "get", "endpoint": "paymentInstrumentGroups/:id/transactionRules", "responses": [ { "uuid": "5bdceeb7-1ef1-4940-a771-b5ad25bc5d7f", "body": "{\n \"transactionRules\": [\n {\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balancePlatformId\": \"\",\n \"countries\": [\n \"\"\n ],\n \"description\": \"\",\n \"endDate\": \"\",\n \"entryModes\": [\n \"{{oneOf (array 'barcode' 'chip' 'cof' 'contactless' 'magstripe' 'manual' 'ocr' 'server' 'token' 'unknown')}}\"\n ],\n \"id\": \"\",\n \"interval\": {\n \"type\": \"{{oneOf (array 'daily' 'lifetime' 'monthly' 'perTransaction' 'weekly')}}\"\n },\n \"maxTransactions\": {{faker 'number.int' max=99999}},\n \"mccs\": [\n \"\"\n ],\n \"paymentInstrumentGroupId\": \"\",\n \"paymentInstrumentId\": \"\",\n \"processingTypes\": [\n \"{{oneOf (array 'atmWithdraw' 'balanceInquiry' 'ecommerce' 'moto' 'pos' 'purchaseWithCashback' 'recurring' 'token' 'unknown')}}\"\n ],\n \"reference\": \"\",\n \"startDate\": \"\",\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"type\": \"{{oneOf (array 'allowList' 'blockList' 'maxUsage' 'velocity')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "59c81516-7924-4e2b-9187-85949c49eb3d", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0acf7f50-e6fe-444c-ba07-994e466a9d7f", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5c1f786e-fd8b-4c5d-97d7-3a1d287237ef", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1290fda7-a935-48d9-8a85-ac6519978396", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3b5444ec-5b5c-4b51-9349-3fa5d5cf0470", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "67bf9af3-5b8a-4751-af6e-77fee9424a1e", "documentation": "Create a payment instrument.", "method": "post", "endpoint": "paymentInstruments", "responses": [ { "uuid": "0820bc74-4b77-47e4-b2d1-5dd9a20d0ed4", "body": "{\n \"balanceAccountId\": \"\",\n \"card\": {\n \"authentication\": {\n \"password\": \"\",\n \"phone\": {\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'Landline' 'Mobile')}}\"\n }\n },\n \"bin\": \"\",\n \"brand\": \"\",\n \"brandVariant\": \"\",\n \"cardholderName\": \"\",\n \"configuration\": {\n \"activation\": \"\",\n \"activationUrl\": \"\",\n \"bulkAddress\": {\n \"city\": \"\",\n \"company\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"houseNumberOrName\": \"\",\n \"mobile\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"cardImageId\": \"\",\n \"carrier\": \"\",\n \"carrierImageId\": \"\",\n \"configurationProfileId\": \"\",\n \"currency\": \"\",\n \"envelope\": \"\",\n \"insert\": \"\",\n \"language\": \"\",\n \"logoImageId\": \"\",\n \"pinMailer\": \"\",\n \"shipmentMethod\": \"\"\n },\n \"cvc\": \"\",\n \"deliveryContact\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"email\": \"\",\n \"fullPhoneNumber\": \"\",\n \"name\": {\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"personalData\": {\n \"dateOfBirth\": \"\",\n \"idNumber\": \"\",\n \"nationality\": \"\"\n },\n \"phoneNumber\": {\n \"phoneCountryCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneType\": \"{{oneOf (array 'Fax' 'Landline' 'Mobile' 'SIP')}}\"\n },\n \"webAddress\": \"\"\n },\n \"expiration\": {\n \"month\": \"\",\n \"year\": \"\"\n },\n \"formFactor\": \"{{oneOf (array 'physical' 'unknown' 'virtual')}}\",\n \"lastFour\": \"\",\n \"number\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"issuingCountryCode\": \"\",\n \"paymentInstrumentGroupId\": \"\",\n \"reference\": \"\",\n \"status\": \"{{oneOf (array 'Active' 'Closed' 'Inactive' 'Lost' 'Requested' 'Stolen' 'Suspended')}}\",\n \"type\": \"{{oneOf (array 'bankAccount' 'card' 'unknown')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a17828ba-0288-4fdc-8231-70dfdd175223", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d71603a-af39-43a5-853c-c4c787f5d67e", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5a1f35f8-fa4b-4f72-940a-05b4565ed8f7", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2f716f39-217b-4299-9bf0-1a7391a76556", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a25fb5fc-f9c3-457c-b4bd-70faa5b6949b", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "59081d00-1117-400a-8949-e17ea5a7b890", "documentation": "Retrieve a payment instrument.", "method": "get", "endpoint": "paymentInstruments/:id", "responses": [ { "uuid": "46eb70ea-6897-444c-b087-ede0d0d10c8d", "body": "{\n \"balanceAccountId\": \"\",\n \"card\": {\n \"authentication\": {\n \"password\": \"\",\n \"phone\": {\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'Landline' 'Mobile')}}\"\n }\n },\n \"bin\": \"\",\n \"brand\": \"\",\n \"brandVariant\": \"\",\n \"cardholderName\": \"\",\n \"configuration\": {\n \"activation\": \"\",\n \"activationUrl\": \"\",\n \"bulkAddress\": {\n \"city\": \"\",\n \"company\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"houseNumberOrName\": \"\",\n \"mobile\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"cardImageId\": \"\",\n \"carrier\": \"\",\n \"carrierImageId\": \"\",\n \"configurationProfileId\": \"\",\n \"currency\": \"\",\n \"envelope\": \"\",\n \"insert\": \"\",\n \"language\": \"\",\n \"logoImageId\": \"\",\n \"pinMailer\": \"\",\n \"shipmentMethod\": \"\"\n },\n \"cvc\": \"\",\n \"deliveryContact\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"email\": \"\",\n \"fullPhoneNumber\": \"\",\n \"name\": {\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"personalData\": {\n \"dateOfBirth\": \"\",\n \"idNumber\": \"\",\n \"nationality\": \"\"\n },\n \"phoneNumber\": {\n \"phoneCountryCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneType\": \"{{oneOf (array 'Fax' 'Landline' 'Mobile' 'SIP')}}\"\n },\n \"webAddress\": \"\"\n },\n \"expiration\": {\n \"month\": \"\",\n \"year\": \"\"\n },\n \"formFactor\": \"{{oneOf (array 'physical' 'unknown' 'virtual')}}\",\n \"lastFour\": \"\",\n \"number\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"issuingCountryCode\": \"\",\n \"paymentInstrumentGroupId\": \"\",\n \"reference\": \"\",\n \"status\": \"{{oneOf (array 'Active' 'Closed' 'Inactive' 'Lost' 'Requested' 'Stolen' 'Suspended')}}\",\n \"type\": \"{{oneOf (array 'bankAccount' 'card' 'unknown')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "87df2bea-cdb9-4be7-a454-088c8468ee27", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c8e36f73-f9ff-4a94-ba05-acd1b470103b", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e8cf7a11-25b6-4527-9c81-ad1d6cc64353", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a01735b4-6942-40bd-b107-3c6e3b6d2042", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4ff8efd1-9690-442c-9b1a-300304ecdf71", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3e8346db-db64-4ed9-9650-3b5671166a94", "documentation": "Update a payment instrument.", "method": "patch", "endpoint": "paymentInstruments/:id", "responses": [ { "uuid": "1957b57a-259c-42b3-8d47-43ce0e481f86", "body": "{\n \"balanceAccountId\": \"\",\n \"card\": {\n \"authentication\": {\n \"password\": \"\",\n \"phone\": {\n \"number\": \"\",\n \"type\": \"{{oneOf (array 'Landline' 'Mobile')}}\"\n }\n },\n \"bin\": \"\",\n \"brand\": \"\",\n \"brandVariant\": \"\",\n \"cardholderName\": \"\",\n \"configuration\": {\n \"activation\": \"\",\n \"activationUrl\": \"\",\n \"bulkAddress\": {\n \"city\": \"\",\n \"company\": \"\",\n \"country\": \"\",\n \"email\": \"\",\n \"houseNumberOrName\": \"\",\n \"mobile\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"cardImageId\": \"\",\n \"carrier\": \"\",\n \"carrierImageId\": \"\",\n \"configurationProfileId\": \"\",\n \"currency\": \"\",\n \"envelope\": \"\",\n \"insert\": \"\",\n \"language\": \"\",\n \"logoImageId\": \"\",\n \"pinMailer\": \"\",\n \"shipmentMethod\": \"\"\n },\n \"cvc\": \"\",\n \"deliveryContact\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"email\": \"\",\n \"fullPhoneNumber\": \"\",\n \"name\": {\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"personalData\": {\n \"dateOfBirth\": \"\",\n \"idNumber\": \"\",\n \"nationality\": \"\"\n },\n \"phoneNumber\": {\n \"phoneCountryCode\": \"\",\n \"phoneNumber\": \"\",\n \"phoneType\": \"{{oneOf (array 'Fax' 'Landline' 'Mobile' 'SIP')}}\"\n },\n \"webAddress\": \"\"\n },\n \"expiration\": {\n \"month\": \"\",\n \"year\": \"\"\n },\n \"formFactor\": \"{{oneOf (array 'physical' 'unknown' 'virtual')}}\",\n \"lastFour\": \"\",\n \"number\": \"\"\n },\n \"description\": \"\",\n \"id\": \"\",\n \"issuingCountryCode\": \"\",\n \"paymentInstrumentGroupId\": \"\",\n \"reference\": \"\",\n \"status\": \"{{oneOf (array 'Active' 'Closed' 'Inactive' 'Lost' 'Requested' 'Stolen' 'Suspended')}}\",\n \"type\": \"{{oneOf (array 'bankAccount' 'card' 'unknown')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "11c67fd9-1c0f-4ccf-a771-1f68a0f4d5a7", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "72aa772a-8a18-4b4a-9e53-5a7b761bc371", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "11a68929-342a-4504-ae3c-efe925e82deb", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9865d31c-f344-40b1-9442-9da381c08b61", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c7314be8-dfff-43b3-b0cc-7a57460ba6a0", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a2598f52-d417-4018-bad6-fe594521c1b2", "documentation": "Retrieve all transaction rules for a specific payment instrument.", "method": "get", "endpoint": "paymentInstruments/:id/transactionRules", "responses": [ { "uuid": "a3a15a87-b60d-462f-8740-8b92b286936b", "body": "{\n \"transactionRules\": [\n {\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balancePlatformId\": \"\",\n \"countries\": [\n \"\"\n ],\n \"description\": \"\",\n \"endDate\": \"\",\n \"entryModes\": [\n \"{{oneOf (array 'barcode' 'chip' 'cof' 'contactless' 'magstripe' 'manual' 'ocr' 'server' 'token' 'unknown')}}\"\n ],\n \"id\": \"\",\n \"interval\": {\n \"type\": \"{{oneOf (array 'daily' 'lifetime' 'monthly' 'perTransaction' 'weekly')}}\"\n },\n \"maxTransactions\": {{faker 'number.int' max=99999}},\n \"mccs\": [\n \"\"\n ],\n \"paymentInstrumentGroupId\": \"\",\n \"paymentInstrumentId\": \"\",\n \"processingTypes\": [\n \"{{oneOf (array 'atmWithdraw' 'balanceInquiry' 'ecommerce' 'moto' 'pos' 'purchaseWithCashback' 'recurring' 'token' 'unknown')}}\"\n ],\n \"reference\": \"\",\n \"startDate\": \"\",\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"type\": \"{{oneOf (array 'allowList' 'blockList' 'maxUsage' 'velocity')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "88a82127-6794-4045-9a1c-5208449e2c13", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eddd22a1-18e1-446f-a44c-0ca25a666983", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dedce9c1-94f1-44b6-99a2-f7fe0fdee047", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bfbd0bae-34bc-44e4-8e18-44c39c7b8022", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d52c4fc9-93bc-4eb1-9caa-5d7da6a3d355", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "df6fbb04-22d9-4825-902c-f1a5ac2e3da9", "documentation": "Create a transaction rule.", "method": "post", "endpoint": "transactionRules", "responses": [ { "uuid": "6dd30e95-a00c-45c6-ade2-1aaf646d40bd", "body": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balancePlatformId\": \"\",\n \"countries\": [\n \"\"\n ],\n \"description\": \"\",\n \"endDate\": \"\",\n \"entryModes\": [\n \"{{oneOf (array 'barcode' 'chip' 'cof' 'contactless' 'magstripe' 'manual' 'ocr' 'server' 'token' 'unknown')}}\"\n ],\n \"id\": \"\",\n \"interval\": {\n \"type\": \"{{oneOf (array 'daily' 'lifetime' 'monthly' 'perTransaction' 'weekly')}}\"\n },\n \"maxTransactions\": {{faker 'number.int' max=99999}},\n \"mccs\": [\n \"\"\n ],\n \"paymentInstrumentGroupId\": \"\",\n \"paymentInstrumentId\": \"\",\n \"processingTypes\": [\n \"{{oneOf (array 'atmWithdraw' 'balanceInquiry' 'ecommerce' 'moto' 'pos' 'purchaseWithCashback' 'recurring' 'token' 'unknown')}}\"\n ],\n \"reference\": \"\",\n \"startDate\": \"\",\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"type\": \"{{oneOf (array 'allowList' 'blockList' 'maxUsage' 'velocity')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "49c0944f-a2a7-4072-b60e-85f00bc8c9ec", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "561b1c77-f96d-49f2-aa42-c895fc1e9dbe", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "edf13b79-64c0-46ce-9c20-651ed6eeb7ed", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4dfbb027-a19e-485c-8bb7-285564336426", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "acc86882-db05-452b-a475-cc05bb921019", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "346664e8-8067-4b1b-8290-29e00af0be28", "documentation": "Delete a transaction rule.", "method": "delete", "endpoint": "transactionRules/:transactionRuleId", "responses": [ { "uuid": "f2bf751a-4d58-4720-9524-2aded70535bd", "body": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balancePlatformId\": \"\",\n \"countries\": [\n \"\"\n ],\n \"description\": \"\",\n \"endDate\": \"\",\n \"entryModes\": [\n \"{{oneOf (array 'barcode' 'chip' 'cof' 'contactless' 'magstripe' 'manual' 'ocr' 'server' 'token' 'unknown')}}\"\n ],\n \"id\": \"\",\n \"interval\": {\n \"type\": \"{{oneOf (array 'daily' 'lifetime' 'monthly' 'perTransaction' 'weekly')}}\"\n },\n \"maxTransactions\": {{faker 'number.int' max=99999}},\n \"mccs\": [\n \"\"\n ],\n \"paymentInstrumentGroupId\": \"\",\n \"paymentInstrumentId\": \"\",\n \"processingTypes\": [\n \"{{oneOf (array 'atmWithdraw' 'balanceInquiry' 'ecommerce' 'moto' 'pos' 'purchaseWithCashback' 'recurring' 'token' 'unknown')}}\"\n ],\n \"reference\": \"\",\n \"startDate\": \"\",\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"type\": \"{{oneOf (array 'allowList' 'blockList' 'maxUsage' 'velocity')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4721a30b-2577-456e-865a-851b636b7a4a", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cfe578eb-76a0-40b5-afb1-77ab4a97a774", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8da36b5b-bb89-4ffb-841c-1c17a33e62a6", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e860cf75-a56e-4a4e-9a76-03f99f58fe0a", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "06c3e749-f98d-40bc-b79f-ab0cbbcfb302", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "98eea970-ef12-4b2e-ae9a-62b1b0d3bf63", "documentation": "Retrieve a transaction rule.", "method": "get", "endpoint": "transactionRules/:transactionRuleId", "responses": [ { "uuid": "48b785e5-5145-43ce-995a-48e3a99e0af5", "body": "{\n \"transactionRule\": {\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balancePlatformId\": \"\",\n \"countries\": [\n \"\"\n ],\n \"description\": \"\",\n \"endDate\": \"\",\n \"entryModes\": [\n \"{{oneOf (array 'barcode' 'chip' 'cof' 'contactless' 'magstripe' 'manual' 'ocr' 'server' 'token' 'unknown')}}\"\n ],\n \"id\": \"\",\n \"interval\": {\n \"type\": \"{{oneOf (array 'daily' 'lifetime' 'monthly' 'perTransaction' 'weekly')}}\"\n },\n \"maxTransactions\": {{faker 'number.int' max=99999}},\n \"mccs\": [\n \"\"\n ],\n \"paymentInstrumentGroupId\": \"\",\n \"paymentInstrumentId\": \"\",\n \"processingTypes\": [\n \"{{oneOf (array 'atmWithdraw' 'balanceInquiry' 'ecommerce' 'moto' 'pos' 'purchaseWithCashback' 'recurring' 'token' 'unknown')}}\"\n ],\n \"reference\": \"\",\n \"startDate\": \"\",\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"type\": \"{{oneOf (array 'allowList' 'blockList' 'maxUsage' 'velocity')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b1c79545-6e14-4acb-a81f-5c8b41280e9b", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dc293526-6f69-49b4-9f9e-51d1dbcfad91", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fb1447d9-3ee7-437e-b731-29f789e27399", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6e1b4572-1ac7-4b15-9a01-a339ba1f30ea", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1c73c54c-a638-450f-b02f-34b80fd2c24d", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a929ce53-d4f3-4d2a-ae26-e38ae17986bf", "documentation": "Update a transaction rule.", "method": "patch", "endpoint": "transactionRules/:transactionRuleId", "responses": [ { "uuid": "93cbabdb-9594-4071-a7cb-72c463c9db59", "body": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balancePlatformId\": \"\",\n \"countries\": [\n \"\"\n ],\n \"description\": \"\",\n \"endDate\": \"\",\n \"entryModes\": [\n \"{{oneOf (array 'barcode' 'chip' 'cof' 'contactless' 'magstripe' 'manual' 'ocr' 'server' 'token' 'unknown')}}\"\n ],\n \"id\": \"\",\n \"interval\": {\n \"type\": \"{{oneOf (array 'daily' 'lifetime' 'monthly' 'perTransaction' 'weekly')}}\"\n },\n \"maxTransactions\": {{faker 'number.int' max=99999}},\n \"mccs\": [\n \"\"\n ],\n \"paymentInstrumentGroupId\": \"\",\n \"paymentInstrumentId\": \"\",\n \"processingTypes\": [\n \"{{oneOf (array 'atmWithdraw' 'balanceInquiry' 'ecommerce' 'moto' 'pos' 'purchaseWithCashback' 'recurring' 'token' 'unknown')}}\"\n ],\n \"reference\": \"\",\n \"startDate\": \"\",\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"type\": \"{{oneOf (array 'allowList' 'blockList' 'maxUsage' 'velocity')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f9e156a6-5780-4279-a8a3-92ed4a5e1755", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4064985d-7993-4723-9b83-100475ad44d5", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "101b48c3-b240-4a2d-85df-6cd2de9a9778", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "27fe2db5-1c0c-4672-8ab3-f785c817e791", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c3de5aa9-cdf7-4f0a-ae7d-096ee0075cd2", "body": "{\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"instance\": \"\",\n \"invalidFields\": [\n {\n \"message\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": {{faker 'number.int' max=99999}},\n \"title\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "93af134e-fdcd-482d-9479-ffd69227d2b9", "documentation": "Create a transfer instrument.", "method": "post", "endpoint": "transferInstruments", "responses": [ { "uuid": "a09d72e1-730b-4f50-a9d6-806112ca3416", "body": "{\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bankBicSwift\": \"\",\n \"bankCity\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"branchCode\": \"\",\n \"checkCode\": \"\",\n \"countryCode\": \"\",\n \"currencyCode\": \"\",\n \"iban\": \"\"\n },\n \"id\": \"\",\n \"legalEntityId\": \"\",\n \"recurringDetail\": {\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"shopperReference\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "432e107f-37f7-467d-8b94-5427d7aeeba1", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "141df5e0-d9df-4b7b-b116-2d440aea8141", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c4937753-1dca-48d6-bc8e-30acafbf7ec8", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7c30acab-d3c2-4e9d-9a36-8c4cc2757ba0", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e7b38418-01e6-4346-89ab-42c21efb774c", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8f991ca3-5a5c-4bd5-93da-a53df7082ac6", "documentation": "Delete a transfer instrument", "method": "delete", "endpoint": "transferInstruments/:id", "responses": [ { "uuid": "16aed5a5-b379-4e82-bdcf-718c211786a0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "48207fa8-b715-4577-aad6-6289ee96a017", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d0299edd-864b-411e-8a39-0fc3d014de1f", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3b7d1d68-d152-4b95-b972-05ddc1d910f4", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b91c5c7b-4dad-447c-87cd-56cb9ee48147", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9f0cd2f5-fa88-4473-bb36-fe7b5fa471a8", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e474ec98-8f5e-4b9f-91fa-259aeb6a0eb9", "documentation": "Retrieve a transfer instrument.", "method": "get", "endpoint": "transferInstruments/:id", "responses": [ { "uuid": "f927f83d-ac42-4178-8c57-1e13345db3a9", "body": "{\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bankBicSwift\": \"\",\n \"bankCity\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"branchCode\": \"\",\n \"checkCode\": \"\",\n \"countryCode\": \"\",\n \"currencyCode\": \"\",\n \"iban\": \"\"\n },\n \"id\": \"\",\n \"legalEntityId\": \"\",\n \"recurringDetail\": {\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"shopperReference\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4f082026-5c59-4b8d-bf2a-5653fd1a81a5", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "da7a8ac3-3f39-48fb-9ff7-458d018ddddf", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f05ae286-26a2-4c98-9c12-be8291cb7a31", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7fb4f345-3f76-4c39-b18d-ee96fbf3030e", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "47538e12-6a75-4f56-8a74-95a6666adc2b", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e30f70fd-41f3-43d9-adfd-e057b4e57177", "documentation": "Update a transfer instrument.", "method": "patch", "endpoint": "transferInstruments/:id", "responses": [ { "uuid": "3bf7c763-32d4-4425-9c7a-3cefed74df07", "body": "{\n \"bankAccount\": {\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bankBicSwift\": \"\",\n \"bankCity\": \"\",\n \"bankCode\": \"\",\n \"bankName\": \"\",\n \"branchCode\": \"\",\n \"checkCode\": \"\",\n \"countryCode\": \"\",\n \"currencyCode\": \"\",\n \"iban\": \"\"\n },\n \"id\": \"\",\n \"legalEntityId\": \"\",\n \"recurringDetail\": {\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"shopperReference\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK - the request has succeeded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a978ed8d-84c9-40f1-bafa-75067dbcbf49", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 400, "label": "Bad Request - a problem reading or understanding the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "392416e0-0e98-4083-95bb-94e3d972a2f5", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized - authentication required.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "91dab10b-fd0c-40c6-913e-747de5b86c67", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 403, "label": "Forbidden - insufficient permissions to process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "208f18ad-502a-4b36-976d-1227a0ec0908", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity - a request validation error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0443c631-51af-43b7-9247-ff6123bde65b", "body": "{\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"pspReference\": \"\",\n \"status\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error - the server could not process the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "4dc0cb44-fd96-4eab-b06c-c45f34bfa225" }, { "type": "route", "uuid": "5eaafd12-11d0-4a42-893a-b8625678b82f" }, { "type": "route", "uuid": "1200f3d7-d475-42b5-bf43-64a5a0334ecd" }, { "type": "route", "uuid": "decd0859-4e4e-456f-ba16-1a4e97a6ceda" }, { "type": "route", "uuid": "549f169c-65a3-4a4a-8926-95d32fd5f6d8" }, { "type": "route", "uuid": "e695d884-947a-4a67-8693-82cdabeff8ae" }, { "type": "route", "uuid": "2e22da94-455d-47ee-9773-432b75bea03b" }, { "type": "route", "uuid": "f393b696-ef81-400e-bb55-4cc66a4d8b40" }, { "type": "route", "uuid": "4787aeb6-a80d-48c2-8b91-aa5cf3c9661f" }, { "type": "route", "uuid": "92e37adc-2e40-45e6-bc01-2d89f3a44eb0" }, { "type": "route", "uuid": "83e850d3-2927-4ab2-a836-4e0fa10bb46b" }, { "type": "route", "uuid": "fafec601-7a02-4199-9ac5-2518fc6f23d5" }, { "type": "route", "uuid": "cf3ac2b8-89b4-4aec-8859-90286cae29bf" }, { "type": "route", "uuid": "57f86780-75dd-455b-80e2-0f090e815632" }, { "type": "route", "uuid": "9f3f3fb1-cca3-4f56-aa52-23bf5ecf8657" }, { "type": "route", "uuid": "4cc01881-58ca-4ebd-8eea-593560f88c56" }, { "type": "route", "uuid": "9fb4c722-9dff-4775-85a5-3d01ddd958e6" }, { "type": "route", "uuid": "31937c93-b74d-4fa9-baa3-af1bb63b7fb5" }, { "type": "route", "uuid": "743c68c7-db97-4302-a96f-139af3c7f711" }, { "type": "route", "uuid": "6edd03ab-f37f-4dc3-bc88-c211ea24f8f8" }, { "type": "route", "uuid": "67bf9af3-5b8a-4751-af6e-77fee9424a1e" }, { "type": "route", "uuid": "59081d00-1117-400a-8949-e17ea5a7b890" }, { "type": "route", "uuid": "3e8346db-db64-4ed9-9650-3b5671166a94" }, { "type": "route", "uuid": "a2598f52-d417-4018-bad6-fe594521c1b2" }, { "type": "route", "uuid": "df6fbb04-22d9-4825-902c-f1a5ac2e3da9" }, { "type": "route", "uuid": "346664e8-8067-4b1b-8290-29e00af0be28" }, { "type": "route", "uuid": "98eea970-ef12-4b2e-ae9a-62b1b0d3bf63" }, { "type": "route", "uuid": "a929ce53-d4f3-4d2a-ae26-e38ae17986bf" }, { "type": "route", "uuid": "93af134e-fdcd-482d-9479-ffd69227d2b9" }, { "type": "route", "uuid": "8f991ca3-5a5c-4bd5-93da-a53df7082ac6" }, { "type": "route", "uuid": "e474ec98-8f5e-4b9f-91fa-259aeb6a0eb9" }, { "type": "route", "uuid": "e30f70fd-41f3-43d9-adfd-e057b4e57177" } ] }