Transactions

GET api/transactions

Gets transaction by partner id and reference id.

Example

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
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
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.

Example

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
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
Status Code	Description	Message
200	OK

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

Gets transaction by partner id and transaction id.

Example

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
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
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.

Example

Request:

Response:

Request information
Name	Value	Description	Data Type	Example

Response information
Name	Description	Data Type	Example

Response information
Status Code	Description	Message
200	OK
400	Bad Request
404	Not Found

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

Get Payment Provider Session Details

Example

Request:

Response:

Request information
Name	Value	Description	Data Type	Example

Response information
Name	Description	Data Type	Example

Response information
Status Code	Description	Message
200	OK
400	Bad Request
404	Not Found

POST api/transactions

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

Example

Request:

Response:

Request information
Name	Value	Description	Data Type	Example

Response information
Name	Description	Data Type	Example

Response information
Status Code	Description	Message
200	OK
400	Bad Request
404	Not Found

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

Verifies a phone transaction with pincode and executes it.

Example

Request:

Response:

Request information
Name	Value	Description	Data Type	Example

Response information
Name	Description	Data Type	Example

Response information
Status Code	Description	Message
200	OK
400	Bad Request
404	Not Found

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

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

Example

Request:

Response:

Request information
Name	Value	Description	Data Type	Example

Response information
Name	Description	Data Type	Example

Response information
Status Code	Description	Message
200	OK
400	Bad Request
404	Not Found

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.

Example

Request:

Response:

Request information
Name	Value	Description	Data Type	Example

Response information
Name	Description	Data Type	Example

Response information
Status Code	Description	Message
200	OK
400	Bad Request
404	Not Found

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

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

Example

Request:

Response:

Request information
Name	Value	Description	Data Type	Example

Response information
Name	Description	Data Type	Example

Response information
Status Code	Description	Message
200	OK
400	Bad Request
404	Not Found

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

Cancel transaction, will fail if money is captured.

Example

Request:

Response:

Request information
Name	Value	Description	Data Type	Example

Response information
Name	Description	Data Type	Example

Response information
Status Code	Description	Message
200	OK
400	Bad Request
404	Not Found