Validate deduction amounts

POST

/api/v1/marketplace/loans/deductions/validate

Before applying deductions to a merchant's sale, call this endpoint to calculate the correct deduction amounts across all active loans. The validation result is valid for 15 minutes.

Required scope: repayment.report

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Deduction validation result

Body

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.opensylo.com/api/v1/marketplace/loans/deductions/validate' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchant_id": "your_merchant_id",
    "merchant_id_type": "marketplace",
    "sale_amount": 50000
}'

Response Example

200 - Success

{
    "merchant": {
        "opensylo_id": "merchant_uuid",
        "marketplace_id": "your_merchant_id",
        "name": "Yakoyo Foods Ltd"
    },
    "sale_amount": 50000,
    "should_deduct": true,
    "deductions": [
        {
            "loan_id": "loan_uuid",
            "reference": "LOAN-2026-001",
            "status": "DISBURSED",
            "deduction_percentage": 10,
            "calculated_amount": 5000,
            "outstanding_balance": 325000,
            "capped_amount": 5000
        }
    ],
    "summary": {
        "total_deduction": 5000,
        "merchant_receives": 45000,
        "loans_count": 1
    },
    "valid_until": "2026-01-29T12:15:00.000Z",
    "timestamp": "2026-01-29T12:00:00.000Z"
}

Modified at 2026-01-29 23:19:05

Get loan status

Bulk loan status check