# Shimi API | Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.shimi.cash/_mcp/server

## Docs

- [Welcome to Shimi](https://docs.shimi.cash/welcome.md): Banking, payouts, cards, crypto and bill payments for your business, through one API.
- [Quickstart](https://docs.shimi.cash/quickstart.md): Get an access token and make your first API call.
- [Access & KYB](https://docs.shimi.cash/access-and-kyb.md): Authentication, token lifetimes and the KYB check on every request.
- [Responses & idempotency](https://docs.shimi.cash/responses-and-idempotency.md): Response formats, safe retries and how to handle uncertain outcomes when moving money.
- [Webhooks](https://docs.shimi.cash/webhooks.md): How Shimi notifies you about deposits and payouts, and how to build a safe receiver.
- [Support](https://docs.shimi.cash/support.md): Get help with your Shimi integration.
- [API reference](https://docs.shimi.cash/api-reference.md): Every endpoint available to a Shimi merchant, with example responses for success and error cases.

## API Docs

- Shimi API > Webhooks Youll Receive [Sub-account Credited (SUB_ACCOUNT)](https://docs.shimi.cash/api-reference/shimi-api/webhooks-youll-receive/sub-account-credited-subaccount.md)
- Shimi API > Webhooks Youll Receive [Corporate Account Credited (CORPORATE_ACCOUNT)](https://docs.shimi.cash/api-reference/shimi-api/webhooks-youll-receive/corporate-account-credited-corporateaccount.md)
- Shimi API > Webhooks Youll Receive [Virtual Account Funded (VIRTUAL_ACCOUNT)](https://docs.shimi.cash/api-reference/shimi-api/webhooks-youll-receive/virtual-account-funded-virtualaccount.md)
- Shimi API > Webhooks Youll Receive [Payout Succeeded (PAYOUT)](https://docs.shimi.cash/api-reference/shimi-api/webhooks-youll-receive/payout-succeeded-payout.md)
- Shimi API > Webhooks Youll Receive [Payout Failed (PAYOUT)](https://docs.shimi.cash/api-reference/shimi-api/webhooks-youll-receive/payout-failed-payout.md)
- Shimi API > Webhooks Youll Receive [Crypto Deposit Received](https://docs.shimi.cash/api-reference/shimi-api/webhooks-youll-receive/crypto-deposit-received.md)
- Shimi API > Authentication [Generate Access Token](https://docs.shimi.cash/api-reference/shimi-api/authentication/generate-access-token.md)
- Shimi API > Authentication [Refresh Access Token](https://docs.shimi.cash/api-reference/shimi-api/authentication/refresh-access-token.md)
- Shimi API > Customers [List Customers](https://docs.shimi.cash/api-reference/shimi-api/customers/list-customers.md)
- Shimi API > Customers [Create Customer](https://docs.shimi.cash/api-reference/shimi-api/customers/create-customer.md)
- Shimi API > Customers [Fetch Single Customer](https://docs.shimi.cash/api-reference/shimi-api/customers/fetch-single-customer.md)
- Shimi API > Customers [Generate Customer Account](https://docs.shimi.cash/api-reference/shimi-api/customers/generate-customer-account.md)
- Shimi API > Customers [Resend Customer OTP](https://docs.shimi.cash/api-reference/shimi-api/customers/resend-customer-otp.md)
- Shimi API > Customer Transactions [List All Transactions](https://docs.shimi.cash/api-reference/shimi-api/customer-transactions/list-all-transactions.md)
- Shimi API > Customer Transactions [List a Customer's Transactions](https://docs.shimi.cash/api-reference/shimi-api/customer-transactions/list-a-customer-s-transactions.md)
- Shimi API > Customer Transactions [Fetch a Customer's Single Transaction](https://docs.shimi.cash/api-reference/shimi-api/customer-transactions/fetch-a-customer-s-single-transaction.md)
- Shimi API > Virtual Accounts [Generate Virtual Account](https://docs.shimi.cash/api-reference/shimi-api/virtual-accounts/generate-virtual-account.md)
- Shimi API > Virtual Accounts [Fetch Virtual Account Transaction](https://docs.shimi.cash/api-reference/shimi-api/virtual-accounts/fetch-virtual-account-transaction.md)
- Shimi API > Settlement Payouts [Validate Bank Account](https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/validate-bank-account.md)
- Shimi API > Settlement Payouts [Send Payout](https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/send-payout.md)
- Shimi API > Settlement Payouts [Check Payout Status](https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/check-payout-status.md)
- Shimi API > Settlement Payouts [List Settlement Accounts](https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/list-settlement-accounts.md)
- Shimi API > Settlement Payouts [List Supported Banks](https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/list-supported-banks.md)
- Shimi API > Settlement Payouts [List Settlement Ledger Transactions](https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/list-settlement-ledger-transactions.md)
- Shimi API > Settlement Payouts [Fetch One Settlement Transaction](https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/fetch-one-settlement-transaction.md)
- Shimi API > Settlement Payouts [Link Account to Settlement](https://docs.shimi.cash/api-reference/shimi-api/settlement-payouts/link-account-to-settlement.md)
- Shimi API > Corporate Accounts [Initiate Corporate KYC](https://docs.shimi.cash/api-reference/shimi-api/corporate-accounts/initiate-corporate-kyc.md)
- Shimi API > Corporate Accounts [Resend Corporate KYC OTP](https://docs.shimi.cash/api-reference/shimi-api/corporate-accounts/resend-corporate-kycotp.md)
- Shimi API > Corporate Accounts [Validate Corporate KYC OTP](https://docs.shimi.cash/api-reference/shimi-api/corporate-accounts/validate-corporate-kycotp.md)
- Shimi API > Corporate Accounts [Create Corporate Sub-account](https://docs.shimi.cash/api-reference/shimi-api/corporate-accounts/create-corporate-sub-account.md)
- Shimi API > Corporate Accounts [List / Fetch Corporate Sub-accounts](https://docs.shimi.cash/api-reference/shimi-api/corporate-accounts/list-fetch-corporate-sub-accounts.md)
- Shimi API > Crypto [List Available Networks](https://docs.shimi.cash/api-reference/shimi-api/crypto/list-available-networks.md)
- Shimi API > Crypto [List Supported Currencies](https://docs.shimi.cash/api-reference/shimi-api/crypto/list-supported-currencies.md)
- Shimi API > Crypto [Generate Deposit Address](https://docs.shimi.cash/api-reference/shimi-api/crypto/generate-deposit-address.md)
- Shimi API > Crypto [Fetch Pre-generated Address](https://docs.shimi.cash/api-reference/shimi-api/crypto/fetch-pre-generated-address.md)
- Shimi API > Crypto [Activate Deposit Webhook](https://docs.shimi.cash/api-reference/shimi-api/crypto/activate-deposit-webhook.md)
- Shimi API > Crypto [Send Crypto](https://docs.shimi.cash/api-reference/shimi-api/crypto/send-crypto.md)
- Shimi API > Crypto [List Crypto Transactions](https://docs.shimi.cash/api-reference/shimi-api/crypto/list-crypto-transactions.md)
- Shimi API > Card Issuing [Create Card Customer](https://docs.shimi.cash/api-reference/shimi-api/card-issuing/create-card-customer.md)
- Shimi API > Card Issuing [Generate Card](https://docs.shimi.cash/api-reference/shimi-api/card-issuing/generate-card.md)
- Shimi API > Card Issuing [Fund Card](https://docs.shimi.cash/api-reference/shimi-api/card-issuing/fund-card.md)
- Shimi API > Card Issuing [Fetch Card Details](https://docs.shimi.cash/api-reference/shimi-api/card-issuing/fetch-card-details.md)
- Shimi API > Card Issuing [Generate Card Token](https://docs.shimi.cash/api-reference/shimi-api/card-issuing/generate-card-token.md)
- Shimi API > Card Issuing [Send Default PIN](https://docs.shimi.cash/api-reference/shimi-api/card-issuing/send-default-pin.md)
- Shimi API > Card Issuing [Change Card PIN](https://docs.shimi.cash/api-reference/shimi-api/card-issuing/change-card-pin.md)
- Shimi API > Airtime Data Bills Vtu [List Services](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/list-services.md)
- Shimi API > Airtime Data Bills Vtu [List Service Categories](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/list-service-categories.md)
- Shimi API > Airtime Data Bills Vtu [List Category Products](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/list-category-products.md)
- Shimi API > Airtime Data Bills Vtu [Verify Entity (Meter / Smartcard)](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/verify-entity-meter-smartcard.md)
- Shimi API > Airtime Data Bills Vtu [Purchase Airtime](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/purchase-airtime.md)
- Shimi API > Airtime Data Bills Vtu [Purchase Data](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/purchase-data.md)
- Shimi API > Airtime Data Bills Vtu [Purchase Utility Bill](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/purchase-utility-bill.md)
- Shimi API > Airtime Data Bills Vtu [Purchase Cable TV](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/purchase-cable-tv.md)
- Shimi API > Airtime Data Bills Vtu [List VTU Transactions](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/list-vtu-transactions.md)
- Shimi API > Airtime Data Bills Vtu [Fetch Single VTU Transaction](https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/fetch-single-vtu-transaction.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.shimi.cash/openapi.json)
- [OpenAPI YAML](https://docs.shimi.cash/openapi.yaml)