# Bitlipa ## API Docs - [Get Members](https://apidocs.bitlipa.com/get-members-25371309e0.md): Lists members belonging to the authenticated partner with pagination via `skip` and `limit`. This is intended for partner dashboards or reconciliation tasks to see which users have been created under the partner’s scope. - [Current Partner](https://apidocs.bitlipa.com/current-partner-25371308e0.md): Returns the partner entity associated with the supplied `apiKey` header. Use this to confirm which partner identity is active for the request and to retrieve metadata such as the partner’s wallet address, slug, and configuration. No request body is required; the endpoint simply reflects the authenticated partner record. - [Create Member](https://apidocs.bitlipa.com/create-member-25371310e0.md): Creates a member for the current partner, keyed on `external_user_id` and phone number. If a wallet address is not supplied, the service provisions a safe address automatically. Repeated calls with the same identifiers are idempotent unless the phone number conflicts, letting partners safely onboard users before payouts or top-ups. - [Get Member](https://apidocs.bitlipa.com/get-member-25371311e0.md): Fetches a single member by external `id` within the current partner. Liquidity-provider partners can look up by the global external `id`, enabling retrieval even when members span multiple contexts. Use this to pull member details before executing transactions. - [Update Member](https://apidocs.bitlipa.com/update-member-25371312e0.md): Updates the stored phone number for a member under the current partner. This keeps contact information current while preserving the stable `external_user_id` used in downstream flows. - [Get Member Safe Info](https://apidocs.bitlipa.com/get-member-safe-info-25371313e0.md): Returns safe contract metadata for the member’s wallet, including owners, threshold, fallback handler, and version. Integrators can inspect custody configuration before initiating on-chain operations involving the member’s Safe - [Withdraw Fiat](https://apidocs.bitlipa.com/withdraw-fiat-25371314e0.md): Initiates a fiat withdrawal after validating an on-chain transfer to the pool wallet via `tx_hash`. The endpoint verifies the token contract and destination, records the withdraw request, converts the crypto amount to fiat, and triggers an Avada payout to the provided phone number. - [Withdraw Fiat For Registered Member](https://apidocs.bitlipa.com/withdraw-fiat-for-registered-member-25371315e0.md): Starts a withdrawal for a registered member identified by `external_user_id`. Funds are moved from the member’s Safe to the pool wallet, then Unipesa is invoked to pay out fiat to the member’s phone. The optional callback URL lets partners receive completion or failure notices without polling. - [Get Withdraw Fiat Pool Info](https://apidocs.bitlipa.com/get-withdraw-fiat-pool-info-25371316e0.md): Returns the pool wallet address and network name so partners know exactly where to send tokens that back fiat withdrawals. Call this to verify the funding target before broadcasting transfers. - [Withdraw Fiat Status](https://apidocs.bitlipa.com/withdraw-fiat-status-25371317e0.md): Retrieves the current status and details of a withdraw request initiated by this partner. Suitable for polling dashboards or support tools that track payout progress (pending, processing, completed, or failed). - [Witdraw Fiat Callback](https://apidocs.bitlipa.com/witdraw-fiat-callback-25371318e0.md): Unipesa webhook receiver for withdrawal events. The handler verifies the signature, updates internal payout status, and if the partner supplied a callback URL during initiation, forwards the finalized payload to that URL. Expose this endpoint publicly for Avada to reach it reliably. - [Topup Fiat](https://apidocs.bitlipa.com/topup-fiat-25371319e0.md): Creates a topup request that collects fiat from the user through Unipesa and, once approved, sends the crypto equivalent from the partner’s Safe to the destination wallet. Inputs include `from_currency`, `to_currency`, `amount`, `phone_number`, `wallet_address`, and `callback_url`. The flow performs balance checks, applies partner fees, and triggers callbacks after completion. - [Topup Fiat Status](https://apidocs.bitlipa.com/topup-fiat-status-25371320e0.md): Returns the status and details for a top-up initiated by this partner. Use this for polling-based integrations when you are not solely relying on callbacks to learn whether payment was authorized, failed, or completed on-chain. - [Topup Fiat Callback](https://apidocs.bitlipa.com/topup-fiat-callback-25371321e0.md): Avada webhook for top-up events. It validates the signature, attaches `partner_id` when provided, transitions the top-up state, executes the crypto transfer if payment succeeded, and triggers the partner’s callback URL when configured. Keep this endpoint reachable by Unipesa and consistent with the callback URL used at initiation. - [Exchange Rates](https://apidocs.bitlipa.com/exchange-rates-25371322e0.md): Fetches the current exchange rate between a crypto token (`base_currency`, default USDC) and a fiat currency (`currency`, default KES). Use this to display live quotes or validate conversions before starting payout or top-up flows. - [Convert To Currency](https://apidocs.bitlipa.com/convert-to-currency-25371323e0.md): Converts a fiat `amount` (default 1) into its crypto equivalent using the latest rates. Accepts `base_currency` for fiat and `currency` for crypto; useful for pre-calculating how much crypto a user will receive during a top-up. - [Get All Transactions](https://apidocs.bitlipa.com/get-all-transactions-25371653e0.md): Returns all withdraw and topup requests for the partner chosen via `x-partner-slug`, along with totals. Admins can audit activity, reconcile payouts, or investigate transaction histories per partner using this aggregated view. - [Read Partners](https://apidocs.bitlipa.com/read-partners-25371654e0.md): Lists partners with pagination (`skip`, `limit`) for admin dashboards or to select a partner slug for downstream scoped operations. - [Create Partner](https://apidocs.bitlipa.com/create-partner-25371655e0.md): Creates a new partner with a unique slug derived from its name and automatically deploys a Safe wallet for them. If wallet deployment fails, the creation is rolled back to avoid half-configured partners. - [Create Api Key](https://apidocs.bitlipa.com/create-api-key-25371656e0.md): Generates an API key for a partner and returns the plaintext key once along with its hashed version stored in the database. Admins must capture the plaintext key at creation time and share it securely with the partner. - [Update Charge Fee](https://apidocs.bitlipa.com/update-charge-fee-25371657e0.md): Updates a partner’s charge fee percentage for topups. Requires the partner ID and the new fee value, returning the updated partner record. - [Login For Access Token](https://apidocs.bitlipa.com/login-for-access-token-25371658e0.md): - [Read Admins Me](https://apidocs.bitlipa.com/read-admins-me-25371659e0.md): - [Create Admin](https://apidocs.bitlipa.com/create-admin-25371660e0.md): - [Create Safe](https://apidocs.bitlipa.com/create-safe-25371661e0.md): - [Create Master Contract](https://apidocs.bitlipa.com/create-master-contract-25371662e0.md): - [Create Master Contract](https://apidocs.bitlipa.com/create-master-contract-25371663e0.md): - [Create Compatibility Fallback Handler](https://apidocs.bitlipa.com/create-compatibility-fallback-handler-25371664e0.md): ## Schemas - [CryptoCurrency](https://apidocs.bitlipa.com/cryptocurrency-11537448d0.md): - [ApiKeyCreate](https://apidocs.bitlipa.com/apikeycreate-11537561d0.md): - [ExchangeRate](https://apidocs.bitlipa.com/exchangerate-11537449d0.md): - [ApiKeyView](https://apidocs.bitlipa.com/apikeyview-11537562d0.md): - [FiatCurrency](https://apidocs.bitlipa.com/fiatcurrency-11537450d0.md): - [AuthCreate](https://apidocs.bitlipa.com/authcreate-11537563d0.md): - [HTTPValidationError](https://apidocs.bitlipa.com/httpvalidationerror-11537451d0.md): - [AuthView](https://apidocs.bitlipa.com/authview-11537564d0.md): - [Member](https://apidocs.bitlipa.com/member-11537452d0.md): - [Body_login_for_access_token_login_post](https://apidocs.bitlipa.com/body-login-for-access-token-login-post-11537565d0.md): - [MemberCreate](https://apidocs.bitlipa.com/membercreate-11537453d0.md): - [EthTx](https://apidocs.bitlipa.com/ethtx-11537566d0.md): - [MemberUpdate](https://apidocs.bitlipa.com/memberupdate-11537454d0.md): - [Partner](https://apidocs.bitlipa.com/partner-11537455d0.md): - [LoginResponse](https://apidocs.bitlipa.com/loginresponse-11537567d0.md): - [PartnerRole](https://apidocs.bitlipa.com/partnerrole-11537456d0.md): - [SafeInfo](https://apidocs.bitlipa.com/safeinfo-11537457d0.md): - [TopupRequestCreate](https://apidocs.bitlipa.com/topuprequestcreate-11537458d0.md): - [ValidationError](https://apidocs.bitlipa.com/validationerror-11537459d0.md): - [PartnerCreate](https://apidocs.bitlipa.com/partnercreate-11537568d0.md): - [WithdrawCreate](https://apidocs.bitlipa.com/withdrawcreate-11537460d0.md): - [WithdrawPartnerCreate](https://apidocs.bitlipa.com/withdrawpartnercreate-11537461d0.md): - [TopupRequestResponse](https://apidocs.bitlipa.com/topuprequestresponse-11537569d0.md): - [WithdrawPartnerResponse](https://apidocs.bitlipa.com/withdrawpartnerresponse-11537462d0.md): - [TransactionListResponse](https://apidocs.bitlipa.com/transactionlistresponse-11537570d0.md): - [UpdateChargingFee](https://apidocs.bitlipa.com/updatechargingfee-11537571d0.md): - [WithdrawRequestResponse](https://apidocs.bitlipa.com/withdrawrequestresponse-11537572d0.md):