Reading Transfers and Transfer events
API reference for Transfer read and Transfer event endpoints and webhooks
For how-to guidance, see the Transfer events documentation.
| Reading Transfers | |
|---|---|
/transfer/get | Retrieve information about a transfer |
/transfer/list | Retrieve a list of transfers and their statuses |
/transfer/event/list | Retrieve a list of transfer events |
/transfer/event/sync | Sync transfer events |
/transfer/sweep/get | Retrieve information about a sweep |
/transfer/sweep/list | Retrieve a list of sweeps |
| Webhooks | |
|---|---|
TRANSFER_EVENTS_UPDATE | New transfer events available |
Endpoints
/transfer/get
Retrieve a transfer
The /transfer/get endpoint fetches information about the transfer corresponding to the given transfer_id or authorization_id. One of transfer_id or authorization_id must be populated but not both.
Request fields
client_idstring
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.secretstring
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.transfer_idstring
Plaid’s unique identifier for a transfer.
authorization_idstring
Plaid’s unique identifier for a transfer authorization.
1const request: TransferGetRequest = {2 transfer_id: '460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9',3};4try {5 const response = await plaidClient.transferGet(request);6 const transfer = response.data.transfer;7} catch (error) {8 // handle error9}Response fields and example
transferobject
Represents a transfer within the Transfers API.
idstring
Plaid’s unique identifier for a transfer.
authorization_idstring
Plaid’s unique identifier for a transfer authorization.
ach_classstring
Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see ACH SEC codes.
Codes supported for credits:
Codes supported for credits:
ccd, ppd
Codes supported for debits: ccd, tel, web"ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts"ppd" - Prearranged Payment or Deposit - The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained in writing either in person or via an electronic document signing, e.g. Docusign, by the consumer. Can be used for credits or debits."web" - Internet-Initiated Entry. The transfer debits a consumer’s bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits."tel" - Telephone-Initiated Entry. The transfer debits a consumer. Debit authorization has been received orally over the telephone via a recorded call.Possible values:
ccd, ppd, tel, webaccount_idstring
The Plaid
account_id corresponding to the end-user account that will be debited or credited.funding_account_idnullablestring
The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.
ledger_idnullablestring
Plaid’s unique identifier for a Plaid Ledger Balance.
typestring
The type of transfer. This will be either
debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.Possible values:
debit, credituserobject
The legal name and other information for the account holder.
legal_namestring
The user's legal name.
phone_numbernullablestring
The user's phone number.
email_addressnullablestring
The user's email address.
addressnullableobject
The address associated with the account holder.
streetnullablestring
The street number and name (i.e., "100 Market St.").
citynullablestring
Ex. "San Francisco"
regionnullablestring
The state or province (e.g., "CA").
postal_codenullablestring
The postal code (e.g., "94103").
countrynullablestring
A two-letter country code (e.g., "US").
amountstring
The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling
/transfer/authorization/create, specify the maximum amount to authorize. When calling /transfer/create, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling /transfer/create, the maximum amount authorized in the authorization_id will be sent.descriptionstring
The description of the transfer.
createdstring
The datetime when this transfer was created. This will be of the form
2006-01-02T15:04:05ZFormat:
date-time statusstring
The status of the transfer.
pending: A new transfer was created; it is in the pending state.
posted: The transfer has been successfully submitted to the payment network.
settled: The transfer was successfully completed by the payment network. Note that funds from received debits are not available to be moved out of the Ledger until the transfer reaches funds_available status. For credit transactions, settled means the funds have been delivered to the receiving bank account. This is the terminal state of a successful credit transfer.
funds_available: Funds from the transfer have been released from hold and applied to the ledger's available balance. (Only applicable to ACH debits.) This is the terminal state of a successful debit transfer.
cancelled: The transfer was cancelled by the client. This is the terminal state of a cancelled transfer.
failed: The transfer failed, no funds were moved. This is the terminal state of a failed transfer.
returned: A posted transfer was returned. This is the terminal state of a returned transfer.Possible values:
pending, posted, settled, funds_available, cancelled, failed, returnedsweep_statusnullablestring
The status of the sweep for the transfer.
unswept: The transfer hasn't been swept yet.
swept: The transfer was swept to the sweep account.
swept_settled: Credits are available to be withdrawn or debits have been deducted from the customer’s business checking account.
return_swept: The transfer was returned, funds were pulled back or pushed back to the sweep account.
null: The transfer will never be swept (e.g. if the transfer is cancelled or returned before being swept)Possible values:
null, unswept, swept, swept_settled, return_sweptnetworkstring
The network or rails used for the transfer.
For transfers submitted as
For transfers submitted as
For transfers submitted as
Wire transfers are currently in early availability. To request access to
For transfers submitted as
ach or same-day-ach, the next-day cutoff is 8:30 PM Eastern Time.For transfers submitted as
same-day-ach, the same-day cutoff is 3:30 PM Eastern Time. It is recommended to send the request 15 minutes prior to the cutoff to ensure that it will be processed in time for submission before the cutoff. If the transfer is processed after this cutoff but before the next-day cutoff, it will be sent over next-day rails and will not incur same-day charges; this will apply to both legs of the transfer if applicable. The transaction limit for a Same-day ACH transfer is $1,000,000. Authorization requests sent with an amount greater than $1,000,000 will fail.For transfers submitted as
rtp, Plaid will automatically route between Real Time Payment rail by TCH or FedNow rails as necessary. If a transfer is submitted as rtp and the counterparty account is not eligible for RTP, the /transfer/authorization/create request will fail with an INVALID_FIELD error code. To pre-check to determine whether a counterparty account can support RTP, call /transfer/capabilities/get before calling /transfer/authorization/create.Wire transfers are currently in early availability. To request access to
wire as a payment network, contact your Account Manager. For transfers submitted as wire, the type must be credit; wire debits are not supported. The cutoff to submit a wire payment is 4:30 PM Eastern Time on a business day; wires submitted after that time will be processed on the next business day. The transaction limit for a wire is $999,999.99. Authorization requests sent with an amount greater than $999,999.99 will fail.Possible values:
ach, same-day-ach, rtp, wirewire_detailsnullableobject
Information specific to wire transfers.
message_to_beneficiarynullablestring
Additional information from the wire originator to the beneficiary. Max 140 characters.
cancellableboolean
When
true, you can still cancel this transfer.failure_reasonnullableobject
The failure reason if the event type for a transfer is
"failed" or "returned". Null value otherwise.failure_codenullablestring
The failure code, e.g.
R01. A failure code will be provided if and only if the transfer status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.ach_return_codedeprecatednullablestring
The ACH return code, e.g.
R01. A return code will be provided if and only if the transfer status is returned. For a full listing of ACH return codes, see Transfer errors.descriptionstring
A human-readable description of the reason for the failure or reversal.
metadatanullableobject
The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
The JSON values must be Strings (no nested JSON objects allowed)
Only ASCII characters may be used
Maximum of 50 key/value pairs
Maximum key length of 40 characters
Maximum value length of 500 characters
iso_currency_codestring
The currency of the transfer amount, e.g. "USD"
standard_return_windownullablestring
The date 3 business days from settlement date indicating the following ACH returns can no longer happen: R01, R02, R03, R29. This will be of the form YYYY-MM-DD.
Format:
date unauthorized_return_window nullablestring
The date 61 business days from settlement date indicating the following ACH returns can no longer happen: R05, R07, R10, R11, R51, R33, R37, R38, R51, R52, R53. This will be of the form YYYY-MM-DD.
Format:
date expected_settlement_date nullablestring
The date when settlement will occur between Plaid and the receiving bank (RDFI). For ACH debits, this is the date funds will be pulled from the bank account being debited. For ACH credits, this is the date funds will be delivered to the bank account being credited. Only set for ACH transfers;
null for non-ACH transfers. This will be of the form YYYY-MM-DD.Format:
date expected_funds_available_date nullablestring
The expected date when funds from a transfer will be made available and can be withdrawn from the associated ledger balance, assuming the debit does not return before this date. If the transfer does return before this date, this field will be null. Only applies to debit transfers. This will be of the form YYYY-MM-DD.
Format:
date originator_client_idnullablestring
The Plaid client ID that is the originator of this transfer. Only present if created on behalf of another client as a Platform customer.
refunds[object]
A list of refunds associated with this transfer.
idstring
Plaid’s unique identifier for a refund.
transfer_idstring
The ID of the transfer to refund.
amountstring
The amount of the refund (decimal string with two digits of precision e.g. "10.00").
statusstring
The status of the refund.
pending: A new refund was created; it is in the pending state.
posted: The refund has been successfully submitted to the payment network.
settled: Credits have been refunded to the Plaid linked account.
cancelled: The refund was cancelled by the client.
failed: The refund has failed.
returned: The refund was returned.Possible values:
pending, posted, cancelled, failed, settled, returnedfailure_reasonnullableobject
The failure reason if the event type for a refund is
"failed" or "returned". Null value otherwise.failure_codenullablestring
The failure code, e.g.
R01. A failure code will be provided if and only if the refund status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.ach_return_codedeprecatednullablestring
The ACH return code, e.g.
R01. A return code will be provided if and only if the refund status is returned. For a full listing of ACH return codes, see Transfer errors. This field is deprecated in favor of the more versatile failure_code, which encompasses non-ACH failure codes as well.descriptionstring
A human-readable description of the reason for the failure or reversal.
ledger_idnullablestring
Plaid’s unique identifier for a Plaid Ledger Balance.
createdstring
The datetime when this refund was created. This will be of the form
2006-01-02T15:04:05ZFormat:
date-time network_trace_idnullablestring
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted.
For
For
ach or same-day-ach transfers, this is the ACH trace number.
For rtp transfers, this is the Transaction Identification number.
For wire transfers, this is the IMAD (Input Message Accountability Data) number.recurring_transfer_idnullablestring
The id of the recurring transfer if this transfer belongs to a recurring transfer.
expected_sweep_settlement_schedule [object]
The expected sweep settlement schedule of this transfer, assuming this transfer is not
returned. Only applies to ACH debit transfers.sweep_settlement_datestring
The settlement date of a sweep for this transfer.
Format:
date swept_settled_amountstring
The accumulated amount that has been swept by
sweep_settlement_date.credit_funds_sourcedeprecatednullablestring
This field is now deprecated. You may ignore it for transfers created on and after 12/01/2023.
Specifies the source of funds for the transfer. Only valid for
Specifies the source of funds for the transfer. Only valid for
credit transfers, and defaults to sweep if not specified. This field is not specified for debit transfers.sweep - Sweep funds from your funding account
prefunded_rtp_credits - Use your prefunded RTP credit balance with Plaid
prefunded_ach_credits - Use your prefunded ACH credit balance with PlaidPossible values:
sweep, prefunded_rtp_credits, prefunded_ach_credits, nullfacilitator_feestring
The amount to deduct from
transfer.amount and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g. "10.00"). The remainder will go to the end-customer’s Ledger balance. This must be value greater than 0 and less than or equal to the transfer.amount.network_trace_idnullablestring
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted.
For
For
ach or same-day-ach transfers, this is the ACH trace number.
For rtp transfers, this is the Transaction Identification number.
For wire transfers, this is the IMAD (Input Message Accountability Data) number.request_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "transfer": {3 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",4 "funding_account_id": "8945fedc-e703-463d-86b1-dc0607b55460",5 "ledger_id": "563db5f8-4c95-4e17-8c3e-cb988fb9cf1a",6 "ach_class": "ppd",7 "amount": "12.34",8 "cancellable": true,9 "created": "2020-08-06T17:27:15Z",10 "description": "Desc",11 "guarantee_decision": null,12 "guarantee_decision_rationale": null,13 "failure_reason": {14 "failure_code": "R13",15 "description": "Invalid ACH routing number"16 },17 "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",18 "authorization_id": "c9f90aa1-2949-c799-e2b6-ea05c89bb586",19 "metadata": {20 "key1": "value1",21 "key2": "value2"22 },23 "network": "ach",24 "origination_account_id": "",25 "originator_client_id": null,26 "refunds": [],27 "status": "pending",28 "type": "credit",29 "iso_currency_code": "USD",30 "standard_return_window": "2020-08-07",31 "unauthorized_return_window": "2020-10-07",32 "expected_settlement_date": "2020-08-04",33 "user": {34 "email_address": "acharleston@email.com",35 "legal_name": "Anne Charleston",36 "phone_number": "510-555-0128",37 "address": {38 "street": "123 Main St.",39 "city": "San Francisco",40 "region": "CA",41 "postal_code": "94053",42 "country": "US"43 }44 },45 "recurring_transfer_id": null,46 "credit_funds_source": "sweep",47 "facilitator_fee": "1.23",48 "network_trace_id": null49 },50 "request_id": "saKrIBuEB9qJZno"51}/transfer/list
List transfers
Use the /transfer/list endpoint to see a list of all your transfers and their statuses. Results are paginated; use the count and offset query parameters to retrieve the desired transfers.
Request fields
client_idstring
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.secretstring
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_datestring
The start
created datetime of transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)Format:
date-time end_datestring
The end
created datetime of transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)Format:
date-time countinteger
The maximum number of transfers to return.
Minimum:
1 Maximum:
25 Default:
25 offsetinteger
The number of transfers to skip before returning results.
Default:
0 Minimum:
0 originator_client_idstring
Filter transfers to only those with the specified originator client.
funding_account_idstring
Filter transfers to only those with the specified
funding_account_id.1const request: TransferListRequest = {2 start_date: '2019-12-06T22:35:49Z',3 end_date: '2019-12-12T22:35:49Z',4 count: 14,5 offset: 2,6 origination_account_id: '8945fedc-e703-463d-86b1-dc0607b55460',7};8try {9 const response = await plaidClient.transferList(request);10 const transfers = response.data.transfers;11 for (const transfer of transfers) {12 // iterate through transfers13 }14} catch (error) {15 // handle error16}Response fields and example
transfers[object]
idstring
Plaid’s unique identifier for a transfer.
authorization_idstring
Plaid’s unique identifier for a transfer authorization.
ach_classstring
Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see ACH SEC codes.
Codes supported for credits:
Codes supported for credits:
ccd, ppd
Codes supported for debits: ccd, tel, web"ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts"ppd" - Prearranged Payment or Deposit - The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained in writing either in person or via an electronic document signing, e.g. Docusign, by the consumer. Can be used for credits or debits."web" - Internet-Initiated Entry. The transfer debits a consumer’s bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits."tel" - Telephone-Initiated Entry. The transfer debits a consumer. Debit authorization has been received orally over the telephone via a recorded call.Possible values:
ccd, ppd, tel, webaccount_idstring
The Plaid
account_id corresponding to the end-user account that will be debited or credited.funding_account_idnullablestring
The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.
ledger_idnullablestring
Plaid’s unique identifier for a Plaid Ledger Balance.
typestring
The type of transfer. This will be either
debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.Possible values:
debit, credituserobject
The legal name and other information for the account holder.
legal_namestring
The user's legal name.
phone_numbernullablestring
The user's phone number.
email_addressnullablestring
The user's email address.
addressnullableobject
The address associated with the account holder.
streetnullablestring
The street number and name (i.e., "100 Market St.").
citynullablestring
Ex. "San Francisco"
regionnullablestring
The state or province (e.g., "CA").
postal_codenullablestring
The postal code (e.g., "94103").
countrynullablestring
A two-letter country code (e.g., "US").
amountstring
The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling
/transfer/authorization/create, specify the maximum amount to authorize. When calling /transfer/create, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling /transfer/create, the maximum amount authorized in the authorization_id will be sent.descriptionstring
The description of the transfer.
createdstring
The datetime when this transfer was created. This will be of the form
2006-01-02T15:04:05ZFormat:
date-time statusstring
The status of the transfer.
pending: A new transfer was created; it is in the pending state.
posted: The transfer has been successfully submitted to the payment network.
settled: The transfer was successfully completed by the payment network. Note that funds from received debits are not available to be moved out of the Ledger until the transfer reaches funds_available status. For credit transactions, settled means the funds have been delivered to the receiving bank account. This is the terminal state of a successful credit transfer.
funds_available: Funds from the transfer have been released from hold and applied to the ledger's available balance. (Only applicable to ACH debits.) This is the terminal state of a successful debit transfer.
cancelled: The transfer was cancelled by the client. This is the terminal state of a cancelled transfer.
failed: The transfer failed, no funds were moved. This is the terminal state of a failed transfer.
returned: A posted transfer was returned. This is the terminal state of a returned transfer.Possible values:
pending, posted, settled, funds_available, cancelled, failed, returnedsweep_statusnullablestring
The status of the sweep for the transfer.
unswept: The transfer hasn't been swept yet.
swept: The transfer was swept to the sweep account.
swept_settled: Credits are available to be withdrawn or debits have been deducted from the customer’s business checking account.
return_swept: The transfer was returned, funds were pulled back or pushed back to the sweep account.
null: The transfer will never be swept (e.g. if the transfer is cancelled or returned before being swept)Possible values:
null, unswept, swept, swept_settled, return_sweptnetworkstring
The network or rails used for the transfer.
For transfers submitted as
For transfers submitted as
For transfers submitted as
Wire transfers are currently in early availability. To request access to
For transfers submitted as
ach or same-day-ach, the next-day cutoff is 8:30 PM Eastern Time.For transfers submitted as
same-day-ach, the same-day cutoff is 3:30 PM Eastern Time. It is recommended to send the request 15 minutes prior to the cutoff to ensure that it will be processed in time for submission before the cutoff. If the transfer is processed after this cutoff but before the next-day cutoff, it will be sent over next-day rails and will not incur same-day charges; this will apply to both legs of the transfer if applicable. The transaction limit for a Same-day ACH transfer is $1,000,000. Authorization requests sent with an amount greater than $1,000,000 will fail.For transfers submitted as
rtp, Plaid will automatically route between Real Time Payment rail by TCH or FedNow rails as necessary. If a transfer is submitted as rtp and the counterparty account is not eligible for RTP, the /transfer/authorization/create request will fail with an INVALID_FIELD error code. To pre-check to determine whether a counterparty account can support RTP, call /transfer/capabilities/get before calling /transfer/authorization/create.Wire transfers are currently in early availability. To request access to
wire as a payment network, contact your Account Manager. For transfers submitted as wire, the type must be credit; wire debits are not supported. The cutoff to submit a wire payment is 4:30 PM Eastern Time on a business day; wires submitted after that time will be processed on the next business day. The transaction limit for a wire is $999,999.99. Authorization requests sent with an amount greater than $999,999.99 will fail.Possible values:
ach, same-day-ach, rtp, wirewire_detailsnullableobject
Information specific to wire transfers.
message_to_beneficiarynullablestring
Additional information from the wire originator to the beneficiary. Max 140 characters.
cancellableboolean
When
true, you can still cancel this transfer.failure_reasonnullableobject
The failure reason if the event type for a transfer is
"failed" or "returned". Null value otherwise.failure_codenullablestring
The failure code, e.g.
R01. A failure code will be provided if and only if the transfer status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.ach_return_codedeprecatednullablestring
The ACH return code, e.g.
R01. A return code will be provided if and only if the transfer status is returned. For a full listing of ACH return codes, see Transfer errors.descriptionstring
A human-readable description of the reason for the failure or reversal.
metadatanullableobject
The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
The JSON values must be Strings (no nested JSON objects allowed)
Only ASCII characters may be used
Maximum of 50 key/value pairs
Maximum key length of 40 characters
Maximum value length of 500 characters
iso_currency_codestring
The currency of the transfer amount, e.g. "USD"
standard_return_windownullablestring
The date 3 business days from settlement date indicating the following ACH returns can no longer happen: R01, R02, R03, R29. This will be of the form YYYY-MM-DD.
Format:
date unauthorized_return_window nullablestring
The date 61 business days from settlement date indicating the following ACH returns can no longer happen: R05, R07, R10, R11, R51, R33, R37, R38, R51, R52, R53. This will be of the form YYYY-MM-DD.
Format:
date expected_settlement_date nullablestring
The date when settlement will occur between Plaid and the receiving bank (RDFI). For ACH debits, this is the date funds will be pulled from the bank account being debited. For ACH credits, this is the date funds will be delivered to the bank account being credited. Only set for ACH transfers;
null for non-ACH transfers. This will be of the form YYYY-MM-DD.Format:
date expected_funds_available_date nullablestring
The expected date when funds from a transfer will be made available and can be withdrawn from the associated ledger balance, assuming the debit does not return before this date. If the transfer does return before this date, this field will be null. Only applies to debit transfers. This will be of the form YYYY-MM-DD.
Format:
date originator_client_idnullablestring
The Plaid client ID that is the originator of this transfer. Only present if created on behalf of another client as a Platform customer.
refunds[object]
A list of refunds associated with this transfer.
idstring
Plaid’s unique identifier for a refund.
transfer_idstring
The ID of the transfer to refund.
amountstring
The amount of the refund (decimal string with two digits of precision e.g. "10.00").
statusstring
The status of the refund.
pending: A new refund was created; it is in the pending state.
posted: The refund has been successfully submitted to the payment network.
settled: Credits have been refunded to the Plaid linked account.
cancelled: The refund was cancelled by the client.
failed: The refund has failed.
returned: The refund was returned.Possible values:
pending, posted, cancelled, failed, settled, returnedfailure_reasonnullableobject
The failure reason if the event type for a refund is
"failed" or "returned". Null value otherwise.failure_codenullablestring
The failure code, e.g.
R01. A failure code will be provided if and only if the refund status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.ach_return_codedeprecatednullablestring
The ACH return code, e.g.
R01. A return code will be provided if and only if the refund status is returned. For a full listing of ACH return codes, see Transfer errors. This field is deprecated in favor of the more versatile failure_code, which encompasses non-ACH failure codes as well.descriptionstring
A human-readable description of the reason for the failure or reversal.
ledger_idnullablestring
Plaid’s unique identifier for a Plaid Ledger Balance.
createdstring
The datetime when this refund was created. This will be of the form
2006-01-02T15:04:05ZFormat:
date-time network_trace_idnullablestring
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted.
For
For
ach or same-day-ach transfers, this is the ACH trace number.
For rtp transfers, this is the Transaction Identification number.
For wire transfers, this is the IMAD (Input Message Accountability Data) number.recurring_transfer_idnullablestring
The id of the recurring transfer if this transfer belongs to a recurring transfer.
expected_sweep_settlement_schedule [object]
The expected sweep settlement schedule of this transfer, assuming this transfer is not
returned. Only applies to ACH debit transfers.sweep_settlement_datestring
The settlement date of a sweep for this transfer.
Format:
date swept_settled_amountstring
The accumulated amount that has been swept by
sweep_settlement_date.credit_funds_sourcedeprecatednullablestring
This field is now deprecated. You may ignore it for transfers created on and after 12/01/2023.
Specifies the source of funds for the transfer. Only valid for
Specifies the source of funds for the transfer. Only valid for
credit transfers, and defaults to sweep if not specified. This field is not specified for debit transfers.sweep - Sweep funds from your funding account
prefunded_rtp_credits - Use your prefunded RTP credit balance with Plaid
prefunded_ach_credits - Use your prefunded ACH credit balance with PlaidPossible values:
sweep, prefunded_rtp_credits, prefunded_ach_credits, nullfacilitator_feestring
The amount to deduct from
transfer.amount and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g. "10.00"). The remainder will go to the end-customer’s Ledger balance. This must be value greater than 0 and less than or equal to the transfer.amount.network_trace_idnullablestring
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted.
For
For
ach or same-day-ach transfers, this is the ACH trace number.
For rtp transfers, this is the Transaction Identification number.
For wire transfers, this is the IMAD (Input Message Accountability Data) number.request_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "transfers": [3 {4 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",5 "funding_account_id": "8945fedc-e703-463d-86b1-dc0607b55460",6 "ledger_id": "563db5f8-4c95-4e17-8c3e-cb988fb9cf1a",7 "ach_class": "ppd",8 "amount": "12.34",9 "cancellable": true,10 "created": "2019-12-09T17:27:15Z",11 "description": "Desc",12 "guarantee_decision": null,13 "guarantee_decision_rationale": null,14 "failure_reason": {15 "failure_code": "R13",16 "description": "Invalid ACH routing number"17 },18 "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",19 "authorization_id": "c9f90aa1-2949-c799-e2b6-ea05c89bb586",20 "metadata": {21 "key1": "value1",22 "key2": "value2"23 },24 "network": "ach",25 "origination_account_id": "",26 "originator_client_id": null,27 "refunds": [],28 "status": "pending",29 "type": "credit",30 "iso_currency_code": "USD",31 "standard_return_window": "2020-08-07",32 "unauthorized_return_window": "2020-10-07",33 "expected_settlement_date": "2020-08-04",34 "user": {35 "email_address": "acharleston@email.com",36 "legal_name": "Anne Charleston",37 "phone_number": "510-555-0128",38 "address": {39 "street": "123 Main St.",40 "city": "San Francisco",41 "region": "CA",42 "postal_code": "94053",43 "country": "US"44 }45 },46 "recurring_transfer_id": null,47 "credit_funds_source": "sweep",48 "facilitator_fee": "1.23",49 "network_trace_id": null50 }51 ],52 "request_id": "saKrIBuEB9qJZno"53}/transfer/event/list
List transfer events
Use the /transfer/event/list endpoint to get a list of transfer events based on specified filter criteria.
Request fields
client_idstring
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.secretstring
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_datestring
The start
created datetime of transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)Format:
date-time end_datestring
The end
created datetime of transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)Format:
date-time transfer_idstring
Plaid’s unique identifier for a transfer.
account_idstring
The account ID to get events for all transactions to/from an account.
transfer_typestring
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.Possible values:
debit, credit, nullevent_types[string]
Filter events by event type.
Possible values:
pending, cancelled, failed, posted, settled, funds_available, returned, swept, swept_settled, return_swept, sweep.pending, sweep.posted, sweep.settled, sweep.returned, sweep.failed, sweep.funds_available, refund.pending, refund.cancelled, refund.failed, refund.posted, refund.settled, refund.returned, refund.swept, refund.return_sweptsweep_idstring
Plaid’s unique identifier for a sweep.
countinteger
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.Default:
25 Maximum:
25 Minimum:
1 offsetinteger
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 events will be returned.Default:
0 Minimum:
0 originator_client_idstring
Filter transfer events to only those with the specified originator client.
funding_account_idstring
Filter transfer events to only those with the specified
funding_account_id.1const request: TransferEventListRequest = {2 start_date: '2019-12-06T22:35:49Z',3 end_date: '2019-12-12T22:35:49Z',4 transfer_id: '460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9',5 account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',6 transfer_type: 'credit',7 event_types: ['pending', 'posted'],8 count: 14,9 offset: 2,10 origination_account_id: '8945fedc-e703-463d-86b1-dc0607b55460',11};12try {13 const response = await plaidClient.transferEventList(request);14 const events = response.data.transfer_events;15 for (const event of events) {16 // iterate through events17 }18} catch (error) {19 // handle error20}Response fields and example
transfer_events[object]
event_idinteger
Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
Minimum:
0 timestampstring
The datetime when this event occurred. This will be of the form
2006-01-02T15:04:05Z.Format:
date-time event_typestring
The type of event that this transfer represents. Event types with prefix
sweep represents events for Plaid Ledger sweeps.pending: A new transfer was created; it is in the pending state.cancelled: The transfer was cancelled by the client.failed: The transfer failed, no funds were moved.posted: The transfer has been successfully submitted to the payment network.settled: The transfer has been successfully completed by the payment network.funds_available: Funds from the transfer have been released from hold and applied to the ledger's available balance. (Only applicable to ACH debits.)returned: A posted transfer was returned.swept: The transfer was swept to / from the sweep account.swept_settled: Credits are available to be withdrawn or debits have been deducted from the customer’s business checking account.return_swept: Due to the transfer being returned, funds were pulled from or pushed back to the sweep account.sweep.pending: A new ledger sweep was created; it is in the pending state.sweep.posted: The ledger sweep has been successfully submitted to the payment network.sweep.settled: The transaction has settled in the funding account. This means that funds withdrawn from Plaid Ledger balance have reached the funding account, or funds to be deposited into the Plaid Ledger Balance have been pulled, and the hold period has begun.sweep.returned: A posted ledger sweep was returned.sweep.failed: The ledger sweep failed, no funds were moved.sweep.funds_available: Funds from the ledger sweep have been released from hold and applied to the ledger's available balance. This is only applicable to debits.refund.pending: A new refund was created; it is in the pending state.refund.cancelled: The refund was cancelled.refund.failed: The refund failed, no funds were moved.refund.posted: The refund has been successfully submitted to the payment network.refund.settled: The refund transaction has settled in the Plaid linked account.refund.returned: A posted refund was returned.refund.swept: The refund was swept from the sweep account.refund.return_swept: Due to the refund being returned, funds were pushed back to the sweep account.Possible values:
pending, cancelled, failed, posted, settled, funds_available, returned, swept, swept_settled, return_swept, sweep.pending, sweep.posted, sweep.settled, sweep.returned, sweep.failed, sweep.funds_available, refund.pending, refund.cancelled, refund.failed, refund.posted, refund.settled, refund.returned, refund.swept, refund.return_sweptaccount_idstring
The account ID associated with the transfer. This field is omitted for Plaid Ledger Sweep events.
funding_account_idnullablestring
The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.
ledger_idnullablestring
Plaid’s unique identifier for a Plaid Ledger Balance.
transfer_idstring
Plaid's unique identifier for a transfer. This field is an empty string for Plaid Ledger Sweep events.
transfer_typestring
The type of transfer. Valid values are
debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account. This field is omitted for Plaid Ledger Sweep events.Possible values:
debit, credittransfer_amountstring
The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). This field is omitted for Plaid Ledger Sweep events.
failure_reasonnullableobject
The failure reason if the event type for a transfer is
"failed" or "returned". Null value otherwise.failure_codenullablestring
The failure code, e.g.
R01. A failure code will be provided if and only if the transfer status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.ach_return_codedeprecatednullablestring
The ACH return code, e.g.
R01. A return code will be provided if and only if the transfer status is returned. For a full listing of ACH return codes, see Transfer errors.descriptionstring
A human-readable description of the reason for the failure or reversal.
sweep_idnullablestring
Plaid’s unique identifier for a sweep.
sweep_amountnullablestring
A signed amount of how much was
swept or return_swept for this transfer (decimal string with two digits of precision e.g. "-5.50").refund_idnullablestring
Plaid’s unique identifier for a refund. A non-null value indicates the event is for the associated refund of the transfer.
originator_client_idnullablestring
The Plaid client ID that is the originator of the transfer that this event applies to. Only present if the transfer was created on behalf of another client as a third-party sender (TPS).
intent_idnullablestring
The
id returned by the /transfer/intent/create endpoint, for transfers created via Transfer UI. For transfers not created by Transfer UI, the value is null. This will currently only be populated for RfP transfers.has_moreboolean
Whether there are more events to be pulled from the endpoint that have not already been returned
request_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "transfer_events": [3 {4 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",5 "funding_account_id": "8945fedc-e703-463d-86b1-dc0607b55460",6 "ledger_id": "563db5f8-4c95-4e17-8c3e-cb988fb9cf1a",7 "transfer_amount": "12.34",8 "transfer_id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",9 "transfer_type": "credit",10 "event_id": 1,11 "event_type": "posted",12 "failure_reason": null,13 "origination_account_id": "",14 "originator_client_id": "569ed2f36b3a3a021713abc1",15 "refund_id": null,16 "sweep_amount": null,17 "sweep_id": null,18 "timestamp": "2019-12-09T17:27:15Z"19 }20 ],21 "has_more": true,22 "request_id": "mdqfuVxeoza6mhu"23}/transfer/event/sync
Sync transfer events
/transfer/event/sync allows you to request up to the next 25 transfer events that happened after a specific event_id. Use the /transfer/event/sync endpoint to guarantee you have seen all transfer events.
Request fields
client_idstring
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.secretstring
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.after_idrequiredinteger
The latest (largest)
event_id fetched via the sync endpoint, or 0 initially.Minimum:
0 countinteger
The maximum number of transfer events to return.
Default:
25 Minimum:
1 Maximum:
25 1const request: TransferEventListRequest = {2 after_id: 4,3 count: 22,4};5try {6 const response = await plaidClient.transferEventSync(request);7 const events = response.data.transfer_events;8 for (const event of events) {9 // iterate through events10 }11} catch (error) {12 // handle error13}Response fields and example
transfer_events[object]
event_idinteger
Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
Minimum:
0 timestampstring
The datetime when this event occurred. This will be of the form
2006-01-02T15:04:05Z.Format:
date-time event_typestring
The type of event that this transfer represents. Event types with prefix
sweep represents events for Plaid Ledger sweeps.pending: A new transfer was created; it is in the pending state.cancelled: The transfer was cancelled by the client.failed: The transfer failed, no funds were moved.posted: The transfer has been successfully submitted to the payment network.settled: The transfer has been successfully completed by the payment network.funds_available: Funds from the transfer have been released from hold and applied to the ledger's available balance. (Only applicable to ACH debits.)returned: A posted transfer was returned.swept: The transfer was swept to / from the sweep account.swept_settled: Credits are available to be withdrawn or debits have been deducted from the customer’s business checking account.return_swept: Due to the transfer being returned, funds were pulled from or pushed back to the sweep account.sweep.pending: A new ledger sweep was created; it is in the pending state.sweep.posted: The ledger sweep has been successfully submitted to the payment network.sweep.settled: The transaction has settled in the funding account. This means that funds withdrawn from Plaid Ledger balance have reached the funding account, or funds to be deposited into the Plaid Ledger Balance have been pulled, and the hold period has begun.sweep.returned: A posted ledger sweep was returned.sweep.failed: The ledger sweep failed, no funds were moved.sweep.funds_available: Funds from the ledger sweep have been released from hold and applied to the ledger's available balance. This is only applicable to debits.refund.pending: A new refund was created; it is in the pending state.refund.cancelled: The refund was cancelled.refund.failed: The refund failed, no funds were moved.refund.posted: The refund has been successfully submitted to the payment network.refund.settled: The refund transaction has settled in the Plaid linked account.refund.returned: A posted refund was returned.refund.swept: The refund was swept from the sweep account.refund.return_swept: Due to the refund being returned, funds were pushed back to the sweep account.Possible values:
pending, cancelled, failed, posted, settled, funds_available, returned, swept, swept_settled, return_swept, sweep.pending, sweep.posted, sweep.settled, sweep.returned, sweep.failed, sweep.funds_available, refund.pending, refund.cancelled, refund.failed, refund.posted, refund.settled, refund.returned, refund.swept, refund.return_sweptaccount_idstring
The account ID associated with the transfer. This field is omitted for Plaid Ledger Sweep events.
funding_account_idnullablestring
The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.
ledger_idnullablestring
Plaid’s unique identifier for a Plaid Ledger Balance.
transfer_idstring
Plaid's unique identifier for a transfer. This field is an empty string for Plaid Ledger Sweep events.
transfer_typestring
The type of transfer. Valid values are
debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account. This field is omitted for Plaid Ledger Sweep events.Possible values:
debit, credittransfer_amountstring
The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). This field is omitted for Plaid Ledger Sweep events.
failure_reasonnullableobject
The failure reason if the event type for a transfer is
"failed" or "returned". Null value otherwise.failure_codenullablestring
The failure code, e.g.
R01. A failure code will be provided if and only if the transfer status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.ach_return_codedeprecatednullablestring
The ACH return code, e.g.
R01. A return code will be provided if and only if the transfer status is returned. For a full listing of ACH return codes, see Transfer errors.descriptionstring
A human-readable description of the reason for the failure or reversal.
sweep_idnullablestring
Plaid’s unique identifier for a sweep.
sweep_amountnullablestring
A signed amount of how much was
swept or return_swept for this transfer (decimal string with two digits of precision e.g. "-5.50").refund_idnullablestring
Plaid’s unique identifier for a refund. A non-null value indicates the event is for the associated refund of the transfer.
originator_client_idnullablestring
The Plaid client ID that is the originator of the transfer that this event applies to. Only present if the transfer was created on behalf of another client as a third-party sender (TPS).
intent_idnullablestring
The
id returned by the /transfer/intent/create endpoint, for transfers created via Transfer UI. For transfers not created by Transfer UI, the value is null. This will currently only be populated for RfP transfers.has_moreboolean
Whether there are more events to be pulled from the endpoint that have not already been returned
request_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "transfer_events": [3 {4 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",5 "funding_account_id": "8945fedc-e703-463d-86b1-dc0607b55460",6 "ledger_id": "563db5f8-4c95-4e17-8c3e-cb988fb9cf1a",7 "transfer_amount": "12.34",8 "transfer_id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",9 "transfer_type": "credit",10 "event_id": 1,11 "event_type": "pending",12 "failure_reason": null,13 "origination_account_id": "",14 "originator_client_id": null,15 "refund_id": null,16 "sweep_amount": null,17 "sweep_id": null,18 "timestamp": "2019-12-09T17:27:15Z"19 }20 ],21 "has_more": true,22 "request_id": "mdqfuVxeoza6mhu"23}/transfer/sweep/get
Retrieve a sweep
The /transfer/sweep/get endpoint fetches a sweep corresponding to the given sweep_id.
Request fields
client_idstring
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.secretstring
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.sweep_idrequiredstring
Plaid's unique identifier for the sweep (UUID) or a shortened form consisting of the first 8 characters of the identifier (8-digit hexadecimal string).
1const request: TransferSweepGetRequest = {2 sweep_id: '8c2fda9a-aa2f-4735-a00f-f4e0d2d2faee',3};4try {5 const response = await plaidClient.transferSweepGet(request);6 const sweep = response.data.sweep;7} catch (error) {8 // handle error9}Response fields and example
sweepobject
Describes a sweep of funds to / from the sweep account.
A sweep is associated with many sweep events (events of type
The total sum of the
A sweep is associated with many sweep events (events of type
swept or return_swept) which can be retrieved by invoking the /transfer/event/list endpoint with the corresponding sweep_id.swept events occur when the transfer amount is credited or debited from your sweep account, depending on the type of the transfer. return_swept events occur when a transfer is returned and Plaid undoes the credit or debit.The total sum of the
swept and return_swept events is equal to the amount of the sweep Plaid creates and matches the amount of the entry on your sweep account ledger.idstring
Identifier of the sweep.
funding_account_idstring
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.
ledger_idnullablestring
Plaid’s unique identifier for a Plaid Ledger Balance.
createdstring
The datetime when the sweep occurred, in RFC 3339 format.
Format:
date-time amountstring
Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. "-10.00")
If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.
If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.
iso_currency_codestring
The currency of the sweep, e.g. "USD".
settlednullablestring
The date when the sweep settled, in the YYYY-MM-DD format.
Format:
date expected_funds_available_date nullablestring
The expected date when funds from a ledger deposit will be made available and can be withdrawn from the associated ledger balance. Only applies to deposits. This will be of the form YYYY-MM-DD.
Format:
date statusnullablestring
The status of a sweep transfer
"pending" - The sweep is currently pending
"posted" - The sweep has been posted
"settled" - The sweep has settled. This is the terminal state of a successful credit sweep.
"returned" - The sweep has been returned. This is the terminal state of a returned sweep. Returns of a sweep are extremely rare, since sweeps are money movement between your own bank account and your own Ledger.
"funds_available" - Funds from the sweep have been released from hold and applied to the ledger's available balance. (Only applicable to deposits.) This is the terminal state of a successful deposit sweep.
"failed" - The sweep has failed. This is the terminal state of a failed sweep.Possible values:
pending, posted, settled, funds_available, returned, failed, nulltriggernullablestring
The trigger of the sweep
"manual" - The sweep is created manually by the customer
"incoming" - The sweep is created by incoming funds flow (e.g. Incoming Wire)
"balance_threshold" - The sweep is created by balance threshold setting
"automatic_aggregate" - The sweep is created by the Plaid automatic aggregation process. These funds did not pass through the Plaid Ledger balance.Possible values:
manual, incoming, balance_threshold, automatic_aggregatedescriptionstring
The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.
network_trace_idnullablestring
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted.
For
For
ach or same-day-ach transfers, this is the ACH trace number.
For rtp transfers, this is the Transaction Identification number.
For wire transfers, this is the IMAD (Input Message Accountability Data) number.failure_reasonnullableobject
The failure reason if the status for a sweep is
"failed" or "returned". Null value otherwise.failure_codenullablestring
The failure code, e.g.
R01. A failure code will be provided if and only if the sweep status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.descriptionnullablestring
A human-readable description of the reason for the failure or reversal.
request_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "sweep": {3 "id": "8c2fda9a-aa2f-4735-a00f-f4e0d2d2faee",4 "funding_account_id": "8945fedc-e703-463d-86b1-dc0607b55460",5 "ledger_id": "563db5f8-4c95-4e17-8c3e-cb988fb9cf1a",6 "created": "2020-08-06T17:27:15Z",7 "amount": "12.34",8 "iso_currency_code": "USD",9 "settled": "2020-08-07",10 "status": "settled",11 "network_trace_id": "123456789012345"12 },13 "request_id": "saKrIBuEB9qJZno"14}/transfer/sweep/list
List sweeps
The /transfer/sweep/list endpoint fetches sweeps matching the given filters.
Request fields
client_idstring
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.secretstring
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_datestring
The start
created datetime of sweeps to return (RFC 3339 format).Format:
date-time end_datestring
The end
created datetime of sweeps to return (RFC 3339 format).Format:
date-time countinteger
The maximum number of sweeps to return.
Minimum:
1 Maximum:
25 Default:
25 offsetinteger
The number of sweeps to skip before returning results.
Default:
0 Minimum:
0 amountstring
Filter sweeps to only those with the specified amount.
statusstring
The status of a sweep transfer
"pending" - The sweep is currently pending
"posted" - The sweep has been posted
"settled" - The sweep has settled. This is the terminal state of a successful credit sweep.
"returned" - The sweep has been returned. This is the terminal state of a returned sweep. Returns of a sweep are extremely rare, since sweeps are money movement between your own bank account and your own Ledger.
"funds_available" - Funds from the sweep have been released from hold and applied to the ledger's available balance. (Only applicable to deposits.) This is the terminal state of a successful deposit sweep.
"failed" - The sweep has failed. This is the terminal state of a failed sweep.Possible values:
pending, posted, settled, funds_available, returned, failed, nulloriginator_client_idstring
Filter sweeps to only those with the specified originator client.
funding_account_idstring
Filter sweeps to only those with the specified
funding_account_id.transfer_idstring
Filter sweeps to only those with the included
transfer_id.triggerstring
The trigger of the sweep
"manual" - The sweep is created manually by the customer
"incoming" - The sweep is created by incoming funds flow (e.g. Incoming Wire)
"balance_threshold" - The sweep is created by balance threshold setting
"automatic_aggregate" - The sweep is created by the Plaid automatic aggregation process. These funds did not pass through the Plaid Ledger balance.Possible values:
manual, incoming, balance_threshold, automatic_aggregate1const request: TransferSweepListRequest = {2 start_date: '2019-12-06T22:35:49Z',3 end_date: '2019-12-12T22:35:49Z',4 count: 14,5 offset: 2,6};7try {8 const response = await plaidClient.transferSweepList(request);9 const sweeps = response.data.sweeps;10 for (const sweep of sweeps) {11 // iterate through sweeps12 }13} catch (error) {14 // handle error15}Response fields and example
sweeps[object]
idstring
Identifier of the sweep.
funding_account_idstring
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.
ledger_idnullablestring
Plaid’s unique identifier for a Plaid Ledger Balance.
createdstring
The datetime when the sweep occurred, in RFC 3339 format.
Format:
date-time amountstring
Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. "-10.00")
If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.
If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.
iso_currency_codestring
The currency of the sweep, e.g. "USD".
settlednullablestring
The date when the sweep settled, in the YYYY-MM-DD format.
Format:
date expected_funds_available_date nullablestring
The expected date when funds from a ledger deposit will be made available and can be withdrawn from the associated ledger balance. Only applies to deposits. This will be of the form YYYY-MM-DD.
Format:
date statusnullablestring
The status of a sweep transfer
"pending" - The sweep is currently pending
"posted" - The sweep has been posted
"settled" - The sweep has settled. This is the terminal state of a successful credit sweep.
"returned" - The sweep has been returned. This is the terminal state of a returned sweep. Returns of a sweep are extremely rare, since sweeps are money movement between your own bank account and your own Ledger.
"funds_available" - Funds from the sweep have been released from hold and applied to the ledger's available balance. (Only applicable to deposits.) This is the terminal state of a successful deposit sweep.
"failed" - The sweep has failed. This is the terminal state of a failed sweep.Possible values:
pending, posted, settled, funds_available, returned, failed, nulltriggernullablestring
The trigger of the sweep
"manual" - The sweep is created manually by the customer
"incoming" - The sweep is created by incoming funds flow (e.g. Incoming Wire)
"balance_threshold" - The sweep is created by balance threshold setting
"automatic_aggregate" - The sweep is created by the Plaid automatic aggregation process. These funds did not pass through the Plaid Ledger balance.Possible values:
manual, incoming, balance_threshold, automatic_aggregatedescriptionstring
The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.
network_trace_idnullablestring
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted.
For
For
ach or same-day-ach transfers, this is the ACH trace number.
For rtp transfers, this is the Transaction Identification number.
For wire transfers, this is the IMAD (Input Message Accountability Data) number.failure_reasonnullableobject
The failure reason if the status for a sweep is
"failed" or "returned". Null value otherwise.failure_codenullablestring
The failure code, e.g.
R01. A failure code will be provided if and only if the sweep status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.descriptionnullablestring
A human-readable description of the reason for the failure or reversal.
request_idstring
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{2 "sweeps": [3 {4 "id": "d5394a4d-0b04-4a02-9f4a-7ca5c0f52f9d",5 "funding_account_id": "8945fedc-e703-463d-86b1-dc0607b55460",6 "ledger_id": "563db5f8-4c95-4e17-8c3e-cb988fb9cf1a",7 "created": "2019-12-09T17:27:15Z",8 "amount": "-12.34",9 "iso_currency_code": "USD",10 "settled": "2019-12-10",11 "status": "settled",12 "originator_client_id": null13 }14 ],15 "request_id": "saKrIBuEB9qJZno"16}Webhooks
TRANSFER_EVENTS_UPDATE
Fired when new transfer events are available. Receiving this webhook indicates you should fetch the new events from /transfer/event/sync. If multiple transfer events occur within a single minute, only one webhook will be fired, so a single webhook instance may correspond to multiple transfer events.
webhook_typestring
TRANSFERwebhook_codestring
TRANSFER_EVENTS_UPDATEenvironmentstring
The Plaid environment the webhook was sent from
Possible values:
sandbox, production1{2 "webhook_type": "TRANSFER",3 "webhook_code": "TRANSFER_EVENTS_UPDATE",4 "environment": "production"5}