Create, update, deactivate and retrieve payments. Create, initiate, capture, cancel, and retrieve payment transactions
Search for payments.
Returns matching payments with all its transactions. Query params are able to used expression like gt:1 for searching. Other expressions can contain eq, ne, gt, gte, lt, lte.
query Parameters
cardNumberLast 4 digits in card number used in transaction for payment
createdAtcurrencyCurrencies
customerNumberNumeric id of customer
externalTransactionIdTransaction ID from 3rd party payment provider
orderIdOrder IDs
orderVersionOrder version
organisationIdorganisationId of the customer company
pageSelects a specific page in the collection
paymentIdPayment IDs
paymentTransactionIdId of (one of) the PaymentTransaction(s) performed as part of the payment
paymentTypeType of payment transaction
paymentTypeGroupThe PaymentTypeGroup the payment type belongs to
perPageSelects the number of elements per page
rrnReconciliation reference number used to track a transaction through different economy systems.
settlementIdstatusStatus of transaction relating to payment
totalAmountTotal amounts
updatedAtHeaders
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
Search for payments. › Responses
OK
Items on a specific page
totalItemsTotal number of items
totalPagesTotal number of pages available to browse
Create a new payment.
Create a new payment. You may either create the payment without transactions and add them later, or include an initial transaction whose amount matches the payment total. Note that Entur can deactivate a payment method temporarily. If you include a transaction in this request, make sure its payment method is available by retrieving all current available methods first via GET /v1/payment-methods.
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 new payment. › Request Body
orderIdId of the order this payment belongs to.
totalAmount^[1-9][0-9]{0,17}\.[… · requiredAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
orderVersionVersion of the order this payment belongs to.
currency[A-Z]{3}3-letter ISO 4217 currency code. Default is NOK.
Information used to create a transaction.
settlementIdSupplied to the client by an external system for handling settlements. For Internal Entur Clients this is Entur’s Electronic Journal.
customerNumberCustomer who owns this payment. This value is only considered for privileged client (internal and partner tenants.
Create a new payment. › Responses
Created
orderIdId of the order this payment belongs to.
currency3-letter ISO 4217 currency code. Default is NOK.
createdAtTimestamp for when payment was created.
paymentIdId of payment
totalAmountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Editable: true
orderVersionVersion of the order this payment belongs to.
organisationIdId of the organisation who created this payment.
activeThis is to block any transactions after the corresponding order version is reset. Clients importing transactions need to either cancel or credit each transaction externally, and the credit the transaction directly using the transaction's credit endpoint. To continue using the same order id, the payment has to be reactivated with the correct total amount before any new actions can be made to this payment. Editable: true
updatedAtTimestamp for when payment was last updated.
settlementIdSupplied to the client by an external system for handling settlements. For Internal Entur Clients this is Entur’s Electronic Journal.
customerNumberID of the customer who owns this payment.
List of all transactions belonging to this payment.
Find all Payment Methods.
Find all Payment Methods for a specific clientId. This method uses the Entur-Distribution-Channel header as a filter to show only those payment methods with the distributionChannelId matching this header.
query Parameters
paymentTypeFilter by PaymentType
The actual type of payment.
paymentTypeGroupFilter by PaymentTypeGroup
A PaymentTypeGroup used to override which kind of method to use for reimbursement, instead of using same as used for the payment transaction.This will only take effect if the payment method on the payment transaction allows for overriding.
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
Entur-Distribution-ChannelDistribution channel identifier.
Find all Payment Methods. › Responses
OK
idUnique identifier for a payment method.
paymentTypeGroupGroup for the payment type. Payment types which are payment cards is in the PAYMENTCARD group.
distributionChannelIdDistribution Channels controls which organisations can sell, refund or inform on available products or salepoints.
clientIdID of the client this payment method belongs to. This ID is the one found in the client's token.
paymentTypeThe actual type of payment.
Current payment configuration set up for psp-client relationship.
Fee related to a payment method.
Get a payment.
Returns the payment with all its transactions.
path Parameters
paymentIdpaymentId
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 a payment. › Responses
Ok
orderIdId of the order this payment belongs to.
currency3-letter ISO 4217 currency code. Default is NOK.
createdAtTimestamp for when payment was created.
paymentIdId of payment
totalAmountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Editable: true
orderVersionVersion of the order this payment belongs to.
organisationIdId of the organisation who created this payment.
activeThis is to block any transactions after the corresponding order version is reset. Clients importing transactions need to either cancel or credit each transaction externally, and the credit the transaction directly using the transaction's credit endpoint. To continue using the same order id, the payment has to be reactivated with the correct total amount before any new actions can be made to this payment. Editable: true
updatedAtTimestamp for when payment was last updated.
settlementIdSupplied to the client by an external system for handling settlements. For Internal Entur Clients this is Entur’s Electronic Journal.
customerNumberID of the customer who owns this payment.
List of all transactions belonging to this payment.
Update a payment.
The payment will be patched with specified fields. NULL values specifically set is considered as removing the field. In other words, only included fields will be modified. As of now, the only editable field is 'totalAmount' and 'active' (only for activation, not deactivation). For more information about the PATCH endpoint and the merge-patch content-type, please refer to RFC7396.
path Parameters
paymentIdpaymentId
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 a payment. › Request Body
totalAmountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Editable: true
activeActive is used during activation of payment
settlementIdId of a settlement used to identify on-site payments i.e. mobile terminals, ticket vending machines and customer service help-desks.
Update a payment. › Responses
OK
orderIdId of the order this payment belongs to.
currency3-letter ISO 4217 currency code. Default is NOK.
createdAtTimestamp for when payment was created.
paymentIdId of payment
totalAmountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Editable: true
orderVersionVersion of the order this payment belongs to.
organisationIdId of the organisation who created this payment.
activeThis is to block any transactions after the corresponding order version is reset. Clients importing transactions need to either cancel or credit each transaction externally, and the credit the transaction directly using the transaction's credit endpoint. To continue using the same order id, the payment has to be reactivated with the correct total amount before any new actions can be made to this payment. Editable: true
updatedAtTimestamp for when payment was last updated.
settlementIdSupplied to the client by an external system for handling settlements. For Internal Entur Clients this is Entur’s Electronic Journal.
customerNumberID of the customer who owns this payment.
List of all transactions belonging to this payment.
Deactivate a payment
The payment will be deactivated. Any previously captured transactions will be credited (as long as it is not an imported transaction), and all other transactions will be cancelled.
path Parameters
paymentIdpaymentId
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.
Deactivate a payment › Responses
Ok
orderIdId of the order this payment belongs to.
currency3-letter ISO 4217 currency code. Default is NOK.
createdAtTimestamp for when payment was created.
paymentIdId of payment
totalAmountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Editable: true
orderVersionVersion of the order this payment belongs to.
organisationIdId of the organisation who created this payment.
activeThis is to block any transactions after the corresponding order version is reset. Clients importing transactions need to either cancel or credit each transaction externally, and the credit the transaction directly using the transaction's credit endpoint. To continue using the same order id, the payment has to be reactivated with the correct total amount before any new actions can be made to this payment. Editable: true
updatedAtTimestamp for when payment was last updated.
settlementIdSupplied to the client by an external system for handling settlements. For Internal Entur Clients this is Entur’s Electronic Journal.
customerNumberID of the customer who owns this payment.
List of all transactions belonging to this payment.
Create a new transaction and add to payment.
Add a transaction to an existing payment. Provide either a payment method or a recurring payment ID (at least one must be present). A payment can have more than one transaction. This operation can be seen in the operation log of the transaction as CREATE. Note that Entur can deactivate a payment method temporarily, retrieve all available payment methods first via GET /v1/payment-methods.
path Parameters
paymentIdpaymentId
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 new transaction and add to payment. › Request Body
amountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
currency[A-Z]{3}3-letter ISO 4217 currency code. Default is NOK.
isImportImport flag. Selects a special payment method for imports.
paymentTypeThe actual type of payment.
scaExemptionThe type of SCA (secure customer authentication) Exemption for a transaction. Defaults to NO_EXEMPTION. Other available values are: LOW_VALUE.
with3DSecureFlag to choose payment methods with or without 3D Secure. This option is only accessible to privileged clients.
createAgreementIf true, a new FLEXIBLE Vipps agreement is created and the transaction amount becomes the initial charge. The user must approve the agreement before the charge is processed. Use with paymentType VIPPS / paymentTypeGroup MOBILE. Mutually exclusive with paymentAgreementId and recurringPaymentId.
paymentTypeGroupA PaymentTypeGroup used to override which kind of method to use for reimbursement, instead of using same as used for the payment transaction.This will only take effect if the payment method on the payment transaction allows for overriding.
paymentAgreementIdID of the payment agreement to charge against. Used for Vipps recurring agreement payments. Mutually exclusive with recurringPaymentId.
recurringPaymentIdID of the saved payment method to use for this transaction.
Create a new transaction and add to payment. › Responses
Created
amountAmount to pay, represented in the standard currency unit. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Deprecated and will be removed in next version of API. Use summary instead.
statusCurrent state of the transaction.
currency3-letter currency code. (ISO 4217)
createdAtTimestamp for when transaction was first created.
transactionIdID of the specific transaction.
rrnReconciliation reference number used to track a transaction through different economy systems.
Aggregated summary of amounts on a transaction.
updatedAtTimestamp for when transaction was last updated.
cardNumberLast 4 digits in card number (PAN - Personal Account Number)
paymentTypeThe actual type of payment.
Log of each successful operation made on the transaction. Failing operations will not be included.
Extra transaction data from external client. Only relevant for clients using the import flow.
paymentTypeGroupA PaymentTypeGroup used to override which kind of method to use for reimbursement, instead of using same as used for the payment transaction.This will only take effect if the payment method on the payment transaction allows for overriding.
paymentAgreementIdID of the payment agreement associated with this transaction, if any.
recurringPaymentIdReference to the saved payment agreement this transaction will use, if any was specified.
Fee related to a payment method.
Get a single transaction.
Returns the transaction including an operation log showing everything that happened to the transaction.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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 a single transaction. › Responses
Ok
amountAmount to pay, represented in the standard currency unit. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Deprecated and will be removed in next version of API. Use summary instead.
statusCurrent state of the transaction.
currency3-letter currency code. (ISO 4217)
createdAtTimestamp for when transaction was first created.
transactionIdID of the specific transaction.
rrnReconciliation reference number used to track a transaction through different economy systems.
Aggregated summary of amounts on a transaction.
updatedAtTimestamp for when transaction was last updated.
cardNumberLast 4 digits in card number (PAN - Personal Account Number)
paymentTypeThe actual type of payment.
Log of each successful operation made on the transaction. Failing operations will not be included.
Extra transaction data from external client. Only relevant for clients using the import flow.
paymentTypeGroupA PaymentTypeGroup used to override which kind of method to use for reimbursement, instead of using same as used for the payment transaction.This will only take effect if the payment method on the payment transaction allows for overriding.
paymentAgreementIdID of the payment agreement associated with this transaction, if any.
recurringPaymentIdReference to the saved payment agreement this transaction will use, if any was specified.
Fee related to a payment method.
Cancel a transaction which is already CREATED/INITIATED.
To be able to continue using the same payment (for the same order and order version), but with a new transaction, cancel needs to be called to not have it be included when summing up the total amount. There are several cases where this can be necessary, i.e. customer wants to use another payment method, or something goes wrong with the transaction before it is CAPTURED. This also takes care of cleaning up with the 3rd party payment provider if necessary.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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.
Cancel a transaction which is already CREATED/INITIATED. › Responses
Ok
amountAmount to pay, represented in the standard currency unit. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Deprecated and will be removed in next version of API. Use summary instead.
statusCurrent state of the transaction.
currency3-letter currency code. (ISO 4217)
createdAtTimestamp for when transaction was first created.
transactionIdID of the specific transaction.
rrnReconciliation reference number used to track a transaction through different economy systems.
Aggregated summary of amounts on a transaction.
updatedAtTimestamp for when transaction was last updated.
cardNumberLast 4 digits in card number (PAN - Personal Account Number)
paymentTypeThe actual type of payment.
Log of each successful operation made on the transaction. Failing operations will not be included.
Extra transaction data from external client. Only relevant for clients using the import flow.
paymentTypeGroupA PaymentTypeGroup used to override which kind of method to use for reimbursement, instead of using same as used for the payment transaction.This will only take effect if the payment method on the payment transaction allows for overriding.
paymentAgreementIdID of the payment agreement associated with this transaction, if any.
recurringPaymentIdReference to the saved payment agreement this transaction will use, if any was specified.
Fee related to a payment method.
Import transaction data from external client.
This endpoint is to be used to fill an existing PaymentTransaction with predetermined data from a completed PaymentTransaction. This should only be used by certain privileged clients.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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.
Import transaction data from external client. › Request Body
transactionConfirmedAtTime when payment transaction was completed by the client.
rrnReconciliation reference number used to track a transaction through different economy systems. Required for PAYMENTCARD.
companyId[\d]{1,4}Id of the issuing organisation. The id is equal to the internal id in Enturs Organisation Register. Required for ECARD.
terminalIdUnique identifier for a physical terminal. Makes a transaction unique together with rrn. Required for PAYMENTCARD.
paymentTypeName of the specific payment type used. This further specifies the type of payment method used for this transaction. Often referred to as the name of the issuer for payment cards in the transaction data retrieved from payment terminals. Required for PAYMENTCARD.
envNetworkId[\d]{6}County code for issuer
Any extra transaction data which could be relevant can be specified as a key value map of strings.
mediaSerialNumberId[\d]{1,10}Numerical e-Card identifier. Required for ECARD.
externalTransactionIdTransaction ID from 3rd party payment provider.
Import transaction data from external client. › Responses
Created
amountAmount to pay, represented in the standard currency unit. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Deprecated and will be removed in next version of API. Use summary instead.
statusCurrent state of the transaction.
currency3-letter currency code. (ISO 4217)
createdAtTimestamp for when transaction was first created.
transactionIdID of the specific transaction.
rrnReconciliation reference number used to track a transaction through different economy systems.
Aggregated summary of amounts on a transaction.
updatedAtTimestamp for when transaction was last updated.
cardNumberLast 4 digits in card number (PAN - Personal Account Number)
paymentTypeThe actual type of payment.
Log of each successful operation made on the transaction. Failing operations will not be included.
Extra transaction data from external client. Only relevant for clients using the import flow.
paymentTypeGroupA PaymentTypeGroup used to override which kind of method to use for reimbursement, instead of using same as used for the payment transaction.This will only take effect if the payment method on the payment transaction allows for overriding.
paymentAgreementIdID of the payment agreement associated with this transaction, if any.
recurringPaymentIdReference to the saved payment agreement this transaction will use, if any was specified.
Fee related to a payment method.
Register wallet-transaction in order to send payments to Netaxept by use of virtual wallets like ApplePay
Register with data regarding payment and wallet provider in order to make payments with e.g. ApplePay. Clients must ask Entur to activate agreements for your merchant before using this endpoint.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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
Entur-Distribution-ChannelDistribution channel identifier.
Register wallet-transaction in order to send payments to Netaxept by use of virtual wallets like ApplePay › Request Body
paymentDataContains payment data that will be ECC encrypted. Client should send this as a JSON-string containing the data as described in https://developer.apple.com/documentation/passkit/payment-token-format-reference#Payment-token-format-reference .
walletProviderExamples of providers are ApplePay and GooglePay. Both of these are supported.
redirectUrlPoints to where users should be redirected to for 3DS handling after registering payment, according to client. This is optional, and should only be used for GooglePay and if the transaction is being initiated from a web client, and not an app client.
Register wallet-transaction in order to send payments to Netaxept by use of virtual wallets like ApplePay › Responses
Created
paymentIdID of the payment the transaction belongs to. Used with the transactionId to later capture transaction.
terminalUriLocation of the payment terminal for handling 3DS. This will only be returned if the redirectUrl was provided in the request.
transactionIdID of the transaction this terminal belongs to. Used with the paymentId to later capture transaction.
walletProviderExamples of providers are ApplePay and GooglePay. Both are supported.
Capture the transaction.
Updates the state of the transaction to CAPTURED, and returns the state of the whole payment. After this operation, the transaction is considered to be paid, and a credit is needed to revert it. This operation can be seen in the operation log of the transaction as CAPTURE.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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.
Capture the transaction. › Responses
Ok
orderIdId of the order this payment belongs to.
currency3-letter ISO 4217 currency code. Default is NOK.
createdAtTimestamp for when payment was created.
paymentIdId of payment
totalAmountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Editable: true
orderVersionVersion of the order this payment belongs to.
organisationIdId of the organisation who created this payment.
activeThis is to block any transactions after the corresponding order version is reset. Clients importing transactions need to either cancel or credit each transaction externally, and the credit the transaction directly using the transaction's credit endpoint. To continue using the same order id, the payment has to be reactivated with the correct total amount before any new actions can be made to this payment. Editable: true
updatedAtTimestamp for when payment was last updated.
settlementIdSupplied to the client by an external system for handling settlements. For Internal Entur Clients this is Entur’s Electronic Journal.
customerNumberID of the customer who owns this payment.
List of all transactions belonging to this payment.
Change the content of an Invoice
Change the contents and/or amount of an invoice. Only valid for COLLECTOR_B2B, and only before invoice has been confirmed by customer.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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.
Change the content of an Invoice › Request Body
invoiceIdId of Invoice. Only set in request for PUT
redirectUrl^(https?://).{0,1024…Location to be redirected to from the payment terminal. Required for Collector
languageCodeLanguage code to override terminal language and invoice if possible. Overrides customer preferences. ISO 639-3 format.
externalInvoiceNumberAn external invoice number that is generated outside the sales system. This number is the invoice number on the written invoice, and must be sent to Xledger
customerIdentificationNumberCustomer identification number to identify customer information on electronic banking transactions. Used for penalty fare invoices in Xledger. Has absolutely nothing to do with Entur customers.
Change the content of an Invoice › Responses
OK
invoiceIdID of the invoice connected to the payment. Used to lookup invoice in the invoice api
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.
expiryDateIf paymentType is COLLECTOR_B2B: Expiry date for when invoice is no longer payable
publicTokenIf paymentType is COLLECTOR_B2B: Token used in creation of payment iframe
terminalUriIf paymentType is COLLECTOR: Location of the payment terminal, else null
Create or replace an invoice for an order
Initiate a payment by creating or replacing an invoice based on orderId and PaymentType.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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 or replace an invoice for an order › Request Body
invoiceIdId of Invoice. Only set in request for PUT
redirectUrl^(https?://).{0,1024…Location to be redirected to from the payment terminal. Required for Collector
languageCodeLanguage code to override terminal language and invoice if possible. Overrides customer preferences. ISO 639-3 format.
externalInvoiceNumberAn external invoice number that is generated outside the sales system. This number is the invoice number on the written invoice, and must be sent to Xledger
customerIdentificationNumberCustomer identification number to identify customer information on electronic banking transactions. Used for penalty fare invoices in Xledger. Has absolutely nothing to do with Entur customers.
Create or replace an invoice for an order › Responses
Created
invoiceIdID of the invoice connected to the payment. Used to lookup invoice in the invoice api
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.
expiryDateIf paymentType is COLLECTOR_B2B: Expiry date for when invoice is no longer payable
publicTokenIf paymentType is COLLECTOR_B2B: Token used in creation of payment iframe
terminalUriIf paymentType is COLLECTOR: Location of the payment terminal, else null
Create payment terminal.
Registers the transaction with a 3rd party PSP 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. After this, a new transaction must be created. This operation can be seen in the operation log of the transaction as INITIATE.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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 payment 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 payment 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.
Create payment claim in mobile app.
Register the transaction with Vipps, which will present payment information to the customer in the Vipps app. Note that the receipt of confirmation in the payment app will not serve as payment confirmation, as this action will only reserve the money on the customer's bank account. When the payment is accepted by the customer, a callback will be sent to the location provided in the request. This operation can be seen in the operation log of the transaction as INITIATE.
The response depends on how the transaction was created:
- Standard Vipps payment (no agreement): returns 201 with an
appClaimUrlthe client uses to open the Vipps app and present the payment to the customer. - New agreement (
createAgreement=true): returns 201 with a confirmation URL the customer must visit to approve the new agreement. - Existing agreement (
paymentAgreementIdset): returns 204 No Content. The charge is initiated directly against the existing agreement; no redirect or customer interaction is required. Clients implementingpaymentAgreementIdsupport must handle both 201 and 204 responses.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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 payment claim in mobile app. › Request Body
descriptionCustomize the text to be presented to the end-user in the payment app. This often involves some kind of product information.
phoneNumber^([0-9]{8}|\+?[0-9]{…Phone number where the claim should be presented. Accepted formats: 8-digit Norwegian number (country code 47 is added automatically if not provided), MSISDN (digits only, country code included, 10–15 digits), or E.164 (leading +, 10–15 digits). Supported country codes: Norway (47), Denmark (45), Sweden (46), Finland (358).
redirectUrlLocation to be redirected to from the 3rd party landing page/app.
Create payment claim in mobile app. › Responses
Created. Returned for standard Vipps payments and new agreements (createAgreement=true). Contains an appClaimUrl used to direct the customer to Vipps.
paymentIdID of the payment the transaction belongs to. Used with the transactionId to later capture transaction.
appClaimUrlLocation of the payment terminal.
transactionIdID of the transaction this terminal belongs to. Used with the transactionId to later capture transaction.
Pre-authorization and authorization adjustments of a transaction
Authorize a transaction pre-capture. The initial authorization, also called a pre-authorization is to reserve the total you think the transaction will amount to. If the total changes between the initial authorization and the time of capture, initial authorization-calls can be made to either increment or reduce the authorized amount. To trigger this just change the totalAmount in the authorizeRequest accordingly to your needs.
Note: An incremental authorization must be directly preceeded by either a pre-authorization or another incremental authorization. Note: A reductional authorization can only be performed once per transaction. Once a reductional authorization has been done, it is no longe possible to alter the totalAmount of the transaction.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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.
Pre-authorization and authorization adjustments of a transaction › Request Body
totalAmountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
Pre-authorization and authorization adjustments of a transaction › Responses
OK
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.
Claim a gift-card
The gift-card will be claimed
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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.
Claim a gift-card › Request Body
giftCardCodeThe code identifying a gift card.
Claim a gift-card › Responses
Created
orderIdId of the order this payment belongs to.
currency3-letter ISO 4217 currency code. Default is NOK.
createdAtTimestamp for when payment was created.
paymentIdId of payment
totalAmountAmount to pay, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot. Editable: true
orderVersionVersion of the order this payment belongs to.
organisationIdId of the organisation who created this payment.
activeThis is to block any transactions after the corresponding order version is reset. Clients importing transactions need to either cancel or credit each transaction externally, and the credit the transaction directly using the transaction's credit endpoint. To continue using the same order id, the payment has to be reactivated with the correct total amount before any new actions can be made to this payment. Editable: true
updatedAtTimestamp for when payment was last updated.
settlementIdSupplied to the client by an external system for handling settlements. For Internal Entur Clients this is Entur’s Electronic Journal.
customerNumberID of the customer who owns this payment.
List of all transactions belonging to this payment.
Create an internal payment terminal.
Returns a terminal-url where the user can provide further information and complete the payment process.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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
Entur-Distribution-ChannelDistribution channel identifier.
Create an internal payment terminal. › Request Body
redirectUrl^(https?://).{0,1024… · requiredLocation to be redirected to from the payment terminal.
Create an internal payment terminal. › Responses
Created
terminalUrlLocation of the payment terminal.
paymentIdID of the payment the transaction belongs to.
transactionIdID of the transaction this terminal belongs to.
Create payment terminal.
Registers the transaction with a 3rd party PSP and returns the location of the payment terminal. This operation can be seen in the operation log of the transaction as INITIATE.
path Parameters
paymentIdpaymentId
transactionIdtransactionId
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 payment terminal. › Request Body
panHashThe pan hash used to execute the payment.
redirectUrl^(https?://).{0,1024… · requiredLocation to be redirected to from the payment terminal.
recurringType^R|S$ · requiredThe type of the recurring payment. Can be either R og S.
Create payment 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.