POST
/
PaymentLink
/
push
/
{payLinkId}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/PaymentLink/push/{payLinkId} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "channel": "sms"
}'
{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234"
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

ID for the payment link.

Body

Request body for the push paylink operation.

channel
enum<string>
required

Use email to send the paylink. This is the standard method for sending paylinks.

Available options:
email
attachFile
boolean

When true, attaches a PDF version of the invoice to the email.

Example:

false

additionalEmails
string[] | null

List of additional email addresses you want to send the paylink to, formatted as an array. Paylinks and opt-in requests are sent to the customer email address on file, and additional recipients can be specified here.

Response

200
application/json
Success
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseCode
integer | null

Code for the response. Learn more in API Response Codes.

Example:

1

responseData
object | null

The paylink ID or error details.

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

Was this page helpful?