DateFunded

Description

The dateFunded endpoint returns the available deposit information for a specific date.

Endpoint

GET v3/merchants/{mid}/reports/deposits/batch/{dateFunded}
https://clover.com/v3/merchants/{mId}/reports/deposits/batch/{dateFunded}
curl --location --request GET 'http://www.clover.com/v3/merchants/{mId}/reports/deposits/batch/{dateFunded}' \
--header 'Authorization: Bearer <Token>'

Requests

Path Parameter

Name

Type

Description

Max Length

mId

String

Indicates the merchant's ID.

13 characters

dateFunded

Long

Date the transaction was funded.

Responses

The following are the responses that might occur when running the dateFunded endpoint.

Message

Description

Example

200

Indicates a valid response.

Refer to 200 response

400
(BadRequestException)

The request is invalid, and subsequent calls will continue to fail.

{ "message": "Platform Not Supported" }

400
(DomainException)

This occurred because of an incomplete/empty filter query parameter.

{ "message": "Please specify a time window for this query." }

400
(ParseException)

This occurs if the filter query is not a timestamp.

{ "message": "Unable to parse filter: ''" }

401

Indicates an invalid bearer token was provided when attempting to authorize funding details of a merchant {mId}.

{ "message": "401 Unauthorized" }

405

Indicates an incorrect base URL.

405 GET not allowed

500

This typically occurs if a query exceeds a time limit.

Internal server Error

200 response

{
    "dateFunded": 1635134400000,
    "startDate": 1635134400000,
    "endDate": 1635134400000,
    "amountSubmitted": 0,
    "transfers": 9,
    "amountTransferred": -15200,
    "paidByOthers": 0,
    "chargeBackDetails": {
        "rows": {
            "elements": [
                {
                    "name": "Reversals",
                    "majorCatCode": "3",
                    "amount": -300,
                    "count": 1,
                    "categoryKey": "com.clover.reporting.funding.cat.reversals"
                },
                {
                    "name": "Chargebacks",
                    "majorCatCode": "12",
                    "amount": -1500,
                    "count": 1,
                    "categoryKey": "com.clover.reporting.funding.cat.chargebacks"
                }
            ]
        },
        "amount": -1800
    },
    "feesDetails": {
        "rows": {
            "elements": [
                {
                    "name": "Fees",
                    "majorCatCode": "6",
                    "amount": -10000,
                    "count": 2,
                    "categoryKey": "com.clover.reporting.funding.cat.fees"
                },
                {
                    "name": "Processing Service Charges",
                    "majorCatCode": "11",
                    "amount": -500,
                    "count": 1,
                    "categoryKey": "com.clover.reporting.funding.cat.service_charge"
                },
                {
                    "name": "Adjustments",
                    "majorCatCode": "2",
                    "amount": -2400,
                    "count": 3,
                    "categoryKey": "com.clover.reporting.funding.cat.adjustments"
                },
                {
                    "name": "Interchange Charges",
                    "majorCatCode": "7",
                    "amount": -500,
                    "count": 1,
                    "categoryKey": "com.clover.reporting.funding.cat.interchange_charges"
                }
            ]
        },
        "amount": -13400
    },
    "taxDetails": {
        "rows": {
            "elements": []
        },
        "amount": 0
    }
}

Examples

North American Merchants

The following is an example of the dateFunded endpoint for North America merchants:

v3/merchants/TP5871RSSQ90Y/reports/deposits/batch/1638432000000
{
   "dateFunded":1638432000000,
   "startDate":1638432000000,
   "endDate":1638432000000,
   "amountSubmitted":251148,
   "transfers":120,
   "amountTransferred":31542,
   "paidByOthers":0,
   "chargeBackDetails":{
      "rows":{
         "elements":[
            
         ]
      },
      "amount":0
   },
   "feesDetails":{
      "rows":{
         "elements":[
            {
               "name":"Interchange Charges",
               "majorCatCode":"12",
               "amount":-172290,
               "count":87,
               "categoryKey":"com.clover.reporting.funding.cat.interchange_charges"
            },
            {
               "name":"Fees",
               "majorCatCode":"30",
               "amount":-41666,
               "count":21,
               "categoryKey":"com.clover.reporting.funding.cat.fees"
            },
            {
               "name":"Processing Service Charges",
               "majorCatCode":"13",
               "amount":-5650,
               "count":8,
               "categoryKey":"com.clover.reporting.funding.cat.service_charge"
            }
         ]
      },
      "amount":-219606
   },

    "taxDetails":{
       "rows":{
          "elements":[


                  ]
               },
               "amount":0
            }

         }

Did this page help you?