Description

The card_types endpoint returns a report of the amount funded by credit card type (American Express^®, Discovery^®, Mastercard^® and Visa^®).

Endpoint

GET v3/merchants/{mid}/reports/deposits/batch/{dateFunded}/card_types

https://clover.com/v3/merchants/{mId}/reports/deposits/batch/{dateFunded}/card_types

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

Requests

Path Parameter

Name	Type	Description	Maximum Length
`mId`	String	Indicates the merchant's ID.	13 characters.
`dateFunded`	Long	Date the was funded.

Header

Name	Description
Bearer Token	Authorization token required for getting deposits for the`{mId}.`

Responses

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

200 response: North America

The following 200 response is for North American (NA) merchants.

{
    "cardTypes": {
        "elements": [
            {
                "name": "UPI CREDIT",
                "amount": 12378,
                "productCode": "98"
            },
            {
                "name": "DISCOVER",
                "amount": 30012,
                "productCode": "3"
            }
        ]
    },
    "total": 42390
}

Examples

Card types

The following card_types example provides a breakdown by card type.

v3/merchants/TP5871RSSQ90Y/reports/deposits/batch/1638432000000/card_types 

{
  "cardTypes": {
    "elements": [ {
        "name": "MASTR-CARD", 
        "amount": 46269, 
        "productCode": "1"
      }, {
        "name": "VISA", 
        "amount": 189749, 
        "productCode": "2"
      }, {
        "name": "DISCOVER", 
        "amount": 8867, 
        "productCode": "3"
      }, {
        "name": "AMEX ACQ", 
        "amount": 6263, 
        "productCode": "7"
      }
    ]
  }, 
  "total": 251148
}