Passer au contenu principal
POST
Enregistrer un paiement

Autorisations

Authorization
string
header
requis

Clé API lck_… créée dans Lexio (Paramètres → Développeur), envoyée en Authorization: Bearer. Voir Authentification.

En-têtes

Idempotency-Key
string
requis

Clé unique de l’opération, réutilisée à chaque nouvel essai : un rejeu avec la même clé et le même corps renvoie la réponse initiale sans rien réécrire. Voir Idempotence. Facultative avec ?dryRun=true sur les opérations qui l’acceptent.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$
Exemple:

"8b3e1d2c-4a5f-4c6b-9e7d-1f2a3b4c5d6e"

Paramètres de chemin

rentalId
string<uuid>
requis

Identifiant de la location.

Exemple:

"9c2d7e4a-5b1f-4d3c-8a6e-0f1b2c3d4e5f"

Corps

application/json

Encaissement.

type
string
requis
Allowed value: "PAYMENT"
amount
number
requis

Montant en unités majeures de la devise de la location, strictement positif, sur sa grille (2 décimales en EUR, entier en XPF et XOF) ; le sens vient de type.

method
enum<string>
requis

Moyen de paiement ; STRIPE exige stripePaymentIntentId.

Options disponibles:
CREDIT_CARD,
CASH,
TRANSFER,
CHECK,
MOBILE_MONEY,
OTHER,
STRIPE
providerReference
string | null

Référence de l’opération chez l’opérateur, MOBILE_MONEY seulement (sinon 400 not_applicable).

Maximum string length: 64
notes
string | null

Note pour l’équipe du loueur ; refusée à une clé partenaire.

Maximum string length: 500
paidAt
string

Date de l’opération, RFC 3339 avec décalage ; omise : maintenant. Ni avant la création de la location, ni plus de 5 minutes dans le futur (400 out_of_range). Refusée avec STRIPE : la date est lue sur le PaymentIntent.

Exemple:

"2026-11-10T10:00:00+01:00"

stripePaymentIntentId
string

PaymentIntent pi_… encaissé sur le compte Stripe de l’agence, dans la devise de la location et pour amount exactement ; requis avec STRIPE, refusé sinon.

Maximum string length: 255
Pattern: ^pi_[A-Za-z0-9]+$
isPreAuthorization
any

Réponse

Enregistrer un paiement

data
object
requis

Encaissement, caution ou remboursement d’une location.

Exemple:
effects
object
requis