Aller au contenu

Statut de cutoff (+ attrition pending si figée)

GET
/v1/allotments/{id}/cutoff-status
curl --request GET \
--url https://example.com/v1/allotments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cutoff-status \
--header 'X-API-Key: <X-API-Key>'
id
required
string format: uuid

Statut de cutoff

Media type application/json
object
data
required
object
status
required
string
Allowed values: active cutoff_reached released cancelled
cutoffDate
required
string format: date
cutoffProcessedAt
string format: date-time
nullable
pending
object
amountCents
required

Attrition figée en centimes (bigint string)

string
currency
required
string
Allowed values: EUR GBP
reason
required
string
Allowed values: missing_fiscal_config no_active_mandate
resolvedAt
string format: date-time
nullable
Example
{
"data": {
"status": "active",
"pending": {
"currency": "EUR",
"reason": "missing_fiscal_config"
}
}
}

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 ou scope 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
}

Contingent 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
}