Pay by Link API

Sets the language/country of the payment forms. Expects ISO 639-1 for languages and ISO 3166-1 alpha-2 for countries. Default is "en-US".

Supported languages are: ar,be,bg,cn,cz,de,da,el,en,es,fi,fr,gr,hu,it,ja,ko,nl,no,pl,pt,ro,ru,sv,sk,sl,tr

Right-to-left languages are not supported by the number formatter.

locale: "de-AT"

locale: "de"

Check the requirements of the connector you are integrating in your shop. If the connector requires to have the language and the country provided, use the format "de-AT". If there is no requirement defined, you may use any of the two options.

Sets the period during which the payment link will be valid and available to perform a checkout.

If validity period is not present default value will be 90 days

validUntil=1

Sets the validity period units. Possible values are HOUR, DAY.

validUntilUnit=HOUR

Merchant terms and conditions URL. Value must be a valid URL

termsAndConditionsUrl=https://test.docs.oppwa.com/

Merchant privacy policy URL. Value must be a valid URL

privacyPolicyUrl=https://test.docs.oppwa.com/

Used to customize the behavior of the embedded COPYandPAY in the page. Note that not all the options are available. The list of available options is listed in the Available wpwlOptions table.

wpwlOptions={"labels":{"cardHolder":"Name on card"}}

Used to collect billing information from the page. It accepts a comma separated string of pre-defined values. Available values are: street1,street2,houseNumber1,houseNumber2,city,state,postcode,country,all. Depending on which value is sent, the form will render accordingly. If all is sent, the full form is rendered.

collectBilling=postcode

Used in conjuntion with collectBiiling, makes the specified input field in the billing form mandatory. Available values are: street1,street2,houseNumber1,houseNumber2,city,state,postcode,country,all.

Except when using all, a javascript regular expression can be specified to validate each field. This feature can be implemented as follows: city,postcode:/^[a-z]{2}[0-9]{5}$/i,street1. Here postcode would have to be 2 letters (upper or lower case) followed by 5 numbers. The fields city and street1 can not be empty. As the fields country and state are drop down selections, any regular expression defined for these will be ignored but if specified a value must be selected.

mandatoryBilling=postcode

The billing address field can be used to show billing information on the page. If used together with collectBiiling, it can be used to pre-fill the billing form.

billing.postecode=81675

Used to show the customer phone number on the page.

customer.phone=+491546556745

Used to show the customer email on the page.

customer.email=john.doe@email.com

When enabled the page will display one pay button for all the payment methods

enableSinglePayButton=true

URL of merchant store logo which may be displayed on payment page.

Merchant store logo's width. By default value is 150px

layout.logoWidth=300

Merchant store logo's height. By default value is 100px

layout.logoWidth=200

URL of image which will be used as a background for payment page

The color of merchant name label's specified in hexadecimal format. By default value is #6b6b6b

#ffffff

The color of amount and price labels specified in hexadecimal format. By default value is #00000

#ffffff

The background color of Pay Now button. By default value is #5cb85c

#ffffff

The color of Pay Now button's text. By default value is #ffffff

#ffffff

The background image of the whole payment page.

https://image.com/my-image.jpg

The background color of the whole payment page specified according HTML/CSS standard.

#FF6666, red, etc.

The width occupied by the whole payment page specified according HTML/CSS standard.

80%, 800px, 80vw

The height occupied by the whole payment page specified according HTML/CSS standard.

80%, 800px, 80vh

The elements and their order which should be displayed on the left side of the payment page.
The presence of totalAmount and paymentMethods is mandatory either on left or right side.

logo, merchantName, totalAmount, cartItems, billing, paymentMethods, terms, cancelPayment, contactInfo, shipping

The elements and their order which should be displayed on the right side of the payment page.
The presence of totalAmount and paymentMethods is mandatory either on left or right side.

logo, merchantName, totalAmount, cartItems, billing, paymentMethods, terms, cancelPayment, contactInfo, shipping

Configure the following properties of the left side of the payment page: background-image, background-color, width, subelement-alignment. It is possible to specify the width of the elements (pixels or percents) and their alignment within the left container.

See sample file.

Configure the following properties of the right side of the payment page: background-image, background-color, width, subelement-alignment. It is possible to specify the width of the elements (pixels or percents) and their alignment within the right container.

See sample file.

Bellow the logo image a sub title can be added with configurable font style.

See sample file.

Configure the logo image properties like width, height, alt and src.

See sample file.

Configure the merchant name styling specified in the merchant.name parameter.

See sample file.

Configure the order ID styling specified in the merchantTransactionId parameter.

See sample file.

The total amount value can be prefixed with a text and it is possible to configure the styling of the text.

See sample file.

Change the styling of the total amount value.

See sample file.

A sub title can be added bellow total amount value and the styling of it can be configured.

See sample file.

Configure the styling of the cart items sent in the cart.items* parameters.

See sample file.

Configure a title for the payment widget and its styling.

See sample file.

Configure a sub title for the payment widget and its styling.

See sample file.

Configure the text and styling which prefix the payment methods listed in the payment methods widget. The paymentMethodList contains a list of payment methods each with its own text and styling. Each payment method is identified by a "key" which is predefined. The valid IDs of the payment methods can be found here.

See sample file.

Configure the text and its styling appearing on the pay button. The background color is also configurable for the pay button.

See sample file.

Configure the text and its styling appearing on the pay button. The background and the border is also configurable for the pay button.

See sample file.

Configure the styling of the text label for the terms and conditions checkbox.

See sample file.

The URL where the user is redirected after canceling the payment.

Any valid URL.

Display a link or a button for canceling the payment.

"type": "button" or "type": "link".

Configure the background color if the type is button.

#FF6666, red, etc.

Configure the alignemnt of the text if the type is link.

left, right or center.

Configure the text and styling for the cancel payment link/button.

See sample file.

Configure the text and styling for title of the contact information section.

See sample file.

Configure the text and styling for sub title of the contact information section.

See sample file.

Configure the label and text styling for the input field used for the customer's email address.

See sample file.

When this configuration option is present, the shipping address will be displayed on 1 line, so street name, house number, etc. will not be displayed on separate lines as it is done by default. This option also configures the label and text style for displaying the shipping address.

See sample file.

Define the address elements and their order for specifying the shipping address.

Possible values: houseNumber1, street1, postcode, city, country.

Configure the title for the shipping section and the styling of the text.

See sample file.

Configure the sub title for the shipping section and the styling of the text.

See sample file.

Configure the labels and text styling for shipping address elements. The available address items are: houseNumber1, street1, postcode, city, country.

See sample file.

When this configuration option is present, the shipping address will be displayed on 1 line, so street name, house number, etc. will not be displayed on separate lines as it is done by default. This option also configures the label and text style for displaying the shipping address. Note that 1 line formatting is not available if collectBilling parameter is present.

See sample file.

Define the address elements and their order for specifying the shipping address.

Possible values: houseNumber1, street1, street2, postcode, city, country.

Configure the title for the shipping section and the styling of the text.

See sample file.

Configure the sub title for the shipping section and the styling of the text.

See sample file.

Configure the labels and text styling for shipping address elements. The available address items are: houseNumber1, street1, street2, postcode, city, country.

See sample file.

Free-form text with which the sender identifies themselves to the recipient. Must not exceed 11 characters length.

from=MTS

The number to which the message is sent. Numbers are specified in E.164 format.

smsTo=14049236100