Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
n) Wallet Reservations

List reservations for a wallet

Retrieves all reservations held against the specified wallet, optionally filtered by session ID.

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

Path parameters

tenantIdinteger required
walletIdinteger required

Query parameters

fieldsstring

Additional field data to include. Comma separated list. Currently supports withdrawals,remittances.

sessionIdstring

Filter by session ID.

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"
    }
  }
]