REST reference

OpenAPI reference

This page is derived from committed OpenAPI; wire names remain unchanged. Portal Try It is sandbox-only, uses a short Trepzy token, and exact CORS. Live examples are copy-only.

`GET /api/v1/buyers`

operation_id: listBuyers

Permission: buyers:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/buyers/{buyer_ref}`

operation_id: retrieveBuyer

Permission: buyers:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "buyer_ref": "example"
}

Response example

{
  "data": {
    "buyer_ref": "buyer_0123456789AB",
    "country": "example",
    "created_at": "2026-08-15T12:00:00Z",
    "display_name": "example",
    "email_masked": "example",
    "entitlements": [],
    "last_seen_at": "2026-08-15T12:00:00Z",
    "locale": "example",
    "purchases": [],
    "status": "active",
    "subscriptions": [],
    "timezone": "example",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/captures`

operation_id: listCaptures

Permission: captures:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/captures/{capture_ref}`

operation_id: retrieveCapture

Permission: captures:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "capture_ref": "example"
}

Response example

{
  "data": {
    "amount_minor": "19700",
    "capture_ref": "cap_0123456789AB",
    "captured_at": "2026-08-15T12:00:00Z",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "invoice_ref": "in_0123456789AB",
    "journey_ref": "jny_0123456789AB",
    "order_ref": "order_0123456789AB",
    "payment_method": {
      "brand": "example",
      "funding": "credit",
      "last4": "example"
    },
    "payment_ref": "pay_0123456789AB",
    "subscription_ref": "sub_0123456789AB"
  }
}

`POST /api/v1/checkout-configs`

operation_id: createCheckoutConfig

Permission: checkout_configs:write_create
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "slug": "example"
}

Response example

{
  "data": {
    "config_ref": "ckt_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "published_version": 1,
    "slug": "example",
    "status": "draft",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/checkout-configs/{config_ref}`

operation_id: retrieveCheckoutConfig

Permission: checkout_configs:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "config_ref": "example"
}

Response example

{
  "data": {
    "config_ref": "ckt_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "published_version": 1,
    "slug": "example",
    "status": "draft",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`POST /api/v1/checkout-configs/{config_ref}/publish`

operation_id: publishCheckoutConfig

Permission: checkout_configs:write_publish
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "config_ref": "ckt_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "published_version": 1,
    "slug": "example",
    "status": "draft",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`POST /api/v1/checkout-configs/{config_ref}/versions`

operation_id: createCheckoutConfigVersion

Permission: checkout_configs:write_create_version
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "copy": {
    "cta_label": "example",
    "offer_title": "example"
  },
  "currency": "BRL",
  "locale": "example",
  "price_ref": "price_0123456789AB"
}

Response example

{
  "data": {
    "config_ref": "ckt_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "published_version": 1,
    "slug": "example",
    "status": "draft",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/checkout-sessions`

operation_id: listCheckoutSessions

Permission: checkout_sessions:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/checkout-sessions`

operation_id: createCheckoutSession

Permission: checkout_sessions:write_create
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "buyer_ref": "buyer_0123456789AB",
    "checkout_session_ref": "cks_0123456789AB",
    "config_ref": "ckt_0123456789AB",
    "config_version": 1,
    "conversion_mode": "catalog",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "currency_source": "buyer_choice",
    "expires_at": "2026-08-15T12:00:00Z",
    "invoice_ref": "in_0123456789AB",
    "items": [],
    "journey_ref": "jny_0123456789AB",
    "locale": "example",
    "order_ref": "order_0123456789AB",
    "payment_ref": "pay_0123456789AB",
    "revision": 1,
    "status": "open",
    "total_amount_minor": "19700",
    "tracking": {
      "node_key": "example",
      "surface": "hosted"
    },
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/checkout-sessions/{checkout_session_ref}`

operation_id: retrieveCheckoutSession

Permission: checkout_sessions:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "checkout_session_ref": "example"
}

Response example

{
  "data": {
    "buyer_ref": "buyer_0123456789AB",
    "checkout_session_ref": "cks_0123456789AB",
    "config_ref": "ckt_0123456789AB",
    "config_version": 1,
    "conversion_mode": "catalog",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "currency_source": "buyer_choice",
    "expires_at": "2026-08-15T12:00:00Z",
    "invoice_ref": "in_0123456789AB",
    "items": [],
    "journey_ref": "jny_0123456789AB",
    "locale": "example",
    "order_ref": "order_0123456789AB",
    "payment_ref": "pay_0123456789AB",
    "revision": 1,
    "status": "open",
    "total_amount_minor": "19700",
    "tracking": {
      "node_key": "example",
      "surface": "hosted"
    },
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`POST /api/v1/checkout-sessions/{checkout_session_ref}/pay`

operation_id: payCheckoutSession

Permission: checkout_sessions:write_pay
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "credential": {
    "intent_ref": "example",
    "kind": "vault_intent"
  },
  "initiation": "customer"
}

Response examples

`retrieve_payment_response`

{
  "data": {
    "amount_minor": "19700",
    "attempts": [],
    "buyer_ref": "buyer_0123456789AB",
    "captured_amount_minor": "19700",
    "captures": [],
    "checkout_session_ref": "cks_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "invoice_ref": "in_0123456789AB",
    "items": [
      {
        "currency": "BRL",
        "line_amount_minor": "19700",
        "offer_ref": "offer_0123456789AB",
        "position": 0,
        "price_ref": "price_0123456789AB",
        "product_ref": "prod_0123456789AB",
        "quantity": 1,
        "unit_amount_minor": "19700"
      }
    ],
    "journey_ref": "jny_0123456789AB",
    "payment_ref": "pay_0123456789AB",
    "status": "open",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`subscription_setup_action_required`

{
  "data": {
    "checkout_session_ref": "cks_0123456789AB",
    "outcome": "subscription_setup_action_required"
  }
}

`subscription_started`

{
  "data": {
    "checkout_session_ref": "cks_0123456789AB",
    "order_ref": "order_0123456789AB",
    "outcome": "subscription_started",
    "subscription_ref": "sub_0123456789AB",
    "trial": false
  }
}

`POST /api/v1/credentials/{credential_ref}/revoke`

operation_id: revokeServiceAccountCredential

Permission: credentials:manage_revoke
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason_code": "example"
}

Response example

{
  "data": {
    "credential_ref": "credential_0123456789AB",
    "expires_at": "2026-08-15T12:00:00Z",
    "predecessor_credential_ref": "credential_0123456789AB",
    "secret_status": "issued",
    "service_account_ref": "principal_0123456789AB",
    "status": "active",
    "successor_credential_ref": "credential_0123456789AB",
    "version": 1
  }
}

`POST /api/v1/credentials/{credential_ref}/rotate`

operation_id: rotateServiceAccountCredential

Permission: credentials:manage_rotate
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason_code": "example",
  "service_account_ref": "principal_0123456789AB"
}

Response example

{
  "data": {
    "credential_ref": "credential_0123456789AB",
    "expires_at": "2026-08-15T12:00:00Z",
    "predecessor_credential_ref": "credential_0123456789AB",
    "secret_status": "issued",
    "service_account_ref": "principal_0123456789AB",
    "status": "active",
    "successor_credential_ref": "credential_0123456789AB",
    "version": 1
  }
}

`GET /api/v1/disputes`

operation_id: listDisputes

Permission: disputes:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/disputes/{dispute_ref}`

operation_id: retrieveDispute

Permission: disputes:read
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "dispute_ref": "dsp_0123456789AB"
}

Response example

{
  "data": {
    "amount": {
      "currency": "BRL",
      "unit": "minor",
      "value": "19700"
    },
    "dispute_ref": "dsp_0123456789AB",
    "evidence_due_at": "2026-08-15T12:00:00Z",
    "kind": "alert",
    "opened_at": "2026-08-15T12:00:00Z",
    "payment_intent_ref": "pay_0123456789AB",
    "reason_safe": "example",
    "resolved_at": "2026-08-15T12:00:00Z",
    "status": "received"
  }
}

`GET /api/v1/entitlements`

operation_id: listEntitlements

Permission: entitlements:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/entitlements/{entitlement_ref}`

operation_id: retrieveEntitlement

Permission: entitlements:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "entitlement_ref": "example"
}

Response example

{
  "data": {
    "buyer_ref": "buyer_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "effective_from": "2026-08-15T12:00:00Z",
    "effective_to": "2026-08-15T12:00:00Z",
    "entitlement_ref": "etm_0123456789AB",
    "product_ref": "prod_0123456789AB",
    "status": "active",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/environments`

operation_id: listEnvironments

Permission: environments:read_list
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/invoices`

operation_id: listInvoices

Permission: invoices:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/invoices/{invoice_ref}`

operation_id: retrieveInvoice

Permission: invoices:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "invoice_ref": "example"
}

Response example

{
  "data": {
    "adjustment_minor": "19700",
    "beneficiary_buyer_ref": "buyer_0123456789AB",
    "billing_reason": "acquisition",
    "capture_ref": "cap_0123456789AB",
    "checkout_presentation": "hosted",
    "checkout_session_ref": "cks_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "due_at": "2026-08-15T12:00:00Z",
    "finalized_at": "2026-08-15T12:00:00Z",
    "invoice_ref": "in_0123456789AB",
    "journey_ref": "jny_0123456789AB",
    "lines": [],
    "order_ref": "order_0123456789AB",
    "origin": "checkout",
    "paid_at": "2026-08-15T12:00:00Z",
    "past_due_at": "2026-08-15T12:00:00Z",
    "purchaser_buyer_ref": "buyer_0123456789AB",
    "status": "draft",
    "subtotal_minor": "19700",
    "tax_minor": "19700",
    "total_minor": "19700",
    "updated_at": "2026-08-15T12:00:00Z",
    "version": 1,
    "void_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/journeys`

operation_id: listJourneys

Permission: journeys:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/journeys/{journey_ref}`

operation_id: retrieveJourney

Permission: journeys:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "journey_ref": "example"
}

Response example

{
  "data": {
    "checkout_session_ref": "cks_0123456789AB",
    "completed_at": "2026-08-15T12:00:00Z",
    "created_at": "2026-08-15T12:00:00Z",
    "decisions": [],
    "funnel_slug": "example",
    "funnel_version": 1,
    "journey_ref": "jny_0123456789AB",
    "root_order_ref": "order_0123456789AB",
    "status": "open",
    "surface": "hosted"
  }
}

`GET /api/v1/offers`

operation_id: listOffers

Permission: offers:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/offers/{offer_ref}`

operation_id: retrieveOffer

Permission: offers:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "offer_ref": "example"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "offer_ref": "offer_0123456789AB",
    "price_ref": "price_0123456789AB",
    "product_ref": "prod_0123456789AB",
    "status": "draft",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`POST /api/v1/offers/{offer_ref}/reprice`

operation_id: repriceOffer

Permission: products:reprice
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "amount_minor": "19700"
}

Response example

{
  "data": {
    "amount_minor": "19700",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "price_ref": "price_0123456789AB",
    "product_ref": "prod_0123456789AB",
    "recurrence_interval": "day",
    "recurrence_interval_count": 1,
    "status": "draft",
    "trial_days": 1,
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/orders`

operation_id: listOrders

Permission: orders:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/orders/{order_ref}`

operation_id: retrieveOrder

Permission: orders:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "order_ref": "example"
}

Response example

{
  "data": {
    "adjustment_minor": "19700",
    "beneficiary_buyer_ref": "buyer_0123456789AB",
    "capture_ref": "cap_0123456789AB",
    "checkout_session_ref": "cks_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "invoice_ref": "in_0123456789AB",
    "journey_ref": "jny_0123456789AB",
    "lines": [],
    "order_ref": "order_0123456789AB",
    "purchaser_buyer_ref": "buyer_0123456789AB",
    "root_order_ref": "order_0123456789AB",
    "source_kind": "hosted",
    "subtotal_minor": "19700",
    "tax_minor": "19700",
    "total_minor": "19700"
  }
}

`GET /api/v1/participations`

operation_id: listParticipations

Permission: participations:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/participations/{participation_ref}`

operation_id: retrieveParticipation

Permission: participations:read
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "participation_ref": "ptc_0123456789AB"
}

Response example

{
  "data": {
    "accepted_at": "2026-08-15T12:00:00Z",
    "beneficiary_business_ref": "biz_0123456789AB",
    "invited_at": "2026-08-15T12:00:00Z",
    "participation_ref": "ptc_0123456789AB",
    "status": "invited",
    "terms_digest": "example",
    "terms_version": 1
  }
}

`GET /api/v1/payment_methods`

operation_id: listStoredPaymentMethods

Permission: payment_methods:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/payment_methods/{stored_payment_method_ref}`

operation_id: retrieveStoredPaymentMethod

Permission: payment_methods:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "stored_payment_method_ref": "example"
}

Response example

{
  "data": {
    "brand": "example",
    "consents": [],
    "created_at": "2026-08-15T12:00:00Z",
    "funding": "example",
    "last4": "example",
    "replaced_by_stored_payment_method_ref": "spm_0123456789AB",
    "revoked_at": "2026-08-15T12:00:00Z",
    "source_checkout_session_ref": "cks_0123456789AB",
    "status": "active",
    "stored_payment_method_ref": "spm_0123456789AB",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/payments`

operation_id: listPayments

Permission: payments:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/payments/{payment_ref}`

operation_id: retrievePayment

Permission: payments:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "payment_ref": "example"
}

Response example

{
  "data": {
    "amount_minor": "19700",
    "attempts": [],
    "buyer_ref": "buyer_0123456789AB",
    "captured_amount_minor": "19700",
    "captures": [],
    "checkout_session_ref": "cks_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "invoice_ref": "in_0123456789AB",
    "items": [
      {
        "currency": "BRL",
        "line_amount_minor": "19700",
        "offer_ref": "offer_0123456789AB",
        "position": 0,
        "price_ref": "price_0123456789AB",
        "product_ref": "prod_0123456789AB",
        "quantity": 1,
        "unit_amount_minor": "19700"
      }
    ],
    "journey_ref": "jny_0123456789AB",
    "payment_ref": "pay_0123456789AB",
    "status": "open",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/payouts`

operation_id: listPayouts

Permission: payouts:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/payouts/{payout_ref}`

operation_id: retrievePayout

Permission: payouts:read
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "payout_ref": "wd_0123456789AB"
}

Response example

{
  "data": {
    "amount": {
      "currency": "BRL",
      "unit": "minor",
      "value": "19700"
    },
    "completed_at": "2026-08-15T12:00:00Z",
    "destination_label": "example",
    "destination_last4": "example",
    "fee": {
      "currency": "BRL",
      "unit": "minor",
      "value": "19700"
    },
    "method_key": "example",
    "net": {
      "currency": "BRL",
      "unit": "minor",
      "value": "19700"
    },
    "payout_ref": "wd_0123456789AB",
    "requested_at": "2026-08-15T12:00:00Z",
    "status": "requested"
  }
}

`GET /api/v1/prices`

operation_id: listPrices

Permission: prices:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/prices`

operation_id: createPrice

Permission: prices:write_create
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "amount_minor": "19700",
  "currency": "BRL",
  "free_mode": "none",
  "product_ref": "prod_0123456789AB"
}

Response example

{
  "data": {
    "amount_minor": "19700",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "price_ref": "price_0123456789AB",
    "product_ref": "prod_0123456789AB",
    "recurrence_interval": "day",
    "recurrence_interval_count": 1,
    "status": "draft",
    "trial_days": 1,
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/prices/{price_ref}`

operation_id: retrievePrice

Permission: prices:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "price_ref": "example"
}

Response example

{
  "data": {
    "amount_minor": "19700",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "price_ref": "price_0123456789AB",
    "product_ref": "prod_0123456789AB",
    "recurrence_interval": "day",
    "recurrence_interval_count": 1,
    "status": "draft",
    "trial_days": 1,
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`POST /api/v1/prices/{price_ref}/publish`

operation_id: publishPrice

Permission: prices:write_publish
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "amount_minor": "19700",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "price_ref": "price_0123456789AB",
    "product_ref": "prod_0123456789AB",
    "recurrence_interval": "day",
    "recurrence_interval_count": 1,
    "status": "draft",
    "trial_days": 1,
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/products`

operation_id: listProducts

Permission: products:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/products`

operation_id: createProduct

Permission: products:write_create
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "format": "digital",
  "name": "example",
  "slug": "example",
  "type": "produto"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "name": "example",
    "product_ref": "prod_0123456789AB",
    "status": "draft",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`GET /api/v1/products/{product_ref}`

operation_id: retrieveProduct

Permission: products:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "product_ref": "example"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "name": "example",
    "product_ref": "prod_0123456789AB",
    "status": "draft",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`POST /api/v1/products/{product_ref}/publish`

operation_id: publishProduct

Permission: products:write_publish
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "name": "example",
    "product_ref": "prod_0123456789AB",
    "status": "draft",
    "updated_at": "2026-08-15T12:00:00Z"
  }
}

`POST /api/v1/promotions/apply`

operation_id: applyPromotion

Permission: promotion:manage_apply
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "confirmed": true,
  "plan_digest": "abababababababababababababababababababababababababababababababab"
}

Response example

{
  "data": {
    "ok": false,
    "operations": [],
    "outcome_class": "example",
    "plan_digest": "abababababababababababababababababababababababababababababababab"
  }
}

`POST /api/v1/promotions/plan`

operation_id: planPromotion

Permission: promotion:read_plan
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, semantic_error, validation_failed

Continue in errors and SDKs.

Request example

{
  "destination": "live",
  "resources": [],
  "schema_version": 1,
  "source": "sandbox"
}

Response example

{
  "data": {
    "destination_environment": "live",
    "mapping": [],
    "operations": [],
    "plan_digest": "abababababababababababababababababababababababababababababababab",
    "schema_version": "1",
    "source_environment": "sandbox"
  }
}

`GET /api/v1/refunds`

operation_id: listRefunds

Permission: refunds:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/refunds`

operation_id: createRefund

Permission: refunds:write_create
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "amount_minor": "19700",
  "currency": "BRL"
}

Response example

{
  "data": {
    "access_effect": "revoke",
    "amount": {
      "currency": "BRL",
      "unit": "minor",
      "value": "19700"
    },
    "cancelable": false,
    "canceled_at": "2026-08-15T12:00:00Z",
    "capture_ref": "cap_0123456789AB",
    "executed_at": "2026-08-15T12:00:00Z",
    "payment_intent_ref": "pay_0123456789AB",
    "reason": "example",
    "refund_ref": "ref_0123456789AB",
    "requested_at": "2026-08-15T12:00:00Z",
    "scheduled_at": "2026-08-15T12:00:00Z",
    "scope": "total",
    "status": "requested"
  }
}

`GET /api/v1/refunds/{refund_ref}`

operation_id: retrieveRefund

Permission: refunds:read
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "refund_ref": "ref_0123456789AB"
}

Response example

{
  "data": {
    "access_effect": "revoke",
    "amount": {
      "currency": "BRL",
      "unit": "minor",
      "value": "19700"
    },
    "cancelable": false,
    "canceled_at": "2026-08-15T12:00:00Z",
    "capture_ref": "cap_0123456789AB",
    "executed_at": "2026-08-15T12:00:00Z",
    "payment_intent_ref": "pay_0123456789AB",
    "reason": "example",
    "refund_ref": "ref_0123456789AB",
    "requested_at": "2026-08-15T12:00:00Z",
    "scheduled_at": "2026-08-15T12:00:00Z",
    "scope": "total",
    "status": "requested"
  }
}

`GET /api/v1/request_logs`

operation_id: listPublicRequestLogs

Permission: request_logs:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/service_accounts`

operation_id: listServiceAccounts

Permission: service_accounts:read_list
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/service_accounts`

operation_id: createServiceAccount

Permission: service_accounts:manage_create
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "display_name": "example"
}

Response example

{
  "data": {
    "display_name": "example",
    "principal_ref": "principal_0123456789AB",
    "status": "active",
    "version": 1
  }
}

`GET /api/v1/service_accounts/{principal_ref}`

operation_id: retrieveServiceAccount

Permission: service_accounts:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "principal_ref": "principal_0123456789AB"
}

Response example

{
  "data": {
    "display_name": "example",
    "principal_ref": "principal_0123456789AB",
    "status": "active",
    "version": 1
  }
}

`GET /api/v1/service_accounts/{principal_ref}/credentials`

operation_id: listServiceAccountCredentials

Permission: credentials:read_list
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "principal_ref": "principal_0123456789AB"
}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/service_accounts/{principal_ref}/credentials`

operation_id: issueServiceAccountCredential

Permission: credentials:manage_issue
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "restriction_allowlist": [
    "example"
  ]
}

Response example

{
  "data": {
    "credential_ref": "credential_0123456789AB",
    "expires_at": "2026-08-15T12:00:00Z",
    "predecessor_credential_ref": "credential_0123456789AB",
    "secret_status": "issued",
    "service_account_ref": "principal_0123456789AB",
    "status": "active",
    "successor_credential_ref": "credential_0123456789AB",
    "version": 1
  }
}

`GET /api/v1/service_accounts/{principal_ref}/grants`

operation_id: listServiceAccountGrants

Permission: grants:read_list
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "principal_ref": "principal_0123456789AB"
}

Response example

{
  "data": {
    "available_actions": [],
    "items": []
  }
}

`POST /api/v1/service_accounts/{principal_ref}/grants`

operation_id: grantServiceAccountPermission

Permission: grants:manage_grant
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "permission_action": "example",
  "reason_code": "example"
}

Response example

{
  "data": {
    "effect": "allow",
    "permission_action": "example",
    "version": 1
  }
}

`POST /api/v1/service_accounts/{principal_ref}/grants/{permission_action}/revoke`

operation_id: revokeServiceAccountPermission

Permission: grants:manage_revoke
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason_code": "example"
}

Response example

{
  "data": {
    "effect": "allow",
    "permission_action": "example",
    "version": 1
  }
}

`POST /api/v1/service_accounts/{principal_ref}/resume`

operation_id: resumeServiceAccount

Permission: service_accounts:manage_resume
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason_code": "example"
}

Response example

{
  "data": {
    "display_name": "example",
    "principal_ref": "principal_0123456789AB",
    "status": "active",
    "version": 1
  }
}

`POST /api/v1/service_accounts/{principal_ref}/retire`

operation_id: retireServiceAccount

Permission: service_accounts:manage_retire
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason_code": "example"
}

Response example

{
  "data": {
    "display_name": "example",
    "principal_ref": "principal_0123456789AB",
    "status": "active",
    "version": 1
  }
}

`POST /api/v1/service_accounts/{principal_ref}/suspend`

operation_id: suspendServiceAccount

Permission: service_accounts:manage_suspend
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason_code": "example"
}

Response example

{
  "data": {
    "display_name": "example",
    "principal_ref": "principal_0123456789AB",
    "status": "active",
    "version": 1
  }
}

`GET /api/v1/subscription-changes`

operation_id: listSubscriptionChanges

Permission: subscription_changes:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/subscription-changes/{subscription_change_ref}`

operation_id: retrieveSubscriptionChange

Permission: subscription_changes:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "subscription_change_ref": "example"
}

Response example

{
  "data": {
    "capture_ref": "cap_0123456789AB",
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "effective_at": "2026-08-15T12:00:00Z",
    "effective_mode": "immediate",
    "invoice_ref": "in_0123456789AB",
    "payment_ref": "pay_0123456789AB",
    "replaced_by_subscription_change_ref": "subchange_0123456789AB",
    "state": "pending_payment",
    "subscription_change_ref": "subchange_0123456789AB",
    "subscription_ref": "sub_0123456789AB",
    "total_amount_minor": "19700",
    "updated_at": "2026-08-15T12:00:00Z",
    "version": 1
  }
}

`GET /api/v1/subscriptions`

operation_id: listSubscriptions

Permission: subscriptions:read_list
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/subscriptions/{subscription_ref}`

operation_id: retrieveSubscription

Permission: subscriptions:read_retrieve
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "subscription_ref": "example"
}

Response example

{
  "data": {
    "anchor_day_of_month": 1,
    "beneficiary_buyer_ref": "buyer_0123456789AB",
    "cadence_interval": "day",
    "cadence_interval_count": 1,
    "created_at": "2026-08-15T12:00:00Z",
    "currency": "BRL",
    "current_cycle": {
      "amount_minor": "19700",
      "currency": "BRL",
      "period_end": "2026-08-15T12:00:00Z",
      "period_start": "2026-08-15T12:00:00Z",
      "status": "scheduled"
    },
    "current_period_end": "2026-08-15T12:00:00Z",
    "current_period_start": "2026-08-15T12:00:00Z",
    "dunning": {
      "access_applied": "none",
      "closed_at": "2026-08-15T12:00:00Z",
      "grace_ends_at": "2026-08-15T12:00:00Z",
      "opened_at": "2026-08-15T12:00:00Z",
      "status": "open"
    },
    "first_charge_amount_minor": "19700",
    "first_charge_at": "2026-08-15T12:00:00Z",
    "first_charge_currency": "BRL",
    "items": [],
    "origin_order_ref": "order_0123456789AB",
    "original_anchor_at": "2026-08-15T12:00:00Z",
    "purchaser_buyer_ref": "buyer_0123456789AB",
    "status": "trialing",
    "stored_payment_method_ref": "spm_0123456789AB",
    "subscription_ref": "sub_0123456789AB",
    "trial_ends_at": "2026-08-15T12:00:00Z",
    "updated_at": "2026-08-15T12:00:00Z",
    "version": 1
  }
}

`GET /api/v1/webhook_deliveries/{delivery_ref}`

operation_id: retrieveWebhookDelivery

Permission: webhooks:read_retrieve_delivery
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "delivery_ref": "whd_0123456789AB"
}

Response example

{
  "data": {
    "attempt_count": 0,
    "created_at": "2026-08-15T12:00:00Z",
    "dead_lettered_at": "2026-08-15T12:00:00Z",
    "delivery_ref": "whd_0123456789AB",
    "diagnostic": false,
    "dto_version": 1,
    "endpoint_ref": "whep_0123456789AB",
    "generation": 0,
    "public_event_type": "example",
    "retry_expires_at": "2026-08-15T12:00:00Z",
    "status": "pending"
  }
}

`GET /api/v1/webhook_deliveries/{delivery_ref}/attempts`

operation_id: listWebhookDeliveryAttempts

Permission: webhooks:read_list_attempts
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example",
  "delivery_ref": "whd_0123456789AB"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/webhook_deliveries/{delivery_ref}/body`

operation_id: retrieveWebhookDeliveryBody

Permission: webhooks:read_delivery_body
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "delivery_ref": "whd_0123456789AB"
}

Response example

{
  "data": {
    "body_status": "redacted",
    "delivery_ref": "whd_0123456789AB",
    "match_reasons": [],
    "payload": null
  }
}

`POST /api/v1/webhook_deliveries/{delivery_ref}/redrive`

operation_id: redriveWebhookDelivery

Permission: webhooks:redrive_unit
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason": "example"
}

Response example

{
  "data": {
    "delivery_ref": "whd_0123456789AB",
    "outcome": "accepted"
  }
}

`POST /api/v1/webhook_deliveries/redrive`

operation_id: batchRedriveWebhookDeliveries

Permission: webhooks:redrive_batch
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "delivery_refs": [
    "whd_0123456789AB"
  ],
  "reason": "example"
}

Response example

{
  "data": {
    "results": []
  }
}

`GET /api/v1/webhook_endpoints`

operation_id: listWebhookEndpoints

Permission: webhooks:read_list_endpoints
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example",
  "status": "active"
}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/webhook_endpoints`

operation_id: createWebhookEndpoint

Permission: webhooks:manage_create_endpoint
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "url": "example"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "endpoint_ref": "whep_0123456789AB",
    "secret_versions": [],
    "status": "active",
    "updated_at": "2026-08-15T12:00:00Z",
    "url": "example",
    "url_immutable": false
  }
}

`GET /api/v1/webhook_endpoints/{endpoint_ref}`

operation_id: retrieveWebhookEndpoint

Permission: webhooks:read_retrieve_endpoint
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "endpoint_ref": "whep_0123456789AB"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "endpoint_ref": "whep_0123456789AB",
    "secret_versions": [],
    "status": "active",
    "updated_at": "2026-08-15T12:00:00Z",
    "url": "example",
    "url_immutable": false
  }
}

`GET /api/v1/webhook_endpoints/{endpoint_ref}/data_profile_grants`

operation_id: listWebhookDataProfileGrants

Permission: webhooks:read_list_data_profile
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "endpoint_ref": "whep_0123456789AB"
}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/data_profile_grants`

operation_id: createWebhookDataProfileGrant

Permission: webhooks:manage_create_data_profile
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "custom_field_refs": [],
  "data_classes": [],
  "purpose": "example",
  "reason": "example"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "custom_field_refs": [],
    "data_classes": [],
    "endpoint_ref": "whep_0123456789AB",
    "purpose": "example",
    "revoked_at": "2026-08-15T12:00:00Z",
    "status": "active"
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/data_profile_grants/revoke`

operation_id: revokeWebhookDataProfileGrant

Permission: webhooks:manage_revoke_data_profile
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason": "example"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "custom_field_refs": [],
    "data_classes": [],
    "endpoint_ref": "whep_0123456789AB",
    "purpose": "example",
    "revoked_at": "2026-08-15T12:00:00Z",
    "status": "active"
  }
}

`GET /api/v1/webhook_endpoints/{endpoint_ref}/deliveries`

operation_id: listWebhookDeliveries

Permission: webhooks:read_list_deliveries
Idempotency: none
CAS: none
Cursor: cursor
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "cursor": "example",
  "endpoint_ref": "whep_0123456789AB"
}

Response example

{
  "data": {
    "items": []
  }
}

`GET /api/v1/webhook_endpoints/{endpoint_ref}/health`

operation_id: retrieveWebhookEndpointHealth

Permission: webhooks:read_health
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "endpoint_ref": "whep_0123456789AB"
}

Response example

{
  "data": {
    "endpoint_ref": "whep_0123456789AB",
    "health": "ok",
    "last_delivery_status": "pending"
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/pause`

operation_id: pauseWebhookEndpoint

Permission: webhooks:manage_pause_endpoint
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "endpoint_ref": "whep_0123456789AB",
    "secret_versions": [],
    "status": "active",
    "updated_at": "2026-08-15T12:00:00Z",
    "url": "example",
    "url_immutable": false
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/resume`

operation_id: resumeWebhookEndpoint

Permission: webhooks:manage_resume_endpoint
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "endpoint_ref": "whep_0123456789AB",
    "secret_versions": [],
    "status": "active",
    "updated_at": "2026-08-15T12:00:00Z",
    "url": "example",
    "url_immutable": false
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/secret/confirm`

operation_id: confirmWebhookSecret

Permission: webhooks:rotate_confirm
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason": "example"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "endpoint_ref": "whep_0123456789AB",
    "secret_versions": [],
    "status": "active",
    "updated_at": "2026-08-15T12:00:00Z",
    "url": "example",
    "url_immutable": false
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/secret/revoke`

operation_id: revokeWebhookSecret

Permission: webhooks:rotate_revoke
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason": "example"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "endpoint_ref": "whep_0123456789AB",
    "secret_versions": [],
    "status": "active",
    "updated_at": "2026-08-15T12:00:00Z",
    "url": "example",
    "url_immutable": false
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/secret/rotate`

operation_id: rotateWebhookSecret

Permission: webhooks:rotate_secret
Idempotency: required
CAS: if_match_required
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "reason": "example"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "endpoint_ref": "whep_0123456789AB",
    "secret_versions": [],
    "status": "active",
    "updated_at": "2026-08-15T12:00:00Z",
    "url": "example",
    "url_immutable": false
  }
}

`GET /api/v1/webhook_endpoints/{endpoint_ref}/subscriptions`

operation_id: listWebhookSubscriptions

Permission: webhooks:read_list_subscriptions
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{
  "endpoint_ref": "whep_0123456789AB"
}

Response example

{
  "data": {
    "items": []
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/subscriptions`

operation_id: createWebhookSubscription

Permission: webhooks:manage_create_subscription
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "dto_version": 1,
  "public_event_type": "example",
  "scope_ref": "example",
  "scope_type": "tenant"
}

Response example

{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "custom_field_refs": [],
    "dto_version": 1,
    "endpoint_ref": "whep_0123456789AB",
    "public_event_type": "example",
    "scope_ref": "example",
    "scope_type": "tenant"
  }
}

`POST /api/v1/webhook_endpoints/{endpoint_ref}/test_send`

operation_id: sendWebhookTest

Permission: webhooks:manage_test_send
Idempotency: required
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, dependency_unavailable, forbidden, idempotency_key_required, idempotency_mismatch, not_found, precondition_failed, precondition_required, semantic_error, validation_failed, version_conflict

Continue in errors and SDKs.

Request example

{
  "public_event_type": "example"
}

Response example

{
  "data": {
    "attempt_count": 0,
    "created_at": "2026-08-15T12:00:00Z",
    "dead_lettered_at": "2026-08-15T12:00:00Z",
    "delivery_ref": "whd_0123456789AB",
    "diagnostic": false,
    "dto_version": 1,
    "endpoint_ref": "whep_0123456789AB",
    "generation": 0,
    "public_event_type": "example",
    "retry_expires_at": "2026-08-15T12:00:00Z",
    "status": "pending"
  }
}

`GET /api/v1/webhook_event_types`

operation_id: listWebhookEventTypes

Permission: webhooks:read_event_catalog
Idempotency: none
CAS: none
Cursor: none
Quota: "none"
Errors: authentication_failed, forbidden, not_found, validation_failed

Continue in errors and SDKs.

Request example

{}

Response example

{
  "data": {
    "items": []
  }
}

​REST reference

​OpenAPI reference

​GET /api/v1/buyers

​Request example

​Response example

​GET /api/v1/buyers/{buyer_ref}

​Request example

​Response example

​GET /api/v1/captures

​Request example

​Response example

​GET /api/v1/captures/{capture_ref}

​Request example

​Response example

​POST /api/v1/checkout-configs

​Request example

​Response example

​GET /api/v1/checkout-configs/{config_ref}

​Request example

​Response example

​POST /api/v1/checkout-configs/{config_ref}/publish

​Request example

​Response example

​POST /api/v1/checkout-configs/{config_ref}/versions

​Request example

​Response example

​GET /api/v1/checkout-sessions

​Request example

​Response example

​POST /api/v1/checkout-sessions

​Request example

​Response example

​GET /api/v1/checkout-sessions/{checkout_session_ref}

​Request example

​Response example

​POST /api/v1/checkout-sessions/{checkout_session_ref}/pay

​Request example

​Response examples

​retrieve_payment_response

​subscription_setup_action_required

​subscription_started

​POST /api/v1/credentials/{credential_ref}/revoke

​Request example

​Response example

​POST /api/v1/credentials/{credential_ref}/rotate

​Request example

​Response example

​GET /api/v1/disputes

​Request example

​Response example

​GET /api/v1/disputes/{dispute_ref}

​Request example

​Response example

​GET /api/v1/entitlements

​Request example

​Response example

​GET /api/v1/entitlements/{entitlement_ref}

​Request example

​Response example

​GET /api/v1/environments

​Request example

​Response example

​GET /api/v1/invoices

​Request example

​Response example

​GET /api/v1/invoices/{invoice_ref}

​Request example

​Response example

​GET /api/v1/journeys

​Request example

​Response example

​GET /api/v1/journeys/{journey_ref}

​Request example

​Response example

​GET /api/v1/offers

​Request example

​Response example

​GET /api/v1/offers/{offer_ref}

​Request example

​Response example

REST reference

OpenAPI reference

`GET /api/v1/buyers`

Request example

Response example

`GET /api/v1/buyers/{buyer_ref}`

Request example

Response example

`GET /api/v1/captures`

Request example

Response example

`GET /api/v1/captures/{capture_ref}`

Request example

Response example

`POST /api/v1/checkout-configs`

Request example

Response example

`GET /api/v1/checkout-configs/{config_ref}`

Request example

Response example

`POST /api/v1/checkout-configs/{config_ref}/publish`

Request example

Response example

`POST /api/v1/checkout-configs/{config_ref}/versions`

Request example

Response example

`GET /api/v1/checkout-sessions`

Request example

Response example

`POST /api/v1/checkout-sessions`

Request example

Response example

`GET /api/v1/checkout-sessions/{checkout_session_ref}`

Request example

Response example

`POST /api/v1/checkout-sessions/{checkout_session_ref}/pay`

Request example

Response examples

`retrieve_payment_response`

`subscription_setup_action_required`

`subscription_started`

`POST /api/v1/credentials/{credential_ref}/revoke`

Request example

Response example

`POST /api/v1/credentials/{credential_ref}/rotate`

Request example

Response example

`GET /api/v1/disputes`

Request example

Response example

`GET /api/v1/disputes/{dispute_ref}`

Request example

Response example

`GET /api/v1/entitlements`

Request example

Response example

`GET /api/v1/entitlements/{entitlement_ref}`

Request example

Response example

`GET /api/v1/environments`

Request example

Response example

`GET /api/v1/invoices`

Request example

Response example

`GET /api/v1/invoices/{invoice_ref}`

Request example

Response example

`GET /api/v1/journeys`

Request example

Response example

`GET /api/v1/journeys/{journey_ref}`

Request example

Response example

`GET /api/v1/offers`

Request example

Response example

`GET /api/v1/offers/{offer_ref}`

Request example

Response example