v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

z) Global Functionality

Execute a batch of wallet transfers

Processes a list of wallet transfers either atomically (all-or-nothing, max 500) or non-atomically in the background (max 500,000, results emailed to caller). A uniqueId per transfer prevents duplicates; if omitted the system assigns a GUID.

post/eclipse-conductor/rest/v1/global/bulk-transfers

Query parameters

atomicboolean

Do all transfers in one atomic transaction (default). Atomic max batch size 500. Non atomic 500000

callbackUrlstring

When the callbackUrl is specified, and atomic is set to false, the transfer results will be forwarded to the designated URL

Request body

amountnumber

Amount in the major currency unit e.g. 50.80 for 50 GBP and 80 pence

descriptionstring

externalIdstring

External identifier for the transfer which can be used for reconciliation. Need not be unique

externalUniqueIdstring required

Unique identifier for the transfer (idempotency key). Duplicates are rejected to ensure double transactions are impossible

fromAccountNumberstring

fromAccountNumber for source wallet

fromWalletIdinteger

Source wallet id

ignoreLimitsboolean

Optional. If true then the transfer will ignore the wallets transfer limits and any positive minimum balance setting. Requires special permissions

onlyCheckboolean

Optional. If true then the transfer wont actually be done but only validated to see if it could have been done

sessionIdstring

Optional: Used for 2-step reserve/transfer transactions. The sessionId of a reservation in order to make this transfer first remove the reservation and then do the transfer atomically

toAccountNumberstring

toAccountNumber for destination wallet

toPanstring

toPan for wallet to credit

toWalletFriendlyIdstring

toWalletFriendlyId for wallet to credit

toWalletIdinteger

Destination wallet id

Response

bulkTransferIdstring

inProgressboolean

percentageCompleteinteger

secondsTillCompleteinteger

transfersDoneinteger

transfersFailedinteger

transfersPerSecondinteger

transfersSucceededinteger

transfersTotalinteger