{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "type": "affiliation-bank-account.operational-status-changed",
  "version": 1,
  "timestamp": "2025-01-15T10:30:00.000Z",
  "source": "transaction-service",
  "company_id": "comp_123456789",
  "correlation_id": "corr_987654321"
}

Events

Affiliation bank account operational status changed

Triggered when the operational status of an affiliation bank account changes, for example when a court order places the account under a judicial block (JUDICIAL_BLOCK) or when the block is lifted (REGULAR).

While an account is under JUDICIAL_BLOCK, its balance is restricted by the banking provider. The payload carries the full bank account object as it stood when the event was emitted, so no follow-up request is needed.

WEBHOOK

affiliation-bank-account.operational-status-changed

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "type": "affiliation-bank-account.operational-status-changed",
  "version": 1,
  "timestamp": "2025-01-15T10:30:00.000Z",
  "source": "transaction-service",
  "company_id": "comp_123456789",
  "correlation_id": "corr_987654321"
}

Body

application/json

Base structure for all webhook events

string<uuid>

required

Unique event identifier

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

type

enum<string>

required

Event type identifier

Available options:

affiliation-bank-account.operational-status-changed

Example:

"affiliation-bank-account.operational-status-changed"

version

integer

required

Event schema version

Example:

1

timestamp

string<date-time>

required

Event timestamp in ISO 8601 format

Example:

"2025-01-15T10:30:00.000Z"

source

string

required

Service that generated the event

Example:

"transaction-service"

company_id

string

required

Company ID associated with the event

Example:

"comp_123456789"

correlation_id

string

required

Correlation ID for event tracking

Example:

"corr_987654321"

payload

object

Affiliation bank account operational status change details

Show child attributes

Response

Webhook received successfully

⌘I

Introduction

Merchants

Pricing

Webhooks

Organization Management

User Management

System

Affiliation bank account operational status changed

Body

Response