{"items":[{"type":"link","label":"Customer Management API","link":"/apis/customermanagement","routeSlug":"/apis/customermanagement","content":{"contentType":"overview","meta":{"name":"Customer Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/apis/customerManagement/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/apis/customerManagement/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://lili.co","url":"https://lili.co"},{"kind":"email","title":"Lili Dev Resources","email":"dev-resources@lili.co","label":"dev-resources@lili.co","withCopyButton":true,"copyContent":"dev-resources@lili.co"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"Lili Server","url":"https://sandbox.lili.co"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Customer Management API (v2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Lili Server API Swagger documentation"}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"label":"Download Bank Letter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/customermanagement/other/createpaymentnotification","routeSlug":"/apis/customermanagement/other/createpaymentnotification","metadata":{"seo":{"title":"Download Bank Letter","description":"Gets a PDF containing a bank letter for a customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentNotification","name":"Download Bank Letter","isWebhook":false,"pointer":"/paths/~1lili~1api~1v1~1lead~1{customerId}~1bankLetter/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Bank Letter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a PDF containing a bank letter for a customer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"accessKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization in the format:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Lili accessKey:secretKey"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_0","description":"The customer ID, as provided in the create lead response","required":true}],"pointer":"/paths/~1lili~1api~1v1~1lead~1{customerId}~1bankLetter/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lili/api/v1/lead/{customerId}/bankLetter","servers":[{"url":"https://sandbox.lili.co","description":"Lili Server"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accessKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":[],"pointer":"/lili/api/v1/lead/{customerId}/bankLetter","href":"other/createpaymentnotification","openApiOperationId":"createPaymentNotification","summary":"Download Bank Letter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.lili.co","description":"Lili Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[],"pointer":"/paths/~1lili~1api~1v1~1lead~1{customerId}~1bankLetter/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/createpaymentnotification"}],"panels":[]}]},"httpPath":"/lili/api/v1/lead/{customerId}/bankLetter"},{"label":"Register a payment transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/customermanagement/other/createpaymentnotification","routeSlug":"/apis/customermanagement/other/createpaymentnotification","metadata":{"seo":{"title":"Register a payment transaction","description":"Creates a payment notification in the Lili system"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentNotification","name":"Register a payment transaction","isWebhook":false,"pointer":"/paths/~1lili~1api~1v1~1payments/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a payment transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a payment notification in the Lili system"},{"nodeType":"security","requirements":[{"schemes":[{"name":"accessKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization in the format:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Lili accessKey:secretKey"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentRequest"}},"schemaId":"components/schemas/PaymentRequest","pointer":"/paths/~1lili~1api~1v1~1payments/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/lili/api/v1/payments","servers":[{"url":"https://sandbox.lili.co","description":"Lili Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accessKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentRequest"}},"responseCodes":["200"],"pointer":"/lili/api/v1/payments","href":"other/createpaymentnotification","openApiOperationId":"createPaymentNotification","summary":"Register a payment transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.lili.co","description":"Lili Server"}],"schemaId":"components/schemas/PaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment request created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponse"}},"schemaId":"components/schemas/PaymentResponse"}],"pointer":"/paths/~1lili~1api~1v1~1payments/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/createpaymentnotification"}],"panels":[]}]},"httpPath":"/lili/api/v1/payments"},{"label":"Get a list of payments related to the customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/customermanagement/other/paymentlist","routeSlug":"/apis/customermanagement/other/paymentlist","metadata":{"seo":{"title":"Get a list of payments related to the customer","description":"Get a list of payments related to the customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paymentList","name":"Get a list of payments related to the customer","isWebhook":false,"pointer":"/paths/~1lili~1api~1v1~1partner~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of payments related to the customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of payments related to the customer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"accessKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization in the format:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Lili accessKey:secretKey"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customerId","in":"query","schemaId":"schema_0","description":"The customer ID, as provided in the create lead response"},{"name":"receiverAccountNumber","in":"query","schemaId":"schema_0","description":"The receiver account number"},{"name":"startDate","in":"query","schemaId":"schema_1","description":"Start date for the payment list"},{"name":"endDate","in":"query","schemaId":"schema_1","description":"End date for the payment list"}],"pointer":"/paths/~1lili~1api~1v1~1partner~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lili/api/v1/partner/payments","servers":[{"url":"https://sandbox.lili.co","description":"Lili Server"}],"parameters":{"path":[],"query":[{"name":"customerId","in":"query","required":false,"schemaId":"schema_0"},{"name":"receiverAccountNumber","in":"query","required":false,"schemaId":"schema_0"},{"name":"startDate","in":"query","required":false,"schemaId":"schema_1"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"accessKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/lili/api/v1/partner/payments","href":"other/paymentlist","openApiOperationId":"paymentList","summary":"Get a list of payments related to the customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.lili.co","description":"Lili Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payments related to the customer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentListResponse"}},"schemaId":"components/schemas/PaymentListResponse"}],"pointer":"/paths/~1lili~1api~1v1~1partner~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/paymentlist"}],"panels":[]}]},"httpPath":"/lili/api/v1/partner/payments"}],"store":{"schemaStore":{"components/schemas/JsonErrorResponse":{"id":"components/schemas/JsonErrorResponse","kind":"json-schema","title":"JsonErrorResponse","data":{"type":"object","description":"An object representing a server error","properties":{"httpStatus":{"type":"integer","description":"The http status of the error"},"reasonPhrase":{"type":"string","description":"Human readable description of the error"},"errors":{"description":"A list of all the errors that the server reported","type":"array","items":{"$ref":"#/components/schemas/JsonSingleError"}}}}},"components/schemas/JsonSingleError":{"id":"components/schemas/JsonSingleError","kind":"json-schema","title":"JsonSingleError","data":{"type":"object","properties":{"code":{"type":"integer","description":"A unique numeric code representing the error"},"codeName":{"type":"string","description":"A unique string code representing the error"},"message":{"type":"string","description":"Human readable description of the error"},"localizedMessage":{"type":"string","description":"Human readable description of the error, localized"}},"description":"A specific server error","x-internal":false}},"components/schemas/PaymentListResponse":{"id":"components/schemas/PaymentListResponse","kind":"json-schema","title":"PaymentListResponse","data":{"title":"PaymentListResponse","type":"object","properties":{"paymentItemResponseList":{"type":"array","items":{"$ref":"#/components/schemas/PaymentListItemResponse"}}}}},"components/schemas/PaymentListItemResponse":{"id":"components/schemas/PaymentListItemResponse","kind":"json-schema","title":"PaymentListItemResponse","data":{"title":"PaymentListItemResponse","type":"object","properties":{"paymentId":{"type":"string","description":"The payment ID"},"submissionDate":{"type":"string","format":"date-time","description":"The payment submissiondate"},"status":{"enum":["CREATED","PROCESSED","FAILED"]}}}},"components/schemas/PaymentResponse":{"id":"components/schemas/PaymentResponse","kind":"json-schema","title":"PaymentResponse","data":{"title":"PaymentResponse","type":"object","properties":{"paymentId":{"type":"string","description":"The payment ID"},"details":{"type":"string","description":"The payment details"},"status":{"enum":["SUCCESS","ACCOUNT_NOT_FOUND","ACCOUNT_CLOSED","NOT_RELEASED_EARLY","TECHNICAL_ERROR","BAD_DATA","EFFECTIVE_DATE_PAST"],"description":"The payment status"}}}},"components/schemas/PaymentRequest":{"id":"components/schemas/PaymentRequest","kind":"json-schema","title":"PaymentRequest","data":{"title":"PaymentRequest","type":"object","properties":{"customerId":{"type":"string"},"amount":{"type":"number"},"effectiveDate":{"type":"string","format":"date-time"},"payeeName":{"type":"string"},"receiverAccountNumber":{"type":"string"},"traceNumber":{"type":"string"},"originatorRoutingNumber":{"type":"string"},"originatorAccountNumber":{"type":"string"}}}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_1"}},"exampleStore":{},"securitySchemeStore":{"accessKey":{"id":"accessKey","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authorization in the format:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Lili accessKey:secretKey"},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"specVersion":"3.0.1","servers":[{"url":"https://sandbox.lili.co","description":"Lili Server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/customermanagement","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/customerManagement/index.json?download"},{"url":"/_bundle/apis/customerManagement/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Customer Management API","description":"Lili Server API Swagger documentation"}},"baseSlug":"/apis/customermanagement","routesMapping":{}}