> ## Documentation Index
> Fetch the complete documentation index at: https://yn-c9bb3266.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Register Webhook Endpoint

> Registers a new webhook endpoint to receive payment event notifications.

<Warning>
  This endpoint may return 404 in the sandbox environment. Configure webhooks through the Dashboard for sandbox testing.
</Warning>

<Note>
  To list, update, or delete webhook endpoints, use **Dashboard > Settings > Webhooks**. The API currently supports webhook registration only. Full CRUD via API is on the roadmap.
</Note>

## Supported Event Types

When registering a webhook, you can subscribe to any of the following payment event types:

* `payment.created`
* `payment.succeeded`
* `payment.failed`
* `payment.declined`
* `payment.cancelled`
* `payment.expired`
* `payment.refunded`
* `payment.partially_refunded`

See the [Webhook Events](/guides/webhooks/events) reference for the full list of event types across all resources (subscriptions, payouts, customers, disputes, and BaaS).


## OpenAPI

````yaml POST /v1/webhooks
openapi: 3.1.0
info:
  title: Yuno Payments API
  description: >-
    Yuno payment orchestration platform — unified REST API for payments,
    checkout sessions, customers, payment methods, subscriptions, payouts,
    marketplace transfers, and banking connectivity across Latin America.
  version: 1.0.0
  contact:
    name: Yuno Support
    email: support@y.uno
    url: https://docs.y.uno
  license:
    name: Proprietary
    url: https://y.uno
servers:
  - url: https://api-sandbox.y.uno
    description: Sandbox
  - url: https://api.y.uno
    description: Production
security:
  - publicApiKey: []
    privateSecretKey: []
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Register webhook endpoint
      description: Registers a new webhook endpoint to receive payment event notifications.
      operationId: registerWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookRegistrationRequest'
            example:
              url: https://example.com/webhooks/yuno
              events:
                - payment.succeeded
                - payment.failed
                - payment.refunded
              secret: whsec_abc123def456
      responses:
        '201':
          description: Webhook registered successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookRegistration'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    WebhookRegistrationRequest:
      type: object
      required:
        - url
        - events
      properties:
        url:
          type: string
          format: uri
          description: Webhook endpoint URL
          example: https://example.com/webhooks/yuno
        events:
          type: array
          items:
            type: string
          description: Event types to subscribe to
          example:
            - payment.succeeded
            - payment.failed
            - payment.refunded
        secret:
          type: string
          description: Shared secret for signature verification
          example: whsec_abc123def456
      example:
        url: https://example.com/webhooks/yuno
        events:
          - payment.succeeded
          - payment.failed
          - payment.refunded
        secret: whsec_abc123def456
    WebhookRegistration:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: wh_a1b2c3d4-e5f6-7890-abcd-ef1234567890
        url:
          type: string
          format: uri
          example: https://example.com/webhooks/yuno
        events:
          type: array
          items:
            type: string
          example:
            - payment.succeeded
            - payment.failed
            - payment.refunded
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          example: ACTIVE
        secret:
          type: string
          description: Shared secret for HMAC signature verification
          example: whsec_abc123def456
        created_at:
          type: string
          format: date-time
          example: '2026-03-01T10:00:00.000Z'
      example:
        id: wh_a1b2c3d4-e5f6-7890-abcd-ef1234567890
        url: https://example.com/webhooks/yuno
        events:
          - payment.succeeded
          - payment.failed
          - payment.refunded
        status: ACTIVE
        secret: whsec_abc123def456
        created_at: '2026-03-01T10:00:00.000Z'
    Error:
      type: object
      description: >-
        Standard error envelope returned by every Yuno service for any 4xx or
        5xx response. Top level. `code` is a stable SCREAMING_SNAKE_CASE
        identifier. `messages` is always an array of strings, even when there is
        only one entry. There is no `error` wrapper, no singular `message`, no
        `type`, no `details`. See the Error handling guide for the full code
        catalog.
      required:
        - code
        - messages
      properties:
        code:
          type: string
          description: >-
            Stable, machine readable identifier. Branch on this in your client.
            Common values include `BAD_REQUEST`, `VALIDATION_ERROR`,
            `INVALID_REQUEST`, `UNAUTHORIZED`, `FORBIDDEN`, `NOT_FOUND`,
            `TOO_MANY_REQUESTS`, `INTERNAL_ERROR`, `BAD_GATEWAY`,
            `SERVICE_UNAVAILABLE`, plus business codes like
            `CUSTOMER_ID_DUPLICATED`, `RECIPIENT_NOT_FOUND`, `INVALID_STATE`,
            and the `PROVIDER_*` family for downstream provider errors.
          example: VALIDATION_ERROR
        messages:
          type: array
          description: >-
            Human readable details. Validation errors put one entry per failed
            field, formatted `"fieldName message"`.
          items:
            type: string
          example:
            - merchant_customer_id must not be blank
      example:
        code: VALIDATION_ERROR
        messages:
          - amount must be greater than 0
          - country must not be blank
  securitySchemes:
    publicApiKey:
      type: apiKey
      in: header
      name: public-api-key
      description: Your public API key from the Yuno Dashboard
    privateSecretKey:
      type: apiKey
      in: header
      name: private-secret-key
      description: Your private secret key (server-side only)

````