<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/bank-accounts/add-bank-account -->

# Add Bank Account

Register a new bank account for receiving settlement payouts.

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

## Request

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
    { name: "Content-Type", required: true, desc: "`application/json`" },
  ]}
/>

### 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

### Success (201 Created)

```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"
  }
}
```

### Error Responses

<ErrorTable
  rows={[
    { code: "VALIDATION_ERROR", status: "400", message: "Invalid input data" },
    { code: "UNAUTHORIZED", status: "401", message: "Invalid API key" },
    { code: "DUPLICATE_ACCOUNT", status: "409", message: "Account number already registered" },
  ]}
/>

<CodeRail>

## Examples

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

```bash
curl -X POST "https://api.zenpayz.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
  }'
```

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

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

console.log(`Bank account added: ${account.id}`);
```

  </TabItem>
</Tabs>

</CodeRail>
