- Category: payment processing
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 19
- Triggers: 0
- Slug:
FINMO - Version: 20261101_00
Tools
Create Customer
Create Customer
Slug:
FINMO_CREATE_CUSTOMERCreate a Finmo customer profile containing personal or company identity data; this may start compliance workflows but does not itself move money. The API key determines whether the profile is created in production or sandbox.Input Parameters
Required when type is company and forbidden when type is individual. Company identity, registration, address, contact, and document data. Only name is always required; every other nested field, including authorized_user, is required only by the organization’s KYC configuration, and Finmo holds a profile missing them in a pending state.
Required when type is individual and forbidden when type is company. Personal identity, address, contact, and document data. Only first_name and last_name are always required; every other nested field is required only by the organization’s KYC configuration, and Finmo holds a profile missing them in a pending state.
Unique key for this exact customer creation. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
Output
Create Payin
Create Payin
Slug:
FINMO_CREATE_PAYINCreate a real production payin that can collect money from a customer and credit a customer or merchant wallet. This has real financial effects. First call FINMO_LIST_PAYIN_METHODS and FINMO_GET_PAYIN_METHOD_REQUIREMENTS, then supply exactly the selected method’s required parameters. Reuse the same idempotency_key only for an identical retry within 8 days. A 499 or 504 may mean Finmo already processed the payment: do not blindly retry; check the payin or transaction state with the same merchant reference, or contact Finmo.Input Parameters
Payin amount as a positive integer in the unit required by the selected method and currency.
Webhook destination for payin updates. If omitted, Finmo uses the dashboard-configured webhook.
Customer redirect URL for both success and failure. Use only when advanced_redirect_url is omitted.
Unique key for this exact payin operation. Reuse it only when retrying an identical request; Finmo retains keys for 8 days.
Wallet to credit. If omitted, Finmo uses the organization payin wallet where supported; a customer with multiple linked wallets may require it.
Method-specific fields required by FINMO_GET_PAYIN_METHOD_REQUIREMENTS. Supply exactly the fields required for the selected method.
Outcome-specific redirect URLs. When supplied, provide all completed, cancelled, expired, and failed URLs.
Output
Create Payout
Create Payout
Slug:
FINMO_CREATE_PAYOUTCreate a payout from a Finmo wallet to a beneficiary, which can reserve and irreversibly transfer funds. The API key determines whether the request uses production or sandbox; cross-currency requests require an FX rate ID and a timeout may leave the outcome uncertain.Input Parameters
Webhook destination for payout updates. If omitted, Finmo uses the dashboard-configured webhook.
Positive source amount. Supply this and/or beneficiary_amount exactly as required by the selected payout method.
Unique key for this exact payout operation. Reuse it only for an identical retry within Finmo’s 8-day idempotency window.
Optional three-letter source currency required by some methods. For cross-currency payouts, provide the matching fx_rate_id.
Positive destination amount. Supply this and/or sender_amount exactly as required by the selected payout method.
Enabled method returned by FINMO_LIST_PAYOUT_METHODS. Retrieve its current requirements before every payout.
Inline sender fields exactly as returned by FINMO_GET_PAYOUT_METHOD_REQUIREMENTS, and only when that method requires them. Do not combine this with payout_sender_id.
Existing stored beneficiary token when available. A newly created beneficiary may require 24 hours before activation.
Inline beneficiary fields exactly as named and required by FINMO_GET_PAYOUT_METHOD_REQUIREMENTS for the selected method. This object is deliberately dynamic; do not guess fields from another rail.
Output
Create Payout Beneficiary
Create Payout Beneficiary
Slug:
FINMO_CREATE_PAYOUT_BENEFICIARYCreate a payout beneficiary with sensitive bank, proxy, identity, and contact details for use in later payouts, without itself moving money. The API key determines whether the beneficiary is created in production or sandbox; activation may take 24 hours.Input Parameters
Required when type is company and forbidden when type is individual. Provide the identity and contact details required by the selected payout method. Finmo stores this sensitive production data.
Required when type is individual and forbidden when type is company. Provide the identity and contact details required by the selected payout method. Finmo stores this sensitive production data.
Method-specific bank or proxy destination. Supply only fields required by FINMO_GET_PAYOUT_METHOD_REQUIREMENTS. Finmo stores these sensitive destination details in production.
Unique key for this exact creation request. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
Controls Finmo’s checks during beneficiary creation. Omit this object to leave the behavior unspecified; Finmo does not document a default.
Output
Create Refund
Create Refund
Slug:
FINMO_CREATE_REFUNDCreate a full refund request for a completed Finmo payin, which may debit or hold wallet funds, incur fees, and be irreversible. The API key determines whether the request uses production or sandbox.Input Parameters
Refundable completed Finmo payin reference beginning payin_. This request creates the provider-default full refund.
Unique key for this refund operation. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
Output
Get Payin Method Requirements
Get Payin Method Requirements
Get Payment
Get Payment
Get Payout Method Requirements
Get Payout Method Requirements
Get Wallet
Get Wallet
List Customers
List Customers
Slug:
FINMO_LIST_CUSTOMERSList one page of individual or company customer profiles and wallet-readiness state. Returns a continuation cursor when more customers are available.Input Parameters
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
Output
List Payin Methods
List Payin Methods
List Payins
List Payins
Slug:
FINMO_LIST_PAYINSList inbound payment attempts with status, method, customer, wallet, and time filters. Returns one page and a continuation cursor.Input Parameters
Payin status to match: PENDING, COMPLETED, EXPIRED, CANCELLED, CREATED, or FAILED.
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
Output
List Payout Beneficiaries
List Payout Beneficiaries
Slug:
FINMO_LIST_PAYOUT_BENEFICIARIESList one page of stored payout beneficiaries and their destination details. Returns a continuation cursor when more beneficiaries are available; use payout method discovery to assess rail suitability.Input Parameters
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
Output
List Payout Methods
List Payout Methods
Slug:
FINMO_LIST_PAYOUT_METHODSList one page of enabled payout rails for a sender and beneficiary country/currency pair. Results may use wildcard sender values. Inspect the returned beneficiary requirements, then call FINMO_GET_PAYOUT_METHOD_REQUIREMENTS for current beneficiary and sender fields before creating a payout or beneficiary. Returns a continuation cursor when more methods are available.Input Parameters
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
Two-letter sender country code. Required for the first page; omit only when supplying next_cursor.
Three-letter sender currency code. Required for the first page; omit only when supplying next_cursor.
Two-letter beneficiary country code. Required for the first page; omit only when supplying next_cursor.
Three-letter beneficiary currency code. Required for the first page; omit only when supplying next_cursor.
Output
List Payouts
List Payouts
Slug:
FINMO_LIST_PAYOUTSList one page of outbound payments with status, payout method, and time filters. Returns a continuation cursor when more payouts are available.Input Parameters
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
Output
List Refunds
List Refunds
Slug:
FINMO_LIST_REFUNDSList one page of refunds with status, originating payin, amount, and time filters. Returns a continuation cursor when more refunds are available.Input Parameters
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
Output
List Transactions
List Transactions
Slug:
FINMO_LIST_TRANSACTIONSList organization-level financial transactions for reconciliation, filtered by customer, event type, settlement, reconciliation, or time. Returns one page and a continuation cursor.Input Parameters
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
Output
List Wallets
List Wallets
Slug:
FINMO_LIST_WALLETSList one page of Finmo wallets available to the connected organization or a customer. Returns a continuation cursor when more wallets are available. Summaries exclude balances; use FINMO_GET_WALLET for wallet accounts and balances.Input Parameters
Wallet category to match: PAYIN, PAYOUT, FEES, GENERAL, or GCA.
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
Output
Transfer Wallet Funds
Transfer Wallet Funds
Slug:
FINMO_TRANSFER_WALLET_FUNDSTransfer funds between two Finmo wallets; depending on the credentials used, this may move real production funds and may be irreversible. Use a unique idempotency key for each transfer, and check transfer and transaction state after an ambiguous failure before retrying.Input Parameters
Positive transfer amount in major currency units. Use the number of decimal places defined for the selected currency by ISO 4217.
Source Finmo wallet to debit. Before calling, use FINMO_GET_WALLET to verify it is active and has sufficient available balance in currency.
Unique key for this exact transfer. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
Destination Finmo wallet to credit. Before calling, verify this exact wallet is active, intended, and supports currency.