Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
n) Wallet Reservations

Create a wallet reservation

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

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

Path parameters

tenantIdinteger required
walletIdinteger required

Request body

amountnumber 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

cardIdinteger
descriptionstring

Description for the reservation

expiresstring date-time required

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

externalUniqueIdstring

Globally Unique identifier for the reservation. Duplicates will be rejected

onlyCheckboolean

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

sessionIdstring required

The identifier of the session holding the reservation

uniqueIdstring

Deprecated - use externalUniqueId. Globally Unique identifier for the reservation

Example request

{
  "expires": "2022-03-10T12:15:50-04:00"
}

Response

OK

amountnumber

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

cardIdinteger
createdstring date-time

When the reservation was created

descriptionstring

Description for the reservation

expiresstring date-time

When the reservation will automatically be deleted, releasing the amount back to the available balance

externalUniqueIdstring

Globally Unique identifier for the reservation

reservationIdinteger required

Unique identifier for the reservation

sessionIdstring

The identifier of the session holding the reservation

uniqueIdstring

Deprecated - use externalUniqueId. Globally Unique identifier for the reservation

walletIdinteger required

The wallet the reservation is against

Example response

{
  "created": "2022-03-10T12:15:50-04:00",
  "expires": "2022-03-10T12:15:50-04:00",
  "payment": {
    "created": "2022-03-10T12:15:50-04:00",
    "expires": "2022-03-10T12:15:50-04:00",
    "lastModified": "2022-03-10T12:15:50-04:00"
  },
  "remittance": {
    "created": "2022-03-10T12:15:50-04:00",
    "quoteExpires": "2022-03-10T12:15:50-04:00"
  },
  "withdrawal": {
    "created": "2022-03-10T12:15:50-04:00",
    "expires": "2022-03-10T12:15:50-04:00",
    "holdUntil": "2022-03-10T12:15:50-04:00",
    "lastModified": "2022-03-10T12:15:50-04:00"
  }
}