Skip to content
Developer portal

refund.updated

POST

A refund changed: it is on its way.

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
id
required

Deduplicate on this; the same event may arrive more than once.

string
object
required
string
Allowed value: event
type
required
string
created
required

A Unix timestamp.

integer
api_version
required
string
Allowed value: v1
livemode
required
boolean
tenant_id
string
merchant_id
string | null
data
required
object
object

The object as the API shows it, as of this event.

object
data
required
object
object
object
id
string
object
string
Allowed value: refund
payment_intent
string
amount
integer
currency

A three-letter ISO 4217 code, in lower case.

string
/^[a-z]{3}$/
status

created for the moment it is made, processing while it is on its way, then succeeded or failed. awaiting_approval while the platform’s risk team looks at it before it is sent: it then goes on, or fails as risk_declined. Nothing is refunded while it waits, and the amount stays held against what the payment has left to refund.

string
Allowed values: created processing awaiting_approval succeeded failed
reason
string | null
Allowed values: requested_by_customer duplicate fraudulent
failure_reason

Why it failed, when it did.

string | null
Allowed values: declined refund_not_possible refund_not_yet_available refunds_not_enabled restricted risk_declined unknown
metadata

Your own key-value pairs, returned as given and carried in webhooks: up to 50 keys of up to 40 characters without square brackets, each with a text value of up to 500 characters.

object
<= 50 properties
key
additional properties
string
<= 500 characters
livemode
boolean
created

A Unix timestamp.

integer

Responses

Section titled “Responses”

200

Section titled “200”

Received. Answer with any 2xx within 10 seconds.