Integration

PayPerEmail Service

1. Introduction

The PayPerEmail service allows you to send an email to a customer with a payment invitation link. Upon clicking the link, the customer can choose from various payment methods or proceed with a preselected method. You can either configure Buckaroo to send the email with a custom template or send the email yourself using the link provided by the Buckaroo Payment Engine.

2. Requirements

  • Service Subscription: The PayPerEmail service requires an additional service subscription that supports the Pay action, as it does not process payments directly.

3. Workflow

  1. Request Submission: The merchant sends a PayPerEmail request to the Buckaroo Payment Engine (BPE) transaction gateway.
  2. Response and Push Notification: The gateway processes the request, sends a response to the merchant, and a transaction push notification with the transaction status.
  3. Email Sending:
    • If configured, Buckaroo sends the email with the payment link.
    • Alternatively, the merchant sends the email using the provided link.
  4. Payment Process:
    • The customer clicks the link and is taken to the payment page to complete the transaction.
    • After completion, the customer is redirected back to the merchant’s website with transaction details.
    • A transaction push notification is also sent to the merchant with transaction details.

4. Single PayPerEmail, Multiple Transactions

  • A PayPerEmail transaction triggers at least one transaction, namely the PayPerEmail transaction.
  • When the customer follows the payment link and initiates the payment, a new transaction is created.
  • Once the payment is successful, the PayPerEmail transaction is marked as "Succeeded".
  • Push notifications are sent for all involved transactions.

Note: Some payment methods (e.g., direct debit, credit card) can be reversed, affecting the associated transactions' status.

5. Service Code and Actions

  • Service Code: payperemail
  • Supported Action: paymentinvitation – This action sends an invitation to the consumer to make a payment.