---
updatedAt: 2026-09-22T23:07:49.000Z
agentTools:
  projectIndex: https://docs.skipify.com/llms.txt
---

# Look Up Paylinks

Learn how you can look up a specific paylink

# Overview

You may want to look up a or all Paylink for a number of reasons, like reviewing the details so you can modify it, or just to confirm its status.

# API Request

<Callout icon="👍" theme="okay">
  ### This endpoint uses API Key Authentication

  Check out our [API KEY Authentication Section](https://docs.skipify.com/docs/api-authentication-api-key) to learn more
</Callout>

This endpoint references the `paylinkId` of the Paylink, which was provided in the response body when you [created the Paylink](https://docs.skipify.com/docs/creating-paylinks).

To look up a Paylink, send an API call to:

> **Staging**:`GET https://paylinks.staging.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:

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Name
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        paylinkId
      </td>

      <td>
        string
      </td>

      <td>
        Skipify’s unique identifier for the Paylink. This ID will be needed to use the other endpoints.
      </td>
    </tr>

    <tr>
      <td>
        link
      </td>

      <td>
        string (url)
      </td>

      <td>
        The URL for this Paylink
      </td>
    </tr>

    <tr>
      <td>
        shortLink
      </td>

      <td>
        string(url)
      </td>

      <td>
        The short link URL for this Paylink
      </td>
    </tr>

    <tr>
      <td>
        merchantInvoiceId
      </td>

      <td>
        string
      </td>

      <td>
        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.
      </td>
    </tr>

    <tr>
      <td>
        currencyCode
      </td>

      <td>
        string
      </td>

      <td>
        The currency used to create the Paylink.  Only USD supported currently.
      </td>
    </tr>

    <tr>
      <td>
        merchantId
      </td>

      <td>
        string
      </td>

      <td>
        The merchantId that this Paylink was created for
      </td>
    </tr>

    <tr>
      <td>
        metadata
      </td>

      <td>
        object
      </td>

      <td>
        If sent in the request, will be returned in the response
      </td>
    </tr>

    <tr>
      <td>
        description
      </td>

      <td>
        string
      </td>

      <td>
        The description sent with the Paylink create request. This will be displayed to the customer.
      </td>
    </tr>

    <tr>
      <td>
        memo
      </td>

      <td>
        string
      </td>

      <td>
        The memo sent with the Paylink create request. This will be displayed to the customer.
      </td>
    </tr>

    <tr>
      <td>
        tax
      </td>

      <td>
        integer
      </td>

      <td>
        If tax was included in the Paylink create request, will be returned in the response
      </td>
    </tr>

    <tr>
      <td>
        shipping
      </td>

      <td>
        integer
      </td>

      <td>
        If shipping was included in the Paylink create request, will be returned in the response
      </td>
    </tr>

    <tr>
      <td>
        orderId
      </td>

      <td>
        string
      </td>

      <td>
        will be Null unless Paylink status = Paid, Partially_Paid, Refunded, or Partially_Refunded
      </td>
    </tr>

    <tr>
      <td>
        expiration
      </td>

      <td>
        dateTime, string
      </td>

      <td>
        The expiration date/time of the Paylink if it was set in the Request.<br />Ex:<br />2024-06-02T21:48:02Z
      </td>
    </tr>

    <tr>
      <td>
        sendSms
      </td>

      <td>
        boolean
      </td>

      <td>
        The boolean flag set on the request
      </td>
    </tr>

    <tr>
      <td>
        sendEmail
      </td>

      <td>
        boolean
      </td>

      <td>
        The boolean flag set on the request
      </td>
    </tr>

    <tr>
      <td>
        createdAt
      </td>

      <td>
        dateTime, string
      </td>

      <td>
        The date/time the Paylink was created, in UTC
      </td>
    </tr>

    <tr>
      <td>
        updatedAt
      </td>

      <td>
        dateTime, string
      </td>

      <td>
        The date/time the Paylink was most recently updated, in UTC
      </td>
    </tr>

    <tr>
      <td>
        customerConsent
      </td>

      <td>
        boolean
      </td>

      <td>
        The boolean flag set in the request, must be true to send
      </td>
    </tr>

    <tr>
      <td>
        total
      </td>

      <td>
        integer
      </td>

      <td>
        Total amount of lineItems, shipping, tax
      </td>
    </tr>

    <tr>
      <td>
        orderTotal
      </td>

      <td>
        integer
      </td>

      <td>
        The total plus any fees applied during payment
      </td>
    </tr>

    <tr>
      <td>
        approvedAmount
      </td>

      <td>
        integer
      </td>

      <td>
        The amount that was approved for during payment
      </td>
    </tr>

    <tr>
      <td>
        lastSentAt
      </td>

      <td>
        dateTime, string
      </td>

      <td>
        The last time the Paylink was sent to the customer
      </td>
    </tr>

    <tr>
      <td>
        lineItems
      </td>

      <td>
        array
      </td>

      <td>
        An array of Line Items sent when the Paylink was created
      </td>
    </tr>

    <tr>
      <td>
        status
      </td>

      <td>
        enum
      </td>

      <td>
        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.
      </td>
    </tr>

    <tr>
      <td>
        subTotal
      </td>

      <td>
        string
      </td>

      <td>
        Total amount of lineitems and lineitems tax
      </td>
    </tr>

    <tr>
      <td>
        openOrders
      </td>

      <td>
        array
      </td>

      <td>
        List of orders that have been created for the Paylink
      </td>
    </tr>

    <tr>
      <td>
        orderId
      </td>

      <td>
        string, nullable
      </td>

      <td>
        ID of the associated order in the Skipify system
      </td>
    </tr>

    <tr>
      <td>
        deliveryLogs
      </td>

      <td>
        array
      </td>

      <td>
        Example:

        ```json
        {
          "deliveryLogId": "string",
          "paylinkId": "string",
          "deliveryMethod": "EMAIL",
          "status": "NOT_SENT",
          "messageId": "string",
          "createdAt": "2023-08-10T22:31:36.725Z",
          "updatedAt": "2023-08-10T22:31:36.725Z"
        }
        ```
      </td>
    </tr>

    <tr>
      <td>
        events
      </td>

      <td>
        array
      </td>

      <td>
        Example:

        ```json
        {
          "eventId": "string",
          "paylinkId": "string",
          "eventType": "PAID",
          "oldValue": {
            "status": "OPENED"
          },
          "newValue": {
            "status": "PAID",
            "orderTotal": 121,
            "amountPaid": 121
          }
        }
        ```
      </td>
    </tr>

    <tr>
      <td>
        transactions
      </td>

      <td>
        array
      </td>

      <td>
        Example:

        ```json
        {
          "transactionType": "Sale",
          "transactionAmount": 2222,
          "pspTransactionId": "string",
          "skipifyTransactionId": "string",
          "cardBrand": "mastercard",
          "cardLastFour": "2205",
          "cardExpirationMonth": 12,
          "cardExpirationYear": 25,
          "billingAddress": {
            "firstName": "string",
            "lastName": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "country": "string"
          }
        }
        ```
      </td>
    </tr>

    <tr>
      <td>
        enableRecurring
      </td>

      <td>
        boolean
      </td>

      <td>
        Whether or not the paylink was setup to prompt the customer for recurring charges during checkout
      </td>
    </tr>

    <tr>
      <td>
        recurringChargeConsent
      </td>

      <td>
        boolean
      </td>

      <td>
        Whether or not the customer consented to recurring charges
      </td>
    </tr>

    <tr>
      <td>
        recurringMethodId
      </td>

      <td>
        string
      </td>

      <td>
        Payment method id for recurring payment
      </td>
    </tr>
  </tbody>
</Table>

### Response Body Example

```json JSON Response Body

{   
  "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",
      "billingAddress": {
        "firstName": "Bob",
        "lastName": "Smith",
        "address1": "123 Main St",
        "city": "Longmont",
        "zipCode": "80501",
        "state": "CO",
        "country": "US"
      }
    }
  ],
  "enableRecurring": true,
  "recurringMethodId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

***

<HTMLBlock>{`
<a href="https://www.skipify.com/get-in-touch"><img src="https://files.readme.io/279452f-CTA_Contact_Footer_1440x205_Final.png" alt="Skipify banner with link to contact us form"></a>
`}</HTMLBlock>