v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

List All Charges

This API returns a list of charges that were created. The list is sorted by ‘creation date’ with the most recent charges appearing first.

get/v1/charges

Request body

limitinteger

A number that represents the number of charges per page.

pageinteger

A number that represents the current page.

Response

200

Example response

{
  "data": [
    {
      "object": "Charge",
      "id": "LnbDBOMLWDLORXMy",
      "real_id": 1783,
      "amount": 100,
      "amount_captured": 100,
      "payarc_fees": 3,
      "type": "Sale",
      "net_amount": 97,
      "captured": 1,
      "status": "submitted_for_settlement",
      "auth_code": "TAS020",
      "charge_description": "jknknk",
      "created_at": "2018-11-26 14:06:54",
      "updated_at": "2018-11-26 14:06:55",
      "card": {
        "data": {
          "object": "Card",
          "id": "1Pvmy9059vv0M2L5",
          "real_id": 992,
          "is_default": 1,
          "exp_month": "02",
          "exp_year": "2022",
          "fingerprint": "29011PMyP1yP2L0M",
          "brand": "V",
          "last4digit": "1111",
          "first6digit": 411111,
          "avs_status": "0",
          "cvc_status": "N",
          "customer_id": "K4DPNMVjKpVnjApx",
          "created_at": {
            "date": "2018-11-22 09:35:37.000000",
            "timezone_type": 3,
            "timezone": "UTC"
          },
          "updated_at": {
            "date": "2018-11-22 09:35:38.000000",
            "timezone_type": 3,
            "timezone": "UTC"
          }
        }
      }
    }
  ],
  "meta": {
    "include": [
      "event"
    ],
    "pagination": {
      "total": 1517,
      "count": 20,
      "per_page": 20,
      "current_page": 1,
      "total_pages": 76,
      "links": {
        "next": "https://staging.payarc.net:9000/api/v1/charges?limit=20&page=2"
      }
    }
  }
}