Skip to content
/
Shares a payment link

Shares a payment link

Request

POST {{baseURL}}/v2/payment-links/{{paymentLinkId}}/share

This endpoint shares a payment link with a customer by SMS or email.

This sends the link's URL to the recipient over the selected channel. Only Active links can be shared, and the customer must have consented to receive the message.

See Also:
To list payment links, see GET /v2/payment-links.
To create a new payment link, see POST /v2/payment-links.
To retrieve a payment link by identifier, see GET /v2/payment-links/{{paymentLinkId}}.
To update a payment link, see PATCH /v2/payment-links/{{paymentLinkId}}.

Security
Bearer
Path
paymentLinkIdstring, (uuid)required

Specifies the payment link identifier.

Example:6f2a8b3c-9d4e-4f1a-8b7c-3e5d6a9f0c1b
Bodyapplication/json

Delivery channel, recipient, and customer consent.

shareBystringrequired

Indicates the delivery method used to share a payment link with a customer.

Valid values are:

ValueDescription
EmailThe link is sent by email.
SmsThe link is sent by text message.

Example: Sms

Enum:"Email""Sms"
Example:"Sms"
recipientstring, non-emptyrequired

Specifies where the link is sent.

This is a mobile phone number (in an E.164 format) when sharing by Sms.
This is an email address (up to 254 characters) when sharing by Email.

Example: +14125553845

Example:"+14125553845"
hasCustomerConsentbooleanrequired

Specifies the customer has consented to receive the message.

If true, the customer has consented to receive the message.
If false, the customer has not consented to receive the message.

Example: true

Example:true
curl -i -X POST \
  https://sandbox.api.flute.com/v2/payment-links/6f2a8b3c-9d4e-4f1a-8b7c-3e5d6a9f0c1b/share \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "shareBy": "Sms",
    "recipient": "+14125553845",
    "hasCustomerConsent": true
  }'

Responses

No Content. The payment link was successfully shared.

Response
No content