Overview

You may want to look up Paylinks 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 API Key Authentication
Check out our API KEY Authentication Section to learn more

This endpoint references the merchantId and any of the optional query parameters listed below.

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

Staging:GET https://paylinks.staging.skipify.com/?{merchantId}&{queryparameter}

Production:GET https://paylinks.skipify.com/?{merchantId}&{queryparameter}

Query Parameters

Name	Type	Description
merchantId	string/uuid	your merchant account id
amountGTE	integer	amount greater than or equal to
amountLTE	integer	amount less than or equal to
createdAfter	datetime	paylinks created after
createdBefore	datetime	payinks created before
customerIds	string	comma separated customerId
customers	string	comma separated customer names ("firstName lastName" or "lastName firstName").
enableRecurring	boolean	returns paylinks enabled for MIT
isFlexPay	boolean	returns paylinks paid with Flex Pay (bnpl)
orderBy	enum	asc (defult), desc
pageNumber	integer	>=1
pageSize	integer	default 25
paymentMethodType	enum	card, bank_account, isFlexPay
search	string	deliveryLog, DatelastSentAt, createdAt (default)
status	enum	comma separated values

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
metadata	object	summary information related to GET `"metadata": { "totalRecords": 68, "totalPages": 3, "pageNumber": 1, "pageSize": 25, "links": { "previousPage": null, "nextPage": "/?merchantId=****&status=PAID&pageNumber=3&pageSize=25", "firstPage": "/?merchantId=&status=PAID&pageNumber=1&pageSize=25", "lastPage": "/?merchantId=*&status=PAID&pageNumber=3&pageSize=25" } },`
data	array	root array housing the below parameters
paylinkid	string (url)	The URL for the specific Paylink
link	string(url)	The link URL for the specific Paylinks
shortLink	string(url)	The short link URL for the specific Paylink
merchantInvoiceId	string	A unique identifier that you send with the paylink 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
recurringChargeConsent	boolean	Whether or not the customer consented to recurring charges
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
bnpl	boolean	Whether bnpl was utilized to complete the paylink
paymentMethodType	string	The payment method type used to complete the paylink
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
deliveryLogs	array	Example: `{ "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" }`
events	array	Example: `{ "eventId": "string", "paylinkId": "string", "eventType": "PAID", "oldValue": { "status": "OPENED" }, "newValue": { "status": "PAID", "orderTotal": 121, "amountPaid": 121 } }`
enableRecurring	boolean	Whether or not the paylink was setup to prompt the customer for recurring charges during checkout
recurringMethodId	string	Payment method id for recurring payment

Response Body Example

{
    "metadata": {
        "totalRecords": 201,
        "totalPages": 9,
        "pageNumber": 1,
        "pageSize": 25,
        "links": {
            "previousPage": null,
            "nextPage": "/?merchantId=2f08bd4d-27ba-4aa7-b8d9-3d798d9635f6&pageNumber=9&pageSize=25",
            "firstPage": "/?merchantId=2f08bd4d-27ba-4aa7-b8d9-3d798d9635f6&pageNumber=1&pageSize=25",
            "lastPage": "/?merchantId=2f08bd4d-27ba-4aa7-b8d9-3d798d9635f6&pageNumber=9&pageSize=25"
        }
    },
    "data": [
        {
            "paylinkId": "c5404d24-72eb-413e-8fde-05082316d923",
            "link": "https://checkout.skipify.com/paylink/process/c5404d24-72eb-413e-8fde-05082316d923",
            "shortLink": "https://pl.skipify.com/fhpqfv",
            "merchantInvoiceId": "TEST",
            "currencyCode": "USD",
            "merchantId": "2f08bd4d-27ba-4aa7-b8d9-3d798d9635f6",
            "metadata": null,
            "description": "TEST PROD",
            "memo": null,
            "tax": null,
            "shipping": null,
            "orderId": null,
            "expiration": null,
            "sendSms": false,
            "sendEmail": true,
            "createdAt": "2024-06-04T19:56:31.987Z",
            "updatedAt": "2024-06-04T20:18:42.299Z",
            "customerConsent": true,
            "recurringChargeConsent": null,
            "total": 100,
            "orderTotal": null,
            "approvedAmount": null,
            "lastSentAt": "2024-06-04T19:56:32.868Z",
            "bnpl": null,
            "paymentMethodType": null,
            "lineItems": [
                {
                    "paylinkItemId": "25c893b1-0c24-42ef-9f68-a32d85ab3726",
                    "sku": "Paylink Amount",
                    "paylinkId": "c5404d24-72eb-413e-8fde-05082316d923",
                    "price": 100,
                    "quantity": 1,
                    "tax": null,
                    "title": null,
                    "description": null,
                    "productCode": null,
                    "commodityCode": null,
                    "category": null,
                    "metadata": null,
                    "createdAt": "2024-06-04T19:56:31.987Z",
                    "updatedAt": "2024-06-04T19:56:31.987Z"
                }
            ],
            "deliveryLogs": [
                {
                    "deliveryLogId": "cb6c8cd2-5533-468b-8568-dd892d85b42f",
                    "paylinkId": "c5404d24-72eb-413e-8fde-05082316d923",
                    "deliveryMethod": "EMAIL",
                    "status": "DELIVERED",
                    "messageId": "grx60dt4TmS_Nishd9d38g",
                    "createdAt": "2024-06-04T19:56:32.870Z",
                    "updatedAt": "2024-06-04T19:56:38.877Z"
                }
            ],
            "openOrders": [
                {
                    "paylinkId": "c5404d24-72eb-413e-8fde-05082316d923",
                    "orderId": "665f76a2c48bc9f5f2f58834",
                    "createdAt": "2024-06-04T20:18:42.299Z"
                }
            ],
            "events": [
                {
                    "eventId": "d50c1398-b759-4cda-bae5-b68ad12c8624",
                    "paylinkId": "c5404d24-72eb-413e-8fde-05082316d923",
                    "eventType": "CREATED",
                    "oldValue": null,
                    "newValue": null,
                    "createdBy": "*****@email.com",
                    "createdAt": "2024-06-04T19:56:31.987Z"
                },
                {
                    "eventId": "aa3b6d96-5f32-406f-b3e1-e12f794abfd9",
                    "paylinkId": "c5404d24-72eb-413e-8fde-05082316d923",
                    "eventType": "SENT",
                    "oldValue": {
                        "status": "CREATED"
                    },
                    "newValue": {
                        "status": "SENT",
                        "deliveredTo": [
                            "EMAIL"
                        ]
                    },
                    "createdBy": "*****@email.com,
                    "createdAt": "2024-06-04T19:56:32.870Z"
                },
                {
                    "eventId": "954ba56e-2dd2-4370-90eb-686ed0c71d50",
                    "paylinkId": "c5404d24-72eb-413e-8fde-05082316d923",
                    "eventType": "OPENED",
                    "oldValue": {
                        "status": "SENT"
                    },
                    "newValue": {
                        "status": "OPENED"
                    },
                    "createdBy": null,
                    "createdAt": "2024-06-04T20:18:42.299Z"
                }
            ],
            "status": "OPENED",
            "subTotal": 100,
            "customer": {
                "accountName": null,
                "email": "*****@email.com",
                "phone": null,
                "firstName": null,
                "lastName": null,
                "paylinkCustomerId": null
            },
            "attachments": [],
            "recurringMethodId": null
        } 
}