Send a Payment Request
Schedule a request email and optional due-date reminder through the durable delivery outbox.
POST /api/v1/payment_requests/:id/send
const result = await paybytoken.paymentRequests.send(
request.id,
{
schedule_reminder: true,
reminder_days_before_due: 3,
},
{ idempotencyKey: 'payment-request:PO-1042:send' },
)recipient_email may override the request recipient. It is required if the request has no stored
customer email. Only open requests can be sent.
The API schedules delivery; it does not synchronously send email. Each delivery moves through
pending, processing, and then sent, failed, or canceled. sent means the provider accepted
the message. It does not prove final mailbox delivery or that the recipient opened it.
Failed sends retry with bounded backoff. Automatic reminders are canceled when the request becomes paid, canceled, or expired. Calling send again creates a merchant-triggered reminder rather than rewriting prior delivery history.
Did this page answer your question?
Your feedback helps us improve the integration path.