v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

h) Wallets

Do a set of inter account transfers from the wallet

The transfers are processed atomically (synchronously) or one by one in the background. For atomic, all fail or all succeed. For non atomic, they are processed one by one in the background and some may fail and some may succeed. The results for non atomic are sent by email to the caller. toWalletId and amount are required. Unique Id can optionally be used as a means of ensuring transactions cannot be duplicated. The unique Id must be globally unique in the system. If not provided the backend will assign a GUID for you. The fromWalletId is the source wallet for all the transfers in the list. If the source and destination may vary, then use the bulk-transfer API at wallets/bulk-transfers. For non-atomic, the result includes a bulkTransferId that can be used to GET the status of the transfers (progress, etc)

post/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/bulk-transfers

Path parameters

tenantIdinteger required

walletIdinteger required

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

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