Create refund
API Refs
- Staging: Create refund
This endpoint creates a refund for a specific policyholder.
Request body
Name | Type | Description | Required |
---|---|---|---|
policyholderId | number | ID of the policyholder receiving the refund | yes |
amount | number | The amount to be refunded | yes |
memo | string | A short description for the refund | no |
Response
The response will include the details of the created refund, including its status.
Name | Type | Description |
---|---|---|
id | number | Unique refund identifier |
policyholderId | number | ID of the policyholder |
amount | number | Refund amount |
memo | string | Refund memo |
status | object | Current status of the refund |
createdAt | string | Date of creation (ISO 8601) |
policyholder | object | Policyholder details |
Example
{
"policyholderId": 123,
"amount": 100.00,
"memo": "Refund for policy cancellation"
}
Updated 1 day ago