List payout requests

get

https://sandbox.uk.rootplatform.com/v1/insurance/payout-requests

Returns a paginated list of payout requests for the organization, most recent first.

Query Params

string

Search payout requests by a free-text search term.

statuses

array of strings

Filter by payout request status. Can be a comma-separated list.

statuses

Allowed:

types

array of strings

Filter by payout request type. Can be a comma-separated list.

types

Allowed:

policy_id

uuid

Filter payout requests by policy ID.

claim_id

uuid

Filter payout requests by claim ID.

annuity_request_id

uuid

Filter payout requests by annuity request ID.

include

array of strings

A comma-separated list of related resources to include in each payout request. One or more of policy, policyholder, payment-method, claim.

include

Allowed:

page_size

integer

1 to 100

Defaults to 30

The maximum number of items that will be contained in a single page, between 1 and 100 (inclusive).

page

integer

≥ 1

Defaults to 1

The page number of the entities to fetch. Must be a minimum of 1.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success