Reporting Api

Reporting functions that return data based on payment processing services

POST/v6/merchant-batch/{merchantid}/{batch_no}/transactions

Retrieves transactions available on a given batch.

    Path Attributes

    Request Attributes

200 OK BatchTransactionReportResponse

    Response Attributes

Request

BatchTransactionReportRequest
{
  "maxResults":50,
  "nextToken":"n34liuwn435tUAGFNg34yn...",
  "orderBy":"date"
}

Response

BatchTransactionReportResponse
{
  "count":25,
  "data":[
    {
      "amount":"20.00",
      "amount_value":3600,
      "atrn":"",
      "authcode":"001245A",
      "batchno":"",
      "currency":"GBP",
      "datetime":"2020-01-02T18:32:28Z",
      "identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
      "maskedpan":"4***********0002",
      "merchantid":11223344,
      "result":"",
      "trans_status":"",
      "trans_type":"",
      "transno":78416
    }
  ],
  "maxResults":50,
  "nextToken":"n34liuwn435tUAGFNg34yn..."
}
POST/v6/merchant-batch/report

Retrieves a report of merchant batches within a specified date range. Batches, which aggregate daily processing activities, are typically generated at 00:00 each day. These batches play a crucial role in the settlement of funds by summarising daily transactions.

    Request Attributes

200 OK MerchantBatchReportResponse

    Response Attributes

Request

MerchantBatchReportRequest
{
  "date_from":"2024-01-24",
  "date_until":"2024-01-31",
  "maxResults":50,
  "merchant_id":[
    11223344,
    5667788
  ],
  "nextToken":"n34liuwn435tUAGFNg34yn...",
  "orderBy":"date"
}

Response

MerchantBatchReportResponse
{
  "batches":[
    {
      "batch_closed":"2024-05-15T19:03:19Z",
      "batch_no":"",
      "batch_status":"",
      "batch_status_code":"",
      "currency":"GBP",
      "merchantid":11223344,
      "net_summary":{
        "credit_items_amount":"£75.89",
        "credit_items_count":12345,
        "credit_items_value":11874500,
        "debit_items_amount":"£75.89",
        "debit_items_count":12345,
        "debit_items_value":11874500,
        "net_amount":11874500,
        "total_count":12345
      }
    }
  ],
  "count":25,
  "maxResults":50,
  "nextToken":"n34liuwn435tUAGFNg34yn..."
}
GET/v6/merchant-batch/{merchantid}/{batch_no}

Retrieves a report of merchant a merchant batch for a specified batch number.

    Path Attributes

200 OK MerchantBatchResponse

    Response Attributes

Response

MerchantBatchResponse
{
  "batch_closed":"2024-05-15T19:03:19Z",
  "batch_no":"",
  "batch_status":"",
  "batch_status_code":"",
  "currency":"GBP",
  "merchantid":11223344,
  "net_summary":{
    "credit_items_amount":"£75.89",
    "credit_items_count":12345,
    "credit_items_value":11874500,
    "debit_items_amount":"£75.89",
    "debit_items_count":12345,
    "debit_items_value":11874500,
    "net_amount":11874500,
    "total_count":12345
  }
}
GET/v6/remittance/report/{clientid}/{date}

Fetches remittance reports for financial transactions for a given date, covering all client-related activities. This report consolidates all batches disbursed to a client, with each remittance summarising the aggregation of batches leading up to settlement. Additionally, the net remittance amount presented in the final settlement will reflect any deductions made by the acquirer.

The process also supports the notion of today deferring the date to today's date or latest reflecting the latest remittance date available.

    Path Attributes

200 OK RemittedClientData

    Response Attributes

Response

RemittedClientData
{
  "batches":[
    {
      "batch_closed":"2024-05-15T19:03:19Z",
      "batch_no":"",
      "batch_status":"",
      "batch_status_code":"",
      "currency":"GBP",
      "merchantid":11223344,
      "net_summary":{
        "credit_items_amount":"£75.89",
        "credit_items_count":12345,
        "credit_items_value":11874500,
        "debit_items_amount":"£75.89",
        "debit_items_count":12345,
        "debit_items_value":11874500,
        "net_amount":11874500,
        "total_count":12345
      }
    }
  ],
  "clientid":"PC12345",
  "date":"2020-01-02",
  "date_created":"2020-01-02T18:32:28Z",
  "net_amount":11874500,
  "processed_amount":11874500,
  "processed_count":11874500,
  "refund_amount":11874500,
  "refund_count":11874500,
  "remittances":[
    {
      "date_created":"2020-01-02T18:32:28Z",
      "net_amount":11874500,
      "refund_amount":11874500,
      "refund_count":11874500,
      "sales_amount":11874500,
      "sales_count":11874500
    }
  ],
  "sales_amount":11874500,
  "sales_count":11874500,
  "settlement_implementation":"",
  "uuid":"123e4567-e89b-12d3-a456-426614174000"
}
POST/v6/remittance/report/{clientid}

Fetches remittance reports for financial transactions within a specified date range, covering all client-related activities. This report consolidates all batches disbursed to a client, with each remittance summarising the aggregation of batches leading up to settlement. Additionally, the net remittance amount presented in the final settlement will reflect any deductions made by the acquirer.

    Path Attributes

    Request Attributes

200 OK RemittanceReportResponse

    Response Attributes

Request

RemittanceReportRequest
{
  "date_from":"2024-01-24",
  "date_until":"2024-01-31",
  "maxResults":50,
  "merchant_id":[
    11223344,
    5667788
  ],
  "nextToken":"n34liuwn435tUAGFNg34yn...",
  "orderBy":"date"
}

Response

RemittanceReportResponse
{
  "count":25,
  "data":[
    {
      "batches":[
        {
          "batch_closed":"2024-05-15T19:03:19Z",
          "batch_no":"",
          "batch_status":"",
          "batch_status_code":"",
          "currency":"GBP",
          "merchantid":11223344,
          "net_summary":{
            "credit_items_amount":"£75.89",
            "credit_items_count":12345,
            "credit_items_value":11874500,
            "debit_items_amount":"£75.89",
            "debit_items_count":12345,
            "debit_items_value":11874500,
            "net_amount":11874500,
            "total_count":12345
          }
        }
      ],
      "clientid":"PC12345",
      "date":"2020-01-02",
      "date_created":"2020-01-02T18:32:28Z",
      "net_amount":11874500,
      "processed_amount":11874500,
      "processed_count":11874500,
      "refund_amount":11874500,
      "refund_count":11874500,
      "remittances":[
        {
          "date_created":"2020-01-02T18:32:28Z",
          "net_amount":11874500,
          "refund_amount":11874500,
          "refund_count":11874500,
          "sales_amount":11874500,
          "sales_count":11874500
        }
      ],
      "sales_amount":11874500,
      "sales_count":11874500,
      "settlement_implementation":"",
      "uuid":"123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "maxResults":50,
  "nextToken":"n34liuwn435tUAGFNg34yn..."
}