simulations

Available simulations and sandbox rules

GET /v1/simulations

• listSimulations
• API key scope balances:read
• Tenant customer

Parameters

Responses

• 200 OK application/json

  Schema SimulationCatalogue

  • environment stringrequired

    One of: "sandbox"

  • connection object | nullrequired

    Fields of connection

    • id Uuidrequired

    • provider stringrequired

    • environment stringrequired

  • data array of objectrequired

    Fields of data

    • kind SimulationKindrequired

    • method stringrequired

      One of: "POST"

    • path stringrequired

    • summary stringrequired

    • providers array of SimulationProviderrequired

    • available booleanrequired

      Available for the caller's connection.

    • rules array of stringrequired

  • rules array of objectrequired

    Deterministic sandbox rules that need no endpoint.

    Fields of rules

    • topic stringrequired

    • rule stringrequired

• 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/simulations" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/simulations", {
  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/simulations",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Simulate a card transaction event

POST /v1/simulations/cards/{cardId}/transactions

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/cards/{cardId}/transactions" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "phase": "authorisation",
  "amount": {
    "amountMinor": "125050",
    "currency": "GBP"
  }
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/cards/{cardId}/transactions", {
  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({
    "phase": "authorisation",
    "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/simulations/cards/{cardId}/transactions",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "phase": "authorisation",
      "amount": {
        "amountMinor": "125050",
        "currency": "GBP"
      }
    },
    timeout=30,
)
response.raise_for_status()

Simulate a direct-debit collection outcome

POST /v1/simulations/direct-debits/collections/{collectionId}/status

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/direct-debits/collections/{collectionId}/status" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "status": "collected"
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/direct-debits/collections/{collectionId}/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": "collected"
  }),
});
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/simulations/direct-debits/collections/{collectionId}/status",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "status": "collected"
    },
    timeout=30,
)
response.raise_for_status()

Simulate the settlement of an exchange

POST /v1/simulations/exchanges/{exchangeId}/status

• simulateExchangeStatus
• API key scope exchanges:write
• Tenant customer

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/exchanges/{exchangeId}/status" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "status": "completed"
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/exchanges/{exchangeId}/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": "completed"
  }),
});
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/simulations/exchanges/{exchangeId}/status",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "status": "completed"
    },
    timeout=30,
)
response.raise_for_status()

Move a sandbox FX rate

POST /v1/simulations/fx-rates

• simulateFxRateMove
• API key scope exchanges:write
• Tenant customer

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/fx-rates" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "sell": "GBP",
  "buy": "GBP",
  "moveBps": -5000
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/fx-rates", {
  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({
    "sell": "GBP",
    "buy": "GBP",
    "moveBps": -5000
  }),
});
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/simulations/fx-rates",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "sell": "GBP",
      "buy": "GBP",
      "moveBps": -5000
    },
    timeout=30,
)
response.raise_for_status()

Simulate a direct debit taken from a balance

POST /v1/simulations/incoming-debits

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/incoming-debits" \
  -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/simulations/incoming-debits", {
  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/simulations/incoming-debits",
    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 an incoming payment

POST /v1/simulations/incoming-payments

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/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/simulations/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/simulations/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 an inbound recall request

POST /v1/simulations/incoming-payments/{incomingPaymentId}/recall

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/incoming-payments/{incomingPaymentId}/recall" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "reasonCode": "AC03"
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/incoming-payments/{incomingPaymentId}/recall", {
  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({
    "reasonCode": "AC03"
  }),
});
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/simulations/incoming-payments/{incomingPaymentId}/recall",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "reasonCode": "AC03"
    },
    timeout=30,
)
response.raise_for_status()

Simulate a KYC review outcome

POST /v1/simulations/kyc

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/kyc" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "personId": "0192a6f0-7c1e-7b3a-9d2e-5f4c3b2a1908",
  "outcome": "approved"
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/kyc", {
  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({
    "personId": "0192a6f0-7c1e-7b3a-9d2e-5f4c3b2a1908",
    "outcome": "approved"
  }),
});
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/simulations/kyc",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "personId": "0192a6f0-7c1e-7b3a-9d2e-5f4c3b2a1908",
      "outcome": "approved"
    },
    timeout=30,
)
response.raise_for_status()

Simulate the outcome of a payment recall

POST /v1/simulations/payments/{paymentId}/recall

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/payments/{paymentId}/recall" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "outcome": "accepted"
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/payments/{paymentId}/recall", {
  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({
    "outcome": "accepted"
  }),
});
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/simulations/payments/{paymentId}/recall",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "outcome": "accepted"
    },
    timeout=30,
)
response.raise_for_status()

Simulate the return of a payment

POST /v1/simulations/payments/{paymentId}/return

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/payments/{paymentId}/return" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/payments/{paymentId}/return", {
  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({}),
});
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/simulations/payments/{paymentId}/return",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={},
    timeout=30,
)
response.raise_for_status()

Simulate the provider status of a payment

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

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/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/simulations/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/simulations/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()

Simulate a sandbox bank outage

POST /v1/simulations/provider-outage

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/provider-outage" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "durationSeconds": 0
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/provider-outage", {
  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({
    "durationSeconds": 0
  }),
});
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/simulations/provider-outage",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
        "Content-Type": "application/json",
    },
    json={
      "durationSeconds": 0
    },
    timeout=30,
)
response.raise_for_status()

Run a scheduled payment now

POST /v1/simulations/scheduled-payments/{scheduledPaymentId}/run-now

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

Parameters

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/scheduled-payments/{scheduledPaymentId}/run-now" \
  -H "Authorization: Bearer $WIREBLOOM_API_KEY" \
  -H "X-Tenant-Id: $WIREBLOOM_CUSTOMER_ID"

const response = await fetch("https://bank.wirebloom.com/v1/simulations/scheduled-payments/{scheduledPaymentId}/run-now", {
  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/simulations/scheduled-payments/{scheduledPaymentId}/run-now",
    headers={
        "Authorization": f"Bearer {os.environ['WIREBLOOM_API_KEY']}",
        "X-Tenant-Id": os.environ["WIREBLOOM_CUSTOMER_ID"],
    },
    timeout=30,
)
response.raise_for_status()

Simulate a statement becoming available

POST /v1/simulations/statements

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/statements" \
  -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"
}'

const response = await fetch("https://bank.wirebloom.com/v1/simulations/statements", {
  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"
  }),
});
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/simulations/statements",
    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"
    },
    timeout=30,
)
response.raise_for_status()

Send an integrator event to your endpoints

POST /v1/simulations/webhook-events

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

Parameters

Request body

Required. application/json

Responses

• 202 Accepted application/json

  Schema SimulationResult

  • simulationId Uuidrequired

  • kind SimulationKindrequired

  • status stringrequired

    queued: a provider event was stored and handed to the workers; submitted: the partner sandbox accepted it and notifies by webhook; applied: done synchronously.

    One of: "queued", "submitted", "applied"

  • provider SimulationProviderrequired

  • providerEventIds array of Uuidrequired

    providers.events rows written (provider event log).

  • providerReference string | nullrequired

  • details objectrequired

    Per kind (amounts, refs, rates, case id, …).

    Fields of details

    object

• 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/simulations/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/simulations/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/simulations/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()