Skip to main content
Finmo logo
  • Category: payment processing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 19
  • Triggers: 0
  • Slug: FINMO
  • Version: 20261101_00

Tools

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

string ("individual" | "company")
required
Customer profile type: individual or company.
object
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.
object
Merchant-defined metadata to retain with the customer.
object
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.
string
Human-readable customer description.
string
required
Unique key for this exact customer creation. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
string
required
Declared purpose for the customer’s account.
string
Merchant-side reference for the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
required
Payin amount as a positive integer in the unit required by the selected method and currency.
string
required
Three-letter ISO 4217 currency code supported by the selected method.
object
Merchant-defined metadata to retain with the payin.
integer
Epoch timestamp at which the payin expires.
string
Finmo payin type, such as DIRECT_PAYIN.
string
Existing Finmo customer to associate with this payin.
string
Human-readable description of the payment.
string
Webhook destination for payin updates. If omitted, Finmo uses the dashboard-configured webhook.
string
Customer redirect URL for both success and failure. Use only when advanced_redirect_url is omitted.
string
Email address that should receive the payment receipt.
string
Finmo fees wallet reference (wallet_*) used to collect payin fees.
string
required
Unique key for this exact payin operation. Reuse it only when retrying an identical request; Finmo retains keys for 8 days.
string
Wallet to credit. If omitted, Finmo uses the organization payin wallet where supported; a customer with multiple linked wallets may require it.
string
required
Enabled method returned by FINMO_LIST_PAYIN_METHODS.
object
required
Method-specific fields required by FINMO_GET_PAYIN_METHOD_REQUIREMENTS. Supply exactly the fields required for the selected method.
object
Outcome-specific redirect URLs. When supplied, provide all completed, cancelled, expired, and failed URLs.
string
Unique merchant-side reference used to identify this payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

object
Merchant-defined metadata to retain with the payout.
string
Finmo FX quote to apply. Required when sender_currency and beneficiary_currency differ.
string
Human-readable payout description.
string
Webhook destination for payout updates. If omitted, Finmo uses the dashboard-configured webhook.
string
Transaction purpose code required by the selected rail.
string
Email address to receive the payout receipt.
integer
Positive source amount. Supply this and/or beneficiary_amount exactly as required by the selected payout method.
string
Wallet from which Finmo should charge payout fees.
string
Two-letter country code for the payout sender.
string
required
Funded Finmo wallet to debit for this payout.
string
required
Unique key for this exact payout operation. Reuse it only for an identical retry within Finmo’s 8-day idempotency window.
object
Optional beneficiary-name-match controls documented by Finmo.
string
Optional three-letter source currency required by some methods. For cross-currency payouts, provide the matching fx_rate_id.
string
Reference shown for the payout where supported.
string
Existing stored payout-sender token. Do not combine this with payout_sender_param.
integer
Positive destination amount. Supply this and/or sender_amount exactly as required by the selected payout method.
string
required
Enabled method returned by FINMO_LIST_PAYOUT_METHODS. Retrieve its current requirements before every payout.
object
Dynamic rail-specific fields exactly as returned by FINMO_GET_PAYOUT_METHOD_REQUIREMENTS.
object
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.
string
required
Three-letter destination currency supported by the selected method.
string
Existing stored beneficiary token when available. A newly created beneficiary may require 24 hours before activation.
object
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.
string
Unique merchant-side reference used to identify this payout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string ("individual" | "company")
required
Beneficiary type: individual or company.
object
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.
object
Merchant-defined metadata to retain with the beneficiary.
object
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.
string
Human-readable beneficiary description.
object
required
Method-specific bank or proxy destination. Supply only fields required by FINMO_GET_PAYOUT_METHOD_REQUIREMENTS. Finmo stores these sensitive destination details in production.
string
required
Unique key for this exact creation request. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
string
required
Display or legal name of the beneficiary.
string
Unique alphanumeric merchant-side reference for this beneficiary.
object
Controls Finmo’s checks during beneficiary creation. Omit this object to leave the behavior unspecified; Finmo does not document a default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
Refundable completed Finmo payin reference beginning payin_. This request creates the provider-default full refund.
string
required
Unique key for this refund operation. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINMO_GET_PAYIN_METHOD_REQUIREMENTSReturn the dynamic required fields, validation regexes, limits, instructions, and capabilities for one Finmo payin method. Call this immediately before constructing a payin request.

Input Parameters

string
required
Exact method name returned by FINMO_LIST_PAYIN_METHODS, such as au_bank_npp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINMO_GET_PAYMENTGet one payin, payout, or refund by its Finmo reference ID. Use this after an ambiguous timeout before retrying a money-moving request with the same idempotency key.

Input Parameters

string
required
Matching Finmo reference beginning payin_, payout_, or refund_.
string ("payin" | "payout" | "refund")
required
Resource type to retrieve: payin, payout, or refund.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINMO_GET_PAYOUT_METHOD_REQUIREMENTSReturn the dynamic payout, beneficiary, and sender field requirements for one Finmo payout method. Use it before creating a beneficiary or moving money.

Input Parameters

string
required
Exact payout method name returned by FINMO_LIST_PAYOUT_METHODS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINMO_GET_WALLETGet one wallet and its currency accounts, including actual and available balances. Reading balances is sensitive but does not move funds.

Input Parameters

string
required
Finmo wallet reference beginning with wallet_.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string ("individual" | "company")
Customer type to match: individual or company.
integer
Maximum customers to return in this page. Must be at least 1.
integer
Inclusive end of the creation-time range as epoch seconds.
string
UTC creation date in YYYY-MM-DD format.
integer
Inclusive start of the creation-time range as epoch seconds.
string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
boolean
Whether to include deleted customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINMO_LIST_PAYIN_METHODSList one page of payin methods for a country and currency, optionally filtered for virtual-account eligibility. Results can include methods usable only for virtual accounts; inspect their capabilities before selecting a method for a payin.

Input Parameters

integer
Requested page size, minimum 1. Finmo may ignore this value for payin-method discovery.
string
required
Two-letter ISO 3166-1 country code.
string
required
Three-letter ISO 4217 currency code.
string
Opaque continuation cursor returned by a prior call; omit for the first page.
boolean
Only return methods usable for virtual accounts when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINMO_LIST_PAYINSList inbound payment attempts with status, method, customer, wallet, and time filters. Returns one page and a continuation cursor.

Input Parameters

integer
Maximum payins to return in this page. Must be at least 1.
string ("PENDING" | "COMPLETED" | "EXPIRED" | "CANCELLED" | "CREATED" | "FAILED")
Payin status to match: PENDING, COMPLETED, EXPIRED, CANCELLED, CREATED, or FAILED.
integer
End of the creation-time range as epoch seconds.
string
UTC creation date in YYYY-MM-DD format.
integer
Start of the creation-time range as epoch seconds.
string
Return only payins associated with this Finmo customer reference.
string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
string
Return only payins that credit this Finmo wallet reference.
string
Return only payins created with this payin method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string ("individual" | "company")
Beneficiary type to match: individual or company.
integer
Maximum beneficiaries to return in this page. Must be at least 1.
integer
End of the creation-time range as epoch seconds.
string
UTC beneficiary creation date in YYYY-MM-DD format.
integer
Start of the creation-time range as epoch seconds.
string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
Requested page size. Must be at least 1.
string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
string
Two-letter sender country code. Required for the first page; omit only when supplying next_cursor.
string
Three-letter sender currency code. Required for the first page; omit only when supplying next_cursor.
string
Two-letter beneficiary country code. Required for the first page; omit only when supplying next_cursor.
string ("DOMESTIC" | "GCA")
Optional payout method class: DOMESTIC or GCA.
string
Three-letter beneficiary currency code. Required for the first page; omit only when supplying next_cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
Maximum payouts to return in this page. Must be at least 1.
string ("PENDING" | "COMPLETED" | "FAILED")
Payout status to match: PENDING, COMPLETED, or FAILED.
integer
End of the creation-time range as epoch seconds.
string
UTC creation date in YYYY-MM-DD format.
integer
Start of the creation-time range as epoch seconds.
string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
string
Return only payouts using this Finmo payout method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
Maximum refunds to return in this page. Must be at least 1.
integer
Return only refunds matching this integer amount.
string ("PENDING" | "COMPLETED" | "FAILED")
Refund status to match: PENDING, COMPLETED, or FAILED.
integer
End of the creation-time range as epoch seconds.
string
Return only refunds for this originating Finmo payin reference.
string
UTC creation date in YYYY-MM-DD format.
integer
Start of the creation-time range as epoch seconds.
string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
Maximum transactions to return in this page. Must be at least 1.
integer
End of the creation-time range as epoch seconds.
string
UTC creation date in YYYY-MM-DD format.
string
Event type to match, such as PAYIN, PAYOUT, REFUND, or VA_PAYIN.
boolean
Filter transactions by settlement state.
integer
Start of the creation-time range as epoch seconds.
string
Return only transactions associated with this Finmo customer reference.
string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
boolean
Filter transactions by Finmo reconciliation state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
Maximum wallets to return in this page. Must be at least 1.
string ("PAYIN" | "PAYOUT" | "FEES" | "GENERAL" | "GCA")
Wallet category to match: PAYIN, PAYOUT, FEES, GENERAL, or GCA.
integer
Inclusive end of the creation-time range as epoch seconds.
string
UTC creation date in YYYY-MM-DD format.
integer
Inclusive start of the creation-time range as epoch seconds.
string
Return only wallets belonging to this Finmo customer reference.
string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
Positive transfer amount in major currency units. Use the number of decimal places defined for the selected currency by ISO 4217.
string
required
Three-letter ISO 4217 currency code verified against both wallets’ currency accounts.
object
Merchant-defined metadata to retain with the transfer.
string
Human-readable purpose of the wallet transfer.
string
Webhook URL for transfer updates. If omitted, Finmo uses the URL configured in the dashboard.
string
required
Source Finmo wallet to debit. Before calling, use FINMO_GET_WALLET to verify it is active and has sufficient available balance in currency.
string
required
Unique key for this exact transfer. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
string
required
Destination Finmo wallet to credit. Before calling, verify this exact wallet is active, intended, and supports currency.
string
Optional alias reference of the destination wallet to credit.
string
Unique merchant-side reference used to identify the transfer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not