Querying DTX and QDTX groups

🔶
Legacy API. This topic describes our original API. If you are integrating with Vitesse, use Vitesse API instead.

Deferred transaction groups are generated when grouping one or more available deferred (DTX) or queued deferred (QDTX) transactions together. You can group transactions as follows...

POST api/deferredTransactionGroups

[
  "a748030b-986b-4201-8b40-eb05abe81445",
  ...
]

That will group the transaction(s) together and return a response...

{
  "CreatedBy": "System",
  "CreatedOn": "2020-01-29T07:50:00.697Z",
  "Currency": "GBP",
  "DeferredTransactionGroupId": 51,
  "ExpiresOn": "2020-01-29T17:35:04.573Z",
  "MerchantId": 5,
  "MerchantName": "Transfercorp UK Ltd",
  "Name": "002TUK",
  "PayInAccount": {
    "Details": {
      "AccountNumber": "99988776",
      "SortCode": "112211"
    },
    "Name": "Barclays GBP"
  },
  "Status": "AwaitingLiquidity",
  "TotalAmount": 1000.00,
  "TotalFees": 0.0,
  "TotalPayment": 1000.00
}

Querying DTX groups

You can query the set of DTX groups in the system by issuing the following GET request...

GET api/deferredTransactionGroups

That will respond with an array of zero or more groups...

[
  {
    "CreatedBy": "System",
    "CreatedOn": "2020-01-29T07:50:00.697Z",
    "Currency": "GBP",
    "DeferredTransactionGroupId": 51,
    "ExpiresOn": "2020-01-29T17:35:04.573Z",
    "MerchantId": 5,
    "MerchantName": "Transfercorp UK Ltd",
    "Name": "002TUK",
    "PayInAccount": {
      "Details": {
        "AccountNumber": "asdasdassdd"
      },
      "Name": "Barclays GBP"
    },
    "Status": "Completed",
    "TotalAmount": 1000.00,
    "TotalFees": 0.00,
    "TotalPayment": 1000.00
  },
  {
    "CreatedBy": "System",
    "CreatedOn": "2020-01-28T17:59:47.753Z",
    "Currency": "GBP",
    "DeferredTransactionGroupId": 50,
    "ExpiresOn": "2020-01-29T17:35:04.573Z",
    "MerchantId": 5,
    "MerchantName": "Transfercorp UK Ltd",
    "Name": "001TUK",
    "PayInAccount": {
      "Details": {
        "AccountNumber": "asdasdassdd"
      },
      "Name": "Barclays GBP"
    },
    "Status": "AwaitingLiquidity",
    "TotalAmount": 1000.00,
    "TotalFees": 0.00,
    "TotalPayment": 1000.00
  },
  ...
]

Querying a DTX group

You can also query an individual DTX group using the DeferredTransactionGroupId...

GET api/deferredTransactionGroups/{id}

In addition you can also query the transactions within that group...

GET api/deferredTransactionGroups/{id}/transactions

That will respond with an array of the transactions for that group...

[
  {
    "CreatedOn": "2020-01-28T17:35:40.11Z",
    "DestinationCurrency": "GBP",
    "DestinationValue": 1000.00,
    "ExchangeRate": 1.0000000000,
    "ExpiresOn": "2020-01-29T17:35:04.573Z",
    "LatePaymentMode": "Cancel",
    "MerchantName": "Transfercorp UK Ltd",
    "SendAccount": "Transfercorp UK Ltd GBP",
    "SendAccountId": 339,
    "SourceCurrency": "GBP",
    "SourceValue": 1000.00,
    "Status": "PendingPayment",
    "TransactionRequestId": "c1363d1b-5df9-4eed-a5d5-45677924f3dd"
  }
]

For for the API reference documentation that shows details of the JSON requests please see here.