Shopify payments webhook events

Shopify sends 6 payments events, including disputes/create, disputes/update and payment_schedules/due.

Every event here can also reach agents as an MCP event through Hookdeck: MCP events →

disputes/create

documented from Shopify docs (example)

New Shopify Payments dispute created

Identified by x-shopify-topic header Resource payments

shopify-disputes-create.json
{
  "id": 285332461850802050,
  "order_id": 820982911946154500,
  "type": "chargeback",
  "amount": "11.50",
  "currency": "CAD",
  "reason": "fraudulent",
  "network_reason_code": "4837",
  "status": "under_review",
  "evidence_due_by": "2021-12-30T19:00:00-05:00",
  "evidence_sent_on": null,
  "finalized_on": null,
  "initiated_at": "2021-12-31T19:00:00-05:00"
}

Key fields

Field Type Example
id integer 285332461850802050
status string under_review
type string chargeback
amount string 11.50 Watch out Numeric string.
initiated_at string 2021-12-31T19:00:00-05:00

Full schema: 12 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

disputes/update

documented from Shopify docs (example)

Shopify Payments dispute changes

Identified by x-shopify-topic header Resource payments

shopify-disputes-update.json
{
  "id": 285332461850802050,
  "order_id": 820982911946154500,
  "type": "chargeback",
  "amount": "11.50",
  "currency": "CAD",
  "reason": "fraudulent",
  "network_reason_code": "4837",
  "status": "under_review",
  "evidence_due_by": "2021-12-30T19:00:00-05:00",
  "evidence_sent_on": null,
  "finalized_on": null,
  "initiated_at": "2021-12-31T19:00:00-05:00"
}

Key fields

Field Type Example
id integer 285332461850802050
status string under_review
type string chargeback
amount string 11.50 Watch out Numeric string.
initiated_at string 2021-12-31T19:00:00-05:00

Full schema: 12 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

payment_schedules/due

documented from Shopify docs (example)

Payment schedules fall due

Identified by x-shopify-topic header Resource payments

shopify-payment-schedules-due.json
{
  "id": 606405506930370000,
  "payment_terms_id": 706405506930370000,
  "amount": "10.00",
  "currency": "USD",
  "issued_at": "2021-01-01T00:00:00-05:00",
  "due_at": "2021-01-02T00:00:00-05:00",
  "completed_at": "2021-01-02T00:00:00-05:00",
  "created_at": "2021-01-01T00:00:00-05:00",
  "updated_at": "2021-01-01T00:00:01-05:00",
  "admin_graphql_api_id": "gid://shopify/PaymentSchedule/606405506930370084"
}

Key fields

Field Type Example
id integer 606405506930370000
amount string 10.00 Watch out Numeric string.
issued_at string 2021-01-01T00:00:00-05:00

Full schema: 14 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

payment_terms/create

documented from Shopify docs (example)

New payment terms created

Identified by x-shopify-topic header Resource payments

shopify-payment-terms-create.json
{
  "id": 706405506930370000,
  "payment_terms_name": "Net 7",
  "payment_terms_type": "net",
  "due_in_days": 7,
  "created_at": "2021-01-01T00:00:00-05:00",
  "updated_at": "2021-01-01T00:00:01-05:00",
  "payment_schedules": [ … ],
  "admin_graphql_api_id": "gid://shopify/PaymentsPaymentFlexibilityPaymentTermsPaymentTerms/706405506930370084"
}

Key fields

Field Type Example
id integer 706405506930370000
created_at string 2021-01-01T00:00:00-05:00

Full schema: 23 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

payment_terms/delete

documented from Shopify docs (example)

Existing payment terms deleted

Identified by x-shopify-topic header Resource payments

shopify-payment-terms-delete.json
{
  "id": 706405506930370000
}

Key fields

Field Type Example
id integer 706405506930370000

Full schema: 1 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

payment_terms/update

documented from Shopify docs (example)

Payment terms change

Identified by x-shopify-topic header Resource payments

shopify-payment-terms-update.json
{
  "id": 706405506930370000,
  "payment_terms_name": "Net 7",
  "payment_terms_type": "net",
  "due_in_days": 7,
  "created_at": "2021-01-01T00:00:00-05:00",
  "updated_at": "2021-01-01T00:00:01-05:00",
  "payment_schedules": [ … ],
  "admin_graphql_api_id": "gid://shopify/PaymentsPaymentFlexibilityPaymentTermsPaymentTerms/706405506930370084"
}

Key fields

Field Type Example
id integer 706405506930370000
created_at string 2021-01-01T00:00:00-05:00

Full schema: 23 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

Route Shopify events by type.

Event Gateway receives every Shopify delivery and filters and routes it by event type, so each service gets only the events it handles.

Not affiliated with Shopify. Facts are compiled from public sources and linked inline.