Event Types

external_payment.created

Occurs when an external payment is created.

postWebhookexternal_payment.created

Payload

event_type'external_payment.created' required

The type of event that occurred.

tokenstring uuid required

Unique identifier for the transaction

createdstring date-time required

ISO 8601 timestamp of when the transaction was created

updatedstring date-time required

ISO 8601 timestamp of when the transaction was last updated

status'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED' required
family'EXTERNAL_PAYMENT' required

EXTERNAL_PAYMENT - External Payment Response

result'APPROVED' | 'DECLINED' required
category'EXTERNAL_WIRE' | 'EXTERNAL_ACH' | 'EXTERNAL_CHECK' | 'EXTERNAL_FEDNOW' | 'EXTERNAL_RTP' | 'EXTERNAL_STABLECOIN' | 'EXTERNAL_TRANSFER' required
settled_amountinteger required
pending_amountinteger required
currencystring required
user_defined_idstring nullable
financial_account_tokenstring uuid required
payment_type'DEPOSIT' | 'WITHDRAWAL' required

Example payload

{
  "event_type": "external_payment.created"
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.