Sign in
plaid

Fetch an e-wallet transaction

Fetch a specific e-wallet transaction

post/wallet/transaction/get

Request body

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

transaction_idstring required

The ID of the transaction to fetch

Response

OK

transaction_idstring required

A unique ID identifying the transaction

wallet_idstring required

The EMI (E-Money Institution) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.

referencestring required

A reference for the transaction

type'BANK_TRANSFER' | 'PAYOUT' | 'PIS_PAY_IN' | 'REFUND' | 'FUNDS_SWEEP' | 'RETURN' required

The type of the transaction. The supported transaction types that are returned are: BANK_TRANSFER: a transaction which credits an e-wallet through an external bank transfer.

PAYOUT: a transaction which debits an e-wallet by disbursing funds to a counterparty.

PIS_PAY_IN: a payment which credits an e-wallet through Plaid's Payment Initiation Services (PIS) APIs. For more information see the Payment Initiation endpoints.

REFUND: a transaction which debits an e-wallet by refunding a previously initiated payment made through Plaid's PIS APIs.

FUNDS_SWEEP: an automated transaction which debits funds from an e-wallet to a designated client-owned account.

RETURN: an automated transaction where a debit transaction was reversed and money moved back to originating account.

scheme'null' | 'FASTER_PAYMENTS' | 'SEPA_CREDIT_TRANSFER' | 'SEPA_CREDIT_TRANSFER_INSTANT' nullable

The payment scheme used to execute this transaction. This is present only for transaction types PAYOUT and REFUND.

FASTER_PAYMENTS: The standard payment scheme within the UK.

SEPA_CREDIT_TRANSFER: The standard payment to a beneficiary within the SEPA area.

SEPA_CREDIT_TRANSFER_INSTANT: Instant payment to a beneficiary within the SEPA area.

status'AUTHORISING' | 'INITIATED' | 'EXECUTED' | 'SETTLED' | 'BLOCKED' | 'FAILED' required

The status of the transaction.

AUTHORISING: The transaction is being processed for validation and compliance.

INITIATED: The transaction has been initiated and is currently being processed.

EXECUTED: The transaction has been successfully executed and is considered complete. This is only applicable for debit transactions.

SETTLED: The transaction has settled and funds are available for use. This is only applicable for credit transactions. A transaction will typically settle within seconds to several days, depending on which payment rail is used.

FAILED: The transaction failed to process successfully. This is a terminal status.

BLOCKED: The transaction has been blocked for violating compliance rules. This is a terminal status.

created_atstring date-time required

Timestamp when the transaction was created, in ISO 8601 format.

last_status_updatestring date-time required

The date and time of the last time the status was updated, in IS0 8601 format

payment_idstring nullable

The payment id that this transaction is associated with, if any. This is present only for transaction types PIS_PAY_IN and REFUND.

failure_reason'EXTERNAL_SYSTEM' | 'EXPIRED' | 'CANCELLED' | 'INVALID' | 'UNKNOWN' nullable

The error code of a failed transaction. Error codes include: EXTERNAL_SYSTEM: The transaction was declined by an external system. EXPIRED: The transaction request has expired. CANCELLED: The transaction request was rescinded. INVALID: The transaction did not meet certain criteria, such as an inactive account or no valid counterparty, etc. UNKNOWN: The transaction was unsuccessful, but the exact cause is unknown.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes