Asteria API DOCs
    • Getting Started
    • Webhooks
    • Auth
      • Validate & Generate Access Token
        POST
    • Collections
      • Pay via Bank Transfer
        • Get Banks
        • Generate Dynamic VIrtual Account
        • Check Payment Status
      • Cards
        • Generate Payment Advice
        • Charge Card
        • Check Card Payment Status
      • Mpesa
        • Mpesa API
      • International Cards
        • Setup Card
        • Check Enrollment
        • Validate Challenge
        • Get Status
    • Payouts
      • Get Bank List
        GET
      • Validate Account
        POST
      • Initiate Transfer
        POST
      • Check Payout Status
        POST
    • Account
      • Get Wallet Balance
        GET

    Getting Started

    Asteria API DOCs#

    This collection serves as the central API reference for the Asteria platform — a digital financial services platform accessible via:
    Staging/Test: https://api-dev.asteriatechnology.io
    Production: https://api.asteriatechnology.io
    It is intended for developers, integration partners, and internal teams building on or consuming the Asteria platform APIs.

    Getting Started#

    To begin integrating with the Asteria platform:
    1.
    Sandbox (Test) Credentials — Visit https://sandbox.asteriatechnology.io to create an account and retrieve your sandbox/test credentials. Use these credentials to test your integration against the staging environment (https://api-dev.asteriatechnology.io).
    2.
    Production Credentials — Once you have completed testing and are ready to go live, switch to https://account.asteriatechnology.io to retrieve your production credentials and point your integration to the live environment.
    Note: The sandbox environment is strictly for testing purposes. Do not use production credentials in the sandbox, and do not use sandbox credentials in production.

    What's Covered#

    The collection documents the following core functional areas:

    🔐 Authentication#

    All apis endpoints (collection, payout, etc) are protected by an OAuth‑style access token.
    To obtain that token you must first call the Auth API with your Gateway ID and Gateway Secret:

    👤 Account Management#

    Endpoints for see balance across different currencies.

    💳 Collections — Pay via Bank Transfer#

    Endpoints to initiate bank transfer payments, check payment status, retrieve transaction history, get supported banks.

    💸 Payouts#

    Endpoints for initiating fund transfers, validating bank accounts, and retrieving the list of supported banks.

    🔔 Webhooks#

    visit webhooks section for more info.

    Authentication#

    Requests use a Bearer token obtained from the Auth API. Set the token variable after a successful validation to authenticate subsequent requests.

    Variables#

    VariableDescription
    base_urlBase URL for the staging/test environment
    gateway_idYour API gateway client ID
    gateway_secretYour API gateway client secret
    tokenBearer token obtained after validation
    Modified at 2026-07-31 13:11:06
    Next
    Webhooks
    Built with