Introduction to the Bank Account Feature

The Bank Account feature securely stores merchant and customer bank account details in the SpherePay system. Each bank account is encrypted and assigned a unique identifier, making it accessible for transactions via both the Dashboard and the SpherePay API.

This feature supports multiple currencies, ensuring compatibility across different banking systems.

Adding a Bank Account

Via the Dashboard

To manually add a bank account from the SpherePay Dashboard, follow these steps:

1️⃣ Sign in to the SpherePay Dashboard.
2️⃣ Navigate to the Transfers tab in the sidebar.
3️⃣ Select Bank Accounts to access account management.
4️⃣ Click on Connect Bank Account.
5️⃣ Fill in the required details in the form.
6️⃣ Submit the form to complete the process.

Once submitted, the account is encrypted and stored securely in the system.

Via the API

For developers integrating bank account management into their applications, use the following API request:

🔹 POST https://api.spherepay.co/v2/customer/:id/bankAccount

Example Request Body:

{
    "accountName": "John Doe Savings",
    "bankName": "Bank of America",
    "currency": "USD",
    "beneficiaryAddress": {
      "line1": "123 Elm Street",
      "line2": "Suite 456",
      "city": "New York",
      "postalCode": "10001",
      "state": "NY",
      "country": "USA"
    },
    "meta": {
      "purpose": "Payroll Account",
      "notes": "Main account for business transactions"
    },
    "lookupKey": "10000000001",
    "accountDetails": {
      "accountType": "checking",
      "accountNumber": "123456789",
      "routingNumber": "987654321"
    }
}

📌 Note:

The required fields depend on the currency and country of the bank account.
Refer to the XML snippet in the API documentation for the full list of supported currencies and fields.

Managing Bank Accounts

Updating or Deleting a Bank Account

Merchants can update or remove bank accounts through the Dashboard or the API.

Dashboard: Navigate to the Bank Accounts section, select the account, and choose Edit or Delete.
API: If merchants extend the API to their own applications, their customers can edit and manage their own bank accounts via the integrated platform.

Security & Data Protection

🔒 All bank account data stored within SpherePay is encrypted to ensure security and compliance with financial regulations.

Troubleshooting & API Reference

If you encounter any issues when adding a bank account, refer to the SpherePay API documentation:
🔗 API Reference

Common issues include:
✅ Incorrectly formatted fields (e.g., missing routingNumber for USD accounts).
✅ Unsupported currency or country (check XML snippet for valid options).
✅ Authentication errors (ensure API keys are properly configured).

Conclusion

The Bank Account feature in SpherePay allows merchants to store, manage, and utilize bank details for seamless financial transactions. Whether you're using the Dashboard for manual management or integrating via the API, SpherePay ensures security, flexibility, and multi-currency support.

For further assistance, visit SpherePay Support or refer to our API documentation. 🚀