Retrieve pending transfer requests

Retrieve list of currently pending transfers.

SecurityJWT
Request
path Parameters
ledgerIdentifier
required
string <uuid>

Ledger identifier, can be found using /api/ledger endpoint

Example: 4b7375e9-79b0-4b8b-a89e-a21607f0239f
query Parameters
direction
string

Specify whether you want only "in"bound or "out"bound pending transfers. If omitted, both types will be returned.

Enum: "in" "out"
Example: direction=direction="in"
includeHoldings
boolean

Include transfer related holdings details

Example: includeHoldings=?includeHoldings=true
onBehalfOfSrcAcctId
string

If permitted, allows the caller to retrieve open transfer batches on behalf of another account holder, identifying that account holder by their system-assigned srcAcctId.

$skip
integer <int32>

Number of records to skip

$top
integer <int32>

Maximum number of records to return

$filter
string

OData-like filter expression

$apply
string

OData-like apply expression with groupby and aggregate only

$orderby
string

Comma-separated list of columns for sorting

$count
boolean

Whether to include the count of records with the result

Responses
200

transfer batches retrieved

404

Not Found

get/api/ledger/{ledgerIdentifier}/transferBatch/open
Response samples
application/json
{
  • "inbound": [
    ],
  • "outbound": [
    ]
}