Webhook event
refund.address_lapsed
The payer gave no address within 14 days.
- Type
refund.address_lapsed- The object it carries
- the
refundobject - Subscribe with
refund.address_lapsed,refund.*or*
Example payload
The body of the request your endpoint receives, shown here over several lines. On the wire it is compact JSON; check its signature over the bytes exactly as they arrive.
Example payload
{
"id": "evt_0x1p83h90qvdypfs7f9vp4fw",
"object": "event",
"livemode": true,
"created": "2026-10-26T09:40:00.000Z",
"type": "refund.address_lapsed",
"api_version": "2026-10-11",
"data": {
"object": {
"id": "rf_z20ve49yz5hve8f0xsdchj2v",
"object": "refund",
"livemode": true,
"created": "2026-10-12T10:00:00.000Z",
"updated": "2026-10-26T09:40:00.000Z",
"status": "draft",
"pending_reason": "address_lapsed",
"order": "ord_0zymngngvf12b8b2cra7tb8e",
"payment": "pay_2pe50hae6w2jk4sp1rcq5pae",
"amount": "5.00",
"currency": "USD",
"reason": "requested_by_customer",
"note": "One bag arrived damaged",
"rate_basis": "order_rate",
"deduct_network_fee": false,
"source": {
"wallet": "wal_bsfw07hymawmda7gg8jsyy3g",
"asset": "base:usdc",
"amount": "5.000000"
},
"destination": null,
"address_claim": {
"sent_to": "jane@example.com",
"sent_at": "2026-10-12T09:40:00.000Z",
"claimed_at": null,
"expires_at": "2026-10-26T09:40:00.000Z"
},
"approvable_at": null,
"delivery": null,
"network_fee": null,
"requested_by": {
"type": "api_key",
"id": "key_6e3gg2c6ea176xxdek2nar6v"
},
"approved_by": null,
"approval_url": null,
"approval_expires_at": null,
"transaction_hash": null,
"failure_code": null,
"cancellation_reason": null,
"approved_at": null,
"sent_at": null,
"confirmed_at": null,
"metadata": {}
},
"previous_attributes": {
"status": "awaiting_address",
"pending_reason": null
}
},
"request": {
"id": null,
"idempotency_key": null
},
"pending_webhooks": 1
}Fields of data.object
| Field | In this example |
|---|---|
id | "rf_ |
object | "refund" |
livemode | true |
created | "2026-10-12T10: |
updated | "2026-10-26T09: |
status | "draft" |
pending_reason | "address_lapsed" |
order | "ord_ |
payment | "pay_ |
amount | "5.00" |
currency | "USD" |
reason | "requested_by_customer" |
note | "One bag arrived damaged" |
rate_basis | "order_rate" |
deduct_network_fee | false |
source | An object with wallet, asset, amount |
destination | null |
address_claim | An object with sent_to, sent_at, claimed_at, expires_at |
approvable_at | null |
delivery | null |
network_fee | null |
requested_by | An object with type, id |
approved_by | null |
approval_url | null |
approval_expires_at | null |
transaction_hash | null |
failure_code | null |
cancellation_reason | null |
approved_at | null |
sent_at | null |
confirmed_at | null |
metadata | An object with no fields |
What each field means is on the page of the refund object. data.previous_attributes holds the old values of exactly the fields that changed: here status, pending_reason.
Endpoints behind it
Calls that change refunds. An event is also sent when a payer, the network, a timer or a person in the dashboard causes the change; the sentence above says which.