HomeGuidesAPI Reference

SourceAccountPayload

Payitoff API: SourceAccountPayload Schema

✉️

Contact us if you're interested in using this feature.

To create an SourceAccount for a Borrower, use our Create a Source Account API endpoint with an SourceAccountPayload.

NOTE: The following fields are required:

  • account_number
  • name_on_account
  • routing_number
  • type

🚧

Use SourcerAccountPayload for to create a SourceAccount

When creating SourceAccount objects via API, send a SourceAccountPayload as your request body. You'll receive a SourceAccount as a response.

Schema Definition

Properties in bold are required.

PropertyTypeFormatDescription
account_numberstringThe borrower's account number at a financial institution.
name_on_accountstringName of account at financial institution.
routing_numberstringThe borrower's routing number at a financial institution.

It must be exactly 9 digits in length.
typestringbrokerage
checking
savings
Type of account at a borrower's financial institution.

Example

{
  "source_account":
  {
    "account_number": "Wells Fargo Joint Checking",
    "name_on_account": "98765543210",
    "routing_number": "123456789",
    "type": "checking"
  }
}