POST /wallet/transaction/execute

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.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`client_id`	String	No	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.
`wallet_id`	String	Yes	The ID of the e-wallet to debit from
`amount`	Object	Yes	The amount and currency of a transaction
`amount.value`	Number	Yes	The amount of the transaction. Must contain at most two digits of precision e.g. `1.23`.
`amount.iso_currency_code`	String	Yes	An ISO-4217 currency code, used with e-wallets and transactions. Possible values: `"EUR"` `"GBP"`
`originating_fund_source`	Object	No	The original source of the funds. This field is required by local regulation for certain businesses (e.g. money remittance) to send payouts to recipients in the EU and UK.
`originating_fund_source.bic`	String	Yes	The Business Identifier Code, also known as SWIFT code, for this bank account.
`originating_fund_source.full_name`	String	Yes	The full name associated with the source of the funds.
`originating_fund_source.account_number`	String	Yes	The account number from which the funds are sourced.
`originating_fund_source.address`	Object	Yes	The optional address of the payment recipient's bank account. Required by most institutions outside of the UK.
`originating_fund_source.address.postal_code`	String	Yes	The postal code where the recipient is located. Maximum of 16 characters.
`originating_fund_source.address.country`	String	Yes	The ISO 3166-1 alpha-2 country code where the recipient is located.
`originating_fund_source.address.street[]`	Array	Yes	An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.
`originating_fund_source.address.city`	String	Yes	The city where the recipient is located. Maximum of 35 characters.
`reference`	String	Yes	A reference for the transaction. This must be an alphanumeric string with 6 to 18 characters and must not contain any special characters or spaces. Ensure that the `reference` field is unique for each transaction.
`counterparty`	Object	Yes	An object representing the e-wallet transaction's counterparty
`counterparty.name`	String	Yes	The name of the counterparty
`counterparty.date_of_birth`	String	No	The counterparty's birthdate, in ISO 8601 (YYYY-MM-DD) format.
`counterparty.numbers`	Object	Yes	The counterparty's bank account numbers. Exactly one of IBAN or BACS data is required.
`counterparty.numbers.international`	Object	No	International Bank Account Number for a Wallet Transaction
`counterparty.numbers.international.iban`	String	No	International Bank Account Number (IBAN).
`counterparty.address`	Object	No	The optional address of the payment recipient's bank account. Required by most institutions outside of the UK.
`counterparty.address.postal_code`	String	Yes	The postal code where the recipient is located. Maximum of 16 characters.
`counterparty.address.country`	String	Yes	The ISO 3166-1 alpha-2 country code where the recipient is located.
`counterparty.address.street[]`	Array	Yes	An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.
`counterparty.address.city`	String	Yes	The city where the recipient is located. Maximum of 35 characters.
`secret`	String	No	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_key`	String	Yes	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 24 hours of the first request, from being processed.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.