Register and manage payment agreements for recurring billing.
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>.
X-Correlation-IdCorrelation id
Entur-Distribution-ChannelDistribution channel identifier.
Get payment agreement status › Responses
Ok
agreementIdThe unique identifier of the payment agreement.
statusThe current status of the agreement.
productNameName of the product or subscription.
Base pricing model for a payment agreement.
Base provider-specific data in an agreement response.
Update payment agreement
Updates the mutable parts of a payment agreement, both at the provider and locally.
Every field is optional and at least one must be supplied; omitting a field leaves it unchanged. pricing behaves differently: it is replaced wholesale rather than merged, so when supplied it must be complete and valid for the agreement's type — the same agreementType discriminator and the same FixedPricing/VariablePricing schemas as on create.
pricing accepts FIXED and VARIABLE only. FLEXIBLE agreements set their amount per charge, so there is nothing on their pricing to update, and the schema leaves FLEXIBLE out rather than accepting a request that would change nothing. FIXED updates amount and interval; VARIABLE updates suggestedMaxAmount and interval.
agreementType and currency are immutable. They are part of the request so the pricing object stays identical to the one used on create, but their values must match the existing agreement; a mismatch is rejected with 400 rather than silently ignored. Sending pricing for a FLEXIBLE agreement is therefore always a 400.
productName and the provider's merchantAgreementUrl can be changed on every agreement type, including FLEXIBLE.
The agreement must be in status PENDING or ACTIVE.
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>.
X-Correlation-IdCorrelation id
Entur-Distribution-ChannelDistribution channel identifier.
Update payment agreement › Request Body
productNameName of the product or subscription.
Pricing model for an agreement that can be repriced. FLEXIBLE is deliberately absent: its amount is set per charge, so there is nothing on it to update.
Base provider-specific data for updating an agreement. Contains only the fields the provider allows changing after the agreement exists — which is why this is a separate schema from AgreementRequestProviderData.
Update payment agreement › Responses
Ok
agreementIdThe unique identifier of the payment agreement.
statusThe current status of the agreement.
productNameName of the product or subscription.
Base pricing model for a payment agreement.
Base provider-specific data in an agreement response.
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>.
X-Correlation-IdCorrelation id
Query payment agreements › Responses
Ok
agreementIdThe unique identifier of the payment agreement.
statusThe current status of the agreement.
productNameName of the product or subscription.
Base pricing model for a payment agreement.
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>.
X-Correlation-IdCorrelation id
Entur-Distribution-ChannelDistribution channel identifier.
Register a new payment agreement › Request Body
productNameName of the product or subscription.
customerNumberThe customer number for the agreement.
Base pricing model for a payment agreement.
Base provider-specific data for creating an agreement.
Register a new payment agreement › Responses
Created
agreementIdThe unique identifier of the payment agreement.
statusThe current status of the agreement.
productNameName of the product or subscription.
Base pricing model for a payment agreement.
Base provider-specific data in an agreement response.