Skip to main content
POST
Send a payment link to recipients

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ID of the payment link to send

Body

application/json

Recipients to notify

recipients
object[]
required
Minimum array length: 1
sendSms
boolean

Override the organization's default SMS setting. If omitted, uses the org setting (defaults to true).

Response

Payment link sent

message
string
heldForApproval
boolean

True when the merchant's approval rules held the send. Nothing was sent; the payment link goes to its recipients once the merchant's approvers approve it.

approvalRequestId
string | null

ID of the approval request holding the send, when heldForApproval is true.