v1

latestOpenAPI 3.0.32026-07-264414182.7 KB
Internal Transfer

List Internal Transfers

Retrieves a list of internal fund transfers between financial accounts within the Monime ecosystem.

get/v1/internal-transfers

Query parameters

status'pending' | 'processing' | 'failed' | 'completed' nullable

Filters transfers by status: 'pending' (awaiting processing), 'processing' (in progress), 'failed' (attempt unsuccessful), or 'completed' (successfully transferred).

Filters transfers by status: 'pending' (awaiting processing), 'processing' (in progress), 'failed' (attempt unsuccessful), or 'completed' (successfully transferred).

sourceFinancialAccountIdstring nullable

Source financial account ID. Filters results to transfers originating from this account.

Source financial account ID. Filters results to transfers originating from this account.

destinationFinancialAccountIdstring nullable

Destination financial account ID. Filters results to transfers credited to this account.

Destination financial account ID. Filters results to transfers credited to this account.

financialTransactionReferencestring nullable

Financial transaction reference. Filters results to transfers with this transaction reference. Useful for correlation with underlying financial transactions.

Financial transaction reference. Filters results to transfers with this transaction reference. Useful for correlation with underlying financial transactions.

limitinteger

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

afterstring nullable

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Headers

Monime-Space-Idstring required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

Specifies which version of the Monime API will handle this request.

Specifies which version of the Monime API will handle this request.

Response

OK

successboolean

Represents the status of the query operation, confirming if it was successful. This field is always true