---
updatedAt: 2025-07-14T08:07:07.000Z
agentTools:
  projectIndex: https://vendy.readme.io/llms.txt
---

# Payout

Payouts Model

| Field        | Type                                                                        | Description                                                                          | Nullable |
| :----------- | :-------------------------------------------------------------------------- | :----------------------------------------------------------------------------------- | :------- |
| id           | Integer                                                                     | A unique identifier for interacting with payout                                      | false    |
| uid          | Integer                                                                     | A unique Identifier for payouts                                                      | false    |
| businessId   | Integer                                                                     | Unique identifier for business associated with wallet from which payout is made      | false    |
| walletId     | Integer                                                                     | Unique identifier for wallet from which Payout is made                               | false    |
| amount       | Double                                                                      | Total current amount for payout                                                      | false    |
| refid        | String                                                                      | Unique reference identifier for payout                                               | false    |
| bankId       | Integer                                                                     | Identifier of bank to which payout is made                                           | false    |
| channel      | Enum(String)                                                                | Channel through which payout is made: 'bank' or 'mobile' (mobile wallet)             | false    |
| currency     | String                                                                      | 3 letters ISO currency code, defaults to wallet's currency                           | true     |
| meta         | JSON                                                                        | Extra data on payout                                                                 | true     |
| status       | Enum(String)                                                                | Current state of payout: 'pending', 'processing', 'completed', 'failed', 'cancelled' | false    |
| createdAt    | Date(String)                                                                | Date of initiation of payout                                                         | false    |
| updatedAt    | Date(String)                                                                | Most recent date of update on payout                                                 | false    |
| deletedAt    | Date(String)                                                                | Date of deletion of payout                                                           | true     |
| wallets      | [Wallet](https://vendy.readme.io/reference/wallet)                          | Wallet details from which payout is made                                             | false    |
| bankaccounts | [BankAccount](https://dash.readme.com/project/vendy/v1.0/refs/bank-account) | Bank account details to which payout is made                                         | false    |

Sample Payout response

```json
{
    "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"
    }
}
```