Events are generated every time something happens behind the scenes in Pinch. These will form the basis for our webhooks, though for now you need to poll for them.

Event type payloads:

bank-results

{
    "dishonours": [
      {
        "typeEnum": 1,
        "type": "insufficient-funds",
        "date": "2017-05-09T00:00:00",
        "fees": 500,
        "transferId": null,
        "payment": {
          "id": "pmt_XXXXXXXXXXXXXX",
          "amount": 1255,
          "transactionDate": "2017-05-08T00:00:00",
          "description": "A new set of wheels 4",
          "status": "dishonoured",
          "payer": {
            "id": "pyr_XXXXXXXXXXXXXX",
            "firstName": "Ben",
            "lastName": "Auto 1",
            "emailAddress": "[email protected]",
            "mobileNumber": "0400000123"
          }
        }
      }
    ]
  }
  • scheduled-process
  • transfer
  • realtime-payment
  • payment-created
  • subscription-complete
  • payer-created
  • payer-updated
  • refund-created
  • refund-updated
  • compliance-updated
  • dispute-created
  • dispute-updated
  • merchant-created
  • merchant-updated
  • merchant-compliance-updated
  • subscription-created
  • subscription-cancelled
  • reportonly-payment

Check the examples on the right for examples for the different types of events.

Language
Authorization
OAuth2
Authenticate
Click Try It! to start a request and see the response here!