{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:adatree-banking/accounts-get-cdr-arrangement-accounts":{"get":{"operationId":"finance_adatree_banking_accounts_get_cdr_arrangement_accounts","summary":"Get Accounts under cdr arrangement id","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"product-category","in":"query","required":false,"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…","schema":{"type":"string","enum":["BUSINESS_LOANS","CRED_AND_CHRG_CARDS","LEASES","MARGIN_LOANS","OVERDRAFTS","PERS_LOANS","REGULATED_TRUST_ACCOUNTS","RESIDENTIAL_MORTGAGES","TERM_DEPOSITS","TRADE_FINANCE","TRAVEL_CARDS","TRANS_AND_SAVINGS_ACCOUNTS"],"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…"}},{"name":"open-status","in":"query","required":false,"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed","schema":{"type":"string","enum":["OPEN","CLOSED","ALL"],"default":"ALL","description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed"}},{"name":"is-owned","in":"query","required":false,"description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…","schema":{"type":"boolean","description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/accounts-balances-get-filtered-balances":{"get":{"operationId":"finance_adatree_banking_accounts_balances_get_filtered_balances","summary":"Get Bulk Balances","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts/balances","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountIds","in":"query","required":false,"description":"Adatree's extension to support account ids for GET /accounts/balances","schema":{"type":"array","description":"Adatree's extension to support account ids for GET /accounts/balances"}},{"name":"product-category","in":"query","required":false,"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…","schema":{"type":"string","enum":["BUSINESS_LOANS","CRED_AND_CHRG_CARDS","LEASES","MARGIN_LOANS","OVERDRAFTS","PERS_LOANS","REGULATED_TRUST_ACCOUNTS","RESIDENTIAL_MORTGAGES","TERM_DEPOSITS","TRADE_FINANCE","TRAVEL_CARDS","TRANS_AND_SAVINGS_ACCOUNTS"],"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…"}},{"name":"open-status","in":"query","required":false,"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed","schema":{"type":"string","enum":["OPEN","CLOSED","ALL"],"default":"ALL","description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed"}},{"name":"is-owned","in":"query","required":false,"description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…","schema":{"type":"boolean","description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/accounts-balance-obtain-single-account-balance":{"get":{"operationId":"finance_adatree_banking_accounts_balance_obtain_single_account_balance","summary":"Get Account Balance","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts/{accountId}/balance","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountId","in":"query","required":true,"description":"A tokenised identifier for the account which is unique but not shareable","schema":{"type":"string","description":"A tokenised identifier for the account which is unique but not shareable"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/accounts-obtain-detail":{"get":{"operationId":"finance_adatree_banking_accounts_obtain_detail","summary":"Get Account Detail","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts/{accountId}","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountId","in":"query","required":true,"description":"A tokenised identifier for the account which is unique but not shareable","schema":{"type":"string","description":"A tokenised identifier for the account which is unique but not shareable"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/account-transactions-get-by-account-id-and-cdr-arrangement-i":{"get":{"operationId":"finance_adatree_banking_account_transactions_get_by_account_id_and_cdr_arrangement_i","summary":"Get Transactions For Account","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts/{accountId}/transactions","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountId","in":"query","required":true,"description":"ID of the account to get transactions for. Must have previously been returned by one of the account list end points.","schema":{"type":"string","description":"ID of the account to get transactions for. Must have previously been returned by one of the account list end points."}},{"name":"oldest-time","in":"query","required":false,"description":"Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to…","schema":{"type":"string","description":"Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to…"}},{"name":"newest-time","in":"query","required":false,"description":"Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today.…","schema":{"type":"string","description":"Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today.…"}},{"name":"min-amount","in":"query","required":false,"description":"Filter transactions to only transactions with amounts higher or equal to than this amount","schema":{"type":"string","description":"Filter transactions to only transactions with amounts higher or equal to than this amount"}},{"name":"max-amount","in":"query","required":false,"description":"Filter transactions to only transactions with amounts less than or equal to than this amount","schema":{"type":"string","description":"Filter transactions to only transactions with amounts less than or equal to than this amount"}},{"name":"text","in":"query","required":false,"description":"Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields.…","schema":{"type":"string","description":"Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields.…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/account-transactions-obtain-detail":{"get":{"operationId":"finance_adatree_banking_account_transactions_obtain_detail","summary":"Get Transaction Detail","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts/{accountId}/transactions/{transactionId}","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountId","in":"query","required":true,"description":"ID of the account to get transactions for. Must have previously been returned by one of the account list end points.","schema":{"type":"string","description":"ID of the account to get transactions for. Must have previously been returned by one of the account list end points."}},{"name":"transactionId","in":"query","required":true,"description":"ID of the transaction obtained from a previous call to one of the other transaction end points","schema":{"type":"string","description":"ID of the transaction obtained from a previous call to one of the other transaction end points"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/account-direct-debits-obtain-for-account":{"get":{"operationId":"finance_adatree_banking_account_direct_debits_obtain_for_account","summary":"Get Direct Debits For Account","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts/{accountId}/direct-debits","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountId","in":"query","required":true,"description":"ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points.","schema":{"type":"string","description":"ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points."}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/accounts-direct-debits-get-bulk-direct-debits":{"get":{"operationId":"finance_adatree_banking_accounts_direct_debits_get_bulk_direct_debits","summary":"Get Bulk Direct Debits","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts/direct-debits","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountIds","in":"query","required":false,"description":"Adatree's extension to support account ids for GET /accounts/balances","schema":{"type":"array","description":"Adatree's extension to support account ids for GET /accounts/balances"}},{"name":"product-category","in":"query","required":false,"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…","schema":{"type":"string","enum":["BUSINESS_LOANS","CRED_AND_CHRG_CARDS","LEASES","MARGIN_LOANS","OVERDRAFTS","PERS_LOANS","REGULATED_TRUST_ACCOUNTS","RESIDENTIAL_MORTGAGES","TERM_DEPOSITS","TRADE_FINANCE","TRAVEL_CARDS","TRANS_AND_SAVINGS_ACCOUNTS"],"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…"}},{"name":"open-status","in":"query","required":false,"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed","schema":{"type":"string","enum":["OPEN","CLOSED","ALL"],"default":"ALL","description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed"}},{"name":"is-owned","in":"query","required":false,"description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…","schema":{"type":"boolean","description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/account-payments-scheduled-get-scheduled-payments":{"get":{"operationId":"finance_adatree_banking_account_payments_scheduled_get_scheduled_payments","summary":"Get Scheduled Payments for Account","description":"GET /adr/banking/arrangements/{cdrArrangementId}/accounts/{accountId}/payments/scheduled","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountId","in":"query","required":true,"description":"ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account…","schema":{"type":"string","description":"ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/payments-scheduled-bulk-get":{"get":{"operationId":"finance_adatree_banking_payments_scheduled_bulk_get","summary":"Get Scheduled Payments Bulk","description":"GET /adr/banking/arrangements/{cdrArrangementId}/payments/scheduled","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"accountIds","in":"query","required":false,"description":"Adatree's extension to support account ids for GET /accounts/balances","schema":{"type":"array","description":"Adatree's extension to support account ids for GET /accounts/balances"}},{"name":"product-category","in":"query","required":false,"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…","schema":{"type":"string","enum":["BUSINESS_LOANS","CRED_AND_CHRG_CARDS","LEASES","MARGIN_LOANS","OVERDRAFTS","PERS_LOANS","REGULATED_TRUST_ACCOUNTS","RESIDENTIAL_MORTGAGES","TERM_DEPOSITS","TRADE_FINANCE","TRAVEL_CARDS","TRANS_AND_SAVINGS_ACCOUNTS"],"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…"}},{"name":"open-status","in":"query","required":false,"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed","schema":{"type":"string","enum":["OPEN","CLOSED","ALL"],"default":"ALL","description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed"}},{"name":"is-owned","in":"query","required":false,"description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…","schema":{"type":"boolean","description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/payees-get-list":{"get":{"operationId":"finance_adatree_banking_payees_get_list","summary":"Get Payees","description":"GET /adr/banking/arrangements/{cdrArrangementId}/payees","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"type","in":"query","required":false,"description":"Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the…","schema":{"type":"string","enum":["BILLER","DOMESTIC","INTERNATIONAL","ALL"],"default":"ALL","description":"Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/payees-get-detail":{"get":{"operationId":"finance_adatree_banking_payees_get_detail","summary":"Get Payee Detail","description":"GET /adr/banking/arrangements/{cdrArrangementId}/payees/{payeeId}","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"payeeId","in":"query","required":true,"description":"The ID used to locate the details of a particular payee","schema":{"type":"string","description":"The ID used to locate the details of a particular payee"}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/user-info-get-by-arrangement-id":{"get":{"operationId":"finance_adatree_banking_user_info_get_by_arrangement_id","summary":"Get user info under cdr arrangement id","description":"GET /adr/common/arrangements/{cdrArrangementId}/userinfo","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/customers-get-customer-info":{"get":{"operationId":"finance_adatree_banking_customers_get_customer_info","summary":"Get Customer","description":"GET /adr/common/arrangements/{cdrArrangementId}/customer","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/customers-obtain-detailed-info":{"get":{"operationId":"finance_adatree_banking_customers_obtain_detailed_info","summary":"Get Customer Detail","description":"GET /adr/common/arrangements/{cdrArrangementId}/customer/detail","tags":["finance"],"parameters":[{"name":"cdrArrangementId","in":"query","required":true,"description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data.","schema":{"type":"string","description":"Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data."}},{"name":"x-fapi-auth-date","in":"query","required":false,"description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…","schema":{"type":"string","description":"The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is…"}},{"name":"x-fapi-customer-ip-address","in":"query","required":false,"description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…","schema":{"type":"string","description":"The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates…"}},{"name":"x-cds-client-headers","in":"query","required":false,"description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…","schema":{"type":"string","description":"The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/data-holder-discovery-get-status":{"get":{"operationId":"finance_adatree_banking_data_holder_discovery_get_status","summary":"Get Status","description":"GET /adr/discovery/status","tags":["finance"],"parameters":[{"name":"data-holder-ids","in":"query","required":false,"description":"Array of strings used to identify the data holder from which to fetch the product/outage/status data.","schema":{"type":"array","description":"Array of strings used to identify the data holder from which to fetch the product/outage/status data."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:adatree-banking/data-holder-discovery-get-outages":{"get":{"operationId":"finance_adatree_banking_data_holder_discovery_get_outages","summary":"Get Outages","description":"GET /adr/discovery/outages","tags":["finance"],"parameters":[{"name":"data-holder-ids","in":"query","required":false,"description":"Array of strings used to identify the data holder from which to fetch the product/outage/status data.","schema":{"type":"array","description":"Array of strings used to identify the data holder from which to fetch the product/outage/status data."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}