Initiating transfers
API reference for Transfer initiation endpoints
Initiating Transfers | |
---|---|
/transfer/authorization/create | Create a transfer authorization |
/transfer/authorization/cancel | Cancel a transfer authorization |
/transfer/create | Create a transfer |
/transfer/cancel | Cancel a transfer |
/transfer/authorization/create
Create a transfer authorization
Use the /transfer/authorization/create
endpoint to authorize a transfer. This endpoint must be called prior to calling /transfer/create
. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.)
There are four possible outcomes to calling this endpoint:
- If the authorization.decision
in the response is declined
, the proposed transfer has failed the risk check and you cannot proceed with the transfer.
- If the authorization.decision
is user_action_required
, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling /link/token/create
to get a new Link token, instead of providing access_token
in the request, you should set transfer.authorization_id
as the authorization.id
. After the Link flow is completed, you may re-attempt the authorization.
- If the authorization.decision
is approved
, and the authorization.rationale_code
is null
, the transfer has passed the risk check and you can proceed to call /transfer/create
.
- If the authorization.decision
is approved
and the authorization.rationale_code
is non-null
, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema.
In Plaid's Sandbox environment the decisions will be returned as follows:
- To approve a transfer with null
rationale code, make an authorization request with an amount
less than the available balance in the account.
- To approve a transfer with the rationale code MANUALLY_VERIFIED_ITEM
, create an Item in Link through the Same Day Micro-deposits flow.
- To get an authorization decision of user_action_required
, reset the login for an Item.
- 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 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 for details on how to customize data in Sandbox.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.access_token
access_token
for the account that will be debited or credited.account_id
account_id
corresponding to the end-user account that will be debited or credited.funding_account_id
funding_account_id
s in the Accounts page of your Plaid Dashboard, under the "Account ID" column. If this field is left blank and you are using legacy funding methods, this will default to the default funding_account_id
specified during onboarding. Otherwise, Plaid Ledger will be used.ledger_id
ledger_id
s in the Accounts page of your Plaid Dashboard. If this field is left blank, this will default to id of the default ledger balance.type
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.debit
, credit
network
For transfers submitted as
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. If the transfer is submitted 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.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.ach
, same-day-ach
, rtp
, wire
amount
/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.ach_class
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, e.g. bill payment"tel"
- Telephone-Initiated Entry"web"
- Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internetccd
, ppd
, tel
, web
wire_details
message_to_beneficiary
user
user.legal_name
field is required. Other fields are not currently used and are present to support planned future functionality.legal_name
phone_number
email_address
address
street
city
region
postal_code
country
device
ip_address
user_agent
iso_currency_code
idempotency_key
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create an authorization fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single authorization is created.
Idempotency does not apply to authorizations whose decisions are
user_action_required
. Therefore you may re-attempt the authorization after completing the required user action without changing idempotency_key
.This idempotency key expires after 48 hours, after which the same key can be reused. Failure to provide this key may result in duplicate charges.
50
user_present
true
; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be false
. This field is not currently used and is present to support planned future functionality.originator_client_id
test_clock_id
sandbox
environment. If provided, the authorization
is created at the virtual_time
on the provided test clock.1const request: TransferAuthorizationCreateRequest = {2 access_token: 'access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',3 account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',4 type: 'debit',5 network: 'ach',6 amount: '12.34',7 ach_class: 'ppd',8 user: {9 legal_name: 'Anne Charleston',10 },11};1213try {14 const response = await client.transferAuthorizationCreate(request);15 const authorizationId = response.data.authorization.id;16} catch (error) {17 // handle error18}
Response fields and example
authorization
id
created
2006-01-02T15:04:05Z
.date-time
decision
approved
– The proposed transfer has received the end user's consent and has been approved for processing by Plaid. The decision_rationale
field is set if Plaid was unable to fetch the account information. You may proceed with the transfer, but further review is recommended. Refer to the code
field in the decision_rationale
object for details.declined
– Plaid reviewed the proposed transfer and declined processing. Refer to the code
field in the decision_rationale
object for details.user_action_required
– An action is required before Plaid can assess the transfer risk and make a decision. The most common scenario is to update authentication for an Item. To complete the required action, initialize Link by setting transfer.authorization_id
in the request of /link/token/create
. After Link flow is completed, you may re-attempt the authorization request.approved
, declined
, user_action_required
decision_rationale
declined
decisions, and may or may not be null for approved
decisions.code
If the
rationale_code
is null
, the transfer passed the authorization check.Any non-
null
value for an approved
transfer indicates that the the authorization check could not be run and that you should perform your own risk assessment on the transfer. The code will indicate why the check could not be run. Possible values for an approved
transfer are:MANUALLY_VERIFIED_ITEM
– Item created via a manual entry flow (i.e. Same Day Micro-deposit, Instant Micro-deposit, Database Insights, or Database Match), limited information available.ITEM_LOGIN_REQUIRED
– Unable to collect the account information due to Item staleness. Can be resolved by using Link and setting transfer.authorization_id
in the request to /link/token/create
.MIGRATED_ACCOUNT_ITEM
- Item created via /transfer/migrate_account
endpoint, limited information available.ERROR
– Unable to collect the account information due to an unspecified error.The following codes indicate that the authorization decision was
declined
:NSF
– Transaction likely to result in a return due to insufficient funds.RISK
- Transaction is high-risk.TRANSFER_LIMIT_REACHED
- One or several transfer limits are reached, e.g. monthly transfer limit. Check the accompanying description
field to understand which limit has been reached.NSF
, RISK
, TRANSFER_LIMIT_REACHED
, MANUALLY_VERIFIED_ITEM
, ITEM_LOGIN_REQUIRED
, PAYMENT_PROFILE_LOGIN_REQUIRED
, ERROR
, MIGRATED_ACCOUNT_ITEM
, null
description
payment_risk
bank_initiated_return _score
The score evaluates the transaction return risk because an account is overdrawn or because an ineligible account is used and covers return codes: "R01", "R02", "R03", "R04", "R06", "R08", "R09", "R13", "R16", "R17", "R20", "R23". These returns have a turnaround time of 2 banking days.
1
99
customer_initiated _return_score
The score evaluates the transaction return risk of an unauthorized debit and covers return codes: "R05", "R07", "R10", "R11", "R29". These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.
1
99
risk_level
HIGH_RISK
, MEDIUM_HIGH_RISK
, MEDIUM_RISK
, MEDIUM_LOW_RISK
, LOW_RISK
warnings
warning_type
warning_code
ITEM_LOGIN_REQUIRED
warning, we recommend re-authenticating your user by implementing Link's update mode. This will guide your user to fix their credentials, allowing Plaid to start fetching data again for future Signal requests.warning_message
proposed_transfer
ach_class
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, e.g. bill payment"tel"
- Telephone-Initiated Entry"web"
- Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internetccd
, ppd
, tel
, web
account_id
account_id
for the account that will be debited or credited.funding_account_id
ledger_id
type
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.debit
, credit
user
legal_name
phone_number
email_address
address
street
city
region
postal_code
country
amount
/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.network
wire_details
message_to_beneficiary
iso_currency_code
originator_client_id
credit_funds_source
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 Plaidsweep
, prefunded_rtp_credits
, prefunded_ach_credits
, null
request_id
1{2 "authorization": {3 "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",4 "created": "2020-08-06T17:27:15Z",5 "decision": "approved",6 "decision_rationale": null,7 "guarantee_decision": null,8 "guarantee_decision_rationale": null,9 "payment_risk": null,10 "proposed_transfer": {11 "ach_class": "ppd",12 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",13 "funding_account_id": "8945fedc-e703-463d-86b1-dc0607b55460",14 "ledger_id": "563db5f8-4c95-4e17-8c3e-cb988fb9cf1a",15 "type": "credit",16 "user": {17 "legal_name": "Anne Charleston",18 "phone_number": "510-555-0128",19 "email_address": "acharleston@email.com",20 "address": {21 "street": "123 Main St.",22 "city": "San Francisco",23 "region": "CA",24 "postal_code": "94053",25 "country": "US"26 }27 },28 "amount": "12.34",29 "network": "ach",30 "iso_currency_code": "USD",31 "origination_account_id": "",32 "originator_client_id": null,33 "credit_funds_source": "sweep"34 }35 },36 "request_id": "saKrIBuEB9qJZno"37}
Was this helpful?
/transfer/authorization/cancel
Cancel a transfer authorization
Use the /transfer/authorization/cancel
endpoint to cancel a transfer authorization. A transfer authorization is eligible for cancellation if it has not yet been used to create a transfer.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.authorization_id
1const request: TransferAuthorizationCancelRequest = {2 authorization_id: '123004561178933',3};4try {5 const response = await plaidClient.transferAuthorizationCancel(request);6 const request_id = response.data.request_id;7} catch (error) {8 // handle error9}
Response fields and example
request_id
1{2 "request_id": "saKrIBuEB9qJZno"3}
Was this helpful?
/transfer/create
Create a transfer
Use the /transfer/create
endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided transfer_id
has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use Transfer events.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.access_token
access_token
for the account that will be debited or credited.account_id
account_id
corresponding to the end-user account that will be debited or credited.authorization_id
amount
/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.description
description
field must be "Retry 1"
or "Retry 2"
to indicate that it's a retry of a previously returned transfer. You may retry a transfer up to 2 times, within 180 days of creating the original transfer. Only transfers that were returned with code R01
or R09
may be retried. For a full listing of ACH return codes, see Transfer errors.15
metadata
test_clock_id
sandbox
environment. If provided, the transfer
is created at the virtual_time
on the provided test_clock
.facilitator_fee
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 less than or equal to the transfer.amount
.1const request: TransferCreateRequest = {2 access_token: 'access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',3 account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',4 description: 'payment',5 authorization_id: '231h012308h3101z21909sw',6};7try {8 const response = await client.transferCreate(request);9 const transfer = response.data.transfer;10} catch (error) {11 // handle error12}
Response fields and example
transfer
id
authorization_id
ach_class
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, e.g. bill payment"tel"
- Telephone-Initiated Entry"web"
- Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internetccd
, ppd
, tel
, web
account_id
account_id
corresponding to the end-user account that will be debited or credited.funding_account_id
ledger_id
type
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.debit
, credit
user
legal_name
phone_number
email_address
address
street
city
region
postal_code
country
amount
/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.description
created
2006-01-02T15:04:05Z
date-time
status
pending
: A new transfer was created; it is in the pending state.
posted
: The transfer has been successfully submitted to the payment network.
settled
: Credits are available to be withdrawn or debits have been deducted from the Plaid linked account.
funds_available
: Funds from the transfer have been released from hold and applied to the ledger's available balance. (Only applicable to ACH debits.)
cancelled
: The transfer was cancelled by the client.
failed
: The transfer failed, no funds were moved.
returned
: A posted transfer was returned.pending
, posted
, settled
, funds_available
, cancelled
, failed
, returned
sweep_status
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)null
, unswept
, swept
, swept_settled
, return_swept
network
For transfers submitted as
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. If the transfer is submitted 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.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.ach
, same-day-ach
, rtp
, wire
wire_details
message_to_beneficiary
cancellable
true
, you can still cancel this transfer.failure_reason
"failed"
or "returned"
. Null value otherwise.ach_return_code
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.description
metadata
iso_currency_code
standard_return_window
date
unauthorized_return _window
date
expected_settlement _date
null
for non-ACH transfers. This will be of the form YYYY-MM-DD.date
originator_client_id
refunds
id
transfer_id
amount
status
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.pending
, posted
, cancelled
, failed
, settled
, returned
failure_reason
"failed"
or "returned"
. Null value otherwise.ach_return_code
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.description
ledger_id
created
2006-01-02T15:04:05Z
date-time
network_trace_id
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_id
expected_sweep _settlement_schedule
returned
. Only applies to ACH debit transfers.sweep_settlement_date
date
swept_settled_amount
sweep_settlement_date
.credit_funds_source
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 Plaidsweep
, prefunded_rtp_credits
, prefunded_ach_credits
, null
facilitator_fee
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 less than or equal to the transfer.amount
.network_trace_id
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_id
1{2 "transfer": {3 "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",4 "authorization_id": "c9f90aa1-2949-c799-e2b6-ea05c89bb586",5 "ach_class": "ppd",6 "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",7 "funding_account_id": "8945fedc-e703-463d-86b1-dc0607b55460",8 "ledger_id": "563db5f8-4c95-4e17-8c3e-cb988fb9cf1a",9 "type": "credit",10 "user": {11 "legal_name": "Anne Charleston",12 "phone_number": "510-555-0128",13 "email_address": "acharleston@email.com",14 "address": {15 "street": "123 Main St.",16 "city": "San Francisco",17 "region": "CA",18 "postal_code": "94053",19 "country": "US"20 }21 },22 "amount": "12.34",23 "description": "payment",24 "created": "2020-08-06T17:27:15Z",25 "refunds": [],26 "status": "pending",27 "network": "ach",28 "cancellable": true,29 "guarantee_decision": null,30 "guarantee_decision_rationale": null,31 "failure_reason": null,32 "metadata": {33 "key1": "value1",34 "key2": "value2"35 },36 "origination_account_id": "",37 "iso_currency_code": "USD",38 "standard_return_window": "2023-08-07",39 "unauthorized_return_window": "2023-10-07",40 "expected_settlement_date": "2023-08-04",41 "originator_client_id": "569ed2f36b3a3a021713abc1",42 "recurring_transfer_id": null,43 "credit_funds_source": "sweep",44 "facilitator_fee": "1.23",45 "network_trace_id": null46 },47 "request_id": "saKrIBuEB9qJZno"48}
Was this helpful?
/transfer/cancel
Cancel a transfer
Use the /transfer/cancel
endpoint to cancel a transfer. A transfer is eligible for cancellation if the cancellable
property returned by /transfer/get
is true
.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.transfer_id
1const request: TransferCancelRequest = {2 transfer_id: '123004561178933',3};4try {5 const response = await plaidClient.transferCancel(request);6 const request_id = response.data.request_id;7} catch (error) {8 // handle error9}
Response fields and example
request_id
1{2 "request_id": "saKrIBuEB9qJZno"3}