Skip to main content
WEBHOOK
cashout.created
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "type": "cashout.created",
  "version": 1,
  "timestamp": "2025-01-15T10:30:00.000Z",
  "source": "transaction-service",
  "company_id": "comp_123456789",
  "correlation_id": "corr_987654321",
  "payload": {
    "cashout_id": "cashout_123456789",
    "request_id": "req_123456789",
    "external_request_id": "ext_req_123456789",
    "origin_bank_account_id": "bank_acc_123456789",
    "destination_bank_account_id": "bank_acc_987654321",
    "amount": 100000,
    "status": "PENDING",
    "currency": "BRL"
  }
}

Body

application/json

Base structure for all webhook events

​
id
string<uuid>
required

Unique event identifier

Example:

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

​
type
enum<string>
required

Event type identifier

Available options:
cashout.created
Example:

"cashout.created"

​
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

CashOut creation details

Response

Webhook received successfully