{ "opencollection": "1.0.0", "info": { "name": "Plaid sandbox/", "version": "2020-09-14_1.517.0" }, "items": [ { "info": { "name": "Plaid", "type": "folder" }, "items": [ { "info": { "name": "Plaid Create a test Item and processor token", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/processor_token/create", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data." }, { "info": { "name": "Plaid Create a test Item", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/public_token/create", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account wi" }, { "info": { "name": "Plaid Fire a test webhook", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/item/fire_webhook", "body": { "type": "json", "data": "{}" } }, "docs": "The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks:\n\n`DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.\n\n`NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2.\n\n`AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item creat" }, { "info": { "name": "Plaid Force a Sandbox Item into an error state", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/item/reset_login", "body": { "type": "json", "data": "{}" } }, "docs": "`/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Ite" }, { "info": { "name": "Plaid Set verification status for Sandbox account", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/item/set_verification_status", "body": { "type": "json", "data": "{}" } }, "docs": "The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.\n\nFor more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#)." }, { "info": { "name": "Plaid Simulate a bank transfer event in Sandbox", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/bank_transfer/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox." }, { "info": { "name": "Plaid Simulate creating a sweep", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/sweep/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of `swept` will become `swept_settled`, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`." }, { "info": { "name": "Plaid Simulate a transfer event in Sandbox", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox." }, { "info": { "name": "Plaid Simulate a refund event in Sandbox", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/refund/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox." }, { "info": { "name": "Plaid Simulate converting pending balance to available balance", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/ledger/simulate_available", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment." }, { "info": { "name": "Plaid Simulate a ledger deposit event in Sandbox", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/ledger/deposit/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment." }, { "info": { "name": "Plaid Simulate a ledger withdraw event in Sandbox", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/ledger/withdraw/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment." }, { "info": { "name": "Plaid Trigger the creation of a repayment", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/repayment/simulate", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned." }, { "info": { "name": "Plaid Manually fire a Transfer webhook", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/fire_webhook", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment." }, { "info": { "name": "Plaid Create a test clock", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/test_clock/create", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment.\n\nA test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox.\n\nA test clock can be associated with up to 5 recurring transfers." }, { "info": { "name": "Plaid Advance a test clock", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/test_clock/advance", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment.\n\nA test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`.\n\nIf a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed.\n\nFor example, a client creates a w" }, { "info": { "name": "Plaid Get a test clock", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/test_clock/get", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment." }, { "info": { "name": "Plaid List test clocks", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/transfer/test_clock/list", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks." }, { "info": { "name": "Plaid Reset the login of a Payment Profile", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/payment_profile/reset_login", "body": { "type": "json", "data": "{}" } }, "docs": "`/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment.\n\n After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a `decision_rationale` `PAYMENT_PROFILE_LOGIN_REQUIRED`. You can then use update mode for Payment Profile to restore it into a good state.\n\n In order to invo" }, { "info": { "name": "Plaid Manually fire a Bank Transfer webhook", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/bank_transfer/fire_webhook", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment." }, { "info": { "name": "Plaid Manually fire an Income webhook", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/income/fire_webhook", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment." }, { "info": { "name": "Plaid Manually fire a bank income webhook in sandbox", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/bank_income/fire_webhook", "body": { "type": "json", "data": "{}" } }, "docs": "Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment." }, { "info": { "name": "Plaid Save the selected accounts when connecting to the Platypus Oauth institution", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/oauth/select_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Save the selected accounts when connecting to the Platypus Oauth institution" } ] } ], "bundled": true }