Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldline Account - Insurance Contract API

Account Insurance Contract Api Controller

Worldline Account - Insurance Contract API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account - Insurance Contract. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 6 paths, and defines 30 schemas. It is described by OpenAPI 2.0, at version 2.41.1.

Requests are made against the base URL https://api.connect.worldline-solutions.com.

10 operations 6 paths 30 schemas 2 DELETE4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.41.1
Base URL
https://api.connect.worldline-solutions.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Worldline Account - Insurance Contract API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Account - Insurance Contract 10

Account Insurance Contract Api Controller

GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts
List insurance contracts for an account by external reference
listInsuranceContractsByIssuerAccExtRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts
Create insurance contract by external reference
createInsuranceContractByIssuerAccExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}
Retrieve an insurance contract for an account by external reference
retrieveInsuranceContractByIssuerAccExtRef 8 params → 400401403404500502200
DELETE
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}
Close insurance contract by external reference
closeInsuranceContractByIssuerAccExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}/insurance-events
Add an insurance event to insurance contract for an account by external reference
createInsuranceEventByIssuerAccExtRef 8 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/insurance-contracts
List insurance contracts for an account
listInsuranceContracts 6 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/{accountReference}/insurance-contracts
Create insurance contract
createInsuranceContract 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}
Retrieve an insurance contract for an account
retrieveInsuranceContract 8 params → 400401403404500502200
DELETE
/issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}
Close insurance contract
closeInsuranceContract 7 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}/insurance-events
Add an insurance event to insurance contract for an account
createInsuranceEvent 8 params → 400401403404500502200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are InsuranceContract (10 properties), ResponseMetadata (6 properties), BadGatewayResponseMetadata (4 properties), BadRequestResponseMetadata (4 properties). Each schema is shown below with its type and property counts.

NotFoundErrorApiResponse
object
1 property 1 required
BadGatewayErrorApiResponse
object
1 property 1 required
CreateInsuranceEventResponse
object
2 properties 2 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
UnauthorizedErrorApiResponse
object
1 property 1 required
InsuranceContractIdentifier
object
The insurance package which is linked to this contract
1 property
CreateInsuranceContractResponse
object
2 properties 2 required
Links
object
2 properties 1 required
InsurancePackageIdentifier
object
Unique identifier of the insurance contract package
1 property
UnauthorizedResponseMetadata
object
4 properties 4 required
InsuranceEvent
object
3 properties
ApiResponseEntityListInsuranceContract
object
Issuer response entity
2 properties 1 required
CreateInsuranceContractRequest
object
2 properties 1 required
NotFoundResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
AccountIdentifier
object
2 properties
ApiResponseEntityCreateInsuranceEventResponse
object
Issuer response entity
2 properties 1 required
ApiResponseEntityCreateInsuranceContractResponse
object
Issuer response entity
2 properties 1 required
ForbiddenErrorApiResponse
object
1 property 1 required
CloseInsuranceContractResponse
object
2 properties 2 required
ApiResponseEntityInsuranceContract
object
Issuer response entity
2 properties 1 required
CreateInsuranceEventRequest
object
3 properties 2 required
InsuranceContractPackage
object
2 properties
BadRequestResponseMetadata
object
4 properties 4 required
InsuranceContract
object
10 properties
BadGatewayResponseMetadata
object
4 properties 4 required
ApiResponseEntityCloseInsuranceContractResponse
object
Issuer response entity
2 properties 1 required
BadRequestErrorApiResponse
object
1 property 1 required
ForbiddenResponseMetadata
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-account-insurance-contract-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
Worldline Direct (Global Online Pay) API
Worldline Acquiring API
Worldline Financial Services Issuing API
Worldline Financial Services Acquiring API
Worldline Open Banking API
Worldline SmartPOS API
Worldline Identity and Authentication API
Worldline Account - AccountState API
Worldline Account API
Worldline Account - Authorization API
Worldline Account - Authorization Restriction API