Bank Accounts

Manage bank accounts for settlements.

Add Bank Account

POSThttps://api.zenpays.com/merchant/api/v1/settlements/bank-accounts

Bearer · API key

Body Parameters

Parameter	Type	Description
accountHolderName REQUIRED	string	Account holder name
accountNumber REQUIRED	string	Bank account number
accountType REQUIRED	string	CURRENT or SAVINGS
ifscCode REQUIRED	string	IFSC/Routing code
bankName REQUIRED	string	Name of the bank
branchName OPTIONAL	string	Bank branch name
branchAddress OPTIONAL	string	Bank branch address
isPrimary OPTIONAL	boolean	Set as primary account
swiftCode OPTIONAL	string	SWIFT/BIC code for international transfers

Response

{
  "success": true,
  "data": {
    "id": "ba_xxxxx",
    "accountNumber": "****5678",
    "accountHolderName": "Acme Inc",
    "accountType": "CURRENT",
    "bankName": "Bank of America",
    "branchName": "Main Branch",
    "ifscCode": "BOFA0001234",
    "isPrimary": false,
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

---

List Bank Accounts

GEThttps://api.zenpays.com/merchant/api/v1/settlements/bank-accounts/list

Bearer · API key

Response

{
  "success": true,
  "data": [
    {
      "id": "ba_xxxxx",
      "accountNumber": "****1234",
      "accountHolderName": "Acme Inc",
      "accountType": "CURRENT",
      "bankName": "Chase Bank",
      "branchName": "Downtown Branch",
      "ifscCode": "CHAS0001234",
      "isPrimary": true,
      "createdAt": "2024-01-01T10:00:00.000Z"
    }
  ]
}

---

Update Bank Account

PUThttps://api.zenpays.com/merchant/api/v1/settlements/bank-accounts/{id}

Bearer · API key

Path Parameters

Parameter	Type	Description
id REQUIRED	string	Bank account ID

Body Parameters

Parameter	Type	Description
accountHolderName OPTIONAL	string	Account holder name
branchName OPTIONAL	string	Bank branch name
branchAddress OPTIONAL	string	Bank branch address
isPrimary OPTIONAL	boolean	Set as primary account
swiftCode OPTIONAL	string	SWIFT/BIC code

---

Delete Bank Account

DELETEhttps://api.zenpays.com/merchant/api/v1/settlements/bank-accounts/{id}

Bearer · API key

Path Parameters

Parameter	Type	Description
id REQUIRED	string	Bank account ID

Response

{
  "success": true,
  "message": "Bank account deleted successfully"
}

Examples

cURL

# Add bank account
curl -X POST "https://api.zenpays.com/merchant/api/v1/settlements/bank-accounts" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json" \
  -d '{
    "accountHolderName": "Acme Inc",
    "accountNumber": "9876543210",
    "accountType": "CURRENT",
    "ifscCode": "BOFA0001234",
    "bankName": "Bank of America",
    "branchName": "Main Branch",
    "isPrimary": false
  }'

# List bank accounts
curl -X GET "https://api.zenpays.com/merchant/api/v1/settlements/bank-accounts/list" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt"

# Update bank account
curl -X PUT "https://api.zenpays.com/merchant/api/v1/settlements/bank-accounts/ba_xxxxx" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json" \
  -d '{
    "isPrimary": true
  }'

# Delete bank account
curl -X DELETE "https://api.zenpays.com/merchant/api/v1/settlements/bank-accounts/ba_xxxxx" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt"

SDK

// Add bank account
const account = await zenpays.settlements.addBankAccount({
  accountHolderName: 'Acme Inc',
  accountNumber: '9876543210',
  accountType: 'CURRENT',
  ifscCode: 'BOFA0001234',
  bankName: 'Bank of America',
  branchName: 'Main Branch',
});

// List bank accounts
const accounts = await zenpays.settlements.listBankAccounts();

// Update bank account
await zenpays.settlements.updateBankAccount('ba_xxxxx', {
  isPrimary: true,
});

// Delete bank account
await zenpays.settlements.deleteBankAccount('ba_xxxxx');