Integration guide

Here's a typical flow of the order using our API:

  1. Call Get available currencies to list supported currencies, channels, and pairs.

  2. Call Get order limits for the selected deposit/payout configuration.

  3. Call Get user KYC state to determine if KYC is required for the intended amounts and currency types.

    • If KYC is required, call Submit user KYC and wait until the status is approved by polling the get user KYC state endpoint.

    • See KYC requirements for a detailed checklist of the decision flow.

  4. Call Create a quote with the deposit/payout configuration.

    • Use deposit.fieldsToCreateOrder and payout.fieldsToCreateOrder to collect all required fields from the user.

  5. Call Create an order with quoteId and the collected fields.

  6. The user completes the deposit per the transfer instructions on the order.

  7. If the transfer requires an intermediate action (stk_push / otp_stk_push), call Trigger intermediate action.

  8. Call Confirm order.

  9. Use Get order to poll for status and details at any time.

PreviousGetting StartedNextTransfer types explanation

Last updated