Skip to main content
POST
/
paymentLink
/
{paymentLinkId}
/
send
Send a payment link to recipients
curl --request POST \
  --url https://rest.staging.nickel.com/paymentLink/{paymentLinkId}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    {
      "email": "<string>",
      "name": "<string>",
      "phoneNumber": "<string>"
    }
  ],
  "sendSms": true
}
'
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
paymentLinkId
string
required

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