Create a refund payment

Create a refund payment on a policy. The refund is created as a pending, externally-collected payment for the negative of the supplied amount (i.e. money paid back to the policyholder). Optionally reference the original payment being refunded via refund_of_payment_id.

Path Params
string
required

Must be a UUID. The unique identifier of the policy.

Body Params
integer
required
≥ 0

The refund amount as a positive integer in cents. The created payment is recorded as the negative of this amount.

string
required

A description of the refund payment.

string

Optional. Must be a UUID. The id of the original payment that this refund relates to.

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json