Deposits

Description

The deposits endpoint returns the available deposit information for the given merchant.

Endpoint

GET /v3/merchants/{mId}/reports/deposits
https://clover.com/v3/merchants/{mId}/reports/deposits
curl --location --request GET 'https://www.clover.com/v3/merchants/{mId}/reports/deposits?filter=timestamp%3C<startDate>&filter=timestamp%3E<endDate>' \ --header 'Authorization: Bearer <Token>'

Requests

Path Parameter

Name

Type

Description

Max Length

mId

String

Indicates the merchant's ID.

13 characters

Query Parameter

Name

Type

Description

timestamp

String

Epoch time in a merchant's time zone.

Headers

Type

Description

Bearer Token

Authorization token required for getting deposits for {mId}.

X-Clover-Region

Required only for Asia-Pacific/India (APAC-IN) merchants.

Responses

The following are the responses that might occur when running the deposit 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

{
    "summaries": {
        "elements": [
            {
                "dateFunded": 1653019200000,
                "startDate": 1653019200000,
                "endDate": 1653019200000,
                "amountSubmitted": 42391,
                "transfers": 2,
                "amountTransferred": 42391,
                "paidByOthers": 0,
                "chargeBackDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "feesDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "taxDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                }
            },
            {
                "dateFunded": 1646888400000,
                "startDate": 1646888400000,
                "endDate": 1646888400000,
                "amountSubmitted": 490000,
                "transfers": 1,
                "amountTransferred": 490000,
                "paidByOthers": 0,
                "chargeBackDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "feesDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "taxDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                }
            },
            {
                "dateFunded": 1639630800000,
                "startDate": 1639630800000,
                "endDate": 1639630800000,
                "amountSubmitted": 15469,
                "transfers": 1,
                "amountTransferred": 15469,
                "paidByOthers": 0,
                "chargeBackDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "feesDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "taxDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                }
            },
            {
                "dateFunded": 1635566400000,
                "startDate": 1635566400000,
                "endDate": 1635566400000,
                "amountSubmitted": -1000,
                "transfers": 2,
                "amountTransferred": -1000,
                "paidByOthers": 0,
                "chargeBackDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "feesDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "taxDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                }
            },
            {
                "dateFunded": 1635480000000,
                "startDate": 1635480000000,
                "endDate": 1635480000000,
                "amountSubmitted": -1000,
                "transfers": 1,
                "amountTransferred": -1000,
                "paidByOthers": 0,
                "chargeBackDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "feesDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "taxDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                }
            },
            {
                "dateFunded": 1635220800000,
                "startDate": 1635220800000,
                "endDate": 1635220800000,
                "amountSubmitted": 15000,
                "transfers": 1,
                "amountTransferred": 15000,
                "paidByOthers": 0,
                "chargeBackDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "feesDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "taxDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                }
            },
            {
                "dateFunded": 1635134400000,
                "startDate": 1635134400000,
                "endDate": 1635134400000,
                "amountSubmitted": 0,
                "transfers": 9,
                "amountTransferred": -15200,
                "paidByOthers": 0,
                "chargeBackDetails": {
                    "rows": {
                        "elements": [
                            {
                                "name": "Chargebacks",
                                "majorCatCode": "12",
                                "amount": -1500,
                                "count": 1,
                                "categoryKey": "com.clover.reporting.funding.cat.chargebacks"
                            },
                            {
                                "name": "Reversals",
                                "majorCatCode": "3",
                                "amount": -300,
                                "count": 1,
                                "categoryKey": "com.clover.reporting.funding.cat.reversals"
                            }
                        ]
                    },
                    "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
                }
            },
            {
                "dateFunded": 1634270400000,
                "startDate": 1634270400000,
                "endDate": 1634270400000,
                "amountSubmitted": 25000,
                "transfers": 1,
                "amountTransferred": 25000,
                "paidByOthers": 0,
                "chargeBackDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "feesDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                },
                "taxDetails": {
                    "rows": {
                        "elements": []
                    },
                    "amount": 0
                }
            }
        ]
    },
    "startDate": 1622174400000,
    "endDate": 1653710399000,
    "totalAmountSubmitted": 585860,
    "totalAmountFees": -13400,
    "totalAmountTransferred": 570660,
    "totalNumberOfTransfers": 8,
    "totalTaxAmount": 0
}

Examples

Deposits with fees

The following is an example of the deposits endpoint for North America merchants when fees were included:

/v3/merchants/TP5871RSSQ90Y/reports/deposits?filter=timestamp%3C1638431998999&filter=timestamp%3E1638345600000
{
   "summaries":{
      "elements":[
         {
            "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
            }
         }
      ]
   },
   "startDate": 1638432000000,
   "endDate": 1638518398999,
   "totalAmountSubmitted": 251148,
   "totalAmountFees": -219606,
   "totalAmountTransferred": 31542,
   "totalNumberOfTransfers": 1,

   "totalTaxAmount": 0

}

Deposits with chargebacks

The following is an example of the deposits endpoint for North America merchants when chargebacks are included:

{
   "summaries":{
      "elements":[
         {
            "dateFunded":1635318000000,
            "startDate":1635318000000,
            "endDate":1635318000000,
            "amountSubmitted":293366,
            "transfers":6,
            "amountTransferred":290100,
            "paidByOthers":0,
            "chargeBackDetails":{
               "rows":{
                  "elements":[
                     {
                        "name":"Chargebacks",
                        "majorCatCode":"15",
                        "amount":-3266,
                        "count":2,
                        "categoryKey":"com.clover.reporting.funding.cat.chargebacks"
                     }
                  ]
               },
               "amount":-3266
            },
            "feesDetails":{
               "rows":{
                  "elements":[
                     
                  ]
               },
               "amount":0
            },

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


                  ]
               },
               "amount":0
            }

         }
      ]
   },
   "startDate":1635318000000,
   "endDate":1635404398999,
   "totalAmountSubmitted":293366,
   "totalAmountFees":0,
   "totalAmountTransferred":290100,
   "totalNumberOfTransfers":1,

   "totalTaxAmount": 0
}

📘

Note

A deposits with chargebacks response might contain both chargebacks and fees information.


Did this page help you?