Skip to main content
View as Markdown

Settlements

Manage merchant settlements and bank accounts. Access via zenpays.settlements.

Settlements​

list​

const { data } = await zenpays.settlements.list({
  status: 'completed',
  from: '2024-01-01',
})

get​

const settlement = await zenpays.settlements.get('stl_xxx')

create​

const settlement = await zenpays.settlements.create({
  amount: 10000,
  currency: 'INR',
  bankAccountId: 'ba_xxx',
})

cancel​

const cancelled = await zenpays.settlements.cancel('stl_xxx')

getStats​

const stats = await zenpays.settlements.getStats({
  startDate: '2024-01-01',
  endDate: '2024-12-31',
})
// Returns: { totalSettled, pendingAmount, settlementCount, currency }

Bank Accounts​

listBankAccounts​

const { bank_accounts } = await zenpays.settlements.listBankAccounts()

addBankAccount​

const { bank_account } = await zenpays.settlements.addBankAccount({
  accountNumber: '1234567890',
  ifscCode: 'HDFC0001234',
  accountHolderName: 'John Doe',
  bankName: 'HDFC Bank',
})

updateBankAccount​

const { bank_account } = await zenpays.settlements.updateBankAccount('ba_xxx', {
  accountHolderName: 'Jane Doe',
})

deleteBankAccount​

await zenpays.settlements.deleteBankAccount('ba_xxx')