Credit Flow Guide
This document describes the state change flow in the Credit Management System (CMS) at the API level, covering the stages of creation, approval, adding invoice, and credit conversion.
API of the Credit Management System (CMS)
Flows and States
General Credit Flow
- Flow creation: Creation of the credit flow by the Partner system.
- Flow approval: The created flow is reviewed and approved.
- Add invoices: Once approved, invoices can be subscribed to the flow, generating a debt for each invoice.
- Debt generation: A debt associated with the flow can also be generated directly without an invoice.
- Flow expiration: If no invoice has been sent or debt generated within a certain period of time, the flow expires and cannot be converted into a debt.
By default, the client's credit line is reserved in step 2 (approval). However, the system can be configured to reserve the client's credit line at the time of flow creation.
Sequence Diagram
Debt creation flow through invoices
If you want a credit flow to be converted into multiple debts associated with invoices, the following workflow is recommended:
A common use case for this flow is a "shopping cart" in BNPL (Buy Now Pay Later) where the final purchase amount is unknown until billing. It is even considered that several invoices associated with the same shopping cart can be generated. Each invoice is recorded in the system, and a corresponding debt is generated.
Direct debt creation flow
If the intention of the credit flow is to directly transition to a debt, the following workflow is recommended:
A common use case for this flow is the origination of a traditional debt that must be disbursed directly to the client.
Cancellation Flow
- Flow creation: The process begins with the creation of the financial flow.
- Flow cancellation: The created flow is canceled.