HEADER PARAMETERS
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
Authorization Required | String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750 |
x-fapi-financial-id Required | String | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. |
x-consumer-key | String | Indicates the user-agent that the PSU is using. |
x-customer-user-agent | String | Indicates the user-agent that the PSU is using. |
x-fapi-customer-ip-address | String | The PSU's IP address if the PSU is currently logged in with the TPP. |
x-fapi-customer-last-logged-time | String | Indicates the user-agent that the PSU is using. |
x-fapi-customer-interaction-id | String | An RFC4122 UID used as a correlation id. |
REQUEST BODY SCHEMA: application/json;charset=utf-8 Example Request
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
Data Required | Object (OBReadData1) | |
Risk Required | Object (OBRisk2) | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info. |
REQUEST BODY SCHEMA: application/json;charset=utf-8 Example Request
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
ExpirationDateTime | String |
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. Example: 2017-04-05T10:43:07+00:00 |
Permissions Required | Array of Strings | Items Enum: "ReadAccountsBasic" "ReadAccountsDetail" "ReadBalances" "ReadBeneficiariesBasic" "ReadBeneficiariesDetail" "ReadDirectDebits" "ReadOffers" "ReadPAN" "ReadParty" "ReadPartyPSU" "ReadProducts" "ReadScheduledPaymentsBasic" "ReadScheduledPaymentsDetail" "ReadStandingOrdersBasic" "ReadStandingOrdersDetail" "ReadStatementsBasic" "ReadStatementsDetail" "ReadTransactionsBasic" "ReadTransactionsCredits" "ReadTransactionsDebits" "ReadTransactionsDetail" Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. |
TransactionFromDateTime | String <date-time> |
Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. Example: 2017-04-05T10:43:07+00:00. |
TransactionFromDateTime | String <date-time> |
Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. Example: 2017-04-05T10:43:07+00:00 |
Risk Required | String <date-time> | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info. |
ERRORS
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitat.