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:

<style>
.App {
  --font-family: 'poppins', 'helvetica';
}
</style>

<style>
  /* Terrell From ReadMe Here */
  .markdown-body .rdmd-table table {
    table-layout: fixed;
  }
</style>

Overview

You may want to look up a Paylink for a number of reasons, like revi

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,
"billingAddress": {
"firstName": "string",
"lastName": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string"
}
}

enableRecurring

boolean

Whether or not the paylink was setup to prompt the customer for recurring charges during checkout

recurringChargeConsent

boolean

Whether or not the customer consented to recurring charges

recurringMethodId

string

Payment method id for recurring payment