Lister les holds incidentals d'un séjour

GET

/v1/incidentals

const url = 'https://example.com/v1/incidentals?stayId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/v1/incidentals?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

Holds du séjour (plus récent en premier)

application/json

object

data

required

Array<object>

object

required

string format: uuid

stayId

required

string format: uuid

folioId

required

string format: uuid

establishmentId

required

string format: uuid

status

required

string

Allowed values: pending authorized declined captured released expired

currency

required

string

requestedAmountCents

required

Montant en centimes (bigint string)

string

authorizedTotalCents

required

Total autorisé COURANT (jamais un delta)

string

capturedAmountCents

required

string

reauthCount

required

Nombre de ré-autorisations réussies (D7)

integer

declineReason

string

nullable

requestedAt

required

string format: date-time

authorizedAt

string format: date-time

nullable

capturedAt

string format: date-time

nullable

releasedAt

string format: date-time

nullable

expiredAt

string format: date-time

nullable

Example

{
  "data": [
    {
      "status": "pending"
    }
  ]
}

401

Non authentifié

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

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
}