Charges: List

Request

GET https://api../stores/{storeId}/charges
List charges for all stores
GET https://api../charges

Parameters:

Parameters
last_fournumber
Filter by the last four digits of the credit card used. If specified, you must also include the name, exp_month, and exp_year parameters
namestring
Filter by the card holder’s name. If specified, you must also include the last_four, exp_month, and exp_year parameters
exp_monthnumber
Filter by the expiration month of the card used. If specified, you must also include the last_four, name, and exp_year parameters
exp_yearnumber
Filter by the expiration year of the credit card used. If specified, you must also include the last_four, name, and exp_month parameters
fromstring (ISO-8601)
Filter for charges created after this date.
tostring (ISO-8601)
Filter for charges created before this date.
emailstring
Filter for charges that were made by customer that provided this email address
phonenumber
Filter for charges using a phone number
amount_fromnumber
Filter for charges with a are great than this amount.
amount_tonumber
Filter for charges that are less
currencystring (ISO-4217)
Filter for charges that were requested or charged in this currency.
modestring
Filter by processing mode. live or test.
metadatastring
Filter by metadata contents.
transaction_token_idstring (UUID)
Filter for charges by the transaction token id.

Headers:

Authorization: Bearer {secret}.{jwt}

Body:

curl --request GET \
--url https://api../stores/af857264-180c-11e7-9be2-276aea4fed28/charges \
--header 'Authorization: Bearer {secret}.{jwt}'
List charges for all stores
curl --request GET \
--url https://api../charges \
--header 'Authorization: Bearer {secret}.{jwt}'

Response

Code: 200

Headers:

Content-Type: application/json

Body:

{
  "items": [
    {
      "id": "a29db148-1851-11e7-9b58-4b8e9d783793",
      "merchant_id": "11d92832-180a-11e7-834d-c3c52381fce7",
      "store_id": "af857264-180c-11e7-9be2-276aea4fed28",
      "transaction_token_id": "9c3b37f8-1851-11e7-9b58-8b8ddbe8f1d1",
      "requested_amount": 1000,
      "requested_currency": "JPY",
      "requested_amount_formatted": 1000,
      "charged_amount": 1000,
      "charged_currency": "JPY",
      "charged_amount_formatted": 1000,
      "status": "successful",
      "error": null,
      "metadata": {
        "order_id": 12345,
        "shipping_details": "Customer wants it now"
      },
      "mode": "test",
      "created_on": 1491212455774
    },
    {
      "id": "ae40db48-1855-11e7-bca5-9754449c2401",
      "merchant_id": "b59155a8-1855-11e7-bca5-cf16c088c7f2",
      "store_id": "bb866962-1855-11e7-bca5-e3dde845a0df",
      "transaction_token_id": "bb866962-1855-11e7-bca5-e3dde845a0df",
      "requested_amount": 1000,
      "requested_currency": "JPY",
      "requested_amount_formatted": 1000,
      "charged_amount": 1000,
      "charged_currency": "JPY",
      "charged_amount_formatted": 1000,
      "status": "successful",
      "error": null,
      "metadata": {
        "order_id": 12345,
        "shipping_details": "Customer wants it now"
      },
      "mode": "test",
      "created_on": 1491212455774
    }
  ],
  "has_more": false
}