PATCH
Modifier une facture

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id
string
requis

Identifiant de la facture.

Corps

application/json
customerEmail
string<email>

Email du client final. La facture lui est envoyée à cette adresse.

Exemple:

"client@example.com"

customerName
string

Nom du client final, tel qu'il doit apparaître sur la facture.

Exemple:

"Awa Diallo"

amount
string

Montant total de la facture, exprimé dans currency. Chaîne de caractères, jamais un nombre JSON : un montant passé en number est arrondi par la précision flottante. Jusqu'à 18 décimales, et strictement supérieur à zéro.

Pattern: ^(?=.*[1-9])\d{1,18}(\.\d{1,18})?$
Exemple:

"30000"

currency
string

Devise fiat dans laquelle la facture est libellée. Ex : XOF, EUR, USD.

Exemple:

"XOF"

description
string

Objet de la facture, affiché au client final.

Exemple:

"Abonnement Pro — juillet 2026"

expiresAt
string<date-time>

Date d'échéance de la facture, au format ISO 8601. Passé ce délai, le client final ne peut plus la régler.

Exemple:

"2026-07-31T23:59:59.000Z"

assetCode
string

Impose la cryptomonnaie avec laquelle le client final doit régler la facture. Ex : USDT.TRC20, BTC, USDT.BEP20. Omis, le client choisit parmi les cryptomonnaies activées sur votre compte.

Exemple:

"USDT.TRC20"

meta
object

Contenu descriptif de la facture : lignes de détail et note de bas de page.

merchantReference
string

Référence libre côté marchand (numéro de commande, identifiant ERP…). Reprise telle quelle dans les réponses de l'API, les webhooks et le tableau de bord.

Maximum string length: 255
Exemple:

"facture-4821"

language
enum<string>

Langue de l'email et du widget envoyés au client final. Omis, hérite de la langue par défaut du marchand.

Options disponibles:
fr,
en
Exemple:

"en"

collectCustomerInformation
boolean
défaut:true

Quand false, la page de paiement de cette facture NE demande PAS au client de saisir ses informations (nom, email) : l'identité est déjà portée par la facture (customerName, customerEmail sont obligatoires) et le client va directement au paiement. Défaut true : la page collecte les informations.

Exemple:

false

Réponse

Facture mise à jour.

id
string
requis

Identifiant unique de la facture.

customerEmail
string
requis

Email du client destinataire.

customerName
string
requis

Nom du client destinataire.

amount
string
requis

Montant facturé — chaîne décimale (preserve la précision).

currency
string
requis

Code de la devise (fiat ou crypto).

assetCode
object | null
requis

Code de l'actif crypto suggéré pour le paiement (optionnel).

description
object | null
requis

Description libre affichée au client (optionnelle).

meta
object
requis

Métadonnées libres attachées à la facture, dont la liste des articles lorsqu'elle est détaillée.

status
string
requis

Statut courant de la facture (draft, sent, paid, expired, cancelled).

paymentIntentId
object | null
requis

Identifiant de l'intention de paiement liée si la facture a été payée.

expiresAt
object | null
requis

Date d'expiration — ISO 8601. null si pas d'échéance.

createdAt
string
requis

Date de création — ISO 8601.

Lien public que le client peut utiliser pour payer la facture.