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 paymentRequestId 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:

GET https://paylinks.skipify.com/{paylinkId}

📘
Note
There is no request body for this request

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 (Open, PaidOffPlatform, CancelledByMerchant, PaidOnPlatform, Expired)	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)	What we all came here for! This is the URL that you will use to forward to your customers. Do what you like with this URL - it can be tiny-fied, it can be embedded as-is, and can be converted into a QR code.
Delivery Logs	object	{ "deliveryLogId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "paylinkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deliveryMethod": "NULL", "status": "NOT_SENT", "messageId": "string", "createdAt": "2023-08-10T21:38:00.802Z", "updatedAt": "2023-08-10T21:38:00.802Z" }

Response Body Example

{
  "paylinkId": "string",
  "link": "string",
  "currencyCode": "string",
  "memo": "string",
  "description": "string",
  "sendEmail": true,
  "sendSms": true,
  "expiration": "2023-08-14T14:01:04.251Z",
  "createdAt": "2023-08-14T14:01:04.251Z",
  "updatedAt": "2023-08-14T14:01:04.251Z",
  "shipping": 0,
  "tax": 0,
  "merchantId": "string",
  "merchantInvoiceId": "string",
  "orderId": "string",
  "subTotal": 0,
  "total": 0,
  "status": "CREATED",
  "customer": {
    "email": "[email protected]",
    "phone": "3065303414",
    "firstName": "string",
    "lastName": "string",
    "accountName": "string"
  },
  "lineItems": [
    {
      "sku": "string",
      "quantity": 1,
      "price": 1,
      "tax": 0,
      "description": "string",
      "category": "string",
      "metadata": {
        "additionalProp1": {}
      },
      "paylinkId": "string",
      "paylinkItemId": "string",
      "createdAt": "2023-08-14T14:01:04.251Z",
      "updatedAt": "2023-08-14T14:01:04.251Z"
    }
  ],
  "deliveryLogs": [
    {
      "deliveryLogId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paylinkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "deliveryMethod": "EMAIL",
      "status": "NOT_SENT",
      "messageId": "string",
      "createdAt": "2023-08-14T14:01:04.251Z",
      "updatedAt": "2023-08-14T14:01:04.251Z"
    }
  ],
  "metadata": {
    "additionalProp1": {}
  }
}

👍
API Reference
Check out our API Reference to learn more

Skipify baner with link to contact us form