With Guided and Managed Flows, it is now possible to use Elavon signing capabilities to have your merchant sign your partner documentation at the same time the Elavon documents are being signed.
To utilise third-party signing, partners must provide document templates in XHTML format and any desired images in JPG or PNG format, as well as indicate where the images should be placed within the document template.
Third party documents are assigned a document name and cardinal number that are used to identify and retrieve specific documents.
Below are examples of how to create and retrieve third-party documents.
In /createdocumentpacket example, two third-party documents are included in XHTML format using two cardinal numbers 1122 and 1213, which are part of partnerDocumentData object. Each cardinal number represents a specific third-party document template. partnerCustomFieldName1, partnerCustomFieldName2, partnerCustomFieldName3 and partnerCustomFieldName4 are the sample fields for third-party documents, while sampleValue1, sampleValue2, sampleValue3 and sampleValue4 are the corresponding sample values.
A signed document packet can be generated after the document packet is signed and submitted for boarding.
/createdocumentpacket request example:
"partnerDocumentData": { "1122": { "partnerCustomFieldName1": "sampleValue1", "partnerCustomFieldName2": "sampleValue2" }, "1213": { "partnerCustomFieldName3": "sampleValue3", "partnerCustomFieldName4": "sampleValue4" } },
/createdocumentpacket response example:
{ "responseId": 0, "error": null, "documentPacketId": "0bf18d64-b725-4b3b-80ef-10387cfeaea0", "signerResponses": [ { "signerId": "1DAM20220321115", "signerUrl": "Sample signerUrl" } ] }
/getsignedpacket request example:
{ "documentPacketId": "0bf18d64-b725-4b3b-80ef-10387cfeaea0" }
/getsignedpacket response example:
{ "responseId": 0, "error": null, "documents": { "APPLICATION": "base-64 encoded string", "PARTNER_DOCUMENTS": { "1122": "base-64 encoded string", "1213": "base-64 encoded string" }, "TERMINAL_HIRE_AGREEMENT": "base-64 encoded string" } }
❮ Back to BoardingNext: Push Notifications ❯