Skip to main content

Transfers

Transfers APIs expose the Transfers service: one-time and scheduled recurring movement between accounts—standard moves, loan payments, IRA contributions, and recipient transfers to other members at the same FI. A single API surface covers immediate execution and future-dated or repeating schedules. Use Recipient APIs first when the destination is a saved payee.

End-user benefits

  • Transfer funds between their own accounts.
  • Send money to other members at the same financial institution.
  • Set up one-time or recurring scheduled transfers.

Integration capabilities

  • Create one-time and scheduled transfers between accounts.
  • Support loan payments and IRA contribution transfers.
  • Configure scheduled recurring transfers with multiple frequencies.

Transfer types

TypeDescription
StandardRegular transfer between accounts
Loan PaymentTransfer to pay loan balance
IRA ContributionTransfer for retirement contributions
Recipient TransferTransfer to another member's account

Scheduled transfer frequencies

FrequencyDescription
ONETIMESingle execution
DAILYEvery day
WEEKLYOnce per week
BIWEEKLYEvery two weeks
TWICEMONTHLYTwice per month
MONTHLYOnce per month
QUARTERLYEvery three months
SEMIANNUALLYTwice per year
ANNUALLYOnce per year

Loan payment options (when applicable): DEFAULT, PRINCIPAL_ONLY, INTEREST_ONLY, EXCESS_TO_PRINCIPAL, EXCESS_TO_INTEREST.

Scopes

ScopeDescription
recipients:readRead recipient information
recipients:writeCreate, update, and delete recipients
transfers:writeCreate transfers

Required headers

HeaderDescription
AuthorizationBearer token (V2 authentication)
transactionIdUnique identifier for request tracking

Error codes (TFR_*)

CodeMessageHTTP Status Code
TFR_10000Client error. Transfer could not be completed400
TFR_10001Server error. Transfer could not be completed500
TFR_10002Invalid institution id400
TFR_10003The From account does not exist or could not be retrieved400
TFR_10004The To account does not exist or could not be retrieved400
TFR_10005An unacceptable transfer type was provided for this transfer400
TFR_10006Contributions to a prior year cannot be scheduled400
TFR_10007A start date must be provided, and must be after today400
TFR_10008An end date after the start date must be provided and must yield at least one execution400
TFR_10009The number of executions is required for the given life type (positive integer ≤ 99)400
TFR_10010The provided frequency requires a valid day or set of days to execute on400
TFR_10011The provided schedule requires a life type400
TFR_10012The provided schedule requires a valid frequency400
TFR_10013Loan overpayment cannot be scheduled400
TFR_10014SRTs are not enabled for this institution400
TFR_10015Loan overpayment is not enabled for this institution400
TFR_10016Loan overpayment options are not configured for this institution400
TFR_10017Loan overpayment options for this institution could not be processed400
TFR_10018Loan overpayment is not allowed for the To account400
TFR_10019Loan overpayment option is not allowed for the To account400
TFR_10020The transfer amount is required400
TFR_10021The transfer amount is invalid400
TFR_10022The transfer amount exceeds the From account balance400
TFR_10023The From User is required400
TFR_10024The To User is required400
TFR_10025The From account is restricted from making a transfer400
TFR_10026The To account is restricted from receiving a transfer400
TFR_10027The From account has an invalid status and cannot be used to make a transfer400
TFR_10028The To account has an invalid status and cannot be used to receive a transfer400
TFR_10029The From account and To account cannot be the same400
TFR_10030The RegE confirmation message could not be created400
TFR_10031The transfer amount must equal the To account loan payment amount400
TFR_10032The transfer amount must be less than or equal to the To account loan payment amount400
TFR_10033The transfer amount must be greater than or equal to the To account loan payment amount400
TFR_10034Invalid query param400
TFR_10035Request should only contain printable ASCII characters400
TFR_10036Request is missing a transactionId header400
TFR_10037Request transactionId header is too long400
TFR_10038The To account prior year eligible contribution amount is missing, zero, or negative400
TFR_10039The transfer amount exceeds the prior year eligible contribution amount400
TFR_10040The To account eligible contribution amount is missing, zero, or negative400
TFR_10041The transfer amount exceeds the eligible contribution amount400
TFR_10042Memo is not enabled for this institution400
TFR_10043Memo exceeds maximum length allowed400
TFR_10044Memo contains an invalid character400
TFR_10045Transfers From the institution owned account transfer type is not enabled400
TFR_10046Transfers To the institution owned account transfer type is not enabled400
TFR_10047The institution owned account is not properly configured for this institution400
TFR_10048The cross TIN transfer type was set incorrectly400
TFR_10050Recipient transfers not allowed400
TFR_10051Recipient not found400
TFR_10052Recipient transfers to the requested account type not allowed400
TFR_10053Invalid to account type in validate recipient transfer request400
TFR_10054Invalid to passcode in validate recipient transfer request400
TFR_10056The request body could not be parsed; ensure required fields and valid values400
TFR_10057Business banking user not found400
TFR_10058The fromAccountId field is required400
TFR_10059The toAccountId field is required400
TFR_10060The CIF number is required, but was not found401
TFR_10061Request callingAppId header is too long400
TFR_10062The provided schedule is invalid for the life type and frequency400
TFR_10063An incorrect number of days was provided for the given frequency400
TFR_10064Test transfers cannot be scheduled400
TFR_10065Request header is too long400
TFR_10066Transfer id is required400
TFR_10067Transfer ids from request and URL do not match400
TFR_10068Unauthorized access403
TFR_11001Full authentication was not provided in the request401
TFR_11002The authentication token is invalid401
TFR_11003The authentication does not authorize this request403

Endpoints