Payment API

Transaction

API Documentation

Senest redigeret:

Introduction

A Transaction represents a single transaction in relation to a Payment.

Properties

Name

Type

Example

Description

transactionGuid

STRING

a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx

Unique GUID

createdTs

TIMESTAMP

 

Timestamp of Transaction creation

paymentGuid

STRING

 

Unique GUID of Payment

amount

DOUBLE

 

Transaction amount

paymentGatewayProvider

STRING

 

Such as ePay, MobilePaySubscriptions, Betalingsservice, LinkMobility, Test

paymentGatewayGuid

STRING

 

Unique GUID of Payment Gateway

paymentGatewaySubscriptionReferenceId

STRING

 

Subscription token at Payment Gateway

paymentGatewayPaymentReferenceId

STRING

 

Payment token at Payment Gateway

transactionTs

TIMESTAMP

 

Timestamp of transaction

transactionType

STRING

Charge, Refund

Type of transaction

paymentMethodAccountingCode

STRING

 

Accounting Code defined by Payment Method

chargeAttemptGuid

STRING

 

Unique GUID of Charge Attempt

paymentMethodGuid

STRING

 

Unique GUID of Payment Method

 

Endpoints

GET /transactions?pageNumber={x}&pageSize={y}&startDate={yyyy-mm-dd}&endDate={yyyy-mm-dd}

Get a list of Transactions at a given size by a given offset and date limitation.

Response

HTTP

Description

200

OK

HTTP 200 Example

{
  "pageNumber": {x},
  "pageSize": {y},
  "startDate": {yyyy-mm-dd},
  "endDate": {yyyy-mm-dd},
  "list": [
    {
      "transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
      "...": "..."
    },
    {
      "transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
      "...": "..."
    }
  ]
}

 

GET /transaction/{guid}

Get a single Transaction.

Response

HTTP

Description

200

OK

404

Transaction not found

HTTP 200 Example

{
  "transactionGuid": "8386b0c8-8210-4b12-a8df-xxxxxxxxxxxx",
  "merchantId": "merchant-name",
  "createdTs": "2020-01-10 14:51:23 +0100",
  "paymentGuid": "269916c5-bf4e-4fda-acf0-xxxxxxxxxxxx",
  "paymentMethodGuid": "24820946-9f48-4132-a8c5-xxxxxxxxxxxx",
  "chargeAttemptGuid": "d606d586-8abb-41d3-bbe0-xxxxxxxxxxxx",
  "amount": 100.0,
  "paymentGatewayProvider": "Test",
  "paymentGatewayGuid": "bfc19988-348d-4f40-b003-xxxxxxxxxxxx",
  "paymentGatewaySubscriptionReferenceId": "xxxxxxxxxxxx",
  "paymentGatewayPaymentReferenceId": "xxxxxxxxxxxx",
  "transactionTs": "2020-01-10 14:51:23 +0100",
  "transactionType": "Charge"
}