Payment updated
EVENT
payment.updated
Published when a Payment is updated.
Typically the payment.status, or card_details.status fields are updated
as a payment is canceled, authorized, or completed.
Permissions
PAYMENTS_READ
| Name | Description |
|---|---|
merchant_
|
The ID of the target merchant associated with the event. |
type
|
The type of event this represents, |
event_
|
A unique ID for the webhook event. |
created_
|
Read only Timestamp of when the webhook event was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
data
|
Data associated with the event. |
Examples
Example payload
{
"merchant_id": "6SSW7HV8K2ST5",
"type": "payment.updated",
"event_id": "6a8f5f28-54a1-4eb0-a98a-3111513fd4fc",
"created_at": "2020-02-06T21:27:34.308Z",
"data": {
"type": "payment",
"id": "KkAkhdMsgzn59SM8A89WgKwekxLZY",
"object": {
"payment": {
"id": "hYy9pRFVxpDsO1FB05SunFWUe9JZY",
"created_at": "2020-11-22T21:16:51.086Z",
"updated_at": "2020-11-22T21:19:00.831Z",
"amount_money": {
"amount": 100,
"currency": "USD"
},
"status": "COMPLETED",
"delay_duration": "PT168H",
"source_type": "CARD",
"card_details": {
"status": "CAPTURED",
"card": {
"card_brand": "MASTERCARD",
"last_4": "9029",
"exp_month": 11,
"exp_year": 2022,
"fingerprint": "sq-1-Tvruf3vPQxlvI6n0IcKYfBukrcv6IqWr8UyBdViWXU2yzGn5VMJvrsHMKpINMhPmVg",
"card_type": "CREDIT",
"prepaid_type": "NOT_PREPAID",
"bin": "540988"
},
"entry_method": "KEYED",
"cvv_status": "CVV_ACCEPTED",
"avs_status": "AVS_ACCEPTED",
"statement_description": "SQ *DEFAULT TEST ACCOUNT",
"card_payment_timeline": {
"authorized_at": "2020-11-22T21:16:51.198Z",
"captured_at": "2020-11-22T21:19:00.832Z"
}
},
"location_id": "S8GWD5R9QB376",
"order_id": "03O3USaPaAaFnI6kkwB1JxGgBsUZY",
"risk_evaluation": {
"created_at": "2020-11-22T21:16:51.198Z",
"risk_level": "NORMAL"
},
"total_money": {
"amount": 100,
"currency": "USD"
},
"approved_money": {
"amount": 100,
"currency": "USD"
},
"receipt_number": "hYy9",
"receipt_url": "https://squareup.com/receipt/preview/hYy9pRFVxpDsO1FB05SunFWU11111",
"delay_action": "CANCEL",
"delayed_until": "2020-11-29T21:16:51.086Z",
"version_token": "bhC3b8qKJvNDdxqKzXaeDsAjS1oMFuAKxGgT32HbE6S6o"
}
}
}
}