Defines the request schema for /transfer/authorization/create
Name | Type | Description | Notes |
---|---|---|---|
type | TransferType | ||
network | TransferNetwork | ||
amount | str | The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). | |
user | TransferAuthorizationUserInRequest | ||
client_id | str | 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. | [optional] |
secret | str | 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. | [optional] |
access_token | str | The Plaid `access_token` for the account that will be debited or credited. Required if not using `payment_profile_token`. | [optional] |
account_id | str | The Plaid `account_id` corresponding to the end-user account that will be debited or credited. Required when creating a transfer using an `access_token`. | [optional] |
funding_account_id | str, none_type | The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited. Defaults to the account configured during onboarding. | [optional] |
payment_profile_token | str | The payment profile token associated with the Payment Profile that will be debited or credited. Required if not using `access_token`. | [optional] |
ach_class | ACHClass | [optional] | |
device | TransferAuthorizationDevice | [optional] | |
origination_account_id | str | Plaid's unique identifier for the origination account for this authorization. If not specified, the default account will be used. | [optional] |
iso_currency_code | str | The currency of the transfer amount. The default value is "USD". | [optional] |
idempotency_key | TransferAuthorizationIdempotencyKey | [optional] | |
user_present | bool, none_type | If the end user is initiating the specific transfer themselves via an interactive UI, this should be `true`; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be `false`. | [optional] |
with_guarantee | bool, none_type | If set to `false`, Plaid will not offer a `guarantee_decision` for this request (Guarantee customers only). | [optional] if omitted the server will use the default value of True |
beacon_session_id | str, none_type | The unique identifier returned by Plaid's beacon when it is run on your webpage. | [optional] |
originator_client_id | str, none_type | The Plaid client ID that is the originator of this transfer. Only needed if creating transfers on behalf of another client as a third-party sender (TPS). | [optional] |
credit_funds_source | TransferCreditFundsSource | [optional] | |
test_clock_id | str, none_type | Plaid’s unique identifier for a test clock. This field may only be used when using `sandbox` environment. If provided, the `authorization` is created at the `virtual_time` on the provided `test_clock`. | [optional] |
any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |