Add a payout account

Endpoint to add an account on Vendy to make payouts into. Multiple payout accounts can be added and on initiation of payout, the one to make payout to can be specified, else the default account will be used.

Request:

Field	Type	Description
businessId	Integer	Unique identifier of business
accountnumber	String(Digits)	Bank account number
bankname	String	Bank name of payout account from the list of supported banks
beneficiaryname	String	Name of beneficiary tied to bank account; can be retrieved from validate bank account endpoint
beneficiarycountry	String	2 letter ISO country code of bank account
bankcode	String(Digits)	Unique bank code from the list of supported banks
type	Enum(String)	Type of bank account: 'bank' or 'mobile' (Mobile Wallet)

Example request

cURL

curl --location 'https://api.vendy.money/business/434/payout-account' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
		"businessId":3,
    "accountnumber": "0123456789", 
    "bankname": "GUARANTY TRUST BANK", 
    "beneficiaryname": "Test User",
    "beneficiarycountry": "ng",
    "bankcode":"000013",
    "type": "bank"
}'

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	Payout Account	Payout account 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"
  }
}