• English
  • Data Dictionary

    Country & Currency

    CountryCountry CodeCurrencyArea Code
    NigeriaNGNGN0234
    GhanaGHGHS0233
    TanzaniaTZTZS0255
    KenyaKEKES0254
    South AfricaZAZAR0027
    PakistanPKPKR0092

    Wallet List

    CountryWallet
    PakistanEASYPAISA, JAZZCASH
    TanzaniaM-pesa, Tigopesa, Airtel Money, Halopesa
    GhanaMTN, VODAFONE, AIRTELTIGO, TIGO
    KenyaM-PESA

    Order Status

    ValueStatusDescription
    0unpaidOrder awaiting to be paid (intermediate status), waiting for customer to pay within the validity period of the order (30 mins)
    1payingOrder in process (intermediate status), the order is being processed for payment within the validity period of the order (30 mins)
    2successThe payment is successful (final status). The payment result within the validity period of the order is successful.
    3failPayment failed (final status), the order payment result is failed.
    4closeThe order is closed (final status). During the validity period of the order, orders that the user has not completed payment will be closed.
    5required_captureAuthorization succeeded, awaiting capture. Triggered when captureMode=manual.

    Order Status Flow

    Be sure to pass notifyUrl when initiating the order to receive status. All the closed, failed, and success orders will be notified asynchronously through the notifyUrl.

    There are two types of status flow:

    • unpaid → pending → success / fail — Normal order status flow
    • unpaid → close — The order that doesn't complete payment within the validity period of the order

    Refund Order Status

    Refund order status definitions:

    ValueStatusDescription
    0unpaidWaiting to be processed (intermediate status).
    1payingRefund is processing (intermediate status).
    2successRefund succeeded (final status).
    3failRefund failed (final status).
    4closeRefund order closed (final status).

    Card Token Status

    Status enumeration for card tokens in Card Payment scenarios:

    ValueStatusDescription
    0INITTransaction initialized, card binding has not yet been initiated
    1LINKEDCard binding succeeded, Token is ready for use
    3FAILEDCard binding failed (final status), Token is not usable
    4APPLYINGCard binding in progress (intermediate status), awaiting response from card network / issuing bank
    7UNAUTHFinal status after transaction initialization, the token was generated but did not pass the verification process

    Token Status Flow

    0 (INIT) ──▶ 4 (APPLYING) ──▶ 1 (LINKED)    -- Normal binding success
                              │
                              └──▶ 3 (FAILED)    -- Binding failed
                     │
                     └──▶ 7 (UNAUTH)             -- Transaction initialized, not certified (final status)

    Note: Only tokens in 1 (LINKED) status can be used in cardPayerInfo when calling Create Order.

    Service Type

    ValueDescription
    airtimeAirtime top-up
    dataBundleDatabundle top-up
    bettingFundBetting account top-up

    Scene Code

    ValueDescription
    airtimeAirtime top-up
    dataDatabundle top-up
    bettingBetting top-up

    Virtual Account Order Status

    ValueDescription
    0Init
    1Success (Only this status will receive pay-in order notifications)
    2Failed
    3Processing