public-api

Integration home: connections, webhooks, API keys, usage and portal links

GET /v1/integration

• getIntegrationHome
• API key scope integration:read
• Tenant operator

Parameters

Responses

• 200 OK application/json

  Schema IntegrationHome

  Integration home of an operator (FR-PLAT-06): connections, webhook registration, API keys, usage, integrator webhooks and portal links.

  • operatorId Uuidrequired

  • generatedAt Timestamprequired

  • activeConnectionId string | null (uuid)required

    Active primary connection (production first).

  • connections array of IntegrationConnectionrequired

    Connections not retired, active first.

  • apiKeys objectrequired

    Unrevoked, unexpired keys of the operator (all customers and operator-level).

    Fields of apiKeys

    • active integerrequired

      min 0

    • live integerrequired

      min 0

    • test integerrequired

      min 0

    • operatorLevel integerrequired

      min 0

    • usedLast24h integerrequired

      min 0

  • usageLast7Days ApiUsageTotalsrequired

  • integratorWebhooks objectrequired

    Fields of integratorWebhooks

    • endpoints integerrequired

      min 0

    • active integerrequired

      min 0

    • paused integerrequired

      min 0

    • failed integerrequired

      min 0

    • deliveriesPending integerrequired

      min 0

    • deliveriesFailed24h integerrequired

      min 0

    • lastDeliveryAt Timestamp | nullrequired

  • links objectrequired

    Developer portal (DEVELOPER_PORTAL_URL, D-35, D-42).

    Fields of links

    • portal string (uri)required

    • reference string (uri)required

    • gettingStarted string (uri)required

    • sandbox string (uri)required

    • changelog string (uri)required

    • openapi string (uri)required

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X GET "https://bank.wirebloom.com/v1/integration" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integration", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "GET",
    "https://bank.wirebloom.com/v1/integration",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Recent requests of an API key (7 days, no bodies)

GET /v1/integration/api-keys/{apiKeyId}/requests

• listOperatorApiKeyRequests
• API key scope integration:read
• Tenant operator

Parameters

Responses

• 200 OK application/json

  Schema ApiKeyRequestLog

  • apiKeyId Uuidrequired

  • retentionDays integerrequired

    Days the request log keeps (7).

    min 1

  • statusCounts objectrequired

    Responses per HTTP status over the retention window (error breakdown).

  • data array of ApiRequestLogEntryrequired

    Newest first.

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X GET "https://bank.wirebloom.com/v1/integration/api-keys/{apiKeyId}/requests" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integration/api-keys/{apiKeyId}/requests", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "GET",
    "https://bank.wirebloom.com/v1/integration/api-keys/{apiKeyId}/requests",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

API usage per key across the operator (daily)

GET /v1/integration/api-usage

• getOperatorApiUsage
• API key scope integration:read
• Tenant operator

Parameters

Responses

• 200 OK application/json

  Schema ApiUsageReport

  • from Daterequired

  • to Daterequired

  • generatedAt Timestamprequired

  • totals ApiUsageTotalsrequired

  • keys array of ApiKeyUsagerequired

    Keys in scope (at most 200, newest first): active keys and keys revoked during the window, with or without requests.

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X GET "https://bank.wirebloom.com/v1/integration/api-usage" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integration/api-usage", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "GET",
    "https://bank.wirebloom.com/v1/integration/api-usage",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

List integrator webhook endpoints

GET /v1/integrator-webhooks

• listIntegratorWebhooks
• API key scope webhooks:manage
• Tenant any

Parameters

Responses

• 200 OK application/json

  Schema IntegratorWebhookPage

  Cursor-paginated list of IntegratorWebhook.

  • data array of IntegratorWebhookrequired

  • page PageInforequired

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X GET "https://bank.wirebloom.com/v1/integrator-webhooks" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "GET",
    "https://bank.wirebloom.com/v1/integrator-webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Register webhook endpoint

POST /v1/integrator-webhooks

• createIntegratorWebhook
• API key scope webhooks:manage
• Tenant any

Parameters

Request body

Required. application/json

Responses

• 201 Created application/json

  Schema IntegratorWebhookCreated

  • id Uuidrequiredread-only

    Fields of id

    Uuid

  • url string (uri)required

  • events array of IntegratorEventTyperequired

  • description string | null

    max length 200

  • enabled booleanrequired

  • secretPrefix stringrequiredread-only

  • createdAt Timestamprequiredread-only

    Fields of createdAt

    Timestamp

  • updatedAt Timestamprequiredread-only

    Row version: the ETag is W/"<updatedAt epoch ms>" (If-Match on PATCH).

    Fields of updatedAt

    Timestamp

  • lastDeliveryAt Timestamp | null

  • failureCount integerrequiredread-only

    min 0

  • status stringread-only

    paused after 20 consecutive failed attempts or enabled: false; failed when a delivery exhausts 72 h without success. Re-enable with PATCH enabled: true.

    One of: "active", "paused", "failed"

  • pauseReason string | nullread-only

  • secret stringrequired

    Signing secret whsec_..., shown once.

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 422 Semantically invalid request; `errors[]` lists field-level problems. Also `idempotency-key-reused` when the key was used with a different payload, `limit-exceeded`, `recipient-not-approved`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X POST "https://bank.wirebloom.com/v1/integrator-webhooks" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "url": "https://example.com",
  "events": [
    "webhook.test"
  ]
}'

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com",
    "events": [
      "webhook.test"
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://bank.wirebloom.com/v1/integrator-webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "url": "https://example.com",
      "events": [
        "webhook.test"
      ]
    },
    timeout=30,
)
response.raise_for_status()

Get webhook endpoint

GET /v1/integrator-webhooks/{webhookId}

• getIntegratorWebhook
• API key scope webhooks:manage
• Tenant any

Parameters

Responses

• 200 OK application/json

  Schema IntegratorWebhook

  Integrator webhook endpoint (tenant.integrator_webhooks). Customer-level endpoints receive the customer's events; operator-level endpoints (created with X-Tenant-Id = the operator, P9-T08b) receive the events of every customer of the operator, including the operator-only types.

  • id Uuidrequiredread-only

    Fields of id

    Uuid

  • url string (uri)required

  • events array of IntegratorEventTyperequired

  • description string | null

    max length 200

  • enabled booleanrequired

  • secretPrefix stringrequiredread-only

  • createdAt Timestamprequiredread-only

    Fields of createdAt

    Timestamp

  • updatedAt Timestamprequiredread-only

    Row version: the ETag is W/"<updatedAt epoch ms>" (If-Match on PATCH).

    Fields of updatedAt

    Timestamp

  • lastDeliveryAt Timestamp | null

  • failureCount integerrequiredread-only

    min 0

  • status stringread-only

    paused after 20 consecutive failed attempts or enabled: false; failed when a delivery exhausts 72 h without success. Re-enable with PATCH enabled: true.

    One of: "active", "paused", "failed"

  • pauseReason string | nullread-only

• 304 Not modified (`If-None-Match` matched).
• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X GET "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "GET",
    "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Update webhook endpoint

PATCH /v1/integrator-webhooks/{webhookId}

• updateIntegratorWebhook
• API key scope webhooks:manage
• Tenant any

Parameters

Request body

Required. application/json

Responses

• 200 OK application/json

  Schema IntegratorWebhook

  Integrator webhook endpoint (tenant.integrator_webhooks). Customer-level endpoints receive the customer's events; operator-level endpoints (created with X-Tenant-Id = the operator, P9-T08b) receive the events of every customer of the operator, including the operator-only types.

  • id Uuidrequiredread-only

    Fields of id

    Uuid

  • url string (uri)required

  • events array of IntegratorEventTyperequired

  • description string | null

    max length 200

  • enabled booleanrequired

  • secretPrefix stringrequiredread-only

  • createdAt Timestamprequiredread-only

    Fields of createdAt

    Timestamp

  • updatedAt Timestamprequiredread-only

    Row version: the ETag is W/"<updatedAt epoch ms>" (If-Match on PATCH).

    Fields of updatedAt

    Timestamp

  • lastDeliveryAt Timestamp | null

  • failureCount integerrequiredread-only

    min 0

  • status stringread-only

    paused after 20 consecutive failed attempts or enabled: false; failed when a delivery exhausts 72 h without success. Re-enable with PATCH enabled: true.

    One of: "active", "paused", "failed"

  • pauseReason string | nullread-only

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 412 `If-Match` does not match the current ETag (resource changed). application/problem+json

  Body Problem; see the error catalogue.

• 422 Semantically invalid request; `errors[]` lists field-level problems. Also `idempotency-key-reused` when the key was used with a different payload, `limit-exceeded`, `recipient-not-approved`. application/problem+json

  Body Problem; see the error catalogue.

• 428 `If-Match` header is required for this operation. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X PATCH "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "If-Match: \"<etag>\"" \
  -H "Content-Type: application/json" \
  --data '{
  "url": "https://example.com",
  "events": [
    "webhook.test"
  ]
}'

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}", {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
    "If-Match": "\"<etag>\"",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com",
    "events": [
      "webhook.test"
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "PATCH",
    "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "If-Match": "\"<etag>\"",
        "Content-Type": "application/json",
    },
    json={
      "url": "https://example.com",
      "events": [
        "webhook.test"
      ]
    },
    timeout=30,
)
response.raise_for_status()

Delete webhook endpoint

DELETE /v1/integrator-webhooks/{webhookId}

• deleteIntegratorWebhook
• API key scope webhooks:manage
• Tenant any

Parameters

Responses

• 204 No Content
• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X DELETE "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}", {
  method: "DELETE",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);

import os

import requests

response = requests.request(
    "DELETE",
    "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Delivery attempts

GET /v1/integrator-webhooks/{webhookId}/deliveries

• listWebhookDeliveries
• API key scope webhooks:manage
• Tenant any

Parameters

Responses

• 200 OK application/json

  Schema WebhookDeliveryPage

  Cursor-paginated list of WebhookDelivery.

  • data array of WebhookDeliveryrequired

  • page PageInforequired

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X GET "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/deliveries" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/deliveries", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "GET",
    "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/deliveries",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Redeliver an event

POST /v1/integrator-webhooks/{webhookId}/deliveries/{deliveryId}/redeliver

• redeliverWebhook
• API key scope webhooks:manage
• Tenant any

Parameters

Responses

• 202 Accepted application/json

  Schema WebhookDelivery

  • id Uuidrequiredread-only

    Fields of id

    Uuid

  • eventId Uuidrequired

  • eventType IntegratorEventTyperequired

  • attempt integerrequired

    min 1

  • statusCode integer | null

  • durationMs integer | null

  • succeeded booleanrequired

  • nextRetryAt Timestamp | null

  • createdAt Timestamprequiredread-only

    Fields of createdAt

    Timestamp

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X POST "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/deliveries/{deliveryId}/redeliver" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/deliveries/{deliveryId}/redeliver", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/deliveries/{deliveryId}/redeliver",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Rotate signing secret (old valid 24 h)

POST /v1/integrator-webhooks/{webhookId}/rotate-secret

• rotateIntegratorWebhookSecret
• API key scope webhooks:manage
• Tenant any

Parameters

Responses

• 200 OK application/json

  Schema IntegratorWebhookCreated

  • id Uuidrequiredread-only

    Fields of id

    Uuid

  • url string (uri)required

  • events array of IntegratorEventTyperequired

  • description string | null

    max length 200

  • enabled booleanrequired

  • secretPrefix stringrequiredread-only

  • createdAt Timestamprequiredread-only

    Fields of createdAt

    Timestamp

  • updatedAt Timestamprequiredread-only

    Row version: the ETag is W/"<updatedAt epoch ms>" (If-Match on PATCH).

    Fields of updatedAt

    Timestamp

  • lastDeliveryAt Timestamp | null

  • failureCount integerrequiredread-only

    min 0

  • status stringread-only

    paused after 20 consecutive failed attempts or enabled: false; failed when a delivery exhausts 72 h without success. Re-enable with PATCH enabled: true.

    One of: "active", "paused", "failed"

  • pauseReason string | nullread-only

  • secret stringrequired

    Signing secret whsec_..., shown once.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X POST "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/rotate-secret" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/rotate-secret", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/rotate-secret",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Send a test event

POST /v1/integrator-webhooks/{webhookId}/test

• testIntegratorWebhook
• API key scope webhooks:manage
• Tenant any

Parameters

Responses

• 200 OK application/json

  Schema WebhookDelivery

  • id Uuidrequiredread-only

    Fields of id

    Uuid

  • eventId Uuidrequired

  • eventType IntegratorEventTyperequired

  • attempt integerrequired

    min 1

  • statusCode integer | null

  • durationMs integer | null

  • succeeded booleanrequired

  • nextRetryAt Timestamp | null

  • createdAt Timestamprequiredread-only

    Fields of createdAt

    Timestamp

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X POST "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/test" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/test", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://bank.wirebloom.com/v1/integrator-webhooks/{webhookId}/test",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Simulate an incoming payment

POST /v1/sandbox/incoming-payments

• simulateSandboxIncomingPayment
• API key scope payments:write
• Tenant customer

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SandboxSimulation

  • simulationId Uuidrequired

  • status stringrequired

    One of: "queued"

  • endpoints integer

    min 0

  • objectId Uuid

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 422 Semantically invalid request; `errors[]` lists field-level problems. Also `idempotency-key-reused` when the key was used with a different payload, `limit-exceeded`, `recipient-not-approved`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X POST "https://bank.wirebloom.com/v1/sandbox/incoming-payments" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "balanceId": "0192a6f0-7c1e-7b3a-9d2e-5f4c3b2a1908",
  "amount": {
    "amountMinor": "125050",
    "currency": "GBP"
  }
}'

const response = await fetch("https://bank.wirebloom.com/v1/sandbox/incoming-payments", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "balanceId": "0192a6f0-7c1e-7b3a-9d2e-5f4c3b2a1908",
    "amount": {
      "amountMinor": "125050",
      "currency": "GBP"
    }
  }),
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://bank.wirebloom.com/v1/sandbox/incoming-payments",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "balanceId": "0192a6f0-7c1e-7b3a-9d2e-5f4c3b2a1908",
      "amount": {
        "amountMinor": "125050",
        "currency": "GBP"
      }
    },
    timeout=30,
)
response.raise_for_status()

Simulate a provider status for a payment

POST /v1/sandbox/payments/{paymentId}/status

• simulateSandboxPaymentStatus
• API key scope payments:write
• Tenant customer

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SandboxSimulation

  • simulationId Uuidrequired

  • status stringrequired

    One of: "queued"

  • endpoints integer

    min 0

  • objectId Uuid

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 404 Resource does not exist in this tenant (cross-tenant ids also return 404), or feature disabled (`feature-disabled`). application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 422 Semantically invalid request; `errors[]` lists field-level problems. Also `idempotency-key-reused` when the key was used with a different payload, `limit-exceeded`, `recipient-not-approved`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X POST "https://bank.wirebloom.com/v1/sandbox/payments/{paymentId}/status" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "status": "processing"
}'

const response = await fetch("https://bank.wirebloom.com/v1/sandbox/payments/{paymentId}/status", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": "processing"
  }),
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://bank.wirebloom.com/v1/sandbox/payments/{paymentId}/status",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "status": "processing"
    },
    timeout=30,
)
response.raise_for_status()

Reset sandbox deliveries and paused endpoints

POST /v1/sandbox/reset

• resetSandbox
• API key scope webhooks:manage
• Tenant customer

Parameters

Responses

• 200 OK application/json

  Schema SandboxReset

  • deliveriesDeleted integerrequired

    min 0

  • endpointsReactivated integerrequired

    min 0

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X POST "https://bank.wirebloom.com/v1/sandbox/reset" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/sandbox/reset", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://bank.wirebloom.com/v1/sandbox/reset",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Emit an integrator event

POST /v1/sandbox/webhook-events

• simulateSandboxWebhookEvent
• API key scope webhooks:manage
• Tenant customer

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SandboxSimulation

  • simulationId Uuidrequired

  • status stringrequired

    One of: "queued"

  • endpoints integer

    min 0

  • objectId Uuid

• 400 Malformed request: unparseable JSON, or an invalid header, path or query parameter (`errors[].field` is `header.X`, `path.x` or `query.x`). Body validation failures are 422 `validation-error`. application/problem+json

  Body Problem; see the error catalogue.

• 401 Missing, expired or invalid credentials (`unauthenticated`, `session-expired` with `reason` `idle` / `revoked` / `expired`, `invalid-api-key`, `mfa-required`). application/problem+json

  Body Problem; see the error catalogue.

• 403 Authenticated but not allowed: missing capability or scope, tenant not in memberships, `step-up-required`, IP not allow-listed, impersonation restriction. application/problem+json

  Body Problem; see the error catalogue.

• 409 State conflict: `invalid-transition`, `duplicate-recipient`, `quote-expired`, `insufficient-funds`, `idempotency-key-in-use` (with Retry-After), `not-cancellable`. application/problem+json

  Body Problem; see the error catalogue.

• 422 Semantically invalid request; `errors[]` lists field-level problems. Also `idempotency-key-reused` when the key was used with a different payload, `limit-exceeded`, `recipient-not-approved`. application/problem+json

  Body Problem; see the error catalogue.

• 429 Rate limit exceeded. application/problem+json

  Body Problem; see the error catalogue.

• default Unexpected error (`500 internal-error`, `501 not-implemented`, `502 provider-error`, `503 service-unavailable`, `504 provider-timeout`). Money operations that time out at the provider are never retried blindly; their state becomes `exception`/unknown and is reconciled. application/problem+json

  Body Problem; see the error catalogue.

Code samples

Against the sandbox (https://bank.wirebloom.com/v1).

curl -X POST "https://bank.wirebloom.com/v1/sandbox/webhook-events" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "type": "webhook.test"
}'

const response = await fetch("https://bank.wirebloom.com/v1/sandbox/webhook-events", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.WIREBLOOM_API_KEY}`,
    "X-Tenant-Id": process.env.WIREBLOOM_CUSTOMER_ID!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "webhook.test"
  }),
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const result = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://bank.wirebloom.com/v1/sandbox/webhook-events",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "type": "webhook.test"
    },
    timeout=30,
)
response.raise_for_status()