
User flow
Our collect API allows your customers to pay in local currency easily using a voucher system we’ve developed from the ground up. Here’s how the process looks like for your customers:1
User verifies identity
We use a simple 3 step ID verification flow. The user only needs to
verify identity once.
2
User account created
After the user has verified their identity, we create a permanent account
for the user to make payments to at any time.
3
Create voucher
Anytime the user makes payment to their account, a voucher is instantly
created for them.
4
Redeem voucher
Once voucher payment is done, voucher can be redeemed. You either auto
redeem the voucher for the user, or allowing them to manually redeem using a
code in your app.
Update your merchant information
Once you get your API credentials, update your merchant details using our update merchant record. Params:logo
: Sets your widget logo.callbackUrl
: Your callback URL. Webhook will be sent to this URL.feeBearer
: Payee of the transaction fees.creditCurrency
: Sets which currency to be settled in after voucher is redeemed
Create a voucher
You can create a voucher in two different ways:Method 1
Method 1
Redirect users to our pay URL
https://staging.ventogram.com/v1/voucher/pay?currency=NGN&voucherId=${voucherId}&amount=${amount}&fullname=${fullname}&email=${email}&user=${merchant}&callback=${callback}
Params:voucherId
: (optional) A unique ID (min length=32) generated by the merchant used to create a voucher.amount
: The value of the voucher.currency
: Currency in which voucher will be created and redeemed.fullname
: Voucher recipient full name.email
: Voucher recipient email.merchant
: Merchant’s username.callback
: Successful payment redirect URL.
callback: When a payment is successful the user will be redirected to this
URL with the
vouchercode
appended to the URL as shown belowBuilding your redirect URL
Method 2
Method 2
Step 1
Use the Create Voucher API to generate a voucher id. See our create-voucher reference for more details.Step 2
Redirect your users to the pay URLhttps://staging.ventogram.com/voucher/pay?voucherId=${voucherId}&callback=${callback}
to view voucher payment details.Required params:voucherId
: The id returned by the Create Voucher API from Step 1.callback
: Successful payment redirect URL.
callback: When a payment is successful the user will be redirected to this
URL with the
vouchercode
appended to the URL as shown belowBuilding your redirect URL
Redeem a voucher
After creating a voucher, your users will be directed to the provided callback URL upon successful payment. Your callback URL will receive the following query parameters:vouchercode
: The code used to redeem the voucher.voucherId
: The ID of the created voucher.
feeBearer: The
feeBearer
param allows you to choose between client
or merchant
as the payee of the fee. merchant
will charge fees from your balance, while client
will charge fees from the customer.