get
https://api.myvendy.com/payout-account
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Endpoint to retrieve all payout accounts.
Request:
| Field | Type | Description |
|---|---|---|
| businessId | Integer | Unique identifier of business |
Example request
curl --location 'https://api.myvendy.com/payout-account' \
--header "AccessKey: $VENDY_ACCESS_KEY" \
--header "SecretKey: $VENDY_SECRET_KEY"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
{
"status": true,
"code": 200,
"msg": "Payout Accounts",
"error": "Payout Accounts",
"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"
}
]
}