POST Get Payment Link Details
The GET Payment Link Details method allows you to get the details of a specific payment link by providing its unique identifier.
The GET Payment Link Details method allows you to get the details of a specific payment link by providing its unique identifier.
API Versioning:
- Version 2.1: allows the merchant to specify a single payment reference ID.
- Version 2.2: allows the merchant to specify multiple payment reference IDs.
| API Endpoint |
| https://api.uat.anddone.com/secure/paymentlinks/details |
| API Data | Details |
| URI | secure/paymentlinks/details |
| Method | GET |
| 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) |
| 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": "y8ylmjx5",
"merchantId": "L68KYxv1",
"title": "PL-5386753092135",
"paymentLink": "https://link.dev.anddone.com/#/B8B2GQ8g",
"shortLink": "https://link.dev.anddone.com/#/B8B2GQ8g",
"amount": 125.75,
"paymentDescription": "Commercial property insurance premium installment.",
"expireIn": 7,
"expireInUnit": "Days",
"expireOn": "04-25-2023 13:44:47",
"applyPaymentAdjustments": null,
"enablePartialPayment": false,
"enableMultiplePayment": false,
"customers": [],
"lineItems": [],
"payments": [],
"noOfPaymentMade": 0,
"totalPaidAmount": 0,
"enableProtection": false,
"protectionMode": null,
"displayReceipt": null,
"linkStatus": "Enabled",
"invoiceNumber": null,
"createdOn": "04-18-2023 13:44:47",
"createdBy": "DocTest",
"modifiedOn": "04-18-2023 13:44:47",
"modifiedBy": "DocTest",
"shortDescription": null,
"responseType": "CallBack",
"callbackParameters": {
"callbackSuccessUrl": null,
"callbackFailureUrl": null,
"accessKey": null,
"secretKey": null,
"referenceNo": null,
"referenceType": null,
"transactionId": null,
"callbackApiUrl": "",
"callbackMessage": ""
},
"settings": {
"selectedCustomerFields": "First Name,Last Name,Email,Phone Number",
"additionalDetailsPreference": "AskShopper",
"displaySummary": false,
"acceptCustomerInfo": false,
"removeHeader": false,
"acceptCard": false,
"acceptBankAccount": false,
"saveCustomer": false,
"saveCustomerAccount": false,
"intent": {
"paymentTypes": [
"ACH",
"CreditCard",
"DebitCard"
]
}
},
"splits": null,
"saveForFuture": null,
"quoteKey": null,
"accountNumber": null,
"referenceType": "AccountNumber",
"referenceNumber": "CP4222188420230",
"referenceKey": "",
"enablePremiumFinance": 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)
{
"suppressTechnologyFee": false,
"id": "ZdmBAYWv",
"merchantId": "nZ8gAqvo",
"title": "PL-20242803094153",
"paymentLink": "https://link.uat.anddone.com/#/ZdmBAYWv",
"shortLink": "https://link.uat.anddone.com/#/ZdmBAYWv",
"amount": 228.0,
"paymentDescription": "Commercial insurance premium down payment",
"expireIn": 7,
"expireInUnit": "Days",
"expireOn": "04-04-2024 09:43:04",
"applyPaymentAdjustments": null,
"enablePartialPayment": false,
"enableMultiplePayment": false,
"customers": [],
"lineItems": [],
"payments": [],
"noOfPaymentMade": 0,
"totalPaidAmount": 0.0,
"enableProtection": false,
"protectionMode": null,
"displayReceipt": null,
"linkStatus": "Enabled",
"invoiceNumber": null,
"createdOn": "03-28-2024 09:43:04",
"createdBy": "SnehalRefund",
"modifiedOn": "03-28-2024 09:43:04",
"modifiedBy": "SnehalRefund",
"shortDescription": null,
"responseType": "CallBack",
"callbackParameters": {
"callbackSuccessUrl": null,
"callbackFailureUrl": null,
"accessKey": null,
"secretKey": null,
"referenceNo": null,
"referenceType": null,
"transactionId": null,
"callbackApiUrl": "",
"callbackMessage": "",
"redirectionTime": null
},
"displaySettings": {
"selectedCustomerFields": "First Name,Last Name,Email,Phone",
"additionalDetailsPreference": "AskShopper",
"displaySummary": false,
"acceptCustomerInfo": false,
"removeHeader": false,
"acceptCard": false,
"acceptBankAccount": false,
"saveCustomer": false,
"saveCustomerAccount": false,
"intent": {
"paymentTypes": [
"ACH",
"CreditCard",
"DebitCard"
]
}
},
"splits": [],
"saveForFuture": null,
"quoteKey": null,
"accountNumber": null,
"referenceType": "None",
"referenceNumber": null,
"referenceKey": null,
"referenceDataList": [
{
"referenceType": "AccountNumber",
"referenceNumber": "8654328808",
"referenceKey": ""
}
],
"enablePremiumFinance": false
}