Events are generated every time something happens behind the scenes in Pinch these allow API integrators hooks into the system when these events are triggered.

Consuming Events

To consume these events there are multiple options:

Webhooks - Webhooks can be created either through the Webhooks API or via the Pinch Developer Portal
Events API - There are 2 API endpoints for events that can be used to poll for events as required, List All Events Endpoint and Get Event Endpoint.
Zapier - Our Zapier integration exposes triggers for these events that can be used to trigger Zaps

Event types

This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

`bank-results`

Occurs whenever a bank account transaction return (as these take time to process) and could result in a dishonour status. If you are taking bank account transactions you will need to listen for this event otherwise you may miss failed payments.

event.payments is a list of BankResultPayment

`scheduled-process`

Occurs whenever scheduled Payments are processed (daily on business days).

event.payments is a list of PaymentWithPayer

`transfer`

Occurs whenever a transfer is created to settle funds to a Merchant.

event.transfer is a Transfer object

`realtime-payment`

Occurs whenever a realtime payment is executed.

event.payment is a Payment object

`payment-created`

Occurs wheneverr a Payment is created in Pinch. This could be done through the Save Payment endpoint or when a Subscription creates its payments.

event.payment is a Payment object

`payer-created`

Occurs whenever a new Payer record is created.

event.payer is a Payer object

`payer-updated`

Occurs whenever a Payer record is updated.

event.payer is a Payer object

`refund-created`

Occurs whenever a Refund is created.

event.refund is a Refund object

`refund-updated`

Occurs whenever a Refund is updated (such as when the refund status gets updated through its processing).

event.refund is a Refund object

`compliance-updated`

Occurs whenever a Merchant record is updated that will result in a compliance check (such as updating a Merchant's bank account or when a Merchant uploads a document for verification).

event.complianceSubmission is a Compliance object

`dispute-created`

Occurs whenever a Dispute is created.

event.dispute is a Dispute object

`dispute-updated`

Occurs whenever a Dispute is updated.

event.dispute is a Dispute object

`merchant-updated`

Occurs whenever a Merchant record is updated.

event.merchant is a Merchant object

`merchant-compliance-updated`

Occurs whenever a Merchant's compliance information is updated by a compliance officer, typically this happens when a Merchants verification status changes.

event.compliance is a MerchantCompliance object

`subscription-created`

Occurs whenever a Subscription is created for a Payer

event.subscription is a Subscription object

`subscription-cancelled`

Occurs whenever a Subscription is cancelled.

event.subscription is a Subscription object

`subscription-complete`

Occurs whenever a Subscription is run to completion.

event.subscription is a Subscription object