Create a payout request

Creates a payout request. The linked_entities object required depends on the type: a claim_payout requires a linked claim, policy and policyholder, while a policy_refund requires a linked policy and may optionally reference the payment or invoice being refunded.

Body Params
string
enum
required

The type of payout request.

Allowed:
number
required

The payout amount as a positive integer in cents.

string
required

A description of the payout request.

payee
object
required

The details of the party receiving the payout.

linked_entities
object

The entities linked to the payout request. For a claim_payout, claim_id, policy_id and policyholder_id are all required. For a policy_refund, policy_id is required and refund_of_payment_id / invoice_id are optional.

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