v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Transactions

List internal transfers

Returns a list of confirmed internal transfers in the organization. For pagination details see the section above.

When the transactionId filter is set, the response contains at most one entry — the InternalTransfer that references the given transaction as either its debit or credit leg. Use this to look up an internal transfer from a transaction without needing to know which side it represents.

get/financial-data/v2beta/internal-transfers

Query parameters

transactionIdstring
Example:31d593d7-fff9-4783-aa1d-92acb7b21a19

Include only the internal transfer that references the given transaction id (as either the debit or credit leg).

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

List of internal transfers.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "debitTransactionId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "creditTransactionId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "debitAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "creditAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z",
      "version": 1,
      "etag": "version:3"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}