Aller au contenu

Marquer un relevé payé (déclenche le reversement)

POST
/v1/owner-statements/{id}/mark-paid
curl --request POST \
--url https://example.com/v1/owner-statements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mark-paid \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "reference": "VIRT-2026-05-DUPONT", "paidAt": "2026-04-15T12:00:00Z" }'
id
required
string format: uuid
Media type application/json
object
reference
required
string
<= 200 characters
Example
VIRT-2026-05-DUPONT
paidAt
required

Date de paiement ISO 8601

string format: date-time

Reversement déclenché

Media type application/json
object
data
required
object
statementId
required
string format: uuid
transferRef
string
nullable
paidAt
required
string format: date-time
Example generated
{
"data": {
"statementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"transferRef": "example",
"paidAt": "2026-04-15T12:00:00Z"
}
}

Corps invalide

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
}

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
}

Permission refusée (owner.manage)

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
}

Relevé 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
}