Send a payment link via email and/or SMS

Production Environment

POST

/api/1/partner/payment-link/{id}/send

Payment Links

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

string <uuid>

required

Payment link ID (UUID)

Header Params

x-merchant-id

string <uuid>

Merchant ID

required

If acting on behalf of a merchant, you will need to specify their merchant ID.

Body Params application/json

sms

object

optional

recipient

string

required

object

optional

recipient

string

required

Example

{
  "sms": {
    "recipient": "+447927987649"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.lopay.com/api/1/partner/payment-link//send' \
--header 'x-merchant-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sms": {
        "recipient": "+447927987649"
    }
}'

Responses

🟢204No Content

application/json

No content response

Body

object {0}

Example

{}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠422Parameter Error

Modified at 2025-03-03 16:34:00

Revoke an existing payment link

Get login link for Lopay Partner Webhook Portal