Hermos API

Export Payments

Streams synced payments newest first instead of creating a background export job. Uses the same filters and search as listPayments: q is trimmed, requires 3–200 characters, matches exact payment IDs, and with customers:read matches customer name/email (full email is an exact case-insensitive lookup; partial search is limited to the first 1000 matching active customers ordered by ID). CSV has a UTF-8 BOM, CRLF endings and formula-safe RFC 4180 cells. Columns: payment_id, created_at (ISO 8601 UTC), status, amount, currency, amount_refunded, amount_disputed, product_id, subscription_id, customer_id. Only callers with customers:read receive the additional customer_name, customer_email, customer_country columns. Product names are not exposed by the list. Amounts convert the list’s integer minor units to exact decimal major units using the ISO 4217 currency exponent (two digits for unknown exponents). Before streaming, more than 100000 matching rows returns invalid_request with too_many_rows on query.created_from; narrow the date range. Idempotency-Key is refused because replay storage would buffer the export. All exports, including q searches, use the payments_export rate bucket (10 per minute per principal) instead of customer_search.

GET/payments/export

Streams synced payments newest first instead of creating a background export job. Uses the same filters and search as listPayments: q is trimmed, requires 3–200 characters, matches exact payment IDs, and with customers:read matches customer name/email (full email is an exact case-insensitive lookup; partial search is limited to the first 1000 matching active customers ordered by ID). CSV has a UTF-8 BOM, CRLF endings and formula-safe RFC 4180 cells. Columns: payment_id, created_at (ISO 8601 UTC), status, amount, currency, amount_refunded, amount_disputed, product_id, subscription_id, customer_id. Only callers with customers:read receive the additional customer_name, customer_email, customer_country columns. Product names are not exposed by the list. Amounts convert the list’s integer minor units to exact decimal major units using the ISO 4217 currency exponent (two digits for unknown exponents). Before streaming, more than 100000 matching rows returns invalid_request with too_many_rows on query.created_from; narrow the date range. Idempotency-Key is refused because replay storage would buffer the export. All exports, including q searches, use the payments_export rate bucket (10 per minute per principal) instead of customer_search.

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

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

text/csv

application/json

application/json

curl -X GET "https://example.com/payments/export"
"string"