Hermos API

List Payments

Synced payments, newest first. Refunded/disputed filters select positive refunded/disputed amounts; status retains the stored payment status. Customer name, email, country and billing address are included only with customers:read. Search requires at least 3 characters after trimming and matches an exact payment ID; with customers:read, full email addresses use an exact case-insensitive contact-email lookup, while other queries match partial customer name/email case-insensitively. Customer search is limited to the first 1000 matching active customers ordered by customer ID, before payment pagination.

GET/payments

Synced payments, newest first. Refunded/disputed filters select positive refunded/disputed amounts; status retains the stored payment status. Customer name, email, country and billing address are included only with customers:read. Search requires at least 3 characters after trimming and matches an exact payment ID; with customers:read, full email addresses use an exact case-insensitive contact-email lookup, while other queries match partial customer name/email case-insensitively. Customer search is limited to the first 1000 matching active customers ordered by customer ID, before payment pagination.

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

cursor?string

Opaque signed cursor. Return it unchanged; valid for 24 hours.

Length1 <= length <= 8192
limit?integer
Range1 <= value <= 100
Default50
status?string

Value in

  • "pending"
  • "authorized"
  • "succeeded"
  • "failed"
  • "refunded"
  • "disputed"
customer?string

Opaque customer ID.

Match^cst_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])
product?string

Opaque product ID.

Match^prd_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])
subscription?string

Opaque subscription ID.

Match^sbs_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])
created_from?string

RFC 3339 UTC timestamp; only the Z suffix is accepted.

Formatdate-time
created_to?string

RFC 3339 UTC timestamp; only the Z suffix is accepted.

Formatdate-time
q?string
Length3 <= length <= 200

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/payments"
{  "data": [    {      "object": "payment",      "id": "string",      "livemode": true,      "created": "2019-08-24T14:15:22Z",      "receipt": {        "number": "string",        "can_resend": true      },      "status": "pending",      "rail": "stripe",      "amount": {        "amount": -9007199254740991,        "currency": "string"      },      "amount_authorized": {        "amount": -9007199254740991,        "currency": "string"      },      "amount_refunded": {        "amount": -9007199254740991,        "currency": "string"      },      "amount_disputed": {        "amount": -9007199254740991,        "currency": "string"      },      "application_fee": {        "amount": -9007199254740991,        "currency": "string"      },      "processing_fee": {        "amount": -9007199254740991,        "currency": "string"      },      "net": {        "amount": -9007199254740991,        "currency": "string"      },      "attempts": [        {          "attempt_no": 0,          "outcome": "string",          "started_at": "2019-08-24T14:15:22Z",          "failure_code": "string",          "reason_text": "string",          "trigger": "string"        }      ],      "advice": "string",      "next_retry_at": "string",      "retry_number": 0,      "retry_limit": 0,      "access_until": "string",      "risk": {        "level": "string"      },      "refund_window_ends_at": "string",      "external_id": "string",      "timeline": [        {          "type": "string",          "description": "string",          "created": "2019-08-24T14:15:22Z"        }      ],      "checkout_evidence": [        {          "captured_at": "2019-08-24T14:15:22Z",          "consent_text": "string",          "charge_terms_text": "string",          "ip_address": "string",          "user_agent": "string"        }      ],      "customer": {        "id": "string",        "name": "string",        "email": "string",        "country": "string",        "billing_address": {          "line1": "string",          "line2": "string",          "city": "string",          "state": "string",          "postal_code": "string",          "country": "string"        }      },      "payment_method": {        "type": "string",        "brand": "string",        "last4": "string",        "exp_month": 1,        "exp_year": 0      },      "payment_setup": "string",      "product": "string",      "subscription": "string",      "failure_code": "string",      "captured_at": "string",      "failed_at": "string",      "refunds": [        {          "id": "string",          "amount": {            "amount": -9007199254740991,            "currency": "string"          },          "status": "string",          "outcome": "string",          "reason": "string",          "created": "2019-08-24T14:15:22Z"        }      ],      "dispute": {        "id": "string",        "status": "string",        "amount": {          "amount": -9007199254740991,          "currency": "string"        }      }    }  ],  "pagination": {    "next_cursor": "string",    "has_more": true,    "as_of": "2019-08-24T14:15:22Z"  },  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",  "source": "primary"}