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.

Transfer Event

This event is generated whenever a new Transfer is created.

[
    {
        "propertyName": "eventId",
        "errorMessage": "Could not find an event with ID: evt_XXXXXXXXXXXXXX",
        "attemptedValue": null,
        "customState": null,
        "severity": 0,
        "errorCode": null,
        "formattedMessageArguments": null,
        "formattedMessagePlaceholderValues": null,
        "resourceName": null
    }
]

Bank Results

This event is generated each time there are payments that have been dishonoured.

{
  "id": "evt_irr1g54lyxw8lg",
  "type": "bank-results",
  "eventDate": "2017-05-08T23:30:00.0989722",
  "metadata": {
    "dishonourCount": 1,
    "dishonourAmount": 1255
  },
  "data": {
    "dishonours": [
      {
        "typeEnum": 1,
        "type": "insufficient-funds",
        "date": "2017-05-09T00:00:00",
        "fees": 500,
        "transferId": null,
        "payment": {
          "id": "pmt_qVvjwIb15cHa8Z",
          "amount": 1255,
          "transactionDate": "2017-05-08T00:00:00",
          "description": "A new set of wheels 4",
          "status": "dishonoured",
          "payer": {
            "id": "pyr_dLCdmrOmXKwuWH",
            "firstName": "Ben",
            "lastName": "Auto 1",
            "emailAddress": "[email protected]",
            "mobileNumber": "0400000123"
          }
        }
      }
    ]
  }
}
Language
Authentication
OAuth2
Authenticate
Click Try It! to start a request and see the response here!