Create a wallet reservation

post

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

Places a hold on the specified amount in the wallet, reducing available balance until the reservation expires or is consumed by a transfer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

walletId

int64

required

Body Params

A lock/hold/reservation of an amount against a wallet. When a debit reservation is held then this accounts for the difference between current and available balance. Reservations can expire. Use negative amount to indicate a reservation to credit so that max wallet balance is not exceeded unintentionally due to race conditions A reservation can only be removed when a charge or transfer for that same session is applied

amount

number

required

Amount in the currency of the wallet. Amounts are in major currency unit. Positive for a reserve to debit, negative for a reserve to credit

avps

array of objects

avps

cardId

int64

description

string

length between 0 and 200

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

Description for the reservation

expires

date-time

required

ISO 8601 date/time of when the reservation should expire and the amount available back in the wallet

externalUniqueId

string

length between 6 and 100

Globally Unique identifier for the reservation. Duplicates will be rejected

onlyCheck

boolean

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

sessionId

string

required

length between 6 and 100

The identifier of the session holding the reservation

uniqueId

string

Deprecated - use externalUniqueId. Globally Unique identifier for the reservation

Responses

400

Bad Request

200OK

500Internal Server Error