Smart Form

Simple to integrate, Smart Form is a smart payment form accessible by the API via the paymentRequest service. Hosted in CentralPay’s PCI-DSS area, it includes essential features to payment needs.

By using Smart Form, you avoid the most restrictive part of PCI-DSS requirements. All sensitive data is processed directly in CentralPay’s PCI-DSS environment. Therefore, credit card data never passes through your server.

Smart Form is linked to the following services :

paymentRequest service that initiates payment claims
“Push & Pay” service that automates and issues notifications

With Smart Form, most complex parts of the process are managed by CentralPay :

Generating and hosting payment form,
Verifying users information,
Managing the various payment methods,
Securing cards data,
Generating payment reminders or requests,
Managing the different payment methods and types.

The service is accessible through :

CentralPay API integrated with a third party Information System :
- By HTTPS redirect to a website
- By e-mail/SMS notifications
- By displaying or printing a QR Code
The web console or CentralPay mobile application :
- By e-mail/SMS notifications
- By displaying or printing a QR Code

Example of Smart Form

Available payment methods

CREDIT CARDS

Visa, Mastercard, Amex, Bancontact…

CREDIT CARDS

Payment in installments to stagger your customers payments.

Visa, Mastercard, CB

E-WALLET AND LOCAL PAYMENT SYSTEMS

PayPal, Alpay, WeChat, Ideal…

HOLIDAY VOUCHERS

ANCV

FIDELYPAY

Cashback, discounts, fidelity points

TRANSFER

SCT (SEPA Credit Transfer)

Choice of payment methods :

Point of sale configuration defines the payment methods that will be accessible to the customer.
Depending on the desirable interactions between combined payments, some methods may not be available.

Combined with the Push & Pay service, a Smart Form can integrate recurring payment methods :

Multi-participants payments
Combined payments on several payment methods
Automation of requests, reminders and notifications

Payment request

paymentRequest defines terms and conditions of payment of an amount to be cashed. The instruction can be initiated to be either transmitted live from an HTTPS redirection from a website to the payment form, or from the PUSH & PAY service by e-mail/SMS notification or by displaying a QR Code.

With the PUSH & PAY service, it is possible to create complex workflows that allow for advanced interaction with consumers or third-party platforms. You need to set up email/SMS templates and scenarios before using this object.

Read more about Payment request

Operation of a payment request

A payment claim allows to reserve an amount to be settled according to the terms defined in its request.

Fixed amount :
- The settlement is set at a single amount (totalAmount).
- The Payer will not be able to change the amount.
Free amount / Pay with multiples cards :
- The customer can pay the amount he wants and use several cards.
- To initiate a free amount, dont send a breakdown amount
Fixed amount with staggered payment with installment :
- Allows the initial amount to be split into several payments (Installment) according to a defined frequency.
Partial amount :
- The payment amount is free. The Payer will be able to pay in multiple installments by setting the amount himself or by re-filing the payment request to third parties.
- To initiate a partial amount and leave the cardholder to pay with more than one card, set the breakdown amount blank (Ex : -F breakdown[]='{"amount":, "email":"johnDoe@hotmail.com"}'.)
Multi-participants payment based on fixed amounts :
- The total amount is broken down into several sub-amounts that are allocated to each participant.
- Each participant will then receive a notification by e-mail or SMS allowing them to go to the payment page in order to pay the amount allocated to them.

The configuration is equivalent to filling in the following data according to the context :

		I'm paying
		Alone		With several people
		Recipient	Amount	Recipient	Amount
Amount	Partial	@1 -->	N/A	@1 --> @2 --> @3 -->	N/A N/A N/A
Amount	Fixed	@1 -->	1 000 €	@1 --> @2 --> @3 -->	500 € 300 € 200 €

A successful payment request addresses in response :

The address of the payment form and associated features in the form of :
- QR CODE
- URL
UUID of the request

The list of available payment methods can be configured at the point of sale defined by : 

Crédit Card
Credit Card (installment payments)
redit Card (subscription)
Holidays vouchers
Transfer
Wallet
FidelyPay

STATUS

Request status	Active = allows payments Canceled = Request has been canceled - doesn't allows payment Closed = Payments can't be performed
Payment status	Pending = Payment is expected Partial = A Partial payment has been completed and registred Paid = Payment has been completed UNPAID: unpaid, payment not completed
Breakdown status	Pending = Payment is expected Partiel = A partial payment has been completed and registered Paid = a Breakdown Payment has been completed
Notification	SMS : association of an existing template E-mail : association of an existing template E-mail list: association of an recipient from an existing list Webhook : Activate a Webhook notification

Read more about Operation of a payment request

Initialization of requests

Payment requisitions are initializable from :

CentralPay API
CentralPay console
CentralPay mobile app

Read more about Initialization of requests

Types of payment request

There are 3 types of payment requests in the backoffice :

1/ Instantaneous requests :

They are characterized in the interface by a lightning symbol and can be created as follows :

They include the possibility to carry out transactions, guarantees, subscriptions, X payments and transfers. It is also possible to create customers by saving your customer data, or to search for existing customers.

From it, it is possible to directly upload a CSV or JSON file, or to download a model (the data is fictitious and given as an example).

The "force import" option allows to submit the import despite syntax errors.

Additional settings will be available to configure X times payments and subscriptions :

2/ Programmed requests

They are characterized in the interface by a clock symbol and can be created as follows :

They include the same options as the instantaneous ones such as the possibility to carry out transactions, deposits, subscriptions, X times payments and transfers. It is also possible to create customers by saving your customer data, or to search for existing customers.

The difference with instant payment requests lies in the possibility of using a special profile, as well as some options :

A payment deadline can be added, after which your customer will not be able to pay anymore.
An expiration deadline, which is the date from which the payment form expires.
The addition of a scenario that will allow you to configure specific notifications on this payment request.
The addition of a payment confirmation email.
Added a language for the payment request.
A display rule that allows you to choose a display template and a custom SMART FORM if needed.
The sending of an Attachment in the payment confirmation email.

3/ Importation of bulk payment request

The functionality is available from the import button on the payment request listing page (Backoffice 10.7.0) :

Be carefull, to have access to this functionality, you must be connected in Merchant and have the ACL 'cpay_core_payment_request' in CREATE.

When you click on the import button, a popin appears :

From it, it is possible to directly upload a CSV or JSON file, or to download a model (the data is fictitious and given as an example).

The "force import" option allows to submit the import despite syntax errors.

Listing of the fields of the file to be imported :

Label	Description	Comments
profile_uuid*	Payment Request Profile UUID	Must exist and belong to the merchant Mandatory
merchant_payment_request_id	Merchant reference	Between 0 and 100 characters
description	Description	Between 0 and 255 characters
total_amount*	Amount of the request for payment	Must be > 0 Mandatory
last_name	Name	Between 0 and 35 characters
first_name	First name	Between 0 and 35 characters
*Email si phone vide**	Email	Mandatory if Phone is empty Between 0 and 255 characters If the email is present in the Customer database (and create_customer to N), the Customer data will be taken over. If the email (and possibly name and surname) is associated with several Customers, the last created will be taken over.
Phone * si email vide	Phone	Required if Email is empty Between 0 and 255 characters International Format : ^\\+[0-9]{1,15}$ Ex : +33612345678 If email is provided and is present in the Customer database (and create_customer to N), the Customer's data will be taken over. If an email is provided (and possibly name and surname) and is associated with several Customers, the last created will be taken over.
create_customer*	Create a customer	Possible value : "Y" (yes) or "N" (no) Mandatory
link_expiration_date	Payment deadline	if completed, overwrites the payment request profile. Format: YYYY-MM-DD Must be > in NOW
deadline	Expiration date of the link	if completed, overwrites the one in the payment request profile Format: YYYY-MM-DD Must be > in NOW
receipt_email	Email of receipt confirmation of payment	if completed, overwrites the payment request profile. If not filled in, the value of the email field will be taken over.
language	Language used in the application	if completed, overwrites the payment request profile. The default is : English.

Be careful, it is necessary to put all the fields in the file, in no particular order.

If the file contains errors with respect to the constraints listed above, an error message will be displayed at the top of the popin so that the merchant can correct his :

If the file passes the checks, the merchant will be redirected to the payment request listing page with a :

It is then the batch that will create the payment requests and send a summary email to the email address of the profile that created the import.

Read more about Types of payment request

Payment Request Profile

The profiles are linked to the Push & Pay service and to the payment requests. The profiles contain the parameters of the payment requests and the possibility to choose a scenario. They will constitute templates of already pre-made behaviors that will be automatically applied to the payment requests in which the profile will be selected. They can then be used in scheduled payment requests and mass payment requests.

In the general configuration part, it is possible to choose a name, a point of sale, a currency linked to the point of sale and a language, which will influence the language in which the information will be displayed for your customers.

In the payment methods section, it is possible to choose the nature of the payment request (Transaction, Deposit, Payment in X times, subscription or transfer).

Finally, in the options, it is possible to choose a payment limit (after which your customer will no longer be able to pay), a link expiration limit (after which your customer will no longer be able to pay through the form specifically), the possibility of choosing a scenario that will send notifications at key moments of the payment request, a payment confirmation reception email, display rules, the possibility of adding attachments and finally the possibility of automatically creating customers as soon as the profile is used.

Display rule - Smart form settings and redirection

Form settings are SMART FORM templates, customized according to your needs
They are called “Display Rules” in the payment request creation.
These templates are already integrated in the programmed payment requests, by a choice or via the chosen profile. They are also included in bulk payment requests via the chosen profile.

The available fields for templates are: the name of the template, the possibility to make the template by default, the possibility to display the CVV field as well as the possibility to force the creation of a customer. Also available are the fields including the redirection URL as well as the delay of redirection.

Finally, it is possible to add additional fields to the automatically generated forms, the checked fields will be added to the fields already present on the classic SMART FORM. The fields added may be delayed if the template is used for transfers or for a payment request by credit card.

The list of additional fields is as follows:

Address 1
Address 2
Address 3
Address 4
City
Country
Email
First name

Smart form integration

We will show you the different steps involved in a standard integration of our Smart Form.

First, you have to initialize a payment request with the payment information you want and that you have collected from the client. The initialization is usually done via a php curl. You can find a PHP curl on our example site.
For reasons of readability of the information sent, our example will be done in native cURL.

Native cURL example :

curl --location --request POST 'https://test-api.centralpay.net/v2/rest/paymentRequest' \
--header 'Authorization: Basic ZG9jdGVzdDo0STlISlJUZA==' \
--form 'paymentMethod[]="TRANSACTION"' \
--form 'currency="EUR"' \
--form 'totalAmount="100000"' \
--form 'partial="false"' \
--form 'breakdown[]="{amout:100000, email:johnDoe@hotmail.com}"' \
--form 'transfer[]="{destinationWalletId:10cfe034-ba9a-457e-b13d-fc68a5bfd171, amount:100000, email:johnDoe@hotmail.com}"'

Once this Payment request is correctly initiated, we return a JSON response. The information to display the smart form is present in this response, so you must retrieve and process it in order to retrieve the endpoint(s). There are several endpoints if you initiate a payment request with several payers, and therefore several breakdowns.

Example curl response :

{
    "paymentRequestId": "4cd3c57c-a71e-4e5d-832c-46e0b30d85c6",
    "creationDate": "2021-06-10T12:34:44.386219+02:00",
    "pointOfSaleId": "cfc0b3c7-e666-4c52-b77a-96f234b873fe",
    "deadline": null,
    "linkExpirationDate": null,
    "endingDate": null,
    "scenarioId": null,
    "scenarioStartingDate": null,
    "paymentFormTemplateId": null,
    "merchantPaymentRequestId": null,
    "description": null,
    "currency": "EUR",
    "totalAmount": 100000,
    "paymentRequestStatus": "ACTIVE",
    "paymentStatus": "UNPAID",
    "createCustomer": false,
    "paymentMethods": [
        "TRANSACTION"
    ],
    "transaction": {
        "paymentRequestTransactionId": "a094ba26-d5e3-41e1-a9d4-4d88bc6f838e",
        "contractId": "71602dd0-2790-4743-877b-e72530d7576d",
        "receiptEmail": null,
        "source": "EC",
        "capture": true,
        "customAcceptanceData": {}
    },
    "installment": null,
    "subscription": null,
    "breakdowns": [
        {
            "paymentRequestBreakdownId": "d3d48c4d-50d8-46d1-ba54-720b673dcc27",
            "customerId": null,
            "lastEnteringDate": null,
            "lastPaymentAttempt": null,
            "amount": null,
            "initiator": true,
            "endpoint": "https://test-form.centralpay.net/b670bb15-c243-450c-aa2b-ea6b077231e2",
            "email": "johnDoe@hotmail.com",
            "phone": null,
            "firstName": null,
            "lastName": null,
            "entered": false,
            "paymentAttempted": false,
            "paid": false,
            "view": 0,
            "payments": []
        }
    ],
    "transfers": [
        {
            "destinationWalletId": "10cfe034-ba9a-457e-b13d-fc68a5bfd171",
            "escrowDate": null,
            "amount": 100000,
            "fee": 0,
            "merchantTransferId": null
        }
    ],
    "wireTransfer": null,
    "transferGroup": null,
    "attachments": [],
    "language": "eng",
    "redirectUrl": null,
    "closeComment": null,
    "additionalData": {}
}

Example of an endpoint :

"endpoint": "https://test-form.centralpay.net/b670bb15-c243-450c-aa2b-ea6b077231e2"

The last step is to display the smart form to your customer. You can either display the smart form in another page, or integrate it directly into your page via an iframe.

Example of iframe :

<!DOCTYPE html>
<html>
<head>
<title></title>
</head>
<body>
<iframe src="https://test-form.centralpay.net/b670bb15-c243-450c-aa2b-ea6b077231e2/transaction" id="iframeForm" width="1000" height="1000"></iframe>
</body>
</html>