Create payment method

post

https://sandbox.uk.rootplatform.com/v1/insurance/policyholders/{policyholder_id}/payment-methods

Create a payment method. Read more about payment methods.

Path Params

policyholder_id

string

required

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

Body Params

type

string

required

The payment method type. debit_order, card, eft, collection_module, or a custom key for external payment methods.

payment_method_key

string

The key of an external payment method type. Use this for external payment methods instead of type.

collection_module_key

string

The key of the collection module to use. Required if type is collection_module.

data

object

Custom data for collection module payment methods. Required if type is collection_module.

payment_method_config_id

string

Must be a UUID. The unique identifier of the payment method configuration to use. Only relevant when Direct Billing Config feature is enabled.

bank_details

object

Required if type is debit_order. Bank details to use for the debit order.

card_details

object

Required if type is card. Cards details to use for the card payment.

policy_ids

array of strings

An optional list of policy ids (each must be a UUID) to which the payment method should be assigned.

policy_ids

external_reference

string

An optional external reference linked to the payment method. Relevant for debit_order and external payment methods.

application_id

string

Must be a UUID. An optional application id to which the payment method should be assigned.

billing_day

integer

Only specify the billing_day when providing policy_ids otherwise it will have no effect. If any of the provided policy_ids belong to once-off or group policies, specifying a billing_day will cause the request to fail. For once-off policies, collection requests are automatically initiated upon payment method assignment, not on specified billing days. Additionally, billing day updates are not allowed for group policies.

Response

Language

Credentials

Basic

base64

URL

Response

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

application/json

200Success