Saltar al contenido principal
GET
Get a webhook endpoint
v1 · Base URL https://api.fintoc.com/v1

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

id
string
requerido

The id of the webhook endpoint to retrieve.

Respuesta

The webhook endpoint. secret is always null outside creation.

id
string
requerido

Unique identifier of the webhook endpoint.

Ejemplo:

"we_M6yrvOepCe3Rqp8B"

object
any
requerido

Type of the object. Always webhook_endpoint.

created_at
string<date-time>
requerido

ISO 8601 timestamp of when the webhook endpoint was created.

Ejemplo:

"2021-05-17T17:04:10.284Z"

description
string | null
requerido

Optional free-text description of the endpoint.

Ejemplo:

"Webhook endpoint for payment events."

enabled_events
enum<string>[]
requerido

Event types that trigger a notification to this endpoint.

Opciones disponibles:
link.credentials_changed,
link.refresh_intent.succeeded,
link.refresh_intent.failed,
account.refresh_intent.succeeded,
account.refresh_intent.failed,
account.refresh_intent.rejected,
payment_intent.succeeded,
payment_intent.rejected,
payment_intent.failed,
payment_intent.pending,
payment_intent.expired,
subscription.activated,
subscription.canceled,
subscription_intent.succeeded,
subscription_intent.rejected,
subscription_intent.failed,
charge.succeeded,
charge.failed,
account.refresh_intent.movements_removed,
account.refresh_intent.movements_modified,
refund.succeeded,
refund.failed,
refund.in_progress,
payout.created,
payout.canceled,
payout.succeeded,
payout.returned,
checkout_session.finished,
checkout_session.expired,
transfer.inbound.succeeded,
transfer.outbound.succeeded,
transfer.outbound.failed,
transfer.outbound.returned,
transfer.inbound.returned,
transfer.inbound.return_failed,
account_number.deleted,
account_verification.succeeded,
account_verification.failed,
transfer.inbound.rejected,
payment_method.activated,
payment_method.canceled,
invoice.created,
invoice.finalized,
invoice.payment_created,
invoice.payment_failed,
invoice.payment_succeeded,
invoice.voided,
dispute.waiting_documentation,
dispute.in_review,
dispute.won,
dispute.lost,
dispute.expired,
entity.onboarding.approved,
entity.onboarding.rejected
mode
enum<string>
requerido

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

Opciones disponibles:
test,
live
Ejemplo:

"live"

name
string | null
requerido

Optional name to identify the endpoint.

Ejemplo:

"My webhook endpoint"

secret
string | null
requerido

Secret used to verify the signature of the webhooks sent to the endpoint. Only returned when the endpoint is created; null in every other response.

Ejemplo:

"whsec_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ"

status
enum<string>
requerido

Whether the endpoint currently receives event notifications.

Opciones disponibles:
disabled,
enabled
Ejemplo:

"enabled"

url
string
requerido

HTTPS URL that receives the event notifications.

Ejemplo:

"https://my.webhook.endpoint"