Sign in

v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Payment Requests

Create Payment requests

PayRequests API

post/api/v1/payment-requests/

Request body

amountstring decimal required
first_namestring required
last_namestring required
reasonstring required
currency'KES' | 'GHS' | 'NGN' | 'UGX' | 'TZS' | 'XAF' | 'XOF' required

Supported currencies:

  • KES - Kenyan Shilling (KE)
  • GHS - Ghanaian Cedi (GH)
  • NGN - Nigerian Naira (NG)
  • UGX - Ugandan Shilling (UG)
  • TZS - Tanzanian Shilling (TZ)
  • XAF - Central African CFA Franc (CM)
  • XOF - West African CFA Franc (BF, CI)
emailstring email required
card_tarrif'BUSINESS-PAYS' | 'CUSTOMER-PAYS'
  • BUSINESS-PAYS - Business Pay Charges
  • CUSTOMER-PAYS - Customer Pay Charges
autosend_remider0 | 1 | 2 | 3 | 7 required
  • 0 - Do not send
  • 1 - After a day
  • 2 - After two days
  • 3 - After three day
  • 7 - After a week

Response

amountstring decimal required
first_namestring required
last_namestring required
reasonstring required
currency'KES' | 'GHS' | 'NGN' | 'UGX' | 'TZS' | 'XAF' | 'XOF' required

Supported currencies:

  • KES - Kenyan Shilling (KE)
  • GHS - Ghanaian Cedi (GH)
  • NGN - Nigerian Naira (NG)
  • UGX - Ugandan Shilling (UG)
  • TZS - Tanzanian Shilling (TZ)
  • XAF - Central African CFA Franc (CM)
  • XOF - West African CFA Franc (BF, CI)
emailstring email required
card_tarrif'BUSINESS-PAYS' | 'CUSTOMER-PAYS'
  • BUSINESS-PAYS - Business Pay Charges
  • CUSTOMER-PAYS - Customer Pay Charges
autosend_remider0 | 1 | 2 | 3 | 7 required
  • 0 - Do not send
  • 1 - After a day
  • 2 - After two days
  • 3 - After three day
  • 7 - After a week