Token Request

Before merchant redirects customer to Leanpay checkout page, merchant’s server must obtain unique token from Leanpay server. Received token will be used as parameter for redirect HTTP request.

Request
Request Body schema: application/json
vendorApiKey
required
string <uuid> <= 36 characters

Assigned vendor API key. This value will be assigned at the time of application.

vendorTransactionId
required
string <= 32 characters

Your unique reference or identification number for the transaction. (Must be unique for each payment)

amount
required
number <= 20 characters

The total amount payable. Note: do not include the trailing zeroes if the amount is a natural number. For example: "23" (not "23.00").

successUrl
required
string <url> <= 320 characters

URL to which the customer is returned once the successful payment is made. Regex (^(https?://[\w.-]+(/\S+))?(/[\w#-]+)$)

errorUrl
required
string <url> <= 320 characters

URL to which the customer is returned if the payment is cancelled or fails. Regex "^(https?://[\w.-]+(/\S+))?(/[\w#-]+)$"

vendorPhoneNumber
string <= 32 characters

Customer phone number acquired by vendor as part of registration on vendors online shop.

vendorFirstName
required
string <= 255 characters

Customer first name acquired by vendor as part of registration on vendors online shop.

vendorLastName
required
string <= 255 characters

Customer last name acquired by vendor as part of registration on vendors online shop.

vendorAddress
string <= 255 characters

Customer address acquired by vendor as part of registration on vendors online shop.

vendorZip
number <= 32 characters

Customer zip acquired by vendor as part of registration on vendors online shop.

vendorCity
string <= 255 characters

Customer city acquired by vendor as part of registration on vendors online shop.

language
string <= 2 characters

Language wich customer selected on vendors online shop.

vendorProductCode
string <uuid> <= 255 characters

Identification for financial product that you agreed with Leanpay. If it is not specified, default will be used.

required
object
Responses
200

Received token will be used as parameter for redirect HTTP request.

post/vendor/token
Request samples
application/json
{
  • "vendorApiKey": "a6e83e59-ab14-42e5-af24-1e46968e5f06",
  • "vendorTransactionId": "trx6298",
  • "amount": 200,
  • "successUrl": "/vendor-mock",
  • "errorUrl": "/vendor-mock",
  • "vendorPhoneNumber": 38611111111,
  • "vendorFirstName": "Janez",
  • "vendorLastName": "Novak",
  • "vendorAddress": "Teslova ulica 1",
  • "vendorZip": 1000,
  • "vendorCity": "Ljubljana",
  • "language": "sl",
  • "vendorProductCode": "7208f613-f346-42be-a334-cef66ff4e44b",
  • "CartItems": {
    }
}
Response samples
application/json
{
  • "token": "375e39ad91434c019e2b6ef0ce17b221"
}