generated: '2026-07-18'
method: searched
source: https://docs.services.butterpayments.com/
docs:
  - https://docs.services.butterpayments.com/authentication
  - https://docs.services.butterpayments.com/webhook-signature-verification
  - https://docs.services.butterpayments.com/api-reference
authentication:
  style: api-key-header
  header: x-api-key
  merchant_endpoints: [api-key, basic-auth, hmac-signature]
  ref: authentication/butterpayments-authentication.yml
idempotency:
  supported: false
  notes: No idempotency-key header or contract is documented for the Recover Enterprise API.
pagination:
  supported: false
  notes: The Recover API is an event-ingest + webhook surface; no list/pagination endpoints are documented.
request_tracing:
  request_id: true
  field: request_id
  notes: >-
    Ingest endpoints (POST /payments, POST /payment_method_updates) return a request_id in the
    response body for correlation.
  ref: errors
webhooks:
  signature: HMAC-SHA256
  signature_header: X-Butter-Webhook-Signature
  expiration_header: X-Butter-Webhook-Expiration
  message: "{json_payload}+{expiration}"
  ref: asyncapi/butterpayments-webhooks.yml
error_envelope:
  ingest_success:
    fields: [message, request_id]
    example_message: "Request submitted for processing"
  webhook_ack:
    fields: [detail]
    example_detail: "Event delivered successfully"
versioning:
  scheme: none-documented
  notes: No public versioning scheme (URI, header, or date) is documented.
rate_limiting:
  documented: false
  notes: >-
    No public rate-limit signaling documented; merchant vault keys are provisioned separately partly to
    avoid rate-limit contention with checkout flows.
data_format:
  content_type: application/json
  timestamps: ISO-8601 (UTC, e.g. 2023-09-25T03:57:26Z)
  currency: ISO-4217 three-letter codes (e.g. USD)