Transactions EB

Get transaction

Returns details for a specific transaction using its unique identifier.

get/transactions/{id}

Request

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

Path parameters

idstring required

Unique identifier for a transaction.

Headers

tokenstring

JWT Client token

client_idstring

Unique identifier for a client.

Response

Successful

idstring required

Transaction ID

creditorAccountstring

The last 4 digits of the creditor account number - PRN or DDA. The digits are preceded by ... to show that the account number has been masked.

creditorNamestring required

The name of the account holder receiving the payment. This is either the name of the account holder?s business or their first and last name.

debtorAccountstring

The last 4 digits of the debtor account number - PRN or DDA. The digits are preceded by ... to show that the account number has been masked.

debtorNamestring required

The name of the account holder making the payment. This is either the name of the account holder?s business or their first and last name.

amountnumber required

Transaction value

currencystring required

Transaction currency

memostring required

Memorandum

paymentDatestring required

Date of transaction

originatingTransactionIdstring

The transactionId of a transaction which incurred a fee. Use this ID to show the connection between a fee transaction and its originating transaction. This is only available for fee transactions.

feeType'CHARGE' | 'REVERSAL'

The type of the fee transaction. Use this to differentiate between the fee transactions that were charged and those that were reversed. * CHARGE - the fee that was incurred as a result of a transaction. * REVERSAL - the fee was incurred and then voided on a transaction.

originatingTransactionType'ACH_PAYOUT' | 'RTP_PAYOUT' | 'WIRE_PAYOUT' | 'DEBIT_CARD_REQUEST' | 'FEE'

The transaction type of the originating transaction that incurred a fee. This is only available for fee transactions. * ACH_PAYOUT - the original transaction was a payout made by ACH payment route. * RTP_PAYOUT - the original transaction was a payout made by ACH payment route. * WIRE_PAYOUT - the original transaction was a payout made by WIRE payment route. * DEBIT_CARD_REQUEST - the original transaction was a debit card request. * FEE - the original transaction was a fee that was reversed.

accountingType'DR' | 'CR' required

Accounting type (Credit (CR) / Debit (DR)) for transaction

rejectedReasonstring

The reason a transaction was REJECTED or RETURNED. This is populated only for transactions with 'REJECTED' status. For all other transactions, the value is 'null'.

paymentRoute'RTP' | 'WIRE' | 'ACH'

The method by which the payment was made - RTP, WIRE, ACH

creationTimestampstring date-time

The date and time the transaction was created.

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

The current status of the transaction as it is processed:

  • PENDING - The transaction is still being processed.
  • CANCELED - The transaction has been canceled.
  • COMPLETED - The transaction has been completed.
  • COMPLETED_WITH_EXCEPTIONS - The transaction has completed, but not all of the requested criteria has been fulfilled.
  • REJECTED - The transaction has been rejected and will not be completed.
  • RETURNED - The payment rail has been unable to complete the payment specified recipient. The payment has been returned to the originator.
  • PARTIALLY_COMPLETED - Not all transactions in the batch have been completed.
  • UNDEFINED - The status of this transaction cannot be found.
transactionType'PAYIN' | 'PAYTO' | 'PAYINTO' | 'TRANSFER' | 'PAYOUT' | 'PAYIN_REVERSAL' | 'PAYOUT_REVERSAL' | 'MISC_CREDIT' | 'MISC_DEBIT' | 'UNDEFINED' | 'PAYINTORECEIPT' | 'PAYOUTCOLLECTION' | 'PAYINTOCOLLECTION' | 'PAYINTO_RETURN' | 'PAYOUTCOLLECTION_RETURN' | 'PAYINTOCOLLECTION_RETURN' | 'RETURN' | 'CARD' | 'FEE' | 'BOOKTRANSFER' required

Defines the transaction according to specific types. For example, whether money has been paid into or out of the account.

Example response

{
  "id": "123434534",
  "creditorAccount": "...6044",
  "creditorName": "JPMC",
  "debtorAccount": "...6044",
  "debtorName": "JPMC C2",
  "amount": 100,
  "currency": "USD",
  "memo": "Invoice 1234",
  "paymentDate": "01-01-2022",
  "originatingTransactionId": "ff1b6152-3ea7-4c59-b4ae-606c6497cd52",
  "feeType": "CHARGE",
  "originatingTransactionType": "ACH_PAYOUT",
  "accountingType": "DR",
  "rejectedReason": "Future transaction date not supported.",
  "paymentRoute": "ACH",
  "creationTimestamp": "2023-02-22T15:05:46.952+0000",
  "status": "PENDING",
  "transactionType": "PAYIN",
  "debitCardDetails": {
    "cardPaymentRoutingNumber": "2000303444",
    "cardLast4": "0000",
    "cardSerialNumber": "100000158935",
    "messageType": "1200",
    "cardTransactionType": "CR",
    "isa": "0",
    "surcharge": 1,
    "merchant": {
      "name": "XYZ001",
      "address": {
        "addressLine1": "345 Wouda St",
        "city": "Springfield",
        "countryCode": "US",
        "state": "ND",
        "zip": "58008"
      }
    }
  }
}

Changes

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