Generate Payment URL

Endpoint to initiate transactions on Vendy.

Request:

Field	Type	Description
businessId	Integer	Merchant registered business Id.
amount	Double	The amount being debited.
msisdn	String	A valid identification phone number that is linked to a specific network.
currency	String	The currency of amount for transaction e.g "NGN", "KES". ISO 4217 three-letter code
meta	JSON Object	Object containing any extra information you want recorded with the transaction. Fields within the custom_field object will show up on merchant receipt.

Example request

cURL

curl --location 'https://api.vendy.money/transactions/initiate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
    "businessId":1,
    "amount":100,
    "msisdn":"[phone]",
    "meta": {
       "email": "[email protected]",
       "custom-key": "custom-value"
    }
}'

Response:

Field	Type	Description
status	Boolean	States if the request was successfully executed or not
code	Integer	Internal code, success if 200
msg	String	A description of the status of the request
data	Object	Newly generated URL and related data

Example response

JSON

{
    "status": true,
    "code": 200,
    "data": {
        "ref": "7d4-98dc",
        "url": "https://checkout.vendy.money/test_7d4-98dc",
        "businessID": 6
    }
}

Possible errors;

Error code	Description
326	Business not found