/v1/payments/{id}/allocationsHow one receipt was split
The split of one instalment's receipt — how the money that landed was applied, each line with its allocation type (principal, interest, fee, penalty, commission, buyout, other), currency, amount in minor units and description. Written by post_payments_id_record, which refuses a split that does not add up to the receipt. For the same split summed across a whole schedule reach for get_payment_schedules_id_reconciliation. An instalment belonging to another workspace answers not found.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": [
{
"allocationType": "string",
"amountMinor": 1,
"createdAt": "string",
"currency": "string",
"description": "string",
"id": 1,
"paymentId": 1
}
]
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}