find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/blindpay-com:blindpay-com-webhook-endpoints-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 1.0.0
  title: BlindPay Webhook Endpoints API
security:
- Bearer: []
tags:
- name: Webhook Endpoints
paths:
  /v1/instances/{instance_id}/webhook-endpoints:
    post:
      x-sdk: true
      tags:
      - Webhook Endpoints
      summary: Register Webhook
      description: Registers an HTTPS endpoint that receives the listed events. Event names and payload schemas are in the webhooks section of this API reference (and in the MCP resource blindpay://webhooks/events). Deliveries are signed with Svix; read the signing secret with Retrieve Webhook Secret and verify every delivery.
      parameters:
      - schema:
          type: string
          minLength: 15
          maxLength: 15
          example: in_000000000000
        required: true
        name: instance_id
        in: path
      - schema:
          type: string
          maxLength: 255
          description: Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        required: false
        name: Idempotency-Key
        in: header
      requestBody:
        description: Create a new webhook endpoint
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookEndpointIn'
      responses:
        '200':
          description: Create webhook endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointOut'
        '400':
          description: 'Possible error codes: `VALIDATION_FAILED`, `WEBHOOKS_LIMIT_REACHED`, `WEBHOOKS_URL_INVALID`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                VALIDATION_FAILED:
                  summary: VALIDATION_FAILED
                  value:
                    success: false
                    code: VALIDATION_FAILED
                    message: validation_failed
                    description: The request contains invalid fields. Check the errors list for details.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
                WEBHOOKS_LIMIT_REACHED:
                  summary: WEBHOOKS_LIMIT_REACHED
                  value:
                    success: false
                    code: WEBHOOKS_LIMIT_REACHED
                    message: webhook_endpoint_limit_reached
                    description: You reached the maximum number of webhook endpoints.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
                WEBHOOKS_URL_INVALID:
                  summary: WEBHOOKS_URL_INVALID
                  value:
                    success: false
                    code: WEBHOOKS_URL_INVALID
                    message: webhook_url_invalid
                    description: The webhook URL is not valid. Use a reachable HTTPS URL.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '401':
          description: 'Possible error codes: `AUTH_UNAUTHORIZED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_UNAUTHORIZED:
                  summary: AUTH_UNAUTHORIZED
                  value:
                    success: false
                    code: AUTH_UNAUTHORIZED
                    message: unauthorized
                    description: Authentication failed. Check your API key or session and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '403':
          description: 'Possible error codes: `AUTH_FORBIDDEN`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_FORBIDDEN:
                  summary: AUTH_FORBIDDEN
                  value:
                    success: false
                    code: AUTH_FORBIDDEN
                    message: user_not_allowed
                    description: You do not have permission to perform this action.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '429':
          description: 'Possible error codes: `AUTH_RATE_LIMITED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_RATE_LIMITED:
                  summary: AUTH_RATE_LIMITED
                  value:
                    success: false
                    code: AUTH_RATE_LIMITED
                    message: card_payment_rate_limit_exceeded
                    description: Too many requests. Wait a moment and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '500':
          description: 'Possible error codes: `INTERNAL_ERROR`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    success: false
                    code: INTERNAL_ERROR
                    message: internal_error
                    description: Something went wrong on our side. Try again, and contact support with the trace ID if the problem persists.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
      operationId: postV1InstancesByInstanceIdWebhookEndpoints
      x-operation-id-source: derived
    get:
      x-sdk: true
      tags:
      - Webhook Endpoints
      summary: Retrieve Webhooks
      parameters:
      - schema:
          type: string
          minLength: 15
          maxLength: 15
          example: in_000000000000
        required: true
        name: instance_id
        in: path
      responses:
        '200':
          description: Get webhook endpoints
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookEndpoint'
        '400':
          description: 'Possible error codes: `VALIDATION_FAILED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                VALIDATION_FAILED:
                  summary: VALIDATION_FAILED
                  value:
                    success: false
                    code: VALIDATION_FAILED
                    message: validation_failed
                    description: The request contains invalid fields. Check the errors list for details.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '401':
          description: 'Possible error codes: `AUTH_UNAUTHORIZED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_UNAUTHORIZED:
                  summary: AUTH_UNAUTHORIZED
                  value:
                    success: false
                    code: AUTH_UNAUTHORIZED
                    message: unauthorized
                    description: Authentication failed. Check your API key or session and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '403':
          description: 'Possible error codes: `AUTH_FORBIDDEN`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_FORBIDDEN:
                  summary: AUTH_FORBIDDEN
                  value:
                    success: false
                    code: AUTH_FORBIDDEN
                    message: user_not_allowed
                    description: You do not have permission to perform this action.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '429':
          description: 'Possible error codes: `AUTH_RATE_LIMITED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_RATE_LIMITED:
                  summary: AUTH_RATE_LIMITED
                  value:
                    success: false
                    code: AUTH_RATE_LIMITED
                    message: card_payment_rate_limit_exceeded
                    description: Too many requests. Wait a moment and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '500':
          description: 'Possible error codes: `INTERNAL_ERROR`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    success: false
                    code: INTERNAL_ERROR
                    message: internal_error
                    description: Something went wrong on our side. Try again, and contact support with the trace ID if the problem persists.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
      operationId: getV1InstancesByInstanceIdWebhookEndpoints
      x-operation-id-source: derived
  /v1/instances/{instance_id}/webhook-endpoints/{id}:
    delete:
      x-sdk: true
      tags:
      - Webhook Endpoints
      summary: Remove Webhook
      parameters:
      - schema:
          type: string
          minLength: 15
          maxLength: 15
          example: in_000000000000
        required: true
        name: instance_id
        in: path
      - schema:
          type: string
          minLength: 15
          maxLength: 15
          example: we_000000000000
        required: true
        name: id
        in: path
      - schema:
          type: string
          maxLength: 255
          description: Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        required: false
        name: Idempotency-Key
        in: header
      responses:
        '200':
          description: Delete webhook endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
        '400':
          description: 'Possible error codes: `VALIDATION_FAILED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                VALIDATION_FAILED:
                  summary: VALIDATION_FAILED
                  value:
                    success: false
                    code: VALIDATION_FAILED
                    message: validation_failed
                    description: The request contains invalid fields. Check the errors list for details.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '401':
          description: 'Possible error codes: `AUTH_UNAUTHORIZED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_UNAUTHORIZED:
                  summary: AUTH_UNAUTHORIZED
                  value:
                    success: false
                    code: AUTH_UNAUTHORIZED
                    message: unauthorized
                    description: Authentication failed. Check your API key or session and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '403':
          description: 'Possible error codes: `AUTH_FORBIDDEN`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_FORBIDDEN:
                  summary: AUTH_FORBIDDEN
                  value:
                    success: false
                    code: AUTH_FORBIDDEN
                    message: user_not_allowed
                    description: You do not have permission to perform this action.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '429':
          description: 'Possible error codes: `AUTH_RATE_LIMITED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_RATE_LIMITED:
                  summary: AUTH_RATE_LIMITED
                  value:
                    success: false
                    code: AUTH_RATE_LIMITED
                    message: card_payment_rate_limit_exceeded
                    description: Too many requests. Wait a moment and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '500':
          description: 'Possible error codes: `INTERNAL_ERROR`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    success: false
                    code: INTERNAL_ERROR
                    message: internal_error
                    description: Something went wrong on our side. Try again, and contact support with the trace ID if the problem persists.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
      operationId: deleteV1InstancesByInstanceIdWebhookEndpointsById
      x-operation-id-source: derived
  /v1/instances/{instance_id}/webhook-endpoints/{id}/secret:
    get:
      x-sdk: true
      tags:
      - Webhook Endpoints
      summary: Retrieve Webhook Secret
      parameters:
      - schema:
          type: string
          minLength: 15
          maxLength: 15
          example: in_000000000000
        required: true
        name: instance_id
        in: path
      - schema:
          type: string
          minLength: 15
          maxLength: 15
          example: we_000000000000
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Get webhook endpoint secret
          content:
            application/json:
              schema:
                type: object
                properties:
                  key:
                    type: string
                    example: whsec_000000000000
                required:
                - key
        '400':
          description: 'Possible error codes: `VALIDATION_FAILED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                VALIDATION_FAILED:
                  summary: VALIDATION_FAILED
                  value:
                    success: false
                    code: VALIDATION_FAILED
                    message: validation_failed
                    description: The request contains invalid fields. Check the errors list for details.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '401':
          description: 'Possible error codes: `AUTH_UNAUTHORIZED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_UNAUTHORIZED:
                  summary: AUTH_UNAUTHORIZED
                  value:
                    success: false
                    code: AUTH_UNAUTHORIZED
                    message: unauthorized
                    description: Authentication failed. Check your API key or session and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '403':
          description: 'Possible error codes: `AUTH_FORBIDDEN`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_FORBIDDEN:
                  summary: AUTH_FORBIDDEN
                  value:
                    success: false
                    code: AUTH_FORBIDDEN
                    message: user_not_allowed
                    description: You do not have permission to perform this action.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '429':
          description: 'Possible error codes: `AUTH_RATE_LIMITED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_RATE_LIMITED:
                  summary: AUTH_RATE_LIMITED
                  value:
                    success: false
                    code: AUTH_RATE_LIMITED
                    message: card_payment_rate_limit_exceeded
                    description: Too many requests. Wait a moment and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '500':
          description: 'Possible error codes: `INTERNAL_ERROR`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    success: false
                    code: INTERNAL_ERROR
                    message: internal_error
                    description: Something went wrong on our side. Try again, and contact support with the trace ID if the problem persists.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
      operationId: getV1InstancesByInstanceIdWebhookEndpointsByIdSecret
      x-operation-id-source: derived
  /v1/instances/{instance_id}/webhook-endpoints/portal-access:
    get:
      x-sdk: true
      tags:
      - Webhook Endpoints
      summary: Retrieve Webhook Portal Access
      parameters:
      - schema:
          type: string
          minLength: 15
          maxLength: 15
          example: in_000000000000
        required: true
        name: instance_id
        in: path
      responses:
        '200':
          description: Get webhook portal access url
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortalAccessOut'
        '400':
          description: 'Possible error codes: `VALIDATION_FAILED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                VALIDATION_FAILED:
                  summary: VALIDATION_FAILED
                  value:
                    success: false
                    code: VALIDATION_FAILED
                    message: validation_failed
                    description: The request contains invalid fields. Check the errors list for details.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '401':
          description: 'Possible error codes: `AUTH_UNAUTHORIZED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_UNAUTHORIZED:
                  summary: AUTH_UNAUTHORIZED
                  value:
                    success: false
                    code: AUTH_UNAUTHORIZED
                    message: unauthorized
                    description: Authentication failed. Check your API key or session and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '403':
          description: 'Possible error codes: `AUTH_FORBIDDEN`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_FORBIDDEN:
                  summary: AUTH_FORBIDDEN
                  value:
                    success: false
                    code: AUTH_FORBIDDEN
                    message: user_not_allowed
                    description: You do not have permission to perform this action.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '429':
          description: 'Possible error codes: `AUTH_RATE_LIMITED`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTH_RATE_LIMITED:
                  summary: AUTH_RATE_LIMITED
                  value:
                    success: false
                    code: AUTH_RATE_LIMITED
                    message: card_payment_rate_limit_exceeded
                    description: Too many requests. Wait a moment and try again.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
        '500':
          description: 'Possible error codes: `INTERNAL_ERROR`. See the Error responses section for retry semantics.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    success: false
                    code: INTERNAL_ERROR
                    message: internal_error
                    description: Something went wrong on our side. Try again, and contact support with the trace ID if the problem persists.
                    errors: []
                    trace_id: 0af7651916cd43dd8448eb211c80319c
      operationId: getV1InstancesByInstanceIdWebhookEndpointsPortalAccess
      x-operation-id-source: derived
components:
  schemas:
    WebhookEndpointIn:
      type: object
      properties:
        url:
          type: string
          format: uri
          example: https://example.com/webhook
        events:
          type: array
          items:
            type: string
            enum:
            - customer.new
            - customer.update
            - customer.delete
            - bankAccount.new
            - payout.new
            - payout.update
            - payout.complete
            - payout.partnerFee
            - blockchainWallet.new
            - blockchainWallet.update
            - payin.new
            - payin.update
            - payin.complete
            - payin.partnerFee
            - tos.accept
            - limitIncrease.new
            - limitIncrease.update
            - virtualAccount.new
            - virtualAccount.complete
            - transfer.new
            - transfer.update
            - transfer.complete
            - wallet.new
            - wallet.update
            - wallet.inbound
            - payable.new
            - payable.update
            - payable.complete
          example:
          - customer.new
      required:
      - url
      - events
    PortalAccessOut:
      type: object
      properties:
        url:
          type: string
          format: uri
          example: https://example.com/webhook
      required:
      - url
    Success:
      type: object
      properties:
        success:
          type: boolean
          example: true
      required:
      - success
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          minLength: 15
          maxLength: 15
          example: we_000000000000
        url:
          type: string
          format: uri
          example: https://example.com/webhook
        events:
          type: array
          items:
            type: string
            enum:
            - customer.new
            - customer.update
            - customer.delete
            - bankAccount.new
            - payout.new
            - payout.update
            - payout.complete
            - payout.partnerFee
            - blockchainWallet.new
            - blockchainWallet.update
            - payin.new
            - payin.update
            - payin.complete
            - payin.partnerFee
            - tos.accept
            - limitIncrease.new
            - limitIncrease.update
            - virtualAccount.new
            - virtualAccount.complete
            - transfer.new
            - transfer.update
            - transfer.complete
            - wallet.new
            - wallet.update
            - wallet.inbound
            - payable.new
            - payable.update
            - payable.complete
          example:
          - customer.new
        last_event_at:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
          example: '2024-01-01T00:00:00.000Z'
        instance_id:
          type: string
          minLength: 15
          maxLength: 15
          example: in_000000000000
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          example: '2021-01-01T00:00:00Z'
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          example: '2021-01-01T00:00:00Z'
      required:
      - id
      - url
      - events
      - instance_id
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        code:
          type: string
          description: Stable error code. See the Error codes section for the full list.
          example: PAYOUTS_INSUFFICIENT_BALANCE
        message:
          type: string
          description: Legacy machine-readable message. Prefer `code` for programmatic handling.
          example: not_enough_balance
        description:
          type: string
          description: Human-readable explanation, safe to show to end users.
          example: There is not enough balance to complete this payout. Fund your balance and try again.
        errors:
          type: array
          items:
            type: string
          example:
          - Bad Request
        trace_id:
          type: string
          description: Request trace ID. Include it when contacting support.
          example: 0af7651916cd43dd8448eb211c80319c
      required:
      - success
      - message
      - errors
    WebhookEndpointOut:
      type: object
      properties:
        id:
          type: string
          minLength: 15
          maxLength: 15
          example: we_000000000000
      required:
      - id
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT