Payment

A Payment field adds a payment button to the form. When the client clicks it, the payment page of your payment provider opens in the form, and the client pays, for example by credit card. Details of the payment, such as the last digits of the card, can be written into fields of the form.

The Payment field is available in HTML and PDF templates, when payment integrations are enabled for your project. A new payment field is required, and only the client can use it. For the settings that all fields share, such as the label, permissions, dependencies and style, see Field settings.

Before you start

Create a payment integration on the Integrations screen. See Payment integration.

Settings

Setting	Tab	What it does
Button text	Values & Display	The text on the payment button. The default is “Credit Card details”.
Payment Integration	Developer	The payment integration to use. The project’s payment integrations are listed.

After you select the integration, the Developer tab shows the settings of its payment provider. For example, for Credit Guard:

Setting	What it does
Select the amount input field	The field that holds the amount to pay. The amount is required: without it, the payment can’t start. The field can have a default value, be filled in by the agent, or be hidden.
Transaction type	debit (a one-time payment) or recurringDebit (a recurring payment).
recurrence (in weeks)	The recurrence of a recurring payment, from 1 to 52.
Unlimited	Makes a recurring payment unlimited.

Payment fields created in earlier versions show their saved settings, for example Transaction type and Select the amount input field, in the same place.

Map the payment details to fields

You can write details returned by the payment provider into fields of the form, for example to show the card’s last digits or to send the authorization number to the archive.

1. On the Developer tab, click Add Mapping.
2. In Source, select the detail returned by the provider.
3. In Target, select the field that receives it: a Text, Number or Image field.

Each source and each target can be used only once, and the amount field can’t be a target. To remove a mapping, click its X button.

Do not expose tokens or other confidential data. Hide such fields from the viewer, or make sure your archive can accept them.

Details returned by Credit Guard

Source	Description
card_expiration	The expiration date of the card.
cguid	The unique ID of the transaction.
card_no	The card number.
card_mask	The masked card number.
card_name	The name of the card owner.
card_brand	The brand of the card.
card_aquirer	The acquirer of the card.
credit_company	The credit card company.
club_id, club_code	The club ID and the club code of the card.
currency	The currency of the transaction.
total	The total amount of the transaction.
life_style	Whether the card is a Life Style card.
auth_number	The authorization number of the transaction.
personal_id	The ID number of the card owner.
blocked_card	Whether the card is blocked.
verify_error_code	The result code. A value other than 000 usually means an error.
verify_error_description	The result message. Usually has a value when the result code isn’t 000.

Other providers return other details. The Source list shows the details of the selected integration.

What the client sees

1. The field shows a button with the Button text.
2. The client clicks the button. The payment page of the provider opens in the form.
3. The client completes the payment. When the payment succeeds, the payment page closes and the mapped fields are filled in. If the payment fails, an error is shown in the field.

The content and the look of the payment page are managed by the payment provider, not by Cellosign.

In the archive data, the payment field holds the status and type of the payment, the transaction ID, the provider’s reference and result, and the amount.