# Nickel API Documentation

## Docs

- [List bill payment methods](https://dev.nickel.com/api-reference/bill-payment-method/list-bill-payment-methods.md): Returns the merchant's payment methods on file for paying bills (ACH bank accounts and cards).
- [Cancel a bill payment](https://dev.nickel.com/api-reference/bill/cancel-a-bill-payment.md)
- [Create a bill](https://dev.nickel.com/api-reference/bill/create-a-bill.md)
- [Delete a bill](https://dev.nickel.com/api-reference/bill/delete-a-bill.md)
- [Get a bill by ID](https://dev.nickel.com/api-reference/bill/get-a-bill-by-id.md)
- [Get a bill payment by ID](https://dev.nickel.com/api-reference/bill/get-a-bill-payment-by-id.md)
- [List bills](https://dev.nickel.com/api-reference/bill/list-bills.md)
- [Pay bills](https://dev.nickel.com/api-reference/bill/pay-bills.md): Process payments for one or more bills in a single batch request.
- [Update a bill](https://dev.nickel.com/api-reference/bill/update-a-bill.md)
- [Make payments using charge authorizations](https://dev.nickel.com/api-reference/charge-authorization/make-payments-using-charge-authorizations.md): Process payments for one or more payment links across multiple charge authorizations in a single request.
- [Request charge authorization from a customer](https://dev.nickel.com/api-reference/charge-authorization/request-charge-authorization-from-a-customer.md)
- [Returns a charge authorization by id](https://dev.nickel.com/api-reference/charge-authorization/returns-a-charge-authorization-by-id.md)
- [Upload an ACH Debit Authorization PDF](https://dev.nickel.com/api-reference/charge-authorization/upload-an-ach-debit-authorization-pdf.md)
- [Create a customer](https://dev.nickel.com/api-reference/customer/create-a-customer.md)
- [Find a customer by id](https://dev.nickel.com/api-reference/customer/find-a-customer-by-id.md)
- [List customers](https://dev.nickel.com/api-reference/customer/list-customers.md): Returns a paginated list of customers in your organization. Supports optional case-insensitive substring filters on `name` and `email`. When both filters are provided, only customers matching both are returned. Results are scoped to the authenticated organization.
- [Update a customer](https://dev.nickel.com/api-reference/customer/update-a-customer.md)
- [Returns a disbursement by id](https://dev.nickel.com/api-reference/disbursement/returns-a-disbursement-by-id.md)
- [Upload a file](https://dev.nickel.com/api-reference/file/upload-a-file.md)
- [Attach a previously uploaded PDF to a payment link](https://dev.nickel.com/api-reference/payment-link/attach-a-previously-uploaded-pdf-to-a-payment-link.md): Attaches a file that was previously uploaded via the file upload endpoint to a payment link. Pass the file ID, not the file itself.
- [Create a new payment link](https://dev.nickel.com/api-reference/payment-link/create-a-new-payment-link.md)
- [Deletes a payment link](https://dev.nickel.com/api-reference/payment-link/deletes-a-payment-link.md)
- [Find a payment link by id](https://dev.nickel.com/api-reference/payment-link/find-a-payment-link-by-id.md)
- [Mark a payment link as paid](https://dev.nickel.com/api-reference/payment-link/mark-a-payment-link-as-paid.md): Marks a payment link as paid.
- [Send a payment link to recipients](https://dev.nickel.com/api-reference/payment-link/send-a-payment-link-to-recipients.md): Sends the payment link to the provided recipients via email and/or SMS. Can be called multiple times to resend; the backend automatically treats subsequent sends to the same recipient as reminders.
- [Update an existing payment link](https://dev.nickel.com/api-reference/payment-link/update-an-existing-payment-link.md)
- [Refund a payment](https://dev.nickel.com/api-reference/payment/refund-a-payment.md): Refunds a payment fully or partially. Credit card payments that have not yet settled can be voided. ACH payments can be refunded as a credit back to the payer.
- [Returns a payment by id](https://dev.nickel.com/api-reference/payment/returns-a-payment-by-id.md)
- [Payments](https://dev.nickel.com/api-reference/payments.md): Understand how payments work in Nickel
- [Delete a vendor payout method](https://dev.nickel.com/api-reference/vendor-payout-method/delete-a-vendor-payout-method.md)
- [Request delivery details from a vendor](https://dev.nickel.com/api-reference/vendor-payout-method/request-delivery-details-from-a-vendor.md)
- [Update vendor ACH payout method](https://dev.nickel.com/api-reference/vendor-payout-method/update-vendor-ach-payout-method.md)
- [Update vendor check payout method](https://dev.nickel.com/api-reference/vendor-payout-method/update-vendor-check-payout-method.md)
- [Update vendor wire payout method](https://dev.nickel.com/api-reference/vendor-payout-method/update-vendor-wire-payout-method.md)
- [Create a vendor](https://dev.nickel.com/api-reference/vendor/create-a-vendor.md)
- [Delete a vendor](https://dev.nickel.com/api-reference/vendor/delete-a-vendor.md)
- [Get a vendor by ID](https://dev.nickel.com/api-reference/vendor/get-a-vendor-by-id.md)
- [List vendors](https://dev.nickel.com/api-reference/vendor/list-vendors.md)
- [Update a vendor](https://dev.nickel.com/api-reference/vendor/update-a-vendor.md)
- [Create a webhook](https://dev.nickel.com/api-reference/webhook/create-a-webhook.md)
- [Get webhooks](https://dev.nickel.com/api-reference/webhook/get-webhooks.md)
- [Webhooks](https://dev.nickel.com/api-reference/webhooks.md): Receive notifications when events happen in your Nickel account
- [Introduction](https://dev.nickel.com/index.md): Learn the basics of the Nickel API

## OpenAPI Specs

- [nickel-api-docs](https://dev.nickel.com/nickel-api-docs.yaml)

## Optional

- [Nickel](https://nickel.com)