Sign in

v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Payment Collection

Checkout Details

Fetch Checkout Details.

post/api/v1/checkout/details/

Request body

checkout_idstring required
signaturestring required

Response

idstring uuid required
urlstring required
signaturestring required
methodsstring required
layoutstring required
stylesstring required
merchant_namestring required
merchant_idstring required
merchant_originstring required
first_namestring nullable
last_namestring nullable
phone_numberstring nullable
emailstring email nullable
countrystring nullable
addressstring nullable
citystring nullable
statestring nullable
zipcodestring nullable
api_refstring nullable
wallet_idstring nullable
channel'WEBSITE' | 'WOOCOMMERCE' | 'SHOPIFY' | 'WORDPRESS' | 'BUBBLE' | 'MOBILE'
  • WEBSITE - WEBSITE
  • WOOCOMMERCE - WOOCOMMERCE
  • SHOPIFY - SHOPIFY
  • WORDPRESS - WORDPRESS
  • BUBBLE - BUBBLE
  • MOBILE - MOBILE
hoststring uri nullable
is_mobileboolean
versionstring nullable required
redirect_urlstring uri nullable
amountstring decimal
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)
paidboolean required
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
bitcoin_tarrif'BUSINESS-PAYS' | 'CUSTOMER-PAYS'
  • BUSINESS-PAYS - Business Pay Charges
  • CUSTOMER-PAYS - Customer Pay Charges
ach_tarrif'BUSINESS-PAYS' | 'CUSTOMER-PAYS'
  • BUSINESS-PAYS - Business Pay Charges
  • CUSTOMER-PAYS - Customer Pay Charges
bank_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