Get Payouts

Endpoint to get all payouts for a specific wallet.

Request:

FieldTypeDescription
businessIdIntegerUnique identifier for business
walletIdIntegerUnique identifier for wallet

Example request

curl --location 'https://api.vendy.money/payouts?businessId=1&walletId=1' \
--header 'Authorization: Bearer <token>'

Response:

FieldTypeDescription
statusBooleanStates if request was successfully executed or not
codeIntegerInternal code, success if 200
msgStringA description of the status of the request
dataArray[Payout]All wallet payouts and details

Example response

{
    "status": true,
    "code": 200,
    "msg": "Payout",
    "data": [
        {
            "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,
                "pendingInflow": 7961800025.335,
                "pendingWithdrawal": 100,
                "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": "0123456789",
                "maskedaccountnumber": "******456789",
                "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"
            }
        }
    ]
}
Language
Authorization
Header
Click Try It! to start a request and see the response here!