{"id":16332,"date":"2024-03-20T09:14:43","date_gmt":"2024-03-20T08:14:43","guid":{"rendered":"https:\/\/docs.centralpay.com\/documentation\/payment-links\/payment-requests\/"},"modified":"2026-08-18T11:33:20","modified_gmt":"2026-08-18T09:33:20","slug":"payment-requests","status":"publish","type":"docs","link":"https:\/\/docs.centralpay.com\/en\/documentation\/payment-links\/payment-requests\/","title":{"rendered":"Payment requests"},"content":{"rendered":"\n

The payment request (PaymentRequest<\/code>) is the service that allows you to generate payment links. You can create payment requests via API or via the Merchant Portal. The payment request can also be paired with the CentralPay notification service<\/a>, allowing you to easily send a payment link to your customers by email or SMS and schedule automated reminders. <\/p>\n\n

1. API creation<\/h2>\n\n

1.1. Create a PaymentRequest<\/h3>\n\n

Below are the available payment methods and the corresponding API values in the PaymentRequest service:<\/p>\n\n

Desired payment method or mode<\/th>API values to provide<\/th><\/tr><\/thead>
One-off payments<\/strong><\/td><\/td><\/tr>
Card transaction<\/td>paymentMethod[]=TRANSACTION<\/td><\/tr>
Card deposit (reserved for rental businesses)<\/td>paymentMethod[]=TRANSACTION
transaction[source]=DP<\/td><\/tr>
Card verification\/imprint (0\u20ac transaction)<\/td>paymentMethod[]=TRANSACTION
transaction[source]=RI<\/td><\/tr>
Bank transfer transaction<\/td>paymentMethod[]=SCT_TRANSACTION<\/td><\/tr>
SEPA Direct Debit transaction<\/td>paymentMethod[]=SDD
sdd[remittanceInformation]<\/td><\/tr>
Pay by bank transaction (standard transfer)<\/td>paymentMethod[]=SCT_TRANSACTION_PIS<\/td><\/tr>
Pay by bank transaction (instant transfer by default, otherwise standard)<\/td>paymentMethod[]=SCT_TRANSACTION_PIS_IP<\/td><\/tr>
Recurring payments<\/strong><\/td><\/td><\/tr>
Card subscription<\/td>paymentMethod[]=SUBSCRIPTION
subscriptionModel[subscriptionModelId]<\/td><\/tr>
SEPA Direct Debit subscription<\/td>paymentMethod[]=SUBSCRIPTION
subscription[source]=SDD
subscriptionModel[subscriptionModelId]<\/td><\/tr>
Card instalment payment<\/td>paymentMethod[]=INSTALLMENT
intallment[intervalUnit]
installment[intervalCount]
installment [iterationCount]<\/td><\/tr>
SEPA Direct Debit instalment payment<\/td>paymentMethod[]=INSTALLMENT
installment[source]=SDD
intallment[intervalUnit]
installment[intervalCount]
installment [iterationCount]<\/td><\/tr><\/tbody><\/table><\/figure>\n\n

If you want to allow multiple payment methods or modes in your PaymentRequest, you must provide the paymentMethod object multiple times.<\/p>\n\n

<\/div>\n\n

Example:<\/strong><\/p>\n\n

paymentMethod[]=TRANSACTION\npaymentMethod[]=SCT_TRANSACTION<\/pre>\n\n
\u26a0\ufe0f Some combinations of payment methods or modes may conflict and your PaymentRequest may return an error. For example, you cannot allow a TRANSACTION and a SUBSCRIPTION; however, you can allow a TRANSACTION and an INSTALLMENT. <\/p>\n\n
<\/div>\n\n
Here is the key information about other values to provide when creating a PaymentRequest:<\/p>\n\n
Label<\/th>Definition<\/th><\/tr><\/thead>
amount<\/code><\/td>Payment request amount in cents<\/td><\/tr>
merchantPaymentRequestId<\/code><\/td>Custom reference (your order or invoice number, for example) that you can use to reconcile the payment. This value will be visible to your customer on the payment page <\/td><\/tr>
description<\/code><\/td>Custom description (name of the product or service sold). This value will be visible to your customer on the payment page <\/td><\/tr>
additionalData[*]<\/code><\/td>Free key-value data, allowing you to pass through one or more data items (invoice references, customer number, etc.). Not visible to your customer on the payment page <\/td><\/tr>
createCustomer<\/code><\/td>TRUE \/ FALSE creation of a Customer account (in particular, enables saving the customer payment method: card, SEPA mandate, and creating a virtual IBAN dedicated to the Customer)<\/td><\/tr>
breakdown[customerId]<\/code><\/td>Select an existing Customer<\/td><\/tr><\/tbody><\/table><\/figure>\n\n
\u2139\ufe0f For SEPA transfer transactions, you can define whether you want to display the Virtual IBAN dedicated to the Customer or generate a single-use Virtual IBAN (SCT) from the settings of your Points of Sale<\/a>.<\/pre>\n\n
1.2. Send a PaymentRequest by email \/ SMS<\/h3>\n\n
When creating it, you can ask CentralPay to send the payment request to your customer. There are two sending methods: <\/p>\n\n