Validate deduction amounts

POST

https://api.opensylo.com/api/v1/marketplace/loans/deductions/validate

Given a sale amount, calculates how much should be deducted for each active loan.
Use this before settlement to determine the correct deduction breakdown.

Deductions are capped at the outstanding balance per loan and the total
sale amount. A valid_until timestamp indicates when the calculation expires
(typically 15 minutes).

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

🟢200OK

application/json

Deduction validation result.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success Example

{
    "merchant": {
        "opensylo_id": "mch_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "marketplace_id": "PLT_MERCH_001",
        "name": "Adebayo Electronics"
    },
    "sale_amount": 50000,
    "should_deduct": true,
    "deductions": [
        {
            "loan_id": "loan_f1e2d3c4-b5a6-7890-1234-567890abcdef",
            "reference": "OSL-2026-00142",
            "status": "repaying",
            "deduction_percentage": 10,
            "calculated_amount": 5000,
            "outstanding_balance": 1380000,
            "capped_amount": 5000
        }
    ],
    "summary": {
        "total_deduction": 5000,
        "merchant_receives": 45000,
        "loans_count": 1
    },
    "valid_until": "2026-04-07T10:45:00.000Z",
    "timestamp": "2026-04-07T10:30:00.000Z"
}

Modified at 2026-06-10 14:59:29

Get loan status

Bulk loan status