Create Off Ramp Bank Account
Add a US bank account to an existing user for offramp payouts. This allows you to add bank account details for your user via the API, making the checkout experience smoother when they open the offramp widget. By pre-saving the bank account on their user profile, users can skip adding bank account information inside the widget, reducing friction and increasing conversion rates. For new users, you can use this endpoint in conjunction with the user creation API to set up a profile and save bank details seamlessly.
Endpoints
| Environment | Method | Endpoint |
|---|---|---|
| Sandbox | POST | https://partner-sandbox.wert.io/api/external/offramp/users/USER_ID/bank-accounts |
| Production | POST | https://partner.wert.io/api/external/offramp/users/USER_ID/bank-accounts |
Limits
- The user must be one you have created or served, and offramp must be available for your Partner ID.
- Requests are rate limited per partner. When the limit is reached, the API returns
429with aRetry-Afterheader. - A user can have up to 3 active bank accounts.
- If the user already has an active bank account with the same
routing_numberandaccount_number, the API returns409with the existingbank_account_id.
Path Parameters
string RequiredThe unique identifier of the user in Wert's database. Replace USER_ID in the path with this value.
Body
string RequiredThe name of the account holder.
Possible values: 1–128 characters; leading and trailing spaces are removed.
string RequiredThe bank account number.
Possible values: 4–17 digits, numbers only.
string RequiredThe bank routing number.
Possible values: 9 digits, numbers only; must be a valid ABA routing number.
enum <string> RequiredThe type of bank account.
Possible values: checking, savings.
string OptionalA custom display name for the account. Up to 64 characters; leading and trailing spaces are removed. If omitted or empty, the alias defaults to four middle dots, a space, and the last four digits of the account number (e.g., ···· 6789).
string OptionalA valid email address. Omit it or send null to use the email on the user's offramp profile, or the user's email if the profile has none.
Example Requests
# 1. Create a bank account with the required fields only
curl -X POST '[https://partner-sandbox.wert.io/api/external/offramp/users/01KT3R3BQ2ZRBHZN58E6VVY5F3/bank-accounts](https://partner-sandbox.wert.io/api/external/offramp/users/01KT3R3BQ2ZRBHZN58E6VVY5F3/bank-accounts)' \
-H 'X-Api-Key: your-unique-api-key' \
-H 'Content-Type: application/json' \
-d '{
"account_holder_name": "Jane Doe",
"account_number": "123456789",
"routing_number": "021000021",
"account_type": "checking"
}'
# 2. Create a bank account with an alias and an email
curl -X POST '[https://partner-sandbox.wert.io/api/external/offramp/users/01KT3R3BQ2ZRBHZN58E6VVY5F3/bank-accounts](https://partner-sandbox.wert.io/api/external/offramp/users/01KT3R3BQ2ZRBHZN58E6VVY5F3/bank-accounts)' \
-H 'X-Api-Key: your-unique-api-key' \
-H 'Content-Type: application/json' \
-d '{
"account_holder_name": "Jane Doe",
"account_number": "123456789",
"routing_number": "021000021",
"account_type": "savings",
"alias": "Main savings",
"email": "[email protected]"
}'Response
booleanIndicates if the request was successfully processed.
objectShow child attributes
string
The last four digits of the bank account number.
enum <string>
The type of bank account (checking or savings).
string
The display alias for the bank account. Up to 64 characters; leading and trailing spaces are removed. If omitted or empty, defaults to four middle dots, a space, and the last four digits of the account number (e.g., ···· 6789).
string
The unique identifier for the created bank account in Wert's database.
string
Timestamp of when the bank account was created (UTC). See Example Response for the time format.
Example Response
{
"success": true,
"data": {
"account_number_last4": "6789",
"account_type": "checking",
"alias": "···· 6789",
"bank_account_id": "01KB2YQ8V7C3N4M5P6R7S8T9VW",
"created_at": "2026-10-29T12:34:56.789123Z"
}
}References
Create Off Ramp Bank Account Errors
Refer to create off ramp bank account error codes for more details.
{
"errors": [
{
"field": "routing_number",
"message": "invalid ABA routing number checksum"
}
]
}{
"errors": [
{
"field": "email",
"message": "no email on the offramp profile or the user"
}
]
}{
"message": "ERR_UNAUTHORIZED"
}{
"message": "user is banned"
}{
"message": "offramp is not available"
}{
"message": "user not found"
}{
"code": "BANK_LIMIT",
"message": "maximum of 3 bank accounts reached"
}{
"bank_account_id": "{existing bank_account_id}",
"message": "bank account already exists"
}The response has no body. The Retry-After header holds the number of seconds to wait before retrying.
Create Off Ramp Bank Account Error Codes
| Error code | Description |
|---|---|
400 | Bad request. The errors array lists each field that failed validation. A body that is not valid JSON, a field of the wrong type, or an email that is not a valid address returns 400 with an empty body. A missing X-Api-Key header returns 400 with the reason in a msg field. |
401 | Unauthorized. Check your API key or contact support. |
403 | Forbidden. The user is banned, or offramp is not available for your Partner ID. |
404 | Not found. The user does not exist or is not one of your users. |
409 | Conflict. The user already has 3 active bank accounts (code is BANK_LIMIT), or already has an active bank account with the same routing and account number (bank_account_id is the existing account). |
429 | Too Many Requests. Retry after the number of seconds in the Retry-After header. |
500 | Internal Server Error. |
Updated about 16 hours ago

