Guides
Back to skipify.comContact Us

Sending Paylinks

Learn how to send a Paylink

Suggest Edits

Overview

Skipify is capable of sending a created Paylink via email or SMS. The use of this endpoint is conditional based on the parameters set on the create endpoint:

  • To send a Paylink via email, you must set the sendEmail parameter to true. This will also require you to add an email within the Customer object.
  • To send a Paylink via text message, you must set the sendSMS parameter to true. This will also require you to add a phone number within the Customer object.

Please read the Creating Paylinks documentation to ensure you are creating links correctly to allow you to use this capability.

API Request

👍

This endpoint uses API Key Authentication

Check out our API KEY Authentication Section to learn more

The endpoint for this request uses the payment's paylinkId, which was originally provided in the response body when you created the Paylink.

To send a Paylink to a customer, send an API call to:

Staging:PATCH https://paylinks.staging.skipify.com/{paylinkId}/send

Production:PATCH https://paylinks.skipify.com/{paylinkId}/send

Request Body Parameters

Parameter NameRequired?TypeDescription
sendEmailyesbooleanThis field is used when you are using Skipify to deliver a link to the customer via email.
sendSmsyesbooleanThis field is used when you are using Skipify to deliver a link to the customer via text.

HTTP API Response Codes

CodeDescription
200Successfully sent a Paylink
400Invalid send request
404Paylink was not found
500Unable to send the Paylink

Response Body Parameters

Parameter NameTypeDescription
paylinkIdstringSkipify’s unique identifier for the Paylink. This ID will be needed to use the other endpoints.
linkstring (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 embedded as-is, and can be converted into a QR code.
shortLinkstring (url)A Skipify generated Short Link that you can use instead of the link to forward to your customers if you deliver the Paylink yourself.
merchantInvoiceIdstringA 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.
currencyCodestringUSD only today
merchantIdstringThe merchantId that this Paylink was created for
metadataobjectIf sent in the request, will be returned in the response
descriptionstringThe description sent with the Paylink create request. This will be displayed to the customer.
memostringThe memo sent with the Paylink create request. This will be displayed to the customer.
orderIdstringwill be Null upon Paylink Creation. OrderId is assigned to Paylink once Payment completed.
expirationdateTime, string,The expiration date/time of the Paylink that was set in the Request.
Ex:
2024-06-02T21:48:02Z
sendSMSbooleanThe boolean flag set on the request.
sendEmailbooleanThe boolean flag set on the request.
createdAtdateTime, stringThe date/time the Paylink was created at in UTC
updatedAtdateTime, stringThe date/time the Paylink was updated in UTC
customerConsentbooleanThe boolean flag set in the request, must be true to send
taxintegerAmount of tax sent for the Paylink
shippingintegerAmount of shipping sent for the Paylink
subTotalintegerTotal price of lineItems and lineItems tax
totalintegerTotal price of lineItems, lineItems tax, shipping, tax
orderTotalintegerThe total plus any fees applied during payment
approvedAmountintegerThe amount that was paid by the customer
lastSentAtdateTime, stringThe last time the Paylink was sent to the customer
lineItemsarrayThese are the line items sent with the request. This object also returns:
'createdAt' - dateTime, string
'updatedAt' - dateTime, string
deliveryLogsarrayList of SMS and/or email delivery attempts
openOrdersarrayList of orders that have been created for the Paylink
eventsarrayList of events associated with this Paylink, upon send, newValue, Status = SENT
statusstringcurrent status of Paylink, upon successfully sent, status = SENT
customerobjectCustomer object sent with request
attachmentsarrayList of attachments file names if added to Paylink

Response Body Example

{
    "paylinkId": "string",
    "link": "string",
    "shortLink": "string",
    "merchantInvoiceId": "string",
    "currencyCode": "USD",
    "merchantId": "string",
    "metadata": null,
    "description": "string",
    "memo": "string",
    "orderId": null,
    "expiration": "2025-02-28T16:13:00.000Z",
    "sendSms": true,
    "sendEmail": true,
    "createdAt": "2024-04-19T16:22:00.599Z",
    "updatedAt": "2024-04-19T17:52:47.702Z",
    "customerConsent": true,
    "tax": null,
    "shipping": null,
    "subTotal": 1010,
    "total": 1010,
    "orderTotal": null,
    "approvedAmount": null,
    "lastSentAt": "2024-04-19T17:52:47.699Z",
    "lineItems": [
        {
            "paylinkItemId": "string",
            "sku": "123987ABCXYZ",
            "paylinkId": "string",
            "price": 1010,
            "quantity": 1,
            "tax": 0,
            "description": "string",
            "category": "string",
            "metadata": null,
            "createdAt": "2024-04-19T16:22:00.599Z",
            "updatedAt": "2024-04-19T16:22:00.599Z"
        }
    ],
    "deliveryLogs": [
        {
            "deliveryLogId": "string",
            "paylinkId": "string",
            "deliveryMethod": "SMS",
            "status": "SENT",
            "messageId": "string",
            "createdAt": "2024-04-19T17:52:47.702Z",
            "updatedAt": "2024-04-19T17:52:47.702Z"
        },
        {
            "deliveryLogId": "string",
            "paylinkId": "string",
            "deliveryMethod": "EMAIL",
            "status": "SENT",
            "messageId": "string",
            "createdAt": "2024-04-19T17:52:47.702Z",
            "updatedAt": "2024-04-19T17:52:47.702Z"
        }
    ],
    "openOrders": [],
    "events": [
        {
            "eventId": "string",
            "paylinkId": "string",
            "eventType": "CREATED",
            "oldValue": null,
            "newValue": null,
            "createdBy": "API Key",
            "createdAt": "2024-04-19T16:22:00.599Z"
        },
        {
            "eventId": "string",
            "paylinkId": "string",
            "eventType": "SENT",
            "oldValue": {
                "status": "CREATED"
            },
            "newValue": {
                "status": "SENT",
                "deliveredTo": [
                    "SMS",
                    "EMAIL"
                ]
            },
            "createdBy": "API Key",
            "createdAt": "2024-04-19T17:52:47.702Z"
        }
    ],
    "status": "SENT",
    "customer": {
        "email": "[email protected]",
        "phone": "3333333333",
        "firstName": "first",
        "lastName": "last",
        "paylinkCustomerId": null
    },
    "attachments": []
}

Skipify baner with link to contact us form

Updated 23 days ago