Entur Developer
Payments
Payments

API Documentation

Server
Download schema

OpenAPI specification endpoints.

Api spec OAS3

GET
https://api.entur.io/sales
/v3/api-docs

Return the OpenApi Specification for the Payment API.

Api spec OAS3 › query Parameters

group
​string · enum · required · style: form · explode: true

The API documentation group to return the specification for.

Enum values:
Payments
Credits
Recurring Payments

Api spec OAS3 › Headers

ET-Client-Name
​string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

Api spec OAS3 › Responses

OK

Api spec OAS3

GET
https://api.entur.io/sales
/v3/api-docs-internal

Return the OpenApi Specification for the Payment Internal API.

Api spec OAS3 › query Parameters

group
​string · enum · required · style: form · explode: true

The API documentation group to return the specification for.

Enum values:
Payment Mending
Cache
Payment Configuration
Kafka

Api spec OAS3 › Headers

ET-Client-Name
​string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

Api spec OAS3 › Responses

OK

ConfigurationsPayment Agreements
Did you find what you were looking for?