List payment methods

get

https://sandbox.uk.rootplatform.com/v1/insurance/payment-methods

Returns a paginated list of payment methods for the organization. Use the include parameter to include related objects in the response.

Query Params

page

integer

Defaults to 1

The page number to retrieve.

page_size

integer

Defaults to 20

The number of items to retrieve per page.

include

array of strings

A comma-separated list of related objects to include in the response. Valid values are policyholder, policies, collection_module.

include

type

string

Filter by payment method type. Valid values include debit_order, card, eft, collection_module, or a custom external payment method key.

banv_status

array of strings

Filter by BANV status. Accepts multiple values.

banv_status

policyholder_ids

array of strings

Filter by policyholder IDs. Accepts multiple UUIDs.

policyholder_ids

payment_method_ids

array of strings

Filter by payment method IDs. Accepts multiple UUIDs.

payment_method_ids

dismissed

boolean

Filter by dismissed status. Set to true to include only dismissed payment methods, false to exclude dismissed payment methods.

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