documentation
Search…
COPYandPAY API
COPYandPAY API enables you to further customize your checkout workflows. Here you can find the reference for the wpwlOptions and you can see these in action on our workflow examples page.
Parameter
Description
Examples
locale
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. When using "ar", for example, set numberFormatting:false
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.
style
Sets the style of the payment forms. You can choose from "card", and "plain" style. Default is "card"
style: "card"
autofocus
Sets focus to the selected input/select element on the payment page upon loading
autofocus : 'card.holder'
onReady
Triggers when all payment forms are ready
onReady: function() {/* function here */};
requireCvv
Determines whether the CVV field is presented on the payment form.
requireCvv: false
allowEmptyCvv
Determines whether the CVV field can be empty. By default it is false
allowEmptyCvv: true
useSummaryPage
If set to true, the payment is not completed, instead the form will initiate a callback to the onSaveTransactionData function, which can initiate a redirection to a summary page. This summary page can then be used to summarise the checkout before asking the user to confirm. An example can be seen on our advanced options page.
useSummaryPage: true
onSaveTransactionData
Triggered after the shopper presses Continue on the CnP form, when useSummaryPage flag is set to true. Parameter "data" is the serialized data of the payment form.
onSaveTransactionData: function(data){console.log(data);}
threeDIframeSize
Sets size of the 3D secure iframe. This iframe will only be used in case a shopper has to enter 3D secure credentials on the bank's page.
'threeDIframeSize':{'width':'100%', 'height':'580px'}
paymentTarget
We submit the form to this target. In case of additional shopper interaction, e.g. 3DSecure, we redirect the shopper within this target. This only works for card payment brands.
paymentTarget: 'my3dIframe'
shopperResultTarget
Works only in combination with "paymentTarget" option. By default, we redirect the shopper to the given "shopperResultUrl" using a self-submitting form with target="_top". If you use COPYandPAY in an iframe and want to redirect the shopper within this iframe, then the "shopperResultTarget" and the "paymentTarget" should be the name of this iframe.
paymentTarget: 'myCustomIframe', shopperResultTarget: 'myCustomIframe'
showTaxNumberField
If set to true the CPF field on the COPYandPAY form will be displayed. The CPF field is needed for payments processed in Brazil.
showTaxNumberField: true
showCVVHint
If set to true then the credit card form will display a hint on where the CVV is located when the mouse is hovering over the CVV field.
showCVVHint: true
brandDetection
If the COPYandPAY form contains more than one credit card brand (e.g. MASTER VISA AMEX) and this option is set to true(default is false) then COPYandPAY updates the brand field automatically based on the first four digits entered in the credit card number field.
brandDetection: true
displayBic
If the COPYandPAY form contains DIRECTDEBIT_SEPA brand and this option is set to true(default is false) then COPYandPAY will display the BIC field.
displayBic: true
forceCardHolderEqualsBillingName
By default the card.holder is displayed as one field in COPYandPAY's form. If this option is set to true then the form displays a field for the given name and a separate field for the surname. The values entered here will be submitted both as card.holder and as customer.givenName and customer.surname.
forceCardHolderEqualsBillingName: true
billingAddress
Option to display the billing address fields.
billingAddress: { country: "US", state: "NY", city: "New York", postcode: "12345", street1: "Suite 1234", street2: "Some Road" }
mandatoryBillingFields
Describe which billing fields cannot be empty. This option needs to be used with billingAddress option.
mandatoryBillingFields:{ country: true, state: true, city: true, postcode: true, street1: true, street2: false }
validation
Use validation. If false disables validation and the functions validate* and on*Submit* will not be called.
validation: true

Labels

Key
Value
accountBank
Bank code
accountBankBic
BIC or bank code
accountBic
BIC
accountHolder
Account holder
accountId
Id
accountNumber
Account number
accountNumberIban
IBAN or account number
accountIban
IBAN
bankName
Name of bank
brand
Brand
cancel
Back
cardHolder
Card holder
cardNumber
Card Number
cvv
CVV
cvvHint
The 3 digits on the back of your card
cvvHintAmex
The 4 digits on the front of your card
cvvHintMaestro
The 3 digits on the back of your card if specified
country
Country
expiryDate
Expiry Date

Error Messages

Key
Value
accountBankError
Invalid bank code
accountBankBicError
Invalid BIC or bank code
accountBicError
Invalid BIC
accountHolderError
Invalid account holder
accountNumberError
Invalid account number
accountNumberIbanError
Invalid IBAN or account number
accountIbanError
Invalid IBAN
cardHolderError
Invalid card holder
surNameError
Invalid surname
givenNameError
Invalid given name
cardNumberError
Invalid card number or brand
cvvError
Invalid CVV
expiryMonthError
Invalid expiry date
expiryYearError
Invalid expiry date
taxNumberError
Invalid Tax Identification Number
generalTermsAndConditionsError
Please accept the consent for data transmission
billingCountryError
Invalid country
billingStateError
Invalid state
billingCityError
Invalid city
Copy link