The tomato pay API platform, built by, and loved by developers, enables anyone to build exceptional financial products to serve small businesses.
\nBy leveraging tomato pay's APIs such as our Open Banking, payments and intelligence APIs, you will gain valuable insights into your users finances so you can deliver the right product, to the right small business, at the right time.
\nThrough Open Banking, your customers can connect their bank accounts to get a holistic view of their finances.
\nMonitor the performance, availability and error rates of Open Banking APIs through a transparent and user-friendly dashboard.
\ntomato pay API uses JWT (JSON web tokens) to authenticate requests to all other endpoints. These tokens expire every 30 minutes. To obtain a JWT, use the API key, and click on your app in the ‘My Apps’ section.
\nCreate multiple companies and link their financial data to their profile. While creating a company, you can add the following as company details:
\nCreate a company to link their financial data to the company. While creating a company, you can add the following as company details:
\nThe 'Get Companies' endpoint will return a list of all the companies that you have created.\nThe following details will be returned for the company:
\n\n- Company id
\n- Name of the company
\n- Date of creation
\n- Registered address
\n- Website
\n- Industry
\n- External ID
\n- Companies house number (CRN)
\n
\nThe companies can be queried by external ID and/or CRN.
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n| externalId | \nstring | \nExternal ID that a partner may want to use to identify a company | \n
\n\n| crn | \nstring | \nCompanies house number; specific to companies registered with Companies house in the UK | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the company | \n
\n\n| name | \nstring | \nName of the company | \n
\n\n| description | \nstring | \nDescription of the company | \n
\n\n| website | \nstring | \nCompany website | \n
\n\n| address | \nstring | \nAddress of the company | \n
\n\n| createdAt | \nstring | \nDate of creation of the company | \n
\n\n| industry | \nstring | \nIndustry name | \n
\n\n| externalId | \nstring | \nExternal ID that a partner may want to use to identify a company | \n
\n\n| crn | \nstring | \nCompanies house number; specific to companies registered with Companies house in the UK | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""},{"disabled":true,"description":{"content":"External ID that a partner may want to use to identify a company
\n","type":"text/plain"},"key":"externalId","value":""},{"disabled":true,"description":{"content":"Companies house number; specific to companies registered with Companies house in the UK
\n","type":"text/plain"},"key":"crn","value":""}],"variable":[]}},"response":[{"id":"45d6d545-279c-4847-a24c-9b2e76cc4996","name":"Get Companies","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/company/v2/companies","host":["{{base_url}}"],"path":["company","v2","companies"],"query":[{"key":"pageId","value":"","description":"Page offset of results","disabled":true},{"key":"externalId","value":"","description":"External ID that a partner may want to use to identify a company","disabled":true},{"key":"crn","value":"","description":"Companies house number; specific to companies registered with Companies house in the UK","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"117557"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Oct 2020 14:43:06 GMT"},{"key":"x-amzn-RequestId","value":"188eec3e-5e5d-4192-9b51-1f3f1d3993a5"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VIF6_HCSDoEFsMg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f998379-58807acf7966271827c7e25a"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 78ddfb54ad788c32ecf2935db37685b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"8ZF9J1pUhOobIk5hEu17W2gEemSw6n3h_nDy-lT9W3V5DGGI5Xxb6Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"CompanyID1234\",\n \"name\": \"Company name\",\n \"description\": \"Micro SME\",\n \"website\": \"www.companyname.com\",\n \"industry\": \"IT\",\n \"address\": \"London\",\n \"externalId\": \"19988-7766\",\n \"crn\": \"14455-345\",\n \"createdAt\": \"2020-10-21T12:55:09.655Z\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"90508006-0875-44e1-8373-2ab09269baca"},{"name":"Get Company (by id)","event":[{"listen":"test","script":{"id":"c1eeac69-3ec2-4852-bffe-cd438a0832d9","exec":[""],"type":"text/javascript"}}],"id":"e4942d08-43a3-4ecc-a0dc-78f701535199","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":"{{base_url}}/company/v2/companies/:companyId","description":"The ‘Get company’ endpoint will return company details for a specific company.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| companyId | \nstring | \nUnique identifier for the company | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the company | \n
\n\n| name | \nstring | \nName of the company | \n
\n\n| description | \nstring | \nDescription of the company | \n
\n\n| website | \nstring | \nCompany website | \n
\n\n| address | \nstring | \nAddress of the company | \n
\n\n| createdAt | \nstring | \nDate of creation of the company | \n
\n\n| industry | \nstring | \nIndustry name | \n
\n\n| externalId | \nstring | \nExternal ID that a partner may want to use to identify a company | \n
\n\n| crn | \nstring | \nCompanies house number; specific to companies registered with Companies house in the UK | \n
\n\n
\n
Error messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid company id | \n404 Not Found | \n | \n
\n\n
\n
Unique identifier for the company
\n","type":"text/plain"},"type":"string","value":"","key":"companyId"}]}},"response":[{"id":"641daca2-f1a6-4389-8474-3883fa3387fe","name":"Get Company (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/company/v2/companies/:companyId","host":["{{base_url}}"],"path":["company","v2","companies",":companyId"],"variable":[{"key":"companyId","value":"CompanyID9890","description":"Unique identifer for the company"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"243"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Oct 2020 15:38:53 GMT"},{"key":"x-amzn-RequestId","value":"3e3af632-403c-47d9-8f1b-0bd944bc7f7d"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VIOGKFItjoEFUyA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f99908d-1791f134633ea6471e149efd"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 afd7214ed49113ddaef00931a8295535.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"jOSZxgBcPL558tNXPrvfinNmwJ83rgTl-Rw4_5A4oK2L-XAN1SIT9A=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CompanyID9890\",\n \"name\": \"Company name\",\n \"description\": \"Micro SME\",\n \"website\": \"www.companyname.com\",\n \"industry\": \"IT\",\n \"address\": \"London\",\n \"externalId\": \"19988-7766\",\n \"crn\": \"14455-345\",\n \"createdAt\": \"2020-10-28T15:27:15.367Z\"\n}"}],"_postman_id":"e4942d08-43a3-4ecc-a0dc-78f701535199"},{"name":"Update Company (by id)","event":[{"listen":"test","script":{"id":"4e518867-5926-46dd-b7ec-6038a9149417","exec":[""],"type":"text/javascript"}}],"id":"f8838b9c-ed79-40ff-b02d-5a8f8e28b53a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"body":{"mode":"raw","raw":"{\n \"externalId\":\"3456\"\n}"},"url":"{{base_url}}/company/v2/companies/:companyId","description":"The ‘Update company’ endpoint will let you update a specific company’s details when the company id is passed as a parameter.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| companyId | \nstring | \nUnique identifier for the company | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field Name | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nCompany name | \n
\n\n| address | \nstring | \nRegistered address of the company | \n
\n\n| website | \nstring | \nWebsite (www.smewebsite.com) | \n
\n\n| industry | \nstring | \nIndustry name | \n
\n\n| description | \nstring | \nCompany description | \n
\n\n| externalId | \nstring | \nExternal ID that a partner may want to use to identify a company | \n
\n\n| crn | \nstring | \nCompanies house number; specific to companies registered with Companies house in the UK | \n
\n\n
\n
Success
\n204 No content\n
\n\n Error messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Without company id | \n403 Forbidden | \n{“error”: “Invalid request”, “hint”: “Unsupported method or endpoint”} | \n
\n\n| Invalid company id | \n404 Not Found | \n | \n
\n\n
\n
Unique identifier for the company
\n","type":"text/plain"},"type":"string","value":"","key":"companyId"}]}},"response":[{"id":"e52a2969-6196-400a-8ec1-95fb87e8c28c","name":"Update Company (by id)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"body":{"mode":"raw","raw":"{\n \"externalId\":\"3456\"\n}"},"url":{"raw":"{{base_url}}/company/v2/companies/:companyId","host":["{{base_url}}"],"path":["company","v2","companies",":companyId"],"variable":[{"key":"companyId","value":"CompanyID9890","description":"Unique identifer for the company"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Oct 2020 15:40:18 GMT"},{"key":"x-amzn-RequestId","value":"9037936c-efc6-4963-92b2-7584dc0a75ea"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VIOTaH9wDoEF0Ag="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9990e2-512e6d2553679f1475bacecf"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 afd7214ed49113ddaef00931a8295535.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"0Ww4BFjDrfXyTJ0ClOagTn3wE3aU9sX14RxvBcQzhCpxJA_EphA4hg=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f8838b9c-ed79-40ff-b02d-5a8f8e28b53a"},{"name":"Delete Company (by id)","id":"5bc2032b-8418-4f90-a391-195679a948a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":"{{base_url}}/company/v2/companies/:companyId","description":"The ‘Delete company’ endpoint will let you delete a company when the company id has passed as a parameter.
\nDeleting the company will also delete all the data that has been associated with the company. The data includes bank accounts, bank transactions, forecasts etc.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| companyId | \nstring | \nUnique identifier for the company | \n
\n\n
\n
Success
\n202 Accepted\n
\n\n Error messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Without company id | \n403 Forbidden | \n{“error”: “Invalid request”, “hint”: “Unsupported method or endpoint”} | \n
\n\n| Invalid company id | \n404 Not Found | \n | \n
\n\n
\n
Unique identifier for the company
\n","type":"text/plain"},"type":"string","value":"","key":"companyId"}]}},"response":[{"id":"52ccb307-db24-4cc1-be96-799de9fd2035","name":"Delete Company (by id)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/company/v2/companies/:companyId","host":["{{base_url}}"],"path":["company","v2","companies",":companyId"],"variable":[{"key":"companyId","value":"CompanyID9890","description":"Unique identifer for the company"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Oct 2020 15:40:56 GMT"},{"key":"x-amzn-RequestId","value":"80a5f711-55a5-4711-96a0-dd1576e25cd7"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VIOZXEbkjoEFkmw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f999108-0880ec3960af92263c64e417"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 afd7214ed49113ddaef00931a8295535.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"OuWYNVD0cRHQyvS6RCYVb1gxvk2TmCA39x3olR0LNuismigz9eaITg=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5bc2032b-8418-4f90-a391-195679a948a9"}],"id":"f54e9405-ccf6-44ea-bc10-e034628af85a","description":" Overview
\n\ntomato pay Company API lets you create and retrieve companies. A company must be created before calling any other APIs as all financial data of an SME will be linked to the company.
\nFollowing endpoints for Company are supported:
\n\n- Create single company
\n- Create bulk companies
\n- Get companies
\n- Get company by id
\n- Update company
\n- Delete company
\n
\n
\n
\n\nLast updated: 14th October 2020\n\n- Added Update Company endpoint
\n- Companies can be queried by External ID and/or CRN
\n- Added support for creating single company and multiple companies
\n
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e7b1ee32-1f50-491e-b385-2f6ba5bb5f77","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c25c7b53-1ae6-449a-9d23-067a39509914","type":"text/javascript","exec":[""]}}],"_postman_id":"f54e9405-ccf6-44ea-bc10-e034628af85a"},{"name":"Bank Data API","item":[{"name":"Consents","item":[{"name":"Retrieve Banks","id":"e09cc91a-1026-49a7-8447-83719f8d7865","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"}],"url":"{{base_url}}/banking/v2/banks","description":"Retrieve a list of all available banks with their corresponding bank ids and logos. Bank id is required to create an auth for a bank, or to retrieve accounts, balances, and transactions for a particular bank.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \ninteger | \nUnique identifier for the bank | \n
\n\n| name | \nstring | \nName of the bank | \n
\n\n| logo | \nstring (link for logo in svg format) | \nLink with bank's logo | \n
\n\n| pngLogo | \nstring | \nBank logo URL | \n
\n\n| rdfName | \nstring | \nBank name | \n
\n\n| aisStatus | \nobject | \nStatus of Account information services (i.e. downloading accounts, balances, transactions etc.) consent | \n
\n\n| aisStatus->status | \nstring | \nstatus {Up, Down} | \n
\n\n| aisStatus->lastTested | \nDateTime | \nLast time when AIS connection was tested | \n
\n\n| aisStatus->lastSuccessful | \nDateTime | \nLast time when AIS connection was successful | \n
\n\n| pisStatus | \nobject | \nStatus of Payment information services consent | \n
\n\n| pisStatus->status | \nstring | \nstatus {Up, Down} | \n
\n\n| pisStatus->lastTested | \nDateTime | \nLast time when PIS connection was tested | \n
\n\n| pisStatus->lastSuccessful | \nDateTime | \nLast time when PIS connection was successful | \n
\n\n
\n
Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n| type | \nstring | \n{Account, Payment} | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":null}],"variable":[]}},"response":[{"id":"a9e0d7e2-708f-42ea-ae15-72cf6a913cce","name":"Retrieve Banks","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}","type":"text"},{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"url":"{{base_url}}/banking/v2/banks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"887445"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 27 Oct 2020 09:32:06 GMT"},{"key":"x-amzn-RequestId","value":"80baf2f9-4026-4edd-9957-f57e30659bbf"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VEFbYE4DDoEF6jA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f97e915-19ff5195589c2c4756ad1b60"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fe4c2207fc59dd7aa34d5b9c9e7bef06.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"ZeYjYoZns_fsu0giIcfqD5yc3VMFReT5N62VNgyPeU1IUYUSSa2tFQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": 31,\n \"name\": \"Monzo\",\n \"logo\": \"bank logo\",\n \"pnglogo\": \"https://bank-logos.tomatopay.co.uk/icon_Monzo.png\",\n \"rdfName\": \"MONZO\",\n \"aisStatus\": {\n \"status\": \"Up\",\n \"lastTested\": \"2021-04-12T08:39:15.590Z\",\n \"lastSuccessful\": \"2021-04-12T08:39:15.590Z\"\n },\n \"pisStatus\": {\n \"status\": \"Up\",\n \"lastTested\": \"2021-04-12T09:06:10.868Z\",\n \"lastSuccessful\": \"2021-04-12T09:06:13.983Z\"\n }\n },\n {\n \"id\": 7,\n \"name\": \"Natwest\",\n \"logo\": \"bank logo\",\n \"pnglogo\": \"https://bank-logos.tomatopay.co.uk/icon_Natwest.png\",\n \"rdfName\": \"Natwest\",\n \"aisStatus\": {\n \"status\": \"Up\",\n \"lastTested\": \"2021-04-12T08:39:15.590Z\",\n \"lastSuccessful\": \"2021-04-12T08:39:15.590Z\"\n },\n \"pisStatus\": {\n \"status\": \"Up\",\n \"lastTested\": \"2021-04-12T09:06:10.868Z\",\n \"lastSuccessful\": \"2021-04-12T09:06:13.983Z\"\n }\n }\n],\n \"links\": {}\n}\n"}],"_postman_id":"e09cc91a-1026-49a7-8447-83719f8d7865"},{"name":"Create Bank Consent","id":"9b156e2f-aba6-40d9-8677-30a0ec5abc36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"redirect\": \"redirect_URL\",\n \"permissions\": \"READALLBANKDATA\",\n \"bankId\": \"6\"\n}"},"url":"{{base_url}}/banking/v2/consents","description":"Before the user can sign in, a bank consent needs to be created in order to get the consent id and the authorisation date. By default, the consent lasts for 90 days as per Open Banking regulations. After 90 days, consent will have to be requested again.
\nBy default, a bank consent will be created to request all bank data from the user. If you want to request specific data, you can specify that in permissions.
\nCalling this endpoint will return a signInUrl for the user's bank, and a unique consentId that must be used in the \"Put bank consent\" request.
\nOn successful authentication, a code, id_token, and state will be returned along with the bankId.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| redirect | \nstring (link) | \nURL to redirect to after the bank account is added | \n
\n\n| permissions | \nstring | \n{READALLBANKDATA (download all bank data), READACCOUNTSDETAIL (download account details only)} | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| code | \nstring | \nTemporary code to be exchanged for access token with the bank | \n
\n\n| id_token | \nstring | \nBase64 encoded JSON for verifying state and token’s validity | \n
\n\n| state | \nstring | \nBase64 encoded JSON containing information about the original request to persist the state throughout the user journey | \n
\n\n| state->nonce | \nstring | \nString value used to associate a client session with an ID Token, and to mitigate replay attacks (for internal use) | \n
\n\n| state->reRed | \nstring | \nRedirect URL | \n
\n\n| state->accReq | \nstring | \ntomato pay consentId | \n
\n\n| state->bId | \ninteger | \nbankId (Unique identifier for the bank) | \n
\n\n| state->consentId | \nstring | \nbank consentId | \n
\n\n
\n
If a permission is not provided, then READALLBANKDATA permission will be requested by default.
\n Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Missing redirect | \n400 Bad Request | \n{\"error\": \"Missing/Invalid redirect”} | \n
\n\n| Invalid redirect | \n400 Bad Request | \n{\"error\": \"Missing/Invalid redirect”} | \n
\n\n| Invalid bankId | \n403 Forbidden | \n | \n
\n\n| Bank error | \n502 Bad Gateway | \n{“error”: “Bank error”} | \n
\n\n| Server error | \n500 Internal server error | \n | \n
\n\n
\n
Bank consents can be retrieved by filtering by bankId. This filter can be used in combination with companyId to search your application users' consents.
\nThe consent response will include the date of authorisation and the status.
\n Query parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| companyId | \nstring | \nUnique identifier for the company | \n
\n\n| permissions | \nstring | \n{READALLBANKDATA (download all bank data), READACCOUNTSDETAIL (download account details only)} | \n
\n\n| expiryDate | \ndatetime | \nDate when the consent expires | \n
\n\n| consentId | \nstring | \nUnique consent id returned by the bank | \n
\n\n| bankId | \ninteger | \nUnique id for the bank | \n
\n\n| authorisedDate | \ndatetime | \nDate when authorisation was provided by the user | \n
\n\n| status | \nstring | \nStatus of consent {Authorised, AwaitingAuthorisation, Rejected} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid bankId | \n403 Forbidden | \n | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""}],"variable":[]}},"response":[{"id":"3bc59e59-79be-4563-a37a-96ea48c92f90","name":"Retrieve Bank Consents","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Authorization}}","type":"text"},{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}","type":"text"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"url":{"raw":"{{base_url}}/banking/v2/consents","host":["{{base_url}}"],"path":["banking","v2","consents"],"query":[{"key":"pageId","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1804"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Oct 2020 18:39:45 GMT"},{"key":"x-amzn-RequestId","value":"e80dfa0b-f398-48f9-ab8e-a1424d4206bf"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VIolpH11DoEF8RQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f99baf0-09f8b1022eb608ec2c69a4c5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0bf3f0b7038d55ea4f178432aa6ddc53.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"smjEnHl4Z3sXOOyshaVzDlP0YZbHB8EKAAFfG4YqZSBYO3_btciieQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"companyId\": \"CompanyID1234\",\n \"permissions\": \"READALLBANKDATA\",\n \"consentId\": \"ConsentID12\",\n \"bankId\": 6,\n \"status\": \"AwaitingAuthorisation\"\n },\n {\n \"companyId\": \"CompanyID5678\",\n \"expiryDate\": \"2021-01-06T17:28:14.759Z\",\n \"permissions\": \"READACCOUNTSDETAIL\",\n \"consentId\": \"ConsentID34\",\n \"bankId\": 6,\n \"authorisedDate\": \"2020-10-08T17:28:14.759Z\",\n \"status\": \"Authorised\"\n },\n {\n \"companyId\": \"CompanyID9878\",\n \"permissions\": \"READALLBANKDATA\",\n \"consentId\": \"ConsentID98\",\n \"bankId\": 6,\n \"status\": \"Rejected\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"f9e0c6cf-e0e1-44c8-9420-b9e52b9dbcec"},{"name":"Retrieve Bank Consent (by id)","event":[{"listen":"test","script":{"id":"af8db399-562c-40fa-8a95-ba6f23dad0e2","exec":[""],"type":"text/javascript"}}],"id":"9906a74a-e19d-4a3d-9d0a-a0fcba433f8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Authorization}}","type":"text"},{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}","type":"text"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"url":"{{base_url}}/banking/v2/consents/:consentId","description":"Bank consents can be retrieved by filtering by bankId. This filter can be used in combination with companyId to search your application users' consents.
\nThe consent response will include the date of authorisation and the status.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| companyId | \nstring | \nUnique identifier for the company | \n
\n\n| permissions | \nstring | \n{READALLBANKDATA (download all bank data), READACCOUNTSDETAIL (download account details only)} | \n
\n\n| expiryDate | \ndatetime | \nDate when the consent expires | \n
\n\n| consentId | \nstring | \nUnique consent id returned by the bank | \n
\n\n| bankId | \ninteger | \nUnique id for the bank | \n
\n\n| authorisedDate | \ndatetime | \nDate when authorisation was provided by the user | \n
\n\n| status | \nstring | \nStatus of consent {Authorised, AwaitingAuthorisation, Rejected} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid consentId | \n404 Not found | \n | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""}],"variable":[{"type":"any","value":"","key":"consentId"}]}},"response":[{"id":"9cc92f3a-1cbf-4c9b-98ce-ebeaf0fcc94d","name":"Retrieve Bank Consent (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Authorization}}","type":"text"},{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}","type":"text"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"url":{"raw":"{{base_url}}/banking/v2/consents/:consentId","host":["{{base_url}}"],"path":["banking","v2","consents",":consentId"],"variable":[{"key":"consentId","value":"ConsentID34"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1804"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Oct 2020 18:39:45 GMT"},{"key":"x-amzn-RequestId","value":"e80dfa0b-f398-48f9-ab8e-a1424d4206bf"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VIolpH11DoEF8RQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f99baf0-09f8b1022eb608ec2c69a4c5"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0bf3f0b7038d55ea4f178432aa6ddc53.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"smjEnHl4Z3sXOOyshaVzDlP0YZbHB8EKAAFfG4YqZSBYO3_btciieQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"companyId\": \"CompanyID5678\",\n \"expiryDate\": \"2021-01-06T17:28:14.759Z\",\n \"permissions\": \"READACCOUNTSDETAIL\",\n \"consentId\": \"ConsentID34\",\n \"bankId\": 6,\n \"authorisedDate\": \"2020-10-08T17:28:14.759Z\",\n \"status\": \"Authorised\"\n}"}],"_postman_id":"9906a74a-e19d-4a3d-9d0a-a0fcba433f8b"},{"name":"Put Bank Consent (by id)","id":"d7610153-0fea-43ba-a21c-7c8ee1e3ffa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"body":{"mode":"raw","raw":"{\n \"bankId\": \"6\",\n \"code\": \"code\",\n \"id_token\": \"id_token\",\n \"state\": \"state\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/banking/v2/consents/:consentId","description":"Before connecting to the bank, authentication needs to be created in order to retrieve the sign in URL (signinUrl) for the bank. Calling this endpoint adds a bank account for companyId and bankId and redirects to the URL specified.
\nNow, your application will need to redirect a user to the signinUrl location for them to sign in through their bank account.
\nAfter the user successfully signs in, they will be redirected back to your redirect field in the initial POST request body, alongside query params in the url including code, id_token, and state.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| consentId | \nstring | \nUnique consent returned from the bank | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| code | \nstring | \nTemporary code to be exchanged for access token with the bank | \n
\n\n| id_token | \nstring | \nBase64 encoded JSON for verifying state and token’s validity | \n
\n\n| state | \nstring | \nBase64 encoded JSON containing information about the original request to persist the state throughout the user journey | \n
\n\n| state->nonce | \nstring | \nString value used to associate a client session with an ID Token, and to mitigate replay attacks (for internal use) | \n
\n\n| state->reRed | \nstring | \nRedirect URL | \n
\n\n| state->accReq | \nstring | \ntomato pay consentId | \n
\n\n| state->bId | \ninteger | \nbankId (Unique identifier for the bank) | \n
\n\n| state->consentId | \nstring | \nbank consentId | \n
\n\n
\n
Success
\n204 No content\n\n Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid bankId | \n403 Forbidden | \n | \n
\n\n| Invalid consentId | \n404 Not Found | \n | \n
\n\n| No code | \n400 Bad Request | \n{“error”: “Missing/Invalid code”} | \n
\n\n| No state | \n400 Bad Request | \n{“error”: “Missing/Invalid state} | \n
\n\n| No id_token | \n400 Bad Request | \n{“error”: “Missing/Invalid id_token”} | \n
\n\n| Invalid state | \n400 Bad Request | \n{“error”: “Missing/Invalid state”} | \n
\n\n| consentId is not in AwaitingAuthorisation status | \n400 Bad Request | \n{“error”: “Missing/Invalid Status”} | \n
\n\n| Invalid id_token | \n400 Bad Request | \n | \n
\n\n| Bank errors | \n502 Bad Gateway | \n{“error”: “Bank error”} | \n
\n\n
\n
Unique identifier for consent
\n","type":"text/plain"},"type":"string","value":"","key":"consentId"}]}},"response":[{"id":"eb5423bd-9faa-4712-8867-26ea4b2eaea1","name":"Put Bank Consent","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"body":{"mode":"raw","raw":"{\n \"bankId\": \"6\",\n \"code\": \"code\",\n \"id_token\": \"id_token\",\n \"state\": \"state\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/banking/v2/consents/:consentId","host":["{{base_url}}"],"path":["banking","v2","consents",":consentId"],"variable":[{"key":"consentId","value":"consentId1234","description":"Unique identifier for the bank consent"}]}},"status":"No content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Oct 2020 18:32:24 GMT"},{"key":"x-amzn-RequestId","value":"cb44d531-a070-4749-bf1a-077c1fc18c3d"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VIngxFJXDoEFdtw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f99b938-40343cb5672a6a6773397f79"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 e46d5e94093ff4a4a8b6b4e0d2227693.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"nQf69NfUE2HfNVrzKUeLowNzfpKw1IBumAnpIxDqEc2LaICRpfSGhA=="}],"cookie":[],"responseTime":null,"body":""}],"variable":[{"id":"459e9267-f75a-4513-b2a5-b6c3252afa5a","key":"consentId","value":"","type":"string","description":"Unique identifier for consent"}],"_postman_id":"d7610153-0fea-43ba-a21c-7c8ee1e3ffa7"},{"name":"Delete Bank Consent (by id)","id":"114be4ba-78f0-4ea2-802d-8c7bafd111c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/consents/:consentId","description":"Delete consent to a bank account
\nDeleting a user’s consent will also delete the tokens created through the user’s authorisation. To execute further requests requiring consent, you will need to request authorisation again.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| consentId | \nstring | \nUnique consent returned from the bank | \n
\n\n
\n
Success
\n202 Accepted\n\n Error messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid consentId | \n404 Not Found | \n | \n
\n\n
\n
Unique identifier for consent
\n","type":"text/plain"},"type":"string","value":"","key":"consentId"}]}},"response":[{"id":"c615e904-a4a6-4121-8d1b-742ea254538d","name":"Delete Bank Consent (by id)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/consents/:consentId","host":["{{base_url}}"],"path":["banking","v2","consents",":consentId"],"variable":[{"key":"consentId","value":"consentId678","description":"Unique identifier for the bank consent"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Oct 2020 18:55:07 GMT"},{"key":"x-amzn-RequestId","value":"6640b848-9ed0-450c-8a6b-91ee274d7439"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VIq1uGfVjoEFUaw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f99be8a-6e7df06805e3d18c7c5a7320"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3f2df5c7fd7d1f93fcc5a6422a7204f0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"mUx5ehxXzSyQFuscOjGlmPMAg8NlgkqQj6vOtFZlnIfgVU4CRXWdWA=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"114be4ba-78f0-4ea2-802d-8c7bafd111c3"}],"id":"85e4af31-0a92-4e73-9a75-42d014d2d481","description":"Before the user can sign in, a bank consent needs to be created. Creating a bank consent will generate a sign-in URL so that the user can authenticate and provide the consent. By default, the consent lasts for 90 days as per Open Banking regulations. After 90 days, consent will have to be requested again.
\nBy default, a bank consent will be created to request all bank data from the user. If you want to request specific data, you can specify that in permissions.
\nYour application will need to redirect a user to the signinUrl location for them to sign in on through their bank account.
\nAfter the user successfully signs in, you will be redirected back to your redirect URL.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"1a422d6c-ce03-4cad-aaba-76bab4072682","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c951dca5-c20f-4989-b2b8-b09634400529","type":"text/javascript","exec":[""]}}],"_postman_id":"85e4af31-0a92-4e73-9a75-42d014d2d481"},{"name":"Bank Data","item":[{"name":"Retrieve Bank Accounts","event":[{"listen":"test","script":{"id":"c6b05c4e-334e-44d8-9d44-77314e723882","exec":[""],"type":"text/javascript"}}],"id":"2758297c-b296-4103-ac38-b1b1b7bdd03c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/accounts","description":"This endpoint can be used to retrieve bank accounts for a business (using the bank id). The endpoint will return all the banks that a business has connected.
\nBank Accounts can be filtered by providing a bankId
\nApril 2021: Updated this endpoint and added consentId to the response
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the account | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| consentId | \nstring | \nUnique identifier for the consent | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| nickname | \nstring | \nNickname | \n
\n\n| account | \nJSON object | \nAccount information | \n
\n\n| account -> schemename | \nstring | \nIBAN or Account and sort code | \n
\n\n| account -> identification | \nstring | \nUnique id per bank account | \n
\n\n| account -> name | \nstring | \nAccount name | \n
\n\n| account -> secondaryIdentification | \nstring | \nAny optional extra information about account | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, OPENBANKING} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n{ \"error\": \"Missing/Invalid pageId” } | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank
\n","type":"text/plain"},"key":"bankId","value":""}],"variable":[]}},"response":[{"id":"c597dce9-0585-455c-ae80-afc9161cf104","name":"Retrieve Bank Accounts","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/accounts","host":["{{base_url}}"],"path":["banking","v2","accounts"],"query":[{"key":"pageId","value":"","description":"Page offset of results","disabled":true},{"key":"bankId","value":"","description":"Unique identifier for the bank","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"606"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Oct 2020 00:14:24 GMT"},{"key":"x-amzn-RequestId","value":"b9b87b12-b8c5-4a1e-b652-79aaee2885af"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VJZm2EV0DoEFkMA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9a095e-7a1c8dd132146d0d43e9716f"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 10131483569b12d46be11abd6f162905.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"0vjsPCr9h1_6dIpmmIggpyGSEcvIn8vG5Ffns-rGlwv61-7FWqwRBw=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"accountId1234\",\n \"consentId\": \"consentId5324\",\n \"bankId\": 6,\n \"currency\": \"GBP\",\n \"nickname\": \"Business Account\",\n \"account\": [\n {\n \"schemeName\": \"IBAN\",\n \"identification\": \"GBBANKIDEN1234\",\n \"name\": \"Debit Account\",\n \"secondaryIdentification\": \"Merrchant\"\n }\n ],\n \"externalId\": \"extenalid123\",\n \"source\": \"MANUALIMPORT\"\n },\n {\n \"id\": \"accountId5678\",\n \"consentId\": \"consentId1324\",\n \"currency\": \"GBP\",\n \"nickname\": \"Debit Account - NatWest - Demo\",\n \"account\": [\n {\n \"schemeName\": \"UK.OBIE.SortCodeAccountNumber\",\n \"identification\": \"5000004001234\",\n \"name\": \"Debit Account - NatWest - Demo\",\n \"secondaryIdentification\": \"\"\n }\n ],\n \"externalId\": \"\",\n \"source\": \"OPENBANKING\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"2758297c-b296-4103-ac38-b1b1b7bdd03c"},{"name":"Retrieve Bank Balances","event":[{"listen":"test","script":{"id":"2d26f1a0-588a-42fa-ba24-7ccfae29e21b","exec":[""],"type":"text/javascript"}}],"id":"c6232c86-f254-4e48-9df9-543a4bd8d83a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/balances","description":"Cash balances are returned for all the bank accounts that have been connected to the company.
\nBalances can be queried by bankId and accountId
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n| from | \ndateTime | \nReturns balances posted on or after from date | \n
\n\n| to | \ndateTime | \nReturns balances posted on or before \"to\" date | \n
\n\n| status | \nstring | \nBalance status {CLOSINGAVAILABLE, CLOSINGBOOKED, EXPECTED, FORWARDAVAILABLE, INFORMATION, INTERIMAVAILABLE, NTERIMBOOKED, OPENINGAVAILABLE, OPENINGBOOKED, PREVIOUSLYCLOSEDBOOKED} | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nBalance Id | \n
\n\n| accountId | \nstring | \nUnique identifier for the account | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| date | \ndatetime | \nBalance date | \n
\n\n| amount | \ninteger | \nBalance amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| status | \nstring | \nBalance status {CLOSINGAVAILABLE, CLOSINGBOOKED, EXPECTED, FORWARDAVAILABLE, INFORMATION, INTERIMAVAILABLE, NTERIMBOOKED, OPENINGAVAILABLE, OPENINGBOOKED, PREVIOUSLYCLOSEDBOOKED} | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, OPENBANKING} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid accountId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""},{"disabled":true,"description":{"content":"Returns balances posted on or after \"from\" date
\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"Returns balances posted on or before \"to\" date
\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank
\n","type":"text/plain"},"key":"bankId","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank account
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"Status of the balance
\n","type":"text/plain"},"key":"status","value":""}],"variable":[]}},"response":[{"id":"1985dc51-05b0-4897-b200-03ff7ce12426","name":"Retrieve Bank Balances","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}","type":"text"},{"key":"Authorization","value":"{{Authorization}}","type":"text"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"url":{"raw":"{{base_url}}/banking/v2/balances","host":["{{base_url}}"],"path":["banking","v2","balances"],"query":[{"key":"pageId","value":"","description":"Page offset of results","disabled":true},{"key":"from","value":"","description":"Returns balances posted on or after \"from\" date","disabled":true},{"key":"to","value":"","description":"Returns balances posted on or before \"to\" date","disabled":true},{"key":"bankId","value":"","description":"Unique identifier for the bank","disabled":true},{"key":"accountId","value":"","description":"Unique identifier for the bank account","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"83568"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Oct 2020 00:45:31 GMT"},{"key":"x-amzn-RequestId","value":"b0489a8e-34ce-4e30-acc0-8ab1ecb3c9d0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VJeKcHjnDoEFwyw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9a10a9-19c6161555cee499335e8b3f"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 9503482155e233e99173b53da4a996ff.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"RMLDXK4qPCpAjTFSEiiGVf-j8cWCrUQ0-FNIIHITcg6OZaMoIWDnUQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"balanceId1234\",\n \"bankId\": 6,\n \"accountId\": \"accountId1357\",\n \"date\": \"2020-10-05T00:00Z\",\n \"amount\": \"11477.35\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"status\": \"INTERIMBOOKED\",\n \"externalId\": \"\",\n \"source\": \"OPENBANKING\"\n },\n {\n \"id\": \"balanceId3456\",\n \"bankId\": 7,\n \"accountId\": \"accountId3579\",\n \"date\": \"2020-10-04T00:00Z\",\n \"amount\": \"15647.35\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"status\": \"CLOSINGBOOKED\",\n \"externalId\": \"\",\n \"source\": \"OPENBANKING\"\n },\n {\n \"id\": \"balanceId9876\",\n \"bankId\": 809,\n \"accountId\": \"accountId0087\",\n \"date\": \"2020-10-03T00:00Z\",\n \"amount\": \"1477.35\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"status\": \"CLOSINGBOOKED\",\n \"externalId\": \"\",\n \"source\": \"MANUALIMPORT\"\n }\n ],\n \"links\": {}\n}\n "}],"_postman_id":"c6232c86-f254-4e48-9df9-543a4bd8d83a"},{"name":"Retrieve Bank Transactions","event":[{"listen":"test","script":{"id":"c648a1de-2f34-40a4-9c0b-e830d400a52f","exec":[""],"type":"text/javascript"}}],"id":"ed354431-80b0-4574-b3fc-b42dd87fbc78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/transactions","description":"All bank transactions are returned across all connected user accounts. If dates are specified, then only transactions for specific dates are returned.
\nBank transactions can be queried by bankId and accountId.
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n| from | \ndateTime | \nReturns transactions posted on or after \"from\" date | \n
\n\n| to | \ndateTime | \nReturns transactions posted on or before \"to\" date | \n
\n\n| status | \nstring | \nStatus of the transaction { PENDING, CLOSINGBOOKED } | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the transaction | \n
\n\n| accountId | \nstring | \nUnique identifier for the account | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| bookingDate | \ndatetime | \nBooking date for the transaction | \n
\n\n| valueDate | \ndatetime | \nValue date for the transaction | \n
\n\n| transactionCode | \nstring | \nSpecifies the transaction family within a domain | \n
\n\n| transactionSubCode | \nstring | \nSub code of the transaction | \n
\n\n| proprietaryCode | \nstring | \nProprietary bank transaction code to identify the underlying transaction | \n
\n\n| proprietarySubCode | \nstring | \nProprietary sub code of the transaction | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| description | \nstring | \nDescription provided in the transaction | \n
\n\n| currency | \nstring | \nTransaction currency | \n
\n\n| amount | \ninteger | \nTransaction amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| status | \nstring | \nTransaction status {BOOKED,PENDING} | \n
\n\n| merchant | \nJSON Object | \nDetails of the merchant | \n
\n\n| merchant->id | \nstring | \nUnique identifier for the merchant | \n
\n\n| merchant->name | \nstring | \nName of the merchant | \n
\n\n| merchant->category | \nstring | \nBusiness category that the merchant belongs to | \n
\n\n| merchant->categoryCode | \ninteger | \nCategory Code | \n
\n\n| merchant->addressLine | \nstring | \nAddress of the merchant (if available) | \n
\n\n| merchant->source | \nstring | \nSource for how the merchant was identified {MODEL, USER, PROVIDER} | \n
\n\n| category | \nJSON Object | \nDetails of the transaction category | \n
\n\n| category->id | \ninteger | \nUnique identifier for the category | \n
\n\n| category->name | \nstring | \nName of the category | \n
\n\n| category->source | \nstring | \nSource for how the category was identified {MERCHANT, MODEL, USER, PROVIDER} | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, OPENBANKING} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid accountId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n{ \"Message\": \"Missing/Invalid pageId” } | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""},{"disabled":true,"description":{"content":"Returns transactions posted on or after \"from\" date
\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"Returns transactions posted on or before \"to\" date
\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank
\n","type":"text/plain"},"key":"bankId","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank account
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"Status of the transaction (PENDING, CLOSINGBOOKED)
\n","type":"text/plain"},"key":"status","value":""}],"variable":[]}},"response":[{"id":"786d45e6-a83a-40cf-9282-ca7afa750481","name":"Retrieve Bank Transactions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/transactions","host":["{{base_url}}"],"path":["banking","v2","transactions"],"query":[{"key":"pageId","value":"","description":"Page offset of results","disabled":true},{"key":"from","value":"","description":"Returns balances posted on or after \"from\" date","disabled":true},{"key":"to","value":"","description":"Returns balances posted on or before \"to\" date","disabled":true},{"key":"bankId","value":"","description":"Unique identifier for the bank","disabled":true},{"key":"accountId","value":"","description":"Unique identifier for the bank account","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"172855"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 27 Oct 2020 11:53:08 GMT"},{"key":"x-amzn-RequestId","value":"bdc3fc3d-0c5f-41ff-8f41-392a6afce96f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VEaFnFjXjoEFR0Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f980a23-7ac299e75db30fc100dccb94"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5dcf6621f285f97fa4781de4d191d289.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"9mBG3OBRKalQh4xhQllaQJmOoxLuN7EYMrF8J5Q90sxmfQEYoC_q5Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"transactionId1357\",\n \"bankId\": 6,\n \"accountId\": \"accountId5555\",\n \"bookingDate\": \"2020-10-16T00:00Z\",\n \"valueDate\": \"2020-10-16T00:00Z\",\n \"reference\": \"\",\n \"transactionCode\": \"\",\n \"transactionSubCode\": \"\",\n \"proprietaryCode\": \"\",\n \"proprietarySubCode\": \"\",\n \"description\": \"Dividends October\",\n \"amount\": \"2000.00\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"status\": \"BOOKED\",\n \"merchant\": {\n \"id\": \"merchantId579\",\n \"name\": \"Dividends\",\n \"categoryCode\": \"\",\n \"addressLine\": \"\",\n \"source\": \"BANK\"\n },\n \"category\": {\n \"id\": \"categoryID9876\",\n \"name\": \"Dividends\",\n \"source\": \"USER\"\n },\n \"externalId\": \"\",\n \"source\": \"MANUALIMPORT\"\n },\n {\n \"id\": \"transactionId1357\",\n \"bankId\": 7,\n \"accountId\": \"accountId1234\",\n \"bookingDate\": \"2020-10-16T00:00Z\",\n \"valueDate\": \"2020-10-16T00:00Z\",\n \"reference\": \"\",\n \"transactionCode\": \"\",\n \"transactionSubCode\": \"\",\n \"proprietaryCode\": \"\",\n \"proprietarySubCode\": \"\",\n \"description\": \"HMRC\",\n \"amount\": \"6200.00\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"status\": \"BOOKED\",\n \"merchant\": {\n \"id\": \"merchantId579\",\n \"name\": \"HMRC\",\n \"categoryCode\": \"\",\n \"addressLine\": \"\",\n \"source\": \"MODEL\"\n },\n \"category\": {\n \"id\": \"categoryID9876\",\n \"name\": \"Tax\",\n \"source\": \"MODEL\"\n },\n \"externalId\": \"\",\n \"source\": \"OPENBANKING\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"ed354431-80b0-4574-b3fc-b42dd87fbc78"},{"name":"Retrieve Parties","event":[{"listen":"test","script":{"id":"9932664a-c39c-4c9f-a05c-507a4d1adf75","exec":[""],"type":"text/javascript"}}],"id":"6bce3b1e-f502-47f7-954b-d9bc78663a64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/parties","description":"This endpoint can be used to retrieve party information.
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| partyType | \nstring | \n{Joint, Sole, Delegate} | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the party | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| name | \nstring | \nName of the party | \n
\n\n| email | \nstring | \nEmail address of the party | \n
\n\n| phoneNumber | \nstring | \nPhone number of the party | \n
\n\n| address | \nobject | \nAddress of the party | \n
\n\n| address->addressType | \nstring | \n{Business, Correspondence, Delivery to, Mail to, PO Box, Postal, Residential, Statement} | \n
\n\n| address->address | \nstring | \nAddress of the party | \n
\n\n| partyType | \nstring | \n{Joint, Sole, Delegate} | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n| source | \nstring | \nSource of data import {OPENBANKING} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n{ \"error\": \"Missing/Invalid pageId” } | \n
\n\n| Invalid partyType | \n400 Bad Request | \n{ \"error\": \"Missing/Invalid partyType” } | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank
\n","type":"text/plain"},"key":"bankId","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank acount
\n","type":"text/plain"},"key":"accountId","value":null},{"disabled":true,"description":{"content":"Party type {Joint, Sole, Delegate}
\n","type":"text/plain"},"key":"partyType","value":null}],"variable":[]}},"response":[{"id":"cca48635-958d-43d0-8f98-e621b11178eb","name":"Retrieve Parties","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/parties","host":["{{base_url}}"],"path":["banking","v2","parties"],"query":[{"key":"pageId","value":"","description":"Page offset of results","disabled":true},{"key":"bankId","value":"","description":"Unique identifier for the bank","disabled":true},{"key":"accountId","value":null,"description":"Unique identifier for the bank account","type":"text","disabled":true},{"key":"partyType","value":null,"description":"Party type {Joint, Sole, Delegate}","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"606"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Oct 2020 00:14:24 GMT"},{"key":"x-amzn-RequestId","value":"b9b87b12-b8c5-4a1e-b652-79aaee2885af"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VJZm2EV0DoEFkMA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9a095e-7a1c8dd132146d0d43e9716f"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 10131483569b12d46be11abd6f162905.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"0vjsPCr9h1_6dIpmmIggpyGSEcvIn8vG5Ffns-rGlwv61-7FWqwRBw=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"53f8b527-bb0c-4925-a2b1-8bf6356144ab\",\n \"bankId\": 23,\n \"accountId\": \"dec1b653-ba2a-41f0-8915-8a9bb6804d70\",\n \"name\": \"JULIA RESEARCH LTD\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"partyType\": \"\",\n \"address\": [],\n \"externalId\": \"7t9xg8rmekakd68o01c97lvcjzmf06nwcf4l\",\n \"source\": \"OPENBANKING\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"6bce3b1e-f502-47f7-954b-d9bc78663a64"},{"name":"Retrieve Parties (by id)","event":[{"listen":"test","script":{"id":"79e92bda-62cb-41d4-90e6-38ecc488d0cd","exec":[""],"type":"text/javascript"}}],"id":"dc5ab2c1-09e7-4573-992d-0aa039a02438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/parties/:partyId","description":"This endpoint can be used to retrieve party information by id
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the party | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| name | \nstring | \nName of the party | \n
\n\n| email | \nstring | \nEmail address of the party | \n
\n\n| phoneNumber | \nstring | \nPhone number of the party | \n
\n\n| address | \nobject | \nAddress of the party | \n
\n\n| address->addressType | \nstring | \n{Business, Correspondence, Delivery to, Mail to, PO Box, Postal, Residential, Statement} | \n
\n\n| address->address | \nstring | \nAddress of the party | \n
\n\n| partyType | \nstring | \n{Joint, Sole, Delegate} | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n| source | \nstring | \nSource of data import {OPENBANKING} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n| Invalid partyId | \n404 Not found | \n | \n
\n\n
\n
This endpoint can be used to retrieve a particular bank account using an account id.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| accountId | \nstring | \nUnique identifier for the account | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the account | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| consentId | \nstring | \nUnique identifier for the consent | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| nickname | \nstring | \nNickname | \n
\n\n| account | \nJSON object | \nAccount information | \n
\n\n| account -> schemename | \nstring | \nIBAN or Account and sort code | \n
\n\n| account -> identification | \nstring | \nUnique id per bank account | \n
\n\n| account -> name | \nstring | \nAccount name | \n
\n\n| account -> secondaryIdentification | \nstring | \nAny optional extra information about account | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, OPENBANKING} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid accountId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Unique identifier for the bank account
\n","type":"text/plain"},"type":"string","value":"","key":"accountId"}]}},"response":[{"id":"ce255dd3-b8fe-46b9-8e44-eb83d5be168c","name":"Retrieve Bank Account (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/accounts/:accountId","host":["{{base_url}}"],"path":["banking","v2","accounts",":accountId"],"query":[{"key":"bankId","value":"","type":"text","disabled":true}],"variable":[{"key":"accountId","value":"accountId1234","description":"Unique identifier for the bank account"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"307"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Oct 2020 00:37:38 GMT"},{"key":"x-amzn-RequestId","value":"3f7c8442-987c-49e2-b285-6d0f1cccbb6e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VJdA6HN4joEFrzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9a0ed2-3228b0f67f6f6ee90bba6e20"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f2ffdecd9dcbc7aeebcaf05ebb6a0967.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"rwAfF5SqgZH8B-fsCuxEKCHlhBdTmhxa1rpOLm4THqqarR3Zsnzzlw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"accountId1234\",\n \"bankId\": 6,\n \"consentId\": \"consentId1324\",\n \"currency\": \"GBP\",\n \"nickname\": \"Debit Account - NatWest - Demo\",\n \"account\": [\n {\n \"schemeName\": \"UK.OBIE.SortCodeAccountNumber\",\n \"identification\": \"5000004001234\",\n \"name\": \"Debit Account - NatWest - Demo\",\n \"secondaryIdentification\": \"\"\n }\n ],\n \"externalId\": \"\",\n \"source\": \"OPENBANKING\"\n}"}],"variable":[{"id":"6df5c420-d355-47fc-8470-b3e851c57a45","key":"accountId","value":"","type":"string","description":"Unique identifier for the bank account"}],"_postman_id":"b6556b0e-9cdb-4199-b372-589715f535a2"},{"name":"Retrieve Bank Balance (by id)","event":[{"listen":"test","script":{"id":"71efa3dc-357d-4d7b-b898-bd78ad69e321","exec":[""],"type":"text/javascript"}}],"id":"4769e60c-9524-4289-a519-9e4191459b83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/balances/:balanceId","description":"This endpoint can be used to retrieve a particular bank balance by providing a balance id.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| balanceId | \nstring | \nUnique identifier for balance | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nBalance Id | \n
\n\n| accountId | \nstring | \nUnique identifier for the account | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| date | \ndatetime | \nBalance date | \n
\n\n| amount | \ninteger | \nBalance amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| status | \nstring | \nBalance status {CLOSINGAVAILABLE, CLOSINGBOOKED, EXPECTED, FORWARDAVAILABLE, INFORMATION, INTERIMAVAILABLE, INTERIMBOOKED, OPENINGAVAILABLE, OPENINGBOOKED, PREVIOUSLYCLOSEDBOOKED} | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, OPENBANKING} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid balanceId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Unique identifier for the bank balance
\n","type":"text/plain"},"type":"string","value":"","key":"balanceId"}]}},"response":[{"id":"7e2109e9-cb99-4672-8b47-cad3ea149167","name":"Retrieve Bank Balance (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/balances/:balanceId","host":["{{base_url}}"],"path":["banking","v2","balances",":balanceId"],"variable":[{"key":"balanceId","value":"balanceId3456","description":"Unique identifier for the balance"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Oct 2020 01:13:18 GMT"},{"key":"x-amzn-RequestId","value":"6f6598cf-dc1b-44c2-b9b5-938804184b19"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VJiPFF2sDoEFfSA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9a172d-552b2cd933a958f74cd33c54"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 18c469438a584a68404b09c7cb7860cf.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"9Vacf_7Ez_4SEysejtSKjs7vc2-4xHeuaW_hwNK0mPLthAH6JZ16mg=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"balanceId3456\",\n \"bankId\": 7,\n \"accountId\": \"accountId3579\",\n \"date\": \"2020-10-04T00:00Z\",\n \"amount\": \"15647.35\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"status\": \"CLOSINGBOOKED\",\n \"externalId\": \"\",\n \"source\": \"OPENBANKING\"\n}"}],"variable":[{"id":"4b7fccf4-b72d-49bf-a3f5-e2386de63c8b","key":"balanceId","value":"","type":"string","description":"Unique identifier for the bank balance"}],"_postman_id":"4769e60c-9524-4289-a519-9e4191459b83"},{"name":"Retrieve Bank Transaction (by id)","event":[{"listen":"test","script":{"id":"5bb0f86a-8914-4cc7-88ed-359410daf24d","exec":[""],"type":"text/javascript"}}],"id":"3aec561f-c713-4eb8-bd36-5b62edef9278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/transactions/:transactionId","description":"This endpoint can be used to retrieve a particular bank transaction using a transaction id.
\nAll bank transactions are returned for all the accounts that the user has connected. If dates are specified, then only transactions for specific dates are downloaded.
\nBank transactions can be queried by bankId and accountId.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| transactionId | \nstring | \nUnique identifier for the transaction | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the transaction | \n
\n\n| accountId | \nstring | \nUnique identifier for the account | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| bookingDate | \ndatetime | \nBooking date for the transaction | \n
\n\n| valueDate | \ndatetime | \nValue date for the transaction | \n
\n\n| transactionCode | \nstring | \nSpecifies the transaction family within a domain | \n
\n\n| transactionSubCode | \nstring | \nSub code of the transaction | \n
\n\n| proprietaryCode | \nstring | \nProprietary bank transaction code to identify the underlying transaction | \n
\n\n| proprietarySubCode | \nstring | \nProprietary sub code of the transaction | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| description | \nstring | \nDescription provided in the transaction | \n
\n\n| currency | \nstring | \nTransaction currency | \n
\n\n| amount | \ninteger | \nTransaction amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| status | \nstring | \nTransaction status {BOOKED,PENDING} | \n
\n\n| merchant | \nJSON Object | \nDetails of the merchant | \n
\n\n| merchant->id | \nstring | \nUnique identifier for the merchant | \n
\n\n| merchant->name | \nstring | \nName of the merchant | \n
\n\n| merchant->category | \nstring | \nBusiness category that the merchant belongs to | \n
\n\n| merchant->categoryCode | \ninteger | \nCategory Code | \n
\n\n| merchant->addressLine | \nstring | \nAddress of the merchant (if available) | \n
\n\n| merchant->source | \nstring | \nSource for how the merchant was identified {MODEL, USER, PROVIDER} | \n
\n\n| category | \nJSON Object | \nDetails of the transaction category | \n
\n\n| category->id | \ninteger | \nUnique identifier for the category | \n
\n\n| category->name | \nstring | \nName of the category | \n
\n\n| category->source | \nstring | \nSource for how the category was identified {MERCHANT, MODEL, USER, PROVIDER} | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, OPENBANKING} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid transactionId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Unique identifier for the bank transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"4d63822e-f6ee-4448-b91c-74587d00ac18","name":"Retrieve Bank Transaction (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/transactions/:transactionId","host":["{{base_url}}"],"path":["banking","v2","transactions",":transactionId"],"variable":[{"key":"transactionId","value":"transactionId1357","description":"Unique identifier for the transaction"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"transactionId1357\",\n \"bankId\": 7,\n \"accountId\": \"accountId1234\",\n \"bookingDate\": \"2020-10-16T00:00Z\",\n \"valueDate\": \"2020-10-16T00:00Z\",\n \"reference\": \"\",\n \"transactionCode\": \"\",\n \"transactionSubCode\": \"\",\n \"proprietaryCode\": \"\",\n \"proprietarySubCode\": \"\",\n \"description\": \"HMRC\",\n \"amount\": \"6200.00\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"status\": \"BOOKED\",\n \"merchant\": {\n \"id\": \"merchantId579\",\n \"name\": \"HMRC\",\n \"categoryCode\": \"\",\n \"addressLine\": \"\",\n \"source\": \"MODEL\"\n },\n \"category\": {\n \"id\": \"categoryID9876\",\n \"name\": \"Tax\",\n \"source\": \"MODEL\"\n },\n \"externalId\": \"\",\n \"source\": \"OPENBANKING\"\n}"}],"variable":[{"id":"0e8b80d2-fed0-4f3b-92cb-1eb65410158d","key":"transactionId","value":"","type":"string","description":"Unique identifier for the bank transaction"}],"_postman_id":"3aec561f-c713-4eb8-bd36-5b62edef9278"}],"id":"f9aae903-627f-4406-bb12-29d6794651e7","description":"In order to access your user's bank data, you are required to obtain their consent to share this information. When the user authorises the request to share their bank data, then the following data can be retrieved from their banks:
\n\n- Bank accounts
\n- Bank balances
\n- Bank transactions
\n- Party information
\n
\n\nIn future versions, you will also be able to extract the following data:
\n\n- Account holder information
\n- Direct debits
\n- Standing orders
\n- Scheduled payments
\n- Account statements
\n
","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"01625eec-d9c0-40fa-af35-284a169bfa3c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45fd2bd7-9ec0-4821-ad9a-cb05d3d098b7","type":"text/javascript","exec":[""]}}],"_postman_id":"f9aae903-627f-4406-bb12-29d6794651e7"},{"name":"Categorisation and Merchants","item":[{"name":"Retrieve Categories","id":"0962da3a-1647-4327-8ab5-d8688606789e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"}],"url":"{{base_url}}/banking/v2/categories","description":"The ‘Get categories’ endpoint returns the list of categories that tomato pay currently supports. Category id and the category name are returned in the response.
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the category | \n
\n\n| name | \nstring | \nName of the category | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""}],"variable":[]}},"response":[{"id":"af296ec4-daca-4f70-946c-124670a4a8af","name":"Retrieve Categories","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}","type":"text"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}","type":"text"},{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"url":{"raw":"{{base_url}}/banking/v2/categories","host":["{{base_url}}"],"path":["banking","v2","categories"],"query":[{"key":"pageId","value":null,"description":"Page offset of results","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1129"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 26 Oct 2020 18:25:46 GMT"},{"key":"x-amzn-RequestId","value":"e797f9b5-5c71-4c09-927d-2b9d0470de42"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VCAqXEu4joEFawA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9714a8-4e39e4ac3713fe963d8110c8"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8eab33758f7a9d7a7d13481eabebea69.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"lDg0Bjjvq0A3mgptYT__xQcediyRQ1YWmpqzwtRqMZ0yHY5LvJCINQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"categoryId1234\",\n \"name\": \"Rent and Office\"\n },\n {\n \"id\": \"categoryId2345\",\n \"name\": \"Other Income\"\n },\n {\n \"id\": \"categoryId3456\",\n \"name\": \"Entertainment\"\n },\n {\n \"id\": \"categoryId4321\",\n \"name\": \"Travel and Subsistence\"\n },\n {\n \"id\": \"categoryId1357\",\n \"name\": \"Tax\"\n },\n {\n \"id\": \"categoryId2468\",\n \"name\": \"Payroll\"\n },\n {\n \"id\": \"categoryId1122\",\n \"name\": \"Technology\"\n },\n {\n \"id\": \"categoryId2244\",\n \"name\": \"Funding and Interest\"\n },\n {\n \"id\": \"categoryId5678\",\n \"name\": \"Miscellaneous\"\n },\n {\n \"id\": \"categoryId3355\",\n \"name\": \"Marketing\"\n },\n {\n \"id\": \"categoryId7788\",\n \"name\": \"Bank Charges and Repayments\"\n },\n {\n \"id\": \"categoryId7890\",\n \"name\": \"Professional Services\"\n },\n {\n \"id\": \"categoryId0123\",\n \"name\": \"Dividends\"\n },\n {\n \"id\": \"categoryId6543\",\n \"name\": \"Transfers\"\n },\n {\n \"id\": \"categoryId1010\",\n \"name\": \"Other Expenses\"\n },\n {\n \"id\": \"categoryId8989\",\n \"name\": \"Sales\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"0962da3a-1647-4327-8ab5-d8688606789e"},{"name":"Retrieve Category (by id)","id":"308b56f3-407d-44b3-bd3b-6ac39881e4ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"}],"url":"{{base_url}}/banking/v2/categories/:categoryId","description":"Retrieve Category by id
\nThe ‘Get categories by id’ endpoint returns the category linked to the corresponding category id that has been passed as a param.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| categoryId | \nstring | \nUnique identifier for the category | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the category | \n
\n\n| name | \nstring | \nName of the category | \n
\n\n
\n
Error messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid categoryId | \n404 Not Found | \n | \n
\n\n
\n
Unique identifier for the category
\n","type":"text/plain"},"type":"string","value":"","key":"categoryId"}]}},"response":[{"id":"25a33131-a89c-46d8-972a-eaaa61066659","name":"Retrieve Category (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/banking/v2/categories/:categoryId","host":["{{base_url}}"],"path":["banking","v2","categories",":categoryId"],"variable":[{"key":"categoryId","value":"categoryId1234","description":"Unique identifier for the category"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 26 Oct 2020 15:05:37 GMT"},{"key":"x-amzn-RequestId","value":"ea5f6235-947a-4019-8f92-61a631c13346"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VBjWMGkWjoEFRyQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f96e5c1-7d31b54b27895c5232fb4f93"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 31cf11cd322ac54e38d4a43fe3a12f04.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"4piZ2z5lFKDrDGEbe9BpQtrJ-Lu9MtyucXGB4U9EQhLgCZ_voxff7g=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"categoryId1234\",\n \"name\": \"Tax\"\n}"}],"variable":[{"id":"2f4d975a-6d4b-470e-a0fc-547030d4f023","key":"categoryId","value":"","type":"string","description":"Unique identifier for the category"}],"_postman_id":"308b56f3-407d-44b3-bd3b-6ac39881e4ee"},{"name":"Retrieve Merchants","id":"3f35677c-2ac8-49c5-b427-5b6271d72c38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"}],"url":"{{base_url}}/banking/v2/merchants","description":"The ‘Get Merchants’ endpoint returns the list of merchants that are currently categorised by tomato pay. Merchant id and the merchant name are returned in the response.
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the merchant | \n
\n\n| name | \nstring | \nName of the merchant | \n
\n\n| categoryCode | \nstring | \nCode for the category | \n
\n\n| addressLine | \nstring | \nMerchant address (if available) | \n
\n\n
\n
Page offset for results
\n","type":"text/plain"},"key":"pageId","value":""}],"variable":[]}},"response":[{"id":"0f69b638-8fb9-4b13-8917-42e259188430","name":"Retrieve Merchants","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/banking/v2/merchants","host":["{{base_url}}"],"path":["banking","v2","merchants"],"query":[{"key":"pageId","value":null,"description":"Page offset for results","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23404"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Oct 2020 17:08:38 GMT"},{"key":"x-amzn-RequestId","value":"2b8fb843-1139-40c5-8515-3885a0d63cce"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VLuLRGgGDoEFr6g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9af714-61ffb37d29de8ce140ad8e84"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 006e53d1925d4d044125ff497c18b3b4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"q4ElQSAgRtZ4mM1Oycs5r5aClESwzNYoxuLCmozRvvK1k0jgKqEtCw=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"categoryId1234\",\n \"name\": \"Vitalityhealth\",\n \"categoryCode\": \"\",\n \"addressLine\": \"\"\n },\n {\n \"id\": \"categoryId2345\",\n \"name\": \"Google\",\n \"categoryCode\": \"\",\n \"addressLine\": \"\"\n },\n {\n \"id\": \"categoryId3456\",\n \"name\": \"Uber\",\n \"categoryCode\": \"\",\n \"addressLine\": \"\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"3f35677c-2ac8-49c5-b427-5b6271d72c38"},{"name":"Retrieve Merchant (by id)","id":"f2514e2a-c804-4f97-8852-ee63de004d82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"}],"url":"{{base_url}}/banking/v2/merchants/:merchantId","description":"The ‘Get Merchant by id’ endpoint returns the merchant linked to the corresponding merchant id that has been passed as a param.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| merchantId | \nstring | \nUnique identifier for the merchant | \n
\n\n
\n
Attrributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the merchant | \n
\n\n| name | \nstring | \nName of the merchant | \n
\n\n| categoryCode | \nstring | \nCode for the category | \n
\n\n| addressLine | \nstring | \nMerchant address (if available) | \n
\n\n
\n
Error messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid merchantId | \n404 Not Found | \n | \n
\n\n
\n
Unique identifier for the merchant
\n","type":"text/plain"},"type":"string","value":"","key":"merchantId"}]}},"response":[{"id":"781ead40-c4d1-4062-8457-06045e9ef824","name":"Retrieve Merchant (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/banking/v2/merchants/:merchantId","host":["{{base_url}}"],"path":["banking","v2","merchants",":merchantId"],"variable":[{"key":"merchantId","value":"merchantId1234","description":"Unique identifier for the merchant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"104"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 26 Oct 2020 15:20:10 GMT"},{"key":"x-amzn-RequestId","value":"e69e39c6-221e-4a68-a818-2742120a30fb"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VBleoFykDoEFbuA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f96e92a-041f1f426d6ccbdf384f387f"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 9503482155e233e99173b53da4a996ff.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"IJ9orgtQBu0_DhO3vaQywi493PcQWiTmLUVqCtY3Cs3cFgqlvx7jBQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"merchantId1234\",\n \"name\": \"Google\",\n \"categoryCode\": \"\",\n \"addressLine\": \"\"\n}"}],"variable":[{"id":"fc31b42c-33d0-40a5-b2d2-037aca604e73","key":"merchantId","value":"","type":"string","description":"Unique identifier for the merchant"}],"_postman_id":"f2514e2a-c804-4f97-8852-ee63de004d82"},{"name":"Update Category","event":[{"listen":"test","script":{"id":"cdfd6acf-bcde-423b-8d74-970c66e71235","exec":[""],"type":"text/javascript"}}],"id":"98300499-2560-47d2-8339-a80afad2b865","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"category Id\",\n \"updateType\": \"ALL\"\n}"},"url":"{{base_url}}/banking/v2/transactions/:transactionId/category","description":"The ‘Update category’ endpoint can be used to update the category in a particular transaction.
\nIf the user re-categorises a transaction to a different category, they can do so by using this endpoint.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| transactionId | \nstring | \nUnique identifier for the transaction | \n
\n\n
\n
Attributes
\n\n\n\n\n\n| Field Name | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the new category | \n
\n\n| updateType | \nstring | \nupdateType {\"ONE\" will only recategorise a particular transaction, \"ALL\" will change all recategorise all similar transactions including past and future transactions} | \n
\n\n
\n
Success
\n204 No content\n\n Error messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid transactionId | \n404 Not Found | \n | \n
\n\n| Missing/Invalid categoryId | \n400 Bad Request | \n{ \"error\": \"Missing/invalid categoryId } | \n
\n\n| Missing/Invalid updateType | \n400 Bad Request | \n{ \"error\": \"Missing/invalid updateType } | \n
\n\n
\n
Unique identifier for the transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"9c2752c1-788e-4fd8-af30-ef425108ee42","name":"Update Category","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"categoryId1234\",\n \"updateType\": \"ALL\"\n}"},"url":{"raw":"{{base_url}}/banking/v2/transactions/:transactionId/category","host":["{{base_url}}"],"path":["banking","v2","transactions",":transactionId","category"],"variable":[{"key":"transactionId","value":"transacttionId2345","description":"Unique identifier for the transaction"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Oct 2020 17:29:08 GMT"},{"key":"x-amzn-RequestId","value":"07459487-5ece-4d59-9275-69d0946e7996"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VLxLnHLeDoEFe0g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9afbe3-35a6290c7b668a214d9e5542"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8eab33758f7a9d7a7d13481eabebea69.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"UX8jQJDSNARceVmlnWkiWIgKj83O0-gpnkpukDn3ga6El6doz6vE6Q=="}],"cookie":[],"responseTime":null,"body":""}],"variable":[{"id":"dfa0be94-1f4e-4446-93f9-11fb937f538e","key":"transactionId","value":"","type":"string","description":"Unique identifier for the transaction"}],"_postman_id":"98300499-2560-47d2-8339-a80afad2b865"},{"name":"Update Merchant","event":[{"listen":"test","script":{"id":"2170baaa-8307-4df7-ab6c-0acfee395ec7","exec":[""],"type":"text/javascript"}}],"id":"f75aa57d-a482-4f2a-96d0-63b7cc520b32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"64b7f5de-d178-4b23-a3a3-4c0783090d91\",\n \"updateType\": \"ALL\"\n}"},"url":"{{base_url}}/banking/v2/transactions/:transactionId/merchant","description":"The ‘Update category’ endpoint can be used to update the merchant in a particular transaction.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| transactionId | \nstring | \nUnique identifier for the transaction | \n
\n\n
\n
Attributes
\n\n\n\n\n\n| Field Name | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the merchant | \n
\n\n| updateType | \nstring | \nupdateType {\"ONE\" will only recategorise a particular transaction, \"ALL\" will change all recategorise all similar transactions including past and future transactions} | \n
\n\n
\n
Success
\n204 No content\n\n Error messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid transactionId | \n404 Not Found | \n | \n
\n\n| Missing/Invalid updateType | \n400 Bad Request | \n{ \"error\": \"Missing/invalid updateType } | \n
\n\n
\n
Unique identifier for the bank transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"6474d325-b46e-49f8-a4ba-f61361936c46","name":"Update Merchant","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"merchantId1234\",\n \"updateType\": \"ALL\"\n}"},"url":{"raw":"{{base_url}}/banking/v2/transactions/:transactionId/merchant","host":["{{base_url}}"],"path":["banking","v2","transactions",":transactionId","merchant"],"variable":[{"key":"transactionId","value":"transactionId1234","description":"Unique identifier for the transaction"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 29 Oct 2020 17:47:13 GMT"},{"key":"x-amzn-RequestId","value":"cd77fb9d-9fcf-4a98-8260-5964d05c10d4"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VLz1NEF4DoEFygg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9b0021-2dd8e3e1535113d31df0c4ce"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c5b4348a0bb5daaef6e0b0e13b317635.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"T4f3Gns0WUsIZMq9mFG72Cqr22UzuOzPvhb9ZoYojV4jud9s1m0-ew=="}],"cookie":[],"responseTime":null,"body":""}],"variable":[{"id":"e0b9feac-7412-4045-bf6f-32c3b68979a6","key":"transactionId","value":"","type":"string","description":"Unique identifier for the bank transaction"}],"_postman_id":"f75aa57d-a482-4f2a-96d0-63b7cc520b32"}],"id":"12791b0d-864b-4bc6-aec3-095b83888ccd","description":"tomato pay’s proprietary ‘Categorisation and Merchants’ solution uses machine learning to auto-categorise transactions in business categories and to identify merchants in transactions.
\nCategories and Merchants can also be updated using \"Update\" endpoints.
\nTransactions are auto-categorised into one of the following categories:
\n\n\n\n| Category | \nType | \n
\n\n\n\n| Dividends | \nExpense | \n
\n\n| Tax | \nExpense | \n
\n\n| Travel and Subsistence | \nExpense | \n
\n\n| Rent and Office | \nExpense | \n
\n\n| Marketing | \nExpense | \n
\n\n| Professional Services | \nExpense | \n
\n\n| Bank charges and repayments | \nExpense | \n
\n\n| Entertainment | \nExpense | \n
\n\n| Payroll | \nExpense | \n
\n\n| Other Expenses | \nExpense | \n
\n\n| Technology | \nExpense | \n
\n\n| Miscellaneous | \nExpense | \n
\n\n| Sales | \nIncome | \n
\n\n| Dividends | \nIncome | \n
\n\n| Transfers | \nIncome | \n
\n\n| Other Income | \nIncome | \n
\n\n| Funding and Interest | \nIncome | \n
\n\n| Miscellaneous | \nIncome | \n
\n\n
\n
This endpoint can be used to manually import bank accounts and link them to a company.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| nickname | \nstring | \nNickname | \n
\n\n| account | \nJSON object | \nAccount information | \n
\n\n| account -> schemename | \nstring | \nIBAN or Account and sort code | \n
\n\n| account -> identification | \nstring | \nUnique id per bank account | \n
\n\n| account -> name | \nstring | \nAccount name | \n
\n\n| account -> secondaryIdentification | \nstring | \nAny optional extra information about account | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| No request body | \n400 Bad Request | \n{ \"error\": \"Missing/invalid JSON” } | \n
\n\n| Missing/invalid currency | \n403 Forbidden | \n{ \"error\": \"Missing/invalid currency” } | \n
\n\n| Missing/Invalid bankId | \n404 Not Found | \n{ \"error\": \"Missing/invalid bankId” } | \n
\n\n
\n
The 'Add bank balances' endpoint can be used to add balances to accounts that were added using the ‘Add bank accounts’ endpoint.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| accountId | \nstring | \nUnique identifier for the account | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| date | \ndatetime | \nBalance data | \n
\n\n| amount | \ninteger | \nBalance amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| status | \nstring | \nBalance status {CLOSINGAVAILABLE, CLOSINGBOOKED, EXPECTED, FORWARDAVAILABLE, INFORMATION, INTERIMAVAILABLE, INTERIMBOOKED, OPENINGAVAILABLE, OPENINGBOOKED, PREVIOUSLYCLOSEDBOOKED} | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Missing/Invalid bankId | \n400 Bad Request | \n{\"error\": \"Missing/Invalid bankId\"} | \n
\n\n| Missing/Invalid accountId | \n400 Bad Request | \n{\"error\": \"Missing/Invalid accountId\"} | \n
\n\n| Missing/Invalid currency | \n400 Bad Request | \n{\"error\": \"Missing/Invalid currency\"} | \n
\n\n| Missing/Invalid amount | \n400 Bad Request | \n{\"error\": \"Missing/Invalid amount\"} | \n
\n\n| Missing/Invalid status | \n400 Bad Request | \n{\"error\": \"Missing/Invalid status\"} | \n
\n\n| Missing/Invalid type (DEBIT/CREDIT) | \n400 Bad Request | \n{\"error\": \"Missing/Invalid type\"} | \n
\n\n| Missing/Invalid date (ISO 8601 format) | \n400 Bad Request | \n{\"error\": \"Missing/Invalid bookingDate\"} | \n
\n\n| Adding more than 500 balances | \n413 Payload too large | \n | \n
\n\n
\n
The ‘Add bank transactions’ endpoint can be used to add transactions to accounts that are added using the ‘Add bank accounts’ endpoint.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| accountId | \nstring | \nUnique identifier for the account | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| bookingDate | \ndatetime | \nBooking date for the transaction | \n
\n\n| valueDate | \ndatetime | \nValue date for the transaction | \n
\n\n| transactionCode | \nstring | \nSpecifies the transaction family within a domain | \n
\n\n| transactionSubCode | \nstring | \nSub code of the transaction | \n
\n\n| proprietaryCode | \nstring | \nProprietary bank transaction code to identify the underlying transaction | \n
\n\n| proprietarySubCode | \nstring | \nProprietary sub code of the transaction | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| description | \nstring | \nDescription provided in the transaction | \n
\n\n| currency | \nstring | \nTransaction currency | \n
\n\n| amount | \ninteger | \nTransaction amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| status | \nstring | \nTransaction status {BOOKED,PENDING} | \n
\n\n| merchant->name | \nstring | \nName of the merchant | \n
\n\n| externalId | \nstring | \nAn Id linked to an external source | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Missing/Invalid bankId | \n400 Bad Request | \n{\"error\": \"Missing/Invalid bankId\"} | \n
\n\n| Missing/Invalid accountId | \n400 Bad Request | \n{\"error\": \"Missing/Invalid accountId\"} | \n
\n\n| Invalid currency | \n400 Bad Request | \n{\"error\": \"Missing/Invalid currency\"} | \n
\n\n| Invalid amount | \n400 Bad Request | \n{\"error\": \"Missing/Invalid amount\"} | \n
\n\n| Invalid status | \n400 Bad Request | \n{\"error\": \"Missing/Invalid status\"} | \n
\n\n| Invalid type (DEBIT/CREDIT) | \n400 Bad Request | \n{\"error\": \"Missing/Invalid type\"} | \n
\n\n| Invalid bookingDate (ISO 8601 format) | \n400 Bad Request | \n{\"error\": \"Missing/Invalid bookingDate\"} | \n
\n\n| Invalid valueDate (ISO 8601 format) | \n400 Bad Request | \n{\"error\": \"Missing/Invalid valueDate\"} | \n
\n\n| Adding more than 500 transactions | \n413 Payload too large | \n | \n
\n\n
\n
The ‘Delete bank account’ endpoint can be used to delete an account that was manually imported.
\nIt will also delete the transactions and balances linked to that bank account.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n
\n
Success
\n202 Accepted\n\n Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid accountId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Unique identifier for the bank account
\n","type":"text/plain"},"type":"string","value":"","key":"accountId"}]}},"response":[{"id":"a4aae826-b497-4482-8d42-345904cc7149","name":"Delete Bank Account (by id)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/accounts/:accountId","host":["{{base_url}}"],"path":["banking","v2","accounts",":accountId"],"variable":[{"key":"accountId","value":"accountId1234","description":"Unique identifier for the bank account"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 26 Oct 2020 19:25:09 GMT"},{"key":"x-amzn-RequestId","value":"28416e45-797d-49f3-806a-1da578985c86"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VCJXYGHHjoEFc1w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f972295-3eb3f4f62c7d1da65d83ca5a"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8cedfb7a16a346fb0119eb355ecdaf4c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"T4PGyp53Nt_J4JNlBzEsyqMPGzGN-Y-2-feOTFT6qMS7Rf5Leq0vGQ=="}],"cookie":[],"responseTime":null,"body":""}],"variable":[{"id":"685b8fc3-1789-4ce3-9077-5df174bd8260","key":"accountId","value":"","type":"string","description":"Unique identifier for the bank account"}],"_postman_id":"d9cf07e1-1ca1-4817-b97f-1ab74b805d37"},{"name":"Delete Bank Balance (by id)","event":[{"listen":"test","script":{"id":"cead4786-fc5a-413f-9161-709f844c24e8","exec":[""],"type":"text/javascript"}}],"id":"44085402-8423-408a-b958-db83b1902862","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/balances/:balanceId","description":"The ‘Delete bank balance’ endpoint can be used to delete a balance for an account that was manually imported.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| balanceId | \nstring | \nUnique identifier for balance | \n
\n\n
\n
Success
\n202 Accepted\n\n Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid balanceId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Unique identifier for the bank balance
\n","type":"text/plain"},"type":"string","value":"","key":"balanceId"}]}},"response":[{"id":"c53839c4-a42c-45a3-8c57-682ca04930ff","name":"Delete Bank Balance (by id)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/balances/:balanceId","host":["{{base_url}}"],"path":["banking","v2","balances",":balanceId"],"variable":[{"key":"balanceId","value":"balanceId1234","description":"Unique identifier for the bank balance"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 26 Oct 2020 19:24:40 GMT"},{"key":"x-amzn-RequestId","value":"3306b2c4-17bd-4e41-9039-e4a856b44890"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VCJSzEvnjoEFsOg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f972278-7c976f7b2fc77677289c9d24"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8cedfb7a16a346fb0119eb355ecdaf4c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"tM4h9_padc_5KrG3zwXa0Dvx6q327jP36AewxmV-G-OGS9WZJm8Guw=="}],"cookie":[],"responseTime":null,"body":""}],"variable":[{"id":"92be9e25-078e-4da3-b029-488f407df088","key":"balanceId","value":"","type":"string","description":"Unique identifier for the bank balance"}],"_postman_id":"44085402-8423-408a-b958-db83b1902862"},{"name":"Delete Bank Transaction (by id)","event":[{"listen":"test","script":{"id":"f2927d7f-4548-43cc-976c-283ef6fc15d8","exec":[""],"type":"text/javascript"}}],"id":"7b5ba083-52c2-4ce7-999e-b9931f829ae6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":"{{base_url}}/banking/v2/transactions/:transactionId","description":"Delete Bank Transaction endpoint can be used to delete transactions for an account that was manually imported.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| transactionId | \ninteger | \nUnique identifier for the transaction | \n
\n\n
\n
Success
\n202 Accepted\n\n Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid transactionId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Unique identifier for the bank transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"c74d47e4-f9a6-45a1-b3b3-a6764fb9acf5","name":"Delete Bank Transaction (by id)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","type":"text","value":"{{Authorization}}"},{"key":"X-Api-Key","type":"text","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","type":"text","value":"{{X-Partner-Id}}"},{"key":"X-Company-Id","type":"text","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/banking/v2/transactions/:transactions","host":["{{base_url}}"],"path":["banking","v2","transactions",":transactions"],"variable":[{"key":"transactions","value":"transactionId1234","description":"Unique identifier for the bank balance"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 26 Oct 2020 19:23:39 GMT"},{"key":"x-amzn-RequestId","value":"ed36d92e-d12b-4743-a0da-1de5de596e02"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VCJJOFavjoEF7Vw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f97223a-113174733c867ed3206e6b3b"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8cedfb7a16a346fb0119eb355ecdaf4c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"2KMJvDi3WQ1RrxJ3wJhOllNVx5_0MDcZMIejp-cpngdRV7eiXDZW0g=="}],"cookie":[],"responseTime":null,"body":""}],"variable":[{"id":"06f1b4c4-5608-4fdb-bc51-b1ca83fe9cf1","key":"transactionId","value":"","type":"string","description":"Unique identifier for the bank transaction"}],"_postman_id":"7b5ba083-52c2-4ce7-999e-b9931f829ae6"}],"id":"b33ef372-37b5-429e-aa96-4645ff216ebe","description":"Financial institutions can use their own data. This data may be richer than what is available with Open Banking through its manual data import functionality.
\nManually importing data is useful if the financial institution wishes to use another aggregator for retrieving Open Banking data, or if they aren't using Open Banking at all. They can still add accounts and leverage other tomato pay key features such as categorisation and forecasting.
\n","event":[{"listen":"prerequest","script":{"id":"5ada543f-98a5-406a-816e-629c2532dd72","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0eabc7fc-4de1-409b-aba4-7c83220c0908","type":"text/javascript","exec":[""]}}],"_postman_id":"b33ef372-37b5-429e-aa96-4645ff216ebe"}],"id":"dc3900f5-721d-473c-bc67-20df026f09e2","description":" Overview
\nThe tomato pay Bank Data API allows partners to securely access their customers’ banking data. This is downloaded through the Open Banking APIs.\n\n\nHow it works
\n Banking Data API Quick start
\nTo quickly test out tomato pay Banking API:\n\n- Obtained an authorisation token using the Authorisation API.
\n- Use the Company API to create a company which you’re going to link the data to.
\n
\nNext, you will need to:\n\n- Call the ‘Create bank auth’ with the redirect link, and get the sign-in URL.
\n- Create a bank consent to register user’s pending consent.
\n(User signs in and approves pending consent)\n- Once the user signs in and approves the pending consent, retrieve the desired bank accounts.
\n- Retrieve the accounts’ balance(s).
\n- Retrieve the accounts’ transactions.
\n
\nBank Data API includes endpoints for:\n\n- Consents: Create, update, retrieve and manage Open Banking consents.
\n- Bank Data (open banking): Retrieve accounts, balances and transactions.
\n- Categorisation and merchants: tomato pay's proprietary engine auto-categorises transactions and identifies merchants in transactions when they are not provided by the bank.
\n- Manually import bank data: Import transactions and use tomato pay data intelligence APIs (Categorisation and Merchants and Forecasting).\n
","event":[{"listen":"prerequest","script":{"id":"93711695-8658-4230-9da7-3b08d5e4f127","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9325ccaa-2b12-4fad-bfd4-eb92adef4d5e","type":"text/javascript","exec":[""]}}],"_postman_id":"dc3900f5-721d-473c-bc67-20df026f09e2"},{"name":"Payments API","item":[{"name":"Inbound payments","item":[{"name":"Create Payment Request","id":"f90ab3a7-207a-4e91-9050-964ed4fb5c64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"creditor\": {\n \"accountId\":\"6f440597-5af7-45f9-bf0d-0abbea113abd\"\n },\n \"currency\": \"GBP\",\n \"amount\": \"0.01\",\n \"reference\": \"test reference\",\n \"paymentType\": \"DOMESTIC\",\n \"usage\": \"SINGLE\",\n \"status\": \"ACTIVE\",\n \"isProtected\": false,\n \"purpose\": \"OTHERS\"\n}"},"url":"{{base_url}}/banking/v2/pay/payment-request","description":"The 'Create Payment Request' endpoint can be used to create request to pay link which will be powered by tomato pay web payment journey with pre-filled creditor and payment details.
\nOn clicking the web app, the user can make a payment by selecting their bank.
\nAttributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| creditor | \nJSON object | \nCreditor information | \n
\n\n| creditor -> accountId | \nstring | \nUnique identifier for the bank account (this is provided by Retrieve Bank Accounts endpoint) | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| paymentType | \nstring | \nPayment type {DOMESTIC} | \n
\n\n| usage | \nstring | \n{SINGLE/MULTI}
Configure the request to take either single or multiple payments | \n
\n\n| isProtected | \nboolean | \nIf set to true, retrieve endpoints will mask bank account details. | \n
\n\n| purpose | \nstring | \n{INVOICE, INSTANT_PAYMENTS, ECOMM, OTHERS}
Purpose for which the payment is being taken | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| No request body | \n400 Bad Request | \n{\"error\": \"Missing/Invalid json”} | \n
\n\n| No currency in the request body | \n400 Bad Request | \n{\"error\": \"Missing/invalid currency\"} | \n
\n\n| No amount in the request body | \n400 Bad Request | \n{\"error\": \"Missing/invalid amount\"} | \n
\n\n| Reference greater than 35 characters in the request body | \n400 Bad Request | \n{\"error\": \"The reference field has a maximum of 18 chars\"} | \n
\n\n| Invalid type | \n400 Bad Request | \n{\"error\": \"Missing/Invalid type. Must be DOMESTIC | \n
\n\n| No creditor in the request body | \n400 Bad Request | \n{\"error\": \"One of the following is mandatory: [creditor, creditorAccountId]\"} | \n
\n\n| Server error | \n500 Internal server error | \n | \n
\n\n
\n
The 'Retrieve payment request by id' endpoint can be used to look a specific payment request.
\nAttributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| creditor | \nJSON object | \nCreditor information | \n
\n\n| creditor -> accountId | \nstring | \nUnique identifier for the bank account (this is provided by Retrieve Bank Accounts endpoint) | \n
\n\n| creditor -> bankId | \nstring | \n | \n
\n\n| creditor -> name | \nstring | \nName on the bank account | \n
\n\n| creditor -> schemeName | \nstring | \nIBAN or Account and sort code | \n
\n\n| creditor -> identification | \nstring | \nUnique id per bank account | \n
\n\n| creditor -> accountType | \nstring | \nType of bank account e.g. BUSINESS, PERSONAL | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| paymentType | \nstring | \nPayment type {DOMESTIC} | \n
\n\n| usage | \nstring | \n{SINGLE/MULTI}
Configure the request to take either single or multiple payments | \n
\n\n| isProtected | \nboolean | \nIf set to true, retrieve endpoints will mask bank account details. | \n
\n\n| purpose | \nstring | \n{INVOICE, INSTANT_PAYMENTS, ECOMM, OTHERS}
Purpose for which the payment is being taken | \n
\n\n| status | \nstring | \n{ACTIVE, IN_ACTIVE} | \n
\n\n| creationDate | \nstring | \nDate and Time when the request was created | \n
\n\n
\n
The 'Retrieve payment requests' endpoint can be used to retrieve particular set of payment request using status and purpose.
\nAttributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| creditor | \nJSON object | \nCreditor information | \n
\n\n| creditor -> accountId | \nstring | \nUnique identifier for the bank account (this is provided by Retrieve Bank Accounts endpoint) | \n
\n\n| creditor -> bankId | \nstring | \n | \n
\n\n| creditor -> name | \nstring | \nName on the bank account | \n
\n\n| creditor -> schemeName | \nstring | \nIBAN or Account and sort code | \n
\n\n| creditor -> identification | \nstring | \nUnique id per bank account | \n
\n\n| creditor -> accountType | \nstring | \nType of bank account e.g. BUSINESS, PERSONAL | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| paymentType | \nstring | \nPayment type {DOMESTIC} | \n
\n\n| usage | \nstring | \n{SINGLE/MULTI}
Configure the request to take either single or multiple payments | \n
\n\n| isProtected | \nboolean | \nIf set to true, retrieve endpoints will mask bank account details. | \n
\n\n| purpose | \nstring | \n{INVOICE, INSTANT_PAYMENTS, ECOMM, OTHERS}
Purpose for which the payment is being taken | \n
\n\n| status | \nstring | \n{ACTIVE, IN_ACTIVE} | \n
\n\n| creationDate | \nstring | \nDate and Time when the request was created | \n
\n\n
\n
{ACTIVE, IN_ACTIVE}
\n","type":"text/plain"},"key":"status","value":null},{"description":{"content":"{INVOICE, INSTANT_PAYMENTS, ECOMM, OTHERS}
\n","type":"text/plain"},"key":"purpose","value":null}],"variable":[]}},"response":[{"id":"cab2e0de-38d1-4ca7-87a2-264006212fcb","name":"Retrieve Payment Requests","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"url":"{{base_url}}/banking/v2/pay/payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"358"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 27 Oct 2020 10:04:57 GMT"},{"key":"x-amzn-RequestId","value":"50c44bb9-a245-43f9-946b-79ec9353327c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VEKPZGCrDoEF9ZA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f97f0c8-14db3d063cfe7bb17bc0b319"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0bf3f0b7038d55ea4f178432aa6ddc53.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"JP6v6mhVbk5W26hAalxYmrZYW1qddo3F_BsfiBIXdemVQf1h5GukiQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"4b5b0eef-f17f-4760-afc9-1371f5b951c6\",\n \"partnerId\": \"6ae1c843-e97d-437c-81d8-6106e91c985f\",\n \"companyId\": \"2667fd3b-49e9-4a84-b77a-b013deada508\",\n \"paymentType\": \"DOMESTIC\",\n \"creditor\": {\n \"accountId\": \"6f440597-5af7-45f9-bf0d-0abbea113abd\",\n \"bankId\": 50,\n \"name\": \"Julia Research Ltd\",\n \"schemeName\": \"UK.OBIE.SortCodeAccountNumber\",\n \"identification\": \"60837109152388\",\n \"accountType\": \"BUSINESS\"\n },\n \"amount\": \"0.01\",\n \"currency\": \"GBP\",\n \"reference\": \"test reference\",\n \"creationDate\": \"2022-01-20T15:49:28.789Z\",\n \"updatedDate\": \"\",\n \"dynamicAmountUrl\": \"dynamicAmountUrl\",\n \"usage\": \"SINGLE\",\n \"status\": \"ACTIVE\",\n \"isProtected\": false,\n \"purpose\": \"OTHERS\",\n \"paymentLink\": \"https://pay.tomatopay.co.uk/request?l=eyJsaW5rSWQiOiJmMjJlZDMzYS1iNWUzLTRiZTUtYTgyYS1iNDMwYWY2OTliYzUiLCJwYXJ0bmVySWQiOiI2YWUxYzg0My1lOTdkLTQzN2MtODFkOC02MTA2ZTkxYzk4NWYifQ==\"\n }\n],\n\"links\": {}\n}\n"}],"_postman_id":"49f61880-76a1-4c8d-a1d0-577be52a40f4"}],"id":"124aee6f-3cc7-4092-9748-99300588d47e","_postman_id":"124aee6f-3cc7-4092-9748-99300588d47e","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","name":"Payments API","type":"folder"}}},{"name":"Outbound payments","item":[{"name":"Create Payment Consent","id":"37d4dda2-1b6e-415b-8dd5-1fa14836821c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bankId\": \"6\",\n \"redirect\": \"redirect_url\",\n \"creditor\": {\n \"schemeName\": \"UK.OBIE.SortCodeAccountNumber\",\n \"identification\": \"Identification\",\n \"name\": \"Account name\"\n },\n \"reference\": \"Reference\",\n \"amount\": \"1.00\",\n \"currency\": \"GBP\",\n \"type\": \"DOMESTIC\"\n}"},"url":"{{base_url}}/banking/v2/pay/domestic/consents","description":"Create Payment Consent
\nBefore initiating a payment, a payment request must be created and presented to the user for their consent.
\nPayment request must include the bank details of the payee and the details of the payment (amount, currency and payment type).
\nCalling this endpoint will generate a payment link (authUrl) that can be sent to the payer. The payer will have to authorise the payment by authenticating with their bank before it can be completed.
\nOn successful authentication, a code, id_token, and state will be returned along with the bankId.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| redirect | \nstring (link) | \nURL to redirect to after the bank account is added | \n
\n\n| creditor | \nJSON object | \nCreditor information | \n
\n\n| creditor -> schemeName | \nstring | \nIBAN or Account and sort code | \n
\n\n| creditor -> identification | \nstring | \nCreditor's account details | \n
\n\n| creditor -> name | \nstring | \nCreditor name | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| type | \nstring | \nPayment type {DOMESTIC} | \n
\n\n| code | \nstring | \nTemporary code to be exchanged for access token with the bank | \n
\n\n| id_token | \nstring | \nBase64 encoded JSON for verifying state and token’s validity | \n
\n\n| state | \nstring | \nBase64 encoded JSON containing information about the original request to persist the state throughout the user journey | \n
\n\n| state->nonce | \nstring | \nString value used to associate a client session with an ID Token, and to mitigate replay attacks (for internal use) | \n
\n\n| state->reRed | \nstring | \nRedirect URL | \n
\n\n| state->accReq | \nstring | \ntomato pay consentId | \n
\n\n| state->bId | \ninteger | \nbankId (Unique identifier for the bank) | \n
\n\n| state->consentId | \nstring | \nbank consentId | \n
\n\n
\n
Response
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| signInUrl | \nstring | \nSign in URL for the requested bank | \n
\n\n| consentId | \nstring | \nUnique ID for the consent | \n
\n\n| status | \nstring | \n | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid bankId | \n403 Forbidden | \n | \n
\n\n| No request body | \n400 Bad Request | \n{\"error\": \"Missing/Invalid redirect”} | \n
\n\n| Missing/Invalid redirect | \n400 Bad Request | \n{\"error\": \"Missing/Invalid redirect”} | \n
\n\n| No currency in the request body | \n400 Bad Request | \n{\"error\": \"Missing/invalid currency\"} | \n
\n\n| No amount in the request body | \n400 Bad Request | \n{\"error\": \"Missing/invalid amount\"} | \n
\n\n| Reference greater than 35 characters in the request body | \n400 Bad Request | \n{\"error\": \"The reference field has a maximum of 35 chars\"} | \n
\n\n| Invalid type | \n400 Bad Request | \n{\"error\": \"Missing/Invalid type. Must be DOMESTIC | \n
\n\n| No creditor in the request body | \n400 Bad Request | \n{\"error\": \"Missing/Invalid creditor.name\"} | \n
\n\n| Invalid schemeName in request body | \n400 Bad Request | \n\"error\": \"Missing/Invalid creditor.schemeName\" | \n
\n\n| Invalid identification in request body | \n400 Bad Request | \n\"error\": \"Missing/Invalid creditor.identification\" | \n
\n\n| Bank error | \n502 Bad Gateway | \n{error: “Bank error”} | \n
\n\n| Server error | \n500 Internal server error | \n | \n
\n\n
\n
Authorise Payment
\nBefore the payment can be initiated, the payment request needs to be approved.
\nBefore calling this endpoint, authentication needs to be created in order to retrieve the authentication URL (authUrl) for the bank.
\nNow, your application will need to redirect a user to the authUrl location for them to sign in through their bank account.
\nThe payment request will be completed once the user successfully signs in. You will be redirected back to your redirect field in the initial POST request body.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| consentId | \nstring | \nUnique identifier for the consent | \n
\n\n
\n
Request
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| code | \nstring | \nTemporary code to be exchanged for access token with the bank | \n
\n\n| id_token | \nstring | \nBase64 encoded JSON for verifying state and token’s validity | \n
\n\n| state | \nstring | \nBase64 encoded JSON containing information about the original request to persist the state throughout the user journey | \n
\n\n| state->nonce | \nstring | \nString value used to associate a client session with an ID Token, and to mitigate replay attacks (for internal use) | \n
\n\n| state->reRed | \nstring | \nRedirect URL | \n
\n\n| state->accReq | \nstring | \ntomato pay consentId | \n
\n\n| state->bId | \ninteger | \nbankId (Unique identifier for the bank) | \n
\n\n| state->consentId | \nstring | \nbank consentId | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the payment | \n
\n\n| consentId | \nstring | \nUnique identifier for the consent | \n
\n\n| companyId | \nstring | \nUnique identifier for the company | \n
\n\n| creditor | \nJSON object | \nCreditor information | \n
\n\n| creditor -> schemename | \nstring | \nIBAN or Account and sort code | \n
\n\n| creditor -> identification | \nstring | \nCreditor's account details | \n
\n\n| creditor -> name | \nstring | \nCreditor name | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| type | \nstring | \nPayment type {DOMESTIC} | \n
\n\n| creationDate | \ndatetime | \nDate and time of the transaction | \n
\n\n| remittanceInfo | \nstring | \nPartner Id is sent as remittance information in order to reconcile the payment with AIS transaction | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid bankId | \n403 Forbidden | \n | \n
\n\n| No code | \n400 Bad Request | \n{“error”: “Missing/Invalid bank code”} | \n
\n\n| No state | \n400 Bad Request | \n{“error”: “Missing/Invalid state} | \n
\n\n| No id_token | \n400 Bad Request | \n{“error”: “Missing/Invalid id_token”} | \n
\n\n| Invalid state | \n400 Bad Request | \n{“error”: “Missing/Invalid state”} | \n
\n\n| Invalid id_token | \n400 Bad Request | \n{“error”: “Open ID token verification failed”} | \n
\n\n| Bank errors | \n502 Bad Gateway | \n{“error”: “Bank error”} | \n
\n\n
\n
Unique identifier for the consent
\n","type":"text/plain"},"type":"any","value":"{{consentId}}","key":"consentId"}]}},"response":[{"id":"8a52da54-fdae-48a2-ba00-7130a6050783","name":"Authorise Payment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bankId\": 6,\n \"code\": \"code\",\n \"id_token\": \"id token\",\n \"state\": \"state\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/banking/v2/pay/domestic/consents/:consentId","host":["{{base_url}}"],"path":["banking","v2","pay","domestic","consents",":consentId"],"variable":[{"key":"consentId","value":"consentId3456"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"358"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 27 Oct 2020 10:02:59 GMT"},{"key":"x-amzn-RequestId","value":"86c98315-9b11-4fb9-b5ab-2eef120b49ec"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VEJ4_F1KDoEFkmw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f97f039-257c30cc7efccb8c6e053d2f"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0bf3f0b7038d55ea4f178432aa6ddc53.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"1245Qhsp4PLfuukbmAzz7h1bfB8uxTKKhD3drba-5o8NVUxrnMVkgQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"paymentId1234\",\n \"consentId\": \"consentId3456\",\n \"bankId\": 6,\n \"companyId\": \"companyId1234\",\n \"type\": \"DOMESTIC\",\n \"status\": \"PENDING\",\n \"amount\": \"25.00\",\n \"currency\": \"GBP\",\n \"reference\": \"reference\",\n \"creditor\": {\n \"schemeName\": \"UK.OBIE.SortCodeAccountNumber\",\n \"identification\": \"11223301234567\",\n \"name\": \"Creditor name\"\n },\n \"creationDate\": \"2020-10-27T10:02:37Z\",\n \"remittanceInfo\": \"partnerId1243\"\n}"}],"_postman_id":"6615dfcf-7755-46a8-a909-0c85560c3c01"},{"name":"Retrieve Payment Consents","id":"080a2e69-7c21-42e5-b051-7660c63fad08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/banking/v2/pay/domestic/consents","description":"Payment consents can be retrieved by providing a bankId.
\nThe consent response will include payment details (amount, currency, payment type), consent Id, date and status.
\n Query parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique consent id returned by the bank | \n
\n\n| companyId | \nstring | \nUnique id for the company | \n
\n\n| bankId | \ninteger | \nUnique id for the bank | \n
\n\n| creationDate | \ndatetime | \nDate when the consent was created | \n
\n\n| status | \nstring | \nStatus of consent {Authorised, AwaitingAuthorisation, Rejected} | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| type | \nstring | \nPayment type {DOMESTIC} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid bankId | \nEmpty response body | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""}],"variable":[]}},"response":[{"id":"b11cd3ec-2570-4748-a9fa-e6b91506f72b","name":"Retrieve Payment Consents","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/banking/v2/pay/domestic/consents/","host":["{{base_url}}"],"path":["banking","v2","pay","domestic","consents",""],"query":[{"key":"pageId","value":null,"description":"Page offset of results","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"8719"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 27 Oct 2020 10:32:55 GMT"},{"key":"x-amzn-RequestId","value":"988399f8-b0ff-4faf-874b-f0ae8a075509"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VEOVkGPPDoEFhSg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f97f756-6750edad1abd1c1d3192a57a"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7fba62cc8c04153ed4b922245ff30684.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"zCC3VtRyryRHDRBV0PHT5XPxVvNIAfdGplXNZWo-MLyjQX9nzuGpYw=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"consentId1234\",\n \"companyId\": \"companyId1234\",\n \"amount\": \"20.00\",\n \"currency\": \"GBP\",\n \"type\": \"DOMESTIC\",\n \"bankId\": 6,\n \"creationDate\": \"2020-07-30T15:10:38.002Z\",\n \"status\": \"AWAITINGAUTHORISATION\"\n },\n {\n \"id\": \"consentId1345\",\n \"companyId\": \"companyId1234\",\n \"amount\": \"10000.00\",\n \"currency\": \"GBP\",\n \"type\": \"DOMESTIC\",\n \"bankId\": 6,\n \"creationDate\": \"2020-10-20T09:11:14.164Z\",\n \"status\": \"AUTHORISED\"\n },\n {\n \"id\": \"consentId345\",\n \"companyId\": \"companyId1234\",\n \"amount\": \"100.00\",\n \"currency\": \"GBP\",\n \"type\": \"DOMESTIC\",\n \"bankId\": 6,\n \"creationDate\": \"2020-07-28T22:05:15.102Z\",\n \"status\": \"REJECTED\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"080a2e69-7c21-42e5-b051-7660c63fad08"},{"name":"Retrieve Payment Consent (by id)","id":"ae362f3b-3edb-42e1-97bb-e646c72607d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/banking/v2/pay/domestic/consents/:consentId","description":"Payment consents can be retrieved by providing a bankId.
\nThe consent response will include payment details (amount, currency, payment type), consent Id, date and status.
\n Path parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| consentId | \nstring | \nUnique identifier for the consent | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique consent id returned by the bank | \n
\n\n| companyId | \nstring | \nUnique id for the company | \n
\n\n| bankId | \ninteger | \nUnique id for the bank | \n
\n\n| creationDate | \ndatetime | \nDate when the consent was created | \n
\n\n| status | \nstring | \nStatus of consent {Authorised, AwaitingAuthorisation, Rejected} | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| type | \nstring | \nPayment type {DOMESTIC} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid consentId | \n404 Not Found | \n | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""}],"variable":[{"type":"any","value":null,"key":"consentId"}]}},"response":[{"id":"60c2cca5-729d-4b13-936d-92556b3ebcb2","name":"Retrieve Payment Consent (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/banking/v2/pay/domestic/consents/:consentId","host":["{{base_url}}"],"path":["banking","v2","pay","domestic","consents",":consentId"],"query":[{"key":"pageId","value":null,"description":"Page offset of results","type":"text","disabled":true}],"variable":[{"key":"consentId","value":"consentId1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"8719"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 27 Oct 2020 10:32:55 GMT"},{"key":"x-amzn-RequestId","value":"988399f8-b0ff-4faf-874b-f0ae8a075509"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VEOVkGPPDoEFhSg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f97f756-6750edad1abd1c1d3192a57a"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7fba62cc8c04153ed4b922245ff30684.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"zCC3VtRyryRHDRBV0PHT5XPxVvNIAfdGplXNZWo-MLyjQX9nzuGpYw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"consentId1234\",\n \"companyId\": \"companyId1234\",\n \"amount\": \"20.00\",\n \"currency\": \"GBP\",\n \"type\": \"DOMESTIC\",\n \"bankId\": 6,\n \"creationDate\": \"2020-07-30T15:10:38.002Z\",\n \"status\": \"AWAITINGAUTHORISATION\"\n}"}],"_postman_id":"ae362f3b-3edb-42e1-97bb-e646c72607d8"}],"id":"c5af211d-a1f8-462a-b396-262ec6ad5379","_postman_id":"c5af211d-a1f8-462a-b396-262ec6ad5379","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","name":"Payments API","type":"folder"}}},{"name":"Subscription API","item":[{"name":"Subscription Request","item":[{"name":"Subscription Request","id":"bf8c0b6c-40d1-42a0-b8b9-59ec0dab18a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{X-Company-Id}}"}],"body":{"mode":"raw","raw":"{\n \"requestorBankAccountId\": \"807802ac-6699-4583-bf3b-c74dffcc2dd1\",\n \"products\": \"SMART_INVOICE\",\n \"frequency\": \"MONTHLY\",\n \"numberOfPayments\": 50,\n \"trialDuration\": 45,\n \"amount\": \"9.95\",\n \"currency\": \"GBP\",\n \"resourceBaseurl\": \"\"\n}"},"url":"{{base_url}}/banking/v2/pay/domestic/subscription/subscription-request","description":"The 'Create Subscription Request' endpoint can be used to create request which contains the details the subscription plan such as the Payee Bank Account,Trial duration ,amount and products.
\nAttributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| requestorBankAccountId | \nstring | \nUnique identifier for the bank account (this is provided by Retrieve Bank Accounts endpoint) | \n
\n\n| products | \nstring | \nComma separated list of products that can be subscribed | \n
\n\n| frequency | \nstring | \nPayment frequency MONTHLY/QUARTERLY/SEMIANNUAL/ANNUAL/DAILY | \n
\n\n| amount | \ninteger | \nSubscription amount | \n
\n\n| numberOfPayments | \ninteger | \nthe total number of payments to be made. | \n
\n\n| trialDuration | \ninteger | \ntrail duration in days | \n
\n\n| currency | \nstring | \ncurrency | \n
\n\n| resourceBaseurl | \nstring | \nurl to get the static content details like description , offer details | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| No request body | \n400 Bad Request | \n{\"error\": \"Missing/Invalid json”} | \n
\n\n| No currency in the request body | \n400 Bad Request | \n{\"error\": \"Missing/invalid currency\"} | \n
\n\n| No amount in the request body | \n400 Bad Request | \n{\"error\": \"Missing/invalid amount\"} | \n
\n\n| No products in the request body | \n400 Bad Request | \n{\"error\": \"Missing/Invalid product} | \n
\n\n| No requestorBankAccountId in the request body | \n400 Bad Request | \n{\"error\": \"Missing/Invalid requestorBankAccountId} | \n
\n\n| No trialDuration | \n400 Bad Request | \n{\"error\": \"Missing/Invalid trialDuration\"} | \n
\n\n| Server error | \n500 Internal server error | \n | \n
\n\n
\n
This endpoint can be used to retrieve subscription requests for a company.
\nQuery Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| products | \nstring | \ncomma separated product list | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionRequestId | \nstring | \nUnique identifier for subscription request | \n
\n\n| products | \nstring | \nComma separated list of products that can be subscribed | \n
\n\n| frequency | \nstring | \nPayment frequency MONTHLY/QUARTERLY/SEMIANNUAL/ANNUAL/DAILY | \n
\n\n| amount | \ninteger | \nSubscription amount | \n
\n\n| numberOfPayments | \ninteger | \nthe total number of payments to be made. | \n
\n\n| trialDuration | \ninteger | \ntrail duration in days | \n
\n\n| currency | \nstring | \ncurrency | \n
\n\n| requestorBankAccount | \nstring | \nPayee Bank Account details | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n{ \"error\": \"Missing/Invalid pageId” } | \n
\n\n
\n
This endpoint can be used to retrieve a particular subscription request .
\nPath variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionRequestId | \nstring | \nUnique identifier for the subscription request. | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionRequestId | \nstring | \nUnique identifier for subscription request | \n
\n\n| products | \nstring | \nComma-separated list of products that can be subscribed | \n
\n\n| frequency | \nstring | \nPayment Frequency MONTHLY/QUARTERLY/SEMIANNUAL/ANNUAL/DAILY | \n
\n\n| amount | \ninteger | \nSubscription amount | \n
\n\n| numberOfPayments | \ninteger | \nthe total number of payments to be made. | \n
\n\n| trialDuration | \ninteger | \ntrail duration in days | \n
\n\n| currency | \nstring | \ncurrency | \n
\n\n| requestorBankAccount | \nstring | \nPayee Bank Account details | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid subscriptionRequestId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Subscription Request is the domain object which contains the details of Payee Bank Account , amount, frequency ,trial duration and products which can be subscribed.
\n","_postman_id":"77450569-4094-4b11-ae47-f6a9f976aeeb","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","name":"Payments API","type":"folder"}}},{"name":"Subscription Consent","item":[{"name":"Subscription Consent","id":"2b2719dc-e294-4452-9071-d29b7dbdc4b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{payerCompanyId}}"}],"body":{"mode":"raw","raw":"{\n \"bankId\": \"52\",\n \"redirect\" : \"http://localhost:3000\",\n \"subscriptionRequestId\": \"655dbfad-aeda-4370-9401-2b63651caea0\",\n \"clientCallbackUrl\": \"app-deep-link\"\n\n}"},"url":"{{base_url}}/banking/v2/pay/domestic/subscription/subscriptionConsent","description":"Create Subscription Consent
\nBefore initiating a standing order payment, a subscription request must be created and presented to the user for their consent.
\nPayment request must include the bank details of the payee and the details of the payment (amount, currency and payment type).
\nCalling this endpoint will generate a bank sigin url that can be sent to the payer. The payer will have to authorise the payment by authenticating with their bank before it can be completed.
\nOn successful authentication, a code, id_token, and state will be returned along with the bankId.
\nAttributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| redirect | \nstring (link) | \nURL to redirect to after the bank account is authorised | \n
\n\n| subscriptionRequestId | \nstring | \nSubscription Request Id | \n
\n\n
\n
Response
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| signInUrl | \nstring | \nSign in URL for the requested bank | \n
\n\n| subscriptionConsentId | \nstring | \nUnique ID for the subscription consent | \n
\n\n| status | \nstring | \n | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid bankId | \n403 Forbidden | \n | \n
\n\n| No request body | \n400 Bad Request | \n{\"error\": \"Missing/Invalid redirect”} | \n
\n\n| Missing/Invalid redirect | \n400 Bad Request | \n{\"error\": \"Missing/Invalid redirect”} | \n
\n\n| No subscriptionRequestId in the request body | \n400 Bad Request | \n{\"error\": \"Missing/invalid subscriptionRequestId\"} | \n
\n\n| Invalid SubscriptionRequestId | \n403 Forbidden | \n | \n
\n\n| Server error | \n500 Internal server error | \n | \n
\n\n
\n
Subscription consents can be retrieved by providing the payer company.
\nThe consent response will include subscription consent details (amount, currency, payment type), consent Id, payment start Date and status.
\nQuery parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscription RequestId | \nstring | \nUnique id for the subscription Request | \n
\n\n| status | \nstring | \nstatus of the subscription consent(AUTHORISED/AWAITINGAUTHORISATION/CONSUMED/REJECTED) | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionConsentId | \nstring | \nUnique consent id | \n
\n\n| payerCompanyId | \nstring | \nUnique id for the company | \n
\n\n| bankId | \ninteger | \nUnique id for the bank | \n
\n\n| creationDate | \ndatetime | \nDate when the consent was created | \n
\n\n| subscriptionRequestId | \nstring | \nUnique id for the subscription Request | \n
\n\n| status | \nstring | \nStatus of consent {Authorised, AwaitingAuthorisation, Rejected} | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| idempotencyKey | \nstring | \nunique identifier for consent from the bank | \n
\n\n| authorisedDate | \nstring | \nDate when the consent was authorised | \n
\n\n| externalId | \nstring | \nexternal identifier for consent | \n
\n\n| paymentStartDate | \nstring | \npayment start date for the standing order | \n
\n\n| creationDate | \nstring | \nConsent Creation Date | \n
\n\n| type | \nstring | \nPayment type {DOMESTIC} | \n
\n\n| updatedDate | \nstring | \nConsent updated Date | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid CompanyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n | \n
\n\n| Invalid SubscrionRequestId | \n403 Forbidden | \n | \n
\n\n
\n
This endpoint can be used to retrieve a particular subscription consent.
\nThe consent response will include subscription consent details (amount, currency, payment type), consent Id, payment start Date and status.
\nPath variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionConsentId | \nstring | \nUnique identifier for the subscription consent. | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionConsentId | \nstring | \nUnique consent id | \n
\n\n| payerCompanyId | \nstring | \nUnique id for the company | \n
\n\n| bankId | \ninteger | \nUnique id for the bank | \n
\n\n| creationDate | \ndatetime | \nDate when the consent was created | \n
\n\n| subscriptionRequestId | \nstring | \nUnique id for the subscription Request | \n
\n\n| status | \nstring | \nStatus of consent {Authorised, AwaitingAuthorisation, Rejected} | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| idempotencyKey | \nstring | \nunique identifier for consent from the bank | \n
\n\n| authorisedDate | \nstring | \nDate when the consent was authorised | \n
\n\n| externalId | \nstring | \nexternal identifier for consent | \n
\n\n| paymentStartDate | \nstring | \npayment start date for the standing order | \n
\n\n| creationDate | \nstring | \nConsent Creation Date | \n
\n\n| type | \nstring | \nPayment type {DOMESTIC} | \n
\n\n| updatedDate | \nstring | \nConsent updated Date | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid subscriptionConsentId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Authorise Subscription Payment
\nBefore the subscription payment can be initiated, the payment request needs to be approved.
\nBefore calling this endpoint, subscription consent needs to be created in order to retrieve the authentication URL (sign-in url) for the bank.
\nNow, your application will need to redirect a user to the sign-in url location for them to sign in through their bank account.
\nThe payment request will be completed once the user successfully signs in. You will be redirected back to your redirect field in the initial POST request body.
\nRequest
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionConsentId | \nstring | \nunique identifier for the subscription consent | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| state | \nstring | \nBase64 encoded JSON containing information about the original request to persist the state throughout the user journey | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| Id | \nstring | \nUnique identifier for the subscription | \n
\n\n| subscriptionConsentId | \nstring | \nUnique identifier for the consent | \n
\n\n| payerCompanyId | \nstring | \nUnique identifier for the company | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| subscriptionRequestId | \nstring | \nUnique identifier for the subscription Request | \n
\n\n| creationDate | \nstring | \nDate and time of the transaction | \n
\n\n| subscriptionStatus | \nstring | \nStatus of the Subscription | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| products | \nstring | \ncomma-separated list of subscribed products | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid bankId | \n403 Forbidden | \n | \n
\n\n| Invalid consentId | \n403 Forbidden | \n | \n
\n\n| No state | \n400 Bad Request | \n{“error”: “Missing/Invalid state} | \n
\n\n| Invalid state | \n400 Bad Request | \n{“error”: “Missing/Invalid state”} | \n
\n\n| Bank errors | \n502 Bad Gateway | \n{“error”: “Bank error”} | \n
\n\n
\n
Create Company
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","name":"Payments API","type":"folder"}},"urlObject":{"path":["banking","v2","","pay","domestic","subscription",":subscriptionId"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"1b09189a-2cee-4f89-bb82-77121387472f","type":"any","value":null,"key":"subscriptionId"}]}},"response":[{"id":"41e81efb-fb29-4642-918f-c9f3ce4edf1f","name":"Update Subscription","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","disabled":true},{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"687400cc-bae5-4e20-a052-7e73f8fb7018"}],"body":{"mode":"raw","raw":"{\n \"status\": \"CANCELLATION_PENDING\",\n//PENDING,ACTIVE,CANCELLED,OVERDUE,REJECTED,CANCELLATION_PENDING\n \n}\n"},"url":{"raw":"{{base_url}}/banking/v2//pay/domestic/subscription/:subscriptionId","host":["{{base_url}}"],"path":["banking","v2","","pay","domestic","subscription",":subscriptionId"],"variable":[{"key":"subscriptionId","value":null}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"522"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jan 2022 18:13:53 GMT"},{"key":"x-amzn-RequestId","value":"b422bf12-c200-46f0-9d0c-119a0f1a92a3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"x-amz-apigw-id","value":"MdnfCH_MDoEFdRA="},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"X-Amzn-Trace-Id","value":"Root=1-61eeec60-3f0998866c20d73013f9df6a"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fc1b267cd678abf6b6d41947e148c0e0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR61-C1"},{"key":"X-Amz-Cf-Id","value":"KS_UrTxJfm5U1BWFoenhVRO0feWYYWufLjBNGoaR9j1HZMt5tYo5XA=="}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0c5318b9-aac2-4e49-acfa-f05feaa7ff4b"},{"name":"Retrieve Subscriptions","id":"fed1806a-688b-48c1-a9e3-f5a9643f6762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{payerComId}}"}],"url":"{{base_url}}/banking/v2/pay/subscriptions","description":"Subscriptions can be retrieved by providing the payer company.
\nThe subscription response will include subscription details (amount, currency, payment type), consent Id, payment start Date and status.
\nQuery parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscription RequestId | \nstring | \nUnique id for the subscription Request | \n
\n\n| status | \nstring | \nstatus of the subscription (PENDING,ACTIVE,CANCELLED,OVERDUE,REJECTED,CANCELLATION_PENDING) | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionId | \n | \nUnique identifier for the subscription | \n
\n\n| subscriptionConsentId | \nstring | \nUnique consent id | \n
\n\n| payerCompanyId | \nstring | \nUnique id for the company | \n
\n\n| bankId | \ninteger | \nUnique id for the bank | \n
\n\n| creationDate | \ndatetime | \nDate when the subscription was authorised | \n
\n\n| subscriptionRequestId | \nstring | \nUnique id for the subscription Request | \n
\n\n| subscriptionStatus | \nstring | \nStatus of the subscription {PENDING,ACTIVE,CANCELLED,OVERDUE,REJECTED,CANCELLATION_PENDING} | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| externalId | \nstring | \nexternal identifier for subscription payment | \n
\n\n| paymentStartDate | \nstring | \npayment start date for the standing order | \n
\n\n| products | \nstring | \ncomma-separated | \n
\n\n| updatedDate | \nstring | \nConsent updated Date | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid CompanyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n | \n
\n\n| Invalid SubscrionRequestId | \n403 Forbidden | \n | \n
\n\n
\n
This endpoint can be used to retrieve a particular subscription.
\nPath variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionId | \nstring | \nUnique identifier for the subscription. | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| subscriptionId | \n | \nUnique identifier for the subscription | \n
\n\n| subscriptionConsentId | \nstring | \nUnique consent id | \n
\n\n| payerCompanyId | \nstring | \nUnique id for the company | \n
\n\n| bankId | \ninteger | \nUnique id for the bank | \n
\n\n| creationDate | \ndatetime | \nDate when the subscription was authorised | \n
\n\n| subscriptionRequestId | \nstring | \nUnique id for the subscription Request | \n
\n\n| subscriptionStatus | \nstring | \nStatus of the subscription {PENDING,ACTIVE,CANCELLED,OVERDUE,REJECTED,CANCELLATION_PENDING} | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nPayment amount | \n
\n\n| externalId | \nstring | \nexternal identifier for subscription payment | \n
\n\n| paymentStartDate | \nstring | \npayment start date for the standing order | \n
\n\n| products | \nstring | \ncomma-separated | \n
\n\n| updatedDate | \nstring | \nConsent updated Date | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid subscriptionId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Subscription API allows the user to subscribe to a predefined plan. Subscription API is responsible for creating standing orders for the given amount once the trial period ends.
\n","_postman_id":"ee06fd1e-35cf-40b5-9d55-69cdf5e13334","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","name":"Payments API","type":"folder"}}},{"name":"Retrieve Payments","id":"d75e5c28-f692-48b1-89b3-4b971904725e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/banking/v2/pay/payments/","description":"The 'Retrieve payment' endpoint can be used to retrieve a particular payment using the bank id and payment id.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the payment | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| companyId | \nstring | \nUnique identifier for the company | \n
\n\n| consentId | \nstring | \nUnique identifier for the consent | \n
\n\n| creditor | \nJSON object | \nCreditor information | \n
\n\n| creditor -> schemeName | \nstring | \nIBAN or Account and sort code | \n
\n\n| creditor -> identification | \nstring | \nCreditor's account details | \n
\n\n| creditor -> name | \nstring | \nCreditor name | \n
\n\n| amount | \ninteger | \nBalance amount | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| type | \nstring | \nPayment type {DOMESTICSCHEDULED,DOMESTIC-STANDINGORDER, DOMESTIC-PAYMENT,INTERNATIONAL-SCHEDULED, INTERNATIONAL-STANDINGORDER, INTERNATIONAL-PAYMENT} | \n
\n\n| creationDate | \ndatetime | \nDate and time of the transaction | \n
\n\n| remittanceInfo | \nstring | \nPartner Id is sent in order to reconcile payment with AIS transaction | \n
\n\n
\n
The 'Retrieve payment' endpoint can be used to retrieve a particular payment using the bank id and payment id.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| paymentId | \nstring | \nUnique identifier for the payment | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the payment | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| companyId | \nstring | \nUnique identifier for the company | \n
\n\n| consentId | \nstring | \nUnique identifier for the consent | \n
\n\n| creditor | \nJSON object | \nCreditor information | \n
\n\n| creditor -> schemeName | \nstring | \nIBAN or Account and sort code | \n
\n\n| creditor -> identification | \nstring | \nCreditor's account details | \n
\n\n| creditor -> name | \nstring | \nCreditor name | \n
\n\n| amount | \ninteger | \nBalance amount | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| reference | \nstring | \nTransaction reference | \n
\n\n| type | \nstring | \nPayment type {DOMESTICSCHEDULED,DOMESTIC-STANDINGORDER, DOMESTIC-PAYMENT,INTERNATIONAL-SCHEDULED, INTERNATIONAL-STANDINGORDER, INTERNATIONAL-PAYMENT} | \n
\n\n| creationDate | \ndatetime | \nDate and time of the transaction | \n
\n\n| remittanceInfo | \nstring | \nPartner Id is sent in order to reconcile payment with AIS transaction | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid paymentId | \n404 Not Found | \n | \n
\n\n
\n
Unique identifier for the payment
\n","type":"text/plain"},"type":"string","value":"","key":"paymentId"}]}},"response":[{"id":"b63a67e1-9286-4222-b556-0e8041c253fc","name":"Retrieve Payment (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/banking/v2/pay/payments/:paymentId","host":["{{base_url}}"],"path":["banking","v2","pay","payments",":paymentId"],"variable":[{"key":"paymentId","value":"paymentId1234","description":"Unique identifier for the payment"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"358"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 27 Oct 2020 10:04:57 GMT"},{"key":"x-amzn-RequestId","value":"50c44bb9-a245-43f9-946b-79ec9353327c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VEKPZGCrDoEF9ZA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f97f0c8-14db3d063cfe7bb17bc0b319"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0bf3f0b7038d55ea4f178432aa6ddc53.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"JP6v6mhVbk5W26hAalxYmrZYW1qddo3F_BsfiBIXdemVQf1h5GukiQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"paymentId1234\",\n \"consentId\": \"consentId3456\",\n \"bankId\": 6,\n \"companyId\": \"companyId1234\",\n \"type\": \"DOMESTIC\",\n \"status\": \"PENDING\",\n \"amount\": \"25.00\",\n \"currency\": \"GBP\",\n \"reference\": \"reference\",\n \"creditor\": {\n \"schemeName\": \"UK.OBIE.SortCodeAccountNumber\",\n \"identification\": \"11223301234567\",\n \"name\": \"Creditor name\"\n },\n \"creationDate\": \"2020-10-27T10:02:37Z\",\n \"remittanceInfo\": \"partnerId1234\"\n}"}],"_postman_id":"f9961515-12f6-4917-91dc-38abe05e64b4"}],"id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875","description":"tomato pay Payments API allows partners to securely initiate payments on their SME customers' behalf. Payments use banks’ rails “Faster payments” and typically take a few seconds. Although it is bank specific, typically a single payment of up to £250,000 can be initiated through PISP.
For more information on the limits, please refer to the faster payments website
\ntomato pay Payments APIs have been divided into 2 broad categories
\n\n- Inbound payments - when merchants need to take payments by embedding a payment link on their eCommerce website, invoices, or simply through social channels
\n- Outbound payments - when merchants want to send payments to their suppliers and want to use the convenience of Open banking to initiate payments
\n
\nIn both situations, the end results of the payment is captured by the Payment Microservice as the payment entity which can be queried through the APIs.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c77197e9-59bb-4da0-b9ce-57eb6909728a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6524dd36-bcfc-43c5-a24a-7fd6b24dd4ea","type":"text/javascript","exec":[""]}}],"_postman_id":"0ad76a6e-26bd-4766-a5bc-d85df73fd875"},{"name":"Cashflow Forecast API","item":[{"name":"Forecasts","item":[{"name":"Get Forecasts","id":"85935dc6-1546-47ba-b38b-87092a1c89d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-APi-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":"{{base_url}}/forecasting/v2/forecasts","description":"Get all forecasts for the company. Each forecast has an id, timestamp, source and name.
\n Query parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the forecast | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| date | \ndatetime | \nDate when the forecast was generated | \n
\n\n| source | \nstring | \nSource of forecast {MODEL, MANUALIMPORT} | \n
\n\n| name | \nstring | \nName of Forecast | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid accountId | \n404 Not Found | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank
\n","type":"text/plain"},"key":"bankId","value":null},{"disabled":true,"description":{"content":"Unique identifier for the bank account
\n","type":"text/plain"},"key":"accountId","value":null}],"variable":[]}},"response":[{"id":"e5eab221-8b5f-4bf3-b336-ce64012dd39a","name":"Get Forecasts","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-APi-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/forecasting/v2/forecasts","host":["{{base_url}}"],"path":["forecasting","v2","forecasts"],"query":[{"key":"pageId","value":"","description":"Page offset of results","disabled":true},{"key":"bankId","value":null,"description":"Unique identifier for the bank","disabled":true},{"key":"accountId","value":null,"description":"Unique identifier for the bank account","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"413"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 01 Mar 2021 10:59:30 GMT"},{"key":"x-amzn-RequestId","value":"bdc09b7e-cab9-4942-a3e8-22b1f8904d1e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"bgRa4Eo7joEFj5Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-603cc912-3a06add604f5f0e12860ab14"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c40cc7e951805498bef454f55140dc73.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DEL51-C1"},{"key":"X-Amz-Cf-Id","value":"0QSYuqkcn0oR0sZEoCNQ3tlKmSHxkCkF2Z_L4kfJcCRnYQ_bOWGO-g=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"forecastId1234\",\n \"bankId\": 16,\n \"accountId\": \"9aed0933-8e38-4571-93dd-8e775c8233e7\",\n \"name\": \"Forecast-Mar1\",\n \"date\": \"2021-03-01T09:34:00.284Z\",\n \"source\": \"MANUALIMPORT\"\n },\n {\n \"id\": \"forecastId3456\",\n \"bankId\": 16,\n \"accountId\": \"9aed0933-8e38-4571-93dd-8e775c8233e7\",\n \"name\": \"model_forecast_21_03_01.09:32\",\n \"date\": \"2021-03-01T09:32:39.831Z\",\n \"source\": \"MODEL\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"85935dc6-1546-47ba-b38b-87092a1c89d4"},{"name":"Get Forecast (by id)","id":"0e86f4df-c228-48bc-9cc0-fba39b73b8aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-APi-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":"{{base_url}}/forecasting/v2/forecasts/:forecastId","description":"A specific forecast can be retrieved by providing a forecast id.
\nThe response will include a timestamp, source and name of the forecast.
\nGet all forecasts for the company. Each forecast has an id, timestamp, source and name.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| forecastId | \nstring | \nUnique identifier for the forecast | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the forecast | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| date | \ndatetime | \nDate when the forecast was generated | \n
\n\n| source | \nstring | \nSource of forecast {MODEL, MANUALIMPORT} | \n
\n\n| name | \nstring | \nName of Forecast | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid forecastId | \n404 Not Found | \n | \n
\n\n
\n
Unique identifier for the forecast
\n","type":"text/plain"},"type":"string","value":"","key":"forecastId"}]}},"response":[{"id":"a8557b31-677e-4f42-93d6-6e6817f0082f","name":"Get Forecast (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-APi-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/forecasting/v2/forecasts/:forecastId","host":["{{base_url}}"],"path":["forecasting","v2","forecasts",":forecastId"],"variable":[{"key":"forecastId","value":"forecastId1234","type":"string","description":"Unique identifier for the forecast"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"189"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 01 Mar 2021 11:06:02 GMT"},{"key":"x-amzn-RequestId","value":"7a62b202-1c90-40ed-9b8f-5b713c1fd7ab"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"bgSX2HKWjoEFpfA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-603cca98-78782fa35cd1a7b032a3019b"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 dcd4d3d277b3e5d294f974c2692b6cf2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DEL51-C1"},{"key":"X-Amz-Cf-Id","value":"CTrBCni2ZL_Rynizu4Ju1a6BpQh5qzNDvtnLDygwwzDKCWLfAs4Qzw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"forecastId1234\",\n \"bankId\": 16,\n \"accountId\": \"9aed0933-8e38-4571-93dd-8e775c8233e7\",\n \"name\": \"Forecast-Mar1\",\n \"date\": \"2021-03-01T09:34:00.284Z\",\n \"source\": \"MANUALIMPORT\"\n}"}],"_postman_id":"0e86f4df-c228-48bc-9cc0-fba39b73b8aa"}],"id":"5bb6bf28-8ecd-439a-9a1a-23599c2400d6","description":"A new forecast is generated every time new data is imported for that business.
\nEach forecast (at the time of data import) has an id, a timestamp and source. The id can be used to retrieve transactions and balances.
\nIt is recommended to use the most recent id to get the latest forecasted transactions and balances.
\n","event":[{"listen":"prerequest","script":{"id":"d77049b8-5418-460a-9db0-eeb6da89ecc9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0be0908e-5ebb-45f8-98ba-ebbb31675dfa","type":"text/javascript","exec":[""]}}],"_postman_id":"5bb6bf28-8ecd-439a-9a1a-23599c2400d6","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240","id":"e55285f1-b329-40b0-972c-d3ae6d90d240","name":"Cashflow Forecast API","type":"folder"}}},{"name":"Forecasted Transactions","item":[{"name":"Get Forecasted Transactions","event":[{"listen":"test","script":{"id":"4158261c-cda0-499e-acf4-32bcebe06312","exec":["// checking for unique transactionId","pm.test(\"checking for unique balanceId \", function () {"," var jsonData = pm.response.json();",""," var size = jsonData.results.length;",""," for(var i = 0; i < size; i++) {"," var trxIdCheck= jsonData.results[i].id;"," for(var j = i+1; j < size; j++){"," pm.expect(jsonData.results[j].id).not.to.eql(trxIdCheck);"," }"," }","});"],"type":"text/javascript"}}],"id":"33e1543f-08eb-4104-b917-f453c6511874","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Company-Id","value":"{{companyId}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":"{{base_url}}/forecasting/v2/transactions","description":"All forecasted transactions linked to the provided forecast id will be returned.
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n| from | \ndateTime | \nReturns forecasted transactions posted on or after \"from\" date | \n
\n\n| to | \ndateTime | \nReturns forecasted transactions posted on or before \"to\" date | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| forecastId | \nstring | \nUnique identifier for the forecast | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the transaction | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| forecastId | \nstring | \nUnique identifier for the forecast | \n
\n\n| valueDate | \ndateTime | \nValue date for the transaction | \n
\n\n| currency | \nstring | \nTransaction currency | \n
\n\n| amount | \ninteger | \nTransaction amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| merchant | \nstring | \nName of the merchant | \n
\n\n| category | \nstring | \nName of the category | \n
\n\n| reasons | \nstring | \nReasons why a particular transaction has been added to the forecast | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, MODEL} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n | \n
\n\n| Invalid accountId | \n404 Not Found | \n | \n
\n\n| Invalid forecastId | \n404 Not Found | \n | \n
\n\n
\n
Page offset of results
\n","type":"text/plain"},"key":"pageId","value":""},{"disabled":true,"description":{"content":"Returns forecasts posted on or after \"from\" date
\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"Returns forecasts posted on or before \"to\" date
\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank
\n","type":"text/plain"},"key":"bankId","value":null},{"disabled":true,"description":{"content":"Unique identifier for the bank account
\n","type":"text/plain"},"key":"accountId","value":null},{"disabled":true,"description":{"content":"Unique identifier for the forecast
\n","type":"text/plain"},"key":"forecastId","value":null}],"variable":[]}},"response":[{"id":"d98bdc8d-5edd-4a45-9122-83f58521e689","name":"Get Forecasted Transactions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Company-Id","value":"{{companyId}}"},{"key":"Authorization","value":"{{Authorization}}"}],"url":{"raw":"{{base_url}}/forecasting/v2/transactions","host":["{{base_url}}"],"path":["forecasting","v2","transactions"],"query":[{"key":"pageId","value":"","type":"text","description":"Page offset of results","disabled":true},{"key":"from","value":"","type":"text","description":"Returns forecasts posted on or after \"from\" date","disabled":true},{"key":"to","value":"","type":"text","description":"Returns forecasts posted on or before \"to\" date","disabled":true},{"key":"bankId","value":"","type":"text","description":"Unique identifier for the bank","disabled":true},{"key":"accountId","value":"","type":"text","description":"Unique identifier for the bank account","disabled":true},{"key":"forecastId","value":"","type":"text","description":"Unique identifier for the forecast","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"96660"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 01 Mar 2021 11:15:08 GMT"},{"key":"x-amzn-RequestId","value":"b9987cbb-4303-4f5d-bb1c-60b50e62c756"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"bgTtSFnXjoEFW5A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-603cccbb-47865ce14d72c1ec2262620f"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fefce332fa9cd85fae29d8a78eaabf6a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"BOM50-C1"},{"key":"X-Amz-Cf-Id","value":"qoPL-aed67GpZ6v3oWgCYnjeaPSLrVOA3a3B5PA_eq3tE4pq-PBRsQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"transactionId1234\",\n \"forecastId\": \"forecastId1234\",\n \"bankId\": 16,\n \"accountId\": \"9aed0933-8e38-4571-93dd-8e775c8233e7\",\n \"valueDate\": \"2020-09-18T03:59Z\",\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"type\": \"CREDIT\",\n \"merchant\": \"LLoyds\",\n \"category\": \"Tax\",\n \"reasons\": \"\",\n \"source\": \"MANUALIMPORT\"\n },\n {\n \"id\": \"transactionId2345\",\n \"forecastId\": \"forecastId2345\",\n \"bankId\": 16,\n \"accountId\": \"9aed0933-8e38-4571-93dd-8e775c8233e7\",\n \"valueDate\": \"2020-09-18T03:59Z\",\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"type\": \"CREDIT\",\n \"merchant\": \"LLoyds\",\n \"category\": \"Tax\",\n \"reasons\": \"\",\n \"source\": \"MANUALIMPORT\"\n },\n {\n \"id\": \"transactionId3456\",\n \"forecastId\": \"forecastId3456\",\n \"bankId\": 16,\n \"accountId\": \"9aed0933-8e38-4571-93dd-8e775c8233e7\",\n \"valueDate\": \"2020-09-18T03:59Z\",\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"type\": \"CREDIT\",\n \"merchant\": \"LLoyds\",\n \"category\": \"Tax\",\n \"reasons\": \"\",\n \"source\": \"MANUALIMPORT\"\n } \n ],\n \"links\": {}\n}"}],"_postman_id":"33e1543f-08eb-4104-b917-f453c6511874"},{"name":"Get Forecasted Transaction (by id)","id":"31a624b0-5cdc-4c66-9363-673fb3430923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":"{{base_url}}/forecasting/v2/transactions/:transactionId","description":"A particular forecasted transaction can be retrieved by providing a transaction id.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| transactionId | \nstring | \nUnique identifier for the transaction | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the transaction | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| forecastId | \nstring | \nUnique identifier for the forecast | \n
\n\n| valueDate | \ndatetime | \nValue date for the transaction | \n
\n\n| currency | \nstring | \nAccount currency | \n
\n\n| amount | \ninteger | \nTransaction amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| merchant | \nstring | \nName of the merchant | \n
\n\n| category | \nstring | \nName of the category | \n
\n\n| reasons | \nstring | \nReasons why a particular transaction has been added to the forecast | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, MODEL} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid transactionId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Unique identifier for the transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"510dbadb-ffcf-4813-965a-1caf250dd042","name":"Get Forecasted Transaction (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/forecasting/v2/transactions/:transactionId","host":["{{base_url}}"],"path":["forecasting","v2","transactions",":transactionId"],"variable":[{"key":"transactionId","value":"transactionId1234","type":"string","description":"Unique identifier for the transaction"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"318"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 01 Mar 2021 11:27:38 GMT"},{"key":"x-amzn-RequestId","value":"f347deff-dd2e-4944-bdd0-f7977a134b74"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"bgVilGZHjoEFzKg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-603ccfaa-572e836f03ce1bee7ffbcd76"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 af1285e159d40db6a95c829305a00563.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DEL51-C1"},{"key":"X-Amz-Cf-Id","value":"CXNdQusfm3sVud5u9TQtJwCu6NlMGutsp_IXUCmLQG8VV54YCksmHw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"transactionId1234\",\n \"forecastId\": \"5fb529e2-2172-4a60-a16e-0d4c5da2546c\",\n \"bankId\": 16,\n \"accountId\": \"9aed0933-8e38-4571-93dd-8e775c8233e7\",\n \"valueDate\": \"2020-09-18T03:59Z\",\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"type\": \"CREDIT\",\n \"merchant\": \"LLoyds\",\n \"category\": \"Tax\",\n \"reasons\": \"\",\n \"source\": \"MANUALIMPORT\"\n}"}],"_postman_id":"31a624b0-5cdc-4c66-9363-673fb3430923"}],"id":"bcb32858-01c7-49a4-a3ec-4e98b4b21edc","description":"A new forecast is generated every time new data is imported for that business. All forecasts can be retrieved by calling \"Get all forecasts\" endpoint.
\nEach forecast (at the time of data import) has an id, a timestamp and source. The id can be used to retrieve transactions.
\nIt is recommended to use the most recent id to get the latest forecasted transactions.
\n","event":[{"listen":"prerequest","script":{"id":"1c3aeb15-3652-47f6-98fc-c3ed4df55b92","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"acf3fc88-e6e1-4dd6-ba34-e8cc75683c0d","type":"text/javascript","exec":[""]}}],"_postman_id":"bcb32858-01c7-49a4-a3ec-4e98b4b21edc","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240","id":"e55285f1-b329-40b0-972c-d3ae6d90d240","name":"Cashflow Forecast API","type":"folder"}}},{"name":"Forecasted Balance","item":[{"name":"Get Forecasted Balances","event":[{"listen":"test","script":{"id":"67638572-9cb4-45f0-afe8-7eb8d1d7d688","exec":["// checking for unique balanceId","pm.test(\"checking for unique balanceId \", function () {"," var jsonData = pm.response.json();",""," var size = jsonData.results.length;",""," for(var i = 0; i < size; i++) {"," var balanceIdCheck= jsonData.results[i].id;"," for(var j = i+1; j < size; j++){"," pm.expect(jsonData.results[j].id).not.to.eql(balanceIdCheck);"," }"," }","});"],"type":"text/javascript"}}],"id":"a759ea73-a862-4bd9-904b-9c3785a6cf46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":"{{base_url}}/forecasting/v2/balances","description":"'Get Forecasted Balances' will return all the forecasted balances for the provided forecast id.
\n Query Parameters
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| forecastId | \nstring | \nUnique identifier for the forecast | \n
\n\n| pageId | \nstring | \nPage offset of results | \n
\n\n| from | \ndateTime | \nReturns balances posted on or after \"from\" date | \n
\n\n| to | \ndateTime | \nReturns balances posted on or before \"to\" date | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the balance | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| forecastId | \nstring | \nUnique identifier for the forecast | \n
\n\n| date | \ndatetime | \nBalance date | \n
\n\n| currency | \nstring | \nBalance currency | \n
\n\n| amount | \ninteger | \nBalance amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, MODEL} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid accountId | \n404 Not Found | \n | \n
\n\n| Invalid forecastId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n| Invalid pageId | \n400 Bad Request | \n | \n
\n\n
\n
Returns forecasted balances on or after \"from\" date
\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"Returns forecasts balances until \"to\" date
\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"Unique identifier for the bank
\n","type":"text/plain"},"key":"bankId","value":null},{"disabled":true,"description":{"content":"Unique identifier for the bank account
\n","type":"text/plain"},"key":"accountId","value":null},{"disabled":true,"description":{"content":"Unique identifier for the forecast
\n","type":"text/plain"},"key":"forecastId","value":null}],"variable":[]}},"response":[{"id":"f12fa306-353f-4a2d-b173-c9bc805b3259","name":"Get Forecasted Balances","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/forecasting/v2/balances","host":["{{base_url}}"],"path":["forecasting","v2","balances"],"query":[{"key":"from","value":"","disabled":true},{"key":"to","value":"","disabled":true},{"key":"pageId","value":null,"description":"Page offset of results","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"326"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 30 Oct 2020 19:52:07 GMT"},{"key":"x-amzn-RequestId","value":"d648b504-8e64-4fe6-9a25-04db0eb090b8"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VPZEGGshjoEF5lQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9c6ee6-5cd9cde4173bf74b30fd43fd"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a59cacde45227666db5b17829b32dd95.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"HO_G_sXSXhkVHUWdHIZxqjEyXSTrdqAneRsB24yhoDaTuYeTawIC5A=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"id\": \"90044386-1c09-40bf-b75f-622555da29f5\",\n \"bankId\": 16,\n \"accountId\": \"accountId1234\",\n \"forecastId\": \"forecastId1234\",\n \"date\": \"2020-11-30T03:59Z\",\n \"amount\": \"100000.00\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"source\": \"MANUALIMPORT\"\n },\n {\n \"id\": \"6cb6c2d1-5b8e-4efc-8e69-7e051a6c3820\",\n \"bankId\": 18,\n \"accountId\": \"accountId2345\",\n \"forecastId\": \"forecastId2345\",\n \"date\": \"2020-12-30T03:59Z\",\n \"amount\": \"110000.00\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"source\": \"MANUALIMPORT\"\n }\n ],\n \"links\": {}\n}"}],"_postman_id":"a759ea73-a862-4bd9-904b-9c3785a6cf46"},{"name":"Get Forecasted Balance (by id)","event":[{"listen":"test","script":{"id":"335ef4b4-a705-467d-8069-2e7552f50728","exec":["// checking for unique balanceId","pm.test(\"checking for unique balanceId \", function () {"," var jsonData = pm.response.json();",""," var size = jsonData.results.length;",""," for(var i = 0; i < size; i++) {"," var balanceIdCheck= jsonData.results[i].id;"," for(var j = i+1; j < size; j++){"," pm.expect(jsonData.results[j].id).not.to.eql(balanceIdCheck);"," }"," }","});"],"type":"text/javascript"}}],"id":"223439f8-0aee-4788-b5bd-45cdd8e9ea72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":"{{base_url}}/forecasting/v2/balances/:balanceId","description":"'Get Forecasted Balance' will return the forecasted balance for the provided forecast id
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| balanceId | \nstring | \nUnique identifier for the balance | \n
\n\n
\n
Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique identifier for the balance | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| forecastId | \nstring | \nUnique identifier for the forecast | \n
\n\n| date | \ndatetime | \nBalance date | \n
\n\n| currency | \nstring | \nBalance currency | \n
\n\n| amount | \ninteger | \nBalance amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| source | \nstring | \nSource of data import {MANUALIMPORT, MODEL} | \n
\n\n
\n
Error Messages
\n\n\n\n\n| Condition | \nResponse Status | \nResponse Body | \n
\n\n\n\n| Invalid balanceId | \n404 Not Found | \n | \n
\n\n| Invalid partnerId | \n403 Forbidden | \n | \n
\n\n| Invalid companyId | \n403 Forbidden | \n | \n
\n\n
\n
Unique identifier for forecasted balance
\n","type":"text/plain"},"type":"string","value":"","key":"balanceId"}]}},"response":[{"id":"c53374a8-82e5-48be-9e70-f3af381a560c","name":"Get Forecasted Balance (by id)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{base_url}}/forecasting/v2/balances/:balanceId","host":["{{base_url}}"],"path":["forecasting","v2","balances",":balanceId"],"variable":[{"key":"balanceId","value":"balanceId1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"326"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 30 Oct 2020 19:52:07 GMT"},{"key":"x-amzn-RequestId","value":"d648b504-8e64-4fe6-9a25-04db0eb090b8"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VPZEGGshjoEF5lQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9c6ee6-5cd9cde4173bf74b30fd43fd"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a59cacde45227666db5b17829b32dd95.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"HO_G_sXSXhkVHUWdHIZxqjEyXSTrdqAneRsB24yhoDaTuYeTawIC5A=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"balanceId1234\",\n \"bankId\": 16,\n \"accountId\": \"accountId1234\",\n \"forecastId\": \"forecastId1234\"\n \"date\": \"2020-11-30T03:59Z\",\n \"amount\": \"100000.00\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"source\": \"MANUALIMPORT\"\n}\n"}],"_postman_id":"223439f8-0aee-4788-b5bd-45cdd8e9ea72"}],"id":"32f2d402-b4df-4315-9955-63d4f58abbd5","description":"A new forecast is generated every time new data is imported for that business. All forecasts can be retrieved by calling the \"Get all forecasts\" endpoint.
\nEach forecast (at the time of data import) has an id, a timestamp and source. The id can be used to retrieve balances.
\nIt is recommended to use the most recent id to get the latest forecasted balance.
\n","event":[{"listen":"prerequest","script":{"id":"c4cad4da-18cc-45a3-9666-60349105a73f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e8ef073c-7873-4796-9552-dbbbf84b8ee8","type":"text/javascript","exec":[""]}}],"_postman_id":"32f2d402-b4df-4315-9955-63d4f58abbd5","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240","id":"e55285f1-b329-40b0-972c-d3ae6d90d240","name":"Cashflow Forecast API","type":"folder"}}},{"name":"User Generated Forecast","item":[{"name":"Create Forecast","id":"12362b95-1d2c-458b-9eff-502b6c4a3bac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"body":{"mode":"raw","raw":"{\n \"values\": [\n {\n \"name\": \"Forecast-2020-Oct29\",\n \"bankId\": 16,\n \"accountId\": \"accountId1234\"\n },\n {\n \"name\": \"Forecast-2020-Oct30\",\n \"bankId\": 18,\n \"accountId\": \"accountId2345\"\n }\n ]\n}"},"url":"{{base_url}}/forecasting/v2/forecasts","description":"Create forecast
\nBefore the user can adjust their forecast, a new forecast id can be generated so balances and transactions that are adjusted by the user can be linked to the id.
\nWhen this forecast is retrieved by calling \"Get all forecasts\" endpoint, the source will be \"MANUALIMPORT\".
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| name | \nstring | \nName provided for the forecast | \n
\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n
\n
Transactions can be added to a particular forecast (forecastId) by calling the \"Add forecast transactions\" endpoint.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| forecastId | \nstring | \nUnique identifier for the forecast (that is being adjusted) | \n
\n\n| valueDate | \ndatetime | \nValue date for the transaction | \n
\n\n| currency | \nstring | \nTransaction currency | \n
\n\n| amount | \ninteger | \nTransaction amount | \n
\n\n| type | \nstring | \nTransaction type {DEBIT,CREDIT} | \n
\n\n| merchant | \nstring | \nName of the merchant | \n
\n\n| category | \nstring | \nName of the category | \n
\n\n
\n
Balances can be added to a particular forecast (forecastId) by calling the \"Add Forecast Balances\" endpoint.
\n Attributes
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| bankId | \ninteger | \nUnique identifier for the bank | \n
\n\n| accountId | \nstring | \nUnique identifier for the bank account | \n
\n\n| forecastId | \nstring | \nUnique identifier for the forecast (that is being adjusted) | \n
\n\n| date | \ndatetime | \nValue date for the balance | \n
\n\n| currency | \nstring | \nBalance currency | \n
\n\n| amount | \ninteger | \nBalance amount | \n
\n\n| type | \nstring | \nBalance type {DEBIT,CREDIT} | \n
\n\n
\n
Forecasted transactions can be updated by calling the \"Edit forecasted transaction\" endpoint.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| transactionId | \nstring | \nUnique identifier for the transaction | \n
\n\n
\n
Success
\n204 No Content","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240","id":"e55285f1-b329-40b0-972c-d3ae6d90d240","name":"Cashflow Forecast API","type":"folder"}},"urlObject":{"path":["forecasting","v2","transactions",":transactionId"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"f21c73c8-a2c7-4367-94c4-d6d3393f980b","description":{"content":"Unique identifier for the transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"41921e5e-94b4-43fd-ada7-5734ba5c2d34","name":"Edit Forecasted Transaction (by id)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"body":{"mode":"raw","raw":"{\n \"valueDate\": \"2021-07-30T03:59Z\",\n \"amount\": \"1500.00\",\n \"currency\": \"GBP\",\n \"type\": \"DEBIT\",\n \"merchant\": \"HMRC\",\n \"category\": \"Tax\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/forecasting/v2/transactions/:transactionId","host":["{{base_url}}"],"path":["forecasting","v2","transactions",":transactionId"],"variable":[{"key":"transactionId","value":"transactionId5678","description":"Unique identifier for the transaction"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 30 Oct 2020 19:58:50 GMT"},{"key":"x-amzn-RequestId","value":"555693ac-5235-4d43-89cc-8d33527d85bc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VPaDIGXUDoEFWig="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9c707a-291271ac63fcf5b0633fe257"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fe4c2207fc59dd7aa34d5b9c9e7bef06.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"A4zilLPtZ1x8Ym7JM29HaYbIqbFx62wMVZBGGb7XW5gGmmXiWi1kSA=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"64484949-3388-48e9-83b6-7169a9756717"},{"name":"Edit Forecasted Balance (by id)","id":"3afd7764-8851-447b-a312-3ea4a0c1d711","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Company-Id","value":"{{companyId}}"},{"key":"Authorization","value":"{{Authorization}}"}],"body":{"mode":"raw","raw":"{\n\"date\": \"2021-07-30T03:59Z\",\n\"amount\": \"12000.00\",\n\"currency\": \"GBP\",\n\"type\": \"CREDIT\"\n}"},"url":"{{base_url}}/forecasting/v2/balances/:balanceId","description":"Forecasted balance can be updated by calling the \"Edit forecasted balance\" endpoint.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| balanceId | \nstring | \nUnique identifier for the balance | \n
\n\n
\n
Success
\n204 No Content","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240","id":"e55285f1-b329-40b0-972c-d3ae6d90d240","name":"Cashflow Forecast API","type":"folder"}},"urlObject":{"path":["forecasting","v2","balances",":balanceId"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"8b0e6700-8408-4d5a-83d4-b8b60c2fb0e1","description":{"content":"Unique identifier for the balance
\n","type":"text/plain"},"type":"string","value":"","key":"balanceId"}]}},"response":[{"id":"ea707c44-027e-4a2e-a84a-555e70c6209c","name":"Edit Forecasted Balance (by id)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"X-Company-Id","value":"{{companyId}}"},{"key":"Authorization","value":"{{Authorization}}"}],"body":{"mode":"raw","raw":"{\n \"date\": \"2021-07-30T03:59Z\",\n \"amount\": \"12000.00\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/forecasting/v2/balances/:balanceId","host":["{{base_url}}"],"path":["forecasting","v2","balances",":balanceId"],"variable":[{"key":"balanceId","value":"balanceId4567","description":"Unique identifier for the balance"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 30 Oct 2020 20:14:41 GMT"},{"key":"x-amzn-RequestId","value":"3402f047-c2d1-4370-8195-dca3aacfc457"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VPcXtHX0DoEFuJg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9c7431-2c39ff8663df44bc22d50135"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fe4c2207fc59dd7aa34d5b9c9e7bef06.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"UBxZTARQYg-ziK6N9_2Bh759iZM7kDU743Ms4sYHdS8k5HWfi7gMlg=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3afd7764-8851-447b-a312-3ea4a0c1d711"},{"name":"Delete Forecasted Transaction (by id)","id":"b48c4e6e-46fc-495f-8dd2-a10c28621b20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/forecasting/v2/transactions/:transactionId","description":"Forecasted transactions can be deleted by calling the \"Delete forecasted transaction\" endpoint.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| transactionId | \nstring | \nUnique identifier for the transaction | \n
\n\n
\n
Success
\n202 Accepted","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240","id":"e55285f1-b329-40b0-972c-d3ae6d90d240","name":"Cashflow Forecast API","type":"folder"}},"urlObject":{"path":["forecasting","v2","transactions",":transactionId"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"Unique identifier for the bank transaction
\n","type":"text/plain"},"type":"string","value":"","key":"transactionId"}]}},"response":[{"id":"e7a468c3-f318-4466-b071-36e9cd721ce6","name":"Delete Forecasted Transaction (by id)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/forecasting/v2/transactions/:transactionId","host":["{{base_url}}"],"path":["forecasting","v2","transactions",":transactionId"],"variable":[{"key":"transactionId","value":"transactionId4567","description":"Unique identifier for the transaction"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 30 Oct 2020 20:12:31 GMT"},{"key":"x-amzn-RequestId","value":"47c001b6-fffe-4b17-ba30-8b057b0ccbf5"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VPcDZFjpDoEFWCQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9c73af-4184ef95741727d23a76ada1"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fe4c2207fc59dd7aa34d5b9c9e7bef06.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"c945iV8c6nCTeYEjntos6R4CXnM4zuzhqcB3MYT_ojZsM6Q6aLTqaw=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b48c4e6e-46fc-495f-8dd2-a10c28621b20"},{"name":"Delete Forecasted Balance (by id)","id":"07b74669-b535-4bdf-918f-2ace59187b62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/forecasting/v2/balances/:balanceId","description":"Forecasted balance can be deleted by calling the \"Delete forecasted balance\" endpoint.
\n Path variables
\n\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| balanceId | \nstring | \nUnique identifier for the balance | \n
\n\n
\n
Success
\n202 Accepted","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240","id":"e55285f1-b329-40b0-972c-d3ae6d90d240","name":"Cashflow Forecast API","type":"folder"}},"urlObject":{"path":["forecasting","v2","balances",":balanceId"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"Unique identifier for the balance
\n","type":"text/plain"},"type":"string","value":"","key":"balanceId"}]}},"response":[{"id":"8f02efb7-ef72-403c-be23-8f0b573e6731","name":"Delete Forecasted Balance (by id)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Partner-Id","value":"{{X-Partner-Id}}"},{"key":"X-Api-Key","value":"{{X-Api-Key}}"},{"key":"Authorization","value":"{{Authorization}}"},{"key":"X-Company-Id","value":"{{companyId}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/forecasting/v2/balances/:balanceId","host":["{{base_url}}"],"path":["forecasting","v2","balances",":balanceId"],"variable":[{"key":"balanceId","value":"balanceId4567","description":"Unique identifier for the balanace"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 30 Oct 2020 20:16:24 GMT"},{"key":"x-amzn-RequestId","value":"874116d5-3750-4776-a8f2-07117d093bce"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"VPcn3GgMjoEFxUQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f9c7498-463d59853d70c541624a9956"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fe4c2207fc59dd7aa34d5b9c9e7bef06.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR62-C4"},{"key":"X-Amz-Cf-Id","value":"1_-8BP1mamkm2IIN-O8RP235Sjr5RSAtT7VHfKX7v1q6I1Hb5yGWDg=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"07b74669-b535-4bdf-918f-2ace59187b62"}],"id":"5437f5a0-016e-47a8-add4-42c1851301f3","description":"The Cash Flow Forecasting API allows customers to adjust their forecast by adding, updating and/or deleting forecasted transactions and balances.
\nMultiple forecasts can be created and can enable scenario planning for the business.
\nEither an existing forecast can be adjusted by passing an existing forecast id or a new forecast can be created by first calling the \"Create Forecast\" endpoint.
\n","event":[{"listen":"prerequest","script":{"id":"643976a1-473b-4fc7-be2f-3a6e92c12224","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"06028dba-129e-47e8-9ee3-4583faf4e158","type":"text/javascript","exec":[""]}}],"_postman_id":"5437f5a0-016e-47a8-add4-42c1851301f3","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240","id":"e55285f1-b329-40b0-972c-d3ae6d90d240","name":"Cashflow Forecast API","type":"folder"}}}],"id":"e55285f1-b329-40b0-972c-d3ae6d90d240","description":"Cashflow Forecast API
\ntomato pay Cash Flow Forecasting API returns predicted transactions as well as balances so that a business’ cash flow can be calculated.
\nThe Cash Flow Forecasting API allows customers to adjust their forecast by adding, updating and/or deleting forecasted transactions and balances.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"fea89780-ff30-41ea-aca9-ac3455af6b88","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab153da2-019b-4cc0-b73f-43790f2a3029","type":"text/javascript","exec":[""]}}],"_postman_id":"e55285f1-b329-40b0-972c-d3ae6d90d240"}],"id":"418a753c-bb2c-47ee-af04-815fcffed3da","description":"APIs for our partners who use our multi-tenant platform to serve their customers using Open Banking
\n","_postman_id":"418a753c-bb2c-47ee-af04-815fcffed3da"},{"name":"Change Log","item":[],"id":"4cef3875-8418-423a-b376-2cfec7672371","description":"Jan 2022
\n\n- Document layout changed to incorporate Partner APIs and Merchant API subsections
\n
\nPartner Payment APIs
\n\n- Below listed Payment APIs were marked for decommissioning to make way to standardised web payment journey which incorporates fraud prevention measure. Guidance for migration will be provided soon
\n- Create Payment Consent
\n- Authorise Payment
\n- Retrieve Payment Consents
\n- Retrieve Payment Consent by id
\n
\n \n
\nMay 2021
\n\nBank Data API
\nUpdated Retrieve Banks endpoint
\n\n- Added logos in PNG format
\n- Added AIS status and PIS status
\n- Added rdfName field (bank name)
\n- logoUrl field has been removed
\n- Added type as a query parameter to filter banks that support AIS and/or payments
\n- Renamed pg to pageId
\n
\nUpdated Create Bank Consent endpoint
\n\n- Removed bankId from the path
\n- Added bankId to POST body
\n- Renamed 'permission' field to 'permissions'
\n- 'type' has been removed from the response
\n- Renamed 'signinUrl' to 'signInUrl'
\n
\nUpdated Retrieve Bank Consents endpoint
\n\n- Removed bankId from the path
\n- Added bankId as a query parameter
\n- Added status
\n- Renamed 'permission' field to 'permissions'
\n- Removed 'dateCreated' for consent
\n- Removed 'ConsentType'
\n
\nUpdated Retrieve Bank Consent (by id) endpoint
\n\n- Removed bankId from the path
\n- Added status
\n- Renamed 'permission' field to 'permissions'
\n- Removed 'dateCreated' for consent
\n- Removed 'ConsentType'
\n
\nUpdated Put Bank Consent (by id) endpoint
\n\n- Removed bankId from the path
\n- Added bankId to POST body
\n
\nUpdated Delete Bank Consent (by id) endpoint
\n\n- Removed bankId from the path
\n
\nUpdated Retrieve Bank Accounts endpoint
\n\n- Added consentId to the response for Open Banking accounts
\n
\nUpdated Retrieve Bank Account (by id) endpoint
\n\n- Added consentId to the response for Open Banking accounts
\n
\nAdded Retrieve Parties endpoint
\nPayments API
\nUpdated Create Payment Consent endpoint
\n\n- companyId is now a mandatory header
\n- Changed the endpoint to /banking/v2/pay/domestic/consents
\n- Added bankId to POST body
\n- Renamed paymentType to type
\n- Renamed authUrl to signInUrl
\n- Renamed consentStatus to status
\n
\nUpdated Authorise Payment Consent endpoint
\n\n- companyId is now a mandatory header
\n- Changed the endpoint to /banking/v2/pay/domestic/consents/:consentId
\n- Added bankId to POST body
\n- Renamed paymentId to ‘id’
\n- Added type (paymentType) to the response
\n- Renamed dateCreated to creationDate
\n- Added remittanceInfo to the response
\n- Added companyId to the response
\n- Renamed SchemeName to 'schemeName'
\n- Renamed Identification to identification
\n- Renamed Name to name
\n- Removed consentType
\n
\nUpdated Retrieve Payment Consents endpoint
\n\n- companyId is now a mandatory header
\n- Changed the endpoint to /banking/v2/pay/domestic/consents
\n- Renamed 'consentId' to ‘id’
\n- Added companyId to the response
\n- Renamed paymentType to type
\n
\nUpdated Retrieve Payment Consents (by id) endpoint
\n\n- companyId is now a mandatory header
\n- Changed the endpoint to /banking/v2/pay/domestic/consents/:consentId
\n- Renamed 'consentId' to ‘id’
\n- Added companyId to the response
\n- Renamed paymentType to type
\n
\nUpdated Retrieve Payment (by id) endpoint
\n\n- companyId is now a mandatory header
\n- Changed the endpoint to /banking/v2/pay/payments/:paymentId
\n- Added companyId to the response
\n- Renamed 'paymentId' to ‘id’
\n- Renamed date to creationDate
\n- Added remittanceInfo to the response
\n- Renamed paymentType to type
\n- Renamed SchemeName to 'schemeName'
\n- Renamed Identification to identification
\n- Renamed Name to name
\n
\nAdded Retrieve Payment endpoint
\nMarch 2021
\n\nForecast API
\nUpdated Forecast API endpoints
\nRemoved bankId from the app and added bankId to the body and response (wherever relevant).
\nNovember 2020
\n\nBank Data API
\nUpdated Retrieve Bank Accounts endpoint
\nUpdated Retrieve Bank Balances endpoint
\nUpdated Retrieve Bank Transactions endpoint
\nUpdated Create Consent endpoint Consent for retrieving specific data can now be requested
\nDeprecated \\banking\\v2\\banks\\:bankId\\accounts; use \\banking\\v2\\accounts endpoint instead
Deprecated \\banking\\v2\\banks\\:bankId\\balances; use \\banking\\v2\\balances endpoint instead
Deprecated \\banking\\v2\\banks\\:bankId\\transactions; use \\banking\\v2\\transactions endpoint instead
October 2020
\n\nCompany API
\nAdded Update Company endpoint
\nUpdated Create Company endpoint
\n\n\nUpdated Get Companies endpoint
Companies can be queried by External ID and/or CRN.
\n","_postman_id":"4cef3875-8418-423a-b376-2cfec7672371"}],"event":[{"listen":"prerequest","script":{"id":"92aa0971-e4d8-4986-8126-a49fa6454150","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"43add788-54d0-4631-a652-8da9436eaa51","type":"text/javascript","exec":[""]}}]}