{
"error": "The logged in user is not allowed to perform that action."
}
{
"error": "<string>",
"code": "<string>"
}
{
"error": "<string>",
"code": "<string>"
}
{
"error": "<string>",
"code": "<string>"
}
Bill
Pay bills
Process payments for up to 25 bills in a single batch request. A
request with more than 25 is refused with a 400 and pays nothing;
send a longer list in several requests.
The batch is partial-success: valid items go through and any per-bill
failures are returned in billErrors[] ({billId, error}). Bills that
are already paid, or that already have a pending scheduled payment, are
reported as per-bill entries in billErrors[] — they no longer fail
the whole request — and are excluded from the returned billPayments
array so pre-existing payments aren’t surfaced as if this batch created
them. A top-level error is only returned for request-wide problems
(for example, invalid input).
Successful operation. Bills are paid independently, so individual bills can still fail (for example, a bill that is already paid or has a pending scheduled payment) — check billErrors for per-bill failures.
Bill payments created by this batch — one entry per item that was
processed immediately. Bills reported in billErrors[] (including
already-paid bills or bills with a pending scheduled payment) are
excluded from this array, and items scheduled for a future
withdrawal date appear under scheduled instead, creating no bill
payment until that day.
Per-bill failures. Each entry identifies a single bill from the
request that could not be paid; other bills in the batch still
proceed. Includes bills rejected because they are already paid
or already have a pending scheduled payment.
Acknowledgment of items scheduled for a future withdrawal date, keyed by the billId submitted in the request.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nickel API Documentation","colors":{"primary":"#3A032D","light":"#9B3278","dark":"#3A032D"},"logo":{"light":"https://mintcdn.com/nickel/51OVWZCdyoI76-NG/logo500.png?fit=max\u0026auto=format\u0026n=51OVWZCdyoI76-NG\u0026q=85\u0026s=9b006540dadff0abbf62416fff590d9d","dark":"https://mintcdn.com/nickel/51OVWZCdyoI76-NG/logo500.png?fit=max\u0026auto=format\u0026n=51OVWZCdyoI76-NG\u0026q=85\u0026s=9b006540dadff0abbf62416fff590d9d"},"favicon":"https://mintcdn.com/nickel/51OVWZCdyoI76-NG/favicon.ico?fit=max\u0026auto=format\u0026n=51OVWZCdyoI76-NG\u0026q=85\u0026s=e1598f9d71a3f063f95232bd8c5b2759","api":{"playground":{"display":"interactive","proxy":true}},"navbar":{"links":[{"href":"mailto:support@nickel.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.nickel.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/nickelhq"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Nickel","icon":"house","href":"https://nickel.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nickel","hasAudioNarration":false,"actualSubdomain":"nickel","customDomains":["dev.nickel.com"],"gitSource":{"type":"github","owner":"nickeltechnology","repo":"nickel-os","deployBranch":"main","contentDirectory":"apps/rest/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adba31f6bc3edbe838b4793","collectionId":"091a123f-ccab-4f79-9897-3a18a61698e5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adba31f6bc3edbe838b4793"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"}},"buildId":"6adba31f6bc3edbe838b4793","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":106},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"Payment Link","count":11},{"language":"default","tag":"Bill","count":10},{"language":"default","tag":"Nickel Banking","count":7},{"language":"default","tag":"Core Concepts","count":5},{"language":"default","tag":"Getting Paid","count":5},{"language":"default","tag":"Vendor Delivery Method","count":5},{"language":"default","tag":"Vendor","count":5},{"language":"default","tag":"Getting Started","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/bill/pay-bills","slug":"/api-reference/bill/pay-bills","pageMetadata":{"title":"Pay bills","description":"Process payments for up to 25 bills in a single batch request. A\nrequest with more than 25 is refused with a 400 and pays nothing;\nsend a longer list in several requests.\n\nThe batch is partial-success: valid items go through and any per-bill\nfailures are returned in `billErrors[]` (`{billId, error}`). Bills that\nare already paid, or that already have a pending scheduled payment, are\nreported as per-bill entries in `billErrors[]` — they no longer fail\nthe whole request — and are excluded from the returned `billPayments`\narray so pre-existing payments aren't surfaced as if this batch created\nthem. A top-level error is only returned for request-wide problems\n(for example, invalid input).\n","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /bill/pay","href":"/api-reference/bill/pay-bills","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Process payments for up to 25 bills in a single batch request. A\\nrequest with more than 25 is refused with a 400 and pays nothing;\\nsend a longer list in several requests.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The batch is partial-success: valid items go through and any per-bill\\nfailures are returned in \", _jsx(_components.code, {\n children: \"billErrors[]\"\n }), \" (\", _jsx(_components.code, {\n children: \"{billId, error}\"\n }), \"). Bills that\\nare already paid, or that already have a pending scheduled payment, are\\nreported as per-bill entries in \", _jsx(_components.code, {\n children: \"billErrors[]\"\n }), \" — they no longer fail\\nthe whole request — and are excluded from the returned \", _jsx(_components.code, {\n children: \"billPayments\"\n }), \"\\narray so pre-existing payments aren’t surfaced as if this batch created\\nthem. A top-level error is only returned for request-wide problems\\n(for example, invalid input).\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Pay bills","description":"Process payments for up to 25 bills in a single batch request. A\nrequest with more than 25 is refused with a 400 and pays nothing;\nsend a longer list in several requests.\n\nThe batch is partial-success: valid items go through and any per-bill\nfailures are returned in `billErrors[]` (`{billId, error}`). Bills that\nare already paid, or that already have a pending scheduled payment, are\nreported as per-bill entries in `billErrors[]` — they no longer fail\nthe whole request — and are excluded from the returned `billPayments`\narray so pre-existing payments aren't surfaced as if this batch created\nthem. A top-level error is only returned for request-wide problems\n(for example, invalid input).\n","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /bill/pay","href":"/api-reference/bill/pay-bills","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Bill"],"summary":"Pay bills","description":"Process payments for up to 25 bills in a single batch request. A\nrequest with more than 25 is refused with a 400 and pays nothing;\nsend a longer list in several requests.\n\nThe batch is partial-success: valid items go through and any per-bill\nfailures are returned in `billErrors[]` (`{billId, error}`). Bills that\nare already paid, or that already have a pending scheduled payment, are\nreported as per-bill entries in `billErrors[]` — they no longer fail\nthe whole request — and are excluded from the returned `billPayments`\narray so pre-existing payments aren't surfaced as if this batch created\nthem. A top-level error is only returned for request-wide problems\n(for example, invalid input).\n","operationId":"payBill","requestBody":"18c5b644-f416-4bff-bbbf-066299b2b5b3","responses":{"200":"c3345cd9-caa3-4e6e-a7c1-6598ac0f5872","400":"7226d517-f348-4dce-b5a1-a2dda7d89823","403":"61dd0294-182d-4de4-9670-4f467fecd3ad","404":"2531eb62-d40d-4cf7-b9ba-0cc4d08cb14c","500":"4f96d563-de92-4f0e-840c-2f8e54c16b3f","default":"495db91b-b23a-4170-a845-c15561fd44b8"},"method":"post","type":"path","servers":["ad169b3a-7580-4cdf-b519-5cf232fed2c8","f29cb06d-c3de-48e4-bfe1-01480ccc908f"],"security":["a79970ac-053d-451a-a280-c2ff3e23ae04"],"path":"/bill/pay","baseUrlOptions":["https://rest.staging.nickel.com","https://rest.nickel.com"],"title":"Pay bills","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Batch bill payment request","content":{"application/json":{"schema":{"required":["payments"],"type":"object","properties":{"payments":{"type":"array","maxItems":25,"description":"Up to 25 bills per request. A request with more is refused with a 400 and nothing is paid; send a longer list in several requests.","items":{"required":["billId","merchantPaymentMethodId","notificationEmails","vendorId"],"type":"object","description":"One of vendorDeliveryMethodId or vendorPayoutMethodId (deprecated) is required.","properties":{"billId":{"type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].billId","typeLabel":"string"},"merchantPaymentMethodId":{"type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].merchantPaymentMethodId","typeLabel":"string"},"notificationEmails":{"type":"array","items":{"type":"string","uniqueKey":"payments.items.[INDEX].notificationEmails.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payments.items.[INDEX].notificationEmails","typeLabel":"string[]"},"vendorId":{"type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].vendorId","typeLabel":"string"},"vendorDeliveryMethodId":{"type":"string","description":"ID of the vendor delivery method to send the funds to. Required unless the deprecated vendorPayoutMethodId is provided instead.","uniqueKey":"payments.items.[INDEX].vendorDeliveryMethodId","typeLabel":"string"},"vendorPayoutMethodId":{"type":"string","deprecated":true,"description":"Deprecated alias of vendorDeliveryMethodId. Provide one or the other; if both are sent they must match.","uniqueKey":"payments.items.[INDEX].vendorPayoutMethodId","typeLabel":"string"},"withdrawalDateEpochMillis":{"type":"number","description":"Scheduled withdrawal date as epoch milliseconds. If omitted, the payment is processed immediately.","uniqueKey":"payments.items.[INDEX].withdrawalDateEpochMillis","typeLabel":"number"},"arrivalDateEpochMillis":{"type":"number","description":"Desired date the payment should arrive at the vendor, as epoch milliseconds. Ignored when `withdrawalDateEpochMillis` is set; otherwise the API back-computes the withdrawal date by subtracting the payment rail's estimated days-to-delivery. A Saturday or Sunday arrival date is scheduled to arrive the Friday before; once that Friday has passed, a weekend date the rail can still reach is paid immediately. Arrival dates too soon for the selected rail (which would require a withdrawal date in the past, or an ACH withdrawal after the daily cutoff) are rejected.\n","uniqueKey":"payments.items.[INDEX].arrivalDateEpochMillis","typeLabel":"number"},"vendorMemo":{"type":"string","uniqueKey":"payments.items.[INDEX].vendorMemo","typeLabel":"string"}},"uniqueKey":"payments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payments","typeLabel":"object[]"},"idempotencyKey":{"type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payments":[{"billId":"\u003cstring>","merchantPaymentMethodId":"\u003cstring>","notificationEmails":["\u003cstring>"],"vendorId":"\u003cstring>","vendorDeliveryMethodId":"\u003cstring>","vendorPayoutMethodId":"\u003cstring>","withdrawalDateEpochMillis":123,"arrivalDateEpochMillis":123,"vendorMemo":"\u003cstring>"}],"idempotencyKey":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"c3345cd9-caa3-4e6e-a7c1-6598ac0f5872":{"description":"Successful operation. Bills are paid independently, so individual bills can still fail (for example, a bill that is already paid or has a pending scheduled payment) — check billErrors for per-bill failures.","content":{"application/json":{"schema":{"type":"object","properties":{"billPayments":{"type":"array","description":"Bill payments created by this batch — one entry per item that was\nprocessed immediately. Bills reported in `billErrors[]` (including\nalready-paid bills or bills with a pending scheduled payment) are\nexcluded from this array, and items scheduled for a future\nwithdrawal date appear under `scheduled` instead, creating no bill\npayment until that day.\n","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"billPayments.items.[INDEX].id","typeLabel":"string"},"status":{"oneOf":[{"type":"string","uniqueKey":"billPayments.items.[INDEX].status.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"billPayments.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"billPayments.items.[INDEX].status","typeLabel":"string | null"},"amountInCents":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"billPayments.items.[INDEX].amountInCents.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"billPayments.items.[INDEX].amountInCents.oneOf.1","typeLabel":"null"}],"uniqueKey":"billPayments.items.[INDEX].amountInCents","typeLabel":"integer\u003cint64> | null"},"createdAt":{"oneOf":[{"type":"number","uniqueKey":"billPayments.items.[INDEX].createdAt.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"billPayments.items.[INDEX].createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"billPayments.items.[INDEX].createdAt","typeLabel":"number | null"},"vendorDeliveryMethodId":{"oneOf":[{"type":"string","description":"ID of the vendor delivery method the funds were sent to.","uniqueKey":"billPayments.items.[INDEX].vendorDeliveryMethodId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the vendor delivery method the funds were sent to.","uniqueKey":"billPayments.items.[INDEX].vendorDeliveryMethodId.oneOf.1","typeLabel":"null"}],"uniqueKey":"billPayments.items.[INDEX].vendorDeliveryMethodId","typeLabel":"string | null"},"vendorPayoutMethodId":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated alias of vendorDeliveryMethodId, retained for backwards compatibility.","uniqueKey":"billPayments.items.[INDEX].vendorPayoutMethodId.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated alias of vendorDeliveryMethodId, retained for backwards compatibility.","uniqueKey":"billPayments.items.[INDEX].vendorPayoutMethodId.oneOf.1","typeLabel":"null"}],"uniqueKey":"billPayments.items.[INDEX].vendorPayoutMethodId","typeLabel":"string | null"},"billPayableId":{"type":"string","description":"Opaque ID grouping the payment attempts made against one bill. Not directly retrievable through the API; use the bill and bill payment endpoints instead.","uniqueKey":"billPayments.items.[INDEX].billPayableId","typeLabel":"string"}},"uniqueKey":"billPayments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"billPayments","typeLabel":"object[]"},"billErrors":{"type":"array","description":"Per-bill failures. Each entry identifies a single bill from the\nrequest that could not be paid; other bills in the batch still\nproceed. Includes bills rejected because they are already paid\nor already have a pending scheduled payment.\n","items":{"type":"object","properties":{"billId":{"type":"string","description":"ID of the bill from the request that could not be paid.","uniqueKey":"billErrors.items.[INDEX].billId","typeLabel":"string"},"error":{"type":"string","description":"Human-readable reason the bill could not be paid (for example, the bill is already paid or already has a pending scheduled payment).","uniqueKey":"billErrors.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"billErrors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"billErrors","typeLabel":"object[]"},"scheduled":{"type":"array","description":"Acknowledgment of items scheduled for a future withdrawal date, keyed by the billId submitted in the request.","items":{"type":"object","properties":{"billId":{"type":"string","description":"ID of the bill the scheduled payment is for.","uniqueKey":"scheduled.items.[INDEX].billId","typeLabel":"string"},"withdrawalDate":{"type":"string","description":"Day (`YYYY-MM-DD`, US Eastern) the payment will debit your payment method and execute.","uniqueKey":"scheduled.items.[INDEX].withdrawalDate","typeLabel":"string"}},"uniqueKey":"scheduled.items.[INDEX]","typeLabel":"object"},"uniqueKey":"scheduled","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"billPayments":[{"id":"\u003cstring>","status":"\u003cstring>","amountInCents":123,"createdAt":123,"vendorDeliveryMethodId":"\u003cstring>","vendorPayoutMethodId":"\u003cstring>","billPayableId":"\u003cstring>"}],"billErrors":[{"billId":"\u003cstring>","error":"\u003cstring>"}],"scheduled":[{"billId":"\u003cstring>","withdrawalDate":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"7226d517-f348-4dce-b5a1-a2dda7d89823":{"description":"Invalid input","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A human-readable error message describing what went wrong. Note that some 500 responses may return a plain text string instead of this JSON object.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code, present on the errors a client can act on (e.g. `SHARED_ACCOUNT` on a 409 from the ACH debit authorization upload, `REFERENCE_CONFLICT` on a 409 from recording an external payment or a debit memo, `NICKEL_BANKING_NOT_ACTIVE` or `MISSING_PERMISSION` on a 403 from a Nickel Banking list). Absent otherwise.","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"61dd0294-182d-4de4-9670-4f467fecd3ad":{"description":"The API key isn't allowed to make this request: the permissions it acts with don't include one the request needs. `error` is Nickel's message. Also returned for an API key without REST API access. Don't retry: the same request is refused until the permission is granted.","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A human-readable error message describing what went wrong. Note that some 500 responses may return a plain text string instead of this JSON object.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code, present on the errors a client can act on (e.g. `SHARED_ACCOUNT` on a 409 from the ACH debit authorization upload, `REFERENCE_CONFLICT` on a 409 from recording an external payment or a debit memo, `NICKEL_BANKING_NOT_ACTIVE` or `MISSING_PERMISSION` on a 403 from a Nickel Banking list). Absent otherwise.","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"The logged in user is not allowed to perform that action."},"examples":{"Example":{"title":"Example","value":{"error":"The logged in user is not allowed to perform that action."}}},"exampleType":"examples"}},"exampleType":"examples"},"2531eb62-d40d-4cf7-b9ba-0cc4d08cb14c":{"description":"One or more bills not found","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A human-readable error message describing what went wrong. Note that some 500 responses may return a plain text string instead of this JSON object.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code, present on the errors a client can act on (e.g. `SHARED_ACCOUNT` on a 409 from the ACH debit authorization upload, `REFERENCE_CONFLICT` on a 409 from recording an external payment or a debit memo, `NICKEL_BANKING_NOT_ACTIVE` or `MISSING_PERMISSION` on a 403 from a Nickel Banking list). Absent otherwise.","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4f96d563-de92-4f0e-840c-2f8e54c16b3f":{"description":"Internal server error","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A human-readable error message describing what went wrong. Note that some 500 responses may return a plain text string instead of this JSON object.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code, present on the errors a client can act on (e.g. `SHARED_ACCOUNT` on a 409 from the ACH debit authorization upload, `REFERENCE_CONFLICT` on a 409 from recording an external payment or a debit memo, `NICKEL_BANKING_NOT_ACTIVE` or `MISSING_PERMISSION` on a 403 from a Nickel Banking list). Absent otherwise.","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"495db91b-b23a-4170-a845-c15561fd44b8":{"description":"Unexpected error","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A human-readable error message describing what went wrong. Note that some 500 responses may return a plain text string instead of this JSON object.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable machine-readable code, present on the errors a client can act on (e.g. `SHARED_ACCOUNT` on a 409 from the ACH debit authorization upload, `REFERENCE_CONFLICT` on a 409 from recording an external payment or a debit memo, `NICKEL_BANKING_NOT_ACTIVE` or `MISSING_PERMISSION` on a 403 from a Nickel Banking list). Absent otherwise.","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a79970ac-053d-451a-a280-c2ff3e23ae04":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"ad169b3a-7580-4cdf-b519-5cf232fed2c8":{"url":"https://rest.staging.nickel.com","description":"Sandbox / Staging"},"f29cb06d-c3de-48e4-bfe1-01480ccc908f":{"url":"https://rest.nickel.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"nickel-api-docs.yaml"},"subdomain":"nickel","siteName":"Nickel API Documentation","title":"Pay bills - Nickel API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T18:02:43.572Z","originalFileLocation":"api-reference/bill/pay-bills.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Process payments for up to 25 bills in a single batch request. A request with more than 25 is refused with a 400 and pays nothing; send a longer list in several requests. The batch is partial-success: valid items go through and any per-bill failures are returned in billErrors[] ({billId, error}). Bills that are already paid, or that already have a pending scheduled payment, are reported as per-bill entries in billErrors[] — they no longer fail the whole request — and are excluded from the returned billPayments array so pre-existing payments aren\u0026#x27;t surfaced as if this batch created them. A top-level error is only returned for request-wide problems (for example, invalid input).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nickel API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Pay bills - Nickel API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Process payments for up to 25 bills in a single batch request. A request with more than 25 is refused with a 400 and pays nothing; send a longer list in several requests. The batch is partial-success: valid items go through and any per-bill failures are returned in billErrors[] ({billId, error}). Bills that are already paid, or that already have a pending scheduled payment, are reported as per-bill entries in billErrors[] — they no longer fail the whole request — and are excluded from the returned billPayments array so pre-existing payments aren\u0026#x27;t surfaced as if this batch created them. A top-level error is only returned for request-wide problems (for example, invalid input).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nickel API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dev.nickel.com/api-reference/bill/pay-bills\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nickel.mintlify.app/_mintlify/api/og/v2?division=Bill\u0026amp;title=Pay+bills\u0026amp;description=Process+payments+for+up+to+25+bills+in+a+single+batch+request.+A%0Arequest+with+more+than+25+is+refused+with+a+400+and+pays+nothing%3B%0Asend+a+longer+list+in+several\u0026amp;theme=ea60622944d870c708d03140\u0026amp;signature=8733929c171c769ac45e2bd1bf5b504cdfeae41e9003245bc879cd2ca9a1a2ce\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Pay bills - Nickel API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Process payments for up to 25 bills in a single batch request. A request with more than 25 is refused with a 400 and pays nothing; send a longer list in several requests. The batch is partial-success: valid items go through and any per-bill failures are returned in billErrors[] ({billId, error}). Bills that are already paid, or that already have a pending scheduled payment, are reported as per-bill entries in billErrors[] — they no longer fail the whole request — and are excluded from the returned billPayments array so pre-existing payments aren\u0026#x27;t surfaced as if this batch created them. A top-level error is only returned for request-wide problems (for example, invalid input).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nickel.mintlify.app/_mintlify/api/og/v2?division=Bill\u0026amp;title=Pay+bills\u0026amp;description=Process+payments+for+up+to+25+bills+in+a+single+batch+request.+A%0Arequest+with+more+than+25+is+refused+with+a+400+and+pays+nothing%3B%0Asend+a+longer+list+in+several\u0026amp;theme=ea60622944d870c708d03140\u0026amp;signature=8733929c171c769ac45e2bd1bf5b504cdfeae41e9003245bc879cd2ca9a1a2ce\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nickel/qzde5PUIvsrMn_56/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nickel API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3A032D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dev.nickel.com/api-reference/bill/pay-bills\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/bill/pay-bills.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dev.nickel.com/#organization\",\"name\":\"Nickel API Documentation\",\"url\":\"https://dev.nickel.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nickel/51OVWZCdyoI76-NG/logo500.png?fit=max\u0026auto=format\u0026n=51OVWZCdyoI76-NG\u0026q=85\u0026s=9b006540dadff0abbf62416fff590d9d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dev.nickel.com#website\",\"name\":\"Nickel API Documentation\",\"url\":\"https://dev.nickel.com\",\"publisher\":{\"@id\":\"https://dev.nickel.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dev.nickel.com/api-reference/bill/pay-bills#webpage\",\"url\":\"https://dev.nickel.com/api-reference/bill/pay-bills\",\"name\":\"Pay bills\",\"description\":\"Process payments for up to 25 bills in a single batch request. A request with more than 25 is refused with a 400 and pays nothing; send a longer list in several requests. The batch is partial-success: valid items go through and any per-bill failures are returned in billErrors[] ({billId, error}). Bills that are already paid, or that already have a pending scheduled payment, are reported as per-bill entries in billErrors[] — they no longer fail the whole request — and are excluded from the returned billPayments array so pre-existing payments aren't surfaced as if this batch created them. A top-level error is only returned for request-wide problems (for example, invalid input).\",\"dateModified\":\"2026-10-23T18:02:43.572Z\",\"isPartOf\":{\"@id\":\"https://dev.nickel.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev.nickel.com/api-reference/bill/pay-bills#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.nickel.com/api-reference/bill/pay-bills#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://dev.nickel.com/api-reference/file/upload-a-file\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Bill\",\"item\":\"https://dev.nickel.com/api-reference/bill/list-bills\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Pay bills\",\"item\":\"https://dev.nickel.com/api-reference/bill/pay-bills\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://dev.nickel.com/api-reference/bill/pay-bills#apireference\",\"headline\":\"Pay bills\",\"name\":\"Pay bills\",\"description\":\"Process payments for up to 25 bills in a single batch request. A request with more than 25 is refused with a 400 and pays nothing; send a longer list in several requests. The batch is partial-success: valid items go through and any per-bill failures are returned in billErrors[] ({billId, error}). Bills that are already paid, or that already have a pending scheduled payment, are reported as per-bill entries in billErrors[] — they no longer fail the whole request — and are excluded from the returned billPayments array so pre-existing payments aren't surfaced as if this batch created them. A top-level error is only returned for request-wide problems (for example, invalid input).\",\"url\":\"https://dev.nickel.com/api-reference/bill/pay-bills\",\"mainEntityOfPage\":{\"@id\":\"https://dev.nickel.com/api-reference/bill/pay-bills#webpage\"},\"dateModified\":\"2026-10-23T18:02:43.572Z\",\"publisher\":{\"@id\":\"https://dev.nickel.com/#organization\"},\"isPartOf\":{\"@id\":\"https://dev.nickel.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nickel API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nickel API Documentation","nav":{"global":{"anchors":[{"anchor":"Nickel","icon":"house","href":"https://nickel.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"group":"File","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /file","href":"/api-reference/file/upload-a-file"}]},{"group":"Webhook","pages":[{"title":"Get webhooks","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /webhook","href":"/api-reference/webhook/get-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /webhook","href":"/api-reference/webhook/create-a-webhook"}]},{"group":"Payment Link","pages":[{"title":"Create a new payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /paymentLink","href":"/api-reference/payment-link/create-a-new-payment-link"},{"title":"Find a payment link by id","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /paymentLink/{paymentLinkId}","href":"/api-reference/payment-link/find-a-payment-link-by-id"},{"title":"Update an existing payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml put /paymentLink/{paymentLinkId}","href":"/api-reference/payment-link/update-an-existing-payment-link"},{"title":"Deletes a payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml delete /paymentLink/{paymentLinkId}","href":"/api-reference/payment-link/deletes-a-payment-link"},{"title":"Attach a previously uploaded PDF to a payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /paymentLink/{paymentLinkId}/uploadPdf","href":"/api-reference/payment-link/attach-a-previously-uploaded-pdf-to-a-payment-link"},{"title":"Send a payment link to recipients","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /paymentLink/{paymentLinkId}/send","href":"/api-reference/payment-link/send-a-payment-link-to-recipients"},{"title":"Mark a payment link as paid","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /paymentLink/{paymentLinkId}/markPaid","href":"/api-reference/payment-link/mark-a-payment-link-as-paid"},{"title":"Record an external payment on a payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /paymentLink/{paymentLinkId}/externalPayment","href":"/api-reference/payment-link/record-an-external-payment-on-a-payment-link"},{"title":"Void an external payment on a payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /paymentLink/{paymentLinkId}/externalPayment/{externalPaymentId}/void","href":"/api-reference/payment-link/void-an-external-payment-on-a-payment-link"},{"title":"Record a debit memo on a payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /paymentLink/{paymentLinkId}/debitMemo","href":"/api-reference/payment-link/record-a-debit-memo-on-a-payment-link"},{"title":"Void a debit memo on a payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /paymentLink/{paymentLinkId}/debitMemo/{debitMemoId}/void","href":"/api-reference/payment-link/void-a-debit-memo-on-a-payment-link"}]},{"group":"Payment","pages":[{"title":"Returns a payment by id","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /payment/{paymentId}","href":"/api-reference/payment/returns-a-payment-by-id"},{"title":"Refund a payment","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /payment/{paymentId}/refund","href":"/api-reference/payment/refund-a-payment"}]},{"group":"Disbursement","pages":[{"title":"Returns a disbursement by id","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /disbursement/{disbursementId}","href":"/api-reference/disbursement/returns-a-disbursement-by-id"}]},{"group":"Customer","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /customers","href":"/api-reference/customer/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /customer","href":"/api-reference/customer/create-a-customer"},{"title":"Find a customer by id","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /customer/{customerId}","href":"/api-reference/customer/find-a-customer-by-id"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml put /customer/{customerId}","href":"/api-reference/customer/update-a-customer"}]},{"group":"Charge Authorization","pages":[{"title":"Upload an ACH Debit Authorization PDF","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /customer/{customerId}/uploadACHDebitAuthorizationPdf","href":"/api-reference/charge-authorization/upload-an-ach-debit-authorization-pdf"},{"title":"Request charge authorization from a customer","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /customer/{customerId}/requestChargeAuthorization","href":"/api-reference/charge-authorization/request-charge-authorization-from-a-customer"},{"title":"Returns a charge authorization by id","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /chargeAuthorization/{chargeAuthorizationId}","href":"/api-reference/charge-authorization/returns-a-charge-authorization-by-id"},{"title":"Make payments using charge authorizations","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /chargeAuthorization/pay","href":"/api-reference/charge-authorization/make-payments-using-charge-authorizations"}]},{"group":"Vendor","pages":[{"title":"List vendors","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /vendor","href":"/api-reference/vendor/list-vendors"},{"title":"Create a vendor","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /vendor","href":"/api-reference/vendor/create-a-vendor"},{"title":"Get a vendor by ID","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /vendor/{vendorId}","href":"/api-reference/vendor/get-a-vendor-by-id"},{"title":"Update a vendor","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml put /vendor/{vendorId}","href":"/api-reference/vendor/update-a-vendor"},{"title":"Delete a vendor","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml delete /vendor/{vendorId}","href":"/api-reference/vendor/delete-a-vendor"}]},{"group":"Vendor Delivery Method","pages":[{"title":"Update vendor ACH delivery method","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml put /vendor/{vendorId}/deliveryMethod/ach","href":"/api-reference/vendor-delivery-method/update-vendor-ach-delivery-method"},{"title":"Update vendor check delivery method","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml put /vendor/{vendorId}/deliveryMethod/check","href":"/api-reference/vendor-delivery-method/update-vendor-check-delivery-method"},{"title":"Update vendor wire delivery method","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml put /vendor/{vendorId}/deliveryMethod/wire","href":"/api-reference/vendor-delivery-method/update-vendor-wire-delivery-method"},{"title":"Delete a vendor delivery method","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml delete /vendorDeliveryMethod/{vendorDeliveryMethodId}","href":"/api-reference/vendor-delivery-method/delete-a-vendor-delivery-method"},{"title":"Request delivery details from a vendor","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /vendor/{vendorId}/requestDeliveryDetails","href":"/api-reference/vendor-delivery-method/request-delivery-details-from-a-vendor"}]},{"group":"Bill","pages":[{"title":"List bills","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /bill","href":"/api-reference/bill/list-bills"},{"title":"Create a bill","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /bill","href":"/api-reference/bill/create-a-bill"},{"title":"Get a bill by ID","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /bill/{billId}","href":"/api-reference/bill/get-a-bill-by-id"},{"title":"Update a bill","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml put /bill/{billId}","href":"/api-reference/bill/update-a-bill"},{"title":"Delete a bill","description":null,"deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml delete /bill/{billId}","href":"/api-reference/bill/delete-a-bill"},{"title":"Pay bills","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /bill/pay","href":"/api-reference/bill/pay-bills"},{"title":"Cancel a bill's scheduled payment","description":"Cancel the pending scheduled payment on a bill before it executes. Returns the refreshed bill with `scheduledWithdrawalDate` back to null. No webhook is emitted for a cancellation made before the withdrawal day. Responds 404 when the bill has no pending scheduled payment — including when the payment already executed on its withdrawal day or was already cancelled.\n","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /bill/{billId}/cancelScheduledPayment","href":"/api-reference/bill/cancel-a-bills-scheduled-payment"},{"title":"Get a bill payment by ID","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /billPayment/{billPaymentId}","href":"/api-reference/bill/get-a-bill-payment-by-id"},{"title":"Cancel a bill payment","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /billPayment/{billPaymentId}/cancel","href":"/api-reference/bill/cancel-a-bill-payment"},{"title":"Stop payment on a check bill payment","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /billPayment/{billPaymentId}/stopPayment","href":"/api-reference/bill/stop-payment-on-a-check-bill-payment"}]},{"group":"Bill Payment Method","pages":[{"title":"List bill payment methods","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /billPaymentMethods","href":"/api-reference/bill-payment-method/list-bill-payment-methods"}]},{"group":"Nickel Banking","pages":[{"title":"List Nickel Banking accounts","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /nickelBanking/accounts","href":"/api-reference/nickel-banking/list-nickel-banking-accounts"},{"title":"List Nickel Banking cards","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /nickelBanking/cards","href":"/api-reference/nickel-banking/list-nickel-banking-cards"},{"title":"List check deposits","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /nickelBanking/checkDeposits","href":"/api-reference/nickel-banking/list-check-deposits"},{"title":"Deposit a check","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /nickelBanking/checkDeposits","href":"/api-reference/nickel-banking/deposit-a-check"},{"title":"Get a check deposit by id","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /nickelBanking/checkDeposits/{checkDepositId}","href":"/api-reference/nickel-banking/get-a-check-deposit-by-id"},{"title":"Apply a check deposit to a payment link","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml post /nickelBanking/checkDeposits/{checkDepositId}/apply","href":"/api-reference/nickel-banking/apply-a-check-deposit-to-a-payment-link"},{"title":"List Nickel Banking transactions","deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /nickelBanking/transactions","href":"/api-reference/nickel-banking/list-nickel-banking-transactions"}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"title":"Pay bills - Nickel API Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}