POST Generate Premium Finance Payment Link
The POST Generate Payment Link method creates a payment link for a premium finance quote using the quoteKey from the POST Generate Premium Finance Lite Quote method. It returns a URL that customers can use to make their initial down payment.
API Versioning:
- Version 2.2: Allows the merchant to set the `isPayInFull` parameter and uses default values for all other payment link settings.
- Version 2.3: Supports the full set of payment link parameters, allowing for greater customization.
| API Endpoint |
| https://api.uat.anddone.com/secure/epflite/quotes/paymentlinks |
| API Data | Details |
| URI | secure/epflite/quotes/paymentlinks |
| Method | POST |
| Authorization | API Key Authorization |
| Authorization | |
| x-api-key | API key {env_merchantAccessKey} |
| Request Headers | |
| x-app-key | Merchant ID or App Key {env_merchantId} |
| x-version | API version (e.g., 2.1). If no version is specified, the call will default to version 2.0 of the API. |
| Origin | URL or IP address provided to AndDone as an allowed origin. |
| Content-Type | application/json |
API Version 2.2
Request Parameters
| Field Name | Data Type | Mandatory | Field Length | Description |
Body Request Example (JSON)
Response Parameters
Body Response Example (JSON)
API Version 2.3
Request Parameters
| Field Name | Data Type | Mandatory | Field Length | Description |
| quoteKey | String | true | NA | The unique key identifier for the premium finance quote. |
| isPayInFull | Boolean | true | NA | If this parameter is set to 'true', the customer will have the option of paying the premium amount in full. |
| title | String | true | NA | The unique ID (Merchant Reference) assigned to the payment by the merchant. If this value is not unique, the payment link will not be generated. |
| paymentDescription | String | true | NA | This is the purpose of the payment. (Purpose of Payment in the merchant portal UI) |
| expireIn | Number | true | NA | Indicates the period of time that the payment link is valid for. Based on expireInUnit. The default value is 0. |
| expireInUnit | Number | true | NA | The units used to define the expiration period (expireIn) for the payment. Values are: 0 - seconds, 1 - minutes, 2 - hours, 3 - days, 4 - weeks. The default value is 0. |
| referenceDataList | Array | true | NA | This array contains the reference identifiers associated with the payment link. ReferenceType, ReferenceKey, and ReferenceNumber are nested parameters under this array. |
| - referenceType | Number | true | NA | Indicates the type of reference ID (referenceNumber) associated with the payment. Accepted values are: 1 - QuoteId, 2 - AccountNumber, 3 - PolicyNumber, 4 - InvoiceNumber, 5 - Other. |
| - referenceKey | String | false | NA | If referenceType is set to 5 (Other), the referenceKey parameter is used to provide a descriptive tag for the reference number. |
| - referenceNumber | String | true | NA | The payment reference ID number or string. |
| callbackParameters | Object | false | NA | This object contains the callback parameters for responseType option 1. |
| - callbackApiUrl | String | false | NA | If responseType is set to 1, this parameter can be used to specify the URL that the customer is redirected to after payment confirmation. |
| - callBackMessage | String | false | NA | If responseType is set to 1, this parameter can be used to specify a custom message that is displayed to the customer in the payment confirmation page. |
| - redirectionTime | Number | false | NA | This parameter allows you to set a delay in seconds before the customer is redirected to the callbackApiUrl after payment confirmation. The default delay is 10 seconds. |
| customers | Object | false | NA | If additionalDetailsPreference is set to 2 or 4 (Merchant enters details), this object contains the customer information that is displayed in the payment form. |
| - firstName | String | false | NA | Customer's first name. |
| - lastName | String | false | NA | Customer's last name. |
| String | false | NA | Customer's contact Email address. | |
| - phone | String | false | NA | Customer's contact phone number. |
| - notifyViaSMS | String | false | NA | If set to 'true' the customer will receive payment link notifications via SMS. |
| - notifyViaEmail | String | false | NA | If set to 'true' the customer will receive payment link notifications via Email. |
| settings | Object | false | NA | |
| - additionalDetailsPreference | Number | true | NA | Sets the option for the customer details to be displayed or collected in the payment link form. Accepted values are 1 - AskShopper. The customer enters details. 2 - ManualEnter - The merchant enters the details, and the customer can edit the details in the payment form. 3 - NoDetails, 4 - ManualEnterEditNotAllowed - The merchant enters the details, and the details cannot be edited in the payment form. |
| - selectedCustomerFields | String | false | NA | If additionalDetailsPreference is set to 1 (Customer enters details) this parameter indicates the information required from the shopper: Accepted values are: First Name, Last Name, Email, Phone Number. |
| - intent | Object | NA | NA | This object defines the accepted payment methods for the transaction. |
| - paymentTypes | Array[string] | true | NA | The accepted payment types for the transaction. Accepted values are: CreditCard, DebitCard, and ACH. |
Body Request Example (JSON)
{
"quoteKey": "86753127",
"isPayInFull": false,
"title": "PL-8675302112",
"paymentDescription": "Insurance Sales, Underwriting, and Premiums",
"expireIn": "30",
"expireInUnit": "Days",
"settings": {
"additionalDetailsPreference": 2,
// AskShopper = 1,
// ManualEnter = 2,
// NoAdditionalDetails = 3,
// ManualEnterEditNotAllowed = 4,
// IncludeInsuredFromQuote = 11 // NEW
"selectedCustomerFields": "First Name,Last Name,Email,Phone",
"intent": {
"PaymentTypes": [
"ACH",
"CreditCard",
"DebitCard"
]
}
},
"customers": [
{
"firstName": "Snehal",
"lastName": "Waikar",
"email": "[email protected]",
"phone": "9876598743",
"address": {
"addressLine1": "STREET NUMBER",
"addressLine2": "SUITE/UNIT",
"city": "City",
"state": "Kansas",
"country": 1,
"postalCode": "12345"
}
}
],
"callbackParameters": {
"callbackApiUrl": "",
"callbackMessage": "",
"redirectionTime": ""
},
"referenceDataList": [
{
"referenceType": "1",
"referenceKey": "",
"referenceNumber": "{{quoteKey}}"
},
{
"referenceType": "2",
"referenceKey": "",
"referenceNumber": "AccountNumber"
},
{
"referenceType": "3",
"referenceKey": "",
"referenceNumber": "PolicyNumber"
},
{
"referenceType": "4",
"referenceKey": "",
"referenceNumber": "InvoiceNumber"
},
{
"referenceType": "5",
"referenceKey": "",
"referenceNumber": "Other"
}
]
}Response
{
"id": "Dv4E5aqx",
"merchantId": "4bvl9KxM",
"title": "PL-8675302112",
"paymentLink": "https://link.uat.anddone.com/#/Dv4E5aqx",
"shortLink": "https://link.uat.anddone.com/#/Dv4E5aqx",
"amount": 2878.00,
"paymentDescription": "26065007",
"expireIn": 10,
"expireInUnit": "Weeks",
"expireOn": "06-25-2024 15:15:04",
"applyPaymentAdjustments": null,
"enablePartialPayment": false,
"enableMultiplePayment": false,
"noOfPaymentMade": 0,
"totalPaidAmount": 0.0,
"enableProtection": false,
"protectionMode": null,
"displayReceipt": null,
"linkStatus": "Enabled",
"invoiceNumber": null,
"createdOn": "04-16-2024 15:15:04",
"createdBy": "JoeUser",
"modifiedOn": "04-16-2024 15:15:04",
"modifiedBy": "JoeUser",
"shortDescription": null,
"responseType": "OnScreen",
"callbackParameters": null,
"displaySettings": {
"selectedCustomerFields": null,
"additionalDetailsPreference": "NoAdditionalDetails",
"displaySummary": false,
"acceptCustomerInfo": false,
"removeHeader": false,
"acceptCard": false,
"acceptBankAccount": false,
"saveCustomer": false,
"saveCustomerAccount": false,
"intent": {
"paymentTypes": [
"ACH",
"CreditCard",
"DebitCard"
]
}
},
"splits": null,
"saveForFuture": null,
"quoteKey": "86753127",
"accountNumber": null,
"referenceType": "None",
"referenceNumber": null,
"referenceKey": null,
"referenceDataList": [
{
"referenceType": "QuoteId",
"referenceNumber": "26065007",
"referenceKey": null
},
{
"referenceType": "AccountNumber",
"referenceNumber": "86753023413",
"referenceKey": null
}
],
"enablePremiumFinance": true,
"suppressTechnologyFee": false
}