Skip to main content
View as Markdown

The BankAccount object

Bank account for settlements

note

15 of 15 fields on this object have no description yet. Field documentation lives in the SDK types (api/settlements.ts) so it stays in one place — this page is generated from it.

Fields​

FieldTypeDescription
id
REQUIRED		string
accountHolderName
REQUIRED		string
accountNumber
REQUIRED		string
maskedAccountNumber
OPTIONAL		string
accountType
REQUIRED		string
ifscCode
REQUIRED		string
swiftCode
OPTIONAL		string
bankName
REQUIRED		string
branchName
OPTIONAL		string
branchAddress
OPTIONAL		string
isPrimary
REQUIRED		boolean
isVerified
REQUIRED		boolean
status
REQUIRED		string
createdAt
REQUIRED		string
updatedAt
OPTIONAL		string

Example​

{
  "id": "obj_1a2b3c",
  "accountHolderName": "string",
  "accountNumber": "string",
  "maskedAccountNumber": "string",
  "accountType": "string",
  "ifscCode": "string",
  "swiftCode": "string",
  "bankName": "string",
  "isPrimary": false,
  "isVerified": false,
  "status": "string",
  "createdAt": "2026-01-15T09:30:00Z"
}