Act on a proposed transfer

Actions include accept, reject or withdrawal of a proposed transfer, using the transfer batch identifier.

SecurityJWT
Request
path Parameters
ledgerIdentifier
required
string <uuid>

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

Example: 4b7375e9-79b0-4b8b-a89e-a21607f0239f
Request Body schema: application/json
required

Populated ActionTransferBatches payload

onBehalfOfSrcAcctId
string

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

action
string

Specifies code of action to take; same action for all transfer batches included in "items".

Enum: "CONFIRM" "WITHDRAW" "REJECT"
Array of objects (ActionTransferBatchItem)

List of transfer batch identifiers

Responses
200

success

404

Not Found

post/api/ledger/{ledgerIdentifier}/transferBatch/open/action
Request samples
application/json
{
  • "onBehalfOfSrcAcctId": "string",
  • "action": "WITHDRAW",
  • "items": [
    ]
}