Add Bank Account

Response Codes

201 - Created, will include a Location response header

200 - Request Succeeded, but entity not created

400 - Bad Request, missing or invalid parameters

409 - Account already exists

422 - Request not processed due to business constraints

Common Error Responses

HTTP Status	ErrorResponseCode	Cause
422	`ERR_ACCOUNT_LIMIT_EXCEEDED`	Per-user ACH account limit reached
422	`ERR_ACCOUNT_AUTH_REQUIRED`	Plaid error populating from processor token
422	`ERR_PROVIDER_ACCOUNT_MISCONFIGURATION`	Plaid client config error
422	`ERR_BANK_ACCOUNT_BLOCKED`	Routing number on blocked list
422	`ERR_ACCOUNT_SHARING_LIMIT_EXCEEDED`	Sharing limit exceeded
422	`ERR_ACCOUNT_TYPE_RESTRICTED`	Restricted account type
422	`ERR_ACCOUNT_NAME_MISMATCH`	Identity name-match score below threshold
422	`ERR_ACCOUNT_NAME_MATCH_UNAVAILABLE`	We were unable to confirm the identity match
422	`ERR_ACCOUNT_NOT_ADDED`	We were unable to add the account due to an error with Plaid

Required Fields

payer_id: string, required, Payer ID
recipient_id: string, required, Recipient ID
processor_token: string, required, Plaid processor token

Sample cURL Request

curl --request POST \
     --url https://test.api.interchecks.io/api/v2/payer_id/accounts/recipient_id/banks/plaid-processor-token \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Example Responses

201 - Created
422 - Unprocessable Entity