Set up and manage stored payment methods.
Get recurring payments.
Get recurring payments, which are not CANCELLED, for a customer. By default, EXPIRED are not included.
query Parameters
customerNumberQuery for a given customer number
includeExpiredWhether or not to include expired recurring payments. Default false.
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
Get recurring payments. › Responses
Ok
primaryIs the recurring payment the primary recurring payment of the user. There can only be one primary recurring payment at a time. Therefore, changing this status to true might set another recurring payment's isPrimary to false.
expiresAtWhen the recurring payment is no longer valid
maskedPanThe stored card's masked number
paymentTypeThe actual type of payment.
cardExpiresAtThe stored card's expiration date, may be longer than the recurring payment's expiration date, but never shorter.
recurringStatusStatus of this recurring payment
recurringPaymentIdID of the recurring payment
nicknameNickname for the recurring payment
Create a recurring payment.
Creates a new recurring payment with status CREATED and couples it to the customer number sent in the request. If this is the first recurring payment coupled to the customer number it is made to be the primary recurring payment for the customer number. If it is not the first recurring payment, it defaults to not primary. However, if the requests makes it primary, the customers other recurring payment with primary status is set to not primary.
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.
Entur-On-Behalf-OfIdentifier of the organisation on whose behalf the request is made. Use of this header requires a separate agreement before use.
Create a recurring payment. › Request Body
nicknameNickname for the recurring payment
isPrimaryIs the recurring payment the primary recurring payment of the user. There can only be one primary recurring payment at a time. Therefore, changing this status to true might set another recurring payment's isPrimary to false.
customerNumberThe customer number this recurring payment belongs to. This field is optional and will only be considered for certain privileged clients. This value can not be updated.
Create a recurring payment. › Responses
Created
primaryIs the recurring payment the primary recurring payment of the user. There can only be one primary recurring payment at a time. Therefore, changing this status to true might set another recurring payment's isPrimary to false.
expiresAtWhen the recurring payment is no longer valid
maskedPanThe stored card's masked number
paymentTypeThe actual type of payment.
cardExpiresAtThe stored card's expiration date, may be longer than the recurring payment's expiration date, but never shorter.
recurringStatusStatus of this recurring payment
recurringPaymentIdID of the recurring payment
nicknameNickname for the recurring payment
End recurring payment.
Ends a recurring payment, the recurring payment is no longer usable after this call.
path Parameters
recurringPaymentIdrecurringPaymentId
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.
End recurring payment. › Responses
Ok
primaryIs the recurring payment the primary recurring payment of the user. There can only be one primary recurring payment at a time. Therefore, changing this status to true might set another recurring payment's isPrimary to false.
expiresAtWhen the recurring payment is no longer valid
maskedPanThe stored card's masked number
paymentTypeThe actual type of payment.
cardExpiresAtThe stored card's expiration date, may be longer than the recurring payment's expiration date, but never shorter.
recurringStatusStatus of this recurring payment
recurringPaymentIdID of the recurring payment
nicknameNickname for the recurring payment
Update recurring payment.
Updates a recurring payment's nickname and/or isPrimary status. If the recurring payment is set to be the primary recurring payment, the last primary recurring payment is no longer the primary recurring payment.
path Parameters
recurringPaymentIdrecurringPaymentId
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.
Update recurring payment. › Request Body
nicknameNickname for the recurring payment
isPrimaryIs the recurring payment the primary recurring payment of the user. There can only be one primary recurring payment at a time. Therefore, changing this status to true might set another recurring payment's isPrimary to false.
customerNumberThe customer number this recurring payment belongs to. This field is optional and will only be considered for certain privileged clients. This value can not be updated.
Update recurring payment. › Responses
Ok
primaryIs the recurring payment the primary recurring payment of the user. There can only be one primary recurring payment at a time. Therefore, changing this status to true might set another recurring payment's isPrimary to false.
expiresAtWhen the recurring payment is no longer valid
maskedPanThe stored card's masked number
paymentTypeThe actual type of payment.
cardExpiresAtThe stored card's expiration date, may be longer than the recurring payment's expiration date, but never shorter.
recurringStatusStatus of this recurring payment
recurringPaymentIdID of the recurring payment
nicknameNickname for the recurring payment
Create terminal.
Registers the transaction with Nets and returns the location of the payment terminal where the user will provide card information. The terminal is available for 15min before the transaction times out. If this happens a new terminal must be created.
path Parameters
recurringPaymentIdrecurringPaymentId
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.
Create terminal. › Request Body
redirectUrl^(https?://).{0,1024… · requiredLocation to be redirected to from the payment terminal.
autoSaleIf this flag is set to true, the capture call after a customer returns from the terminal is not needed. The processing starts automatically. This is only compatible with payments done with payment cards.
singlePageIf this flag is set to true, we will attempt to generate a single-page terminal. If false, multi-page terminal might be used.
callbackUrlLocation where notification of payment completion will be sent. If this is not provided, then the client will have to check for completion manually by getting the transaction and checking its status. The callback will be repeated until the server receives an HTTP 202 response.
countryCodeISO 3166-1 Alpha 2 country code used for certain terminals (PayPal, Collector). Used to decide which country store the customer wants to use. Default is 'NO'
storePaymentShould the card be stored for recurring payments. If customer is not logged in, the value of this will be disregarded.
customerNumberCustomer number used with recurring payment creation. This field is optional and will only be considered for certain privileged clients.
transactionTypeSet the type of transaction. Only set this field to MIT_UCOF if you want to create a Merchant Initiated Transaction (MIT) which refers to a card payment started by a merchant without the customer being actively involved. If this value is not set, a payment terminal will be created as normal.
terminalLanguageLanguage used in the payment terminal. Default is 'no_NO'.
Create terminal. › Responses
Created
terminalUriLocation of the payment terminal.
paymentIdID of the payment the transaction belongs to. Used with the transactionId to later capture transaction.
transactionIdID of the transaction this terminal belongs to. Used with the paymentId to later capture transaction.
recurringPaymentIdID of the recurring payment this terminal belongs to.
Authorize a recurring payment.
Authorize the card details provided by the customers in the terminal were valid and accepted by Nets and by calling Nets with a process call. If valid, the recurring payment has its status set to ACTIVE and the returned pan hash is stored. This pan hash is later used when paying with a recurring payment.
path Parameters
recurringPaymentIdrecurringPaymentId
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.
Authorize a recurring payment. › Responses
Ok
primaryIs the recurring payment the primary recurring payment of the user. There can only be one primary recurring payment at a time. Therefore, changing this status to true might set another recurring payment's isPrimary to false.
expiresAtWhen the recurring payment is no longer valid
maskedPanThe stored card's masked number
paymentTypeThe actual type of payment.
cardExpiresAtThe stored card's expiration date, may be longer than the recurring payment's expiration date, but never shorter.
recurringStatusStatus of this recurring payment
recurringPaymentIdID of the recurring payment
nicknameNickname for the recurring payment