Get payout accounts

Endpoint to retrieve all payout accounts.

Request:

Field	Type	Description
businessId	Integer	Unique identifier of business

Example request

cURL

curl --location 'https://api.vendy.money//payout-account?businessId=3' \
--header 'Authorization: Bearer <token>'

Response:

Field	Type	Description
status	Boolean	States if request was successfully executed or not
code	Integer	Internal code, success if 200
msg	String	A description of the status of the request
data	Array[Payout Account]	All payout accounts and details

Example response

JSON

{
    "status": true,
    "code": 200,
    "msg": "Businesses",
    "data": [
        {
            "id": 3,
            "uid": 1,
            "businessId": 3,
            "defaultBank": 0,
            "accountnumber": "0123456789",
            "maskedaccountnumber": "*****456789",
            "bankname": "GUARANTY TRUST BANK",
            "beneficiaryname": "Test User",
            "beneficiarycountry": "NG",
            "type": "bank",
            "email": null,
            "createdAt": "2022-09-19T17:16:28.000Z",
            "updatedAt": "2022-09-19T17:16:28.000Z"
        }
    ]
}