GET api/transactions?partnerId={partnerId}&referenceId={referenceId}&api-version=2.0

Gets transaction by partner id and reference id.

Request Information

URI Parameters

NameDescriptionTypeRequiredAdditional information
partnerId

Partner id.

integer

Required

referenceId

Unique client reference id.

string

Required

Body Parameters

None.

Response Information

Resource Description

TransactionResponseV2
NameDescriptionTypeRequiredAdditional information
TransactionId

Unique transaction id.

globally unique identifier

None.

CreatedDateUtc

Date and time for creation of this transaction, in UTC.

date

None.

PaymentTransactionId

Payment transaction id provided by the payment implementation used.

string

None.

Status

Transaction status provided by the payment implementation used.

string

None.

Success

Whether the transaction was processed succesfully.

boolean

None.

StatusDescription

Description of the status (such as error description of why a transaction has status code 'Failed').

string

None.

StatusCode

Tranaction status code ('Registered', 'Authorized', 'Captured', 'Failed' or 'Annulled').

string

None.

PaymentSetup

Pseudo-form object graph used to generate an HTML submission form.

PaymentSetupV2

None.

PaymentDateUtc

DateTime of the actual payment

date

None.

PartnerId

PartnerId provided by LINK Mobility AS

integer

Range: inclusive between 1 and 2147483647

Currency

Currency code (ISO-4217).

string

Required

String length: inclusive between 0 and 3

Amount

Amount (with support for 2 decimals)

decimal number

Matching regular expression pattern: ^\d+(.\d{1,2})?$

Range: inclusive between 0 and 999999.99

ReturnUrl

Return url/landing page after transaction is completed. Example: https://somedomain.net/returnToMeApp/{{referenceId}}/{{status}}

string

String length: inclusive between 0 and 2000

StatusCallbackUrl

Transaction status callback url.

string

String length: inclusive between 0 and 2000

ReferenceId

Client reference id (must be unique for per client transaction if used). Note: Not to be used for personal information.

string

String length: inclusive between 0 and 50

PaymentProvider

Defines which Payment provider (that should be) used

string

Required

PaymentEntity

Payment entity used (phone number for PaymentProvider Phone or Card PAN hash for Nets).

string

String length: inclusive between 0 and 30

Description

General description of transaction.

string

String length: inclusive between 0 and 500

Ocr

Ocr Note: Not to be used for personal information.

string

String length: inclusive between 0 and 32

Response Formats

application/json, text/json

Sample:
{
  "transactionId": "6f38c399-fe67-4e28-919a-7c93ad933b35",
  "createdDateUtc": "2024-04-28T17:37:03.2544981Z",
  "paymentTransactionId": "sample string 3",
  "status": "sample string 4",
  "success": true,
  "statusDescription": "sample string 5",
  "statusCode": "sample string 6",
  "paymentSetup": {
    "method": "sample string 1",
    "url": "sample string 2",
    "fields": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  "paymentDateUtc": "2024-04-28T17:37:03.2544981Z",
  "partnerId": 7,
  "currency": "sample string 8",
  "amount": 9.0,
  "returnUrl": "sample string 10",
  "statusCallbackUrl": "sample string 11",
  "referenceId": "sample string 12",
  "paymentProvider": "sample string 13",
  "paymentEntity": "sample string 14",
  "description": "sample string 15",
  "ocr": "sample string 16"
}