Skip to content
Lili API Documentation
/
Customer Management API
/
Customer Management API

Customer Management API (v2.0.0)

Lili Server API Swagger documentation

Download OpenAPI description
index.json
index.yaml
Overview
URL

https://lili.co

Lili Dev Resources

dev-resources@lili.co

Languages
Servers
Lili Server

https://sandbox.lili.co/

Download Bank Letter

Request

Gets a PDF containing a bank letter for a customer

Security
accessKey
Path
customerIdstringrequired

The customer ID, as provided in the create lead response

curl -i -X GET \
  'https://sandbox.lili.co/lili/api/v1/{customerId}/bankLetter' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Register a payment transaction

Request

Creates a payment notification in the Lili system

Security
accessKey
Bodyapplication/json
customerIdstring
amountnumber
effectiveDatestring(date-time)
payeeNamestring
receiverAccountNumberstring
traceNumberstring
originatorRoutingNumberstring
originatorAccountNumberstring
curl -i -X PUT \
  https://sandbox.lili.co/lili/api/v1/payments \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerId": "string",
    "amount": 0,
    "effectiveDate": "2019-08-24T14:15:22Z",
    "payeeName": "string",
    "receiverAccountNumber": "string",
    "traceNumber": "string",
    "originatorRoutingNumber": "string",
    "originatorAccountNumber": "string"
  }'

Responses

Payment request created

Bodyapplication/json
paymentIdstring

The payment ID

detailsstring

The payment details

statusany

The payment status

Enum"SUCCESS""ACCOUNT_NOT_FOUND""ACCOUNT_CLOSED""NOT_RELEASED_EARLY""TECHNICAL_ERROR""BAD_DATA""EFFECTIVE_DATE_PAST"
Response
application/json
{
  "paymentId": "string",
  "details": "string",
  "status": "SUCCESS"
}

Get a list of payments related to the customer

Request

Get a list of payments related to the customer

Security
accessKey
Query
customerIdstring

The customer ID, as provided in the create lead response

receiverAccountNumberstring

The receiver account number

startDatestring(date-time)

Start date for the payment list

endDatestring(date-time)

End date for the payment list

curl -i -X GET \
  'https://sandbox.lili.co/lili/api/v1/partner/payments?customerId=string&receiverAccountNumber=string&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of payments related to the customer

Bodyapplication/json
paymentItemResponseListArray of objects(PaymentListItemResponse)
Response
application/json
{
  "paymentItemResponseList": [
    { … }
  ]
}
Copyright © Lili App Inc. All rights reserved.