Skip to main content

Core API Integration

Core API Integration lets you run the entire checkout experience through direct API calls, with no redirect and no Echezona-hosted UI. You build your own payment form, collect the customer's card/transfer/USSD details yourself, and call the Core API to process and validate the payment.

Relevant Licenses & Compliance Certifications Required

Because your own UI collects and transmits raw cardholder data, this integration method requires the relevant licenses and compliance certifications before you can go live. If you don't need full control over the checkout UI, use Checkout Integration instead — Echezona's hosted page/SDK handles sensitive data for you and carries no licensing requirement. To begin the approval process, contact hello@echezona.com.

How It Works​

  1. Initialize the Transaction​

    Send a POST request to Payments/Initialize to create the transaction and receive an accessCode.

  2. Get Payment Info​

    Call Payments/GetPaymentInfo/{accessCode} to fetch the payment-page configuration: supported payment methods, fee breakdown, the publicKey used to encrypt sensitive data, and the token used to authenticate the remaining calls in this flow.

  3. Make the Payment​

    Collect the customer's payment details in your own UI (card, bank transfer, or USSD), then call Payments/MakePayment. Sensitive fields (card number, CVV, PIN, expiry) must be RSA-encrypted with the publicKey from the previous step — see Data Encryption for the encryption helper. This call is authenticated with the token (not your API key).

  4. Validate the Payment​

    If the response requires OTP or 3DS confirmation, collect it in your UI and call Payments/ValidatePayment.

  5. Confirm the Outcome​

    Confirm the final transaction status server-side with Fetch Transaction Status.

Mobile (React Native)​

The React Native SDK's "Advanced Usage (Headless Hooks)" — useCardCheckout, useTransferCheckout, and useUssdCheckout — wrap this same Core API flow for merchants who need a custom in-app checkout experience. The licensing and compliance requirement above applies to those hooks too.

Support​

If you need assistance, or want to start the approval process, reach out at hello@echezona.com.