<!-- ZenPays documentation · https://docs.zenpays.com/docs/rest-api/endpoints/settlements/bank-accounts -->

# Bank Accounts

Manage bank accounts for settlements.

## Add Bank Account

<EndpointHeader verb="POST" path="/merchant/api/v1/settlements/bank-accounts" />

### Body Parameters

<ParamTable
  rows={[
    { name: "accountHolderName", type: "string", required: true, desc: "Account holder name" },
    { name: "accountNumber", type: "string", required: true, desc: "Bank account number" },
    { name: "accountType", type: "string", required: true, desc: "`CURRENT` or `SAVINGS`" },
    { name: "ifscCode", type: "string", required: true, desc: "IFSC/Routing code" },
    { name: "bankName", type: "string", required: true, desc: "Name of the bank" },
    { name: "branchName", type: "string", desc: "Bank branch name" },
    { name: "branchAddress", type: "string", desc: "Bank branch address" },
    { name: "isPrimary", type: "boolean", desc: "Set as primary account" },
    { name: "swiftCode", type: "string", desc: "SWIFT/BIC code for international transfers" },
  ]}
/>

### Response

```json
{
  "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

<EndpointHeader verb="GET" path="/merchant/api/v1/settlements/bank-accounts/list" />

### Response

```json
{
  "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

<EndpointHeader verb="PUT" path="/merchant/api/v1/settlements/bank-accounts/{id}" />

### Path Parameters

<ParamTable
  rows={[
    { name: "id", type: "string", required: true, desc: "Bank account ID" },
  ]}
/>

### Body Parameters

<ParamTable
  rows={[
    { name: "accountHolderName", type: "string", desc: "Account holder name" },
    { name: "branchName", type: "string", desc: "Bank branch name" },
    { name: "branchAddress", type: "string", desc: "Bank branch address" },
    { name: "isPrimary", type: "boolean", desc: "Set as primary account" },
    { name: "swiftCode", type: "string", desc: "SWIFT/BIC code" },
  ]}
/>

---

## Delete Bank Account

<EndpointHeader verb="DELETE" path="/merchant/api/v1/settlements/bank-accounts/{id}" />

### Path Parameters

<ParamTable
  rows={[
    { name: "id", type: "string", required: true, desc: "Bank account ID" },
  ]}
/>

### Response

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

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
# 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"
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

```javascript
// 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');
```

  </TabItem>
</Tabs>

</CodeRail>
