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.


businessIdIntegerUnique identifier of business
accountnumberString(Digits)Bank account number
banknameStringBank name of payout account from the list of supported banks
beneficiarynameStringName of beneficiary tied to bank account; can be retrieved from validate bank account endpoint
beneficiarycountryString2 letter ISO country code of bank account
bankcodeString(Digits)Unique bank code from the list of supported banks
typeEnum(String)Type of bank account: 'bank' or 'mobile' (Mobile Wallet)

Example request

curl --location '' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqd3RpZCI6Ijc1NWU5Njg4LTk1NzgtNGYyZi05NTM3LTQ3NDFhYzIzYjEyZSIsImlhdCI6MTY4NTM2MTE0NCwiZXhwIjoxNjg2NTcwNzQ0LCJpc3MiOiJodHRwczovL3ZlbmR5Lm1vbmV5LmNvbS8iLCJqdGkiOiI3NTVlOTY4OC05NTc4LTRmMmYtOTUzNy00NzQxYWMyM2IxMmUifQ.sOp2MGo9HLeytMmSpS3XAOQlJ84jPxZcPnp9OipClwOcxHoTNcYR-Vnmw1tEJdw5X62gF3B0z8ZN_dr4uCKPTRZnPE22NiL45y0467A0Dkxrnag3LgUic8jp0sdpKakYxnFvC7uKJQSP52BEYTpC8EPG8bYogH0V6jHWtpCJcPU' \
--data '{
    "accountnumber": "0123456789", 
    "bankname": "GUARANTY TRUST BANK", 
    "beneficiaryname": "Test User",
    "beneficiarycountry": "ng",
    "type": "bank"


statusBooleanStates if request was successfully executed or not
codeIntegerInternal code, success if 200
msgStringA description of the status of the request
dataPayout AccountPayout account details

Example response

  "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"
Click Try It! to start a request and see the response here!