SportsPay's Deposit Query functionality allows users to retrieve information about deposits, including batch details and individual transaction items within those deposits.

This guide provides detailed instructions on how to execute Deposit List and Deposit Info queries using the SportsPay API.

1. Deposit List

Retrieve a list of deposits based on a starting point (e.g., the last known deposit number). This can be useful for financial reconciliation or auditing purposes.

1.1 Deposit List Request

Purpose: Retrieve a list of deposits starting from the provided deposit number (LASTDEP).

Request

The Deposit List API Reference outlines the required and optional parameters needed for your request. The minimum required information includes the merchant's Terminal ID (TERMID), Password (PASS), the type of request (TYPE as Q for Query), and the subtype (SUBTYPE as DL for Deposit List).

Optional parameters include the deposit number (DEPNUM) of the last deposit from which you want to query. For example, if you input "0005", it will query deposits "0006" and onwards. If you omit this field, it will give you the merchant's entire deposit history.

Refer to Deposit Query API Reference

Example Deposit List Request:

# Example Deposit List request
curl --request POST \
  --url https://svra.interpaypos.com:1443/ \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
    "TERMID": "TEST0058",
    "PASS": "zX3Ht5va",
    "TYPE": "Q",
    "SUBTYPE": "DL",
    "LASTDEP": "DEP12345"
  }'

Response

TEXT: "Deposit List" for success, or a relevant error message.
CODE: "0000" for success, other codes for errors.
MERCHID: Merchant ID.
PREVDEP: Previous deposit number.
NEWDEP: Array of deposits, each containing:
- DEPNUM: Deposit number.
- DATE: Deposit date.
- AMOUNT: Deposit amount.
- NUMITEMS: Number of items in the deposit.

2. Deposit Info

Retrieve information about a specific deposit or transaction, including individual transaction items within the deposit.

2.1 Deposit Info Request

Purpose: Retrieve deposit information about a specific deposit (either just a summary or details) or transaction.

Request

The Deposit Info API Reference outlines the required and optional parameters needed for your request. At a minimum, include the merchant's Terminal ID (TERMID), Password (PASS), the type of request (TYPE as Q), and the subtype (SUBTYPE as DI).

Additional parameters depend on the information you want to retrieve:

SUMMARY

DEPNUM: Retrieve summary deposit details for a specific deposit using the deposit number.
- BLOCK: Add BLOCK=0 for summary. (Refer to Detail section below for using BLOCK field to get Details.

GATEREF: Retrieve summary deposit details for a specific transaction using the gateway reference.

REFNUM&AUTHNUM: Retrieve summary deposit details for a specific transaction using the reference and authorization numbers.

DETAIL

To get a detailed report when querying using DEPNUM, add the parameter BLOCK to specify whether you want just a summary or a detailed breakdown. The response for a deposit query may span multiple blocks. Each Block can have up to 25 items. Add BLOCK=0 for summary or BLOCK=1 for item details. If you omit this field, the default is BLOCK=1 (details). Use BLOCK=1, BLOCK=2, etc., to retrieve all items.

Refer to Deposit Query API Reference

Example Deposit Info Request (Summary):

# Example Deposit Info Summary request
curl --request POST \
  --url https://svra.interpaypos.com:1443/ \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
    "TERMID": "TEST0058",
    "PASS": "zX3Ht5va",
    "TYPE": "Q",
    "SUBTYPE": "DI",
    "DEPNUM": "DEP12345",
    "BLOCK": "0"
  }'

Example Deposit Info Request (Detail)

# Example Deposit Info Detail request
curl --request POST \
  --url https://svra.interpaypos.com:1443/ \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
    "TERMID": "TEST0058",
    "PASS": "zX3Ht5va",
    "TYPE": "Q",
    "SUBTYPE": "DI",
    "DEPNUM": "DEP12345",
    "BLOCK": "1"
  }'

Example Deposit Info Request (Summary) using GATEREF:

# Example Deposit Info Summary request using GATEREF
curl --request POST \
  --url https://svra.interpaypos.com:1443/ \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
    "TERMID": "TEST0058",
    "PASS": "zX3Ht5va",
    "TYPE": "Q",
    "SUBTYPE": "DI",
    "GATEREF": "t45hgu1ts4f1t"
  }'

Example Deposit Info Request (Summary) using REFNUM & AUTHNUM:

# Example Deposit Info Summary request using REFNUM and AUTHNUM
curl --request POST \
  --url https://svra.interpaypos.com:1443/ \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
    "TERMID": "TEST0058",
    "PASS": "zX3Ht5va",
    "TYPE": "Q",
    "SUBTYPE": "DI",
    "REFNUM": "0000960102",
    "AUTHNUM": "06638I"
  }'

Response for Info Request (Detail)

TEXT: "Deposit Info" for success, or a relevant error message.
CODE: "0000" for success, other codes for errors.
MERCHID: Merchant ID.
DEPNUM: Deposit number.
DEPDATE: Deposit date.
AMOUNT: Total amount of the deposit.
NUMITEMS: Number of items in the deposit.
BLOCK: Block number of the retrieved items.
NUMBLOCKS: Total number of blocks available for the deposit.
ITEMS: List of individual transactions within the deposit block, each containing:
- TERMID: Terminal ID associated with the transaction.
- TYPE: Transaction type (e.g., SALE).
- CARDNUM: Masked card number.
- CHARGED: Amount charged.
- WITHHELD: Amount withheld.
- DEPOSITED: Amount deposited.
- GATEREF: Gateway reference.
DATE: Date the query was made.
TIME: Time the query was made.
DUR: Amount of time it took server to provide response.

Response for Info Request (Summary)

TEXT: "Deposit Info" for success, or a relevant error message.
CODE: "0000" for success, other codes for errors.
MERCHID: Merchant ID.
DEPNUM: Deposit number.
DEPDATE: Deposit date.
AMOUNT: Total amount of the deposit.
NUMITEMS: Number of items in the deposit.
DATE: Date the query was made.
TIME: Time the query was made.
DUR: Amount of time it took server to provide response.