API Reference
  1. Payment Defaults API
  2. Payment Defaults

End a Payment Default

patch
https://{BASE_URL}/v1/payment-defaults//end

Ends an ACTIVE payment default by providing an end date and an optional end reason.

Only payment defaults with ACTIVE status can be ended.

endDate is required and must be in YYYY-MM-DD format. It cannot be earlier than the payment default's beginDate.

endReason is optional and must be one of the following numeric values:

  • 1 — Settled claim
  • 2 — Assignment of claim
  • 3 — Other

A 404 Not Found error is returned if no payment default with the given ID exists.

Note: With DISPUTED payment defaults, it is possible to send endDate, but the payment default status remains DISPUTED and is not changed to ENDED.

Path Params
integer
required

Unique identifier of the payment default to end.

Body Params
date
required

End date in YYYY-MM-DD format. Cannot be earlier than beginDate.

integer
enum

Reason for ending. Optional.

  • 1 — Settled claim
  • 2 — Assignment of claim
  • 3 — Other
Allowed:
Responses

Updated 10 days ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago

Did this page help you?