--- title: Chimoney API Integration on Truto slug: chimoney category: Payment Gateway canonical: "https://truto.one/integrations/detail/chimoney/" --- # Chimoney API Integration on Truto **Category:** Payment Gateway **Status:** Beta ## MCP-ready AI tools Truto exposes 86 tools for Chimoney that AI agents can call directly. - **create_a_chimoney_beneficiary_bank** — Create a new bank beneficiary in chimoney. Returns status, message, and data containing id, beneID, and templateId. Required: beneficiaryData (with accountHolderName, accountHolderAddress1, accountHolderCity, bankName, bankCity, bankAddressLine1, accountNumber, routingCode, currency, and country). - **create_a_chimoney_beneficiary_preview** — Preview a beneficiary transfer in Chimoney (supports PIX and other payment methods). Returns: status, message, data. Required: method, country, currency. - **list_all_chimoney_info_airtime_countries** — List all supported airtime countries in Chimoney. Returns an array of country name strings including Nigeria, Ghana, Kenya, South Africa, and Uganda. - **list_all_chimoney_info_country_states_regions** — List states/regions for a specific country in Chimoney. Returns each region's code and name. Required: countryCode (two-letter ISO 3166-1 alpha-2 country code, e.g. "US"). - **list_all_chimoney_info_assets** — List all Chimoney assets and platform capabilities. Returns: benefitsList, supportedCountriesAirtime, momoRedeemOptions, acceptedTokens, giftCardsRLD, crytoFacts, celoWalletAddress, contests, fees, validity, subscriptionPlans, giftCardsWG, ecommerce, featuredProducts. Optionally filter by countryCode. - **list_all_chimoney_info_country_banks** — List supported banks and bank codes for a given country in Chimoney. Returns: id, code, name. Required: countryCode. - **list_all_chimoney_info_bank_branches** — List bank branches and their branch codes for a given bank in Chimoney. Returns: id, branch_code, branch_name, swift_code, bic, bank_id. Required: bankID. - **list_all_chimoney_info_bank_searches** — Search for banks in chimoney by name and country. Returns a list of matching bank records including primaryKey, institutionName, city, region, country, countryISO, postalCode, swiftBIC, nationalBankCode, nationalBankCodeType, officeType, branchName, phone, and fax. Required: country (ISO 3166-1 alpha-2), search (minimum 2 characters). - **list_all_chimoney_info_exchange_rates** — List current exchange rates from Chimoney. Returns currency pair rate values (e.g., USDAED, NGNUSD, NGNSTN) along with validUntil, expiresAt, and expiresAtTimestamp indicating when the rates expire. No required parameters. - **list_all_chimoney_info_local_amount_in_usds** — Convert a local currency amount to USD in Chimoney. Returns: amountInOriginCurrency, originCurrency, amountInUSD, validUntil. Required: originCurrency, amountInOriginCurrency. - **list_all_chimoney_convert_local_amount_to_usds** — Convert a local currency amount to USD in chimoney. Returns: amountInOriginCurrency, originCurrency, amountInUSD, validUntil. Required: originCurrency, amountInOriginCurrency. - **list_all_chimoney_info_usd_amount_in_locals** — Convert a USD amount to a local currency amount in Chimoney. Returns: amountInUSD, destinationCurrency, amountInDestinationCurrency, validUntil. Required: destinationCurrency, amountInUSD. - **list_all_chimoney_convert_usd_to_local_amounts** — Convert a USD amount to a local currency amount in Chimoney. Returns: amountInUSD, destinationCurrency, amountInDestinationCurrency, validUntil. Required: destinationCurrency, amountInUSD. - **list_all_chimoney_info_mobile_money_codes** — List all supported mobile money codes in Chimoney. Returns: name, country, code, provider. - **create_a_chimoney_info_verify_bank_account_number** — Verify one or more bank account numbers in Chimoney. Returns: account_name, account_number, status, message, data. Required: verifyAccountNumbers (array of objects each with countryCode, account_bank, and account_number). - **list_all_chimoney_info_beneficiary_rules** — List beneficiary validation rules for a specific country in Chimoney. Returns the set of required fields and their constraints, including name, label, regexPattern, validValues, inputType, defaultValue, and required flag for each field. Required: country_code. - **list_all_chimoney_info_identification_types** — List all supported identification types and their codes in Chimoney. Returns: code. - **create_a_chimoney_info_fee_estimate** — Estimate chimoney transaction fees before executing a payout or funding operation. Returns: status, message, data. Required: amount. When rail is omitted, assumes a standard chimoney payout and currency must be USD. - **list_all_chimoney_multicurrency_wallets_gets** — Get details of a chimoney multicurrency wallet by its ID. Returns the wallet record including id, firstName, lastName, verified, phoneNumber, feePercent, parent, tier, accountSecondCurrencies, and wallets (each with balance, type, owner, and transactions). Required: id. - **create_a_chimoney_payouts_airtime** — Create an airtime payout to one or more phone numbers via Chimoney. Returns: status, message, data. Required: airtimes (each item requires countryToSend, phoneNumber, and valueInUSD). - **create_a_chimoney_payouts_bank** — Create a bank payout to a supported country via Chimoney. Returns status, message, and data containing chimoneys and payouts arrays. Required: banks (array; each item requires countryToSend, account_bank, and account_number). Note: fullname and branch_code are required per bank entry for all countries except Nigeria. - **create_a_chimoney_payouts_chimoney** — Create a Chimoney payout to one or more recipients in Chimoney. Returns: status, message, data. Required: chimoneys. - **create_a_chimoney_payouts_wallet** — Create a payout to one or more Chimoney wallets. Returns status, message, and a data object containing paymentLink, chimoneys, and payouts. Required: wallets (array of payout targets, each with receiver and valueInUSD). - **create_a_chimoney_payouts_gift_card** — Create a Chimoney gift card payout to one or more recipients by email. Returns status, message, and data containing chimoneys (with id, issueID, valueInUSD, fee, chiRef, email, status, and issueDate per entry) and payouts. Required: giftcards (each item requires email and valueInUSD). - **create_a_chimoney_payouts_mobile_money** — Create a mobile money (Momo) payout in Chimoney, sending funds to one or more recipients via their mobile money accounts. Each entry in the momos array must include countryToSend, phoneNumber, valueInUSD, and momoCode. Returns: status, message, data. Required: momos. - **create_a_chimoney_payouts_interac** — Create an Interac payout in Chimoney, sending funds via Interac e-Transfer to one or more recipients. Returns: status, message, data. Required: debitCurrency and interacs array (each item requires email, name, and amount). - **create_a_chimoney_payouts_spei** — Create a SPEI (Mexican bank transfer) payout in Chimoney. Returns: status, message, data. Required: speis (array; each item requires beneficiary and amount; provide clabe, phoneNum, or debitCard as recipient identifier). - **create_a_chimoney_payouts_status** — Check the status of a Chimoney payout by chi reference. Returns: status, message, data. Required: chiRef. - **create_a_chimoney_payouts_initiate_chimoney** — Initiate a Chimoney transaction in Chimoney, sending funds to one or more recipients via email, phone, Twitter handle, crypto wallet, or bank account. Returns: status, message, data. Required: chimoneys. - **create_a_chimoney_redeem_airtime** — Redeem mobile airtime via chimoney for a recipient phone number and country. Returns: status, message, data. Required: chiRef, phoneNumber, countryToSend. - **create_a_chimoney_redeem_chimoney** — Redeem one or more Chimoneys in chimoney by submitting an array of Chimoney payment objects. Returns status, message, and data including paymentLink, a data array with per-redemption fields (id, chiRef, redeemLink, fee, status, issueDate), and error. Required: chimoneys. - **create_a_chimoney_redeem_gift_card** — Redeem a chimoney gift card by chi reference and redemption options. Returns: status, message, data. Required: chiRef, redeemOptions. - **create_a_chimoney_redeem_mobile_money** — Redeem a chimoney mobile money payment by chi reference. Returns status, message, and a data object containing payout details including id, payoutLink, account_number, currency, amount, reference, and status. Required: chiRef, redeemOptions. - **list_all_chimoney_sub_account_gets** — Get details of an existing chimoney sub-account by its ID. Returns: status, message, data. Required: id. - **list_all_chimoney_kyc_links** — Get the KYC verification page link for a chimoney sub-account. Returns: kycUrl, subAccountID, redirectUrl, account_number, amount, bank_code, bank_name, complete_message, created_at, currency, debit_currency, fee, full_name, id, is_approved, meta, reference, requires_approval, status. Required: subAccountID. - **list_all_chimoney_account_transactions** — List chimoney account transactions for an account, optionally scoped to a sub-account and filtered by currency, debit currency, status, or date range. Returns: id, issueDate, issueID, chiRef, status, initiatedBy, issuer, email, chimoney, valueInUSD, productId, valueInLocalCurrency, twitter, countryCode, redeemData, payout, integration, enabledToRedeem, pagination, account_number, amount,… - **get_single_chimoney_account_transaction_by_id** — Get a single chimoney account transaction by id. Returns: id, issueDate, issueID, chiRef, status, initiatedBy, issuer, email, chimoney, valueInUSD, enabledToRedeem, account_number, amount, bank_code, bank_name, complete_message, created_at, currency, debit_currency, fee, full_name, is_approved, meta, reference, requires_approval. Required: id. - **create_a_chimoney_account_issue_id_transaction** — Get Chimoney transaction details by issueID. Returns: id, account_number, issueID, fee, account_bank, issuer, enabledToRedeem, reference, quote, chiRef, issueDate, initiatedBy, redeemData, valueInUSD, chimoney, countryToSend, amount, personalizedMessage, branch_code, t_id, collectionPaymentIssueID, narration, integration, fullname, paymentDate, redeemDate, meta, payout, updatedDate, status,… - **create_a_chimoney_account_public_profile** — Create a Chimoney account public profile linked to a user. Returns: status, message, data, eventType. Accepts userID, linkCode, p_id, and interledgerWalletAddress in the request body. - **create_a_chimoney_account_transfer** — Create a Chimoney account transfer to a specified receiver. Returns status, message, eventType, and a data object containing id, amount, fee, currency, reference, created_at, and transfer status. Required: receiver, valueInUSD. - **delete_a_chimoney_account_unpaid_transaction_by_id** — Delete an unpaid transaction in Chimoney. Returns an empty 204 response on success. - **create_a_chimoney_account_wallet_address** — Issue a Chimoney Interledger wallet address for a user. Returns: status, message, data, eventType. - **create_a_chimoney_account_reward** — Claim a community membership reward in Chimoney by submitting eligibility details. Returns: status, message, data, eventType. Required: userID, community (with communityID). - **create_a_chimoney_agent** — Create a new Chimoney agent equipped with wallet, identity, and policy capabilities. Returns: status, data, id, created_at, updated_at. - **list_all_chimoney_agents** — List all Chimoney agents associated with the account. Returns: id, created_at, updated_at. - **get_single_chimoney_agent_by_id** — Get a single Chimoney agent record. Returns: id, created_at, updated_at. - **update_a_chimoney_agent_by_id** — Update an existing Chimoney agent's details. Returns: status, data, id, created_at, updated_at. - **chimoney_agents_update_policies** — Update the compliance policies for a Chimoney agent, such as daily spending limits, per-transaction caps, and recipient allowlists. Returns: status, data, id, created_at, updated_at. - **chimoney_agents_suspend** — Suspend a Chimoney AI agent, temporarily halting its ability to transact and spend. Returns an empty 204 response on success. - **chimoney_agents_reactivate** — Reactivate a previously suspended Chimoney AI agent, restoring its transacting and spending capabilities. Returns an empty 204 response on success. - **chimoney_agents_fund** — Add funds to a Chimoney AI agent's wallet to enable or top up its transacting balance. Returns an empty 204 response on success. - **list_all_chimoney_agent_api_keys** — List all Chimoney agent API keys associated with the authenticated account. Returns: id, key, appName, webhookUrl, createdAt, revoked, revokedAt, created_at, updated_at. - **create_a_chimoney_agent_api_key** — Create, rotate, revoke, delete, or update the webhook for a Chimoney agent API key (each agent may hold only one key at a time). Returns: status, data, message. Required: agentId, action. - **list_all_chimoney_agent_transactions** — List transactions for a Chimoney agent, with optional filtering by sub-account, date range, currency, and status. Returns: id, status, currency, debitCurrency, createdAt, updatedAt. - **list_all_chimoney_agent_capabilities_limits** — List capabilities and spending limits configured for AI agents in Chimoney, reflecting the platform's policy-layer guardrails such as transaction caps, velocity rules, and authorization constraints. Returns: version, capabilities, limits, regions, id, created_at, updated_at. - **create_a_chimoney_invoice** — Generate a Chimoney invoice from a natural language instruction using AI. Returns an AI-generated invoice object whose fields are determined by the content of the instruction. Required: instruction. - **list_all_chimoney_beneficiaries** — List beneficiaries in chimoney. Returns: id, accountNumber, bankCurrency, channel, createdDate, created_at, updated_at. - **create_a_chimoney_info_community_verify_code** — Validate a Chimoney-issued community voucher code. Returns: status, message, data. Required: code. - **create_a_chimoney_info_bill_merchants_ca** — Retrieve Canadian bill merchant reference data from Chimoney via a POST request. Returns opaque merchant data for Canada; the per-endpoint source was unavailable so specific request parameters and response fields cannot be enumerated — consult the Chimoney API docs for the full payload shape. - **create_a_chimoney_multicurrency_wallet** — Create a new chimoney multicurrency wallet. Returns the created wallet object including id, createdAt, and updatedAt. - **update_a_chimoney_multicurrency_wallet_by_id** — Update an existing chimoney multicurrency wallet. Returns the updated wallet object including id, createdAt, and updatedAt. - **list_all_chimoney_multicurrency_wallets** — List chimoney multicurrency wallets. Returns a collection of wallet objects, each including id, createdAt, and updatedAt. - **chimoney_multicurrency_wallets_transfer** — Transfer funds between chimoney multicurrency wallets. Returns the transfer result including id, createdAt, and updatedAt. - **chimoney_multicurrency_wallets_get_quote** — Get a transfer quote for a Chimoney multicurrency wallet transfer. No field-level documentation was available in the discovered source for this endpoint; consult the Chimoney API reference for required body parameters and the returned quote structure. - **chimoney_multicurrency_wallets_request** — Create a payment request against a Chimoney multicurrency wallet. No field-level documentation was available in the discovered source for this endpoint; consult the Chimoney API reference for required body parameters and the returned request object structure. - **chimoney_multicurrency_wallets_create_bank_account** — Create and link a bank account to a Chimoney multicurrency wallet. No field-level documentation was available in the discovered source for this endpoint; consult the Chimoney API reference for required body parameters and the returned bank account object structure. - **create_a_chimoney_passport** — Create a new passport in Chimoney by submitting a JSON body to the passport endpoint. No field-level source documentation was available for this endpoint; consult the Chimoney API reference for required body parameters and the structure of the returned passport record. - **chimoney_payments_initiate** — Initiate a Chimoney payment request for a payer. Returns status, message, and a data object including paymentLink, issueID, payerEmail, valueInUSD, chimoney, and cryptoPayment details. Required: payerEmail. - **chimoney_payments_verify** — Verify a Chimoney payment by its ID to confirm processing status. Returns status, message, and a data object including paymentLink, error, and cryptoPayment details. Required: id. - **chimoney_payments_simulate** — Simulate a Chimoney payment status change for sandbox testing. Accepted status values include failed, expired, fraud, and paid. Returns status, message, and a data object including paymentLink, error, and cryptoPayment. Required: issueID, status. Only works in staging. - **chimoney_payments_simulate_interac_funding** — Simulate an Interac e-Transfer funding flow in Chimoney's sandbox environment. Returns status, message, and a data object including simulated, simulatedAmount, chiRef, and status. At least one of reference or amount must be provided. - **chimoney_payments_simulate_funding** — Simulate a funding transaction via a specified payment rail in Chimoney's sandbox environment. Returns status and a data object including simulated, simulatedAmount, and rail. Required: rail. Only available in staging or sandbox. - **create_a_chimoney_payouts_interledger_wallet_address** — Create a payout to an Interledger wallet address in Chimoney. Initiates a disbursement to one or more Interledger wallet addresses (e.g. $ilp.chimoney.io/yourname-agentname). Returns an empty 204 response on success. - **create_a_chimoney_payouts_process** — Process a Chimoney payout by submitting an issue ID or collection payment issue ID for execution. Returns an empty 204 response on success. - **create_a_chimoney_payouts_bills_ca** — Create a Canadian bill payment payout via Chimoney. Returns an empty 204 response on success. - **create_a_chimoney_redeem_any** — Create a chimoney redemption using any available payment method on the Chimoney platform. Specific request body fields and response fields are not documented in the available source for this endpoint. - **create_a_chimoney_sub_account** — Create a new chimoney sub-account. Returns status, message, and data including the new sub-account's id, uid, name, email, parent, verified, and verification details. Required: name. - **update_a_chimoney_sub_account_by_id** — Update an existing chimoney sub-account's metadata and profile details. Returns status, message, and data containing the write timestamp (_writeTime) of when the update occurred. Required: id, meta. - **delete_a_chimoney_sub_account_by_id** — Delete a chimoney sub-account. Returns an empty 204 response on success. - **list_all_chimoney_sub_accounts** — List all chimoney sub-accounts. Returns a collection of sub-account records each containing id and attributes. - **create_a_chimoney_community** — Create a new community in chimoney. Returns: status, message, data, id, createdAt, updatedAt. - **update_a_chimoney_community_by_id** — Update an existing community in chimoney. Returns: status, message, data, id, createdAt, updatedAt. - **chimoney_communities_list_members** — List members of a chimoney community. Returns member records including id, createdAt, updatedAt. - **list_all_chimoney_wallets** — List Chimoney wallets associated with the account. Returns a collection of wallet records; each record includes id, created_at, and updated_at. - **chimoney_wallets_lookup** — Look up a specific Chimoney wallet by its identifier. Returns wallet details including id, created_at, and updated_at. - **chimoney_wallets_transfer** — Transfer funds between Chimoney wallets. Returns the resulting transfer record including id, created_at, and updated_at. ## How it works 1. **Link your customer's Chimoney account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Chimoney.** The Proxy API is a 1-to-1 mapping of the Chimoney API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Offer Global Payouts to End Users** — SaaS platforms in gig economy, creator, or HR spaces can let their users withdraw earnings via bank transfer, mobile money, airtime, or gift cards across dozens of countries — without building local payout rails themselves. - **Embed Multi-Currency Wallets with KYC** — Fintech and marketplace SaaS products can provision Chimoney sub-accounts and multi-currency wallets for their users, including hosted KYC flows, to offer white-labeled ledgering without becoming a regulated entity. - **Automate Rewards and Incentive Distribution** — Survey, marketing, and HR platforms can trigger micro-rewards like airtime top-ups or gift cards the moment an end user completes an action, removing the need to manage cross-border compliance or gift card vendor relationships. - **Provision AI Agent Wallets with Spend Policies** — DevTool and AI infrastructure SaaS companies can mint programmatic agent wallets for their customers, set policy-based spending caps, and fund them so autonomous agents can transact within strict guardrails. - **Validate Beneficiaries Before Payout** — Any platform disbursing money at scale can use dynamic beneficiary rules and bank account verification to reduce failed transactions and surface the correct payout fields per country in their UI. ## What you can build - **Multi-Rail Withdrawal Center** — Give end users a single UI to withdraw funds via bank transfer, mobile money, airtime, gift card, or Interac — routing each request through the appropriate Chimoney payout endpoint. - **Dynamic Beneficiary Onboarding Forms** — Use beneficiary rules and country/bank lookups to render the exact required fields per destination, then verify bank account numbers before saving the beneficiary. - **Sub-Account Provisioning with Hosted KYC** — Automatically create a Chimoney sub-account and multi-currency wallet for each of your users on signup, and surface a hosted KYC link inside your product to complete verification. - **Automated Rewards Engine** — Trigger airtime, gift card, or Chimoney payouts from workflow events in your app, with real-time payout status polling to update the recipient's UI. - **AI Agent Spend Console** — Let customers create agents, apply spending policies, fund them, and monitor agent transactions and capability limits — all embedded natively in your product. - **FX Quote & Conversion Widget** — Show users live USD-to-local conversions and fee estimates before they confirm a payout, using Chimoney's exchange rate and fee estimation endpoints. ## FAQs ### How does authentication work when my end users connect their Chimoney account? Truto handles credential storage and injection for Chimoney API keys. Your end users provide their Chimoney credentials once through Truto's connection flow, and Truto manages secure token handling for every subsequent API call your app makes on their behalf. ### Which payout rails are available through the Chimoney integration? The integration supports bank transfers, mobile money, airtime, gift cards, Chimoney wallet transfers, Interac (Canada), SPEI (Mexico), and Interledger wallet addresses — each exposed as a dedicated payout endpoint through Truto. ### Can I check the status of a payout after it's been initiated? Yes. Use the payout status endpoint to poll for the current state of any initiated transaction, and the account transactions endpoints to list or fetch individual transaction records for reconciliation. ### Does the integration support AI agent wallets and policy-based spending? Yes. You can create agents, update their spending policies, fund them, list their transactions, and inspect their capability limits — all through dedicated Chimoney agent endpoints exposed via Truto. ### How do I handle country-specific bank field requirements? Chimoney exposes beneficiary rules, country bank lists, bank branches, and bank search endpoints. You can call these to dynamically render the correct payout form per country and verify bank account numbers before submitting a payout. ### Can end users hold balances in multiple currencies? Yes. The integration supports creating and updating multi-currency wallets, transferring between them, requesting quotes, and generating bank account details tied to a wallet — enabling embedded multi-currency treasury features in your product. ## Related reading - [Connect Chimoney to ChatGPT: Automate Global Payouts & Transfers](https://truto.one/blog/connect-chimoney-to-chatgpt-automate-global-payouts-transfers/) — Learn how to build a managed MCP server for Chimoney to automate global payouts, multi-currency wallets, and FX rates natively from ChatGPT. - [Connect Chimoney to Claude: Manage Wallets, Rates & Global Payouts](https://truto.one/blog/connect-chimoney-to-claude-manage-wallets-rates-global-payouts/) — Learn how to securely connect Chimoney to Claude using a managed MCP server. Automate global payouts, multi-currency wallets, and exchange rate queries. - [Connect Chimoney to AI Agents: Orchestrate Multi-Rail Disbursements](https://truto.one/blog/connect-chimoney-to-ai-agents-orchestrate-multi-rail-disbursements/) — Learn how to connect Chimoney to AI Agents using Truto's /tools endpoint. Build autonomous workflows for global payouts, bank verification, and multi-rail disbursements without custom code.