POST /payment_initiation/consent/payment/execute

Default value: "application/json"

Decides the mode under which the payment processing should be performed, using IMMEDIATE as default.

IMMEDIATE: Will immediately execute the payment, waiting for a response from the ASPSP before returning the result of the payment initiation. This is ideal for user-present flows.

ASYNC: Will accept a payment execution request and schedule it for processing, immediately returning the new payment_id. Listen for webhooks or use the /payment_initiation/payment/get endpoint to obtain updates on the payment status. This is ideal for non user-present flows.

Possible values:

• "ASYNC"
• "IMMEDIATE"

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.

The amount and currency of a payment

The amount of the payment. Must contain at most two digits of precision e.g. 1.23. Minimum accepted value is 1.

The ISO-4217 currency code of the payment. For standing orders and payment consents, "GBP" must be used. For Poland, Denmark, Sweden and Norway, only the local currency is currently supported.

Possible values:

• "PLN"
• "NOK"
• "EUR"
• "SEK"
• "GBP"
• "DKK"

Deprecated, payments will be executed within the type of the consent.

A scope of the payment. Must be one of the scopes mentioned in the consent. Optional if the appropriate consent has only one scope defined, required otherwise.

Possible values:

• "EXTERNAL"
• "ME_TO_ME"

The consent ID.

A reference for the payment. This must be an alphanumeric string with at most 18 characters and must not contain any special characters (since not all institutions support them). If not provided, Plaid will automatically fall back to the reference from consent. In order to track settlement via Payment Confirmation, each payment must have a unique reference. If the reference provided through the API is not unique, Plaid will adjust it. Some institutions may limit the reference to less than 18 characters. If necessary, Plaid will adjust the reference by truncating it to fit the institution's requirements. Both the originally provided and automatically adjusted references (if any) can be found in the reference and adjusted_reference fields, respectively.

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.

A random key provided by the client, per unique consent payment. 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 consent payment fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single payment is created. If the request was successfully processed, it will prevent any payment that uses the same idempotency key, and was received within 48 hours of the first request, from being processed.