> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trepzy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REST reference

> Reference generated from the canonical OpenAPI contract.

# REST reference

<h2 id="openapi-reference">
  OpenAPI reference
</h2>

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.

<h2 id="retrievedispute">
  `GET /api/v1/disputes/{dispute_ref}`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "dispute_ref": "dsp_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "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"
  }
}
```

<h2 id="retrieveparticipation">
  `GET /api/v1/participations/{participation_ref}`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "participation_ref": "ptc_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "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": 0
  }
}
```

<h2 id="retrievepayout">
  `GET /api/v1/payouts/{payout_ref}`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "payout_ref": "wd_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "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"
  }
}
```

<h2 id="retrieverefund">
  `GET /api/v1/refunds/{refund_ref}`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "refund_ref": "ref_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "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"
  }
}
```

<h2 id="retrievewebhookdelivery">
  `GET /api/v1/webhook_deliveries/{delivery_ref}`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "delivery_ref": "whd_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "delivery_ref": "whd_0123456789AB",
    "diagnostic": false,
    "dto_version": 0,
    "endpoint_ref": "whep_0123456789AB",
    "generation": 0,
    "public_event_type": "example",
    "status": "pending"
  }
}
```

<h2 id="listwebhookdeliveryattempts">
  `GET /api/v1/webhook_deliveries/{delivery_ref}/attempts`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "cursor": "example",
  "delivery_ref": "whd_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "data": {
    "items": []
  }
}
```

<h2 id="retrievewebhookdeliverybody">
  `GET /api/v1/webhook_deliveries/{delivery_ref}/body`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "delivery_ref": "whd_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "data": {
    "body_status": "redacted",
    "delivery_ref": "whd_0123456789AB",
    "match_reasons": [],
    "payload": null
  }
}
```

<h2 id="redrivewebhookdelivery">
  `POST /api/v1/webhook_deliveries/{delivery_ref}/redrive`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "reason": "example"
}
```

### Response example

```json theme={null}
{
  "data": {
    "delivery_ref": "whd_0123456789AB",
    "outcome": "accepted"
  }
}
```

<h2 id="batchredrivewebhookdeliveries">
  `POST /api/v1/webhook_deliveries/redrive`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "delivery_refs": [],
  "reason": "example"
}
```

### Response example

```json theme={null}
{
  "data": {
    "results": []
  }
}
```

<h2 id="listwebhookendpoints">
  `GET /api/v1/webhook_endpoints`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "cursor": "example",
  "status": "active"
}
```

### Response example

```json theme={null}
{
  "data": {
    "items": []
  }
}
```

<h2 id="createwebhookendpoint">
  `POST /api/v1/webhook_endpoints`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "url": "example"
}
```

### Response example

```json theme={null}
{
  "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
  }
}
```

<h2 id="retrievewebhookendpoint">
  `GET /api/v1/webhook_endpoints/{endpoint_ref}`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "endpoint_ref": "whep_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "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
  }
}
```

<h2 id="listwebhookdataprofilegrants">
  `GET /api/v1/webhook_endpoints/{endpoint_ref}/data_profile_grants`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "endpoint_ref": "whep_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "data": {
    "items": []
  }
}
```

<h2 id="createwebhookdataprofilegrant">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/data_profile_grants`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "custom_field_refs": [],
  "data_classes": [],
  "purpose": "example",
  "reason": "example"
}
```

### Response example

```json theme={null}
{
  "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"
  }
}
```

<h2 id="revokewebhookdataprofilegrant">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/data_profile_grants/revoke`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "reason": "example"
}
```

### Response example

```json theme={null}
{
  "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"
  }
}
```

<h2 id="listwebhookdeliveries">
  `GET /api/v1/webhook_endpoints/{endpoint_ref}/deliveries`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "cursor": "example",
  "endpoint_ref": "whep_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "data": {
    "items": []
  }
}
```

<h2 id="retrievewebhookendpointhealth">
  `GET /api/v1/webhook_endpoints/{endpoint_ref}/health`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "endpoint_ref": "whep_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "data": {
    "endpoint_ref": "whep_0123456789AB",
    "health": "ok",
    "last_delivery_status": "pending"
  }
}
```

<h2 id="pausewebhookendpoint">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/pause`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{}
```

### Response example

```json theme={null}
{
  "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
  }
}
```

<h2 id="resumewebhookendpoint">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/resume`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{}
```

### Response example

```json theme={null}
{
  "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
  }
}
```

<h2 id="confirmwebhooksecret">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/secret/confirm`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "reason": "example"
}
```

### Response example

```json theme={null}
{
  "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
  }
}
```

<h2 id="revokewebhooksecret">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/secret/revoke`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "reason": "example"
}
```

### Response example

```json theme={null}
{
  "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
  }
}
```

<h2 id="rotatewebhooksecret">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/secret/rotate`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "reason": "example"
}
```

### Response example

```json theme={null}
{
  "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
  }
}
```

<h2 id="listwebhooksubscriptions">
  `GET /api/v1/webhook_endpoints/{endpoint_ref}/subscriptions`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "endpoint_ref": "whep_0123456789AB"
}
```

### Response example

```json theme={null}
{
  "data": {
    "items": []
  }
}
```

<h2 id="createwebhooksubscription">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/subscriptions`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "dto_version": 1,
  "public_event_type": "example",
  "scope_ref": "example",
  "scope_type": "tenant"
}
```

### Response example

```json theme={null}
{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "custom_field_refs": [],
    "dto_version": 0,
    "endpoint_ref": "whep_0123456789AB",
    "public_event_type": "example",
    "scope_ref": "example",
    "scope_type": "tenant"
  }
}
```

<h2 id="sendwebhooktest">
  `POST /api/v1/webhook_endpoints/{endpoint_ref}/test_send`
</h2>

**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](./errors#intro) and [SDKs](./sdks#intro).

### Request example

```json theme={null}
{
  "public_event_type": "example"
}
```

### Response example

```json theme={null}
{
  "data": {
    "created_at": "2026-08-15T12:00:00Z",
    "delivery_ref": "whd_0123456789AB",
    "diagnostic": false,
    "dto_version": 0,
    "endpoint_ref": "whep_0123456789AB",
    "generation": 0,
    "public_event_type": "example",
    "status": "pending"
  }
}
```