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://checkoutgate.docs.oppwa.com/

Merchant privacy policy URL. Value must be a valid URL

privacyPolicyUrl=https://checkoutgate.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

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

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