{"openapi":"3.0.3","info":{"version":"1.0.0","title":"Data API v1","description":"One API to access account information from banks all over the world.\n"},"servers":[{"url":"https://api.truelayer.com/data/v1"},{"url":"https://api.truelayer-sandbox.com/data/v1"}],"security":[{"oauth2":[]}],"tags":[{"name":"Meta","description":"Meta data about the account connection"},{"name":"Accounts","description":"Account information"},{"name":"Cards","description":"Credit cards information"},{"name":"Batch","description":"Lots of data in one call"},{"name":"Connection Management","description":"Connection management"}],"paths":{"/me":{"get":{"tags":["Meta"],"summary":"Connection metadata","description":"Data about the access token and account connection.","operationId":"GetMe","parameters":[{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Me"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"meExample":{"$ref":"#/components/examples/GetMe200Response"}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/info":{"get":{"tags":["Meta"],"summary":"User info","description":"Data about the end user. Almost all providers only populate the `full_name` field. We do not recommend relying on any of the other fields for your application.","operationId":"GetInfo","security":[{"oauth2":["info"]}],"parameters":[{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Info"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"infoTypicalExample":{"$ref":"#/components/examples/GetInfoTypical200Response"},"infoAllFieldsExample":{"$ref":"#/components/examples/GetInfoAllFields200Response"}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/accounts":{"get":{"tags":["Accounts"],"summary":"Get accounts","description":"List all accounts","operationId":"GetAccounts","security":[{"oauth2":["accounts"]}],"parameters":[{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"accountsExample":{"$ref":"#/components/examples/GetAccounts200Response"},"accountsAUExample":{"$ref":"#/components/examples/GetAccountsAU200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/accounts/{account_id}":{"get":{"tags":["Accounts"],"summary":"Get account","description":"Get a specific account","operationId":"GetAccount","security":[{"oauth2":["accounts"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"accountExample":{"$ref":"#/components/examples/GetAccount200Response"},"accountAUExample":{"$ref":"#/components/examples/GetAccountAU200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/accounts/{account_id}/balance":{"get":{"tags":["Accounts"],"summary":"Get account balance","description":"Get balance for specified account","operationId":"GetAccountBalance","security":[{"oauth2":["accounts","balance"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountBalance"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"balanceExample":{"$ref":"#/components/examples/GetAccountBalance200Response"},"balanceAUExample":{"$ref":"#/components/examples/GetAccountBalanceAU200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/accounts/{account_id}/transactions":{"get":{"tags":["Accounts"],"summary":"Get account transactions","description":"Get all settled transactions for an account","operationId":"GetAccountTransactions","security":[{"oauth2":["accounts","transactions"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountTransaction"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"accountTransactionsExample":{"$ref":"#/components/examples/GetAccountTransactions200Response"},"accountTransactionsAUExample":{"$ref":"#/components/examples/GetAccountTransactionsAU200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/accounts/{account_id}/transactions/pending":{"get":{"tags":["Accounts"],"summary":"Get account pending transactions","description":"Get all pending transactions for an account","operationId":"GetAccountPendingTransactions","security":[{"oauth2":["accounts","transactions"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountTransaction"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"accountPendingTransactionsExample":{"$ref":"#/components/examples/GetAccountTransactions200Response"},"accountPendingTransactionsAUExample":{"$ref":"#/components/examples/GetAccountTransactionsAU200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/accounts/{account_id}/standing_orders":{"get":{"tags":["Accounts"],"summary":"Get standing orders","description":"Get standing orders for specified account","operationId":"GetAccountStandingOrders","security":[{"oauth2":["accounts","standing_orders"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountStandingOrder"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"directDebitsExample":{"$ref":"#/components/examples/GetAccountStandingOrders200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/accounts/{account_id}/direct_debits":{"get":{"tags":["Accounts"],"summary":"Get direct debits","description":"Get direct debits for specified account","operationId":"GetAccountDirectDebits","security":[{"oauth2":["accounts","direct_debits"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountDirectDebit"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"directDebitsExample":{"$ref":"#/components/examples/GetAccountDirectDebits200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/cards":{"get":{"tags":["Cards"],"summary":"Get cards","description":"List all cards","operationId":"GetCards","security":[{"oauth2":["cards"]}],"parameters":[{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Card"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"cardExample":{"$ref":"#/components/examples/GetCards200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/cards/{account_id}":{"get":{"tags":["Cards"],"summary":"Get card","description":"Get a specific card","operationId":"GetCard","security":[{"oauth2":["cards"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Card"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"cardExample":{"$ref":"#/components/examples/GetCard200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/cards/{account_id}/balance":{"get":{"tags":["Cards"],"summary":"Get card balance","description":"Get balance for specified card","operationId":"GetCardBalance","security":[{"oauth2":["cards","balance"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/CardBalance"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"balanceExample":{"$ref":"#/components/examples/GetCardBalance200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/cards/{account_id}/transactions":{"get":{"tags":["Cards"],"summary":"Get card transactions","description":"Get all settled transactions for a card","operationId":"GetCardTransactions","security":[{"oauth2":["cards","transactions"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/CardTransaction"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"cardTransactionsExample":{"$ref":"#/components/examples/GetCardTransactions200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/cards/{account_id}/transactions/pending":{"get":{"tags":["Cards"],"summary":"Get card pending transactions","description":"Get all pending transactions for a card","operationId":"GetCardPendingTransactions","security":[{"oauth2":["cards","transactions"]}],"parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/async"},{"$ref":"#/components/parameters/webhook_uri"}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/CardTransaction"}},"status":{"$ref":"#/components/schemas/ResponseStatus"}}},"examples":{"cardTransactionsExample":{"$ref":"#/components/examples/GetCardTransactions200Response"}}}}},"202":{"$ref":"#/components/responses/202"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/batch/transactions":{"post":{"tags":["Batch"],"summary":"Initiate batch call","description":"Initiate collection of data for multiple cards and accounts in one call","operationId":"GetBatch","security":[{"oauth2":["accounts"]}],"parameters":[{"$ref":"#/components/parameters/X-Client-Correlation-Id"},{"$ref":"#/components/parameters/X-PSU-IP"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRequest"}}}},"callbacks":{"batchSuccess":{"$ref":"#/components/callbacks/batchSuccess"}},"responses":{"202":{"$ref":"#/components/responses/202"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"501":{"$ref":"#/components/responses/501"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/batch/results":{"get":{"tags":["Batch"],"summary":"Get data in batch","description":"Get data for multiple cards and accounts following a successful batch call","operationId":"GetBatchResults","security":[{"oauth2":["accounts"]}],"responses":{"200":{"description":"OK","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResults"},"examples":{"200Example":{"$ref":"#/components/examples/BatchResults200Response"}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"},"504":{"$ref":"#/components/responses/504"}}}},"/connections/extend":{"servers":[{"url":"https://api.truelayer.com"},{"url":"https://api.truelayer-sandbox.com"}],"post":{"tags":["Connection Management"],"summary":"Extend a connection","description":"Starts a process to extend a connection, by reconfirming consent and starting a new authentication if necessary.\nYou can find out more on how to use this endpoint [here](https://docs.truelayer.com/docs/connections).\n","operationId":"ExtendConnection","parameters":[{"$ref":"#/components/parameters/X-Client-Correlation-Id"}],"servers":[{"url":"https://api.truelayer.com"},{"url":"https://api.truelayer-sandbox.com"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendConnectionRequest"}}}},"responses":{"200":{"description":"Extend response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendResponse"},"examples":{"noFurtherActionExample":{"$ref":"#/components/examples/noFurtherActionExample"},"goToAuthDialogExample":{"$ref":"#/components/examples/goToAuthDialogExample"},"reauthRequiredExample":{"$ref":"#/components/examples/reauthRequiredExample"}}}}},"400":{"description":"Validation error response","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"},"examples":{"validationErrorExample":{"$ref":"#/components/examples/validationErrorExample"}}}}},"401":{"description":"Unauthorised","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"},"examples":{"validationErrorExample":{"$ref":"#/components/examples/unauthorisedErrorExample"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"},"examples":{"validationErrorExample":{"$ref":"#/components/examples/unprocessableEntityErrorExample"}}}}}},"security":[{"oauth2":[]}]}}},"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.truelayer.com/token/connect","tokenUrl":"https://auth.truelayer.com/token/connect","scopes":{"info":"read access for full_name of account holder","accounts":"read access for current and savings account data","cards":"read access for credit card account data","balance":"read access for balance data. This must be combined with at least one of `cards` or `accounts`","transactions":"read access for transaction data. This must be combined with at least one of `cards` or `accounts`","direct_debits":"read access for direct debit data. This must be combined with `accounts`","standing_orders":"read access for standing order data. This must be combined with `accounts`","offline_access":"enables read access for 90 days after end user grants authorization"}}}}},"parameters":{"X-Client-Correlation-Id":{"name":"X-Client-Correlation-Id","description":"Client-specified ID used to debug requests","in":"header","schema":{"type":"string"}},"X-PSU-IP":{"name":"X-PSU-IP","description":"IP address of the end user requesting data. Necessary to overcome 4 calls per day rate limits","in":"header","schema":{"type":"string"}},"async":{"name":"async","description":"When set to true, data is fetched asynchronously. Expect 202 status code","in":"query","schema":{"type":"string","enum":["true"]}},"webhook_uri":{"name":"webhook_uri","description":"When async is set to true, a webhook will be POSTed to the URI provided","in":"query","schema":{"type":"string","format":"uri"}},"accountId":{"name":"account_id","description":"unique ID for an account or card","in":"path","required":true,"schema":{"type":"string","example":"f1234560abf9f57287637624def390871"}},"to":{"name":"to","description":"The date to retrieve transactions until in the format `YYYY-MM-DD`. The results include transactions from this date.","in":"query","schema":{"type":"string","format":"datetime"}},"from":{"name":"from","description":"The date to retrieve transactions from in the format `YYYY-MM-DD`. The results include transactions from this date.","in":"query","schema":{"type":"string","format":"datetime"}}},"headers":{"X-TL-Correlation-Id":{"description":"Unique Id per request - we recommend logging this and always sharing it with our client-care team when opening incident tickets","schema":{"type":"string"}},"X-Credentials-Id":{"description":"Uniquely identifies a connection between the client and a users account(s)","schema":{"type":"string"}},"X-Request-Id":{"deprecated":true,"description":"Not recommended: `X-TL-Correlation-Id` should be used instead","schema":{"type":"string"}},"Cache-Control":{"description":"`max-age=n` where n number of seconds","schema":{"type":"string"}},"Content-Encoding":{"schema":{"type":"string","enum":["gzip"]}},"Content-Type":{"schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"Date":{"description":"Date and time the message was sent","schema":{"type":"string","format":"date-time"}},"Last-Modified":{"description":"The date and time a resource was last modified","schema":{"type":"string","format":"date-time"}},"Content-Security-Policy":{"schema":{"type":"string","enum":["default-src 'none'; frame-ancestors 'none';"]}},"X-Content-Type-Options":{"schema":{"type":"string","enum":["nosniff"]}},"X-Frame-Options":{"schema":{"type":"string","enum":["deny"]}},"X-XSS-Protection":{"schema":{"type":"string","enum":["1; mode=block"]}},"Referrer-Policy":{"schema":{"type":"string","enum":["no-referrer"]}}},"schemas":{"Me":{"type":"object","properties":{"client_id":{"type":"string"},"credentials_id":{"type":"string"},"consent_status":{"type":"string"},"consent_status_updated_at":{"type":"string"},"consent_created_at":{"type":"string"},"consent_expires_at":{"type":"string"},"provider":{"type":"object","properties":{"display_name":{"type":"string"},"logo_uri":{"type":"string"},"provider_id":{"type":"string"}}},"scopes":{"type":"array","items":{"type":"string","enum":["info","accounts","balance","transactions","cards","offline_access"]}},"privacy_policy":{"type":"string"}}},"ResponseStatus":{"type":"string","description":"Indicates whether the request was successful. 'Queued', 'Running' and 'Failed' can be returned for async requests","example":"Succeeded","enum":["Succeeded","Queued","Running","Failed"]},"Error":{"type":"object","properties":{"error":{"type":"string"},"error_description":{"type":"string"},"error_details":{"type":"object"}}},"Info":{"type":"object","properties":{"full_name":{"type":"string"},"branch_id":{"type":"string"},"emails":{"description":"⚠️ This field is very rarely populated by providers","type":"array","items":{"type":"string","format":"email"}},"phones":{"description":"⚠️ This field is very rarely populated by providers","type":"array","items":{"type":"string"}},"update_timestamp":{"type":"string"}}},"UpdateTimestamp":{"type":"string","format":"datetime","description":"Last update time of the data"},"AccountId":{"type":"string","description":"Unique identifier of the account","example":"f1234560abf9f57287637624def390871"},"AccountType":{"type":"string","description":"Distinguish between personal and business, as well as savings and current accounts.","enum":["TRANSACTION","SAVINGS","BUSINESS_TRANSACTION","BUSINESS_SAVINGS"]},"Currency":{"type":"string","description":"Currency used for this account or transaction","enum":["EUR","GBP","USD","AUD"]},"Account":{"type":"object","required":["update_timestamp","display_name","account_number","provider","currency"],"properties":{"update_timestamp":{"$ref":"#/components/schemas/UpdateTimestamp"},"account_id":{"$ref":"#/components/schemas/AccountId"},"account_type":{"$ref":"#/components/schemas/AccountType"},"display_name":{"type":"string","description":"Human-readable name of the account"},"currency":{"$ref":"#/components/schemas/Currency"},"account_number":{"type":"object","properties":{"number":{"type":"string","description":"Only returned for UK accounts"},"sort_code":{"type":"string","description":"Only returned for UK accounts"},"swift_bic":{"type":"string","description":"ISO 9362:2009 Business Identifier Codes. If swift_bic is not supported, one of the below values will be returned: `NOT_SUPPORTED_BY_GEO` or `NOT_SUPPORTED_BY_PROVIDER`"},"iban":{"type":"string","description":"ISO 13616-1:2007 international bank number"},"routing_number":{"type":"string","description":"Routing transit number. Only returned for US accounts"},"bsb":{"type":"string","description":"BSB (Bank State Branch) number of the account. Only returned for AU accounts"}}},"provider":{"type":"object","properties":{"provider_id":{"type":"string","description":"Unique identifier for the provider"},"logo_uri":{"type":"string","deprecated":true,"description":"Use the providers endpoint for accurate provider data"},"display_name":{"type":"string","deprecated":true,"description":"Use the providers endpoint for accurate provider data"}}}}},"AsyncResponse":{"type":"object","properties":{"results_uri":{"type":"string","format":"uri"},"status":{"$ref":"#/components/schemas/ResponseStatus"},"task_id":{"type":"string"}}},"AccountBalance":{"type":"object","required":["currency","current"],"properties":{"currency":{"$ref":"#/components/schemas/Currency"},"available":{"type":"number","description":"The amount of funds available to the account holder. This takes into account any pending transactions and includes any overdraft facility."},"current":{"type":"number","description":"The amount of funds within the account. This does not include any pending transactions."},"overdraft":{"type":"number","description":"Pre-arranged overdraft limit. Available for all “TRANSACTION” and “BUSINESS_TRANSACTION” account types."},"update_timestamp":{"$ref":"#/components/schemas/UpdateTimestamp"}}},"TransactionAmount":{"type":"number","description":"The transaction value."},"TransactionCategory":{"type":"string","description":"`ATM`:\tDeposit or withdrawal of funds using an ATM (Automated Teller Machine)<br/> `BILL_PAYMENT`:\tPayment of a bill<br/> `CASH`:\tCash deposited over the branch counter or using a Cash & Deposit Machines<br/> `CASHBACK`:\tAn option retailers offer to withdraw cash while making a debit card purchase<br/> `CHEQUE`:\tA document ordering the payment of money from a bank account to another person or organization<br/> `CORRECTION`:\tCorrection of a transaction error<br/> `CREDIT`:\tFunds added to your account<br/> `DIRECT_DEBIT`:\tAn automatic withdrawal of funds initiated by a third party at regular intervals<br/> `DIVIDEND`:\tA payment to your account from shares you hold<br/> `FEE_CHARGE`:\tFees or charges in relation to a transaction<br/> `INTEREST`:\tCredit or debit associated with interest earned or incurred<br/> `OTHER`:\tMiscellaneous credit or debit<br/> `PURCHASE`:\tA payment made with your debit or credit card<br/> `STANDING_ORDER`:\tA payment instructed by the account-holder to a third party at regular intervals<br/> `TRANSFER`:\tTransfer of money between accounts<br/> `DEBIT`:\tFunds taken out from your account, uncategorised by the bank<br/> `UNKNOWN`:\tNo classification of transaction category known","enum":["ATM","BILL_PAYMENT","CASH","CASHBACK","CHEQUE","CORRECTION","CREDIT","DIRECT_DEBIT","DIVIDEND","FEE_CHARGE","INTEREST","OTHER","PURCHASE","STANDING_ORDER","TRANSFER","DEBIT","UNKNOWN"]},"TransactionClassification":{"type":"array","description":"The classification and sub-classification of the transaction.","items":{"type":"string","maxItems":2}},"AccountTransactionMeta":{"type":"object","properties":{"bank_transaction_id":{"type":"string","deprecated":true,"description":"This field is deprecated. Please use the top level provider_transaction_id."},"provider_transaction_category":{"type":"string"},"provider_reference":{"type":"string"},"provider_merchant_name":{"type":"string"},"provider_category":{"type":"string"},"address":{"type":"string"},"provider_id":{"type":"string"},"counter_party_preferred_name":{"type":"string"},"counter_party_iban":{"type":"string"},"user_comments":{"type":"string","description":"Revolut only."},"debtor_account_name":{"type":"string","description":"Monzo only."},"transaction_type":{"type":"string","description":"Amex only."},"provider_transaction_id":{"type":"string","deprecated":true,"description":"Starling only. This field is deprecated. Please use the top level provider_transaction_id."},"provider_source":{"type":"string","description":"Starling only."}}},"AccountTransaction":{"type":"object","required":["transaction_id","timestamp","currency","amount","description","transaction_type","transaction_category","transaction_classification"],"properties":{"transaction_id":{"type":"string","description":"TrueLayer's identifier of the transaction in a request. It may change between requests."},"normalised_provider_transaction_id":{"type":"string","description":"TrueLayer's recommended identifier of the transaction in a request. It will not change between requests."},"provider_transaction_id":{"type":"string","description":"Provider's identifier of the transaction in a request. The format of this string will vary across providers."},"timestamp":{"type":"string","format":"datetime","description":"Date the transaction was posted on the account."},"description":{"type":"string","description":"Original description of the transaction as reported by the provider."},"amount":{"$ref":"#/components/schemas/TransactionAmount"},"currency":{"$ref":"#/components/schemas/Currency"},"transaction_type":{"type":"string","description":"Type of the transaction.","enum":["DEBIT","CREDIT"]},"transaction_category":{"$ref":"#/components/schemas/TransactionCategory"},"transaction_classification":{"$ref":"#/components/schemas/TransactionClassification"},"merchant_name":{"type":"string","description":"The merchant name identified in the transaction description."},"running_balance":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/TransactionAmount"},"currency":{"$ref":"#/components/schemas/Currency"}}},"meta":{"$ref":"#/components/schemas/AccountTransactionMeta"}}},"AccountStandingOrder":{"type":"object","required":["frequency","timestamp"],"properties":{"frequency":{"type":"string","description":"Frequency of the standing order. Possible values:<br/> `EvryDay` - every day<br/> `EvryWorkgDay` - every working day<br/> `IntrvlDay:XX` - every XX calendar day<br/> `IntrvlMnthDay:XX:YY` - every XXth month on the YYth day of the month<br/> `IntrvlWkDay:XX:YY` - every XXth week, on the YYth day of the week<br/> `QtrDay` - quarterly `WkInMnthDay:XX:YY` - every month, on the XXth week of the month and on the YYth day of the week."},"status":{"type":"string","enum":["Active","Inactive"]},"timestamp":{"type":"string","description":"Date and time the request was made."},"currency":{"$ref":"#/components/schemas/Currency"},"meta":{"type":"object","properties":{"provider_account_id":{"type":"string"}}},"next_payment_date":{"type":"string","format":"datetime","description":"The date on which the next payment for the standing order schedule will be made."},"next_payment_amount":{"type":"string","description":"Amount of the next payment for the standing order"},"first_payment_date":{"type":"string","format":"datetime","description":"The date on which the first payment for the standing order schedule will be or was made."},"first_payment_amount":{"type":"string","description":"Amount of the first payment for the standing order."},"final_payment_date":{"type":"string","format":"datetime","description":"The date on which the next payment for a Standing Order schedule will be made."},"final_payment_amount":{"type":"string","description":"Amount of the last payment for the standing order."},"payee":{"type":"string","description":"Payee of the standing order set by the user."},"reference":{"type":"string","description":"Reference of the standing order set by the user."}}},"AccountDirectDebit":{"type":"object","required":["direct_debit_id","timestamp","name","meta"],"properties":{"direct_debit_id":{"type":"string","description":"Unique identifier of the direct debit in a request. It may change between requests."},"timestamp":{"type":"string","format":"datetime","description":"Date and time the request was made"},"name":{"type":"string","description":"This is the name of merchant collecting funds via the direct debit. This is often a brand the end user would recognise eg. their utilities provider."},"status":{"type":"string","description":"Possible values are `Active` and `Inactive`","enum":["Active","Inactive"]},"previous_payment_timestamp":{"type":"string","format":"datetime","description":"Date of the latest payment"},"previous_payment_amount":{"type":"number","description":"Amount of the latest payment"},"currency":{"$ref":"#/components/schemas/Currency"},"meta":{"type":"object","required":["provider_mandate_identification","provider_account_id"],"properties":{"provider_mandate_identification":{"type":"string","description":"This is the direct debit reference. For AUDDIS (Automated Direct Debit Instruction Service), the merchant provides Core Reference. For non AUDDIS merchants provide Core reference if possible or last used reference"},"provider_account_id":{"type":"string","description":"An account id set by the provider. It is unique and immutable identifier used to identify the account resource. This identifier has no meaning to the user."},"provider_direct_debit_id":{"type":"string","description":"This is a unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the user and it is not always provided"}}}}},"Card":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/AccountId"},"card_network":{"type":"string"},"card_type":{"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"display_name":{"type":"string"},"partial_card_number":{"type":"string"},"name_on_card":{"type":"string"},"valid_from":{"type":"string"},"valid_to":{"type":"string"},"update_timestamp":{"type":"string"},"provider":{"type":"object","properties":{"provider_id":{"type":"string"}}}}},"CardBalance":{"type":"object","required":["current"],"properties":{"available":{"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"current":{"type":"number"},"credit_limit":{"type":"number"},"last_statement_balance":{"type":"number"},"last_statement_date":{"type":"string","format":"datetime"},"payment_due":{"type":"number"},"payment_due_date":{"type":"string","format":"datetime"},"update_timestamp":{"type":"string","format":"datetime"}}},"CardTransaction":{"allOf":[{"$ref":"#/components/schemas/AccountTransaction"},{"type":"object","properties":{"meta":{"type":"object","properties":{"provider_transaction_category":{"type":"string"},"cardNumber":{"type":"string"},"location":{"type":"string"}}}}}]},"BatchRequest":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"pending":{"description":"set to true to include pending transactions in response","type":"boolean"},"balance":{"description":"set to true to include balances in response","type":"boolean"},"webhook_uri":{"description":"a webhook will be POSTed to the URI if provided","type":"string","format":"uri"},"account_ids_whitelist":{"description":"if included, only accounts matching the provided IDs will be included in response","type":"array"}}},"BatchResults":{"type":"object","required":["status","task_id","request","results"],"properties":{"status":{"$ref":"#/components/schemas/ResponseStatus"},"task_id":{"description":"A unique ID associated with the task","type":"string"},"request":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"results":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/AccountId"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/AccountTransaction"}},"pending_transactions":{"type":"array","items":{"$ref":"#/components/schemas/AccountTransaction"}},"balance":{"$ref":"#/components/schemas/AccountBalance"}}}},"cards":{"type":"array","items":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/AccountId"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/CardTransaction"}},"pending_transactions":{"type":"array","items":{"$ref":"#/components/schemas/CardTransaction"}},"balance":{"$ref":"#/components/schemas/CardBalance"}}}}}}}},"client_id":{"type":"string","description":"Your application's client id, found in TrueLayer Console","example":"budgetapp-b4c334"},"new_user":{"type":"object","description":"Details of the end user who is connecting to their provider.","properties":{"id":{"type":"string","description":"Unique ID for the user"},"name":{"type":"string","description":"If the client is not regulated, they must provide this value.","example":"Alan Turing"},"email":{"type":"string","format":"email","description":"If the client is not regulated, they must provide one of `email`/`phone`.","example":"alan@example.org"},"phone":{"type":"string","format":"phone_number","description":"If the client is not regulated, they must provide one of `email`/`phone`.","example":"+437777777777"}}},"ExtendConnectionRequest":{"type":"object","required":["user_has_reconfirmed_consent","client_id","client_secret","user","refresh_token","redirect_uri"],"properties":{"user_has_reconfirmed_consent":{"type":"boolean","description":"Set to `true` if the user has re-confirmed consent in your application. We must review your consent screen and enable your client_id before you can set this field to `true` in production.\n\nSet to `false` if you'd like the user to re-confirm consent in TrueLayer's auth dialog (setting to `false` is currently not supported).\n"},"client_id":{"$ref":"#/components/schemas/client_id"},"client_secret":{"type":"string","description":"Your application's client secret, found in TrueLayer Console"},"user":{"$ref":"#/components/schemas/new_user"},"refresh_token":{"type":"string","description":"refresh_token for the connection you want to extend"},"redirect_uri":{"type":"string","format":"uri","description":"A valid redirect_uri for your TrueLayer client_id (set in your Console)"},"state":{"type":"string","description":"An opaque value used by the client to maintain state between the request and callback"},"code_challenge":{"type":"string","description":"PKCE code challenge"},"response_mode":{"type":"string","description":"If set to \"form_post\", when we call your redirect_uri, we'll include the `code` in a form POST request. If left unset, we'll make a GET request with the code set as a query parameter","enum":["form_post"]}}},"NoActionNeeded":{"type":"object","required":["action_needed","access_token","expires_in","token_type","refresh_token"],"properties":{"action_needed":{"type":"string","enum":["no_action_needed"]},"access_token":{"type":"string","description":"A short-lived JWT token used to access data on behalf of the End user"},"expires_in":{"type":"integer","description":"`access_token` validity in seconds. Default is 1 hour or specified by provider whichever is lower."},"refresh_token":{"type":"string","description":"A long-lived code used to obtain a new `access_token` when expired."},"token_type":{"type":"string","description":"Type of token returned. Must be `Bearer`"}}},"AuthenticationNeeded":{"type":"object","required":["action_needed","user_input_link"],"properties":{"action_needed":{"type":"string","enum":["authentication_needed"]},"user_input_link":{"type":"string","format":"uri","description":"A link to direct the end user to confirm additional information. This could be a direct link to a bank authentication, or to TrueLayer if consent has not been re-confirmed."}}},"ReconfirmationOfConsentNeeded":{"type":"object","required":["action_needed","user_input_link"],"properties":{"action_needed":{"type":"string","enum":["reconfirmation_of_consent_needed"]},"user_input_link":{"type":"string","format":"uri","description":"A link to direct the end user to confirm additional information. This could be a direct link to a bank authentication, or to TrueLayer if consent has not been re-confirmed."}}},"ExtendResponse":{"oneOf":[{"$ref":"#/components/schemas/NoActionNeeded"},{"$ref":"#/components/schemas/AuthenticationNeeded"},{"$ref":"#/components/schemas/ReconfirmationOfConsentNeeded"}],"discriminator":{"propertyName":"action_needed","mapping":{"no_action_needed":"#/components/schemas/NoActionNeeded","authentication_needed":"#/components/schemas/AuthenticationNeeded","reconfirmation_of_consent_needed":"#/components/schemas/ReconfirmationOfConsentNeeded"}}},"Problem":{"type":"object","title":"ApiErrorResponse","required":["title","type","status","trace_id"],"properties":{"type":{"description":"Link that describes http status codes","type":"string"},"title":{"description":"Title of the error","type":"string"},"status":{"description":"HTTP status code of the response","type":"integer"},"detail":{"description":"More verbose explanation of the error.\n","type":"string"},"instance":{"description":"The endpoint from where the error occured.\n","type":"string"},"trace_id":{"description":"A unique GUID for the request.","type":"string"},"errors":{"description":"Errors","type":"array","items":{}}}}},"examples":{"GetMe200Response":{"summary":"Me example payload","value":{"results":[{"client_id":"test","credentials_id":"6L7RxyPKX0THy1tw93PB4V+8DB+KjnX9Pxa451yXPu0=","consent_status":"Authorised","consent_status_updated_at":"2020-05-24T15:44:40.077Z","consent_created_at":"2020-05-24T14:44:40.077Z","consent_expires_at":"2020-08-24T14:44:40.077Z","provider":{"display_name":"Lloyds Bank","logo_uri":"https://auth.truelayer.com/img/banks/banks-icons/lloyds-icon.svg","provider_id":"lloyds"},"scopes":["info","accounts","balance","transactions","cards","offline_access"],"privacy_policy":"Feb2019"}]}},"Unauthorized401Response":{"summary":"Unauthorized","value":{"error_description":"The token expired at '2020-12-07 12:34:56Z'","error":"invalid_token"}},"AccessDenied403Response":{"summary":"Access denied (SCA exceeded)","value":{"error_description":"SCA exemption has expired. This resource is protected and should be accessed shortly after PSU Authentication. In order to access this resource, please have the PSU re-authenticate.","error":"sca_exceeded","error_details":{}}},"AccessDeniedSCAExceeded403Response":{"summary":"Access denied","value":{"error_description":"Access to a specific resource has been denied.","error":"access_denied","error_details":{}}},"ProviderRateLimitExceeded429Response":{"summary":"Provider rate limit exceeded","value":{"error_description":"Provider rate limit exceeded.","error":"provider_too_many_requests","error_details":{}}},"UnattendedCallsLimitExceeded429Response":{"summary":"Unattended calls rate limit exceeded","value":{"error_description":"Maximum number of requests per user allowed by provider exceeded.","error":"provider_request_limit_exceeded","error_details":{}}},"InternalServerError500Response":{"summary":"Internal server error","value":{"error_description":"Internal server error.","error":"internal_server_error","error_details":{}}},"ProviderPlannedDowntime503Response":{"summary":"Provider planned downtime","value":{"error_description":"The provider service is unavailable.","error":"provider_error","error_details":{}}},"ConnectorOverload503Response":{"summary":"Connector overload","value":{"error_description":"The connector service is currently overloaded.","error":"connector_overload","error_details":{}}},"ProviderUnplannedDowntime503Response":{"summary":"Provider unplanned downtime","value":{"error_description":"The provider service is unavailable.","error":"temporarily_unavailable","error_details":{}}},"ConnectorTimeout504Response":{"summary":"Connector timeout","value":{"error_description":"The connector service timed out.","error":"connector_timeout","error_details":{}}},"ProviderTimeout504Response":{"summary":"Provider timeout","value":{"error_description":"The provider service timed out.","error":"provider_timeout","error_details":{}}},"GetInfoTypical200Response":{"summary":"typical info payload example","value":{"results":[{"full_name":"John Doe","update_timestamp":"2020-11-19T09:30:00Z"}]}},"GetInfoAllFields200Response":{"summary":"complete info payload example","value":{"results":[{"full_name":"John Doe","branch_id":"stet-caisse-d-epargne-normandie","emails":["joe.doe@example.com"],"phones":["+447777123456"],"update_timestamp":"2020-11-19T09:30:00Z"}]}},"NotImplemented501Response":{"summary":"Not implemented","value":{"error_description":"Feature not supported by the provider","error":"endpoint_not_supported","error_details":{}}},"GetAccounts200Response":{"summary":"accounts payload example","value":{"results":[{"update_timestamp":"2017-02-07T17:29:24.740802Z","account_id":"f1234560abf9f57287637624def390871","account_type":"TRANSACTION","display_name":"Club Lloyds","currency":"GBP","account_number":{"iban":"GB35LOYD12345678901234","number":"12345678","sort_code":"12-34-56","swift_bic":"LOYDGB2L"},"provider":{"provider_id":"lloyds"}},{"update_timestamp":"2017-02-07T17:29:24.740802Z","account_id":"f1234560abf9f57287637624def390872","account_type":"SAVINGS","display_name":"Club Lloyds","currency":"GBP","account_number":{"iban":"GB35LOYD12345678901235","number":"12345679","sort_code":"12-34-57","swift_bic":"LOYDGB2L"},"provider":{"provider_id":"lloyds"}}]}},"GetAccountsAU200Response":{"summary":"accounts payload (AU)","value":{"results":[{"update_timestamp":"2022-05-09T17:29:24.740802Z","account_id":"6a21c1c0883d43fa79b3f74b32416787","account_type":"TRANSACTION","display_name":"Complete Freedom Account","currency":"AUD","account_number":{"number":"453278497078354","bsb":"112879","swift_bic":"SGBLAU2S"},"provider":{"provider_id":"st-george-aus"}},{"update_timestamp":"2022-05-09T17:29:24.740802Z","account_id":"6a21c1c0883d43fa79b3f74b32416788","account_type":"SAVINGS","display_name":"Easy Saver Account","currency":"AUD","account_number":{"number":"453122497078355","bsb":"112879","swift_bic":"SGBLAU2S"},"provider":{"provider_id":"st-george-aus"}}]}},"AsyncRequestQueued202Response":{"summary":"202 payload","value":{"results_uri":"https://api.truelayer.com/data/v1/results/18a77ae5-a30b-4955-b840-301daddd180a","status":"Queued","task_id":"18a77ae5-a30b-4955-b840-301daddd180a"}},"AccountNotFound404Response":{"summary":"404 payload","value":{"error_description":"account not found","error":"account_not_found","error_details":{}}},"GetAccount200Response":{"summary":"account payload","value":{"results":[{"update_timestamp":"2017-02-07T17:29:24.740802Z","account_id":"f1234560abf9f57287637624def390871","account_type":"TRANSACTION","display_name":"Club Lloyds","currency":"GBP","account_number":{"iban":"GB35LOYD12345678901234","number":"12345678","sort_code":"12-34-56"},"provider":{"provider_id":"lloyds"}}]}},"GetAccountAU200Response":{"summary":"account payload (AU)","value":{"results":[{"update_timestamp":"2022-05-09T17:29:24.740802Z","account_id":"6a21c1c0883d43fa79b3f74b32416787","account_type":"TRANSACTION","display_name":"Complete Freedom Account","currency":"AUD","account_number":{"number":"453278497078354","bsb":"112879","swift_bic":"SGBLAU2S"},"provider":{"provider_id":"st-george-aus"}}]}},"GetAccountBalance200Response":{"summary":"balance example payload","value":{"results":[{"currency":"GBP","available":2150.8,"current":1161.2,"overdraft":1000,"update_timestamp":"2017-02-07T17:33:30.001222Z"}]}},"GetAccountBalanceAU200Response":{"summary":"account balance payload (AU)","value":{"results":[{"currency":"AUD","available":2150.8,"current":1161.2,"overdraft":1000,"update_timestamp":"2022-05-09T17:33:30.001222Z"}]}},"GetAccountTransactions200Response":{"summary":"2 transactions example payload","value":{"results":[{"transaction_id":"03c333979b729315545816aaa365c33f","normalised_provider_transaction_id":"txn-ajdifh38fheu5hgue","provider_transaction_id":"9882ks-00js","timestamp":"2018-03-06T00:00:00","description":"GOOGLE PLAY STORE","amount":-2.99,"currency":"GBP","transaction_type":"DEBIT","transaction_category":"PURCHASE","transaction_classification":["Entertainment","Games"],"merchant_name":"Google play","running_balance":{"amount":1238.6,"currency":"GBP"},"meta":{"bank_transaction_id":"9882ks-00js","provider_transaction_category":"DEB"}},{"transaction_id":"3484333edb2078e77cf2ed58f1dec11e","normalised_provider_transaction_id":"txn-2jdh8whf8w9rh3udh","provider_transaction_id":"33b5555724","timestamp":"2018-02-18T00:00:00","description":"PAYPAL EBAY","amount":-25.25,"currency":"GBP","transaction_type":"DEBIT","transaction_category":"PURCHASE","transaction_classification":["Shopping","General"],"merchant_name":"Ebay","meta":{"bank_transaction_id":"33b5555724","provider_transaction_category":"DEB"}}]}},"GetAccountTransactionsAU200Response":{"summary":"2 transactions payload (AU)","value":{"results":[{"timestamp":"2022-03-02T00:00:00","description":"TFR Westpac","transaction_type":"CREDIT","transaction_category":"OTHER","amount":100,"currency":"AUD","transaction_id":"08b22f7ed7e222a0ac986d10cbacc2da","provider_transaction_id":"32RJRrk-g5KzzOTDkVp631blQrzgsBOSAJ8J8qa3nlJsJaUDgK36mMCe","normalised_provider_transaction_id":"txn-f88d587a7bd5fcd16"},{"timestamp":"2022-03-01T00:00:00","description":"DEBIT CARD PURCHASE WOOLWORTHS","transaction_type":"DEBIT","transaction_category":"OTHER","amount":-50,"currency":"AUD","transaction_id":"1289224494752e396fd21a496c34aa96","provider_transaction_id":"42RJRrk-g5KzzOTDkVp631blQrzgsBOSAJ8J8qa3nlJsJaUDgK36mMCq","normalised_provider_transaction_id":"txn-58fe8574b18e3e917"}]}},"Invalid400Response":{"summary":"Invalid request","value":{"error_description":"The supplied parameters are not valid.","error":"validation_error","error_details":{}}},"InvalidDate400Response":{"summary":"Invalid date range","value":{"error_description":"Invalid date range provided.","error":"invalid_date_range","error_details":{}}},"GetAccountStandingOrders200Response":{"summary":"standing orders response example","value":{"results":[{"frequency":"IntrvlMnthDay:01:26","status":"Active","timestamp":"2019-07-24T11:29:47.414+00:00","currency":"GBP","meta":{"provider_account_id":"12345ca1-18fd-4e6b-891e-0597cac6bb8c"},"next_payment_date":"2019-07-26T00:00:00+00:00","next_payment_amount":500,"first_payment_date":"2019-06-26T00:00:00+00:00","first_payment_amount":0,"final_payment_date":"9999-12-31T00:00:00+00:00","final_payment_amount":0,"reference":"Savings"},{"frequency":"IntrvlMnthDay:01:30","status":"Active","timestamp":"2019-07-24T11:29:47.416+00:00","currency":"GBP","meta":{"provider_account_id":"12345ca1-18fd-4e6b-891e-0597cac6bb8c"},"next_payment_date":"2019-07-30T00:00:00+00:00","next_payment_amount":500,"first_payment_date":"2019-01-01T00:00:00+00:00","first_payment_amount":0,"final_payment_date":"9999-12-31T00:00:00+00:00","final_payment_amount":0,"payee":"JOHN DOE","reference":"MONZO"}],"status":"Succeeded"}},"GetAccountDirectDebits200Response":{"summary":"3 direct debits example payload","value":{"results":[{"direct_debit_id":"004ea8ce16b6ff57090b7bf8c7b483a1","timestamp":"2019-07-19T17:28:37.798+01:00","name":"EE","status":"Active","previous_payment_timestamp":"2018-09-17T00:00:00+01:00","previous_payment_amount":25,"currency":"GBP","meta":{"provider_mandate_identification":"6","provider_account_id":"1000000000000000001"}},{"direct_debit_id":"8e5dfbc5b4d66c8aff248e9ca6440c55","timestamp":"2019-07-19T17:28:37.805+01:00","name":"PAYPAL","status":"Active","previous_payment_timestamp":"2019-07-18T00:00:00+01:00","previous_payment_amount":4.99,"currency":"GBP","meta":{"provider_mandate_identification":"9","provider_account_id":"1000000000000000001"}},{"direct_debit_id":"72699309c9be1226e46e5257fb24133f","timestamp":"2019-07-19T17:28:37.805+01:00","name":"BT INTERNET","status":"Active","previous_payment_timestamp":"2018-09-18T00:00:00+01:00","previous_payment_amount":16.99,"currency":"GBP","meta":{"provider_mandate_identification":"7","provider_account_id":"1000000000000000001"}}],"status":"Succeeded"}},"GetCards200Response":{"summary":"get cards example payload","value":{"results":[{"account_id":"f7b093437032c216d4350b7d442b9c5ccc0e9f19","card_network":"VISA","card_type":"CREDIT","currency":"GBP","display_name":"Club Credit Card","partial_card_number":"0044","name_on_card":"A. N. Other","valid_from":"2017-01","valid_to":"2018-01","update_timestamp":"2017-02-07T17:29:24.740802Z","provider":{"provider_id":"lloyds"}},{"account_id":"ad86fb1c213245b6b6594895068973efca5f9367","card_network":"MASTERCARD","card_type":"CHARGE","currency":"GBP","display_name":"Club Charge Card","partial_card_number":"0055","name_on_card":"A. N. Other","valid_from":"2017-01","valid_to":"2018-01","update_timestamp":"2017-02-07T17:29:24.740802Z","provider":{"provider_id":"lloyds"}}]}},"GetCard200Response":{"summary":"get card example payload","value":{"results":[{"account_id":"f7b093437032c216d4350b7d442b9c5ccc0e9f19","card_network":"VISA","card_type":"CREDIT","currency":"GBP","display_name":"Club Credit Card","partial_card_number":"0044","name_on_card":"A. N. Other","valid_from":"2017-01","valid_to":"2018-01","update_timestamp":"2017-02-07T17:29:24.740802Z","provider":{"provider_id":"lloyds"}}]}},"GetCardBalance200Response":{"summary":"card balance example payload","value":{"results":[{"available":3279,"currency":"GBP","current":20,"credit_limit":3300,"last_statement_balance":420,"last_statement_date":"2017-01-28","payment_due":5,"payment_due_date":"2017-02-24","update_timestamp":"2017-02-247T17:29:24.740802Z"}]}},"GetCardTransactions200Response":{"summary":"2 transaction example payload","value":{"results":[{"transaction_id":"a15d8156569ba848d84c07c34d291bca","normalised_provider_transaction_id":"txn-ajdifh38fheu5hgue","provider_transaction_id":"9882ks-00js","timestamp":"2018-01-16T00:00:00+00:00","description":"SAINSBURYS SMRKT STORE 128","amount":24.25,"currency":"GBP","transaction_type":"DEBIT","transaction_category":"PURCHASE","transaction_classification":["Shopping","Groceries"],"merchant_name":"Sainsburys","running_balance":{"amount":1238.6,"currency":"GBP"},"meta":{"cardNumber":"1234********5678","location":"INTERNET"}},{"transaction_id":"af4d5470cc7ad6a83a02335ab8053481","normalised_provider_transaction_id":"txn-2jdh8whf8w9rh3udh","provider_transaction_id":"33b5555724","timestamp":"2018-03-19T00:00:00","description":"TALKTALK TELECOM","amount":46.82,"currency":"GBP","transaction_type":"DEBIT","transaction_category":"PURCHASE","transaction_classification":["Bills and Utilities","Internet"],"merchant_name":"Talktalk","running_balance":{"amount":1262.85,"currency":"GBP"},"meta":{"provider_transaction_category":"DEB","cardNumber":"1234********5678","location":"INTERNET"}}]}},"BatchResults200Response":{"summary":"batch payload","value":{"status":"Succeeded","task_id":"0cf3fca2-e64e-4a35-8280-7c5bd7b5dc43","request":{"from":"2019-05-10T00:00:00","to":"2019-05-20T00:00:00"},"results":{"accounts":[{"account_id":"a467e5319ddc9ad99846465bd6f0127e","transactions":[{"timestamp":"2019-05-10T00:00:00","description":"EDF ENERGY","transaction_type":"DEBIT","transaction_category":"UNKNOWN","transaction_classification":["Bills and Utilities","Utilities"],"merchant_name":"EDF ENERGY","amount":-24.5,"currency":"GBP","transaction_id":"1647dc2acf12438d8c348a379b85814a"},{"timestamp":"2019-05-20T00:00:00","description":"REGENDA REDWING","transaction_type":"DEBIT","transaction_category":"UNKNOWN","transaction_classification":["Investments","Real-estate"],"merchant_name":"REDWING LIVING","amount":-150,"currency":"GBP","transaction_id":"7cfc04c0f5c4c39a3e168b76ec607799"}],"pending_transactions":[{"transaction_id":"a15d8156569ba848d84c07c34d291bca","timestamp":"2019-05-20T00:00:00","amount":24.25,"currency":"GBP","description":"SAINSBURYS SMRKT STORE 128","transaction_type":"DEBIT","transaction_category":"PURCHASE","running_balance":{"amount":1238.6,"currency":"GBP"},"meta":{"cardNumber":"1234********5678","location":"INTERNET"}},{"transaction_id":"af4d5470cc7ad6a83a02335ab8053481","timestamp":"2019-05-20T00:00:00","amount":46.82,"currency":"GBP","description":"TALKTALK TELECOM","transaction_type":"DEBIT","transaction_category":"PURCHASE","meta":{"provider_transaction_category":"DEB","cardNumber":"1234********5678","location":"INTERNET"}}],"balance":{"currency":"GBP","available":200.12,"current":200.12,"overdraft":0,"update_timestamp":"2019-05-20T00:00:00"}},{"account_id":"9586f94c8b253dc83807171339ea5da9","transactions":[{"timestamp":"2019-05-10T00:00:00","description":"EDF ENERGY","transaction_type":"DEBIT","transaction_category":"UNKNOWN","transaction_classification":["Bills and Utilities","Utilities"],"merchant_name":"EDF ENERGY","amount":-24.5,"currency":"GBP","transaction_id":"f80d0229693f61fcb6c1fb79f2c61af4"},{"timestamp":"2019-05-20T00:00:00","description":"REGENDA REDWING","transaction_type":"DEBIT","transaction_category":"UNKNOWN","transaction_classification":["Investments","Real-estate"],"merchant_name":"REDWING LIVING","amount":-150,"currency":"GBP","transaction_id":"bdf8979b2d9c80ad1db2053c2e18a483"}],"pending_transactions":[],"balance":{"currency":"GBP","available":50.08,"current":50.08,"overdraft":0,"update_timestamp":"2019-05-20T00:00:00"}}],"cards":[{"account_id":"8901414c1e40d6beb24dfe45f39f3912","transactions":[{"timestamp":"2019-05-10T00:00:00","description":"EDF ENERGY","transaction_type":"CREDIT","transaction_category":"UNKNOWN","transaction_classification":["Bills and Utilities","Utilities"],"merchant_name":"EDF ENERGY","amount":-24.5,"currency":"GBP","transaction_id":"646a9145784840eb911fef6278fbc4e5"},{"timestamp":"2019-05-20T00:00:00","description":"REGENDA REDWING","transaction_type":"CREDIT","transaction_category":"UNKNOWN","transaction_classification":["Investments","Real-estate"],"merchant_name":"REDWING LIVING","amount":-150,"currency":"GBP","transaction_id":"27d48b9c7d943c285e870bceba5b033b"}],"balance":{"available":3279,"currency":"GBP","current":20,"credit_limit":3300,"last_statement_balance":420,"last_statement_date":"2019-04-30","payment_due":5,"payment_due_date":"2019-05-20","update_timestamp":"2019-05-107T17:29:24.740802Z"}},{"account_id":"afb594831dacd544563b20be7c362a51","transactions":[{"timestamp":"2019-05-10T00:00:00","description":"EDF ENERGY","transaction_type":"CREDIT","transaction_category":"UNKNOWN","transaction_classification":["Bills and Utilities","Utilities"],"merchant_name":"EDF ENERGY","amount":-24.5,"currency":"GBP","transaction_id":"cc96f312d45f2c96d9464e69873d6a04"},{"timestamp":"2019-05-20T00:00:00","description":"REGENDA REDWING","transaction_type":"CREDIT","transaction_category":"UNKNOWN","transaction_classification":["Investments","Real-estate"],"merchant_name":"REDWING LIVING","amount":-150,"currency":"GBP","transaction_id":"da5c341e2b790bb3bcfd0235829df37c"}],"balance":{"available":510,"currency":"GBP","current":200,"credit_limit":710,"last_statement_balance":420,"last_statement_date":"2019-04-30","payment_due":10,"payment_due_date":"2019-05-20","update_timestamp":"2019-05-107T17:29:24.740802Z"}}]}}},"noFurtherActionExample":{"summary":"No action needed","value":{"action_needed":"no_action_needed","access_token":"ey...","expires_in":3600,"refresh_token":"ABC123","token_type":"Bearer"}},"goToAuthDialogExample":{"summary":"Go to auth dialog","value":{"action_needed":"reconfirmation_of_consent_needed","user_input_link":"https://login.truelayer.com/?session_id=auth-abc123"}},"reauthRequiredExample":{"summary":"Reauthentication required","value":{"action_needed":"authentication_needed","user_input_link":"https://personal.secure1.natwest.com/as/authorization.oauth2?client_id=HZ6ewkLruJDapDopkR6YVS&request=ey...gg&state=auth-y4PCIwnDZcUAM6nVoV_HJnb9DVmOXZlJT5UAs03wT8U&nonce=iZ67tVaMNo-NRtCPCu8nSvubsK5h1C8vr2peGsNc&scope=openid%20accounts&response_type=code%20id_token&redirect_uri=https%3A%2F%2Fauth.truelayer.com%2Foauth%2Fhybrid%2Fcallback"}},"validationErrorExample":{"summary":"Validation error","value":{"type":"https://docs.truelayer.com/#connection-api-errors","title":"One or more validation errors occurred.","status":400,"instance":"/connections/extend","trace_id":"3dc845a2-93a2-4e12-940a-0a8aec24d0bc","errors":{"ClientId":["The ClientId field is required."]}}},"unauthorisedErrorExample":{"summary":"Validation error","value":{"type":"https://docs.truelayer.com/#connection-api-errors","title":"Unauthorized","status":401,"detail":"Refresh token missing or invalid.","instance":"/connections/extend","trace_id":"5b25a9ad-fdb5-42c7-90d7-dca27ceebc4d"}},"unprocessableEntityErrorExample":{"summary":"Unprocessable Entity Error","value":{"type":"https://docs.truelayer.com/#connection-api-errors","title":"No way to extend this connection","status":422,"detail":"This connection cannot be extended","instance":"/connections/extend","trace_id":"1c7efd51-51d5-4e00-bce5-15bce583701f"}}},"responses":{"202":{"description":"Accepted","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResponse"},"examples":{"202Example":{"$ref":"#/components/examples/AsyncRequestQueued202Response"}}}}},"400":{"description":"Invalid request","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"400Example":{"$ref":"#/components/examples/Invalid400Response"},"400InvalidDateExample":{"$ref":"#/components/examples/InvalidDate400Response"}}}}},"401":{"description":"Unauthorized","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401Example":{"$ref":"#/components/examples/Unauthorized401Response"}}}}},"403":{"description":"Access denied","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403Example":{"$ref":"#/components/examples/AccessDenied403Response"},"403InvalidDateExample":{"$ref":"#/components/examples/AccessDeniedSCAExceeded403Response"}}}}},"404":{"description":"Not found","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"404Example":{"$ref":"#/components/examples/AccountNotFound404Response"}}}}},"429":{"description":"Rate limit exceeded","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"429ProviderRateLimitExceededExample":{"$ref":"#/components/examples/ProviderRateLimitExceeded429Response"},"429UnattendedCallsLimitExceededExample":{"$ref":"#/components/examples/UnattendedCallsLimitExceeded429Response"}}}}},"500":{"description":"Internal server error","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"500Example":{"$ref":"#/components/examples/InternalServerError500Response"}}}}},"501":{"description":"Not implemented","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"501Example":{"$ref":"#/components/examples/NotImplemented501Response"}}}}},"503":{"description":"Service unavailable","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"503ProviderPlannedDowntimeExample":{"$ref":"#/components/examples/ProviderPlannedDowntime503Response"},"503ConnectorOverloadExample":{"$ref":"#/components/examples/ConnectorOverload503Response"},"503ProviderUnplannedDowntime":{"$ref":"#/components/examples/ProviderUnplannedDowntime503Response"}}}}},"504":{"description":"Gateway timeout","headers":{"X-TL-Correlation-Id":{"$ref":"#/components/headers/X-TL-Correlation-Id"},"X-Credentials-Id":{"$ref":"#/components/headers/X-Credentials-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Content-Encoding":{"$ref":"#/components/headers/Content-Encoding"},"Content-Type":{"$ref":"#/components/headers/Content-Type"},"Date":{"$ref":"#/components/headers/Date"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-Frame-Options":{"$ref":"#/components/headers/X-Frame-Options"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"Referrer-Policy":{"$ref":"#/components/headers/Referrer-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"504ConnectorTimeoutExample":{"$ref":"#/components/examples/ConnectorTimeout504Response"},"504ProviderTimeoutExample":{"$ref":"#/components/examples/ProviderTimeout504Response"}}}}}},"requestBodies":{"WebhookRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"request_timestamp":{"description":"The ISO8601 encoded datetime specified in the original request","type":"string","format":"date-time"},"request_uri":{"description":"The URI of the original request","type":"string","format":"uri"},"results_uri":{"description":"The URI where results can be fetched from when available.","type":"string","format":"uri"},"credentials_id":{"description":"Unique string identifying a set of End user’s credentials used to access a Provider","type":"string"},"task_id":{"description":"A unique ID associated with the task","type":"string"},"status":{"description":"the outcome of the request","type":"string","enum":["Succeeded","Failed"]}}}}}}},"callbacks":{"batchSuccess":{"{$request.body#/webhook_uri}":{"post":{"summary":"Batch call webhook","requestBody":{"$ref":"#/components/requestBodies/WebhookRequest"},"responses":{"200":{"description":"Return 200 to indicate the data has been received"}}}}}}},"x-readme":{"explorer-enabled":false}}