Payout Account

Bank Account Model

idIntegerA unique identifier for interacting with payout accountfalse
uidIntegerA unique Identifier for payout accountfalse
businessIdIntegerUnique identifier for business associated with payout accountfalse
defaultBankBooleanSpecifies if payouts are paid into this account by defaultfalse
accountnumberStringaccount number for bank accountfalse
maskedaccountnumberStringaccount number in masked form with only last six digits of account number visiblefalse
banknameStringName of bankfalse
beneficiarynameStringName of beneficiary tied to bank accountfalse
beneficiarycountryString2 letter ISO country code of bank accountfalse
typeEnum(String)Type of payout account: 'bank' or 'mobile' (Mobile Wallet)false
emailStringBusiness emailtrue
createdAtDate(String)Date of initiation of payoutfalse
updatedAtDate(String)Most recent date of update on payoutfalse

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"