API Reference
Create payment link
POST/v1/payment-linksCreates one specific payment link, that allows to initiate the payment process.
Request
Header Params
request-id
string
required
A unique identifier generated by requesting client
>= 38 characters<= 1024 characters
Example:
|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.
Match pattern:
^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$
Body Params application/json
merchantTransactionId
string
required
Id of the transaction provided by merchant.
>= 1 characters<= 128 characters
Example:
23beb187-f8a3-44b8-9ef8-b31180358dd3
Match pattern:
^[a-zA-Z0-9?&:\-\/=.,#|+_$\[\]€ ]+$
amount
string
required
Amount of the transaction.
Example:
123.04
Match pattern:
^(?=.*[0-9])\d{1,16}(?:\.\d{1,12})?$
currency
string
required
Currency code in ISO 4217 alphabetic code
>= 3 characters<= 3 characters
Example:
PLN
Match pattern:
^[A-Z]+$
customer
object
required
email
string <email>
required
Customer's email
<= 256 characters
Example:
john.doe@zen.com
firstName
string
required
Customer's firstname
<= 128 characters
Example:
John
lastName
string
required
Customer's lastname
<= 128 characters
Example:
Doe
items
array [object {3}]
required
Array of payment link items
name
string
required
Item Name
<= 256 characters
Example:
Multipla
price
string
required
Unit price of the item
Example:
123.04
Match pattern:
^-?(?=.*[0-9])\d{1,16}(?:\.\d{1,12})?$
quantity
number
required
Item quantity
Example:
1
expirationDate
string <date-time>
required
Example
{
"merchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
"amount": "123.04",
"currency": "PLN",
"customer": {
"email": "john.doe@zen.com",
"firstName": "John",
"lastName": "Doe"
},
"items": [
{
"name": "Multipla",
"price": "123.04",
"quantity": 1
}
],
"expirationDate": "2019-08-24T14:15:22.123Z"
}Request samples
Responses
OK(201)
Not Found(404)
HTTP Code: 201
Content Type : JSONapplication/json
Data Schema
id
string <uuid>
optional
url
string <uri>
optional
createdAt
string <date-time>
optional
Example
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "http://example.com",
"createdAt": "2019-08-24T14:15:22.123Z"
}Modified at 10 days ago