Create a Bank Account
Create a new bank account for a customer. Requires at least one of the customer's verification profiles to be approved.
In: header
The unique identifier of the customer who owns this bank account.
1 <= lengthThe name of the financial institution where the account is held.
1 <= lengthA descriptive name for this bank account (e.g., "Checking Account", "Business Account").
1 <= lengthThe currency of the bank account. When set to usd, accountDetails must contain accountNumber, routingNumber, and accountType.
"usd"USD account details. Required fields: accountNumber, routingNumber, accountType.
Information about the account owner, including their name, address, and relationship to the customer.
The payment networks supported by this bank account. For USD accounts, must include at least one of "ach" or "wire" (specify both wire and ach if unsure).
The unique identifier of the customer who owns this bank account.
1 <= lengthThe name of the financial institution where the account is held.
1 <= lengthA descriptive name for this bank account (e.g., "Checking Account", "Business Account").
1 <= lengthThe currency of the bank account. When set to eur, accountDetails must contain iban and bic.
"eur"EUR/SEPA account details. Required fields: iban, bic.
Information about the account owner, including their name, address, and relationship to the customer.
The payment networks supported by this bank account. For EUR accounts, must be exactly ["sepa"].
The unique identifier of the customer who owns this bank account.
1 <= lengthThe name of the financial institution where the account is held.
1 <= lengthA descriptive name for this bank account (e.g., "Checking Account", "Business Account").
1 <= lengthThe currency of the bank account. When set to brl, accountDetails must contain pixKey and pixKeyType.
"brl"BRL/PIX account details. Required fields: pixKey, pixKeyType.
The bank account holder details.
The payment networks supported by this bank account. For BRL accounts, must be exactly ["pix"].
Response Body
curl -X POST "https://api.spherepay.co/v2/bank-account" \
-H "Content-Type: application/json" \
-d '{
"customerId": "customer_66c4168d418a410eae282b83883bdc39",
"bankName": "Bank of America",
"accountName": "Checking Account",
"currency": "usd",
"accountDetails": {
"accountNumber": "9876543210",
"routingNumber": 26009593,
"accountType": "checking"
},
"accountOwner": {
"accountHolderName": "Sarah Johnson",
"address": {
"line1": "233 South Wacker Drive",
"city": "Chicago",
"country": "USA"
}
},
"networks": [
"wire",
"ach"
]
}'{
"id": "bankAccount_ce745ef7f3df4b9a8bff1301ce24b045",
"status": "active",
"bankName": "Bank of America",
"accountName": "Checking Account",
"customerId": "customer_66c4168d418a410eae282b83883bdc39",
"created": "2025-01-01T00:00:00Z",
"updated": "2025-01-01T00:00:00Z",
"currency": "usd",
"accountDetails": {
"accountNumber": "****7890",
"routingNumber": "021000021",
"accountType": "checking"
},
"accountOwner": {
"accountHolderName": "John Doe",
"relationship": "self"
},
"networks": [
"wire",
"ach"
]
}{
"status": 400,
"detail": "Invalid request parameters",
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}{
"status": 404,
"detail": "Resource not found",
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}{
"status": 422,
"detail": "Validation failed",
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
]
}