Skip to main content
POST
/
payment-links
/
scheduled
Trigger scheduled payment link emails
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/payment-links/scheduled \
  --header 'Content-Type: application/json' \
  --data '
{
  "scheduled_at": "2026-04-15",
  "period": 24
}
'
{
  "message": "Scheduled payment link emails sent",
  "count": 5
}

Body

application/json
​
scheduled_at
string
required

Target date/datetime for which to query due payment links (ISO 8601).

Example:

"2026-04-15"

​
period
integer
required

Number of hours before scheduled_at to include in the query window. Default is 24.

Example:

24

Response

200 - application/json

Scheduled emails triggered successfully.

​
message
string
Example:

"Scheduled payment link emails sent"

​
count
integer
Example:

5