Payout address archived

{ "object": "event", "id": "evt_5EdynMEiYSyiWAH9GpcbHp", "type": "payout_addresses", "eventType": "payments.payout_address.archived", "createdAt": "2026-06-04T10:30:00.000Z", "data": { "object": "payoutAddress", "id": "pytadd_PbDQ126YUAbkNrNX6XbGL", "supportedCurrencies": [ "USD" ], "supportedRails": [ "SEPA" ], "status": "ACTIVE", "archivedAt": "2026-06-04T10:30:00.000Z", "createdAt": "2026-06-04T10:30:00.000Z", "updatedAt": "2026-06-04T10:30:00.000Z", "payoutAddressType": "BANK_ACCOUNT", "accountId": "acc_BMY3UenpGBn8ZQ8hio4BgE", "verifications": [ { "kind": "NAME_MATCH", "mode": "SEPA_VOP", "result": "MATCH", "createdAt": "2026-06-04T10:30:00.000Z", "verifiedAt": "2026-06-04T10:35:12.000Z", "expiresAt": "2026-12-04T10:35:12.000Z" } ], "previousStatus": "ACTIVE", "label": "Operating account", "metadata": { "invoiceId": "INV-2026-0412", "costCenter": "AP_INTL" } } }

Headers

X-OpenFX-Signature

string

required

t=<unix-timestamp>,v1=<hex-hmac>: a hex-encoded HMAC-SHA256 signature computed over {timestamp}.{raw_body} (the exact bytes sent, not a re-serialized copy) using your organization's signing secret for that environment. Reject if t is more than 300 seconds from now, then verify v1 with a constant-time compare. See Webhook authentication. Dedup on the delivered event's id, not on this header.

Example:

"t=1735689600,v1=5257a869e7bfbe00e0be2007c1b7be16bb2ba57ee233b0d0c4de5d83b3f5e01d"

Body

application/json

The client soft-archived the payout address via POST /v3/payments/payout-addresses/{payoutAddressId}/archive; data.archivedAt is now set.

The address is hidden from listPayoutAddresses by default and can no longer back payouts, but is retained in full for regulatory obligations and stays retrievable by id. Archival is orthogonal to readiness status, which keeps whatever value it had (see data.previousStatus).

object

string

required

The type of object represented, a fixed discriminator. Always "event" for this resource, and identical across every object of the type.

Allowed value: "event"

Example:

"event"

string

required

Event identifier, the client's dedup key for this delivery.

Pattern: ^evt_[1-9A-HJ-NP-Za-km-z]{21,22}$

Example:

"evt_5EdynMEiYSyiWAH9GpcbHp"

type

string

required

Resource noun this event is about, the plural of the resource segment in eventType. Route coarsely on this; switch on eventType for the specific transition.

Allowed value: "payout_addresses"

Example:

"payout_addresses"

eventType

string

required

Product-namespaced lowercase {product}.{resource}.{action} event type, the product segment mirroring the resource's URL, the one lowercase-enum exception on this platform (every other enum is SCREAMING_SNAKE).

Allowed value: "payments.payout_address.archived"

Example:

"payments.payout_address.archived"

createdAt

string<date-time>

required

Event timestamp.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$

Example:

"2026-06-04T10:30:00.000Z"

data

object

required

The PayoutAddress resource plus event-only context, embedded as data on every payments.payout_address.* webhook/event.

Where a verification act drove a status change, that act's result is in the payload. bankAccount and the acts' name strings are not delivered to webhook endpoints; read them from GET /v3/payments/payout-addresses/{payoutAddressId}.

Show child attributes

Response

200

Return any 2xx to acknowledge receipt of the event.

Core concepts

Endpoints

Webhooks

Payout address archived

Headers

Body

Response