L'objet Payment décrit un achat en plusieurs fois dans sa totalité : montant et date de l'achat, informations client et échéancier.
La plupart des attributs sont en lecture seule: seuls ceux mentionnés dans le paragraphe Créer un payment ci-après peuvent être renseignés.
| Champ | Type | Description |
|---|---|---|
| id | string | Identifiant du Payment |
| merchant_id | string | ID du marchand attaché au Payment |
| merchant_name | string | Nom du marchand attaché au Payment |
| state | string | État du paiement : not_ready ou not_started (le paiement a été créé), scored_no (le paiement en plusieurs fois est refusé par Alma), scored_yes (le paiement en plusieurs fois est accepté par Alma), scored_maybe (Alma a besoin de plus d'informations pour décider de l'acceptation du paiement), in_progress (paiement en cours – au moins une échéance a été payée, mais il reste des échéances non payées) ou paid (le client ne doit plus d'argent à Alma). Note : même dans les états scored_no et scored_maybe, un paiement peut finalement être payé en une fois par le client : si c'est le cas l'état passera alors à paid. |
| created | timestamp | Date de création du Payment |
| updated | timestamp | Date de dernière modification du Payment |
| expired_at | timestamp or null | Date d’expiration du Payment, si expiré |
| url | string | URL de la page Alma correspondant à ce paiement. Quand le paiement est paid cette page devient un résumé de l'état du paiement et des éventuels retards de paiement pour le client |
| return_url | string or null | URL vers laquelle le client sera redirigé une fois le paiement effectué, généralement là où le marchand valide la commande |
| customer_cancel_url | string or null | URL vers laquelle le client sera redirigé si le paiement est annulé par le marchand ou le client |
| failure_return_url | string or null | URL vers laquelle le client sera redirigé si le paiement n’est pas accepté par Alma |
| purchase_amount | int | Montant du panier, sans les frais Alma |
| installments_count | int | Nombre d’échéances du paiement |
| kind | string or null | Type de paiement: P1X, P1X_D+30, P3X, P10X, etc… |
| payment_plan | array | Liste des échéances, avec pour chacun: |
| payment_plan[state] | string | État de l’échéance, valeurs possibles : pending (pas encore prélevé), paid (prélevé), covered (incident de paiement couvert par Alma). L'état d'un prélèvement ne renseigne pas sur l'existence d'un remboursement (partiel ou total) opéré sur le paiement associé au prélèvement ; voir refunds pour connaître la liste des remboursements (afin, par exemple, de déterminer si un remboursement total a été opéré sur le paiement). |
| payment_plan[is_check] | boolean | Vrai si ce prélèvement correspond à un vérification par Alma de la méthode de paiement du client |
| payment_plan[original_purchase_amount] | integer | Montant originel de l'échéance à la création du paiement |
| payment_plan[purchase_amount] | integer | Montant de l'échéance, sans les frais |
| payment_plan[customer_fee] | integer | Frais bruts payés par le client lors de cette échéance |
| payment_plan[customer_interest] | integer | Montant des intérêts pour cette échéance dans la cas des credits |
| payment_plan[due_date] | timestamp | Date à laquelle cette échéance est due |
| payment_plan[date_paid] | timestamp or null | Date à laquelle cette échéance a été payé |
| customer | Customer | Client, voir section Customer |
| shipping_address | Address or null | Adresse de livraison de la commande, voir section Address |
| billing_address | Address or null | Adresse de facturation de ce paiement, voir section Address |
| custom_data | JSON | Objet JSON de format libre qui vous permet d'associer au paiement Alma des données provenant de votre base de données. Typiquement utilisé pour retrouver facilement l'identifiant du panier/de la commande à l'origine du paiement. |
| orders | list of Order | Liste des commandes payées avec ce paiement, voir section Order |
| origin | string or null | Origine du paiement |
| integration_origin | string or null | Identifiant de l’intégration à l’origine du paiement |
| seller | object or null | Object représentant le vendeur à l’origine du paiement |
| seller[id] | string | Identifiant de l’utilisateur Alma |
| seller[name] | string | Nom du vendeur |
| seller[display_name] | string | Nom d’affichage du vendeur |
| seller[email] | string | Email du vendeur |
| deferred_months | integer | Nombre de mois précédant la première échéance. |
| deferred_days | integer | Nombre de jours précédant la première échéance. |
| is_deferred_capture | boolean | Vrai si le paiement utilise la fonctionnalité de Capture Différée |
| capture_method | string | Si présent, indique la méthode par laquelle le paiement peut être capturé. |
| authorization_expires_at | datetime or null | Si présent, indique la date à laquelle l’autorisation expire pour ce paiement s’il n’est pas capturé |
| locale | string | Indique la langue dans laquelle communiquer avec le client: fr, en, it, es, de, nl ou nl_BE |
| transaction_country | string or null | Indique le pays dans lequel la vente à lieu dont découle les conditions générales de vente. |
| country_of_service | string or null | Pays qui détermine les licences applicables et les règles de régulation du paiement. |
| ipn_callback_url | string or null | URL appelée de façon asynchrone par nos serveurs une fois le paiement effectué, afin de valider la commande auprès de la boutique au cas où le client aurait fermé son navigateur prématurément, ou rencontré un problème réseau lors de la redirection vers l'URL return_url. |
| cart | object or null | Contenu du panier à la création du Payment. Voir Custom Data pour le format. |
| payout | object or null | Pour les marchands en intégration indirecte, représentation de la transaction liée au paiement |
| payout[status] | string | État de la transaction : pending, completed ou failed |
| payout[merchant_psp] | string or null | Nom du fournisseur de paiement du merchant |
| payout[merchant_psp_id] | string or null | Identifiant de la transaction chez le fournisseur de paiement du marchand |
| payout[merchant_psp_metadata] | object | Métadonnées transmises par le fournisseur de paiement du marchand |
| payout[processed_at] | timestamp or null | Date à laquelle la transaction a été créée par Alma |
| refunds | list of Refund | Liste des remboursements opérés sur ce paiement, voir section Refund |
| is_completely_refunded | boolean | Vrai si le paiement a été remboursé intégralement |
| amount_already_refunded | integer | Montant total remboursé au client |
| customer_fees_refunded | integer | Montant des frais remboursés au client |
| fees | object | Détail des frais |
| fees[merchant] | object | Détail des frais marchand |
| fees[merchant][total] | integer | Montant brut des frais marchand |
| fees[merchant][total_excluding_tax] | integer | Montant net des frais marchand |
| fees[merchant][tax] | integer | Montant de la TVA sur les frais marchand |
| customer_fee | integer | Montant brut des frais client |
| customer_interest | integer | Montant des intérêts client dans le cadre d’un credit |
| annual_interest_rate | integer | Montant du TAEG dans le cadre d’un credit |
| merchant_target_fee | integer | Montant brut des frais marchand |