Looking Up PayLinks
Learn how you can look up a previously created PayLink
Overview
You may want to look up a PayLink for a number of reasons, like reviewing the details so you can modify it, or just to confirm its status.
API Request
This endpoint uses HMAC
Check out our API Authentication to learn more
This endpoint references the paylinkId of the PayLink, which was provided in the response body when you created the PayLink.
To look up a PayLink, send an API call to:
Staging:GET https://stage-paylinks.skipify.com/{paylinkId}
Production:GET https://paylinks.skipify.com/{paylinkId}
API Response
Response Body Parameters
The response body will include all of the elements that you passed to us when you created the Payment Request. It will also include the following:
| Name | Type | Description |
|---|---|---|
| status | enum | Denotes what status the PayLink is in Created means the request to generate a PayLink was successful. No other action by the customer or Skipify has been taken. Opened is a PayLink that was opened by the customer. A link could remain in this status if the customer doesn’t complete the checkout. Sent is a PayLink that was sent via Skipify delivery mechanisms. If both email & SMS are used to deliver a link, this status will reflect either success. The delivery log in the response will indicate which, if any, delivery method failed. Paid is a PayLink that has been successfully paid using Skipify PayLink. Expired is a PayLink that has passed the datetime specified by you in the expiration field of the original PayLink |
| orderId | string, nullable | ID of the associated order in the Skipify system |
| paylinkId | string | Skipify’s unique identifier for the PayLink. This ID will be needed to use the other endpoints. |
| link | String (url) | The URL for this PayLink |
| Delivery Logs | object | { "deliveryLogId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "paylinkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deliveryMethod": "EMAIL", "status": "DELIVERED", "messageId": "string", "createdAt": "2023-08-10T21:38:00.802Z", "updatedAt": "2023-08-10T22:38:05.802Z" } |
| events | List of objects | Example: [{ "eventId": "7814717b-56d0-4885-8da7-3033b1160265", "paylinkId": "590eabc3-80fa-4f31-8380-0203265potr9d7", "eventType": "CREATED", "oldValue": null, "newValue": null, "createdBy": "API Key", "createdAt": "2024-03-28T16:16:42.030Z" }] |
Response Body Example
{
"paylinkId": "string",
"link": "https://checkout.skipify.com/paylink/process/590eabc3-80fa-5gtyu-8380-0sdsdsw4d7",
"shortLink": "https://checkout.skipify.com/TirWjlK",
"merchantInvoiceId": "20231218153805",
"currencyCode": "USD",
"merchantId": "1bdf450-5dd4-5644-88e1-c9e5b5770f1a0",
"metadata": {
"key": "value"
},
"description": "Services on December 15",
"memo": "Thank you for your business",
"tax": 430,
"shipping": null,
"orderId": null,
"expiration": "2024-02-18T00:38:00.000Z",
"sendSms": false,
"sendEmail": true,
"createdAt": "2023-12-18T22:38:41.093Z",
"updatedAt": "2023-12-18T22:38:47.110Z",
"customerConsent": true,
"total": 17362,
"orderTotal": null,
"lineItems": [
{
"paylinkItemId": "c6044c53-65p9-4dcb-99f2-53ee16ead086",
"sku": "12345678911ABC",
"paylinkId": "590eabc3-80fa-4f31-8380-0201d82229d7",
"price": 12333,
"quantity": 1,
"tax": null,
"description": "Chest X-Ray",
"category": "Service",
"metadata": null,
"createdAt": "2023-12-18T22:38:41.093Z",
"updatedAt": null
},
{
"paylinkItemId": "ab5ec3a2-3x45-4336-8078-fc95aatf21e5",
"sku": "987654321ZYX",
"paylinkId": "590eabc3-80fa-4f31-8380-0216569uytre7",
"price": 4599,
"quantity": 1,
"tax": null,
"description": "Supplies",
"category": "Materials",
"metadata": null,
"createdAt": "2023-12-18T22:38:41.093Z",
"updatedAt": null
}
],
"deliveryLogs": [],
"openOrders": [
{
"paylinkId": "590eabc3-80fa-4f31-8380-0203265potr9d7",
"orderId": "6580c9f7546ed4458e352f27",
"createdAt": "2023-12-18T22:38:47.112Z"
}
],
"events": [
{
"eventId": "7814717b-56d0-4885-8da7-3033b1160265",
"paylinkId": "590eabc3-80fa-4f31-8380-0203265potr9d7",
"eventType": "CREATED",
"oldValue": null,
"newValue": null,
"createdBy": "API Key",
"createdAt": "2024-03-28T16:16:42.030Z"
},
{
"eventId": "37d26a1d-d51f-4959-9398-2b00803dcd16",
"paylinkId": "590eabc3-80fa-4f31-8380-0203265potr9d7",
"eventType": "SENT",
"oldValue": {
"status": "CREATED"
},
"newValue": {
"status": "SENT",
"deliveredTo": [
"SMS",
"EMAIL"
]
},
"createdBy": "[email protected]",
"createdAt": "2024-03-28T16:16:50.744Z"
},
{
"eventId": "239ba7d0-f374-4e66-8700-c238c056bd71",
"paylinkId": "590eabc3-80fa-4f31-8380-0203265potr9d7",
"eventType": "OPENED",
"oldValue": {
"status": "SENT",
},
"newValue": {
"status": "OPENED",
},
"createdAt": "2024-03-28T16:16:50.744Z"
}
],
"status": "OPENED",
"subTotal": 16932,
"customer": {
"accountName": null,
"email": "[email protected]",
"phone": null,
"firstName": "First",
"lastName": "Last"
},
"attachments": []
}
Updated 19 days ago