openapi: 3.2.0
info:
  title: Fiat Republic Webhooks API
  version: '1.0'
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: fiat-republic-republic-openapi.yml, fiat-republic-transaction-monitoring-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sandbox.fiatrepublic.com/api/v1
- url: https://sandbox-oxygen.fiatrepublic.com/api/v1
security:
- sec0: []
tags:
- name: Webhooks
paths:
  /webhooks:
    post:
      summary: Create Webhook
      description: ''
      operationId: create-webhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - events
              - url
              properties:
                description:
                  type: string
                  description: Optional description for the Webhook.
                events:
                  type: array
                  description: '[Events](https://docs.fiatrepublic.com/docs/webhooks) that you want to receive on the provided URL.'
                  items:
                    type: string
                metadata:
                  type: array
                  items:
                    type: string
                status:
                  type: string
                  description: Defaults to `ENABLED` if not set.
                  enum:
                  - ENABLED
                  - DISABLED
                url:
                  type: string
                  description: URL on which you want to receive the events.
      responses:
        '201':
          description: '201'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"whk_ejl2vpn1m305rxko6b\",\n    \"url\": \"https://webhook.site/0da05c1a-6978-4178-bee9-1cabb582ac3f\",\n    \"events\": [\n        \"INDIVIDUAL_END_USER.CREATED\",\n        \"PAYMENT.CREATED\",\n        \"FIAT_ACCOUNT.CREATED\",\n        \"FIAT_ACCOUNT.UPDATED\",\n        \"FIAT_ACCOUNT.STATUS_UPDATED\",\n        \"INDIVIDUAL_END_USER.STATUS_UPDATED\",\n        \"PAYMENT.STATUS_UPDATED\"\n    ],\n    \"status\": \"ENABLED\",\n    \"description\": \"Fiat Republic Webhooks\",\n    \"createdAt\": 1637601761317,\n    \"updatedAt\": 1637601761317,\n    \"metadata\": null\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: whk_ejl2vpn1m305rxko6b
                  url:
                    type: string
                    example: https://webhook.site/0da05c1a-6978-4178-bee9-1cabb582ac3f
                  events:
                    type: array
                    items:
                      type: string
                      example: INDIVIDUAL_END_USER.CREATED
                  status:
                    type: string
                    example: ENABLED
                  description:
                    type: string
                    example: Fiat Republic Webhooks
                  createdAt:
                    type: integer
                    example: 1637601761317
                    default: 0
                  updatedAt:
                    type: integer
                    example: 1637601761317
                    default: 0
                  metadata: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl --request POST \\\n     --url https://sandbox.fiatrepublic.com/api/v1/payments \\\n     --header 'Accept: application/json' \\\n     --header 'Authorization: Bearer ZmlhdHJlcHVibGljOmZpYXRyZXB1YmxpYw==' \\\n     --header 'Content-Type: application/json' \\\n     --data '\n{\n    \"url\": \"https://webhook.site/0da05c1a-6978-4178-bee9-1cabb582ac3f\",\n    \"description\": \"Fiat Republic Webhooks\",\n    \"status\": \"ENABLED\",\n    \"events\": [\n        \"INDIVIDUAL_END_USER.CREATED\",\n        \"PAYMENT.CREATED\",\n        \"FIAT_ACCOUNT.CREATED\",\n        \"FIAT_ACCOUNT.UPDATED\",\n        \"FIAT_ACCOUNT.STATUS_UPDATED\",\n        \"INDIVIDUAL_END_USER.STATUS_UPDATED\",\n        \"PAYMENT.STATUS_UPDATED\"\n    ],\n    \"metadata\": null\n}\n'"
        samples-languages:
        - curl
      tags:
      - Webhooks
    get:
      summary: List Webhooks
      description: ''
      operationId: list-webhooks
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        schema:
          type: integer
          format: int32
      - name: status
        in: query
        description: Accepts multiple values.
        schema:
          type: string
          enum:
          - ENABLED
          - DISABLED
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n    {\n        \"id\": \"whk_emv4j231821oaz56yx\",\n        \"url\": \"https://webhook.site/fc5201ce-e1b6-4bf7-8b73-37ae92c99736\",\n        \"events\": [\n            \"INDIVIDUAL_END_USER.CREATED\",\n            \"PAYMENT.CREATED\",\n            \"FIAT_ACCOUNT.CREATED\",\n            \"FIAT_ACCOUNT.UPDATED\",\n            \"FIAT_ACCOUNT.STATUS_UPDATED\",\n            \"INDIVIDUAL_END_USER.STATUS_UPDATED\"\n        ],\n        \"status\": \"ENABLED\",\n        \"description\": \"just some test webhook\",\n        \"createdAt\": 1637600101003,\n        \"updatedAt\": 1637600101003,\n        \"metadata\": null\n    },\n    {...},\n    {...}\n]"
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl --request GET \\\n     --url https://sandbox.fiatrepublic.com/api/v1/webhooks \\\n     --header 'Accept: application/json' \n     --header 'Authorization: Basic ZmlhdHJlcHVibGljOmZpYXRyZXB1YmxpYw==' \\"
        samples-languages:
        - curl
      tags:
      - Webhooks
    servers:
    - url: https://sandbox.fiatrepublic.com/api/v1
  /webhooks/{id}:
    get:
      summary: Get Webhook
      description: ''
      operationId: get-webhook
      parameters:
      - name: id
        in: path
        description: Id of the Webhook.
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"whk_ejl2vpn1m305rxko6b\",\n    \"url\": \"https://webhook.site/0da05c1a-6978-4178-bee9-1cabb582ac3f\",\n    \"events\": [\n        \"INDIVIDUAL_END_USER.CREATED\",\n        \"PAYMENT.CREATED\",\n        \"FIAT_ACCOUNT.CREATED\",\n        \"FIAT_ACCOUNT.UPDATED\",\n        \"FIAT_ACCOUNT.STATUS_UPDATED\",\n        \"INDIVIDUAL_END_USER.STATUS_UPDATED\",\n        \"PAYMENT.STATUS_UPDATED\"\n    ],\n    \"status\": \"ENABLED\",\n    \"description\": \"Fiat Republic Webhooks\",\n    \"createdAt\": 1637601761317,\n    \"updatedAt\": 1637601761317,\n    \"metadata\": null\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: whk_ejl2vpn1m305rxko6b
                  url:
                    type: string
                    example: https://webhook.site/0da05c1a-6978-4178-bee9-1cabb582ac3f
                  events:
                    type: array
                    items:
                      type: string
                      example: INDIVIDUAL_END_USER.CREATED
                  status:
                    type: string
                    example: ENABLED
                  description:
                    type: string
                    example: Fiat Republic Webhooks
                  createdAt:
                    type: integer
                    example: 1637601761317
                    default: 0
                  updatedAt:
                    type: integer
                    example: 1637601761317
                    default: 0
                  metadata: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl --request GET \\\n     --url https://sandbox.fiatrepublic.com/api/v1/webhooks/whk_ejl2vpn1m305rxko6b \\\n     --header 'Accept: application/json' \n     --header 'Authorization: Basic ZmlhdHJlcHVibGljOmZpYXRyZXB1YmxpYw==' \\"
        samples-languages:
        - curl
      tags:
      - Webhooks
    patch:
      summary: Update Webhook
      description: ''
      operationId: update-webhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: Optional description for the Webhook.
                events:
                  type: array
                  description: Events that you want to receive on the provided URL.
                  items:
                    type: string
                metadata:
                  type: array
                  items:
                    type: string
                status:
                  type: string
                  enum:
                  - ENABLED
                  - DISABLED
                url:
                  type: string
                  description: URL on which you want to receive the events.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"whk_ejl2vpn1m305rxko6b\",\n    \"url\": \"https://webhook.site/0da05c1a-6978-4178-bee9-1cabb582ac3f\",\n    \"events\": [\n        \"PAYMENT.STATUS_UPDATED\",\n        \"INDIVIDUAL_END_USER.CREATED\",\n        \"PAYMENT.CREATED\",\n        \"FIAT_ACCOUNT.CREATED\",\n        \"FIAT_ACCOUNT.UPDATED\",\n        \"FIAT_ACCOUNT.STATUS_UPDATED\",\n        \"INDIVIDUAL_END_USER.STATUS_UPDATED\",\n        \"FIAT_ACCOUNT.BALANCE_UPDATED\"\n    ],\n    \"status\": \"ENABLED\",\n    \"description\": \"Fiat Republic Webhooks\",\n    \"createdAt\": 1637601761317,\n    \"updatedAt\": 1637601761317,\n    \"metadata\": null\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: whk_ejl2vpn1m305rxko6b
                  url:
                    type: string
                    example: https://webhook.site/0da05c1a-6978-4178-bee9-1cabb582ac3f
                  events:
                    type: array
                    items:
                      type: string
                      example: PAYMENT.STATUS_UPDATED
                  status:
                    type: string
                    example: ENABLED
                  description:
                    type: string
                    example: Fiat Republic Webhooks
                  createdAt:
                    type: integer
                    example: 1637601761317
                    default: 0
                  updatedAt:
                    type: integer
                    example: 1637601761317
                    default: 0
                  metadata: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl --request PATCH \\\n     --url https://sandbox.fiatrepublic.com/api/v1/webhooks/whk_ejl2vpn1m305rxko6b \\\n     --header 'Accept: application/json' \\\n     --header 'Authorization: Bearer ZmlhdHJlcHVibGljOmZpYXRyZXB1YmxpYw==' \\\n     --header 'Content-Type: application/json' \\\n     --data '\n{\n    \"events\": [\n        \"INDIVIDUAL_END_USER.CREATED\",\n        \"PAYMENT.CREATED\",\n        \"FIAT_ACCOUNT.CREATED\",\n        \"FIAT_ACCOUNT.UPDATED\",\n        \"FIAT_ACCOUNT.STATUS_UPDATED\",\n        \"INDIVIDUAL_END_USER.STATUS_UPDATED\",\n        \"FIAT_ACCOUNT.BALANCE_UPDATED\",\n        \"PAYMENT.STATUS_UPDATED\"\n    ]\n}\n'\n"
        samples-languages:
        - curl
      tags:
      - Webhooks
    delete:
      summary: Delete Webhook
      description: ''
      operationId: delete-webhook
      parameters:
      - name: id
        in: path
        description: Id of the Webhook. You can also update the status of the Webhook to `DISABLED` instead.
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Webhooks
    servers:
    - url: https://sandbox.fiatrepublic.com/api/v1
components:
  securitySchemes:
    sec0:
      type: oauth2
      flows: {}
x-refined-from:
- fiat-republic-republic-openapi.yml
- fiat-republic-transaction-monitoring-openapi.yml
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.fiatrepublic.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.fiatrepublic.com/reference/create-api-token.md
  merge:
    pages: 1
    deduped: 0
    conflicts_kept_first: 0