Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.nickel.com/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks are the primary way that Nickel tells your application that something has happened. To receive webhooks, create a webhook subscription either through the webhooks section of your dashboard or programmatically via the POST /webhook endpoint. Once you specify a webhook URL, Nickel sends updates to the endpoint whenever something happens against your Nickel account.

​
Webhook Structure

The webhook currently has the following structure: 
{
  "id": "event_123abc",
  "created_at": "2020-01-31T23:59:59Z",
  "category": "disbursement.pending",
  "associated_object_type": "disbursement",
  "associated_object_id": "clrv6k8y80003wq02x36efjnv",
  "type": "event"
}

​
Categories

Nickel currently supports the following webhook notifications:

​
payment.made

This notification fires when a payment is made.

​
payment.failed

This notification fires when a payment has failed, such as when an ACH return occurs.

​
payment.refunded

This notification fires when a payment has been refunded.

​
payment.voided

This notification fires when a payment has been refunded, but it has not yet been sent to the ACH network or submitted for settlement to the card networks and thus was effectively canceled.

​
disbursement.pending

This notification fires whenever a disbursement is created and is set to be sent out to your bank account on file.

​
disbursement.succeeded

This notification fires whenever the receiving bank receives the funds. This may not necessarily be the same time as it appears in your bank account depending on your bank’s turnaround time.

​
charge_authorization.authorized

This notification fires whenever your customer authorizes a payment method to be charged by you.

​
charge_authorization.deleted

This notification fires whenever your customer or you delete an authorization to charge a payment method on file.

​
bill_payment.succeeded

This notification fires when a bill payment to a vendor has been completed successfully.

​
bill_payment.failed

This notification fires when a bill payment to a vendor has failed.

​
check.sent

This notification fires when a check has been mailed to the vendor.

​
check.delivered

This notification fires when a check has been delivered to the vendor.

​
check.deposited

This notification fires when a check has been deposited by the vendor.

​
check.returned

This notification fires when a check has been returned to sender.

​
check.failed

This notification fires when a check payment has failed.

​
vendor.payout_method_updated

This notification fires when a vendor’s payout method is created or updated, whether through the vendor onboarding link or by the merchant.

​
Consuming Events

Individual Events don’t contain very much information on their own. This is by design, as the API structure can remain extremely stable and avoid difficult webhook migrations in the future as the Nickel API changes. If you need additional metadata, such as the amount of the Disbursement in the above example, make a GET request to the API for that information. You can use the associated_object_type or category fields to determine what resource to fetch from the API.