Passer au contenu principal
PapelPay est le moyen de paiement par carte de votre boutique PapelShip. Avec la Store API, vous créez une commande, lancez son paiement PapelPay, puis laissez le client payer par carte sur votre page de paiement hébergée ou dans un formulaire de carte sur votre propre site. Les commandes de produits vendus sous forme d’abonnement sont débitées à nouveau à chaque période de facturation.
PapelPay doit être activé sur votre boutique. Faites-en la demande dans le tableau de bord, sous PapelPay ; les points de terminaison de cette page renvoient PAPELPAY_NOT_ENABLED tant que votre boutique n’est pas approuvée.

Fonctionnement d’un paiement par carte

1

Créer la commande

Appelez POST /api/v1/invoices avec le client et les produits, comme dans Créer et gérer des commandes. Ajoutez auto_renew pour vendre un produit d’abonnement sous forme d’abonnement ou d’achat unique. Consultez Abonnements.
2

Lancer le paiement par carte

Appelez POST /api/v1/invoices/{invoiceId}/papelpay, ou envoyez "payment_method": "PAPELPAY" lors de la création de la commande pour faire les deux en un seul appel. La réponse contient un objet payment.
3

Laisser le client payer

Redirigez le client vers payment.payment_url, votre page de paiement hébergée ouverte sur le formulaire de carte. Pour garder le client sur votre site, intégrez payment.embed_url avec le SDK JavaScript. Consultez Formulaire de carte sur votre site.
4

Confirmer la commande

Une fois la carte débitée, la commande passe à completed et PapelShip livre les produits. Écoutez le webhook order.completed, ou lisez la commande avec GET /api/v1/invoices/{invoiceId}. Consultez Webhooks.

Lancer le paiement par carte

Réponse (200)
Appeler à nouveau le point de terminaison tant que le paiement est ouvert renvoie le même session_id. Utilisez l’identifiant de la commande dans votre Idempotency-Key.

L’objet payment

Erreurs

Lorsque vous envoyez "payment_method": "PAPELPAY" à la création et que le paiement par carte ne peut pas démarrer, la commande existe malgré tout. Le champ details.invoice_id de l’erreur l’identifie, ce qui vous permet de réessayer avec POST /invoices/{invoiceId}/papelpay.

Étapes suivantes

Abonnements

Vendez un produit sous forme d’abonnement et suivez ses renouvellements.

Formulaire de carte sur votre site

Affichez le formulaire de carte sur votre propre page de paiement.