Before you start: You need a paid invoice to follow — see Send an Invoice and Get Paid — and a webhook subscription if you want to be notified instead of polling.
Check when a payment will pay out
Every payment carries its own payout expectations. Fetch it with
GET /payment/{paymentId} and look at two fields:estimatedDisbursementDate is when Nickel expects to send the money to your bank. disbursement stays null until the payment is actually included in a transfer — then it carries the disbursement’s id and status, which is your key for everything below.Listen for disbursement events
Two webhook events track each transfer:
The event payload contains the disbursement’s ID in
| Event | Meaning |
|---|---|
disbursement.pending | The disbursement was created and is on its way to your bank account on file. |
disbursement.succeeded | The receiving bank has the funds. Depending on your bank’s turnaround, it may take a little longer to appear in your account. |
associated_object_id — fetch the details next.Fetch the disbursement
Get the full picture with
GET /disbursement/{disbursementId}. The response shape (illustrative values):amountInCents is the total landing in your account — the deposit line on your bank statement. paymentIds lists every payment bundled into this transfer, and paidAt fills in once the money has been received.Reconcile against your books
To itemize a deposit, walk Each payment gives you the invoice it settles (
paymentIds and fetch each payment:paymentLinkId), the invoice amount (amountInCents), and the fees involved (fees, platformFeeInCents) — everything you need to match the single bank deposit back to individual invoices in your accounting system.Things that trip people up
disbursement.succeededdoesn’t mean “visible in your account”. It means the receiving bank has the funds; your bank’s posting time adds a delay on top.- One deposit, many invoices. Never assume a bank deposit maps to one payment — always itemize through
paymentIds. - ACH returns can claw money back after payout. If an ACH payment is returned up to 60 days later (the payment moves to
FAILED), and it was already paid out, Nickel debits the return amount back. See How Payments Work.
Where to go next
Webhook events
Subscribe to disbursement.pending and disbursement.succeeded.
Refund or void a payment
What giving money back does to your payouts.
