plaid2.model.external_payment_options module

class plaid2.model.external_payment_options.ExternalPaymentOptions(*, request_refund_details: Optional[bool] = None, wallet_id: Optional[str] = None, bacs: Optional[RecipientBacs] = None, scheme: Optional[str] = None, iban: Optional[str] = None)[source]

Bases: BaseModel

bacs: Optional[RecipientBacs]: An optional object used to restrict the accounts used for payments. If provided, the end user will be able to send payments only from the specified bank account.

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

iban: Optional[str]: The International Bank Account Number (IBAN) for the payer’s account. If provided, the end user will be able to send payments only from the specified bank account.

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → ExternalPaymentOptions[source]: Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → ExternalPaymentOptions[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

request_refund_details: Optional[bool]: When true, Plaid will attempt to request refund details from the payee’s financial institution. Support varies between financial institutions and will not always be available. If refund details could be retrieved, they will be available in the /payment_initiation/payment/get response.

scheme: Optional[str]

Payment scheme. If not specified - the default in the region will be used (e.g. SEPA_CREDIT_TRANSFER for EU). Using unsupported values will result in a failed payment.

FASTER_PAYMENTS: Enables payments to move quickly between UK bank accounts. Default value in the UK.

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

SEPA_CREDIT_TRANSFER_INSTANT: Instant payment within the SEPA area. May involve additional fees and may not be available at some banks.

wallet_id: Optional[str]: 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.