Skip to main content
PATCH
Mettre à jour un lien de paiement

Supported products

Paramètres de chemin

L'identifiant unique du lien de paiement à mettre à jour.

Corps

application/json
businessUnitId
object
requis

Objet représentant l'identifiant de l'unité commerciale associée au lien de paiement.

dealConfigurations
object
requis

Un objet contenant les paramètres de configuration de la transaction.

descriptionHtml
object
requis

Un objet contenant la description HTML du lien de paiement.

discountObjectId
object
requis

Un objet représentant l'ID de l'objet de réduction associé au lien de paiement.

domainId
object
requis

Un objet représentant l'ID de domaine associé au lien de paiement.

expirationSettings
object
requis

Un objet représentant les paramètres d'expiration du lien de paiement.

successUrl
object
requis

Un objet représentant l'URL de succès vers laquelle l'utilisateur est redirigé après une transaction réussie.

acceptedPaymentMethods
enum<string>[]

Un tableau de chaînes de caractères indiquant les méthodes de paiement acceptées. Les valeurs valides incluent « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS » et « PADS ».

Options disponibles:
CREDIT_OR_DEBIT_CARD,
ACH,
SEPA,
BACS,
PADS,
AFFIRM,
KLARNA
additionalFormFields
object[]

Un tableau d'objets PaymentLinkFormField représentant des champs de formulaire supplémentaires pour le lien de paiement.

automatedSalesTaxEnabled
boolean

Un booléen indiquant si la taxe de vente automatisée est activée.

collectFullBillingAddress
boolean

Un booléen indiquant s'il faut collecter l'adresse de facturation complète lors du paiement.

collectShippingAddress
boolean

Un booléen indiquant s'il faut collecter l'adresse de livraison lors du paiement.

createContractOnPurchase
boolean

Un booléen indiquant si un contrat doit être créé lors de l'achat.

currencyCode
string

Le code de devise du lien de paiement, représenté sous forme de chaîne.

discount
object
discountCodeEnabled
boolean

Un booléen indiquant si les codes de réduction sont activés pour le lien de paiement.

enableDefaultCheckoutFees
boolean

Un booléen indiquant si les frais de paiement par défaut sont activés.

feeObjectIds
string[]

Un tableau de chaînes de caractères représentant les identifiants des objets de frais associés au lien de paiement.

fees
object[]

Un tableau d'objets FeeRequest représentant les frais associés au lien de paiement.

includeEmailInSuccessRedirect
boolean

Un booléen indiquant s'il faut inclure l'email dans la redirection en cas de succès.

isOneTimeUseEnabled
boolean

Un booléen indiquant si le lien de paiement est activé pour une utilisation unique.

lineItemObjectIds
string[]

Un tableau de chaînes de caractères représentant les identifiants des objets de ligne de produit associés au lien de paiement.

lineItems
(CUSTOM · object | FROM_PRODUCT · object | CLONE · object)[]

Un tableau d'objets de lignes de produit, qui peuvent être de type LineItemCustomCreateRequest, LineItemFromProductCreateRequest ou LineItemCloneCreateRequest.

Le nom du lien de paiement, représenté sous forme de chaîne de caractères.

state
enum<string>

L'état du lien de paiement, représenté sous forme de chaîne de caractères. Les valeurs valides sont « ON » et « OFF ».

Options disponibles:
OFF,
ON
storePaymentMethodAtCheckout
boolean

Un booléen indiquant si le mode de paiement doit être enregistré lors du paiement.

taxObjectIds
string[]

Un tableau de chaînes de caractères représentant les identifiants des objets fiscaux associés au lien de paiement.

taxes
object[]

Un tableau d'objets TaxRequest représentant les taxes associées au lien de paiement.

Réponse

successful operation

acceptedPaymentMethods
enum<string>[]
requis

Un ensemble de méthodes de paiement acceptées pour le lien de paiement. Les valeurs valides incluent : « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS » et « PADS ».

Options disponibles:
CREDIT_OR_DEBIT_CARD,
ACH,
SEPA,
BACS,
PADS,
AFFIRM,
KLARNA
additionalFormFields
object[]
requis

Un ensemble de champs de formulaire supplémentaires inclus dans le lien de paiement.

archived
boolean
requis

Un booléen indiquant si le lien de paiement est archivé.

automatedSalesTaxEnabled
boolean
requis

Un booléen indiquant si la taxe de vente automatisée est activée pour le lien de paiement.

checkoutFeeIds
string[]
requis

Un tableau d'ID de frais associés au lien de paiement.

collectFullBillingAddress
boolean
requis

Un booléen indiquant s'il faut collecter l'adresse de facturation complète lors du paiement.

collectShippingAddress
boolean
requis

Un booléen indiquant s'il faut collecter l'adresse de livraison lors du paiement.

completedPurchaseCount
integer<int32>
requis

Le nombre d'achats effectués via ce lien de paiement.

createContractOnPurchase
boolean
requis

Un booléen indiquant si un contrat doit être créé lors de l'achat.

currencyCode
string
requis

Le code de devise du lien de paiement, représenté sous forme de chaîne.

discountCodeEnabled
boolean
requis

Un booléen indiquant si les codes de réduction sont activés pour le lien de paiement.

discounts
object[]
requis

Un tableau d'objets en réduction associés au lien de paiement.

fees
object[]
requis

Un tableau d'objets de frais associés au lien de paiement.

formGuid
string
requis

Le GUID du formulaire associé au lien de paiement, représenté sous forme de chaîne de caractères.

id
string
requis

L'identifiant unique du lien de paiement, représenté sous forme de chaîne de caractères.

includeEmailInSuccessRedirect
boolean
requis

Un booléen indiquant s'il faut inclure l'e-mail dans l'URL de redirection en cas de succès.

isOneTimeUseEnabled
boolean
requis

Un booléen indiquant si le lien de paiement est activé pour une utilisation unique.

lineItems
object[]
requis

Un tableau de lignes de produit associées au lien de paiement.

Le nom du lien de paiement, représenté sous forme de chaîne de caractères.

L'URL du lien de paiement, représentée sous forme de chaîne de caractères.

state
enum<string>
requis

L'état actuel du lien de paiement, représenté sous forme de chaîne de caractères. Les valeurs valides sont « ON » et « OFF ».

Options disponibles:
OFF,
ON
storePaymentMethodAtCheckout
boolean
requis

Un booléen indiquant s'il faut enregistrer le mode de paiement au moment du règlement.

taxes
object[]
requis

Un tableau d'objets fiscaux associés au lien de paiement.

archivedAt
string<date-time>

La date et l'heure d'archivage du lien de paiement, au format ISO 8601.

businessUnitId
string

L'ID de l'unité commerciale associée au lien de paiement, représenté sous forme de chaîne de caractères.

createdAt
string<date-time>

La date et l'heure de création du lien de paiement, au format ISO 8601.

dealConfigurations
object
descriptionHtml
string

La description HTML du lien de paiement, représentée sous forme de chaîne.

domainId
string

L'ID de domaine associé au lien de paiement, représenté sous forme de chaîne de caractères.

expirationSettings
object
successUrl
string

L'URL de redirection en cas de paiement réussi, représentée sous forme de chaîne de caractères.

updatedAt
string<date-time>

La date et l'heure de la dernière mise à jour du lien de paiement, au format ISO 8601.

Dernière modification le 6 octobre 2026