v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Export Deposits

This request is used to export transaction deposit summaries for the specified date range

get/v1/deposit/summary

Query parameters

from_datestring required

Deposits created after the date. <br /><b>Format:</b>YYYY-MM-DD

to_datestring required

Deposits created before the date. <br /><b>Format:</b>YYYY-MM-DD

limitinteger

Number of records to be listed per page.

pageinteger

A number that represents the current page number.

excelinteger
selected_columnsstring

Selected columns for export. <br /> Ex. report_date,case_number,is_primary,transaction_date,case_amount,reason_desc,case_type,status,card_number,case_submitted,responded_date,last_updated_date

Response

200

Example response

{
  "data": {
    "rows_data": {
      "2024-09-13": {
        "row_data": [
          {
            "processing_date": "2024-09-13",
            "transaction_volume": 2816079.99,
            "amount": 2816079.99,
            "transaction_count": 76,
            "batch_reference_number": "630979120002",
            "batch_flag": 1,
            "transType": "DEPOSIT",
            "description": "Net Processing",
            "record_type": "D",
            "effective_date": "2024-09-13",
            "line_item": "Net Processing",
            "deposit_amount": 4755701
          }
        ],
        "row_totals": {
          "Amounts": 2850208.99,
          "Transactions": 77,
          "Settlement_Date": "2024-09-13"
        }
      },
      "2024-09-14": {
        "row_data": [
          {
            "processing_date": "2024-09-14",
            "transaction_volume": 3156398.99,
            "amount": 3156398.99,
            "transaction_count": 62,
            "batch_reference_number": "630979130017",
            "batch_flag": 1,
            "transType": "DEPOSIT",
            "description": "Net Processing",
            "record_type": "D",
            "effective_date": "2024-09-14",
            "line_item": "Net Processing",
            "deposit_amount": 3156399
          }
        ],
        "row_totals": {
          "Amounts": 3156398.99,
          "Transactions": 62,
          "Settlement_Date": "2024-09-14"
        }
      },
      "2024-09-18": {
        "row_data": [
          {
            "processing_date": "2024-09-18",
            "amount": 7912100,
            "transType": "RELEASED FUNDS",
            "description": "Release funding",
            "record_type": "D",
            "effective_date": "2024-09-18",
            "line_item": "Release funding"
          }
        ],
        "row_totals": {
          "Amounts": 7912100,
          "Settlement_Date": "2024-09-18"
        }
      }
    },
    "grand_total": {
      "total_amount": 13978707.98,
      "total_transaction": 139
    }
  }
}