v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

m.1) Wallet Transfers

Transfer funds between wallets

Transfers funds between two Eclipse wallets. Authorization rules are enforced based on the caller's relationship to the source wallet — ownership, organisation position, or tenant-level system access depending on the wallet type.

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

Path parameters

tenantIdinteger required

Request body

amountnumber

Amount to transfer. Amounts are in major currency unit

check'BOTH' | 'FROM' | 'TO'

descriptionstring required

Description for the statement/s

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 wallet to debit

fromWalletIdinteger

The wallet to debit

ignoreLimitsboolean

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

locationstring

Optional. Any location information to add to the transfer such as GPS coordinates

onlyCheckboolean

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

replyPolicy'WHEN_COMPLETE' | 'WHEN_GUARANTEED' | 'WHEN_RECEIVED'

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 wallet to credit

toPanstring

toPan for wallet to credit

toWalletFriendlyIdstring

toWalletFriendlyId for wallet to credit

toWalletIdinteger

The wallet to credit

Response

Transfer submitted successfully