{ "uuid": "2bc407b3-02da-4be8-ac42-93df93de1311", "lastMigration": 29, "name": "Fire Financial Services Business API", "endpointPrefix": "business/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "d4caab13-ae6b-4f55-93a0-d27a8b853aa6", "documentation": "List all fire.com Accounts", "method": "get", "endpoint": "accounts", "responses": [ { "uuid": "f800b4d7-b118-4f22-a45f-dfebf6c55261", "body": "{\n \"accounts\": [\n {\n \"balance\": 23950,\n \"cbic\": \"CPAYIE2D\",\n \"ccan\": \"11111111\",\n \"ciban\": \"IE54CPAY99119911111111\",\n \"cnsc\": \"232221\",\n \"colour\": \"ORANGE\",\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"defaultAccount\": true,\n \"directDebitsAllowed\": {{faker 'datatype.boolean'}},\n \"ican\": 42,\n \"name\": \"Main Account\",\n \"status\": \"{{oneOf (array 'LIVE' 'MIGRATED')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "An array of account objects.", "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": "e3cca42d-aa33-4689-a8ef-d86230bfcfcd", "body": "", "latency": 0, "statusCode": 401, "label": "Access Token is Invalid or missing", "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": "4d54e1f7-c241-4383-a2ad-3490396da175", "documentation": "Add a new account", "method": "post", "endpoint": "accounts", "responses": [ { "uuid": "d8f40afd-97ad-42d4-8e73-1a8bf4c37122", "body": "{\n \"balance\": 23950,\n \"cbic\": \"CPAYIE2D\",\n \"ccan\": \"11111111\",\n \"ciban\": \"IE54CPAY99119911111111\",\n \"cnsc\": \"232221\",\n \"colour\": \"ORANGE\",\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"defaultAccount\": true,\n \"directDebitsAllowed\": {{faker 'datatype.boolean'}},\n \"ican\": 42,\n \"name\": \"Main Account\",\n \"status\": \"{{oneOf (array 'LIVE' 'MIGRATED')}}\"\n}", "latency": 0, "statusCode": 201, "label": "The details of the new account", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f2e7b3d5-b9eb-498f-b06f-9a49d8aebb87", "documentation": "Retrieve the details of a fire.com Account", "method": "get", "endpoint": "accounts/:ican", "responses": [ { "uuid": "35a21eeb-7fe4-4b27-a7a1-c50737cca9ee", "body": "{\n \"balance\": 23950,\n \"cbic\": \"CPAYIE2D\",\n \"ccan\": \"11111111\",\n \"ciban\": \"IE54CPAY99119911111111\",\n \"cnsc\": \"232221\",\n \"colour\": \"ORANGE\",\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"defaultAccount\": true,\n \"directDebitsAllowed\": {{faker 'datatype.boolean'}},\n \"ican\": 42,\n \"name\": \"Main Account\",\n \"status\": \"{{oneOf (array 'LIVE' 'MIGRATED')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An array of account objects.", "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": "4672fc7d-c050-45ac-8828-a14fc5d6d42a", "body": "", "latency": 0, "statusCode": 401, "label": "Access Token is Invalid or missing", "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": "be026450-b165-431c-ad06-26907eccdf14", "documentation": "List transactions for an account", "method": "get", "endpoint": "accounts/:ican/transactions", "responses": [ { "uuid": "b14d9fa0-c363-41f6-b240-a29472b68286", "body": "{\n \"amountAfterCharges\": 5000,\n \"amountBeforeCharges\": 5000,\n \"balance\": 8500,\n \"card\": {\n \"alias\": \"\",\n \"cardId\": {{faker 'number.int' max=99999}},\n \"embossBusinessName\": \"\",\n \"embossCardName\": \"\",\n \"expiryDate\": \"{{faker 'date.recent' 365}}\",\n \"maskedPan\": \"\",\n \"provider\": \"\"\n },\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"date\": \"2021-04-13T11:06:32.437Z\",\n \"dateAcknowledged\": \"2021-04-13T11:06:32.437Z\",\n \"feeAmount\": {{faker 'number.int' max=99999}},\n \"fxTradeDetails\": {\n \"buyAmount\": 359,\n \"buyCurrency\": \"GBP\",\n \"fixedSide\": \"SELL\",\n \"rate4d\": 7180,\n \"sellAmount\": 500,\n \"sellCurrency\": \"EUR\"\n },\n \"ican\": 1951,\n \"myRef\": \"Transfer to main account\",\n \"paymentRequestPublicCode\": \"1abcdefg\",\n \"refId\": 26774,\n \"relatedParty\": {\n \"account\": {\n \"accountNumber\": \"11111111\",\n \"alias\": \"Main Account\",\n \"bic\": \"CPAYIE2D\",\n \"iban\": \"IE54CPAY99119911111111\",\n \"id\": 42,\n \"nsc\": \"232221\"\n },\n \"type\": \"{{oneOf (array 'FIRE_ACCOUNT')}}\"\n },\n \"taxAmount\": {{faker 'number.int' max=99999}},\n \"txnId\": 30157,\n \"type\": \"WITHDRAWAL\"\n}", "latency": 0, "statusCode": 200, "label": "An array of transaction objects for the account with a count (`total`).", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "323bea35-000b-49e5-b70d-fd160b133f51", "documentation": "Filtered list of transactions for an account", "method": "get", "endpoint": "accounts/:ican/transactions/filter", "responses": [ { "uuid": "e95ff6e4-fa08-47ce-9692-df05db96bbfd", "body": "{\n \"amountAfterCharges\": 5000,\n \"amountBeforeCharges\": 5000,\n \"balance\": 8500,\n \"card\": {\n \"alias\": \"\",\n \"cardId\": {{faker 'number.int' max=99999}},\n \"embossBusinessName\": \"\",\n \"embossCardName\": \"\",\n \"expiryDate\": \"{{faker 'date.recent' 365}}\",\n \"maskedPan\": \"\",\n \"provider\": \"\"\n },\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"date\": \"2021-04-13T11:06:32.437Z\",\n \"dateAcknowledged\": \"2021-04-13T11:06:32.437Z\",\n \"feeAmount\": {{faker 'number.int' max=99999}},\n \"fxTradeDetails\": {\n \"buyAmount\": 359,\n \"buyCurrency\": \"GBP\",\n \"fixedSide\": \"SELL\",\n \"rate4d\": 7180,\n \"sellAmount\": 500,\n \"sellCurrency\": \"EUR\"\n },\n \"ican\": 1951,\n \"myRef\": \"Transfer to main account\",\n \"paymentRequestPublicCode\": \"1abcdefg\",\n \"refId\": 26774,\n \"relatedParty\": {\n \"account\": {\n \"accountNumber\": \"11111111\",\n \"alias\": \"Main Account\",\n \"bic\": \"CPAYIE2D\",\n \"iban\": \"IE54CPAY99119911111111\",\n \"id\": 42,\n \"nsc\": \"232221\"\n },\n \"type\": \"{{oneOf (array 'FIRE_ACCOUNT')}}\"\n },\n \"taxAmount\": {{faker 'number.int' max=99999}},\n \"txnId\": 30157,\n \"type\": \"WITHDRAWAL\"\n}", "latency": 0, "statusCode": 200, "label": "An array of transaction objects for the account with a count (`total`) filtered by the specified query parameter.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "56d4ee71-6e07-440c-a93b-11c53d697d2d", "documentation": "Create a new API Application", "method": "post", "endpoint": "apps", "responses": [ { "uuid": "2894726c-7b98-42e1-9454-e53287e58ca5", "body": "{\n \"applicationId\": 45345,\n \"clientId\": \"4ADFB67A-0F5B-4A9A-9D74-34437250045C\",\n \"clientKey\": \"4ADFB67A-0F5B-4A9A-9D74-34437250045C\",\n \"enabled\": true,\n \"expiry\": \"2019-08-22T07:48:56.460Z\",\n \"ican\": {{faker 'number.int' max=99999}},\n \"numberOfPayeeApprovalsRequired\": 1,\n \"numberOfPaymentApprovalsRequired\": 1,\n \"refreshToken\": \"4ADFB67A-0F5B-4A9A-9D74-34437250045C\"\n}", "latency": 0, "statusCode": 200, "label": "API Application created successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a6307642-ca27-4218-8109-b48df37479ac", "documentation": "Authenticate with the API.", "method": "post", "endpoint": "apps/accesstokens", "responses": [ { "uuid": "50dcb09e-395e-468a-bd5d-5dd2b4be698a", "body": "{\n \"accessToken\": \"4ADFB67A-0F5B-4A9A-9D74-34437250045C\",\n \"apiApplicationId\": 433,\n \"businessId\": 248,\n \"expiry\": \"2020-10-22T07:48:56.460Z\",\n \"permissions\": [\n \"PERM_BUSINESSES_GET_ACCOUNTS\",\n \"PERM_BUSINESSES_GET_ACCOUNT_TRANSACTIONS\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successfully authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f7e1790e-8d99-4864-8205-cdf4c237a844", "documentation": "Get list of ASPSPs / Banks", "method": "get", "endpoint": "aspsps", "responses": [ { "uuid": "689a449a-f947-4933-94ed-3d75094dbe51", "body": "{\n \"aspsps\": [\n {\n \"alias\": \"Demo Bank\",\n \"aspspUuid\": \"4ADFB67A-0F5B-4A9A-9D74-34437250045C\",\n \"country\": {\n \"code\": \"GB\",\n \"description\": \"United Kingdom\"\n },\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"dateCreated\": \"2019-08-22T07:48:56.460Z\",\n \"lastUpdated\": \"2019-08-22T07:48:56.460Z\",\n \"logoUrl\": \"https://assets.fire.com/pisp/demo.svg\"\n }\n ],\n \"total\": 10\n}", "latency": 0, "statusCode": 200, "label": "A list of ASPSPs the customers can use to pay a payment.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a35e5f7b-4229-469c-b7dc-3dc6fe2a448c", "documentation": "List batches", "method": "get", "endpoint": "batches", "responses": [ { "uuid": "9d47458d-ece0-44e0-9010-8e0990858905", "body": "{\n \"items\": [\n {\n \"amount\": 10000,\n \"amountAfterCharges\": 10000,\n \"batchItemUuid\": \"F2AF3F2B-4406-4199-B249-B354F2CC6019\",\n \"dateCreated\": \"2021-04-04T10:48:53.540Z\",\n \"feeAmount\": {{faker 'number.int' max=99999}},\n \"icanFrom\": 2150,\n \"icanTo\": 1002,\n \"lastUpdated\": \"2021-04-04T10:48:53.540Z\",\n \"ref\": \"Testing a transfer via batch\",\n \"refId\": 123782,\n \"result\": {\n \"code\": 500001,\n \"message\": \"SUCCESS\"\n },\n \"status\": \"{{oneOf (array 'SUBMITTED' 'REMOVED' 'SUCCEEDED' 'FAILED')}}\",\n \"taxAmount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "List all batches.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "03c37dd6-a361-44fb-af15-1843e94db154", "documentation": "Create a new bath of payments", "method": "post", "endpoint": "batches", "responses": [ { "uuid": "efd588be-043f-4ea3-98fd-309eb71c450e", "body": "{\n \"batchUuid\": \"F2AF3F2B-4406-4199-B249-B354F2CC6019\"\n}", "latency": 0, "statusCode": 200, "label": "Batch created successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d63a863-7260-4d73-a8d4-d7e8985c3be1", "documentation": "Submit a batch for approval", "method": "put", "endpoint": "batches", "responses": [ { "uuid": "d53d4a0c-88ec-491e-8434-fea5c733cf04", "body": "", "latency": 0, "statusCode": 204, "label": "No body is returned - a HTTP 204 No Content response signifies the call was successful.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2e1c9c76-af43-4fbe-8277-73602e5f2352", "documentation": "Cancel a batch", "method": "delete", "endpoint": "batches/:batchUuid", "responses": [ { "uuid": "f7455777-2c0a-4a41-8e6c-e1a90e2f862f", "body": "", "latency": 0, "statusCode": 200, "label": "Batch payment deleted successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2196c23c-7743-40bb-990e-2287d3b1ed30", "documentation": "Get details of a single Batch", "method": "get", "endpoint": "batches/:batchUuid", "responses": [ { "uuid": "9367977b-3673-4118-a1f2-94301038ad7f", "body": "{\n \"amount\": 10000,\n \"amountAfterCharges\": 10000,\n \"batchItemUuid\": \"F2AF3F2B-4406-4199-B249-B354F2CC6019\",\n \"dateCreated\": \"2021-04-04T10:48:53.540Z\",\n \"feeAmount\": {{faker 'number.int' max=99999}},\n \"icanFrom\": 2150,\n \"icanTo\": 1002,\n \"lastUpdated\": \"2021-04-04T10:48:53.540Z\",\n \"ref\": \"Testing a transfer via batch\",\n \"refId\": 123782,\n \"result\": {\n \"code\": 500001,\n \"message\": \"SUCCESS\"\n },\n \"status\": \"{{oneOf (array 'SUBMITTED' 'REMOVED' 'SUCCEEDED' 'FAILED')}}\",\n \"taxAmount\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Returns the details of the batch specified in the API endpoint - {batchUuid}.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0e52d3ab-6b63-47d0-9d70-55c834b26fe7", "documentation": "List Approvers for a Batch", "method": "get", "endpoint": "batches/:batchUuid/approvals", "responses": [ { "uuid": "1a1577f9-f736-4344-b0a6-f7a9a663208d", "body": "{\n \"approvals\": [\n {\n \"emailAddress\": \"jane.doe@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"lastUpdated\": \"2021-04-04T10:48:53.540Z\",\n \"mobileNumber\": 353871234567,\n \"status\": \"PENDING_APPROVAL\",\n \"userId\": 3138\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A list of approvers for this batch.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "12626482-3dab-4091-8dee-1d1ad0e89fae", "documentation": "List items in a Batch", "method": "get", "endpoint": "batches/:batchUuid/banktransfers", "responses": [ { "uuid": "dc31d67f-42a1-41ed-980c-9ee684e1fa5c", "body": "{\n \"items\": [\n {\n \"amount\": 10000,\n \"amountAfterCharges\": 10000,\n \"batchItemUuid\": \"F2AF3F2B-4406-4199-B249-B354F2CC6019\",\n \"dateCreated\": \"2021-04-04T10:48:53.540Z\",\n \"feeAmount\": {{faker 'number.int' max=99999}},\n \"icanFrom\": 2150,\n \"icanTo\": 1002,\n \"lastUpdated\": \"2021-04-04T10:48:53.540Z\",\n \"ref\": \"Testing a transfer via batch\",\n \"refId\": 123782,\n \"result\": {\n \"code\": 500001,\n \"message\": \"SUCCESS\"\n },\n \"status\": \"{{oneOf (array 'SUBMITTED' 'REMOVED' 'SUCCEEDED' 'FAILED')}}\",\n \"taxAmount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "A fire.com list object of Batch Items (Internal transfers or Bank transfers).", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "069b6742-6827-4d7a-a9db-06ba2ff6cdbb", "documentation": "Add payment for an bank transfers", "method": "post", "endpoint": "batches/:batchUuid/banktransfers", "responses": [ { "uuid": "efea720b-761f-480d-8602-8d1a479cf2e0", "body": "{\n \"batchItemUuid\": \"fba4a76a-ce51-4fc1-b562-98ec01299e4d\"\n}", "latency": 0, "statusCode": 200, "label": "Batch payment added successfully. **Note*** Please use batchUuid when submitting a batch, not batchItemUuid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9f34cf15-9f23-46cd-ae36-2a4d0e2a2cab", "documentation": "Remove a Payment from the Batch (Bank Transfers)", "method": "delete", "endpoint": "batches/:batchUuid/banktransfers/:itemUuid", "responses": [ { "uuid": "ac4508c6-0ee2-4a9f-adcd-c63c12a02711", "body": "", "latency": 0, "statusCode": 200, "label": "Batch payment deleted successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e7660594-0d25-476b-936b-e807021f5358", "documentation": "List items in a Batch", "method": "get", "endpoint": "batches/:batchUuid/internaltransfers", "responses": [ { "uuid": "c41d22eb-9ba7-44bb-ab60-1b3c1240376d", "body": "{\n \"items\": [\n {\n \"amount\": 10000,\n \"amountAfterCharges\": 10000,\n \"batchItemUuid\": \"F2AF3F2B-4406-4199-B249-B354F2CC6019\",\n \"dateCreated\": \"2021-04-04T10:48:53.540Z\",\n \"feeAmount\": {{faker 'number.int' max=99999}},\n \"icanFrom\": 2150,\n \"icanTo\": 1002,\n \"lastUpdated\": \"2021-04-04T10:48:53.540Z\",\n \"ref\": \"Testing a transfer via batch\",\n \"refId\": 123782,\n \"result\": {\n \"code\": 500001,\n \"message\": \"SUCCESS\"\n },\n \"status\": \"{{oneOf (array 'SUBMITTED' 'REMOVED' 'SUCCEEDED' 'FAILED')}}\",\n \"taxAmount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "A fire.com list object of Batch Items (Internal transfers or Bank transfers).", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "73ae08f2-bdcf-44a5-b48b-04f99111ebbe", "documentation": "Add payment for an internal transfers", "method": "post", "endpoint": "batches/:batchUuid/internaltransfers", "responses": [ { "uuid": "f1547e64-0761-4f29-bdc7-d8e92a48fd99", "body": "{\n \"batchItemUuid\": \"fba4a76a-ce51-4fc1-b562-98ec01299e4d\"\n}", "latency": 0, "statusCode": 200, "label": "Batch payment added successfully. Note* Please use batchUuid when submitting a batch, not batchItemUuid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6eb2b771-e904-46bc-a3a1-6eea5bfad9ec", "documentation": "Remove a Payment from the Batch (Internal Transfer)", "method": "delete", "endpoint": "batches/:batchUuid/internaltransfers/:itemUuid", "responses": [ { "uuid": "5bffbca0-1a25-4da2-8acb-cff82bfbabc5", "body": "", "latency": 0, "statusCode": 200, "label": "Batch payment deleted successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "32da974f-eb63-40e3-bec7-e116d1bc3b85", "documentation": "View List of Cards.", "method": "get", "endpoint": "cards", "responses": [ { "uuid": "db2211ec-0155-42f9-8d10-23f74c745e25", "body": "{\n \"cards\": [\n {\n \"blocked\": {{faker 'datatype.boolean'}},\n \"cardId\": 51,\n \"dateCreated\": \"2017-01-19T16:38:15.803Z\",\n \"emailAddress\": \"user@example.com\",\n \"eurIcan\": 2150,\n \"expiryDate\": \"2019-01-31T00:00:00.000Z\",\n \"firstName\": \"John\",\n \"gbpIcan\": 2152,\n \"lastName\": \"Doe\",\n \"maskedPan\": \"537455******1111\",\n \"provider\": \"{{oneOf (array 'MASTERCARD')}}\",\n \"status\": \"{{oneOf (array 'LIVE' 'CREATED_ACTIVE' 'CREATED_INACTIVE' 'DEACTIVATED')}}\",\n \"statusReason\": \"{{oneOf (array 'LOST_CARD' 'STOLEN_CARD' 'CARD_DESTROYED')}}\",\n \"userId\": 3138\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "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": "bfae0481-acb5-4432-a55b-0cb2d8e9b48b", "body": "", "latency": 0, "statusCode": 401, "label": "Access Token is Invalid or missing", "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": "eb7b25c1-4f33-44eb-beeb-c7879165ecc8", "body": "", "latency": 0, "statusCode": 403, "label": "Access Token is Invalid or missing", "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": "7fb06b60-ae2f-487b-8bfc-efe150f3af55", "documentation": "Create a new debit card.", "method": "post", "endpoint": "cards", "responses": [ { "uuid": "eb2d2fbc-153c-4428-b818-e011041e7f28", "body": "{\n \"cardId\": 51,\n \"expiryDate\": \"2019-01-31T00:00:00.000Z\",\n \"maskedPan\": \"537455******1111\",\n \"status\": \"{{oneOf (array 'CREATED_ACTIVE' 'CREATED_INACTIVE')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Card created successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f57a7679-6521-4b4b-b7c7-fc8d65729147", "documentation": "Get all DD payments associated with a direct debit mandate", "method": "get", "endpoint": "directdebits", "responses": [ { "uuid": "389251b1-7539-41db-b077-e096bf6fac64", "body": "{\n \"directdebits\": [\n {\n \"amount\": 100,\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"dateCreated\": \"2016-12-15T22:56:05.937Z\",\n \"directDebitReference\": \"VODA-ABC453-1\",\n \"directDebitUuid\": \"42de0705-e3f1-44fa-8c41-79973eb80eb2\",\n \"isDDIC\": {{faker 'datatype.boolean'}},\n \"lastUpdated\": \"2016-12-15T22:56:05.937Z\",\n \"mandateUUid\": \"f171b143-e3eb-47de-85a6-1c1f1108c701\",\n \"originatorAlias\": \"Three\",\n \"originatorName\": \"Vodafone PLC\",\n \"originatorReference\": \"VODA-123456\",\n \"schemeRejectReason\": \"eg. Instruction cancelled by payer\",\n \"schemeRejectReasonCode\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' 'A' 'B')}}\",\n \"status\": \"{{oneOf (array 'RECIEVED' 'REJECT_REQUESTED' 'REJECT_READY_FOR_PROCESSING' 'REJECT_RECORD_IN_PROGRESS' 'REJECT_RECORDED' 'REJECT_FILE_CREATED' 'REJECT_FILE_SENT' 'COLLECTED' 'REFUND_REQUESTED' 'REFUND_RECORD_IN_PROGRESS' 'REFUND_RECORDED' 'REFUND_FILE_CREATED' 'REFUND_FILE_SENT')}}\",\n \"targetIcan\": 42,\n \"targetPayeeId\": 12,\n \"type\": \"{{oneOf (array 'FIRST_COLLECTION' 'ONGOING_COLLECTION' 'REPRESENTED_COLLECTION' 'FINAL_COLLECTION')}}\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "Retrieve all direct debit payments associated with a direct debit mandate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5880f4d9-765e-449d-8188-83928ba76ee5", "documentation": "Get the deails of a direct debit", "method": "get", "endpoint": "directdebits/:directDebitUuid", "responses": [ { "uuid": "456a3d09-1db1-4434-b63c-b2547f37ac28", "body": "{\n \"amount\": 100,\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"dateCreated\": \"2016-12-15T22:56:05.937Z\",\n \"directDebitReference\": \"VODA-ABC453-1\",\n \"directDebitUuid\": \"42de0705-e3f1-44fa-8c41-79973eb80eb2\",\n \"isDDIC\": {{faker 'datatype.boolean'}},\n \"lastUpdated\": \"2016-12-15T22:56:05.937Z\",\n \"mandateUUid\": \"f171b143-e3eb-47de-85a6-1c1f1108c701\",\n \"originatorAlias\": \"Three\",\n \"originatorName\": \"Vodafone PLC\",\n \"originatorReference\": \"VODA-123456\",\n \"schemeRejectReason\": \"eg. Instruction cancelled by payer\",\n \"schemeRejectReasonCode\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' 'A' 'B')}}\",\n \"status\": \"{{oneOf (array 'RECIEVED' 'REJECT_REQUESTED' 'REJECT_READY_FOR_PROCESSING' 'REJECT_RECORD_IN_PROGRESS' 'REJECT_RECORDED' 'REJECT_FILE_CREATED' 'REJECT_FILE_SENT' 'COLLECTED' 'REFUND_REQUESTED' 'REFUND_RECORD_IN_PROGRESS' 'REFUND_RECORDED' 'REFUND_FILE_CREATED' 'REFUND_FILE_SENT')}}\",\n \"targetIcan\": 42,\n \"targetPayeeId\": 12,\n \"type\": \"{{oneOf (array 'FIRST_COLLECTION' 'ONGOING_COLLECTION' 'REPRESENTED_COLLECTION' 'FINAL_COLLECTION')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Retrieve all details of a single direct debit collection/payment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a2322599-dd07-42bc-91db-77e08071d6d5", "documentation": "Reject a direct debit payment", "method": "post", "endpoint": "directdebits/:directDebitUuid/reject", "responses": [ { "uuid": "06f5b650-9f7c-41ce-a2b6-8281fdef6c21", "body": "", "latency": 0, "statusCode": 204, "label": "204 no content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "86de53a3-5c89-4548-86b0-4aef6dbb36ac", "documentation": "List all direct debit mandates", "method": "get", "endpoint": "mandates", "responses": [ { "uuid": "06718697-cdce-4a60-b42b-e17216bc6352", "body": "{\n \"mandates\": [\n {\n \"alias\": \"Vodaphone\",\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"dateCancelled\": \"2016-12-15T22:56:05.937Z\",\n \"dateCompleted\": \"2016-12-15T22:56:05.937Z\",\n \"dateCreated\": \"2016-12-15T22:56:05.937Z\",\n \"fireRejectionReason\": \"{{oneOf (array 'ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS' 'DDIC' 'ACCOUNT_NOT_FOUND' 'ACCOUNT_NOT_LIVE' 'CUSTOMER_NOT_FOUND' 'BUSINESS_NOT_LIVE' 'BUSINESS_NOT_FULL' 'PERSONAL_USER_NOT_LIVE' 'PERSONAL_USER_NOT_FULL' 'MANDATE_ALREADY_EXISTS' 'MANDATE_WITH_DIFERENT_ACCOUNT' 'NULL_MANDATE_REFERENCE' 'INVALID_ACCOUNT_CURRENCY' 'INVALID_MANDATE_REFERENCE' 'REQUESTED_BY_CUSTOMER_VIA_SUPPORT' 'CUSTOMER_ACCOUNT_CLOSED' 'CUSTOMER_DECEASED' 'ACCOUNT_TRANSFERRED' 'MANDATE_NOT_FOUND' 'ACCOUNT_TRANSFERRED_TO_DIFFERENT_ACCOUNT' 'INVALID_ACCOUNT_TYPE' 'MANDATE_EXPIRED' 'MANDATE_CANCELLED' 'REQUESTED_BY_CUSTOMER')}}\",\n \"lastUpdated\": \"2016-12-15T22:56:05.937Z\",\n \"latestDirectDebitAmount\": 2,\n \"latestDirectDebitDate\": \"2016-12-15T22:56:05.937Z\",\n \"mandateReference\": \"CRZ-102190123\",\n \"mandateUuid\": \"28d627c3-1889-44c8-ae59-6f6b20239260\",\n \"numberOfDirectDebitCollected\": 2,\n \"originatorAlias\": \"Vodaphone PLC\",\n \"originatorLogoUrlLarge\": \"originatorLogoLarge\",\n \"originatorLogoUrlSmall\": \"originatorLogoSmall\",\n \"originatorName\": \"Vodafone PLC\",\n \"originatorReference\": \"VODA-123456\",\n \"schemeCancelReason\": \"e.g. Instruction cancelled by payer\",\n \"schemeCancelReasonCode\": \"For BACS (ADDACS) - 0|1|2|3|B|C|D|E|R\",\n \"status\": \"{{oneOf (array 'CREATED' 'LIVE' 'REJECT_REQUESTED' 'REJECT_RECORD_IN_PROGRESS' 'REJECT_RECORDED' 'REJECT_FILE_CREATED' 'REJECT_FILE_SENT' 'CANCEL_REQUESTED' 'CANCEL_RECORD_IN_PROGRESS' 'CANCEL_RECORDED' 'CANCEL_FILE_CREATED' 'CANCEL_FILE_SENT' 'COMPLETE' 'DORMANT')}}\",\n \"targetIcan\": 1,\n \"valueOfDirectDebitCollected\": 2\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "List all direct debit mandates.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "71e74cf8-e486-4bed-9a95-f75ab02bf0d9", "documentation": "Get direct debit mandate details", "method": "get", "endpoint": "mandates/:mandateUuid", "responses": [ { "uuid": "bc811173-7f57-45ec-96cb-5622a79fe9f3", "body": "{\n \"alias\": \"Vodaphone\",\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"dateCancelled\": \"2016-12-15T22:56:05.937Z\",\n \"dateCompleted\": \"2016-12-15T22:56:05.937Z\",\n \"dateCreated\": \"2016-12-15T22:56:05.937Z\",\n \"fireRejectionReason\": \"{{oneOf (array 'ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS' 'DDIC' 'ACCOUNT_NOT_FOUND' 'ACCOUNT_NOT_LIVE' 'CUSTOMER_NOT_FOUND' 'BUSINESS_NOT_LIVE' 'BUSINESS_NOT_FULL' 'PERSONAL_USER_NOT_LIVE' 'PERSONAL_USER_NOT_FULL' 'MANDATE_ALREADY_EXISTS' 'MANDATE_WITH_DIFERENT_ACCOUNT' 'NULL_MANDATE_REFERENCE' 'INVALID_ACCOUNT_CURRENCY' 'INVALID_MANDATE_REFERENCE' 'REQUESTED_BY_CUSTOMER_VIA_SUPPORT' 'CUSTOMER_ACCOUNT_CLOSED' 'CUSTOMER_DECEASED' 'ACCOUNT_TRANSFERRED' 'MANDATE_NOT_FOUND' 'ACCOUNT_TRANSFERRED_TO_DIFFERENT_ACCOUNT' 'INVALID_ACCOUNT_TYPE' 'MANDATE_EXPIRED' 'MANDATE_CANCELLED' 'REQUESTED_BY_CUSTOMER')}}\",\n \"lastUpdated\": \"2016-12-15T22:56:05.937Z\",\n \"latestDirectDebitAmount\": 2,\n \"latestDirectDebitDate\": \"2016-12-15T22:56:05.937Z\",\n \"mandateReference\": \"CRZ-102190123\",\n \"mandateUuid\": \"28d627c3-1889-44c8-ae59-6f6b20239260\",\n \"numberOfDirectDebitCollected\": 2,\n \"originatorAlias\": \"Vodaphone PLC\",\n \"originatorLogoUrlLarge\": \"originatorLogoLarge\",\n \"originatorLogoUrlSmall\": \"originatorLogoSmall\",\n \"originatorName\": \"Vodafone PLC\",\n \"originatorReference\": \"VODA-123456\",\n \"schemeCancelReason\": \"e.g. Instruction cancelled by payer\",\n \"schemeCancelReasonCode\": \"For BACS (ADDACS) - 0|1|2|3|B|C|D|E|R\",\n \"status\": \"{{oneOf (array 'CREATED' 'LIVE' 'REJECT_REQUESTED' 'REJECT_RECORD_IN_PROGRESS' 'REJECT_RECORDED' 'REJECT_FILE_CREATED' 'REJECT_FILE_SENT' 'CANCEL_REQUESTED' 'CANCEL_RECORD_IN_PROGRESS' 'CANCEL_RECORDED' 'CANCEL_FILE_CREATED' 'CANCEL_FILE_SENT' 'COMPLETE' 'DORMANT')}}\",\n \"targetIcan\": 1,\n \"valueOfDirectDebitCollected\": 2\n}", "latency": 0, "statusCode": 200, "label": "Retrieve all details for a direct debit mandate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "69bf329d-c928-48ce-a9e2-6159d08003bd", "documentation": "Update a direct debit mandate alias", "method": "post", "endpoint": "mandates/:mandateUuid", "responses": [ { "uuid": "9ec4e651-c90c-4791-ae43-4700b9c1433c", "body": "", "latency": 0, "statusCode": 204, "label": "204 no content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "01def38a-d193-4fd4-937d-61d2ceb9bb95", "documentation": "Activate a direct debit mandate", "method": "post", "endpoint": "mandates/:mandateUuid/activate", "responses": [ { "uuid": "b1534b88-01cc-4a12-bc7c-0d313f040dbe", "body": "", "latency": 0, "statusCode": 204, "label": "204 no content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "738e70cc-7780-4a43-99c7-ad258939ba2b", "documentation": "Cancel a direct debit mandate", "method": "post", "endpoint": "mandates/:mandateUuid/cancel", "responses": [ { "uuid": "37fbaf30-c06c-4610-bc52-780fe341547a", "body": "", "latency": 0, "statusCode": 204, "label": "204 no content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4d6f9458-8aed-454a-bf4f-7ffc71f8ec75", "documentation": "List all Payee Bank Accounts", "method": "get", "endpoint": "payees", "responses": [ { "uuid": "44742aca-383f-4968-a0ad-e5885b3451a0", "body": "{\n \"accountHolderName\": \"Joe Bloggs\",\n \"accountName\": \"Joe\",\n \"accountNumber\": \"\",\n \"bic\": \"BOFIIE2DXXX\",\n \"createdBy\": \"{{oneOf (array 'CUSTOMER' 'LODGEMENT' 'DIRECT DEBIT' 'OPEN BANKING' 'FIRE OPEN PAYMENT' 'FIRE DIRECT')}}\",\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"dateCreated\": \"2019-08-22T07:48:56.460Z\",\n \"iban\": \"IE86BOFI90535211111111\",\n \"id\": 742,\n \"nsc\": \"\",\n \"status\": \"{{oneOf (array 'CREATED' 'LIVE' 'CLOSED' 'ARCHIVED')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An array of Payee Bank Accounts", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7e47b3c3-7b3a-46bf-99d5-d8498fd286be", "documentation": "Create a Fire Open Payment request", "method": "post", "endpoint": "paymentrequests", "responses": [ { "uuid": "aa33a194-fa13-4226-9b4e-ec7642e87f8a", "body": "{\n \"code\": \"1234abcd\",\n \"type\": \"{{oneOf (array 'OTHER')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Payment Request created successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "64fdfb47-d30e-4ca2-b961-58fa94a6b2dd", "documentation": "Get Payment Details", "method": "get", "endpoint": "payments/:paymentUuid", "responses": [ { "uuid": "9efc7baf-4450-4d3e-a7a9-f9d9d649c244", "body": "{\n \"additionalFields\": \"ORDER_ID|PRODUCT_ID|CUSTOMER_ID|CUSTOMER_NUMBER|COMMENT2\",\n \"amount\": 1000,\n \"collectFields\": \"ADDRESS|REFERENCE|COMMENT1\",\n \"currency\": {\n \"code\": \"{{oneOf (array 'EUR' 'GBP')}}\",\n \"description\": \"Euro\"\n },\n \"description\": \"Gym Fees Oct 2020\",\n \"expiry\": \"2024-10-22T07:48:56.460Z\",\n \"icanTo\": 42,\n \"mandatoryFields\": \"ADDRESS|REFERENCE|COMMENT1\",\n \"maxNumberPayments\": 1,\n \"myRef\": \"Fees\",\n \"orderDetails\": {\n \"comment1\": \"Additional comments about the transaction\",\n \"comment2\": \"Additional comments about the transaction\",\n \"customerNumber\": \"123645\",\n \"deliveryAddressLine1\": \"12 The Street\",\n \"deliveryAddressLine2\": \"The Way\",\n \"deliveryCity\": \"London\",\n \"deliveryCountry\": \"GB\",\n \"deliveryPostCode\": \"EC15155\",\n \"merchantCustomerIdentification\": \"08303863544\",\n \"merchantNumber\": \"1234567\",\n \"orderId\": \"6c28a47d-4502-4111\",\n \"productId\": \"ZFDAA-1221\",\n \"variableReference\": \"John Doe\"\n },\n \"paymentRequestCode\": \"1234abcd\",\n \"paymentUuid\": \"4ADFB67A-0F5B-4A9A-9D74-34437250045C\",\n \"returnUrl\": \"https://example.com/callback\",\n \"status\": \"{{oneOf (array 'AWAITING_AUTHORISATION' 'AUTHORISED' 'AWAITING_MULTI_AUTHORISATION' 'NOT_AUTHORISED' 'PAID' 'REJECTED' 'ACCEPTED' 'RECEIVED')}}\",\n \"transactionType\": \"{{oneOf (array 'REFUND_REQUEST' 'PAYMENT')}}\",\n \"type\": \"{{oneOf (array 'OTHER')}}\",\n \"webhookUrl\": \"https://example.com/webhook\"\n}", "latency": 0, "statusCode": 200, "label": "The Payment Request details object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1e083ab5-d0ab-484f-8c07-0e2ddbd1682c", "documentation": "Returns details of a specific fire.com user.", "method": "get", "endpoint": "user/:userId", "responses": [ { "uuid": "57db550e-9bee-4523-a916-e59c1d31935f", "body": "{\n \"emailAddress\": \"user@example.com\",\n \"firstName\": \"Colm\",\n \"id\": 14059,\n \"lastName\": \"User\",\n \"lastlogin\": \"2012-01-20T11:21:35.000Z\",\n \"mobileApplicationDetails\": {\n \"OS\": \"{{oneOf (array 'Android' 'IOS' 'OTHER')}}\",\n \"businessUserId\": \"14059\",\n \"clientID\": \"EBB10F29-A653-4DBA-9C8C-BA79F72F78B0\",\n \"deviceName\": \"{{oneOf (array 'iPhone' 'Android' 'Other')}}\",\n \"deviceOSVersion\": \"14.4\",\n \"mobileApplicationId\": \"18967\",\n \"status\": \"{{oneOf (array 'LIVE' 'CLOSED' 'LOCKED' 'SMS_SENT')}}\"\n },\n \"mobileNumber\": \"+353871234567\",\n \"role\": \"{{oneOf (array 'ADMIN' 'FULL_USER' 'READ_ONLY' 'CARD_ONLY')}}\",\n \"status\": \"{{oneOf (array 'LIVE' 'CLOSED' 'FROZEN' 'INVITE_SENT' 'SMS_CODE_SENT')}}\",\n \"userCvl\": \"FULL\"\n}", "latency": 0, "statusCode": 200, "label": "Unique information about a User.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "071ff7a5-5401-4550-8f53-648f12691468", "documentation": "Returns list of all users on your fire.com account", "method": "get", "endpoint": "users", "responses": [ { "uuid": "a193d56c-e4a1-4c47-b202-5337ce6c841c", "body": "[\n {\n \"emailAddress\": \"user@example.com\",\n \"firstName\": \"Colm\",\n \"id\": 14059,\n \"lastName\": \"User\",\n \"lastlogin\": \"2012-01-20T11:21:35.000Z\",\n \"mobileApplicationDetails\": {\n \"OS\": \"{{oneOf (array 'Android' 'IOS' 'OTHER')}}\",\n \"businessUserId\": \"14059\",\n \"clientID\": \"EBB10F29-A653-4DBA-9C8C-BA79F72F78B0\",\n \"deviceName\": \"{{oneOf (array 'iPhone' 'Android' 'Other')}}\",\n \"deviceOSVersion\": \"14.4\",\n \"mobileApplicationId\": \"18967\",\n \"status\": \"{{oneOf (array 'LIVE' 'CLOSED' 'LOCKED' 'SMS_SENT')}}\"\n },\n \"mobileNumber\": \"+353871234567\",\n \"role\": \"{{oneOf (array 'ADMIN' 'FULL_USER' 'READ_ONLY' 'CARD_ONLY')}}\",\n \"status\": \"{{oneOf (array 'LIVE' 'CLOSED' 'FROZEN' 'INVITE_SENT' 'SMS_CODE_SENT')}}\",\n \"userCvl\": \"FULL\"\n }\n]", "latency": 0, "statusCode": 200, "label": "List of all Users.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "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": "d4caab13-ae6b-4f55-93a0-d27a8b853aa6" }, { "type": "route", "uuid": "4d54e1f7-c241-4383-a2ad-3490396da175" }, { "type": "route", "uuid": "f2e7b3d5-b9eb-498f-b06f-9a49d8aebb87" }, { "type": "route", "uuid": "be026450-b165-431c-ad06-26907eccdf14" }, { "type": "route", "uuid": "323bea35-000b-49e5-b70d-fd160b133f51" }, { "type": "route", "uuid": "56d4ee71-6e07-440c-a93b-11c53d697d2d" }, { "type": "route", "uuid": "a6307642-ca27-4218-8109-b48df37479ac" }, { "type": "route", "uuid": "f7e1790e-8d99-4864-8205-cdf4c237a844" }, { "type": "route", "uuid": "a35e5f7b-4229-469c-b7dc-3dc6fe2a448c" }, { "type": "route", "uuid": "03c37dd6-a361-44fb-af15-1843e94db154" }, { "type": "route", "uuid": "7d63a863-7260-4d73-a8d4-d7e8985c3be1" }, { "type": "route", "uuid": "2e1c9c76-af43-4fbe-8277-73602e5f2352" }, { "type": "route", "uuid": "2196c23c-7743-40bb-990e-2287d3b1ed30" }, { "type": "route", "uuid": "0e52d3ab-6b63-47d0-9d70-55c834b26fe7" }, { "type": "route", "uuid": "12626482-3dab-4091-8dee-1d1ad0e89fae" }, { "type": "route", "uuid": "069b6742-6827-4d7a-a9db-06ba2ff6cdbb" }, { "type": "route", "uuid": "9f34cf15-9f23-46cd-ae36-2a4d0e2a2cab" }, { "type": "route", "uuid": "e7660594-0d25-476b-936b-e807021f5358" }, { "type": "route", "uuid": "73ae08f2-bdcf-44a5-b48b-04f99111ebbe" }, { "type": "route", "uuid": "6eb2b771-e904-46bc-a3a1-6eea5bfad9ec" }, { "type": "route", "uuid": "32da974f-eb63-40e3-bec7-e116d1bc3b85" }, { "type": "route", "uuid": "7fb06b60-ae2f-487b-8bfc-efe150f3af55" }, { "type": "route", "uuid": "f57a7679-6521-4b4b-b7c7-fc8d65729147" }, { "type": "route", "uuid": "5880f4d9-765e-449d-8188-83928ba76ee5" }, { "type": "route", "uuid": "a2322599-dd07-42bc-91db-77e08071d6d5" }, { "type": "route", "uuid": "86de53a3-5c89-4548-86b0-4aef6dbb36ac" }, { "type": "route", "uuid": "71e74cf8-e486-4bed-9a95-f75ab02bf0d9" }, { "type": "route", "uuid": "69bf329d-c928-48ce-a9e2-6159d08003bd" }, { "type": "route", "uuid": "01def38a-d193-4fd4-937d-61d2ceb9bb95" }, { "type": "route", "uuid": "738e70cc-7780-4a43-99c7-ad258939ba2b" }, { "type": "route", "uuid": "4d6f9458-8aed-454a-bf4f-7ffc71f8ec75" }, { "type": "route", "uuid": "7e47b3c3-7b3a-46bf-99d5-d8498fd286be" }, { "type": "route", "uuid": "64fdfb47-d30e-4ca2-b961-58fa94a6b2dd" }, { "type": "route", "uuid": "1e083ab5-d0ab-484f-8c07-0e2ddbd1682c" }, { "type": "route", "uuid": "071ff7a5-5401-4550-8f53-648f12691468" } ] }