POST Get Payment Link Details
The GET Payment Link Details method allows you to retrieve detailed information of a specific payment link by providing its unique identifier.
Versions: The POST Get Payment Link Details method is supported identically in AndDone API versions 2.1, 2.2 and 2.3.
| API Endpoint |
| https://api.uat.anddone.com/secure/paymentlinks/details |
| API Data | Details |
| URI | secure/paymentlinks/details |
| 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.1
Request Parameters (v2.1)
| Field Name | Data Type | Mandatory | Field Length | Description |
| paymentLinkId | string | true | N/A | The unique payment link ID. |
Body Request Example (JSON)
{
"paymentLinkId": "y8ylmjx5"
}
Response Parameters (v2.1)
Body Response Example (JSON)
{
"id": "O78jve8k",
"merchantId": "GBaPo83P",
"title": "FirstPayment",
"paymentLink": "https://link.anddone.com/#/QjxbLdDJ",
"shortLink": "https://link.anddone.com/#/QjxbLdDJ",
"amount": 20,
"paymentDescription": "FirstPayment",
"expireIn": 9,
"expireInUnit": "Days",
"expireOn": "07-17-2021 13:35:00",
"callbackParameters": {
"callbackSuccessUrl": "htttp://example.com",
"callbackFailureUrl": "htttp://example.com",
"accessKey": null,
"secretKey": null,
"referenceNo": null,
"referenceType": null,
"transactionId": null,
"callbackApiUrl": "htttp://example.com",
"callbackMessage": "this is test message",
"redirectionTime": 60
},
"customers": [
{
"firstName": "ExampleFirstName",
"lastName": "ExampleLastName",
"email": "[email protected]",
"phone": "1234567890",
"notifyViaSMS": false,
"notifyViaEmail": true,
"createdOn": "07-08-2021 06:57:47",
"accounts": null,
"address": {
"addressLine1": "7438 Airport Drive",
"addressLine2": "Suite 200",
"city": "Collegeville",
"state": "PA",
"country": 1,
"postalCode": "19426",
"timeZone": null
}
}
],
"lineItems": [],
"payments": [],
"noOfPaymentMade": 0,
"totalPaidAmount": 0,
"linkStatus": "Created",
"invoiceNumber": null,
"createdOn": "07-08-2021 06:57:47",
"createdBy": "REMerchant",
"modifiedOn": "07-08-2021 06:57:47",
"modifiedBy": "REMerchant",
"shortDescription": "FirstPayment",
"responseType": "OnScreen",
"displaySettings": {
"selectedCustomerFields": null,
"additionalDetailsPreference": "ManualEnter",
"displaySummary": true,
"acceptCustomerInfo": true,
"removeHeader": false,
"acceptCard": true,
"acceptBankAccount": false,
"saveCustomer": true,
"saveCustomerAccount": true,
"intent": {
"paymentTypes": [
"ACH",
"CreditCard",
"DebitCard"
]
}
},
"splits": [],
"saveForFuture": null,
"quoteKey": null,
"accountNumber": "3451",
"referenceType": "QuoteId",
"referenceNumber": null,
"referenceKey": null,
"referenceDataList": [
{
"referenceType": "PolicyNumber",
"referenceNumber": "pol123",
"referenceKey": "nul"
}
],
"enablePremiumFinance": false,
"isPremiumFinancier": false,
"pfr": {
"entity": "IPFS",
"reference": "Reference_test",
"quote": "Q_1212",
"accountNumber": "123456789",
"paymentType": "OtherPayment"
},
"paymentLinkType": "PaymentLink",
"suppressTechnologyFee": false,
"overrideTechnologyFee": 23.78,
"isPFLite": false,
"isPayInFull": false
}
API Version 2.2
Request Parameters (v2.2)
| Field Name | Data Type | Mandatory | Field Length | Description |
| paymentLinkId | string | true | N/A | The unique payment link ID. |
Body Request Example (JSON)
{
"paymentLinkId": "y8ylmjx5"
}
Response Parameters (v2.2)
Body Response Example (JSON)
{
"id": "O78jve8k",
"merchantId": "GBaPo83P",
"title": "FirstPayment",
"paymentLink": "https://link.anddone.com/#/QjxbLdDJ",
"shortLink": "https://link.anddone.com/#/QjxbLdDJ",
"amount": 20,
"paymentDescription": "FirstPayment",
"expireIn": 9,
"expireInUnit": "Days",
"expireOn": "07-17-2021 13:35:00",
"callbackParameters": {
"callbackSuccessUrl": "htttp://example.com",
"callbackFailureUrl": "htttp://example.com",
"accessKey": null,
"secretKey": null,
"referenceNo": null,
"referenceType": null,
"transactionId": null,
"callbackApiUrl": "htttp://example.com",
"callbackMessage": "this is test message",
"redirectionTime": 60
},
"customers": [
{
"firstName": "ExampleFirstName",
"lastName": "ExampleLastName",
"email": "[email protected]",
"phone": "1234567890",
"notifyViaSMS": false,
"notifyViaEmail": true,
"createdOn": "07-08-2021 06:57:47",
"accounts": null,
"address": {
"addressLine1": "7438 Airport Drive",
"addressLine2": "Suite 200",
"city": "Collegeville",
"state": "PA",
"country": 1,
"postalCode": "19426",
"timeZone": null
}
}
],
"lineItems": [],
"payments": [],
"noOfPaymentMade": 0,
"totalPaidAmount": 0,
"linkStatus": "Created",
"invoiceNumber": null,
"createdOn": "07-08-2021 06:57:47",
"createdBy": "REMerchant",
"modifiedOn": "07-08-2021 06:57:47",
"modifiedBy": "REMerchant",
"shortDescription": "FirstPayment",
"responseType": "OnScreen",
"displaySettings": {
"selectedCustomerFields": null,
"additionalDetailsPreference": "ManualEnter",
"displaySummary": true,
"acceptCustomerInfo": true,
"removeHeader": false,
"acceptCard": true,
"acceptBankAccount": false,
"saveCustomer": true,
"saveCustomerAccount": true,
"intent": {
"paymentTypes": [
"ACH",
"CreditCard",
"DebitCard"
]
}
},
"splits": [],
"saveForFuture": null,
"quoteKey": null,
"accountNumber": "3451",
"referenceType": "QuoteId",
"referenceNumber": null,
"referenceKey": null,
"referenceDataList": [
{
"referenceType": "PolicyNumber",
"referenceNumber": "pol123",
"referenceKey": "nul"
}
],
"enablePremiumFinance": false,
"isPremiumFinancier": false,
"pfr": {
"entity": "IPFS",
"reference": "Reference_test",
"quote": "Q_1212",
"accountNumber": "123456789",
"paymentType": "OtherPayment"
},
"paymentLinkType": "PaymentLink",
"suppressTechnologyFee": false,
"overrideTechnologyFee": 23.78,
"isPFLite": false,
"isPayInFull": false
}
API Version 2.3
Request Parameters (v2.3)
| Field Name | Data Type | Mandatory | Field Length | Description |
| paymentLinkId | string | true | N/A | The unique payment link ID. |
Body Request Example (JSON)
{
"paymentLinkId": "y8ylmjx5"
}Response Parameters (v2.3)
Body Response Example (JSON)
{
"id": "O78jve8k",
"merchantId": "GBaPo83P",
"title": "FirstPayment",
"paymentLink": "https://link.anddone.com/#/QjxbLdDJ",
"shortLink": "https://link.anddone.com/#/QjxbLdDJ",
"amount": 20,
"paymentDescription": "FirstPayment",
"expireIn": 9,
"expireInUnit": "Days",
"expireOn": "07-17-2021 13:35:00",
"callbackParameters": {
"callbackSuccessUrl": "htttp://example.com",
"callbackFailureUrl": "htttp://example.com",
"accessKey": null,
"secretKey": null,
"referenceNo": null,
"referenceType": null,
"transactionId": null,
"callbackApiUrl": "htttp://example.com",
"callbackMessage": "this is test message",
"redirectionTime": 60
},
"customers": [
{
"firstName": "ExampleFirstName",
"lastName": "ExampleLastName",
"email": "[email protected]",
"phone": "1234567890",
"notifyViaSMS": false,
"notifyViaEmail": true,
"createdOn": "07-08-2021 06:57:47",
"accounts": null,
"address": {
"addressLine1": "7438 Airport Drive",
"addressLine2": "Suite 200",
"city": "Collegeville",
"state": "PA",
"country": 1,
"postalCode": "19426",
"timeZone": null
}
}
],
"lineItems": [],
"payments": [],
"noOfPaymentMade": 0,
"totalPaidAmount": 0,
"linkStatus": "Created",
"invoiceNumber": null,
"createdOn": "07-08-2021 06:57:47",
"createdBy": "REMerchant",
"modifiedOn": "07-08-2021 06:57:47",
"modifiedBy": "REMerchant",
"shortDescription": "FirstPayment",
"responseType": "OnScreen",
"displaySettings": {
"selectedCustomerFields": null,
"additionalDetailsPreference": "ManualEnter",
"displaySummary": true,
"acceptCustomerInfo": true,
"removeHeader": false,
"acceptCard": true,
"acceptBankAccount": false,
"saveCustomer": true,
"saveCustomerAccount": true,
"intent": {
"paymentTypes": [
"ACH",
"CreditCard",
"DebitCard"
]
}
},
"splits": [],
"saveForFuture": null,
"quoteKey": null,
"accountNumber": "3451",
"referenceType": "QuoteId",
"referenceNumber": null,
"referenceKey": null,
"referenceDataList": [
{
"referenceType": "PolicyNumber",
"referenceNumber": "pol123",
"referenceKey": "nul"
}
],
"enablePremiumFinance": false,
"isPremiumFinancier": false,
"pfr": {
"entity": "IPFS",
"reference": "Reference_test",
"quote": "Q_1212",
"accountNumber": "123456789",
"paymentType": "OtherPayment"
},
"paymentLinkType": "PaymentLink",
"suppressTechnologyFee": false,
"overrideTechnologyFee": 23.78,
"isPFLite": false,
"isPayInFull": false
}