Description

This is a type of import payment used when there is no actual payment being done in Enturs systems - for example when there needs to be a receipt which shows an amount paid, but the actual payment is done solely at the operator level. Use of this PaymentTypeGroup requires a prearranged PaymentType String, and a confirmation from Entur that our systems are set up to handle it. Unauthorized or non-prearranged use of this PaymentTypeGroup has serious side effects on both the sales systems and the accounting systems - including bookkeeping systems that are regulated heavily by law.

Constraints

Get permission from Entur to use this workflow

If you have a use case which requires this workflow, please contact Entur through your main business contact, and explain your use case. Using this workflow without first arranging with us will lead to possible data loss and errors in the bookkeeping.

Only for use in Transaction imports - not in the normal capture workflow.

This CANNOT be used with a captured transaction, for the simple reason that in captured transactions we expect an actual payment method - and this is not one.

Only use this PaymentTypeGroup with Transactions which will pay for entire orders.

Agent payments CANNOT be combined with other forms of payment (like payment cards) for one order. This can lead to errors in bookkeeping and also undefined results if an order is cancelled. The only exception to this rule is a special case for Vy (rutegående alternativ transport). Using several agent payments to pay for different versions of an order -- including crediting, is fine, but only with one transaction per order version.

Arrange with Entur directly which PaymentType should be used

The PaymentType String field will tell the accounting systems how to treat your Transactions. When creating a transaction, use the PaymentTypeGroup "AGENT", and a PaymentType that you have agreed with either your customer contact at Entur, og directly with Team Avregning. Please do not change the PaymentType without talking to us beforehand, as this will lead to possible errors in the bookkeeping.

Workflow

1. Follow this guide as usual up to and including "Create Payment"

2. Create a Payment Transaction, but use PaymentTypeGroup "AGENT" and a blank PaymentType

   POST /sales/v1/payments/:id/transactions

   Example request
   Example response

3. Do not create a terminal, do not capture the transaction. Instead, import the transaction at the endpoint "/{paymentId}/transactions/{transactionId}/import" using the TransactionImportRequest datatype specified in our Swagger schema, which should be linked from our API documentation. Remember to use the PaymentType you've agreed with Entur.

   POST /sales/v1/payments/:id/transactions/:id/import

   Example request
   Example response

4. Continue from "Generate and Distribute ticket distributions" on the guide as usual