Request Fund

POST {{BASE_URL}}/request/fund

The endpoint to initiate fund request

FieldsData TypeDescriptionRequired
amountIntegerAmount in koboMandatory
isNairaBooleanFlag true to send amount as naira instead of KoboOptional
typeStringThis is used to determine the request type. there are two types user-to-business cases where a business is requesting funds from a user and user-to-user cases where a user is requesting funds from a userMandatory
sender_emailstringEmail of the senderMandatory
receiver_emailstringEmail of the receiverMandatory
payment_namestringrequest titleMandatory
descriptionstringRequest descriptionMandatory
metadataobjectDefine custom keys hereOptional

Request Body

{"type"=>"user-to-business", "amount"=>3000, "sender_email"=>"okeayodeji.a@gmail.com", "receiver_email"=>"osunifedayo@gmail.com", "description"=>"Product description", "payment_name"=>"Product title"}

HEADERS

KeyDatatypeRequiredDescription
api-keystring
public-keystring
reference-idstring
idempotencykeystring