Retrieve charges fees report

GET 
/charges/reports/fees

Retrieves a list of charges with fees

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

Fees report retrieved

application/json

Schema

Schema

status string

Possible values: [success]

data

object[]

Array [

id uuid

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

customer_id uuidnullable

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

invoice_id uuidnullable

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID v4

status string

Possible values: [pending, succeeded, failed]

paid boolean

Indicates if the Charge has been captured

disputed boolean

Indicates if the Charge has been disputed

refunded boolean

Indicates if the Charge has been refunded partially or completely

failure_code stringnullable

It will show the error code when the charge fails

failure_message stringnullable

It will show the error message when the charge fails

amount

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

amount_captured

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

amount_refunded

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

description stringnullable

Possible values: <= 255 characters

Description for this charge

billing_details

object

name stringnullable

Possible values: <= 255 characters

Name of the billing contact person

email emailnullable

Possible values: <= 255 characters

Email Address

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

nullable

Address of the billing contact

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

shipping_details

object

name stringrequired

Possible values: <= 255 characters

Name of the shipping contact person

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

required

Address of the shipping destination

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

fees

object[]

Array [

name string

Fee's name

percentage string

Fee's percent

amount

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

total_amount

object

Money representation

value MoneyAmount (integer)required

Possible values: <= 9999999999

Amount expressed in cents. 1 USD should be submitted as 100 cents

currency /[A-Z]{3}/required

ISO 4217 representation of the currency

]

metadata

object

A metadata object containing key-value pairs. Keys must be strings, and values are strings. The object can also be empty.

property name* string

created_on Unix timestamp

Unix timestamp representing the date

]

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "data": [
    {
      "id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
      "customer_id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
      "invoice_id": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
      "status": "pending",
      "paid": true,
      "disputed": true,
      "refunded": true,
      "failure_code": "string",
      "failure_message": "string",
      "amount": {
        "value": 99,
        "currency": "USD"
      },
      "amount_captured": {
        "value": 99,
        "currency": "USD"
      },
      "amount_refunded": {
        "value": 99,
        "currency": "USD"
      },
      "description": "Services x 3 hs",
      "billing_details": {
        "name": "Louis Griffin",
        "email": "peter@pathly.io",
        "phone_number": "1234567890",
        "address": {
          "country": "US",
          "line1": "Passatge sant pere",
          "line2": "Apartment 2",
          "zip": "8397.0",
          "city": "Pineda de mar",
          "state": "Barcelona"
        }
      },
      "shipping_details": {
        "name": "Louis Griffin",
        "phone_number": "1234567890",
        "address": {
          "country": "US",
          "line1": "Passatge sant pere",
          "line2": "Apartment 2",
          "zip": "8397.0",
          "city": "Pineda de mar",
          "state": "Barcelona"
        }
      },
      "fees": [
        {
          "name": "Card Debit",
          "percentage": "2.99%",
          "amount": {
            "value": 99,
            "currency": "USD"
          },
          "total_amount": {
            "value": 99,
            "currency": "USD"
          }
        }
      ],
      "metadata": {},
      "created_on": 1656656767
    }
  ],
  "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...