Bank Accounts

bank_account objects hold the account details of a customer's bank account. bank_account objects are linked to customer and mandate objects. The API allows you to retrieve your bank accounts. You can retrieve individual bank accounts as well as a list of all of a customer's bank accounts.

The bank account object

ATTRIBUTES

Scroll inside to view more
Attribute
Description
id string
Unique identifier for the object.
object string, value is "bank_account"
String representing the object's type. Objects of the same type share the same value.
created timestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
livemode boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
account_holder_name string
Name of the person or business that owns the bank account.
account_ifsc string
Branch IFSC code.
account_last4 string
Last four digits of the bank account number.
account_type string
Type of account. This is savings, current, nre, nro, or cc.
bank_name string
Name of the bank associated with the IFSC (e.g. ICICI BANK).
customer string
Identifier of the customer who owns the bank account.
mandates list
List of mandates that are attached to this bank account.
status string
Status of the bank account. Possible values are enabled, disabled. Bank accounts are always enabled unless a user has specifically disabled it. Disabling a bank account cancels its linked mandates and ach_debits. A disabled bank account can be enabled by creating a new bank account with the same account details.
Last updated 1 year ago