Errors

Response format

Every response has the same envelope. A failed request has status: false, a Vendy error code and a msg. Some errors also carry details in data and error.

{
  "status": false,
  "code": 326,
  "msg": "Business not found"
}

Validation errors

When a field is missing or malformed, the response is HTTP 400 with code 204. data lists each problem as {field: message}:

{
  "status": false,
  "code": 204,
  "msg": "Input is invalid",
  "data": [
    { "amount": "amount must be specified" },
    { "msisdn": "msisdn or email must be specified" }
  ],
  "error": [
    { "amount": "amount must be specified" },
    { "msisdn": "msisdn or email must be specified" }
  ]
}

HTTP status codes

Status	Meaning
`200`	Success. `201` for Create Dedicated Account
`400`	The request was invalid or couldn't be completed. Check `code` and `msg`
`401`	Your AccessKey or SecretKey is missing or wrong
`403`	Your keys don't have permission for this action or this business
`500`	Something went wrong at Vendy. Retry later, and contact support if it continues

📘
Match on code and msg
A few codes are shared by more than one error, for example 327, 334 and 338. Check msg as well as code when you handle a specific error.

Error codes

Code	Name	Message
`201`	ACCOUNT_NOT_FOUND	Email or password maybe incorrect. Also returned as "Access or Secret key not provided" when a key header is missing
`203`	INCORRECT_SECRET_KEY	Incorrect secret key
`204`	INVALID_DATA	Input is invalid
`206`	NOT_CREATED	Data not created
`207`	NOT_FOUND	Data not found
`208`	NOT_UPDATED	Data not updated
`209`	ACCOUNT_BLOCKED	Account blocked
`217`	WALLET_NOT_SUPPORTED	Wallet not supported
`218`	WEBHOOK_NOT_SUPPORTED	Webhook not supported. The `msg` usually carries the reason
`219`	WALLET_NOT_CREATED	Wallet not created
`221`	WALLETS_NOT_FOUND	Wallet not found
`223`	TRANSACTION_NOT_BE_CREATED	Transaction not be created
`229`	UNAUTHORIZED	User not logged in. Returned when the AccessKey is unknown
`244`	BALANCE_NOT_RETRIEVED	Balance not retrieved
`252`	BALANCE_INSUFFICIENT	Your balance is insufficient
`290`	BANK_ACCOUNT_EXISTS	You already have this bank account
`291`	BANK_ACCOUNT_REMOVED	Bank cannot be removed
`292`	BANK_NOT_DEFAULT	Bank could not be made default
`293`	TRANSACTION_AMOUNT_INVALID	Transaction amount does not match payment amount
`297`	PAYMENT_NOT_PROCESSED	Payment could not be processed right now. Please try again later
`298`	TRANSACTION_NO_PENDING	Transaction is not pending
`305`	TRANSACTION_STILL_PENDING	Transaction still processing. Please wait...
`306`	TRANSACTION_NOT_PROCESSED	Transaction failed. Please try again later
`310`	KYC_NOT_VERIFIED	You account has not been verified. Please complete KYC or contact support
`318`	BALANCE_NOT_UPDATED	Balance not updated
`324`	BUSINESS_NOT_CREATED	Business not created
`325`	BUSINESS_NOT_ACTIVE	Business not active
`326`	BUSINESS_NOT_FOUND	Business not found
`327`	TRANSACTION_NOT_FOUND	Transaction not found
`327`	BANK_ACCOUNT_NOT_FOUND	Bank information not resolved
`328`	PAYOUT_NOT_CREATED	Error occurred while creating payout
`329`	PAYOUT_NOT_FOUND	Payout not found
`330`	PAYOUT_ALREADY_PROCESSED	Payout already processed
`331`	PAYOUT_NOT_UPDATED	Payout not processed, please try again later or contact admin
`332`	CHANNELS_NOT_FOUND	Channels not found
`334`	WALLET_MULTIPLE_CURRENCY	You cannot have multiple wallets with the same currency
`334`	WALLET_MULTIPLE_TYPE	You cannot have multiple wallets of the same type
`335`	WALLET_NOT_CREDITED	Wallet could not be credited
`336`	WALLET_BLOCKED	Your wallet has been blocked, withdrawals are not allowed
`337`	PUBLIC_KEY_INVALID	invalid public key, please check key or contact administrator
`338`	TRANSACTION_LIMIT_EXCEEDED	Amount exceeds transaction limit of {limit}
`338`	TRANSACTION_LIMIT_LOW	Amount cannot be less than {limit}
`338`	BUSINESS_IN_REVIEW	Your business is currently under review
`338`	BUSINESS_PENDING	Please complete KYC
`339`	TRANSACTION_NOT_REVERSED	Transaction cannot be reversed
`340`	TRANSACTION_NOT_COMPLETED_REVERSED	Only successful transactions can be reversed
`342`	FORBIDDEN	You do not have permission to take that action
`348`	PAYOUT_NOT_PROCESSED	Payout not processed
`349`	BANKCODE_NOT_PRESENT	Bank account does not have bank code associated with. Please add and remove bank account again
`350`	NOT_SUPPORTED	Not supported
`351`	WALLET_ON_HOLD	Wallet is on hold, only inflow actions can be carried out
`352`	WALLET_ONLY_DEBIT	Wallet cannot be credited
`353`	WALLET_ONLY_CREDIT	Wallet cannot be debited
`354`	WALLET_NOT_DEBITED	Wallet could not be debited
`359`	WALLET_TYPE_NOT_SUPPORTED	Wallet type not supported
`360`	WALLET_BLOCKED_NO_INFLOW	Wallet blocked no inflow activity allowed
`361`	SERVICE_UNAVAILABLE	Service is currently unavailable
`364`	INTERNAL_SERVER_ERROR	Internal server error
`372`	BUSINESS_BLOCKED	Business blocked
`386`	FORBIDDEN_AUTH_TYPE	Your account type is not allowed to take this action
`393`	BANK_NOT_VALIDATED	Account can't be validated, Please Try Again Later!
`407`	WALLET_CURRENCY_NOT_SUPPORTED	Wallet currency does not match transaction currency
`417`	CURRENCY_NOT_SUPPORTED	Currency is not yet supported
`418`	INTERNAL_ERROR	Internal server error
`438`	CUSTOMER_BLACKLISTED	You're no longer allowed to transact on this platform
`439`	PAYOUT_REFID_EXISTS	A transfer with this reference already exists