Webhooks
Accounts, cards and payment ev...
Request and response codes
4 min
registration status the following table describes the status field returned in a webhook registration status description active everything is ok suspended something went wrong several attempts to send events to this registration failed no further attempts will be made until registration is restarted restarting we are attempting to restart this registration an event must be successfully transmitted before the status will transition back to active registration types the following table describes the type of webhook event you want to register for type description push events will be pushed to a partner endpoint a 200 ok response is expected in order for it to be considered successful (default) poll events will be consumed by partner polling the events api periodically and calling acknowledge api method for each event successfully processed file events will be sent to the partner via set up sftp in a csv file once per day event status the following table describes the status of the webhook event status description pending event has been created, but no attempt to send it has been made yet success event was successfully delivered to the registered url failed we could not deliver the event to the registered url see the event logs for more detail on the failure reason format the following table describes the amount of detail in the webhook event payload that you request format description basic webhook is delivered with an object containing resource identifiers related to that event extended with this format you get everything in a 'basic' event, in addition you will receive a 'details' object containing various meta data pertaining to each resource for example, on the ach return received event you would receive the return code and original payment id