Bank Account Model
Field | Type | Description | Nullable |
---|---|---|---|
id | Integer | A unique identifier for interacting with payout account | false |
uid | Integer | A unique Identifier for payout account | false |
businessId | Integer | Unique identifier for business associated with payout account | false |
defaultBank | Boolean | Specifies if payouts are paid into this account by default | false |
accountnumber | String | account number for bank account | false |
maskedaccountnumber | String | account number in masked form with only last six digits of account number visible | false |
bankname | String | Name of bank | false |
beneficiaryname | String | Name of beneficiary tied to bank account | false |
beneficiarycountry | String | 2 letter ISO country code of bank account | false |
type | Enum(String) | Type of payout account: 'bank' or 'mobile' (Mobile Wallet) | false |
String | Business email | true | |
createdAt | Date(String) | Date of initiation of payout | false |
updatedAt | Date(String) | Most recent date of update on payout | false |
Sample Bank Account response
{
"id": 3,
"uid": 1,
"businessId": 3,
"defaultBank": 0,
"accountnumber": "0123456789",
"maskedaccountnumber": "*****456789",
"bankname": "GTBank",
"beneficiaryname": "Test User",
"beneficiarycountry": "NG",
"type": "bank",
"email": null,
"createdAt": "2022-09-19T17:16:28.000Z",
"updatedAt": "2022-09-19T17:16:28.000Z"
}