Credit Request

Creates new credit request for the customer with all necessary data for consumer loan directly from shop’s CRM or ERP, no need to use Leanpay Shop App.

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

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

vendorTransactionId
required
number <= 32 characters

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

amount
required
number <= 32 characters

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

validUntil
required
number <UNIX timestamp> <= 32 characters

The date by which the offer is valid The number of milliseconds since January 1, 1970, 00:00:00 GMT.

vendorProductCode
number <= 32 characters

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

vendorItemDescription
number <= 32 characters

Description of goods from the customers order.

customerPhoneNumber
required
number <= 32 characters

Customer phone number

customerEmail
required
string <= 32 characters

Customer email.

customerFirstName
string <= 32 characters

Customer first name

customerLastName
string <= 32 characters

Customer last name.

customerAddress
string <= 32 characters

Customer address.

customerHouseNumber
number <= 32 characters

Customer house number.

customerZip
number <= 32 characters

Customer ZIP.

customerCity
string <= 32 characters

Customer city.

Responses
200

OK – Empty body

400

-> VENDOR_API_VENDOR_UNKNOWN - Unknown vendor API key; VENDOR_API_VENDOR_TRANSACTION_ID_DUPLICATED - Vendor transaction ID has already been sent before; VENDOR_API_MIN_AMOUNT_EXCEEDED - Amount is lower than allowed minimum; VENDOR_API_MAX_AMOUNT_EXCEEDED - Amount is greater than allowed maximum; VENDOR_API_VALID_UNTIL_ERROR - Valid until date is in the past; VENDOR_WRONG_PRODUCT_CODE - Unknown financial product code;

500

Internal application error with unknown reason.

503

Leanpay platform is in maintenance mode.

post/vendor/custom/credit-request
Request samples
application/json
{
  • "vendorApiKey": "d6b5b4ed-833b-43e8-ae44-5724b423ee49",
  • "vendorTransactionId": 1234567890,
  • "amount": "23.59 or 23.6 or 23",
  • "validUntil": 1555688766000,
  • "vendorProductCode": "a4da54b9-54f0-47db-9898-11244a4c9308",
  • "vendorItemDescription": "Laptop computer",
  • "customerPhoneNumber": 38640123456,
  • "customerEmail": "janez@novak.si",
  • "customerFirstName": "Janez",
  • "customerLastName": "Novak",
  • "customerAddress": "Teslova ulica",
  • "customerHouseNumber": 12,
  • "customerZip": 1000,
  • "customerCity": "Ljubljana"
}