Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Endpoints

List Transactions

Return a list of all transactions, restricted by your allianceCode, partnerCode or merchant ID (as appropriate) for the given datetime range.

get/transactions

Query parameters

postedAfterstring date

Filter transactions on the posted field from the given date value in ISO 8601 format yyyy-MM-dd, anything from the time 00:00:00 on the given day would match.

Default: Current day

postedBeforestring date

Filter transactions on the posted field up to and including the given date value in ISO 8601 format yyyy-MM-dd, anything up the the time 23:59:59 on the given day would match.

Default: Current day

limitinteger

Number of elements to be returned in a single query.

Can be used for page/offset or cursor based pagination

offsetinteger

Starting point to start retrieving the elements from. It is "0" based i.e. value "0" signifies the first page.

This can be used with "limit".

Can be used for page/offset based pagination.

sortstring

Specifies the sequence of elements and order to sort the payload by

Defines how to sort the records returned. Must be specified in the syntax '+' (ascending) or '-' (descending) followed by the field name.

For example: +posted would sort by the 'posted' field ascending.

Allowed fields: posted

Default: +posted (oldest first)

terminalIdstring
Example:890123456

Filter for records made on a specific terminal by ID.

orderIdstring
Example:890123456

Filter for records linked by the order ID from our payment gateway.

fundingIdstring
Example:890123456

Filter for records linked by a funding record's id via the /fundings endpoint.

fundingDetailIdstring
Example:890123456

Filter for records linked by a funding detail record's id via the /fundings/{id}/details endpoint.

Headers

Partner-Codestring
Example:DIGI_PAYMENTS

For use by an alliance when there is a need to filter on a specific partner within their scope. May be restricted based on the API key.

Merchant-Idstring
Example:1234567890

For use by an alliance or partner when there is a need to filter on a specific merchant within their scope. May be restricted based on the API key.

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"
      }
    }
  }
]