> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Finmo

> Finmo provides payment collection, payouts, wallets, foreign exchange, virtual accounts, and transaction management for businesses.

![Finmo logo](https://mintcdn.com/composio-preview/r7CO9m4_UWMVFnU7/images/toolkits/finmo.svg?fit=max\&auto=format\&n=r7CO9m4_UWMVFnU7\&q=85\&s=d81415de7aeb3546245859972873025e)

* **Category:** payment processing
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 19
* **Triggers:** 0
* **Slug:** `FINMO`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Customer
>
> **Slug:** `FINMO_CREATE_CUSTOMER`
>
> Create 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
>
> **type** `string ("individual" | "company")` *required*
>
> Customer profile type: individual or company.
>
> **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.
>
> **metadata** `object`
>
> Merchant-defined metadata to retain with the customer.
>
> **individual** `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.
>
> **description** `string`
>
> Human-readable customer description.
>
> **idempotency\_key** `string` *required*
>
> Unique key for this exact customer creation. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
>
> **account\_usage\_purpose** `string` *required*
>
> Declared purpose for the customer's account.
>
> **organization\_reference\_id** `string`
>
> Merchant-side reference for the customer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payin
>
> **Slug:** `FINMO_CREATE_PAYIN`
>
> Create 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
>
> **amount** `integer` *required*
>
> Payin amount as a positive integer in the unit required by the selected method and currency.
>
> **currency** `string` *required*
>
> Three-letter ISO 4217 currency code supported by the selected method.
>
> **metadata** `object`
>
> Merchant-defined metadata to retain with the payin.
>
> **expire\_at** `integer`
>
> Epoch timestamp at which the payin expires.
>
> **payin\_type** `string`
>
> Finmo payin type, such as DIRECT\_PAYIN.
>
> **customer\_id** `string`
>
> Existing Finmo customer to associate with this payin.
>
> **description** `string`
>
> Human-readable description of the payment.
>
> **webhook\_url** `string`
>
> Webhook destination for payin updates. If omitted, Finmo uses the dashboard-configured webhook.
>
> **redirect\_url** `string`
>
> Customer redirect URL for both success and failure. Use only when advanced\_redirect\_url is omitted.
>
> **receipt\_email** `string`
>
> Email address that should receive the payment receipt.
>
> **fees\_wallet\_id** `string`
>
> Finmo fees wallet reference (wallet\_\*) used to collect payin fees.
>
> **idempotency\_key** `string` *required*
>
> Unique key for this exact payin operation. Reuse it only when retrying an identical request; Finmo retains keys for 8 days.
>
> **credit\_wallet\_id** `string`
>
> Wallet to credit. If omitted, Finmo uses the organization payin wallet where supported; a customer with multiple linked wallets may require it.
>
> **payin\_method\_name** `string` *required*
>
> Enabled method returned by FINMO\_LIST\_PAYIN\_METHODS.
>
> **payin\_method\_param** `object` *required*
>
> Method-specific fields required by FINMO\_GET\_PAYIN\_METHOD\_REQUIREMENTS. Supply exactly the fields required for the selected method.
>
> **advanced\_redirect\_url** `object`
>
> Outcome-specific redirect URLs. When supplied, provide all completed, cancelled, expired, and failed URLs.
>
> **organization\_reference\_id** `string`
>
> Unique merchant-side reference used to identify this payment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payout
>
> **Slug:** `FINMO_CREATE_PAYOUT`
>
> Create 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
>
> **metadata** `object`
>
> Merchant-defined metadata to retain with the payout.
>
> **fx\_rate\_id** `string`
>
> Finmo FX quote to apply. Required when sender\_currency and beneficiary\_currency differ.
>
> **description** `string`
>
> Human-readable payout description.
>
> **webhook\_url** `string`
>
> Webhook destination for payout updates. If omitted, Finmo uses the dashboard-configured webhook.
>
> **purpose\_code** `string`
>
> Transaction purpose code required by the selected rail.
>
> **receipt\_email** `string`
>
> Email address to receive the payout receipt.
>
> **sender\_amount** `integer`
>
> Positive source amount. Supply this and/or beneficiary\_amount exactly as required by the selected payout method.
>
> **fees\_wallet\_id** `string`
>
> Wallet from which Finmo should charge payout fees.
>
> **sender\_country** `string`
>
> Two-letter country code for the payout sender.
>
> **debit\_wallet\_id** `string` *required*
>
> Funded Finmo wallet to debit for this payout.
>
> **idempotency\_key** `string` *required*
>
> Unique key for this exact payout operation. Reuse it only for an identical retry within Finmo's 8-day idempotency window.
>
> **payout\_controls** `object`
>
> Optional beneficiary-name-match controls documented by Finmo.
>
> **sender\_currency** `string`
>
> Optional three-letter source currency required by some methods. For cross-currency payouts, provide the matching fx\_rate\_id.
>
> **payout\_reference** `string`
>
> Reference shown for the payout where supported.
>
> **payout\_sender\_id** `string`
>
> Existing stored payout-sender token. Do not combine this with payout\_sender\_param.
>
> **beneficiary\_amount** `integer`
>
> Positive destination amount. Supply this and/or sender\_amount exactly as required by the selected payout method.
>
> **payout\_method\_name** `string` *required*
>
> Enabled method returned by FINMO\_LIST\_PAYOUT\_METHODS. Retrieve its current requirements before every payout.
>
> **payout\_method\_param** `object`
>
> Dynamic rail-specific fields exactly as returned by FINMO\_GET\_PAYOUT\_METHOD\_REQUIREMENTS.
>
> **payout\_sender\_param** `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.
>
> **beneficiary\_currency** `string` *required*
>
> Three-letter destination currency supported by the selected method.
>
> **payout\_beneficiary\_id** `string`
>
> Existing stored beneficiary token when available. A newly created beneficiary may require 24 hours before activation.
>
> **payout\_beneficiary\_param** `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.
>
> **organization\_reference\_id** `string`
>
> Unique merchant-side reference used to identify this payout.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payout Beneficiary
>
> **Slug:** `FINMO_CREATE_PAYOUT_BENEFICIARY`
>
> Create 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
>
> **type** `string ("individual" | "company")` *required*
>
> Beneficiary type: individual or company.
>
> **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.
>
> **metadata** `object`
>
> Merchant-defined metadata to retain with the beneficiary.
>
> **individual** `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.
>
> **description** `string`
>
> Human-readable beneficiary description.
>
> **destination** `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.
>
> **idempotency\_key** `string` *required*
>
> Unique key for this exact creation request. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
>
> **beneficiary\_name** `string` *required*
>
> Display or legal name of the beneficiary.
>
> **organization\_reference\_id** `string`
>
> Unique alphanumeric merchant-side reference for this beneficiary.
>
> **payout\_beneficiary\_controls** `object`
>
> Controls Finmo's checks during beneficiary creation. Omit this object to leave the behavior unspecified; Finmo does not document a default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Refund
>
> **Slug:** `FINMO_CREATE_REFUND`
>
> Create 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
>
> **payin\_id** `string` *required*
>
> Refundable completed Finmo payin reference beginning payin\_. This request creates the provider-default full refund.
>
> **idempotency\_key** `string` *required*
>
> Unique key for this refund operation. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payin Method Requirements
>
> **Slug:** `FINMO_GET_PAYIN_METHOD_REQUIREMENTS`
>
> Return 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
>
> **payin\_method\_name** `string` *required*
>
> Exact method name returned by FINMO\_LIST\_PAYIN\_METHODS, such as au\_bank\_npp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment
>
> **Slug:** `FINMO_GET_PAYMENT`
>
> Get 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
>
> **payment\_id** `string` *required*
>
> Matching Finmo reference beginning payin\_, payout\_, or refund\_.
>
> **payment\_type** `string ("payin" | "payout" | "refund")` *required*
>
> Resource type to retrieve: payin, payout, or refund.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payout Method Requirements
>
> **Slug:** `FINMO_GET_PAYOUT_METHOD_REQUIREMENTS`
>
> Return the dynamic payout, beneficiary, and sender field requirements for one Finmo payout method. Use it before creating a beneficiary or moving money.
>
> #### Input Parameters
>
> **payout\_method\_name** `string` *required*
>
> Exact payout method name returned by FINMO\_LIST\_PAYOUT\_METHODS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Wallet
>
> **Slug:** `FINMO_GET_WALLET`
>
> Get one wallet and its currency accounts, including actual and available balances. Reading balances is sensitive but does not move funds.
>
> #### Input Parameters
>
> **wallet\_id** `string` *required*
>
> Finmo wallet reference beginning with wallet\_.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customers
>
> **Slug:** `FINMO_LIST_CUSTOMERS`
>
> List one page of individual or company customer profiles and wallet-readiness state. Returns a continuation cursor when more customers are available.
>
> #### Input Parameters
>
> **type** `string ("individual" | "company")`
>
> Customer type to match: individual or company.
>
> **limit** `integer`
>
> Maximum customers to return in this page. Must be at least 1.
>
> **end\_time** `integer`
>
> Inclusive end of the creation-time range as epoch seconds.
>
> **created\_at** `string`
>
> UTC creation date in YYYY-MM-DD format.
>
> **start\_time** `integer`
>
> Inclusive start of the creation-time range as epoch seconds.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **include\_deleted** `boolean`
>
> Whether to include deleted customers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payin Methods
>
> **Slug:** `FINMO_LIST_PAYIN_METHODS`
>
> List 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
>
> **limit** `integer`
>
> Requested page size, minimum 1. Finmo may ignore this value for payin-method discovery.
>
> **country** `string` *required*
>
> Two-letter ISO 3166-1 country code.
>
> **currency** `string` *required*
>
> Three-letter ISO 4217 currency code.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior call; omit for the first page.
>
> **is\_va\_allowed** `boolean`
>
> Only return methods usable for virtual accounts when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payins
>
> **Slug:** `FINMO_LIST_PAYINS`
>
> List inbound payment attempts with status, method, customer, wallet, and time filters. Returns one page and a continuation cursor.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum payins to return in this page. Must be at least 1.
>
> **status** `string ("PENDING" | "COMPLETED" | "EXPIRED" | "CANCELLED" | "CREATED" | "FAILED")`
>
> Payin status to match: PENDING, COMPLETED, EXPIRED, CANCELLED, CREATED, or FAILED.
>
> **end\_time** `integer`
>
> End of the creation-time range as epoch seconds.
>
> **created\_at** `string`
>
> UTC creation date in YYYY-MM-DD format.
>
> **start\_time** `integer`
>
> Start of the creation-time range as epoch seconds.
>
> **customer\_id** `string`
>
> Return only payins associated with this Finmo customer reference.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **credit\_wallet\_id** `string`
>
> Return only payins that credit this Finmo wallet reference.
>
> **payin\_method\_name** `string`
>
> Return only payins created with this payin method.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payout Beneficiaries
>
> **Slug:** `FINMO_LIST_PAYOUT_BENEFICIARIES`
>
> List 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
>
> **type** `string ("individual" | "company")`
>
> Beneficiary type to match: individual or company.
>
> **limit** `integer`
>
> Maximum beneficiaries to return in this page. Must be at least 1.
>
> **end\_time** `integer`
>
> End of the creation-time range as epoch seconds.
>
> **created\_at** `string`
>
> UTC beneficiary creation date in YYYY-MM-DD format.
>
> **start\_time** `integer`
>
> Start of the creation-time range as epoch seconds.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payout Methods
>
> **Slug:** `FINMO_LIST_PAYOUT_METHODS`
>
> List 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
>
> **limit** `integer`
>
> Requested page size. Must be at least 1.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **sender\_country** `string`
>
> Two-letter sender country code. Required for the first page; omit only when supplying next\_cursor.
>
> **sender\_currency** `string`
>
> Three-letter sender currency code. Required for the first page; omit only when supplying next\_cursor.
>
> **beneficiary\_country** `string`
>
> Two-letter beneficiary country code. Required for the first page; omit only when supplying next\_cursor.
>
> **payout\_method\_class** `string ("DOMESTIC" | "GCA")`
>
> Optional payout method class: DOMESTIC or GCA.
>
> **beneficiary\_currency** `string`
>
> Three-letter beneficiary currency code. Required for the first page; omit only when supplying next\_cursor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payouts
>
> **Slug:** `FINMO_LIST_PAYOUTS`
>
> List one page of outbound payments with status, payout method, and time filters. Returns a continuation cursor when more payouts are available.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum payouts to return in this page. Must be at least 1.
>
> **status** `string ("PENDING" | "COMPLETED" | "FAILED")`
>
> Payout status to match: PENDING, COMPLETED, or FAILED.
>
> **end\_time** `integer`
>
> End of the creation-time range as epoch seconds.
>
> **created\_at** `string`
>
> UTC creation date in YYYY-MM-DD format.
>
> **start\_time** `integer`
>
> Start of the creation-time range as epoch seconds.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **payout\_method\_name** `string`
>
> Return only payouts using this Finmo payout method.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Refunds
>
> **Slug:** `FINMO_LIST_REFUNDS`
>
> List one page of refunds with status, originating payin, amount, and time filters. Returns a continuation cursor when more refunds are available.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum refunds to return in this page. Must be at least 1.
>
> **amount** `integer`
>
> Return only refunds matching this integer amount.
>
> **status** `string ("PENDING" | "COMPLETED" | "FAILED")`
>
> Refund status to match: PENDING, COMPLETED, or FAILED.
>
> **end\_time** `integer`
>
> End of the creation-time range as epoch seconds.
>
> **payin\_id** `string`
>
> Return only refunds for this originating Finmo payin reference.
>
> **created\_at** `string`
>
> UTC creation date in YYYY-MM-DD format.
>
> **start\_time** `integer`
>
> Start of the creation-time range as epoch seconds.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Transactions
>
> **Slug:** `FINMO_LIST_TRANSACTIONS`
>
> List organization-level financial transactions for reconciliation, filtered by customer, event type, settlement, reconciliation, or time. Returns one page and a continuation cursor.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum transactions to return in this page. Must be at least 1.
>
> **end\_time** `integer`
>
> End of the creation-time range as epoch seconds.
>
> **created\_at** `string`
>
> UTC creation date in YYYY-MM-DD format.
>
> **event\_type** `string`
>
> Event type to match, such as PAYIN, PAYOUT, REFUND, or VA\_PAYIN.
>
> **is\_settled** `boolean`
>
> Filter transactions by settlement state.
>
> **start\_time** `integer`
>
> Start of the creation-time range as epoch seconds.
>
> **customer\_id** `string`
>
> Return only transactions associated with this Finmo customer reference.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **is\_reconciled** `boolean`
>
> Filter transactions by Finmo reconciliation state.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Wallets
>
> **Slug:** `FINMO_LIST_WALLETS`
>
> List 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
>
> **limit** `integer`
>
> Maximum wallets to return in this page. Must be at least 1.
>
> **category** `string ("PAYIN" | "PAYOUT" | "FEES" | "GENERAL" | "GCA")`
>
> Wallet category to match: PAYIN, PAYOUT, FEES, GENERAL, or GCA.
>
> **end\_time** `integer`
>
> Inclusive end of the creation-time range as epoch seconds.
>
> **created\_at** `string`
>
> UTC creation date in YYYY-MM-DD format.
>
> **start\_time** `integer`
>
> Inclusive start of the creation-time range as epoch seconds.
>
> **customer\_id** `string`
>
> Return only wallets belonging to this Finmo customer reference.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Transfer Wallet Funds
>
> **Slug:** `FINMO_TRANSFER_WALLET_FUNDS`
>
> Transfer 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
>
> **amount** `string` *required*
>
> Positive transfer amount in major currency units. Use the number of decimal places defined for the selected currency by ISO 4217.
>
> **currency** `string` *required*
>
> Three-letter ISO 4217 currency code verified against both wallets' currency accounts.
>
> **metadata** `object`
>
> Merchant-defined metadata to retain with the transfer.
>
> **description** `string`
>
> Human-readable purpose of the wallet transfer.
>
> **webhook\_url** `string`
>
> Webhook URL for transfer updates. If omitted, Finmo uses the URL configured in the dashboard.
>
> **debit\_wallet\_id** `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.
>
> **idempotency\_key** `string` *required*
>
> Unique key for this exact transfer. Reuse it only for an identical retry; Finmo retains idempotency keys for 8 days.
>
> **credit\_wallet\_id** `string` *required*
>
> Destination Finmo wallet to credit. Before calling, verify this exact wallet is active, intended, and supports currency.
>
> **credit\_wallet\_alias\_id** `string`
>
> Optional alias reference of the destination wallet to credit.
>
> **organization\_reference\_id** `string`
>
> Unique merchant-side reference used to identify the transfer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
