Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.8 KB

SandboxTransferSimulateRequest.md

File metadata and controls

18 lines (13 loc) · 1.8 KB

SandboxTransferSimulateRequest

Defines the request schema for /sandbox/transfer/simulate

Properties

Name Type Description Notes
transfer_id str Plaid’s unique identifier for a transfer.
event_type str The asynchronous event to be simulated. May be: `posted`, `settled`, `failed`, or `returned`. An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include: `pending` --> `failed` `pending` --> `posted` `posted` --> `returned` `posted` --> `settled`
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]
test_clock_id str, none_type Plaid’s unique identifier for a test clock. If provided, the event to be simulated is created at the `virtual_time` on the provided `test_clock`. [optional]
failure_reason TransferFailure [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]

[Back to Model list] [Back to API list] [Back to README]