Sign in
Transactions EB

List and filter transactions

Lists transactions for a specific client, which can be filtered using optional parameters.

get/transactions

Request

  • Base URL: https://apigateway.jpmorgan.com/tsapi/ef/v1
  • URL: https://apigateway.jpmorgan.com/tsapi/ef/v1/transactions
  • Auth: none declared

Query parameters

transactionType'PAYIN' | 'PAYOUT' | 'PAYTO' | 'PAYINTOCOLLECTION' | 'TRANSFER' | 'REVERSAL' | 'UNDEFINED' | 'RETURN' | 'CARD' | 'FEE'

The types of transaction that the client is allowed to search by.

Example:PAYIN

Filters by type of transaction.

status'PENDING' | 'CANCELED' | 'COMPLETED' | 'COMPLETED_WITH_EXCEPTIONS' | 'REJECTED' | 'RETURNED' | 'PARTIALLY_COMPLETED' | 'UNDEFINED'

The statuses of the transaction that the client is allowed to search by.

Example:PENDING

Filters by transaction status.

accountNumberstring

Filters by the Embedded Banking client account number connected to the transaction.

amountEqualsstring

Filters by an exact amount.

amountGreaterThanstring

Filters by amounts greater than a specified value.

amountLessThanstring

Filters by amounts less than a specified value.

dateEqualsstring

Filters transactions by an exact date.

dateGreaterThanstring

Filters for transactions made after this date.

dateLessThanstring

Filters for transactions made before this date.

dateTimeGreaterThanstring date-time

Filters for transactions made after this date and time.

dateTimeLessThanstring date-time

Filters for transactions made before this date and time.

recipientAccountstring

Filters by the recipient's account number.

transactionIdstring

Filters for a transaction that matches a specific transaction ID. The transaction ID is generated by Embedded Banking when a transaction is created or received.

Headers

tokenstring

JWT Client token

Response

Successful

Example response

{
  "metadata": {
    "page": 1,
    "limit": 30,
    "total_items": 1
  },
  "items": [
    {
      "status": "PENDING",
      "transactionType": "PAYIN",
      "ledgerBalance": 10000,
      "creationTimestamp": "2023-02-22T15:05:46.952+0000",
      "effectiveDate": "2023-02-22",
      "postingVersion": 1,
      "transactionId": "qsajdb3ybv3",
      "debtorAccount": "...1511",
      "creditorAccount": "...1511",
      "currency": "USD",
      "createdDate": "01-01-2022",
      "amount": "12.45",
      "debtorName": "Modells Sporting Goods",
      "creditorName": "HSBC Holding",
      "accountingType": "DR",
      "paymentRoute": "ACH"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.