# API Documentation

## Docs

- [About Mobile Money](https://docs.getmipay.com/api-doc/Mobile-Money.md)
- [GetMiPay API Documentation](https://docs.getmipay.com/api-doc/index.md): Welcome to GetMiPay - Your universal gateway to Soleaspay
- [Quick Start](https://docs.getmipay.com/api-doc/quickstart.md): Get started with GetMiPay API in 5 minutes - Complete onboarding guide for merchants
- [Get Balance](https://docs.getmipay.com/api-reference/account/balance.md): Retrieve current merchant account balance
- [Get Bearer Token](https://docs.getmipay.com/api-reference/auth/auth.md): Authenticate once with your public and private API keys. The response returns a Tymon JWT bearer token that must be used for protected API routes. Token lifetime is 24 hours.
- [Check API Key Status](https://docs.getmipay.com/api-reference/auth/check.md): Public endpoint to check the status and validity of an API key without creating a JWT session.
- [ Transaaction Check ](https://docs.getmipay.com/api-reference/check/check-status.md): Directly check transaction status with getmipay using both order ID and payment reference
- [Converter](https://docs.getmipay.com/api-reference/converter/converter.md): Convert an amount from one currency to another using ISO 4217 currency codes. Returns the converted amount in the target currency.
- [Collect payment (Pay-In)](https://docs.getmipay.com/api-reference/payments/payin.md): Collect payment from a customer via mobile money. Requires Authorization: Bearer <jwt>. Also send service and operation headers. OTP is required only for OTP-required services such as OM CI, OM SN, and OM BF.
- [Disburse payment (Pay-out)](https://docs.getmipay.com/api-reference/payouts/create.md): Send money to a customer via mobile money. Requires Authorization: Bearer <jwt>. Also send service and operation headers. The amount will be deducted from your merchant balance immediately.
- [Get Services](https://docs.getmipay.com/api-reference/services/services.md): Retrieve all available payment services activated for the merchant identified by the JWT bearer token. These are the services you can use for PayIn and PayOut operations.
- [Calculate fees for specific card creation](https://docs.getmipay.com/api-reference/virtualCard/Calfees.md): Calculate fees for creating a virtual card based on card grade, type, and initial balance. Returns total fees including both Soleaspay and GetMiPay fees.
- [Get Card Balance](https://docs.getmipay.com/api-reference/virtualCard/balance.md): Retrieve the current balance of a virtual card
- [Get Card User](https://docs.getmipay.com/api-reference/virtualCard/cardUser.md): Retrieve a specific virtual card user by reference
- [Create Card](https://docs.getmipay.com/api-reference/virtualCard/createCard.md): Create a new virtual card for a specific user
- [Create Card User](https://docs.getmipay.com/api-reference/virtualCard/createUser.md): Create a new user for virtual card operations
- [Disable Card](https://docs.getmipay.com/api-reference/virtualCard/disable.md): Disable a virtual card
- [Enable Card](https://docs.getmipay.com/api-reference/virtualCard/enable.md): Enable a disabled virtual card
- [Get all virtual card fee configurations](https://docs.getmipay.com/api-reference/virtualCard/fees.md): Retrieve all active virtual card fee configurations. Fees shown are total amounts including both Soleaspay and GetMiPay fees.
- [Get Card Details](https://docs.getmipay.com/api-reference/virtualCard/fetchCard.md): Retrieve virtual card details by card ID
- [Get All Users](https://docs.getmipay.com/api-reference/virtualCard/fetchUser.md): Retrieve list of all virtual card users
- [List Virtual Cards](https://docs.getmipay.com/api-reference/virtualCard/listCards.md): List virtual cards for the authenticated merchant.
- [Card Operation](https://docs.getmipay.com/api-reference/virtualCard/operation.md): Perform generic operations on virtual card
- [Terminate Card](https://docs.getmipay.com/api-reference/virtualCard/terminate.md): Permanently terminate a virtual card
- [Top Up Card](https://docs.getmipay.com/api-reference/virtualCard/topUp.md): Add funds to a virtual card
- [Card Transactions](https://docs.getmipay.com/api-reference/virtualCard/transaction.md): Retrieve transaction history for a virtual card
- [Update Card User](https://docs.getmipay.com/api-reference/virtualCard/updateUser.md): Update a virtual-card user by user reference.
- [Get Card User Details](https://docs.getmipay.com/api-reference/virtualCard/userDetails.md): Retrieve detailed information for a virtual-card user by user reference.
- [Withdraw from Card](https://docs.getmipay.com/api-reference/virtualCard/withdraw.md): Withdraw funds from a virtual card

## OpenAPI Specs

- [openapi](https://docs.getmipay.com/api-reference/openapi.json)

## Optional

- [About Company](https://getmipay.com/about)
- [Community](https://t.me/+zDwS-7kQrsViMTk0)
- [Pricing](https://getmipay.com/pricing)