Retrieve charges totals

GET 
/charges/reports/totals

Retrieves three numbers: count of failed, succeded and settled charges, in given dates

Request

Query Parameters

fromDate daterequired

Possible values: <= 10 characters

Records created earlier than this date will be excluded from result

toDate daterequired

Possible values: <= 10 characters

Records created later than this date will be excluded from result

Responses

200

Charges totals report retrieved

application/json

Schema

Schema

status string

Possible values: [success]

data

object

totals_by_currencies

object[]

Array [

currency string

Code of charges' capture currency

failed_count integer

Number of failed charges in given currency

failed_sum integer

Total amount of failed charges in given currency

succeeded_count integer

Number of succeeded but not yet settled charges in given currency

succeeded_sum integer

Total amount of succeeded but not yet settled charges in given currency

settled_count integer

Number of settled charges in given currency

settled_sum integer

Total amount of settled charges in given currency

]

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "data": {
    "totals_by_currencies": [
      {
        "currency": "string",
        "failed_count": 0,
        "failed_sum": 0,
        "succeeded_count": 0,
        "succeeded_sum": 0,
        "settled_count": 0,
        "settled_sum": 0
      }
    ]
  },
  "code": 200,
  "message": "Successful request"
}

401

Access token is missing or invalid

403

Access denied

409

Request failed due to a conflict in the provided entity

application/json

Schema

Schema

status string

Possible values: [fail]

code integer

Possible values: [409]

message string

Failure reason

Example (from schema)

{
  "status": "fail",
  "code": 409,
  "message": "Entity with Id already exists"
}

422

Query failed due to query parameters validation failure

application/json

Schema

Schema

status string

Possible values: [error]

data object
code integer

Possible values: [422]

message string

Example (from schema)

{
  "status": "error",
  "data": {
    "dob": {
      "day": "Value expected to be 'integer', 'string' given."
    }
  },
  "code": 422,
  "message": "cannot process the provided entity"
}

500

Server error

Loading...