Skip to content
RelayTap

    Payment Services

    Payment Services facilitates payments, refunds OR reversals for the supported alternate payment schemes.

    Scroll down for code samples, example requests and responses.
    Select a language for code samples from the tabs or the mobile navigation menu.

    Initialize a transaction

    POST /ms/aapay/v2/transaction/{type}/initialize

    This operation initializes a payment, refund or a reversal transaction

    Parameters

    • Authorizationstringrequired

      Bearer Base64(consumer-key:consumer-secret)

    • typestringrequired

      The type of transaction i.e payment OR refund OR reversal

    Initialize a transaction

    var client = new RestClient("https://api-gateway-pp.paas-test.bbsas.no/ms/aapay/v2/transaction/{type}/initialize");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json;charset=utf-8;version=2.0");
request.AddHeader("Authorization", "SOME_STRING_VALUE");
IRestResponse response = client.Execute(request);

    Request body

    • merchantIdstringrequired

      MerchantId

    • methodstringrequired

      This is the PSP name.

      SWISH_E_COM, KLARNA, SANTANDER, EASY

    • purchaseAmountobjectrequired

      Represents an amount.

      • currencyCodestringrequired

        ISO-4217 Currency code

      • vatAmountinteger (int64)required

        Vat Amount [Hundredth of denomination].

      • nominalAmountinteger (int64)required

        Nominal amount [Hundredth of denomination].

      • totalAmountinteger (int64)required

        Amount including VAT. [Hundredth of denomination].

    • consumerobjectrequired

      Consumer

      • consumerIdstringrequired

        Id/org number/code/mobileno

      • namestringrequired

        Name of the consumer

    • ecr2Naaobjectoptional

      Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

      • verstringoptional

        version default to 1.0

      • referencestringoptional

        reference number

      • langstringoptional

        language from the terminal

      • orderobjectoptional

        Order Details- with individual items

        • itemsarrayoptional

          List of items present in the order

          • itemNostringoptional

            itemNo for the order item

          • referencestringoptional

            reference for the order item

          • namestringoptional

            name of the order item

          • quantityinteger (int32)optional

            quantity of the order item

          • unitstringoptional

            unit of the order item e.g. pc/kg

          • unitPriceinteger (int64)optional

            Price for a single unit of the order line. Non-negative minor units. Excludes tax.

          • taxRateinteger (int64)optional

            Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

          • taxAmountinteger (int64)optional

            Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

          • grossTotalAmountinteger (int64)optional

            Total amount of the order line. Must be defined as non-negative minor units. Includes tax

          • netTotalAmountinteger (int64)optional

            Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

        • amountinteger (int64)optional

          Total Amount of the Order

        • currencystringoptional

          Currency of the order

        • referencestringoptional

          reference of the order

      • autoCapturestringoptional

        autoCapture from the terminal

    • batchinteger (int64)optional

      The batch to which this transaction should be registered.

    • terminalReferencestringoptional

      Terminal reference unique number identifying the terminal (in addition to the terminalId). Required for reversals

    • originalReferencestringoptional

      The reference of the original transaction. If included, it cannot be null for reversals and refunds. For Reversal the request body contains the terminalReference key and for Refund it has the value of the transactionId.

    • messagestringoptional

      Initialize payment message

    • triggerstringoptional

      Initialize trigger for payment OR refund OR reversals to identify if its QR(2) or Manual(0). Default is 0

    • additionalPropertiesarrayoptional

      Any addtional properties required for transaction as Parameters key/value pairs e.g. lang, country with values required for Klarna.

      • keystringrequired

        key

      • valuestringrequired

        value

    Request body

    {
    "merchantId": "string",
    "method": "SWISH_E_COM",
    "purchaseAmount": {
        "currencyCode": "string",
        "vatAmount": 0,
        "nominalAmount": 0,
        "totalAmount": 0
    },
    "consumer": {
        "consumerId": "string",
        "name": "string"
    },
    "ecr2Naa": {
        "ver": "string",
        "reference": "string",
        "lang": "string",
        "order": {
            "items": [
                {
                    "itemNo": "string",
                    "reference": "string",
                    "name": "string",
                    "quantity": 0,
                    "unit": "string",
                    "unitPrice": 0,
                    "taxRate": 0,
                    "taxAmount": 0,
                    "grossTotalAmount": 0,
                    "netTotalAmount": 0
                }
            ],
            "amount": 0,
            "currency": "string",
            "reference": "string"
        },
        "autoCapture": "string"
    },
    "batch": 0,
    "terminalReference": "string",
    "originalReference": "string",
    "message": "string",
    "trigger": "string",
    "additionalProperties": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

    Responses

    • 201optional
      The transaction has been created but rejected. No further processing possible.
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    • 202The transaction has been initialized ok.optional
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    • 400optional
      The server did not understand or could not validate the input parameters.
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    • 401Operation not allowed.optional
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    • 500optional
      The server experienced a runtime exception while processing the request. Try again later or contact our customer support.
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    {
    "valid": true,
    "error": {
        "componsiteFault": {
            "faults": [
                {
                    "explanationText": "string",
                    "params": {
                        "property1": "string",
                        "property2": "string"
                    }
                }
            ]
        },
        "message": "string"
    },
    "response": {
        "responseCode": 0,
        "extendedResponseCode": 0,
        "request": {
            "transaction": {
                "transactionId": 0,
                "terminalReference": "string",
                "referenceId": "string",
                "agreementNumber": "string",
                "batch": 0,
                "timeStampOrigin": "2019-08-24T14:15:22Z",
                "timeStamp": "2019-08-24T14:15:22Z",
                "amount": {
                    "currencyCode": "string",
                    "vatAmount": 0,
                    "nominalAmount": 0,
                    "totalAmount": 0
                },
                "method": "string",
                "accountState": "COMMIT",
                "cancel": true,
                "message": "string",
                "state": "INITIALIZED",
                "origin": "string",
                "merchant": {
                    "merchantId": "string",
                    "name": "string",
                    "orgNumber": "string",
                    "vatNumber": "string",
                    "active": 0,
                    "countryCode": "string",
                    "merchantCatCode": "string",
                    "merchantCity": "string"
                },
                "consumer": {
                    "consumerId": "string",
                    "name": "string"
                },
                "receipt": {
                    "receiptId": 0,
                    "timeStamp": "2019-08-24T14:15:22Z",
                    "receiptData": [
                        "string"
                    ],
                    "receiptClass": "string"
                },
                "transitions": [
                    {
                        "timeStamp": "2019-08-24T14:15:22Z",
                        "from": "INITIALIZED",
                        "to": "INITIALIZED",
                        "event": "CREATE"
                    }
                ],
                "parameters": [
                    {
                        "parameterId": 0,
                        "key": "string",
                        "value": "string"
                    }
                ],
                "order": {
                    "items": [
                        {
                            "itemNo": "string",
                            "reference": "string",
                            "name": "string",
                            "quantity": 0,
                            "unit": "string",
                            "unitPrice": 0,
                            "taxRate": 0,
                            "taxAmount": 0,
                            "grossTotalAmount": 0,
                            "netTotalAmount": 0
                        }
                    ],
                    "amount": 0,
                    "currency": "string",
                    "reference": "string"
                },
                "trigger": "string",
                "transientConsumerId": "string"
            },
            "channel": "INTERNAL",
            "additionalProperties": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "ecr2Naa": {
                "ver": "string",
                "reference": "string",
                "lang": "string",
                "order": {
                    "items": [
                        {
                            "itemNo": "string",
                            "reference": "string",
                            "name": "string",
                            "quantity": 0,
                            "unit": "string",
                            "unitPrice": 0,
                            "taxRate": 0,
                            "taxAmount": 0,
                            "grossTotalAmount": 0,
                            "netTotalAmount": 0
                        }
                    ],
                    "amount": 0,
                    "currency": "string",
                    "reference": "string"
                },
                "autoCapture": "string"
            }
        },
        "naa2Ecr": {
            "schemeId": "string",
            "ppref": "string",
            "payerId": "string",
            "additionalInfo": "string",
            "loyaltyIds": [
                "string"
            ]
        }
    },
    "nextLink": {
        "type": "string",
        "uriBuilder": {},
        "rels": [
            "string"
        ],
        "params": {
            "property1": "string",
            "property2": "string"
        },
        "uri": "http://example.com",
        "rel": "string",
        "title": "string"
    }
}

    Retrieve status of the transaction

    GET /ms/aapay/v2/transaction/{id}/status

    This operation retrieves status of a payment, refund or a reversal transaction

    Parameters

    • Authorizationstringrequired

      Bearer Base64(consumer-key:consumer-secret)

    • idstringrequired

      The transaction Id to query

    • methodstringoptional

      Query parameter method

    Retrieve status of the transaction

    var client = new RestClient("https://api-gateway-pp.paas-test.bbsas.no/ms/aapay/v2/transaction/{id}/status?method=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "SOME_STRING_VALUE");
IRestResponse response = client.Execute(request);

    Responses

    • 200Requested transaction found.optional
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
      • transactionIdinteger (int64)optional

        Unique ID of the transaction

      • timeStampstring (date-time)optional

        Timestamp when the transaction was created.

      • statestringoptional

        State of the transaction

        INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

      • accountStatestringoptional

        Have funds changed the owner? COMMIT = yes

        COMMIT, ROLLBACK

      • receiptobjectoptional

        The receipt

      • payerIdstringoptional

        The payer id.

      • qrTriggerstringoptional

        QR Trigger 1 if transaction is QR transaction or 0 if transaction is a manual transaction.

      • naa2Ecrobjectoptional

        Naa to Ecr data

        • schemeIdstringoptional

          schemeId of the method passed i.e. 201 for SWISH_E_COM

        • pprefstringoptional

          ppref is the transaction id generated

        • payerIdstringoptional

          payerId identifying payer i.e. mobileno or code

        • additionalInfostringoptional

          AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

        • loyaltyIdsarrayoptional

          loyaltyIds

    • 404Requested transaction not found.optional
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
      • transactionIdinteger (int64)optional

        Unique ID of the transaction

      • timeStampstring (date-time)optional

        Timestamp when the transaction was created.

      • statestringoptional

        State of the transaction

        INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

      • accountStatestringoptional

        Have funds changed the owner? COMMIT = yes

        COMMIT, ROLLBACK

      • receiptobjectoptional

        The receipt

      • payerIdstringoptional

        The payer id.

      • qrTriggerstringoptional

        QR Trigger 1 if transaction is QR transaction or 0 if transaction is a manual transaction.

      • naa2Ecrobjectoptional

        Naa to Ecr data

        • schemeIdstringoptional

          schemeId of the method passed i.e. 201 for SWISH_E_COM

        • pprefstringoptional

          ppref is the transaction id generated

        • payerIdstringoptional

          payerId identifying payer i.e. mobileno or code

        • additionalInfostringoptional

          AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

        • loyaltyIdsarrayoptional

          loyaltyIds

    • 500optional
      The server experienced a runtime exception while processing the request. Try again later or contact our customer support.
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
      • transactionIdinteger (int64)optional

        Unique ID of the transaction

      • timeStampstring (date-time)optional

        Timestamp when the transaction was created.

      • statestringoptional

        State of the transaction

        INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

      • accountStatestringoptional

        Have funds changed the owner? COMMIT = yes

        COMMIT, ROLLBACK

      • receiptobjectoptional

        The receipt

      • payerIdstringoptional

        The payer id.

      • qrTriggerstringoptional

        QR Trigger 1 if transaction is QR transaction or 0 if transaction is a manual transaction.

      • naa2Ecrobjectoptional

        Naa to Ecr data

        • schemeIdstringoptional

          schemeId of the method passed i.e. 201 for SWISH_E_COM

        • pprefstringoptional

          ppref is the transaction id generated

        • payerIdstringoptional

          payerId identifying payer i.e. mobileno or code

        • additionalInfostringoptional

          AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

        • loyaltyIdsarrayoptional

          loyaltyIds

    {
    "valid": true,
    "error": {
        "componsiteFault": {
            "faults": [
                {
                    "explanationText": "string",
                    "params": {
                        "property1": "string",
                        "property2": "string"
                    }
                }
            ]
        },
        "message": "string"
    },
    "response": {
        "responseCode": 0,
        "extendedResponseCode": 0,
        "request": {
            "transaction": {
                "transactionId": 0,
                "terminalReference": "string",
                "referenceId": "string",
                "agreementNumber": "string",
                "batch": 0,
                "timeStampOrigin": "2019-08-24T14:15:22Z",
                "timeStamp": "2019-08-24T14:15:22Z",
                "amount": {
                    "currencyCode": "string",
                    "vatAmount": 0,
                    "nominalAmount": 0,
                    "totalAmount": 0
                },
                "method": "string",
                "accountState": "COMMIT",
                "cancel": true,
                "message": "string",
                "state": "INITIALIZED",
                "origin": "string",
                "merchant": {
                    "merchantId": "string",
                    "name": "string",
                    "orgNumber": "string",
                    "vatNumber": "string",
                    "active": 0,
                    "countryCode": "string",
                    "merchantCatCode": "string",
                    "merchantCity": "string"
                },
                "consumer": {
                    "consumerId": "string",
                    "name": "string"
                },
                "receipt": {
                    "receiptId": 0,
                    "timeStamp": "2019-08-24T14:15:22Z",
                    "receiptData": [
                        "string"
                    ],
                    "receiptClass": "string"
                },
                "transitions": [
                    {
                        "timeStamp": "2019-08-24T14:15:22Z",
                        "from": "INITIALIZED",
                        "to": "INITIALIZED",
                        "event": "CREATE"
                    }
                ],
                "parameters": [
                    {
                        "parameterId": 0,
                        "key": "string",
                        "value": "string"
                    }
                ],
                "order": {
                    "items": [
                        {
                            "itemNo": "string",
                            "reference": "string",
                            "name": "string",
                            "quantity": 0,
                            "unit": "string",
                            "unitPrice": 0,
                            "taxRate": 0,
                            "taxAmount": 0,
                            "grossTotalAmount": 0,
                            "netTotalAmount": 0
                        }
                    ],
                    "amount": 0,
                    "currency": "string",
                    "reference": "string"
                },
                "trigger": "string",
                "transientConsumerId": "string"
            },
            "channel": "INTERNAL",
            "additionalProperties": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "ecr2Naa": {
                "ver": "string",
                "reference": "string",
                "lang": "string",
                "order": {
                    "items": [
                        {
                            "itemNo": "string",
                            "reference": "string",
                            "name": "string",
                            "quantity": 0,
                            "unit": "string",
                            "unitPrice": 0,
                            "taxRate": 0,
                            "taxAmount": 0,
                            "grossTotalAmount": 0,
                            "netTotalAmount": 0
                        }
                    ],
                    "amount": 0,
                    "currency": "string",
                    "reference": "string"
                },
                "autoCapture": "string"
            }
        },
        "naa2Ecr": {
            "schemeId": "string",
            "ppref": "string",
            "payerId": "string",
            "additionalInfo": "string",
            "loyaltyIds": [
                "string"
            ]
        }
    },
    "nextLink": {
        "type": "string",
        "uriBuilder": {},
        "rels": [
            "string"
        ],
        "params": {
            "property1": "string",
            "property2": "string"
        },
        "uri": "http://example.com",
        "rel": "string",
        "title": "string"
    },
    "transactionId": 0,
    "timeStamp": "2019-08-24T14:15:22Z",
    "state": "INITIALIZED",
    "accountState": "COMMIT",
    "receipt": {},
    "payerId": "string",
    "qrTrigger": "string",
    "naa2Ecr": {
        "schemeId": "string",
        "ppref": "string",
        "payerId": "string",
        "additionalInfo": "string",
        "loyaltyIds": [
            "string"
        ]
    }
}

    Initialize a transaction

    POST /ms/aapay/v2/transaction/{type}/initializeWithIdempotency

    This operation initializes a payment, refund or a reversal transaction

    Parameters

    • typestringrequired

      The type of transaction i.e payment OR refund OR reversal

    Initialize a transaction

    var client = new RestClient("https://api-gateway-pp.paas-test.bbsas.no/ms/aapay/v2/transaction/{type}/initializeWithIdempotency");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json;charset=utf-8;version=2.0");
IRestResponse response = client.Execute(request);

    Request body

    • merchantIdstringrequired

      MerchantId

    • methodstringrequired

      This is the PSP name.

      SWISH_E_COM, KLARNA, SANTANDER, EASY

    • purchaseAmountobjectrequired

      Represents an amount.

      • currencyCodestringrequired

        ISO-4217 Currency code

      • vatAmountinteger (int64)required

        Vat Amount [Hundredth of denomination].

      • nominalAmountinteger (int64)required

        Nominal amount [Hundredth of denomination].

      • totalAmountinteger (int64)required

        Amount including VAT. [Hundredth of denomination].

    • consumerobjectrequired

      Consumer

      • consumerIdstringrequired

        Id/org number/code/mobileno

      • namestringrequired

        Name of the consumer

    • ecr2Naaobjectoptional

      Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

      • verstringoptional

        version default to 1.0

      • referencestringoptional

        reference number

      • langstringoptional

        language from the terminal

      • orderobjectoptional

        Order Details- with individual items

        • itemsarrayoptional

          List of items present in the order

          • itemNostringoptional

            itemNo for the order item

          • referencestringoptional

            reference for the order item

          • namestringoptional

            name of the order item

          • quantityinteger (int32)optional

            quantity of the order item

          • unitstringoptional

            unit of the order item e.g. pc/kg

          • unitPriceinteger (int64)optional

            Price for a single unit of the order line. Non-negative minor units. Excludes tax.

          • taxRateinteger (int64)optional

            Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

          • taxAmountinteger (int64)optional

            Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

          • grossTotalAmountinteger (int64)optional

            Total amount of the order line. Must be defined as non-negative minor units. Includes tax

          • netTotalAmountinteger (int64)optional

            Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

        • amountinteger (int64)optional

          Total Amount of the Order

        • currencystringoptional

          Currency of the order

        • referencestringoptional

          reference of the order

      • autoCapturestringoptional

        autoCapture from the terminal

    • batchinteger (int64)optional

      The batch to which this transaction should be registered.

    • terminalReferencestringoptional

      Terminal reference unique number identifying the terminal (in addition to the terminalId). Required for reversals

    • originalReferencestringoptional

      The reference of the original transaction. If included, it cannot be null for reversals and refunds. For Reversal the request body contains the terminalReference key and for Refund it has the value of the transactionId.

    • messagestringoptional

      Initialize payment message

    • triggerstringoptional

      Initialize trigger for payment OR refund OR reversals to identify if its QR(2) or Manual(0). Default is 0

    • additionalPropertiesarrayoptional

      Any addtional properties required for transaction as Parameters key/value pairs e.g. lang, country with values required for Klarna.

      • keystringrequired

        key

      • valuestringrequired

        value

    Request body

    {
    "merchantId": "string",
    "method": "SWISH_E_COM",
    "purchaseAmount": {
        "currencyCode": "string",
        "vatAmount": 0,
        "nominalAmount": 0,
        "totalAmount": 0
    },
    "consumer": {
        "consumerId": "string",
        "name": "string"
    },
    "ecr2Naa": {
        "ver": "string",
        "reference": "string",
        "lang": "string",
        "order": {
            "items": [
                {
                    "itemNo": "string",
                    "reference": "string",
                    "name": "string",
                    "quantity": 0,
                    "unit": "string",
                    "unitPrice": 0,
                    "taxRate": 0,
                    "taxAmount": 0,
                    "grossTotalAmount": 0,
                    "netTotalAmount": 0
                }
            ],
            "amount": 0,
            "currency": "string",
            "reference": "string"
        },
        "autoCapture": "string"
    },
    "batch": 0,
    "terminalReference": "string",
    "originalReference": "string",
    "message": "string",
    "trigger": "string",
    "additionalProperties": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

    Responses

    • 201optional
      The transaction has been created but rejected. No further processing possible.
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    • 202The transaction has been initialized ok.optional
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    • 400optional
      The server did not understand or could not validate the input parameters.
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    • 401Operation not allowed.optional
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    • 500optional
      The server experienced a runtime exception while processing the request. Try again later or contact our customer support.
      • validbooleanrequired

        Sucessfully processed?

      • errorobjectoptional

        For invalid responses (valid=false), information about the error.

        • componsiteFaultobjectoptional

          Contains composite and detailed information about the error response.

          • faultsarrayoptional
            • explanationTextstringoptional
            • paramsobjectoptional
        • messagestringoptional

          High level error message.

      • responseobjectoptional

        Response to request

        • responseCodeinteger (int32)optional

          Response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • extendedResponseCodeinteger (int32)optional

          Extended response code e.g. RESPONSE_OK=0,RESPONSE_RESEND=1, RESPONSE_REJECT=-1, RESPONSE_CANCEL=-2, RESPONSE_PENDING=-3

        • requestobjectoptional

          Transaction request

          • transactionobjectoptional
            • transactionIdinteger (int64)optional
            • terminalReferencestringoptional
            • referenceIdstringoptional
            • agreementNumberstringoptional
            • batchinteger (int64)optional
            • timeStampOriginstring (date-time)optional
            • timeStampstring (date-time)optional
            • amountobjectrequired

              Represents an amount.

              • currencyCodestringrequired

                ISO-4217 Currency code

              • vatAmountinteger (int64)required

                Vat Amount [Hundredth of denomination].

              • nominalAmountinteger (int64)required

                Nominal amount [Hundredth of denomination].

              • totalAmountinteger (int64)required

                Amount including VAT. [Hundredth of denomination].

            • methodstringoptional
            • accountStatestringoptional

              COMMIT, ROLLBACK

            • cancelbooleanoptional
            • messagestringoptional
            • statestringoptional

              INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

            • originstringoptional
            • merchantobjectrequired
              • merchantIdstringoptional
              • namestringoptional
              • orgNumberstringoptional
              • vatNumberstringoptional
              • activeinteger (int32)optional
              • countryCodestringoptional
              • merchantCatCodestringoptional
              • merchantCitystringoptional
            • consumerobjectoptional

              Consumer

              • consumerIdstringrequired

                Id/org number/code/mobileno

              • namestringrequired

                Name of the consumer

            • receiptobjectoptional
              • receiptIdinteger (int64)optional
              • timeStampstring (date-time)optional
              • receiptDataarrayoptional
              • receiptClassstringoptional
            • transitionsarrayoptional
              • timeStampstring (date-time)optional
              • fromstringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • tostringoptional

                INITIALIZED, AUTHORIZED, FINALIZED, REPORTED, STALE, PENDING, REJECTED, CANCELLED, FAILED, RESERVED, TIMEDOUT

              • eventstringoptional

                CREATE, AUTHORIZE, FINALIZE, REPORT, AGE, REJECT, CANCEL, RESEND, FAIL, RESERVE, TIMEOUT

            • parametersarrayoptional
              • parameterIdinteger (int64)optional
              • keystringoptional
              • valuestringoptional
            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • triggerstringoptional
            • transientConsumerIdstringoptional
          • channelstringrequired

            INTERNAL, WS_REST, WS_REST_CALLBACK

          • additionalPropertiesarrayoptional
            • keystringrequired

              key

            • valuestringrequired

              value

          • ecr2Naaobjectoptional

            Allows you to pass on additional optional non sensitive data for your reference (i.e. order information)

            • verstringoptional

              version default to 1.0

            • referencestringoptional

              reference number

            • langstringoptional

              language from the terminal

            • orderobjectoptional

              Order Details- with individual items

              • itemsarrayoptional

                List of items present in the order

                • itemNostringoptional

                  itemNo for the order item

                • referencestringoptional

                  reference for the order item

                • namestringoptional

                  name of the order item

                • quantityinteger (int32)optional

                  quantity of the order item

                • unitstringoptional

                  unit of the order item e.g. pc/kg

                • unitPriceinteger (int64)optional

                  Price for a single unit of the order line. Non-negative minor units. Excludes tax.

                • taxRateinteger (int64)optional

                  Tax rate of the order line. Non-negative value. The percentage value is represented with two implicit decimals. i.e. 2500 = 25%.

                • taxAmountinteger (int64)optional

                  Sum of total tax amount of the order line based on quantity and taxRate i.e. Tax of single unit * quantity

                • grossTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Includes tax

                • netTotalAmountinteger (int64)optional

                  Total amount of the order line. Must be defined as non-negative minor units. Excludes tax .

              • amountinteger (int64)optional

                Total Amount of the Order

              • currencystringoptional

                Currency of the order

              • referencestringoptional

                reference of the order

            • autoCapturestringoptional

              autoCapture from the terminal

        • naa2Ecrobjectoptional

          Naa to Ecr data

          • schemeIdstringoptional

            schemeId of the method passed i.e. 201 for SWISH_E_COM

          • pprefstringoptional

            ppref is the transaction id generated

          • payerIdstringoptional

            payerId identifying payer i.e. mobileno or code

          • additionalInfostringoptional

            AdditionalInfo in case of any error/message from the third party Payment Service Provider (PSP).

          • loyaltyIdsarrayoptional

            loyaltyIds

      • nextLinkobjectoptional

        Link to the next operation. e.g. status call post initialization.

        • typestringoptional
        • uriBuilderobjectoptional
        • relsarrayoptional
        • paramsobjectoptional
        • uristring (uri)optional
        • relstringoptional
        • titlestringoptional
    {
    "valid": true,
    "error": {
        "componsiteFault": {
            "faults": [
                {
                    "explanationText": "string",
                    "params": {
                        "property1": "string",
                        "property2": "string"
                    }
                }
            ]
        },
        "message": "string"
    },
    "response": {
        "responseCode": 0,
        "extendedResponseCode": 0,
        "request": {
            "transaction": {
                "transactionId": 0,
                "terminalReference": "string",
                "referenceId": "string",
                "agreementNumber": "string",
                "batch": 0,
                "timeStampOrigin": "2019-08-24T14:15:22Z",
                "timeStamp": "2019-08-24T14:15:22Z",
                "amount": {
                    "currencyCode": "string",
                    "vatAmount": 0,
                    "nominalAmount": 0,
                    "totalAmount": 0
                },
                "method": "string",
                "accountState": "COMMIT",
                "cancel": true,
                "message": "string",
                "state": "INITIALIZED",
                "origin": "string",
                "merchant": {
                    "merchantId": "string",
                    "name": "string",
                    "orgNumber": "string",
                    "vatNumber": "string",
                    "active": 0,
                    "countryCode": "string",
                    "merchantCatCode": "string",
                    "merchantCity": "string"
                },
                "consumer": {
                    "consumerId": "string",
                    "name": "string"
                },
                "receipt": {
                    "receiptId": 0,
                    "timeStamp": "2019-08-24T14:15:22Z",
                    "receiptData": [
                        "string"
                    ],
                    "receiptClass": "string"
                },
                "transitions": [
                    {
                        "timeStamp": "2019-08-24T14:15:22Z",
                        "from": "INITIALIZED",
                        "to": "INITIALIZED",
                        "event": "CREATE"
                    }
                ],
                "parameters": [
                    {
                        "parameterId": 0,
                        "key": "string",
                        "value": "string"
                    }
                ],
                "order": {
                    "items": [
                        {
                            "itemNo": "string",
                            "reference": "string",
                            "name": "string",
                            "quantity": 0,
                            "unit": "string",
                            "unitPrice": 0,
                            "taxRate": 0,
                            "taxAmount": 0,
                            "grossTotalAmount": 0,
                            "netTotalAmount": 0
                        }
                    ],
                    "amount": 0,
                    "currency": "string",
                    "reference": "string"
                },
                "trigger": "string",
                "transientConsumerId": "string"
            },
            "channel": "INTERNAL",
            "additionalProperties": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "ecr2Naa": {
                "ver": "string",
                "reference": "string",
                "lang": "string",
                "order": {
                    "items": [
                        {
                            "itemNo": "string",
                            "reference": "string",
                            "name": "string",
                            "quantity": 0,
                            "unit": "string",
                            "unitPrice": 0,
                            "taxRate": 0,
                            "taxAmount": 0,
                            "grossTotalAmount": 0,
                            "netTotalAmount": 0
                        }
                    ],
                    "amount": 0,
                    "currency": "string",
                    "reference": "string"
                },
                "autoCapture": "string"
            }
        },
        "naa2Ecr": {
            "schemeId": "string",
            "ppref": "string",
            "payerId": "string",
            "additionalInfo": "string",
            "loyaltyIds": [
                "string"
            ]
        }
    },
    "nextLink": {
        "type": "string",
        "uriBuilder": {},
        "rels": [
            "string"
        ],
        "params": {
            "property1": "string",
            "property2": "string"
        },
        "uri": "http://example.com",
        "rel": "string",
        "title": "string"
    }
}