Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Endpoints

Retrieve a single transaction

Returns single Transaction for the given unique ID

get/transactions/{id}

Path parameters

idstring required

Unique system identifier of the record in our system.

Example:54321123456

The unique system id for the transaction to retrieve.

Response

OK

idstring required

Unique system identifier of the record in our system.

postedstring date-time required

The date and time (in ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) the clearing message was sent for the transaction.

authorisedstring date-time

The date and time (in ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) the authorisation occurred, relative to the terminal location.

status'CLEARED' | 'REJECTED' | 'PENDING' required

Whether the transaction has yet been cleared or rejected.

type'PURCHASE' | 'PAYMENT' | 'CASH_ADVANCE' | 'REFUND' | 'PURCHASE_WITH_CASHBACK' | 'CARD_VERIFICATION' | 'PREPAID_LOAD' | 'BALANCE_ENQUIRY' | 'CHECK_VERIFICATION' | 'CHECK_GUARANTEE' | 'PURCHASE_ADJUSTMENT' | 'MOBILE_TOPUP' | 'PURCHASE_WITH_TIP' | 'ADMIN' | 'ACCOUNT_FUNDING_TRANSACTION' | 'ORIGINAL_CREDIT' | 'MONEY_TRANSFER' required

The nature of the transaction, which often signifies how it is processed. The most common type is a purchase (the transfer of money for goods or services), but may refer to things like a refund or card verification.

channel'ECOMMERCE' | 'POINT_OF_SALE' | 'PAY_BY_LINK' | 'MAIL_ORDER' | 'TELEPHONE_ORDER' required

A categorisation for the system which generated the transaction record. The most common being point of sale (such as an in-store card payment) or ecommerce (via an online store), but also includes channels like pay by link, mail order and telephone order.

Example response

{
  "id": "54321123456",
  "posted": "2021-08-16T14:12:43Z",
  "authorised": "2021-08-16T14:12:43Z",
  "channel": "ECOMMERCE",
  "merchant": {
    "id": "520334547514337",
    "name": "Matt's Bicycles Ltd",
    "countryCode": "GBR",
    "mcc": "0742",
    "allianceCode": "FISV",
    "partnerCode": "DIGI_PMNTS",
    "storeId": "1108707593"
  },
  "meta": {
    "orderId": "54321123456",
    "authorisationCode": "454903",
    "fundingDetailId": "54321123456",
    "retrievalReferenceNumber": "130237163512",
    "originalReference": "12345678900",
    "terminalBatchNumber": "EPV190917_01",
    "merchantTransactionReference": "GGIC-FK-432432-AB",
    "acquirerReferenceNumber": "87263457739999123742"
  },
  "paymentInstrument": {
    "brand": "VISA",
    "number": "446998******2153",
    "subType": "N2"
  },
  "financial": {
    "amounts": {
      "currencyCode": "GBP",
      "transacted": "20.99",
      "cashback": "20.99",
      "tip": "20.99"
    },
    "fees": [
      {
        "type": "INTERCHANGE",
        "currencyCode": "GBP",
        "amount": "1.45732"
      }
    ],
    "funding": {
      "currencyCode": "GBP",
      "gross": "20.99",
      "charges": "20.99",
      "net": "20.99"
    }
  },
  "captureEnvironment": {
    "platform": "IPG",
    "captureMethod": "CHIP_CONTACTLESS"
  },
  "_links": {
    "authorisations": {
      "href": "/authorisations?createdAfter=2021-08-16&createdBefore=2021-08-16&orderId=123456"
    },
    "fundings": {
      "href": "/fundings?fundedAfter=2021-08-16&fundedBefore=2021-08-17&fundingDetailId=123456"
    }
  }
}