Create Payment Intent

The Payment intent is the contract between your backend and Lean to certify that you will request a payment from your customer of a specified amount and currency. In order to initiate a payment, the payment_intent_id must be provided into the pay() or checkout() method of the LinkSDK.

Request body

customer_idstring uuid required

The Customer you want to make a payment.

amountnumber float required

The amount that should be charged to the customer.

currencystring required

The currency that the customer will make the payment in.

descriptionstring

The description submitted to the bank as a reference when initiating a payment. Can be used for reconciliation. By default this value is a the Payment Intent UUID without hyphens but you can also specify the description upon creation of a payment intent.

payment_destination_idstring

Payment destination for where funds are settled into.

purpose_code'FIS' | 'TCS' | 'MWP' | 'OAT' | 'IFS' | 'RNT' | 'LNC' | 'PIN' | 'GDS'

A category code that relates to the type of services or goods that corresponds to the underlying purpose of the payment. The code must conform to the payment purpose code list.
Supported values:

FIS – Financial services
TCS – Telecommunication services
MWP – Mobile wallet card payments
OAT – Own account transfer
IFS – Information services
RNT – Rent payments
LNC – Loan charges
PIN – Personal investments
GDS – Goods bought or sold

Example request

{
  "amount": 120.43
}

Response

payment_intent_idstring uuid required

The unique identifier for the Payment Intent.

customer_idstring required

The Customer object associated with the Payment Intent.