Gets transaction details based on an account identifier and transaction identifier.
OAuth Grant type, Private JWT
SCA token ID
Client ID header.
Device information permitted for the data query.
You can use this parameter to apply an experience base to optimize data collection.
Identifier of the account. The number format is defined in the "account_id_type" parameter.
Transaction identifier.
Account id country
Account id type
Flag to retrieve the account identifier with type virtual_account or virtual_account_limited which has caused the entry.
Query param (string, splitted by comma) that determine how many information we should return. Possible values for this query are:
- transaction_description
- related_virtual_account
If the value is 'transaction_description', the response includes the transaction additional info.
If the value is 'related_virtual_account', the response includes related virtual account transaction info.
The default value is empty and returns no transaction description.
String that in case that it is ISO20022, returns a transactionCategory field like an object in transaction response.
String that in case that it is not ISO20022, returns a transactionCategory field like a string in transaction response.
By default, the value is false.
Data structure showing client account details.
{
"transactionId": "0f4367d2-5247-46ff-9b60-f52894ef949c",
"operationDate": "2017-07-21T17:32:28.000Z",
"valueDate": "2017-07-21T17:32:28.000Z",
"bookingDate": "2017-07-21T17:32:28.000Z",
"type": "debit",
"transactionCategory": {
"domain": "PMNT",
"family": "RCDT",
"subFamily": "DMCT"
},
"categoryDescription": "Received Credit Transfers - Domestic Credit Transfer",
"transactionAmount": {
"amount": "5000",
"currency": "GBP"
},
"balances": {
"current": {
"amount": {
"amount": "150",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"value": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"consolidated": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"pendingConsolidation": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"withholding": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"overdraft": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"limit": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"available": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
}
},
"references": {
"transactionClientReference": "CF44-312-1234ABC197",
"transactionBatchReference": "NONREF",
"transactionInternalReference": "1500CF321006HSK1"
},
"additionalInfo": {}
}{
"relatedVirtualAccountTransaction": {
"accountIdentifiersList": [
{
"accountIdType": "uuid",
"accountId": "0589bd6c-cca4-4b46-9c8a-b786171e66d1"
},
{
"accountIdType": "iban",
"accountId": "GB40PNXT09991100000023",
"country": "GB"
},
{
"accountIdType": "bban",
"accountId": "PNXT09991100000023",
"country": "GB"
}
],
"transactionDetailsLink": "/accounts/0589bd6c-cca4-4b46-9c8a-b786171e66d1/transactions/0564bd6c-cca4-4b46-9c8a-b786171f66a1/?account_id_type=uuid"
},
"transactionId": "0f4367d2-5247-46ff-9b60-f52894ef949c",
"operationDate": "2017-07-21T17:32:28.000Z",
"valueDate": "2017-07-21T17:32:28.000Z",
"bookingDate": "2017-07-21T17:32:28.000Z",
"type": "debit",
"transactionCategory": {
"domain": "PMNT",
"family": "RCDT",
"subFamily": "DMCT"
},
"categoryDescription": "Received Credit Transfers - Domestic Credit Transfer",
"transactionAmount": {
"amount": "5000",
"currency": "GBP"
},
"balances": {
"current": {
"amount": {
"amount": "150",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"value": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"consolidated": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"pendingConsolidation": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"withholding": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"overdraft": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"limit": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"available": {
"amount": {
"amount": "100",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
}
},
"references": {
"transactionClientReference": "CF44-312-1234ABC197",
"transactionBatchReference": "NONREF",
"transactionInternalReference": "1500CF321006HSK1"
},
"additionalInfo": {}
}Data of a transaction
Related virtual account transaction.
List of account Identifiers.
Identifier of an account. It is usually used to identify the real account related to a virtual account.
Format used for the account number in the accountId property.
The possible values are:
- IBAN = IBAN code
- BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
- UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.
For example:
- In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
- In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Identifier of an account.
Data structure containing details of the country for the account. Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).
Link to the account transactions list.
UUID identification type
Balance last update date time. The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Balance last update date time. The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Balance last update date time. The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Nature of the transaction. Possible values could be: credit, debit, reverse-credit, reverse-debit.
Data structure containing transaction category request.
Bank transaction code domain.
Bank transaction code family.
Bank transaction code sub family.
Transaction category description.
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Data structure containing information related to different balances.
Base Balance and date of last change
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Balance last update date time.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Base Balance and date of last change
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Balance last update date time.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Base Balance and date of last change
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Balance last update date time.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Base Balance and date of last change
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Balance last update date time.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Base Balance and date of last change
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Balance last update date time.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Base Balance and date of last change
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Balance last update date time.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Base Balance and date of last change
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Balance last update date time.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Base Balance and date of last change
Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Balance last update date time.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Types of transactions references.
Client transaction identification (customer reference included in a domestic electronic statement). If the 'client transaction identification' field is not used in the report for the banking system supervisor for this particular entry, 'NONREF' must be used.
Transaction identification (customer reference included in a domestic electronic batch). If the 'client batch identification' field is not used in the report for the banking system supervisor for this particular entry, 'NONREF' must be used.
Internal reference of the account servicing institution. If there is no information, 'NONREF' must be used.
Free JSON object.
No content
Bad Request
{
"errors": [
{
"code": "INVALID_SCHEMA",
"message": "Invalid input.",
"level": "ERROR",
"description": "Error validating schema."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"message": "A token must be provided.",
"level": "ERROR",
"description": "There was an error during token verification in header [authorization]"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Forbidden
{
"errors": [
{
"code": "OPERATION_NOT_ALLOWED",
"message": "operation not allowed due to lack of permissions.",
"level": "ERROR",
"description": "Operation not allowed due to lack of permissions."
}
]
}{
"errors": [
{
"code": "INVALID_AUTH_TOKEN",
"message": "The token provided is invalid.",
"level": "ERROR",
"description": "Invalid auth token."
}
]
}{
"errors": [
{
"code": "FORBIDDEN",
"message": "A token must be provided.",
"level": "ERROR",
"description": "Operation not allowed due to lack of permissions."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Data structure showing an account does not exist in the system.
{
"errors": [
{
"code": "NOT_FOUND",
"level": "ERROR",
"message": "Not found.",
"description": "The server can not find the requested resource. In the browser, this means the URL is not recognized."
}
]
}{
"errors": [
{
"code": "ACCOUNT_NOT_FOUND",
"level": "ERROR",
"message": "Account not found.",
"description": "The data related to the account with identifier \"a26c7fc3-3f9b-4045-a946-24e565bee1f9\" could not be found."
}
]
}{
"errors": [
{
"code": "REAL_ACCOUNT_VIRTUAL_STRUCTURE_NOT_EXIST",
"level": "ERROR",
"message": "Real account has no virtual account structure",
"description": "This account with an UUID \"698b21e5-016f-487c-b0a7-bb86772f126f\" has no virtual structure ID."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Method Not Allowed
{
"errors": [
{
"code": "METHOD_NOT_ALLOWED",
"level": "ERROR",
"message": "Method not allowed",
"description": "The request method is known by the server but is not supported by the target resource."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Not Acceptable
{
"errors": [
{
"code": "NOT_ACCEPTABLE",
"level": "ERROR",
"message": "Not Acceptable",
"description": "This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Conflict
{
"errors": [
{
"code": "CONFLICT",
"level": "ERROR",
"message": "Conflict",
"description": "This response is sent when a request conflicts with the current state of the server."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Payload too large
{
"errors": [
{
"code": "PAYLOAD_TOO_LARGE",
"level": "ERROR",
"message": "Payload too large",
"description": "Request entity is larger than limits defined by server. The server might close the connection or return an Retry-After header field."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Request URI Too Long
{
"errors": [
{
"code": "URI_TOO_LARGE",
"level": "ERROR",
"message": "URI too large",
"description": "The URI requested by the client is longer than the server is willing to interpret."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Unsupported Media Type
{
"errors": [
{
"code": "UNSUPPORTED_MEDIA_TYPE",
"level": "ERROR",
"message": "Unsupported Media Type",
"description": "The media format of the requested data is not supported by the server, so the server is rejecting the request."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Unprocessable Entity
{
"errors": [
{
"code": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"message": "Unprocessable entity.",
"description": "The request was well-formed but was unable to be followed due to semantic errors."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Too Many Requests
{
"errors": [
{
"code": "TOO_MANY_REQUESTS",
"level": "ERROR",
"message": "Too many requests.",
"description": "The user has sent too many requests in a given amount of time"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Internal Server Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error.",
"level": "ERROR",
"description": "INTERNAL_SERVER_ERROR"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Service Down Error
{
"errors": [
{
"code": "SERVICE_DOWN_ERROR",
"message": "Service down error.",
"level": "ERROR",
"description": "Service down error."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Gateway Timeout Error
{
"errors": [
{
"code": "GATEWAY_TIMEOUT_ERROR",
"message": "Gateway timeout error.",
"level": "ERROR",
"description": "Gateway timeout error"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Internal Server Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error.",
"level": "ERROR",
"description": "INTERNAL_SERVER_ERROR"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.