Lister les cautions d'un séjour

GET

/v1/deposits

curl --request GET \
  --url 'https://example.com/v1/deposits?stayId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

stayId

required

string format: uuid

Responses

200

Cautions du séjour (plus récente en premier)

Media type application/json

object

data

required

Array<object>

object

id

required

string format: uuid

stayId

required

string format: uuid

establishmentId

required

string format: uuid

depositMode

required

string

Allowed values: card_imprint real_payment

status

required

string

amountCents

required

Montant en centimes (bigint string)

string

currency

required

string

paymentMethod

string

nullable

paymentReference

string

nullable

collectedAt

required

string format: date-time

releasedAt

string format: date-time

nullable

retentions

required

Array<object>

object

id

required

string format: uuid

amountCents

required

string

reason

required

string

decidedBy

required

string format: uuid

decidedAt

required

string format: date-time

Example

{
  "data": [
    {
      "depositMode": "card_imprint"
    }
  ]
}

401

Non authentifié

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}

403

Permission refusée ou séjour hors périmètre

Media type application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}