Documentation en ligne

Introduction à l'API combo

Combo est la brique de gestion du portail (portail client et portail agent). C'est également la brique qui permet d'intégrer des paiements aux démarches. L'API présentée ici est destinée à être utilisée depuis des action webservices dans un workflow.

Cette API ne permet pas de piloter des paiements depuis une application tierce.

Création d'un item à payer

Sur /api/lingo/add-basket-item via la méthode HTTP POST.

Paramètres JSON, corps de la requête

Nom

Description

Obligatoire

Exemple

amount

Montant à payer

OUI

10.05

display_name

Description de l'item à payer

NON

Abonnement au cours de pétanque

url

URL permettant de remonter à la démarche ayant provoqué l'ajout de l'item à payer

NON

{{ form_url }}

capture_date

Date de remise en banque (au format yyyy-mm-dd), remise en banque immédiate si non spécifié

NON

2019-05-06

Paramètres de la query string de la requête

Certains paramètres doivent être passé dans l'URL de de la requête

Nom

Description

Obligatoire

Exemple

NameId

Identifiant de l'utilisateur (NameId ou email doit être spécifié)

NON

{{form_user_name_identifier_0}}

email

Email de l'utilisateur (NameId ou email doit être spécifié)

NON

gerard.lambert@rungis.fr

regie_id

Identifiant ou slug de la régie de paiement (la régie de paiement par défaut sera utilisée si non spécifiée)

NON

la-regie-pas-cher

cancellable

Autorise la suppression de l'item à payer par l'utilisateur (vrai par défaut)

NON

no

Format de retour

Une réponse JSON est retournée dont les entrées sont les suivantes

Nom

Description

Exemple

result

Succès de l'ajout d'un item à payer

succes

id

Identifiant de l'item à payer

12

payement_url

URL de paiement de cet item

https://payement-operator/mon-item

Suppression d'un item à payer

Sur /api/lingo/remove-basket-item via la méthode HTTP POST.

Paramètres JSON, corps de la requête

Nom

Description

Obligatoire

Exemple

basket_item_id

Identifiant de l'item à payer

OUI

12

notify

Notifier la démarche de la suppression de l'item à payer (faux par défaut)

NON

true

Paramètres de la query string de la requête

Certains paramètres doivent être passé dans l'URL de de la requête

Nom

Description

Obligatoire

Exemple

NameId

Identifiant de l'utilisateur (NameId ou email doit être spécifié)

NON

{{form_user_name_identifier_0}}

email

Email de l'utilisateur (NameId ou email doit être spécifié)

NON

gerard.lambert@rungis.fr

Format de retour

Une réponse JSON est retournée dont les entrées sont les suivantes

Nom

Description

Exemple

result

Succès de la suppression de l'item à payer

succes

Dernière mise à jour le 3 juillet 2019 15:05 — Éditer