Skip to main content
POST
Charge Repayment

Overview

Initiates a repayment charge for an active loan. All amounts are in kobo.
Note: The :loanId path parameter is the loan ID (field loan_id on the application record, populated after disbursement) — not the application_id.

Request

Method: POST
URL: /v1/loans/:loanId/repayments

Parameters

Request Body

Response

200 OK

Error Responses

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Path Parameters

loanId
string
required

Loan ID from the application record (loan_id field, not application_id)

Body

application/json

Provide the required values for the request body.

amount
number
required

Repayment amount in kobo

Example:

7199999

reference
string
required

Merchant-supplied repayment reference

Example:

"REPAY_REF_20250215_001"

Response

200 - application/json

Successful response

The response is of type object.