Transfer

transferEventList

POST
/transfer/event/list

Use the /transfer/event/list endpoint to get a list of transfer events based on specified filter criteria.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

Defines the request schema for /transfer/event/list

client_id?string

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.

secret?string

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.

start_date?|

The start datetime of transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)

Formatdate-time
end_date?|

The end datetime of transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)

Formatdate-time
transfer_id?|

Plaid’s unique identifier for a transfer.

account_id?|

The account ID to get events for all transactions to/from an account.

transfer_type?TransferType2

The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into your origination account; a credit indicates a transfer of money out of your origination account.

Value in

  • "debit"
  • "credit"
event_types?array<>

Filter events by event type.

count?|

The maximum number of transfer events to return. If the number of events matching the above parameters is greater than count, the most recent events will be returned.

Formatint32
Range1 <= value <= 25
Default25
offset?|

The offset into the list of transfer events. When count=25 and offset=0, the first 25 events will be returned. When count=25 and offset=25, the next 25 bank transfer events will be returned.

Formatint32
Range0 <= value
Default0
origination_account_id?|

The origination account ID to get events for transfers from a specific origination account.

Response Body

application/json

application/json

curl -X POST "https://example.com/transfer/event/list" \  -H "Content-Type: application/json" \  -d '{}'
{  "transfer_events": [    {      "account_id": "6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B",      "transfer_amount": "12.34",      "transfer_id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",      "transfer_type": "credit",      "event_id": 1,      "event_type": "posted",      "failure_reason": null,      "origination_account_id": null,      "timestamp": "2020-08-06T17:27:15Z"    }  ],  "request_id": "mdqfuVxeoza6mhu"}

transferAuthorizationCreate POST

Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer, make an authorization request with an `amount` less than the available balance in the account. - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.

bankTransferCancel POST

Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.