Register and manage payment agreements for recurring billing.
Query payment agreements
Returns payment agreements for a given customer across all organisations the caller has access to. Optionally filter by one or more statuses.
query Parameters
customerNumberCustomer number to query agreements for. Required.
statusOptional. Filter by one or more agreement statuses.
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Query payment agreements › Responses
Ok
statusThe current status of the agreement.
Base pricing model for a payment agreement.
agreementIdThe unique identifier of the payment agreement.
productNameName of the product or subscription.
Base provider-specific data in an agreement response.
Register a new payment agreement
Registers a payment agreement with the specified provider. For Vipps, this drafts the agreement and returns a confirmation URL to redirect the customer to.
Headers
Entur-POSPoint-of-sale identifier.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Distribution-ChannelDistribution channel identifier.
Register a new payment agreement › Request Body
Base pricing model for a payment agreement.
productNameName of the product or subscription.
Base provider-specific data for creating an agreement.
customerNumberThe customer number for the agreement.
Register a new payment agreement › Responses
Created
statusThe current status of the agreement.
Base pricing model for a payment agreement.
agreementIdThe unique identifier of the payment agreement.
productNameName of the product or subscription.
Base provider-specific data in an agreement response.
Get payment agreement status
Returns the current status and details of a payment agreement. The Vipps confirmation URL is only included while the agreement is pending customer confirmation (CREATED or PENDING status).
path Parameters
agreementIdagreementId
Headers
Entur-POSPoint-of-sale identifier.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Entur-Distribution-ChannelDistribution channel identifier.
Get payment agreement status › Responses
Ok
statusThe current status of the agreement.
Base pricing model for a payment agreement.
agreementIdThe unique identifier of the payment agreement.
productNameName of the product or subscription.
Base provider-specific data in an agreement response.