Endpoint to initiate transactions on Vendy.

Request:

FieldTypeDescription
businessIdIntegerMerchant registered business Id.
amountDoubleThe amount being debited.
msisdnStringA valid identification phone number that is linked to a specific network.
currencyStringThe currency of amount for transaction e.g "NGN", "KES". ISO 4217 three-letter code
metaJSON ObjectObject 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 --location 'https://api.vendy.money/transactions/initiate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
    "businessId":1,
    "amount":100,
    "msisdn":"+2348101851915",
    "meta": {
       "email": "[email protected]",
       "custom-key": "custom-value"
    }
}'

Response:

FieldTypeDescription
statusBooleanStates if the request was successfully executed or not
codeIntegerInternal code, success if 200
msgStringA description of the status of the request
dataObjectNewly generated URL and related data

Example response

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

Possible errors;

Error codeDescription
326Business not found
Language
Credentials
Header
Click Try It! to start a request and see the response here!