Syntax

The syntax used for sending a payment order is very simple:

"amount"  "currency"  "buyer’s phone number"

Example:

120,50 EUR +49XXXXXXXXXXX

Here is a list of available parameters.
Parameter Syntax Required Description
Amount 100.32 or 100.32 Yes Amount to be paid, including tax.

Both point and comma are accepted as the decimal separator.

Currency
EUR
Yes Payment currency.

Lowercase and uppercase letters or a combination of both are accepted (e.g.: UsD).

Phone
+49XXXXXXXXXXX
No Buyer’s cell phone number preceded by the country code.

“Classic” mode:

If the parameter is transmitted, the payment order is transmitted to the Buyer via WhatsApp and the Merchant receives a copy of the message.

If the phone number does not match the one specified for WhatsApp, the Merchant receives a message with the payment link that he or she can transmit to the Buyer via another channel.

“Echo” mode:

If the parameter is not transmitted, the Merchant will receive a message with the payment link that he or she can transmit to the Buyer via the channel of his or her choice (SMS, Messenger, Instagram, etc.).

Order ID
ORDER=myOrder-133
No Order ID.
E-mail
john.doe@example.com
No* The Buyer’s e-mail address that will receive the payment receipt.

* The buyer’s e-mail address is mandatory in case of a payment method registration request.

Mode
TEST
No Allows to create a test payment order.

If the parameter is not transmitted, the payment orders are created in PRODUCTION mode.

Note:

As long as the shop is in TEST mode, the default mode is TEST, even if the field is not transmitted.

Shop ID
SHOP=12345678
No When a company has several shops, it allows you to override the shop associated with the payment.
Validity period of the order.
DELAY=10
No Allows to override the validity period of the payment order (expressed in days) defined in the Merchant Back Office.

The maximum value is 99 days.

VAT amount
VAT=0 | IVA=19.6 | TVA=5,5%
No Allows to override the default VAT rate.

The amount of taxes transmitted to the Acquirer is calculated based on the amount to be paid (including taxes) and the VAT rate.

The rate amount is unrestricted.

Both point and comma are accepted.

The “%” symbol is optional

Data collection form
FORM
No Allows to call a personalized data collection form before the payment. Via this form, the Merchant can collect Buyer’s data (first name, last name, address, etc.).
Submission of a payment order without an amount via the data collection form
0 CURRENCY FORM
  Allows to call a personalized data collection form with unrestricted amount entry.

The recipient of the payment order will enter the desired amount when they enter the required data in the form.

Creating a token without payment
REGISTER
No Allows to send buyer’s payment method record order for future purchases.

Buyer’s e-mail address is required.

Example:
REGISTER john.doe@example.com
Creating a token during a payment
REGISTER
No Allows to send a payment order and to record the buyer's payment method.

Buyer’s e-mail address is required.

Example:
REGISTER 10 EUR john.doe@example.com
Payment with the token creation option for the cardholder
ASK
No Allows to send a payment order and offer the buyer, if they wish to do so, to record their payment method upon the payment.
Example:
ASK 10 EUR john.doe@example.com
Language of the message, in “echo” mode.
en | es | fr | de | pt
No Allows to define the language used for sending the message to the Merchant, in “echo” mode.
Payment order entry wizard.
LINK
No Allows to receive a link that redirects the user to a Production payment order creation wizard.
Help
HELP | help | ? | ¿
No Allows to receive the chatbot message via WhatsApp.