{"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/payment/returns-a-payment-by-id","slug":"/api-reference/payment/returns-a-payment-by-id","pageMetadata":{"title":"Returns a payment by id","description":null,"deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /payment/{paymentId}","href":"/api-reference/payment/returns-a-payment-by-id","autogeneratedByOpenApi":true},"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":"Returns a payment by id","description":null,"deprecated":null,"version":null,"openapi":"/nickel-api-docs.yaml get /payment/{paymentId}","href":"/api-reference/payment/returns-a-payment-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payment"],"summary":"Returns a payment by id","operationId":"getPayment","parameters":["06b0512b-59a4-4a29-9a64-148959eaa651"],"responses":{"200":"baeb3003-da65-429e-8f19-f04faa68c92a","403":"04825648-4ce8-4620-8ce8-b476b5f2cd70","500":"0493fe8b-ebb8-4664-ace2-d6169220d34e","default":"23763950-252d-4a80-b762-52fbb4c48d1c"},"method":"get","type":"path","servers":["ad169b3a-7580-4cdf-b519-5cf232fed2c8","f29cb06d-c3de-48e4-bfe1-01480ccc908f"],"security":["a79970ac-053d-451a-a280-c2ff3e23ae04"],"path":"/payment/{paymentId}","baseUrlOptions":["https://rest.staging.nickel.com","https://rest.nickel.com"],"title":"Returns a payment by id","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"06b0512b-59a4-4a29-9a64-148959eaa651":{"name":"paymentId","in":"path","description":"ID of the payment","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of the payment","uniqueKey":"","typeLabel":"string"}}},"responses":{"baeb3003-da65-429e-8f19-f04faa68c92a":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","example":"SUCCEEDED","uniqueKey":"status","typeLabel":"string"},"fees":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"CREDIT_CARD_FEE","uniqueKey":"fees.items.[INDEX].type","typeLabel":"string"},"amountInCents":{"type":"integer","format":"int64","example":290,"uniqueKey":"fees.items.[INDEX].amountInCents","typeLabel":"integer\u003cint64>"}},"uniqueKey":"fees.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fees","typeLabel":"object[]"},"amountInCents":{"type":"integer","format":"int64","example":10000,"uniqueKey":"amountInCents","typeLabel":"integer\u003cint64>"},"chargedAmountInCents":{"type":"integer","format":"int64","example":10290,"uniqueKey":"chargedAmountInCents","typeLabel":"integer\u003cint64>"},"platformFeeInCents":{"type":"integer","format":"int64","example":290,"uniqueKey":"platformFeeInCents","typeLabel":"integer\u003cint64>"},"paymentLinkId":{"oneOf":[{"type":"string","uniqueKey":"paymentLinkId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentLinkId.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentLinkId","typeLabel":"string | null"},"paymentMethod":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","uniqueKey":"paymentMethod.oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["ACH","Card","NickelBalance"],"description":"`NickelBalance` is a Nickel Banking account.","uniqueKey":"paymentMethod.oneOf.0.type","typeLabel":"enum\u003cstring>"},"achDetails":{"oneOf":[{"type":"object","properties":{"bankName":{"type":"string","example":"JP Morgan Chase","uniqueKey":"paymentMethod.oneOf.0.achDetails.oneOf.0.bankName","typeLabel":"string"},"routingNumber":{"type":"string","uniqueKey":"paymentMethod.oneOf.0.achDetails.oneOf.0.routingNumber","typeLabel":"string"},"accountNumberLastFour":{"type":"string","uniqueKey":"paymentMethod.oneOf.0.achDetails.oneOf.0.accountNumberLastFour","typeLabel":"string"}},"uniqueKey":"paymentMethod.oneOf.0.achDetails.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.achDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.achDetails","typeLabel":"object | null"},"cardDetails":{"oneOf":[{"type":"object","properties":{"brand":{"oneOf":[{"type":"string","example":"visa","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.brand.oneOf.0","typeLabel":"string"},{"type":"null","example":"visa","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.brand","typeLabel":"string | null"},"last4":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.last4.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.last4.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.last4","typeLabel":"string | null"},"holderName":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.holderName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.holderName.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.holderName","typeLabel":"string | null"},"expMonth":{"oneOf":[{"type":"string","example":"2","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.expMonth.oneOf.0","typeLabel":"string"},{"type":"null","example":"2","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.expMonth.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.expMonth","typeLabel":"string | null"},"expYear":{"oneOf":[{"type":"string","example":"2030","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.expYear.oneOf.0","typeLabel":"string"},{"type":"null","example":"2030","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.expYear.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0.expYear","typeLabel":"string | null"}},"uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.cardDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.cardDetails","typeLabel":"object | null"},"nickelBalanceDetails":{"oneOf":[{"type":"object","description":"Set when `type` is `NickelBalance`; null otherwise.","properties":{"nickname":{"oneOf":[{"type":"string","description":"The name you gave the account in the dashboard, if any.","example":"Operating","uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.nickname.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name you gave the account in the dashboard, if any.","example":"Operating","uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.nickname.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.nickname","typeLabel":"string | null"},"accountNumberLastFour":{"oneOf":[{"type":"string","example":"6789","uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.accountNumberLastFour.oneOf.0","typeLabel":"string"},{"type":"null","example":"6789","uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.accountNumberLastFour.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.accountNumberLastFour","typeLabel":"string | null"},"spendableCents":{"oneOf":[{"type":"integer","format":"int64","description":"What the account can pay right now, in cents — its available balance less money already committed to other payments. A bill payment larger than this fails.","example":125000,"uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.spendableCents.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"What the account can pay right now, in cents — its available balance less money already committed to other payments. A bill payment larger than this fails.","example":125000,"uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.spendableCents.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0.spendableCents","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.nickelBalanceDetails","typeLabel":"object | null"},"billingDetails":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.name","typeLabel":"string | null"},"companyName":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.companyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.companyName","typeLabel":"string | null"},"street":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.street.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.street","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.state","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.zip","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"paymentMethod.oneOf.0.billingDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.billingDetails","typeLabel":"object | null"}},"uniqueKey":"paymentMethod.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"paymentMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod","typeLabel":"object | null"},"disbursement":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","uniqueKey":"disbursement.oneOf.0.id","typeLabel":"string"},"status":{"type":"string","example":"PENDING","uniqueKey":"disbursement.oneOf.0.status","typeLabel":"string"},"amountInCents":{"type":"integer","format":"int64","example":10000,"uniqueKey":"disbursement.oneOf.0.amountInCents","typeLabel":"integer\u003cint64>"},"bankName":{"type":"string","example":"JP Morgan Chase","uniqueKey":"disbursement.oneOf.0.bankName","typeLabel":"string"},"accountNumberLastFour":{"type":"string","uniqueKey":"disbursement.oneOf.0.accountNumberLastFour","typeLabel":"string"},"paymentIds":{"type":"array","items":{"type":"string","example":"clkqzo2y1000cx9tfohoiodq1","uniqueKey":"disbursement.oneOf.0.paymentIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"disbursement.oneOf.0.paymentIds","typeLabel":"string[]"},"createdAt":{"oneOf":[{"type":"string","format":"date","uniqueKey":"disbursement.oneOf.0.createdAt.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"disbursement.oneOf.0.createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"disbursement.oneOf.0.createdAt","typeLabel":"string\u003cdate> | null"},"paidAt":{"oneOf":[{"type":"string","format":"date","uniqueKey":"disbursement.oneOf.0.paidAt.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"disbursement.oneOf.0.paidAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"disbursement.oneOf.0.paidAt","typeLabel":"string\u003cdate> | null"}},"uniqueKey":"disbursement.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"disbursement.oneOf.1","typeLabel":"null"}],"uniqueKey":"disbursement","typeLabel":"object | null"},"refunds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"refunds.items.[INDEX].id","typeLabel":"string"},"amountCents":{"type":"integer","format":"int64","example":515,"uniqueKey":"refunds.items.[INDEX].amountCents","typeLabel":"integer\u003cint64>"},"refundDate":{"type":"string","format":"date-time","uniqueKey":"refunds.items.[INDEX].refundDate","typeLabel":"string\u003cdate-time>"},"voided":{"type":"boolean","uniqueKey":"refunds.items.[INDEX].voided","typeLabel":"boolean"}},"uniqueKey":"refunds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"refunds","typeLabel":"object[]"},"createdAt":{"type":"number","uniqueKey":"createdAt","typeLabel":"number"},"estimatedDisbursementDate":{"oneOf":[{"type":"string","uniqueKey":"estimatedDisbursementDate.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"estimatedDisbursementDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"estimatedDisbursementDate","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","status":"SUCCEEDED","fees":[{"type":"CREDIT_CARD_FEE","amountInCents":290}],"amountInCents":10000,"chargedAmountInCents":10290,"platformFeeInCents":290,"paymentLinkId":"\u003cstring>","paymentMethod":{"id":"\u003cstring>","type":"ACH","achDetails":{"bankName":"JP Morgan Chase","routingNumber":"\u003cstring>","accountNumberLastFour":"\u003cstring>"},"cardDetails":{"brand":"visa","last4":"\u003cstring>","holderName":"\u003cstring>","expMonth":"2","expYear":"2030"},"nickelBalanceDetails":{"nickname":"Operating","accountNumberLastFour":"6789","spendableCents":125000},"billingDetails":{"name":"\u003cstring>","companyName":"\u003cstring>","street":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","zip":"\u003cstring>","email":"\u003cstring>"}},"disbursement":{"id":"\u003cstring>","status":"PENDING","amountInCents":10000,"bankName":"JP Morgan Chase","accountNumberLastFour":"\u003cstring>","paymentIds":["clkqzo2y1000cx9tfohoiodq1"],"createdAt":"2023-12-25","paidAt":"2023-12-25"},"refunds":[{"id":"\u003cstring>","amountCents":515,"refundDate":"2023-11-07T05:31:56Z","voided":true}],"createdAt":123,"estimatedDisbursementDate":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"04825648-4ce8-4620-8ce8-b476b5f2cd70":{"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"},"0493fe8b-ebb8-4664-ace2-d6169220d34e":{"description":"Payment not found or 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"},"23763950-252d-4a80-b762-52fbb4c48d1c":{"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":"Returns a payment by id - Nickel API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T18:11:11.268Z","originalFileLocation":"api-reference/payment/returns-a-payment-by-id.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=\"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=\"Returns a payment by id - Nickel API Documentation\">\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/payment/returns-a-payment-by-id\">\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=Payment\u0026amp;title=Returns+a+payment+by+id\u0026amp;theme=ea60622944d870c708d03140\u0026amp;signature=622174eaeaa601de3bbc0a7259b23923ae7b46ac46c10469cb7552a48827f240\">\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=\"Returns a payment by id - Nickel API Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nickel.mintlify.app/_mintlify/api/og/v2?division=Payment\u0026amp;title=Returns+a+payment+by+id\u0026amp;theme=ea60622944d870c708d03140\u0026amp;signature=622174eaeaa601de3bbc0a7259b23923ae7b46ac46c10469cb7552a48827f240\">\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/payment/returns-a-payment-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payment/returns-a-payment-by-id.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/payment/returns-a-payment-by-id#webpage\",\"url\":\"https://dev.nickel.com/api-reference/payment/returns-a-payment-by-id\",\"name\":\"Returns a payment by id\",\"dateModified\":\"2026-10-23T18:11:11.268Z\",\"isPartOf\":{\"@id\":\"https://dev.nickel.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev.nickel.com/api-reference/payment/returns-a-payment-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.nickel.com/api-reference/payment/returns-a-payment-by-id#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\":\"Returns a payment by id\",\"item\":\"https://dev.nickel.com/api-reference/payment/returns-a-payment-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://dev.nickel.com/api-reference/payment/returns-a-payment-by-id#apireference\",\"headline\":\"Returns a payment by id\",\"name\":\"Returns a payment by id\",\"url\":\"https://dev.nickel.com/api-reference/payment/returns-a-payment-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://dev.nickel.com/api-reference/payment/returns-a-payment-by-id#webpage\"},\"dateModified\":\"2026-10-23T18:11:11.268Z\",\"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","description":"Voids a debit memo — the undo for recording one, or the mirror of a reversed debit memo in your ERP. The memo is kept for audit but its amount comes back out of `requestedAmountCents`, which can complete the link. Voiding is allowed even when your customer already paid the memo: `overCollectedAmountCents` in the response says how much they paid beyond the link's new total. Returning that money is a refund, and yours to decide. Voiding an already-voided memo succeeds.","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","description":"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.","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","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","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":"Returns a payment by id - 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"]}