Mark a pile as paid

POST 
/v1/piles/:pileId/mark-as-paid

Marks a specific pile as paid for an insurer.

Request

Path Parameters

pileId stringrequired

The ID of the pile to be marked as paid

application/json

Body

metadata object

Metadata containing any additional information about the payment made

Responses

200

Pile marked as paid successfully

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Pile marked as paid successfully."
}

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Invalid request."
}

404

Pile not found

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Pile not found."
}

500

Internal Server Error

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "An error occurred while marking the pile as paid."
}

Loading...