Skip to main content
POST
/
payments
Import a payment
curl --request POST \
  --url https://api.leanpay.fr/v1/public/payments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 1,
  "date": "2023-12-25",
  "externalId": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "date": "2023-12-25",
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.leanpay.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Body

application/json

Payment object to import

​
invoiceId
string<uuid>
required
​
amount
integer
required
Required range: x >= 0
​
date
string<date>
required
​
externalId
string | null
Maximum string length: 80

Response

Returns the imported payment

​
id
string<uuid>
​
tenantId
string<uuid>
​
clientId
string<uuid>
​
invoiceId
string<uuid>
​
amount
integer
​
date
string<date>
​
externalId
string | null
​
createdAt
string<date-time>
​
updatedAt
string<date-time>