Capturer le hold au check-out (= settlement folio, Idempotency-Key obligatoire)

POST

/v1/incidentals/{id}/capture

curl --request POST \
  --url https://example.com/v1/incidentals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/capture \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "amount": { "amountCents": "20000", "currency": "EUR" } }'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Identifiant du hold incidentals

Header Parameters

Idempotency-Key

required

string

>= 8 characters <= 200 characters

Clé d’idempotence OBLIGATOIRE (8–200 car.)

Request Body ^required

Media type application/json

object

amount

required

object

amountCents

required

string

Example

20000

currency

required

string

Allowed values: EUR GBP

Responses

200

Capturé + settlement folio posté

Media type application/json

object

data

required

object

holdId

required

string format: uuid

Example ^generated

{
  "data": {
    "holdId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

400

Corps invalide ou capture refusée

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
}

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 IDOR

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
}

404

Hold introuvable

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
}