API referenceShared resource endpointsPayment links

Send payment link

Send a payment link to the specified email addresses or phone numbers.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

payLinkIdstringRequired
ID for the payment link.

Request

This endpoint expects an object.
emailobjectRequired
OR
smsobjectRequired

Response

Success
isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDatastring

If isSuccess = true, this contains the payment link identifier. If isSuccess = false, this contains the reason of the error.

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error