View List of Transactions
Method Description
Endpoint
Request Type | URL |
|---|---|
GET | https://{EnvironmentURL}/api/core/customers/{customerId}/accounts/{accountId}/transactions |
Headers
No headers
Request parameters
Path parameters
Parameter | Type | Mandatory | Description | |
|---|---|---|---|---|
customerId | uuid | Yes | Identifier of the Customer, owner of the Account | |
accountId | uuid | Yes | Identifier of the Account |
Query parameters
Parameter | Type | Mandatory | Description |
|---|---|---|---|
startDateTime | string | No | Filter parameter |
endDateTime | string | No | Filter parameter |
minAmount | number | No | Filter parameter |
maxAmount | number | No | Filter parameter |
pageNumber | int | No | Pagination parameter |
pageSize | int | No | Pagination parameter |
Responses
200 OK - Success
Body - JSON
Wrapper - Paginated Response
Parameter | Type | Mandatory | Description |
|---|---|---|---|
value | object | No | Successful response |
value.pageNumber | int | Yes | Pagination parameter |
value.pageSize | int | Yes | Pagination parameter |
value.total | int | Yes | Total number of objects in the list |
value.data | object | Yes | Response |
isSuccess | boolean | Yes | Success flag |
isCancelled | boolean | Yes | Cancellation flag |
errors | objects array | No | Errors details |
error.code | string | No | Error code |
error.description | string | No | Error description |
error.data | object | No | Additional data for error |
Data - Collection of Transaction entity
Parameter | Type | Mandatory | Description |
|---|---|---|---|
transactionId | uuid | Yes | Identifier of the transaction |
endToEndTransactionId | string | Yes | Unique end-to-end transaction identifier |
reference | string | No | Payment reference specified by the customer |
currency | string | Yes | String code of the currency. Allowed values: usd, eur, gbp |
amount | number | Yes | Amount of the transaction |
balance | number | Yes | Available balance of the account after the moment of creating Transaction |
number | int | Yes | Unique number of transaction for this account |
paymentRails | string | Yes | Payment rails. Allowed values: fps, sepa, swift, bacs |
paymentScheme | string | No | Payment scheme if applicable. Allowed values: sepaNormal, sepaInstant, bacsDD |
executionDate | datetime | Yes | Date when execution is planned |
creationDate | datetime | Yes | Date of creation |
currentState | string | Yes | State of the transaction. Allowed values: pending, failed, completed |
counterpartName | string | No | Name of external counterpart |
counterpartIban | string | No | IBAN of external counterpart |
bankTransactionAccountOwnerName | string | No | Name of internal counterpart |
counterpartAddress | string | No | Address of internal counterpart |
bankAddress | string | No | Obsolete |
transactionSubType | string | No | Subtype of the transaction: Inbound or outbound |
contactId | uuid | No | Initial beneficiary contact |
linkedTransactionId | uuid | No | Linked transaction in case of fee charge |
401 - Unauthorized
No Body