Record a partial commission payment

POST

/commission-payouts/record-payment

Maintainer:Not configured

Creates a new CommissionPayout tranche for the given gross amount (TDS is computed
automatically from the commission's snapshotted TDS rate). The payout is created in
PENDING_APPROVAL status and must go through the normal approve → pay workflow.

This endpoint mirrors how a receipt is recorded against a DemandSplit for partial
customer-payment tracking. Multiple partial payments can be recorded against the
same commission; the commission status is updated to PARTIALLY_PAID or PAID
once the payout tranche is marked as paid via PUT /{id}/pay.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

x-tenant-id

Example:

x-tenant-id: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Partial payout tranche created

Body

🟠400

🟠404

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/commission-payouts/record-payment' \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "commissionId": "da9cbd26-0027-446f-ab38-79db949c5cf9",
    "grossAmount": 0,
    "triggerEvent": "string",
    "paidDate": "2019-08-24",
    "transactionRef": "string",
    "notes": "string"
}'

Response Example

201 - Success

{
    "id": "new-payout-uuid",
    "commission": "comm-uuid",
    "booking": "booking-uuid",
    "triggerEvent": "Partial Payment 1 of 2",
    "grossAmount": {
        "amount": 50000,
        "currency": "INR"
    },
    "tdsDeducted": {
        "amount": 2500,
        "currency": "INR"
    },
    "netPayable": {
        "amount": 47500,
        "currency": "INR"
    },
    "status": "PENDING_APPROVAL"
}

Modified at 2026-04-16 18:43:47

Send commission payout notification

List all commission payouts