Create and update credits. Create and execute credit transactions.
Search credits
Returns matching credits 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
creditIdID of Credit entity
customerNumberInternal numeric ID of customer which Credit is linked to
orderIdID of Order entity that Credit is linked to
orderVersionVersion of Credit entity
organisationIdID of organisation Credit entity is linked to
pageSelects a specific page in the collection
perPageSelects the number of elements per page
reimbursementMethodWhich specific payment transfer type is used for the CreditTransactions linked to the Credit. E.g. VIPPS, VISA, MASTERCARD
reimbursementTypeGroupWhich of the several groups of ways to transfer payment the CreditTransactions linked to the Credit entity is. E.g. MOBILE, PAYMENTCARD, CASH
rrnRetrieval Reference Number of CreditTransaction linked to Credit entity
settlementIdstatusEither CREATED or CREDITED depending on whether the actual credit action has been performed
totalCreditAmountTotal amount of credit, with one or more credit transactions
transactionIdId of (one of) the PaymentTransaction(s) performed as part of the credit
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
Search credits › Responses
OK
Items on a specific page
totalItemsTotal number of items
totalPagesTotal number of pages available to browse
Create credit transactions.
Creates credit transactions for all the payment transactions specified. The total credit amount must match the sum of the individual transactions, and each transaction cannot be higher than the paid amount.
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 credit transactions. › Request Body
orderIdID of the order this credit belongs to.
orderVersionVersion of the order this credit belongs to.
totalCreditAmount^[1-9][0-9]{0,17}\.[… · requiredAmount to credit, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
List of individual transactions to credit.
currency[A-Z]{3}The currency used for this credit. Default value is 'NOK'
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 credit. This value is only considered for privileged client (internal and partner tenants.
Create credit transactions. › Responses
Ok
orderIdID of the order this payment belongs to.
creditIdIdentification of this credit resource.
orderVersionVersion of the order this credit belongs to.
totalCreditAmountTotal amount to credit, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
List of individual transactions to credit.
activeIf active is false, credit is considered uneditable. The only way to change this property is through an internal Admin endpoint or the mergePatch endpoint. Editable: true
currencyThe currency used for this credit.
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 credit.
organisationIdID of the organisation who created this credit.
Find a credit.
Returns the credit with all its credit transactions. The credit transactions have each backreferences to their corresponding payment transaction.
path Parameters
creditIdcreditId
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
Find a credit. › Responses
Ok
orderIdID of the order this payment belongs to.
creditIdIdentification of this credit resource.
orderVersionVersion of the order this credit belongs to.
totalCreditAmountTotal amount to credit, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
List of individual transactions to credit.
activeIf active is false, credit is considered uneditable. The only way to change this property is through an internal Admin endpoint or the mergePatch endpoint. Editable: true
currencyThe currency used for this credit.
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 credit.
organisationIdID of the organisation who created this credit.
Update the credit
The credit 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. For more information about the PATCH endpoint and the merge-patch content-type, please refer to RFC7396.
path Parameters
creditIdcreditId
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
Update the credit › Request Body
totalCreditAmountAmount to credit, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
activeActive is used during activation of credit
List of individual transactions to credit.
Update the credit › Responses
OK
orderIdID of the order this payment belongs to.
creditIdIdentification of this credit resource.
orderVersionVersion of the order this credit belongs to.
totalCreditAmountTotal amount to credit, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
List of individual transactions to credit.
activeIf active is false, credit is considered uneditable. The only way to change this property is through an internal Admin endpoint or the mergePatch endpoint. Editable: true
currencyThe currency used for this credit.
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 credit.
organisationIdID of the organisation who created this credit.
Execute credit.
Executes a credit operation on all the payment transactions referenced in this credit. The operation will execute sequentially for all payment transactions. If one of the operations fails, this call responds with the specific error response for that payment transaction. Any previous successful credit operation cannot be undone, and for this reason it is highly recommended to check the status of each credit transaction after en error response is returned. More detail on the individual payment transaction can be found in the transaction summary by calling GET on the specific payment transaction. This call is idempotent, which means it is safe to repeatedly retry without any creditTransactions being executed more than once.
path Parameters
creditIdcreditId
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.
Execute credit. › Responses
Ok
orderIdID of the order this payment belongs to.
creditIdIdentification of this credit resource.
orderVersionVersion of the order this credit belongs to.
totalCreditAmountTotal amount to credit, represented in the standard currency. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022. The integer and fractional digits are separated by a dot.
List of individual transactions to credit.
activeIf active is false, credit is considered uneditable. The only way to change this property is through an internal Admin endpoint or the mergePatch endpoint. Editable: true
currencyThe currency used for this credit.
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 credit.
organisationIdID of the organisation who created this credit.