Transactions

GET api/transactions

Gets transaction by partner id and reference id.

Request: GET api/transactions?partnerId={partnerId}&referenceId={referenceId} GET api/transactions?partnerId={partnerId}&referenceId={referenceId}&api-version=2.0 Response: { "transactionId": "00000000-0000-0000-0000-000000000000", "createdDateUtc": "2023-11-30T15:05:33.087Z", "paymentTransactionId": "string", "status": "string", "success": true, "statusDescription": "string", "statusCode": "string", "paymentSetup": { "method": "string", "url": "string", "fields": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "paymentDateUtc": "2023-11-30T15:05:33.087Z", "partnerId": 0, "currency": "string", "amount": 0, "returnUrl": "string", "statusCallbackUrl": "string", "referenceId": "string", "paymentProvider": "string", "paymentEntity": "string", "description": "string", "ocr": "string" }

 

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId. Provided to you by LINK Mobility.

integer

10295

referenceId

required

Reference Id

string

“some-string“

Response information

Response information

TransactionResponseV2

Response information

Response information

Status Code

Description

Message

200

OK

 

400

Bad Request

Missing required parameter referenceId.

404

Not Found

Transaction for partner id '{partnerId}' and reference id '{referenceId}' not found.

GET api/transactions/search/{partnerId}

Get list of transactions.

Request: GET api/transactions/search/{partnerId}?fromDate={fromDate} GET api/transactions/search/{partnerId}?fromDate={fromDate}&api-version=2.0 Response: { "transactions": [ { "transactionId": "00000000-0000-0000-0000-000000000000", "createdDateUtc": "2023-11-30T15:10:45.684Z", "paymentTransactionId": "string", "status": "string", "success": true, "statusDescription": "string", "statusCode": "string", "paymentSetup": { "method": "string", "url": "string", "fields": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "paymentDateUtc": "2023-11-30T15:10:45.684Z", "partnerId": 0, "currency": "string", "amount": 0, "returnUrl": "string", "statusCallbackUrl": "string", "referenceId": "string", "paymentProvider": "string", "paymentEntity": "string", "description": "string", "ocr": "string" } ] }

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId. Provided to you by LINK Mobility.

integer

10295

fromDate

required

FromDate is bottom limit.

string

Format yyyy-MM-dd|yyyy-MM-ddTHH:mm

Response information

Response information

List of TransactionResponseV2

Response information

Response information

Status Code

Description

Message

200

OK

 

GET api/transactions/{partnerId}/{transactionId}

Gets transaction by partner id and transaction id.

Request: GET api/transactions/{partnerId}/{transactionId} GET api/transactions/{partnerId}/{transactionId}?api-version=2.0 Response: { "transactionId": "fa5339f5-ac84-4eb4-966e-6510829f0f38", "createdDateUtc": "2023-11-30T13:31:56.385791Z", "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": "2023-11-30T13:31:56.3980965Z", "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" }

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId. Provided to you by LINK Mobility.

integer

10295

transactionId

required

Transaction id.

GUID

“452c1d44-5a0d-4216-b5da-a4533036e010“

Response information

Response information

TransactionResponseV2

Response information

Response information

Status Code

Description

Message

200

OK

 

404

Not Found

Transaction with id '" + transactionId + "' not found.

GET api/transactions/search/{partnerId}/{recurringPaymentId}

Get list of transactions.

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId. Provided to you by LINK Mobility.

integer

10295

recurringPaymentId

required

 

integer

100

Response information

Response information

List of TransactionResponseV2

Response information

Response information

Status Code

Description

Message

200

OK

 

GET api/transactions/{partnerId}/{transactionId}/psp-session

Get Payment Provider Session Details

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId. Provided to you by LINK Mobility.

int

10295

transactionId

required

Transaction Id

GUID

“452c1d44-5a0d-4216-b5da-a4533036e010“

Response information

 

Response information

 

Name

Description

Data Type

Example

 

Status

Transaction status

string

“some string“

 

"Reference

Transaction reference

string

“some string“

 

PaymentType

payment provider

string

“some string“

 

CustomProviderData

Custom data from the provider

object

 

 

POST api/transactions

Creates a new transaction. Use the 'Location' http header to learn the resulting url of the created resource.

Request information (from body)

Request information (from body)

Name

Value

Description

Data Type

Example

PartnerId

optional

PartnerId provided by LINK Mobility AS

integer

10295

Currency

required

Currency code (ISO-4217).

string

USD

Amount

optional

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

Range: inclusive between 0 and 999999.99

decimal

10.23

ReturnUrl

optional

Return url/landing page after transaction is completed.

string

some url

StatusCallbackUrl

optional

Transaction status callback url.

string

some url

ReferenceId

optional

Client reference id (must be unique for per client transaction if used).

string

“some-string“

PaymentProvider

required

Defines which Payment provider (that should be) used

string

“some-string“

PaymentEntity

optional

Payment entity used

string

“some-string“

Description

optional

General description of transaction.

string

“some-string“

OCR

optional

Ocr Note:

string

“some-string“

Response information

Response information

Status Code

Description

Message

200

OK

 

409

Conflict

Reference id '{transactionRequest.ReferenceId}' already exists.

POST api/transactions/{partnerId}/{transactionId}/pincode

Verifies a phone transaction with pincode and executes it.

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId provided by LINK Mobility AS

integer

10295

transactionId

required

Transaction Id

GUID

“452c1d44-5a0d-4216-b5da-a4533036e010“

Request information (from body)

Request information (from body)

Name

Value

Description

Data Type

Example

pinCode

required

Pincode to verify transaction

string

“some string“

Response information

Response information

Status Code

Description

Message

200

OK

 

400

Bad Request

Wrong pincode.

Exception message.

404

Not Found

Transaction with id '" + transactionId + "' not found.

PUT api/transactions/{partnerId}/{transactionId}/capture

Full capture authorized transaction, if transaction is not authorized it will fail.

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId provided by LINK Mobility AS

integer

10295

transactionId

required

Transaction Id

GUID

“452c1d44-5a0d-4216-b5da-a4533036e010“

Response information

Response information

Status Code

Description

Message

200

OK

 

403

Forbidden

Capture failed for transaction id: 'transactionId': Message.

404

Not Found

Transaction with id '" + transactionId + "' not found.

500

Internal Server Error

Capture failed for transaction id: 'transactionId': Message.

PUT api/transactions/{partnerId}/{transactionId}/{amount}/capture

Partial capture authorized transaction. Amount should be '.' separated number (123.45) if transaction is not authorized it will fail.

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId provided by LINK Mobility AS

integer

10295

transactionId

required

Transaction Id

GUID

“452c1d44-5a0d-4216-b5da-a4533036e010“

amount

required

Transaction amount

decimal

10.25

Response information

Response information

Status Code

Description

Message

200

OK

 

403

Forbidden

Capture failed for transaction id: 'transactionId': Message.

404

Not Found

Transaction with id '" + transactionId + "' not found.

500

Internal Server Error

Capture failed for transaction id: 'transactionId': Message.

PUT api/transactions/{partnerId}/{transactionId}/refund

Refund transaction, if money is captured it will be refunded.

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId provided by LINK Mobility AS

integer

10295

transactionId

required

Transaction Id

GUID

“452c1d44-5a0d-4216-b5da-a4533036e010“

Response information

Response information

Status Code

Description

Message

200

OK

 

400

Bad Request

Refund failed for transaction id 'transactionId': Message.

403

Forbidden

Refund failed for transaction id 'transactionId': Message.

404

Not Found

Transaction with id '" + transactionId + "' not found.

500

Internal Server Error

Refund failed for transaction id 'transactionId': Message.

PUT api/transactions/{partnerId}/{transactionId}/cancel

Cancel transaction, will fail if money is captured.

Request information

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId provided by LINK Mobility AS

integer

10295

transactionId

required

Transaction Id

GUID

“452c1d44-5a0d-4216-b5da-a4533036e010“

Response information

Response information

Status Code

Description

Message

200

OK

 

403

Forbidden

Transaction id 'transactionId' is completed and can not be cancelled.
Transaction id 'transactionId' is already cancelled.
Cancel failed for transaction id 'transactionId': Message.

404

Not Found

Transaction with id '" + transactionId + "' not found.

500

Internal Server Error

Cancel failed for transaction id 'transactionId': Message.

 

Feeling lost? Click on this link! Portal page