Aller au contenu
Documentation

Définition de l'objet

Paiement

Payment

Les propriétés d'une fiche « Paiement », ses énumérations et ses liaisons avec les autres fiches.

26 propriétés 4 énumérations 4 liaisons
3 min de lecture Mise à jour le 11 novembre 2026

Une fiche « Paiement », telle que l'API la lit et l'écrit (Payment dans la référence). Sa liste et sa création : https://staging-api.docage.com/Payments ; une fiche : https://staging-api.docage.com/Payments/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.

3 fiches liées · survolez une fiche pour lire son nom et son rôle

Ses propriétés

  • AllowedPaymentAccountIdsliste d'identifiants

    Comptes de paiement autorisés

  • AmountnombreÉcrite par le serveur

    Montant

  • AmountTexttexte, 255 caractères au plus

    Montant (texte ou jeton)

  • CanChangeAccountoui ou non

    Vrai tant que le compte marchand se change encore : la session n'a pas été créée chez le fournisseur.

  • Mode de capture

  • Currencytexte, 3 caractères au plus

    Devise

  • Descriptiontexte, 1024 caractères au plus

    Description

  • ExpirationDatedate et heure (UTC)Écrite par le serveur

    Date d'expiration

  • Instancesliste de Payment

    Paiements issus de ce modèle

  • Linktexte

    Lien de paiement

  • OriginPaymentOriginÉcrite par le serveur

    Origine

  • PaidAtUtcdate et heure (UTC)Écrite par le serveur

    Date de paiement

  • PayerEmailtexte, 255 caractères au plus

    Email du payeur

  • PayerNametexte, 255 caractères au plus

    Nom du payeur

  • PaymentAccountIdidentifiant

    Identifiant du compte de paiement

  • PaymentMethodtexte, 100 caractères au plusÉcrite par le serveur

    Moyen de paiement

  • ProviderPaymentProviderÉcrite par le serveur

    Le fournisseur, recopié du compte au Start — une photo, jamais une jointure vivante. null tant que le paiement n'a pas commencé.

  • ProviderPaymentIdtexte, 255 caractères au plusÉcrite par le serveur

    Identifiant chez le fournisseur

  • ProviderStatustexte, 100 caractères au plusÉcrite par le serveur

    Statut chez le fournisseur

  • Referencetexte, 255 caractères au plus

    Référence

  • StatusPaymentStatusÉcrite par le serveur

    Statut

  • StatusDatedate et heure (UTC)Écrite par le serveur

    Date du statut

  • StatusDetailstexteÉcrite par le serveur

    Détails du statut

  • TemplatePayment

    Modèle dont ce paiement est issu.

  • TransactionActionIdidentifiantÉcrite par le serveur

    Identifiant de l'action de parcours

  • TransactionIdidentifiantÉcrite par le serveur

    Identifiant du parcours

Ses énumérations

PaymentCaptureMode

  • 1Automatique
  • 2Manuelle

PaymentOrigin

  • 1Utilisateur
  • 2Parcours
  • 3Formulaire
  • 4Flux
  • 5Email

PaymentProvider

  • 1Stripe
  • 2PayPal
  • 3Adyen

PaymentStatus

  • -100Erreur
  • 0Brouillon
  • 1En attente
  • 2Commencé
  • 3Réussi
  • 4Échoué
  • 5Annulé
  • 6Expiré
  • 7Remboursé

Ses liaisons

Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans une liste (voir Lire des listes).