Modifying PayLinks
Learn how to make changes to PayLinks you have already created
Overview
You can always modify a Payment Request that you've created. This is great if you need to add, remove, or modify items in the request itself.
Important!
You may only make a change to a PayLink when it's in an
Created,Opened, orSentstatus.To check the status of a PayLink, please see Looking Up PayLinks
API Request
This endpoint uses HMAC
Check out our API Authentication section to learn more
The PayLink endpoint uses paylinkId which was provided in the response body when you created a PayLink.
To update a payment request, send an API call to:
Staging:PATCH https://stage-paylinks.skipify.com/{paylinkId}
Production:PATCH https://paylinks.skipify.com/{paylinkId}
Request Body Parameters
| Parameter Name | Required? | Type | Description |
|---|---|---|---|
| shipping | no | integer, nullable | This is the amount of shipping for the PayLink. The last two digits are cents, so $20.50 would be sent as 2050 |
| tax | no | integer, nullable | This is the amount of tax for the PayLink. The last two digits are cents, so $20.50 would be sent as 2050 |
| memo | no | string, 255 char | A generic field to allow you to add more information on the specific usage of this PayLink. This will be displayed to the customer. |
| description | no | string, 255 char | A generic field to allow you to add more information on the specific usage of this PayLink. This will be displayed to the customer. |
| expiration | no | dateTime string, nullable | This is an optional parameter you can use to set an expiry on the Payment Request. Use the format: yyyy-MM-ddTHH:mm:ss.SSSZEx: 2022-06-02T21:48:02.000Z |
Request Body Example
{
"shipping": 0,
"tax": 0,
"memo": "string",
"description": "string",
"expiration": "2023-08-10T22:31:36.684Z"
}
Important
Changes to shipping and tax are based on currency code assignment when creating a PayLink
API Response
Response Body Parameters
A successful response will return the PayLink parameters in your original create request, reflecting the changes made in this request.
Response Body Example
{
"paylinkId": "string",
"link": "string",
"shortLink": "string",
"currencyCode": "string",
"memo": "string",
"description": "string",
"sendEmail": true,
"sendSms": true,
"expiration": "2023-08-10T22:31:36.725Z",
"createdAt": "2023-08-10T22:31:36.725Z",
"updatedAt": "2023-08-10T22:31:36.725Z",
"shipping": 0,
"tax": 0,
"merchantId": "string",
"merchantInvoiceId": "string",
"orderId": "string",
"subTotal": 0,
"total": 0,
"orderTotal": 0,
"status": "CREATED",
"customer": {
"email": "[email protected]",
"phone": "7014734135",
"firstName": "string",
"lastName": "string",
"accountName": "string",
"paylinkCustomerId": "string"
},
"customerConsent": true,
"lineItems": [
{
"sku": "string",
"quantity": 1,
"price": 1,
"tax": 0,
"description": "string",
"category": "string",
"metadata": {
"additionalProp1": {}
},
"paylinkId": "string",
"paylinkItemId": "string",
"createdAt": "2023-08-10T22:31:36.725Z",
"updatedAt": "2023-08-10T22:31:36.725Z"
}
],
"deliveryLogs": [
{
"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"
}
],
"metadata": {
"additionalProp1": {}
},
"openedOrders": [
"string",
],
"attachments": [
{
"attachmentId": "string",
"paylinkId": "string",
"displayName": "string",
"createdAt": "2023-08-10T22:31:36.725Z",
"updatedAt": "2023-08-10T22:31:36.725Z"
}
]
}
Updated 5 days ago