Payments

Creating payments

It's essential to record your customer's loan payments in MO so that the system can accurately track loan repayment progress. This process is done by informing the details of each payment, by following these steps:

1. Make an API call to the Create payment endpoint.
2. Add the required information to the request payload. The available fields of the payload are:

Field	Description	Required	Example
customer_id	Identifier for the customer	Yes	3fa85f64-5717-4562-b3fc-2c963f66afa6
loan_id	Identifier for the loan	Yes	5e8bbdc5-6c46-4c80-a43d-66fb8a410105
amount	Loan amount	Yes	100.00
external_id	The external identifier for the loan	No	YOUR_EXTERNAL_SYSTEM_ID
application_mode	Mode of loan application	Yes	installment

3. Send the request.

The response JSON will present you with details about every payment from the respective loan, including this one. Below is an example of the returned JSON:

JSON

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "loan_payments": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "amount": 100,
        "loan": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "reference": "string",
          "external_id": "string"
        }
      },
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "amount": 100,
        "loan": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "reference": "string",
          "external_id": "string"
        }
      }
    ]
  },
  "metadata": {
    "timestamp": "2023-08-30T16:30:00Z",
    "version": "2"
  },
  "errors": []
}

Definition of payment status: Pre-Payments & Payments

Payments:

• Pending: first automatic status of each payment. The payment has not been confirmed yet.
• Rejected: The payment was not approved. The process ends.
• Completed: The payment was confirmed and becomes an accepted payment.
• Reversed: Proactive status where the payment is returned to the user because the user committed fraud, won a dispute, a refund or rejection of the purchase was made after payment or because of a business rule..
  Actions allowed: not applicable.