Initiate counterparty transfer

Initiate transfer will propose the transaction to the counterparty, after which the counterparty will be prompted to act on the proposal.

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

Bulk Transfer Request payload

onBehalfOfSrcAcctId
string

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

Array of objects (InteraccountTransferRequest)

Collection of Transfer requests

Responses
200

success

404

Not Found

post/api/ledger/{ledgerIdentifier}/transfer
Request samples
application/json
{
  • "onBehalfOfSrcAcctId": "string",
  • "requests": [
    ]
}
Response samples
application/json
{
  • "responses": [
    ]
}