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/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/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": 0
  }
}

`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/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/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": {
    "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"
  }
}

`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": [],
  "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": 0,
    "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": {
    "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"
  }
}

⌘I

​REST reference

​OpenAPI reference

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

​POST /api/v1/webhook_deliveries/redrive

​Request example

​Response example

​GET /api/v1/webhook_endpoints

​Request example

​Response example

​POST /api/v1/webhook_endpoints

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

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

​Request example

​Response example

REST reference

OpenAPI reference

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

`POST /api/v1/webhook_deliveries/redrive`

Request example

Response example

`GET /api/v1/webhook_endpoints`

Request example

Response example

`POST /api/v1/webhook_endpoints`

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example

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

Request example

Response example