We have improved our eBoarding API experience including:
- Improved Validation for Document APIs
- Third-Party Document Signing
- New Product and Service Available in UK and Ireland
- New Government Owned Flag
- VAT Invoice Delivery Method Selection for Poland
- Marketing Opt-In/Out Selection for Poland
1. Improved Validation for Document APIs
Validation logic has been improved to help users identify errors when using document packet APIs, specifically for:
- Creating documents using createdocumentpacket (Managed Flow users),
- Appending documents using appendgroupdocumentpacket (Guided Flow users), or
- Updating documents using updatedocumentpacket (Guided Flow users).
2. Third-Party Document Signing
Third-party documents can now be dynamically generated and signed along with Elavon documents. Contact our eBoarding team for more details. To utilise third-party signing, partners must provide document templates in XHTML format and images in JPG or PNG format, as well as indicate where the images should be placed within their document templates.
Partners must also provide a document name and document cardinal number. The document cardinal number is a unique identifier used to distinguish and reference an individual partner document when using eBoarding API operations.
Refer to API Reference for examples of how to create and retrieve the third-party documents. A signed document packet can be generated after the document packet is signed and submitted for boarding.
3. New Product and Service Available in UK and Ireland
The following product and service are now available for boarding in UK and Ireland.
For the full list of available products and services across Europe, refer to Product, Value Added Service, and Fee Codes.
|
Product Code / SKU |
Name Value |
Associated Fee Code |
UK |
IE |
|---|---|---|---|---|
|
DBP50WE |
DATECS BP-50 White |
MM1 |
Yes |
Yes |
* Pilot of the new product DATECS BP-50 White (Opayo) will commence in the third quarter of 2022.
|
Product Code / SKU |
Name Value |
Associated Fee Code |
UK |
IE |
|---|---|---|---|---|
|
TALMO |
Talech Mobile |
T44 |
Yes |
Yes |
4. New Government Owned Flag
A new field Government Owned Entity >= 50% governmentOwnedEntity has been added as part of merchant application onboarding, to identify whether at least 50% of the business is government owned. If the condition is met, then the Country of Origin information will be sent to Mastercard to meet their Compliance requirements.
The new Boolean type field requires a value on all applications, and MUST be included in the application payload by 30th June 2022 in order to continue successful boarding.
Refer to /board, /creditcheck, and /createdocumentpacket payload examples in the API Reference for more detail.
5. VAT Invoice Delivery Method Selection for Poland
When creating new application in Poland via PAPI, partners can now set the preferred delivery method of VAT Invoice Statement vatInvoiceStatement as either “Dynamic Merchant Reporting” or “Hard Copy” according to their preference. The value is defaulted to “Hard Copy” if not provided on the request as it was before.
Refer to /board, /creditcheck, and /createdocumentpacket payload examples in the API Reference for more detail.
6. Marketing Opt-In/Out Selection for Poland
Poland has amended the regulation of the ePrivacy Directive, changed from the “Opt-Out” model to the “Opt-In” model. A proper “Opt-In” consent must now be obtained for direct marketing purposes.
When creating new application in Poland via PAPI, the value of direct marketing consent is now defaulted to “Opt-Out” if not provided on the request. If partners would like to board merchants who opt-in the direct marketing, they will need to set the "optOut":false in the payload request.