v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB

Payment Intents

Get 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() method of the LinkSDK.

get/payments/v1/intents/{payment_intent_id}

Path parameters

payment_intent_idstring required

Response

payment_intent_idstring uuid required

The unique identifier for the Payment Intent.

customer_idstring required

The Customer object associated with the Payment Intent.

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 required

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.

Example response

{
  "currency": "AED"
}