Skip to content
Hayonix

API reference · Schema

PaymentMethod

  • objectstringrequired

    Always `payment_method`: the type of this object

    One ofpayment_method

  • idstringrequired

    Unique ID (`pmth_…`)

    ID with prefix pmth_

  • org_idstringrequired

    Organization it belongs to

    ID with prefix org_

  • driverstringrequired

    `stripe` for a card saved with the payment processor, `development` for a test card that takes no money

    One ofstripedevelopment

  • brandstring | nullrequired

    Card brand, for example `visa`; null when unknown

  • last4string | nullrequired

    Last four digits of the card; null when unknown

  • exp_monthinteger | nullrequired

    Expiry month (1–12); null when unknown

  • exp_yearinteger | nullrequired

    Expiry year (four digits); null when unknown

  • statusstringrequired

    `active` (can be charged) or `detached` (removed; never charged again)

    One ofactivedetached

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

Example
{
  "object": "payment_method",
  "id": "pmth_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "driver": "stripe",
  "brand": "string",
  "last4": "string",
  "exp_month": 1,
  "exp_year": 1,
  "status": "active",
  "created_at": "2026-01-01T00:00:00.000Z"
}

Used by