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.
Required permissions:
PAYMENTS_READ
Event payload
| Name | Description |
|---|---|
merchant_id
|
The ID of the target merchant associated with the event. |
type
|
The type of event this represents, |
event_id
|
A unique ID for the webhook event. |
created_at
|
Timestamp of when the webhook event was created, in RFC 3339 format. Examples for January 25th, 2020 6:27.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
You are viewing an old version of the API
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": "KkAkhdMsgzn59SM8A89WgKwekxLZY",
"created_at": "2020-02-06T21:27:30.444Z",
"updated_at": "2020-02-06T21:27:33.399Z",
"amount_money": {
"amount": 1000,
"currency": "USD"
},
"total_money": {
"amount": 1000,
"currency": "USD"
},
"status": "COMPLETED",
"source_type": "CARD",
"card_details": {
"auth_result_code": "YFB91d",
"avs_status": "AVS_ACCEPTED",
"card": {
"bin": "411111",
"card_brand": "VISA",
"card_type": "CREDIT",
"exp_month": 2,
"exp_year": 2022,
"fingerprint": "sq-1-pu54rLMT5m8qddqnsWaSBI9zJkDH_mMy8hC2qe6MUzdP4MCSHaHZtm_XNuiiso95gQ",
"last_4": "1111"
},
"cvv_status": "CVV_ACCEPTED",
"entry_method": "KEYED",
"statement_description": "SQ *MY BUSINESS",
"status": "CAPTURED"
},
"location_id": "NAQ1FHV6ZJ8YV",
"order_id": "j3WfFVLi7XdcrH3BxoV0L3EHqe4F",
"receipt_number": "KkAk",
"receipt_url": "https://squareup.com/receipt/preview/KkAkhdMsgzn59SM8A89WgKwekxLZY",
"reference_id": "123456",
"note": "Brief description",
"customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
"version": 4
}
}
}
}