Skip to main content

Settlements API

Manage merchant settlements.

Methods​

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: 'USD',
  bankAccountId: 'ba_xxx',
})

getStatus​

const status = await zenpays.settlements.getStatus('stl_xxx')

apply​

await zenpays.settlements.apply('stl_xxx')

getSummary​

const summary = await zenpays.settlements.getSummary('30d')
// { totalSettled, pendingAmount, settlementCount }

Types​

Settlement​

interface Settlement {
  id: string
  merchantId: string
  amount: number
  currency: string
  status: SettlementStatus
  bankAccountId?: string
  transactionCount: number
  periodStart: string
  periodEnd: string
  processedAt?: string
  createdAt: string
}

SettlementStatus​

type SettlementStatus
  = | 'pending'
    | 'processing'
    | 'completed'
    | 'failed'