plaid

Execute a transaction using an e-wallet

Changed on

Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.

post/wallet/transaction/execute

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/wallet/transaction/execute
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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.

idempotency_keystring required

A random key provided by the client, per unique wallet transaction. Maximum of 128 characters.

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. If a request to execute a wallet transaction fails due to a network connection error, then after a minimum delay of one minute, you can retry the request with the same idempotency key to guarantee that only a single wallet transaction is created. If the request was successfully processed, it will prevent any transaction that uses the same idempotency key, and was received within 48 hours of the first request, from being processed.

wallet_idstring required

The ID of the e-wallet to debit from

user_idstring

The user_id of the end user the transaction is for, as returned by /user/create. The user must have a name and either an email address or a phone number. Required for new integrations.

referencestring required

A reference for the transaction. This must be a string of 6 to 18 characters containing only letters, numbers, and spaces. Ensure that the reference field is unique for each transaction.

Response

OK

transaction_idstring required

A unique ID identifying the transaction

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.

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

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • 141de8aaaad2Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /