Skip to main content
POST
/
payments
/
link
cURL
curl --request POST \
  --url https://api-test.klyme.io/api/v1/payments/link \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantUuid": "<string>",
  "amount": 10.99,
  "currency": "GBP",
  "type": "EMAIL",
  "reference": "<string>",
  "email": "[email protected]",
  "mobile": "7742123456",
  "countryCallingCode": "44",
  "firstName": "<string>",
  "surname": "<string>"
}
'
{
  "link": "https://lnk.klyme.io/a11de8",
  "date": "2025-09-08 15:05:12"
}
klyme-widget-flow-example

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
merchantUuid
string
required
​
amount
number<double>
required
Example:

10.99

​
currency
enum<string>
required
Available options:
GBP,
EUR
​
type
enum<string>
required

Determines how the payment link is delivered.

EMAIL requires email to be specified. SMS requires mobile and countryCallingCode to be specified. EMSMS requires both email and mobile to be specified.

Available options:
EMAIL,
SMS,
EMSMS,
LINK
​
reference
string
required
Required string length: 6 - 36
​
email
string<email>
Maximum string length: 256
​
mobile
number

Must not contain country code, leading zeros or + character. The parameter countryCallingCode is mandatory if specifying mobile.

Example:

"7742123456"

​
countryCallingCode
string

Is mandatory if mobile has been specified.

Maximum string length: 2
Example:

"44"

​
firstName
string
Maximum string length: 64
​
surname
string
Maximum string length: 64

Response

201 - application/json

Payment link response

​
link
string
Example:

"https://lnk.klyme.io/a11de8"

​
date
string<date-time>
Example:

"2025-09-08 15:05:12"