Add bank for carrier

Adds a bank account to a carrier, so split payment legs can pay it directly. Any payee saved as a carrier, such as an MGA, broker, agent, or captive, can have one.

Request

POST /api/public/carriers/{carrierId}/banks

URI Parameters

NameTypeDescriptionRequired
carrierIdnumberCarrier IDyes

Request body

NameTypeDescriptionRequired
routingNumberstringNine-digit routing number of a US bank or credit unionyes
accountNumberstringAccount number, 4 to 17 digitsyes
accountTypestringchecking or savingsyes

Example

{
  "routingNumber": "222222226",
  "accountNumber": "123456789",
  "accountType": "checking"
}

Response

A successful request returns a 201 Created status code with the bank account:

NameTypeDescription
idstringBank account ID
namestringName of the bank
accountTypestringchecking or savings

Error Responses

  • 400 Bad Request: Routing or account number is not valid
  • 404 Not Found: Carrier not found, or it belongs to another account
❗️

Important

We do not verify bank accounts added through the API. You are responsible for correct details. If the payee's bank rejects a leg, it moves to failed. Add the correct bank account, then release the leg again. A direct leg always uses the carrier's most recently added bank account.


Did this page help you?