Payouts Model

idIntegerA unique identifier for interacting with payoutfalse
uidIntegerA unique Identifier for payoutsfalse
businessIdIntegerUnique identifier for business associated with wallet from which payout is madefalse
walletIdIntegerUnique identifier for wallet from which Payout is madefalse
amountDoubleTotal current amount for payoutfalse
refidStringUnique reference identifier for payoutfalse
bankIdIntegerIdentifier of bank to which payout is madefalse
channelEnum(String)Channel through which payout is made: 'bank' or 'mobile' (mobile wallet)false
currencyString3 letters ISO currency code, defaults to wallet's currencytrue
metaJSONExtra data on payouttrue
statusEnum(String)Current state of payout: 'pending', 'processing', 'completed', 'failed', 'cancelled'false
createdAtDate(String)Date of initiation of payoutfalse
updatedAtDate(String)Most recent date of update on payoutfalse
deletedAtDate(String)Date of deletion of payouttrue
walletsWalletWallet details from which payout is madefalse
bankaccountsBankAccountBank account details to which payout is madefalse

Sample Payout response

    "id": 12,
    "uid": 1,
    "businessId": 1,
    "walletId": 1,
    "amount": 100,
    "refid": "84a19c3a-1329-48e1-b575-a41e2a556610",
    "bankId": 15,
    "channel": "bank",
    "currency": null,
    "meta": null,
    "status": "pending",
    "createdAt": "2022-07-18T12:02:49.000Z",
    "updatedAt": "2022-07-18T12:02:49.000Z",
    "deletedAt": null,
    "wallets": {
        "id": 1,
        "ownerid": 1,
        "uid": 1,
        "businessId": 1,
        "balance": 0,
        "lockedBalance": 0,
        "meta": null,
        "status": "active",
        "type": "balance",
        "currency": "NGN",
        "fee": 0.015,
        "createdAt": "2022-08-18T11:32:31.000Z",
        "updatedAt": "2022-09-08T09:59:11.000Z",
        "deletedAt": null
    "bankaccounts": {
        "id": 15,
        "uid": 1,
        "businessId": 1,
        "defaultBank": false,
        "accountnumber": "",
        "maskedaccountnumber": "******903110",
        "bankname": "GTBank",
        "beneficiaryname": "FAGBOHUNGBE AYOMIDE OLUWASEUN",
        "beneficiarycountry": "NGA",
        "type": "bank",
        "email": null,
        "createdAt": "2022-07-18T06:00:49.000Z",
        "updatedAt": "2022-07-18T06:00:49.000Z"