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 |
|---|---|---|
| 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 |
| shortLink | string(url) | The short link URL for this Paylink |
| merchantInvoiceId | string | A unique identifier that you send with the request is returned in the response. This identifier will not be visible to the customer. It can be used for your reference to link a Skipify order to a record in your systems. Max 255 char. |
| currencyCode | string | The currency used to create the Paylink. Only USD supported currently. |
| merchantId | string | The merchantId that this Paylink was created for |
| metadata | object | If sent in the request, will be returned in the response |
| description | string | The description sent with the Paylink create request. This will be displayed to the customer. |
| memo | string | The memo sent with the Paylink create request. This will be displayed to the customer. |
| tax | integer | If tax was included in the Paylink create request, will be returned in the response |
| shipping | integer | If shipping was included in the Paylink create request, will be returned in the response |
| orderId | string | will be Null unless Paylink status = Paid, Partially_Paid, Refunded, or Partially_Refunded |
| expiration | dateTime, string | The expiration date/time of the Paylink if it was set in the Request. Ex: 2024-06-02T21:48:02Z |
| sendSms | boolean | The boolean flag set on the request |
| sendEmail | boolean | The boolean flag set on the request |
| createdAt | dateTime, string | The date/time the Paylink was created, in UTC |
| updatedAt | dateTime, string | The date/time the Paylink was most recently updated, in UTC |
| customerConsent | boolean | The boolean flag set in the request, must be true to send |
| total | integer | Total amount of lineItems, shipping, tax |
| orderTotal | integer | The total plus any fees applied during payment |
| approvedAmount | integer | The amount that was approved for during payment |
| lastSentAt | dateTime, string | The last time the Paylink was sent to the customer |
| lineItems | array | An array of Line Items sent when the Paylink was created |
| 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 (clicked on) 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. Cancelled means the Paylink has been cancelled via the Invalidate Paylinks endpoints. Partially_Paid is a Paylink that has been partially paid using Skipify Paylink. You may send a new PayLink to secure the remaining amount. Paid is a Paylink that has been successfully paid using Skipify Paylink. Refunded is a Paylink that has refunded the entire amount that the customer paid during checkout. Partially_Refunded is a Paylink that has refunded a partial amount that the customer paid during checkout. Expired is a Paylink that has passed the datetime specified by you in the expiration field of the original Paylink. |
| subTotal | string | Total amount of lineitems and lineitems tax |
| openOrders | array | List of orders that have been created for the Paylink |
| orderId | string, nullable | ID of the associated order in the Skipify system |
| Delivery Logs | array | Example: [ { "deliveryLogId": "string", "paylinkId": "string", "deliveryMethod": "EMAIL", "status": "DELIVERED", "messageId": "string", "createdAt": "2023-08-10T21:38:00.802Z", "updatedAt": "2023-08-10T22:38:05.802Z" } ] |
| events | array | Example:{ "eventId": "string", "paylinkId": "string", "eventType": "PAID", "oldValue": { "status": "OPENED" }, "newValue": { "status": "PAID", "orderTotal": 121, "amountPaid": 121 }, |
| transactions | array | Example: { "transactionType": "Sale", "transactionAmount": 2222, "pspTransactionId": "string", "skipifyTransactionId": "string", "cardBrand": "mastercard", "cardLastFour": "2205", "cardExpirationMonth": 12, "cardExpirationYear": 25 } |
Response Body Example
{
"paylinkId": "113ad60b-6c4d-41b5-b4f7-3b2444ebdd25",
"link": "https://stagecheckout.skipify.com/paylink/process/113ad60b-6c4d-41b5-b4f7-3b2444ebdd25",
"shortLink": "https://pl-stage.skipify.com/CF62Yt3",
"merchantInvoiceId": "your unique value",
"currencyCode": "USD",
"merchantId": "a1da0dbf-ccde-4265-8ccd-3b987c0a7193",
"metadata": null,
"description": "All sales are final",
"memo": "Thank you for your business",
"tax": null,
"shipping": null,
"orderId": "668570c06f1eder57a289bc7",
"expiration": "2025-05-22T21:44:00.000Z",
"sendSms": false,
"sendEmail": false,
"createdAt": "2024-07-03T15:39:42.021Z",
"updatedAt": "2024-07-03T15:40:00.148Z",
"customerConsent": true,
"total": 2222,
"orderTotal": 2222,
"approvedAmount": 2222,
"lastSentAt": null,
"lineItems": [
{
"paylinkItemId": "59c741-7741-4c39-9097-7bc27b3f2904",
"sku": "ABCDEFG123456",
"paylinkId": "226af40b-6c4d-41b5-b4f7-3b2444ebdd25",
"price": 1111,
"quantity": 2,
"tax": null,
"description": "Blue Hooded Sweatshirt Size L",
"category": "Men's",
"metadata": null,
"createdAt": "2024-07-03T15:39:42.021Z",
"updatedAt": "2024-07-03T15:39:42.021Z"
}
],
"deliveryLogs": [],
"openOrders": [
{
"paylinkId": "226af40b-6c4d-41b5-b4f7-3b2444ebdd25",
"orderId": "668570c06f1eder57a289bc7",
"createdAt": "2024-07-03T15:39:44.766Z"
}
],
"events": [
{
"eventId": "60f993b2-360b-4356-a509-2d5099c5c6b1",
"paylinkId": "226af40b-6c4d-41b5-b4f7-3b2444ebdd25",
"eventType": "CREATED",
"oldValue": null,
"newValue": null,
"createdBy": "API Key",
"createdAt": "2024-07-03T15:39:42.021Z"
},
{
"eventId": "cc32a004-5079-4f43-87fe-1d46231bd909",
"paylinkId": "226af40b-6c4d-41b5-b4f7-3b2444ebdd25",
"eventType": "OPENED",
"oldValue": {
"status": "CREATED"
},
"newValue": {
"status": "OPENED"
},
"createdBy": null,
"createdAt": "2024-07-03T15:39:44.766Z"
},
{
"eventId": "0779a8dd-b6f5-4a60-9501-8b681ba2f5f8",
"paylinkId": "226af40b-6c4d-41b5-b4f7-3b2444ebdd25",
"eventType": "PAID",
"oldValue": {
"status": "OPENED"
},
"newValue": {
"status": "PAID",
"orderTotal": 2222,
"approvedAmount": 2222
},
"createdBy": null,
"createdAt": "2024-07-03T15:40:00.148Z"
}
],
"status": "PAID",
"subTotal": 2222,
"customer": {
"email": null,
"phone": null,
"firstName": null,
"lastName": null,
"paylinkCustomerId": null
},
"attachments": [],
"transactions": [
{
"transactionType": "Sale",
"transactionAmount": 2222,
"pspTransactionId": "406503199",
"skipifyTransactionId": "13223fb91-51c9-42b5-9156-45bc35308e7c",
"cardBrand": "mastercard",
"cardLastFour": "2205",
"cardExpirationMonth": 12,
"cardExpirationYear": 25,
"transactionTimestamp": "2023-11-18T21:02:49.036129Z"
}
]
}
Updated about 1 month ago