Transfer funds between wallets

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/transfers

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

Body Params

A transfer between two wallets in the currency of the wallets

amount

number

≥ 1e-9

Amount to transfer. Amounts are in major currency unit

check

string

enum

Only provide if onlyCheck=true. If TO is passed then source wallet permissions are ignored when the check is done

Allowed:

description

string

required

length between 0 and 200

(?s)^(?:[\t\r\n]|[^\p{C}<>])*$

Description for the statement/s

externalId

string

length between 5 and 200

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

externalUniqueId

string

required

length between 6 and 200

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

fromAccountNumber

string

fromAccountNumber for wallet to debit

fromWalletId

int64

The wallet to debit

ignoreLimits

boolean

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

location

string

length between 0 and 200

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

onlyCheck

boolean

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

replyPolicy

string

enum

Optional: Indicates to Eclipse whether to reply to the caller after the transfer has actually happened on both wallets. WHEN_GUARANTEED: Eclipse should reply when the result is guaranteed to happen and will eventually happen, WHEN_COMPLETE: Eclipse should only reply when the source and destination are fully consistent. In all normal situations and by default, WHEN_GUARANTEED should be used. For most wallet transfers between wallets in the same store of value, WHEN_GUARANTEED and WHEN_COMPLETE are identical. WHEN_COMPLETE is only useful when transferring from a digital wallet within Eclipse to a store of value like a card wallet which sits outside of Eclipse. The semantics of these transactions is that the source is debited and the destination is credited in a separate transaction that is retried until success. If the destination wallet is not complete within 5 seconds then Eclipse will reply as if WHEN_GUARANTEED was passed in In order to prevent timeouts on the client.

Allowed:

sessionId

string

length ≤ 200

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

toAccountNumber

string

toAccountNumber for wallet to credit

toPan

string

toPan for wallet to credit

toWalletFriendlyId

string

toWalletFriendlyId for wallet to credit

toWalletId

int64

The wallet to credit

Responses

204

Transfer submitted successfully

400

Bad Request

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

500Internal Server Error