GET
/
v1
/
internal-transfers
List Internal Transfers
curl --request GET \
  --url https://api.monime.io/v1/internal-transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": [
    {
      "id": "<string>",
      "status": "pending",
      "amount": {
        "currency": "<string>",
        "value": 123
      },
      "sourceFinancialAccount": {
        "id": "<string>"
      },
      "destinationFinancialAccount": {
        "id": "<string>"
      },
      "financialTransactionReference": "<string>",
      "description": "<string>",
      "failureDetail": {
        "code": "unknown",
        "message": "<string>"
      },
      "ownershipGraph": {
        "owner": {
          "id": "<string>",
          "type": "<string>",
          "metadata": {},
          "owner": {
            "id": "<string>",
            "type": "<string>",
            "metadata": {},
            "owner": {}
          }
        }
      },
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "count": 123,
    "next": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Monime-Space-Id
string
required

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

Maximum length: 64

Query Parameters

​
status
enum<string> | null

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

Available options:
pending,
processing,
failed,
completed
​
sourceFinancialAccountId
string | null

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

​
destinationFinancialAccountId
string | null

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

​
financialTransactionReference
string | null

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

​
limit
integer
default:10

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

Required range: 1 <= x <= 50
​
after
string | null

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

Maximum length: 2000

Response

200 - application/json

OK

The response is of type object.