How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Root Insurance

Root Insurance Payments API

The Payments API from Root Insurance — 6 operation(s) for payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Root Insurance Payments API is one of 19 APIs that Root Insurance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 6 operations across 6 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against 4 base URLs: https://sandbox.uk.rootplatform.com/v1/insurance, https://api.uk.rootplatform.com/v1/insurance, https://sandbox.rootplatform.com/v1/insurance, https://api.rootplatform.com/v1/insurance.

6 operations 6 paths 23 schemas 1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://api.rootplatform.com/
Authentication
HTTP Basic
Contact
Root support team
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Root Insurance Payments API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payments 6
PATCH
/payment-batches/{payment_batch_id}
Update a payment batch
update-payment-batch 2 params body → 200
POST
/payments/async-createdeprecated
Create payments async
async-payments-create 1 param body → 200
POST
/payments/async-update
Update payments async
update-payments-async 1 param body → 200
PUT
/payments/{payment_id}
Update payment
update-payment 2 params body → 200
POST
/scheduled-payments/{scheduled_payment_id}/reschedule
Reschedule a scheduled payment
reschedule-scheduled-payment 2 params body → 200409
POST
/scheduled-payments/{scheduled_payment_id}/unschedule
Unschedule a scheduled payment
unschedule-scheduled-payment 2 params body → 200409

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are policy (41 properties), payment-response (26 properties), policyholder (26 properties), payment-method (18 properties). Each schema is shown below with its type and property counts.

premium-type
string
The type of the payment being created.Required when paymenttype is premium or reversal, optional when paymenttype is premiumrefund, forbidden otherwise.
payment-updates
array
policyholder
object
26 properties 9 required
actor-type
string
The actor who created the record.
payment-response
object
26 properties
beneficiary-relationship
string
The beneficiary's relationship to the policyholder.
policy-status
string
The policy status. See the [managing policies](https://docs.rootplatform.com/docs/policy-administrationpolicy-lifecycle) guide for more details on the policy l…
payment-batch
object
18 properties 18 required
failure-action
string
The additional action to perform when processing a failed payment. blockpaymentmethod: Set the payment method's verification status to blocked, and do not gene…
policy
object
Policies are issued from applications, and represent binding insurance agreements. Parameters stored on the policy can be referenced in custom notifications, p…
41 properties 28 required
payment-charge-type
string
Variable charges are applied as a proportion of the total payment amount. Fixed charges are applied as an absolute currency value in cents. The balance is the…
payment-type
string
The type of the payment being created.
payment-method
object
18 properties 5 required
collection-type
string
The collection type of the payment being created.
beneficiaries
array
null is allowed. An array of beneficiaries. If null, the default beneficiary may be the policyholder if enabled in the product module settings. Some product mo…
payment-create-async
payment-create
object
15 properties 7 required
payment-update
object
5 properties 2 required
payment-details
object
Details of the account into which the payout should be made.
2 properties 2 required
bank-name
string
The name of the bank
payment-status
string
The status to which to create the payment.
cellphone-string
stringnull
null and "" allowed. String containing the cellphone number in international format.
payment-creates-async-array
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

root-payments-api-openapi.yml Raw ↑

Other APIs Root Insurance publishes across the network.

Root Bind API
AE Profile APIs.io
Root Insurance Applications API
AE Profile APIs.io
Root Insurance Calls API
AE Profile APIs.io
Root Insurance Claims API
AE Profile APIs.io
Root Insurance Complaints API
AE Profile APIs.io
Root Insurance Data exports API
AE Profile APIs.io
Root Insurance Data stores API
AE Profile APIs.io
Root Insurance Embed API
AE Profile APIs.io
Root Insurance Files API
AE Profile APIs.io
Root Insurance Leads API
AE Profile APIs.io
Root Insurance Notifications API
AE Profile APIs.io
Root Insurance Payment Methods API
AE Profile APIs.io
#Payments
← Back to R APIs
API Details
ID
root:root-payments-api
Base URL
https://api.rootplatform.com/
Docs
https://docs.rootplatform.com/docs/overview
Provider
Root Insurance
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=root-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/root-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Root Insurance Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.