Overview
Overview
The customer receives an e-mail with the payment details and has to transfer the money for the ordered goods in advance. First after the full amount has been received on the merchant bank account the goods will be shipped.
Customer Experience - Prepayment
Payment method configuration
To be able to activate the prepayment payment method, first a bank account connection should be configured.
To set Bank account configuration settings:
- Go to "Bank Account" section from vertical menu in Merchant Center. It will open page where you can fill your bank account data.

- Select Country, fill BIC of your Bank account and Click on "Create User".

- It will open additional fields section to fill user and PIN.

- Now you must activate the bank account in your bank account. After that you must come back, and you will see details of your account, and you can select "Tan Schemes".

- To activate the payment method you must contact to Account manager or admin.
Customer experience
- Select payment method from the available payment methods.

- Confirm the payment.

- After finishing the payment, customer will be redirected to Success or Failure page.

PayEngine Details - Prepayment
General
Name | Details |
---|---|
Product | Prepayment |
Channels | ECOM |
Currencies | EUR |
Countries | DE |
Technical Flow | Synchronous |
Recurring | No |
Chargebacks | No |
Supported Features and Services
Name | Details |
---|---|
Debit | Yes |
Preauthorization | No |
Cancelation | No |
Capture | No |
Refunds | Yes (full and partial) Note: for more information, contact PayEngine support team. |
Notifications | Yes (webhook and email) |
PayLink Integration | No |
Settlement Reporting | No |
Integration Types
Name | Details |
---|---|
API | Yes |
Widget | Yes |
Bridge | No |
Shop Plugin | Yes |
Integration via API - Prepayment
Step 1: Create customer (POST/customers)
create customer specific request parameters
Parameter | Mandatory/Optional (M/O) | Description | Example |
---|---|---|---|
M | the e-mail adress of the customer | user@example.com |
Alternatively to create a new customer an already existing customerID can be use.
Example:
Create Customer (POST/customers)
Create customer request
{ "email": "user@example.com", "merchantCustomerId": "merchantCustomerId_696501538" }
Create customer response
{ "customerId": "customer_fl6wae2jqn", "email": "user@example.com", "merchantCustomerId": "merchantCustomerId_696501538",
Step 2: Create preauth
After successful processed preauth there are two following options for sending the prepayment payment details to the customer:
- The Payengine generate and sends an e-mail with the payment details to the customer.
- The merchant generates and sends out an e-mail with the payment details to the customer. (the automated e-mail sending function should be disabled at the merchant center).
The Payengine generates and provides a unique descriptor, which must be given by the customer as a payment reason in the bank transfer.
Example:
Preauth (POST/orders/preauth)
Create preauth request
{ "product" : "prepayment", "merchantOrderId": "merchantOrderId", "description": "description",
Create preauth response
{ "createdAt": 1537878271910, "modifiedAt": 1537878271910, "merchantId": "string",
Preauth specific response parameters
Parameter | Mandatory/Optional (M/O) | Description |
---|---|---|
descriptor | M | The Payengine generates and provides a unique descriptor, which must be given by the customer as a payment reason in the bank transfer. |
Step 3: Money received
- After money is received on the merchant bank account the Payengine captured automatically the received amount.
- The Payengine sends out a notification to the merchant when the money is received on the merchant bank account so that the order can be dispatched.
Payment disruptions
- Wrong "descriptor": In case of the customer provided wrong "descriptor" in the payment reason the PayEngine is not able to match the received money on the right Transaction. In this case possible refunds should be triggered manually by the merchant.
- Bank transfer amount is too high: The PayEngine donot refund the balance automatically.
- Bank transfer amount is too low: The PayEngine set a partial capture for the received amount and is waiting for rest amount to be paid. If the customer have not paid the rest amount, the transaction should be canceled by the merchant (without sending the goods) and refund of the already paid amount should be carrie out manually.
- No money received on the merchant bank account: The created order is valid for 7 days. After 7 days the order will be automatically cancelled.
Notifications - Prepayment
Step 1: Set up notifications
For receiving Notifications from the Payengine on status changes for prepayment the notification service should be set up
Step 2: Receive and process notifications
Status | Description |
---|---|
capture | A notification will be send if the full or a partial amount is received on the merchant bank account. |
Testing
The testing is processed via the Payengine Simulator.
Testable functionalities:
- Successful
- order decline (use 11.11 or 111.11 as amount to cause a decline)
- Payment details e-mail (on the roadmap)
- Payment received information e-mail(on the roadmap)
- Partial/full cancel
- Capture
- Partial/full refund
- Notifications - capture - settled
Order Details - Prepayment
Prepayment Orders can be found under the "Orders" section of the Merchant Center.

To view order details, click on the Actions button for selected order:

It will open detailed view of the Prepayment Order.

In the top Info container can be found information about Order:
- Payment method Icon
- Amount and currency for the order
- Status of the order

Second part contain sections with additional information:
- Summary of the order
- Billing Address
- Shipping Address
- Customer information
- Persona information
- Payment instrument information

Next part contains Transactions information.

The left part of the section contains list of created transaction:

The right contains detailed information about the selected transaction:

Transaction Details - Prepayment
After the order is created, the information about the transaction can be found in Transactions section.
In the left part, you will see general information about the transaction:
- Transaction Id
- Date and time when transaction was created
- Amount and currency if the transaction
- Status of the transaction
- Transaction type

In the right part you will see detailed information about the selected transaction and a button to cancel it:

Depending on the order status, there are different transaction types and statuses:
Created Order
When the order is created:
- Status of the transaction is "OK"
- Transaction type is "PREAUTH"

Full Cancellation of Order
When the order is canceled, In the left part you will see additional transaction with:
- Status of the transaction - "SUCCESS"
- Transaction type - "CANCEL"
- Amount - full amount of the order

There are list of connected transactions in PREAUTH transaction details section, and the "Cancel" button is missing.

Partial Cancellation of Order
When the order is partially canceled, In the left part you will see additional transaction with:
- Status of the transaction - "SUCCESS"
- Transaction type - "CANCEL"
- Parent - parent PREAUTH transaction
- Amount - canceled amount of the order

- There are list of connected transactions in PREAUTH transaction details section.
- Canceled amount is visible in transaction details section.
- The "Cancel" button is available, but only for the remaining amount.

Captured Order
When the order is payed in the left part you will see additional transaction with:
- Status of the transaction is "SETTLED".
- Transaction type is "CAPTURE".
Expired time for payment
When the time for payment is expired in the left part you will see PREAUTH transaction with:
- Status of the transaction is "PREAUTH".
- Transaction type is "EXPIRED".
- There is no Cancel option.
