Sign in

v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Payment Links

Create Paymentlinks

Payment links API

post/api/v1/paymentlinks/

Request body

idstring uuid
titlestring required

Payment link title

is_activeboolean
redirect_urlstring uri nullable

Optional website URL to redirect the client after a successful payment

amountinteger
usage_limitinteger
qrcode_filestring uri nullable required
urlstring required
currency'KES' | 'GHS' | 'NGN' | 'UGX' | 'TZS' | 'XAF' | 'XOF'

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)
mobile_tarrif'BUSINESS-PAYS' | 'CUSTOMER-PAYS'
  • BUSINESS-PAYS - Business Pay Charges
  • CUSTOMER-PAYS - Customer Pay Charges
card_tarrif'BUSINESS-PAYS' | 'CUSTOMER-PAYS'
  • BUSINESS-PAYS - Business Pay Charges
  • CUSTOMER-PAYS - Customer Pay Charges
created_atstring date-time nullable required
updated_atstring date-time nullable required

Response

idstring uuid
titlestring required

Payment link title

is_activeboolean
redirect_urlstring uri nullable

Optional website URL to redirect the client after a successful payment

amountinteger
usage_limitinteger
qrcode_filestring uri nullable required
urlstring required
currency'KES' | 'GHS' | 'NGN' | 'UGX' | 'TZS' | 'XAF' | 'XOF'

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)
mobile_tarrif'BUSINESS-PAYS' | 'CUSTOMER-PAYS'
  • BUSINESS-PAYS - Business Pay Charges
  • CUSTOMER-PAYS - Customer Pay Charges
card_tarrif'BUSINESS-PAYS' | 'CUSTOMER-PAYS'
  • BUSINESS-PAYS - Business Pay Charges
  • CUSTOMER-PAYS - Customer Pay Charges
created_atstring date-time nullable required
updated_atstring date-time nullable required