{ "uuid": "4778d324-fdfd-48b3-af58-08ce0f75f996", "lastMigration": 29, "name": "Balance Platform Transfers API", "endpointPrefix": "btl/v2", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "c30d8d97-3fcc-46b2-bfca-05b80d3c4bc4", "documentation": "Get all transactions.", "method": "get", "endpoint": "transactions", "responses": [ { "uuid": "ec545cfd-c54e-409c-9153-0ecaf828b5f0", "body": "{\n \"_links\": {\n \"next\": {\n \"href\": \"\"\n },\n \"prev\": {\n \"href\": \"\"\n }\n },\n \"data\": [\n {\n \"accountHolderId\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balanceAccountId\": \"\",\n \"balancePlatform\": \"\",\n \"bookingDate\": \"{{faker 'date.recent' 365}}\",\n \"category\": \"{{oneOf (array 'bank' 'internal' 'issuedCard' 'platformPayment')}}\",\n \"counterparty\": {\n \"balanceAccountId\": \"\",\n \"bankAccount\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"iban\": \"\",\n \"ownerName\": {\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"infix\": \"\",\n \"lastName\": \"\"\n }\n },\n \"merchant\": {\n \"mcc\": \"\",\n \"merchantId\": \"\",\n \"nameLocation\": {\n \"city\": \"\",\n \"country\": \"\",\n \"countryOfOrigin\": \"\",\n \"name\": \"\",\n \"rawData\": \"\",\n \"state\": \"\"\n }\n },\n \"transferInstrumentId\": \"\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"id\": \"\",\n \"instructedAmount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"paymentInstrumentId\": \"\",\n \"reference\": \"\",\n \"referenceForBeneficiary\": \"\",\n \"status\": \"{{oneOf (array 'booked' 'pending')}}\",\n \"transferId\": \"\",\n \"type\": \"{{oneOf (array 'atmWithdrawal' 'atmWithdrawalReversal' 'bankTransfer' 'capture' 'captureReversal' 'chargeback' 'chargebackReversal' 'depositCorrection' 'fee' 'internalTransfer' 'invoiceDeduction' 'manualCorrection' 'miscCost' 'payment' 'paymentCost' 'refund' 'refundReversal' 'secondChargeback')}}\",\n \"valueDate\": \"{{faker 'date.recent' 365}}\"\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": "0daad3ca-5c4d-466e-8cba-7f40252dc2f6", "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": "56d58ff9-1c36-4197-96b7-64ee15826ef0", "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": "d84cd407-42f2-41c5-9ad7-73ecf1633376", "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": "c22447d9-01d2-47a1-8f4a-c0b43d72bd8f", "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": "99f96aa5-712e-4932-b943-a1a4a38b14cc", "documentation": "Get a transaction.", "method": "get", "endpoint": "transactions/:id", "responses": [ { "uuid": "f5763a32-0170-4902-8beb-c54663465d74", "body": "{\n \"accountHolderId\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balanceAccountId\": \"\",\n \"balancePlatform\": \"\",\n \"bookingDate\": \"{{faker 'date.recent' 365}}\",\n \"category\": \"{{oneOf (array 'bank' 'internal' 'issuedCard' 'platformPayment')}}\",\n \"counterparty\": {\n \"balanceAccountId\": \"\",\n \"bankAccount\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"iban\": \"\",\n \"ownerName\": {\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"infix\": \"\",\n \"lastName\": \"\"\n }\n },\n \"merchant\": {\n \"mcc\": \"\",\n \"merchantId\": \"\",\n \"nameLocation\": {\n \"city\": \"\",\n \"country\": \"\",\n \"countryOfOrigin\": \"\",\n \"name\": \"\",\n \"rawData\": \"\",\n \"state\": \"\"\n }\n },\n \"transferInstrumentId\": \"\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"id\": \"\",\n \"instructedAmount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"paymentInstrumentId\": \"\",\n \"reference\": \"\",\n \"referenceForBeneficiary\": \"\",\n \"status\": \"{{oneOf (array 'booked' 'pending')}}\",\n \"transferId\": \"\",\n \"type\": \"{{oneOf (array 'atmWithdrawal' 'atmWithdrawalReversal' 'bankTransfer' 'capture' 'captureReversal' 'chargeback' 'chargebackReversal' 'depositCorrection' 'fee' 'internalTransfer' 'invoiceDeduction' 'manualCorrection' 'miscCost' 'payment' 'paymentCost' 'refund' 'refundReversal' 'secondChargeback')}}\",\n \"valueDate\": \"{{faker 'date.recent' 365}}\"\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": "8a687044-2624-4ca6-8d0f-d40b89ebd9de", "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": "a287e922-b06c-4d15-9885-8ee5a93bb9ad", "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": "897f01c3-5f07-4c44-a7f9-97a5e7e83429", "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": "56d63429-c63c-4b5a-abc5-f6b906cca15c", "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": "7151fd22-e7a7-4c27-b877-632ceb5e784d", "documentation": "Transfer funds.", "method": "post", "endpoint": "transfers", "responses": [ { "uuid": "cca3ee6b-84d0-45d2-b430-b2980f9ee5a3", "body": "{\n \"amount\": {\n \"currency\": \"\",\n \"value\": {{faker 'number.int' max=99999}}\n },\n \"balanceAccountId\": \"\",\n \"bank\": {\n \"priority\": \"{{oneOf (array 'fast' 'regular' 'wire')}}\"\n },\n \"counterparty\": {\n \"balanceAccountId\": \"\",\n \"bankAccount\": {\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"houseNumberOrName\": \"\",\n \"postalCode\": \"\",\n \"stateOrProvince\": \"\",\n \"street\": \"\"\n },\n \"iban\": \"\",\n \"ownerName\": {\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"infix\": \"\",\n \"lastName\": \"\"\n }\n },\n \"merchant\": {\n \"mcc\": \"\",\n \"merchantId\": \"\",\n \"nameLocation\": {\n \"city\": \"\",\n \"country\": \"\",\n \"countryOfOrigin\": \"\",\n \"name\": \"\",\n \"rawData\": \"\",\n \"state\": \"\"\n }\n },\n \"transferInstrumentId\": \"\"\n },\n \"description\": \"\",\n \"direction\": \"{{oneOf (array 'incoming' 'outgoing')}}\",\n \"id\": \"\",\n \"paymentInstrumentId\": \"\",\n \"reason\": \"{{oneOf (array 'approved' 'notEnoughBalance' 'unknown')}}\",\n \"reference\": \"\",\n \"referenceForBeneficiary\": \"\",\n \"status\": \"{{oneOf (array 'authorised' 'refused')}}\"\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": "e6f2316d-d61e-453f-a396-6a0ed6247bc0", "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": "39acb5e0-ad3a-4f1e-92ce-d2ec5b17ef99", "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": "ee45b23c-e12e-4540-a2cb-b9772f8b6897", "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": "9b769fd6-1d6f-4636-9811-d29ab62aac63", "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" } ], "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": "c30d8d97-3fcc-46b2-bfca-05b80d3c4bc4" }, { "type": "route", "uuid": "99f96aa5-712e-4932-b943-a1a4a38b14cc" }, { "type": "route", "uuid": "7151fd22-e7a7-4c27-b877-632ceb5e784d" } ] }