{
"code": "authentication_missing",
"message": "The request has no authentication credentials. Send your API token in the Authorization header.",
"errors": [
{
"code": "authentication_missing",
"message": "The Authorization header is missing. Send your API token as a bearer token.",
"parameters": [
"Authorization"
]
}
]
}
{
"code": "internal_server_error",
"message": "Internal server error. Retry with exponential backoff. For a POST, PATCH or DELETE, reuse the same Idempotency-Key so the request isn't processed twice. If it keeps failing, contact Lead with the Lead-Request-ID."
}
User Credit Balances
Create a User Credit Balance
Create a User Credit Balance under an existing User Account. Send the parent User Account’s ID as user_account_id in the request body. New User Credit Balances have status: active.
{
"code": "authentication_missing",
"message": "The request has no authentication credentials. Send your API token in the Authorization header.",
"errors": [
{
"code": "authentication_missing",
"message": "The Authorization header is missing. Send your API token as a bearer token.",
"parameters": [
"Authorization"
]
}
]
}
{
"code": "internal_server_error",
"message": "Internal server error. Retry with exponential backoff. For a POST, PATCH or DELETE, reuse the same Idempotency-Key so the request isn't processed twice. If it keeps failing, contact Lead with the Lead-Request-ID."
}
See Errors for the common errors every v2 endpoint can return.
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Idempotency-Key
string
required
Idempotency key
Required string length: 5 - 255
Body
application/json
Request body for creating a new User Credit Balance.
user_account_id
string
required
The ID of the parent User Account.
Pattern: ^user_account_\w+$
Example:
"user_account_xyz123"
name
string
required
Required string length: 1 - 64
Pattern: \S
currency_code
enum<string>
required
A three-letter currency code as defined in ISO 4217.
Available options:
USD
Example:
"USD"
autopay_method
enum<string>
required
Available options:
ach,
debit_card,
wire,
virtual_wallet,
credit_card,
none
terms
object
required
The rates are always required. Which other fields apply depends on structure. When
structure is non_revolving, expected_maturity_date, repayment, max_funding_amount,
duration, and expected_finance_charge_amount are required. When structure is
revolving, only repayment is allowed, and it's optional.
Show child attributes
metadata
object
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
Response
Credit Balance created successfully
A user credit balance — a virtual end-customer credit position.
id
string
required
The ID of the User Credit Balance object.
Pattern: ^user_credit_balance_[0-9A-Za-z]{27}$
Example:
"user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf"
created_at
string<date-time>
required
user_account_id
string
The parent User Account's ID.
Pattern: ^user_account_\w+$
Example:
"user_account_xyz123"
name
string
Human-readable name.
Example:
"Personal Loan - Jane Smith"
status
enum<string>
Available options:
active,
inactive,
closed,
reporting_stopped
status_reason
enum<string>
Available options:
active,
frozen,
dormant,
other,
entity_closed,
partner_closed,
paid_off,
charged_off,
canceled,
receivables_sold_to_partner,
data_not_available
currency_code
enum<string>
A three-letter currency code as defined in ISO 4217.
Available options:
USD
Example:
"USD"
amount
integer
Signed, minor units.
amount_in_usd
integer
Signed, minor units, in USD.
amount_breakdown
object
Show child attributes
fees
object
Show child attributes
rewards
object
Show child attributes
dispute
object
Show child attributes
charge_off
object
Show child attributes
past_due
object
Show child attributes
autopay_method
enum<string>
Available options:
ach,
debit_card,
wire,
virtual_wallet,
credit_card,
none
terms
object
Show child attributes
metadata
object
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
closed_at
string<date-time> | null
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Lead | API Docs","description":"Documentation on integrating with Lead.","colors":{"primary":"#0a7dff","light":"#0A7DFF","dark":"#0A7DFF"},"logo":{"light":"https://mintcdn.com/lead/CBhAckaMlXKGU6Mg/logo/light.png?fit=max\u0026auto=format\u0026n=CBhAckaMlXKGU6Mg\u0026q=85\u0026s=15271cba9a93ada7db90b103ceca5861","dark":"https://mintcdn.com/lead/CBhAckaMlXKGU6Mg/logo/dark.png?fit=max\u0026auto=format\u0026n=CBhAckaMlXKGU6Mg\u0026q=85\u0026s=b903bd5379397802c864e5f18a2eb40a"},"favicon":"https://mintcdn.com/lead/xIgp8PZ3ECTtP05D/logo/favicon.png?fit=max\u0026auto=format\u0026n=xIgp8PZ3ECTtP05D\u0026q=85\u0026s=d2492ae48f213bed1dbf2b5b087b2df2","navbar":{"primary":{"type":"button","label":"Partner Site","href":"https://partners.lead.bank"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/lead-bank","x":"https://x.com/Lead_Bank","website":"https://www.lead.bank/"}},"fonts":{"heading":{"family":"Lead-Sans-Variable","weight":700,"source":"fonts/Lead-Sans-Variable.woff2","format":"woff2"},"body":{"family":"Lead-Sans-Variable","weight":400,"source":"fonts/Lead-Sans-Variable.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lead","hasAudioNarration":false,"actualSubdomain":"lead","customDomains":["docs.lead.bank"],"gitSource":{"type":"github","owner":"lunafinancialgroup","repo":"client-api-specs","deployBranch":"docs-live","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":"","_id":"6afe2c426d627ce391380405"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afe2c426d627ce39138040b","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":159},{"language":"default","tag":"Products","count":158},{"language":"default","tag":"Payment Rails","count":88},{"language":"default","tag":"Customers \u0026 Accounts","count":54},{"language":"default","tag":"File Reference","count":41},{"language":"default","tag":"ACH","count":28},{"language":"default","tag":"Banking Infrastructure","count":26},{"language":"default","tag":"Applications","count":22},{"language":"default","tag":"Lending \u0026 Receivables","count":20},{"language":"default","tag":"Wire","count":20}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"site-roles","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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:Lead Sans Variable;src:url('https://dunclyde.s3.us-west-1.amazonaws.com/Lead+Bank/Lead+Sans+Variable+250523.ttf') format(\"truetype\");font-weight:50 900;font-style:normal;font-display:swap}body{color:#07021d;font-family:Lead Sans Variable, Arial, sans-serif;font-size:16px;line-height:20px;overscroll-behavior:none;font-feature-settings:\"calt\" 0, \"liga\" 1, \"rlig\" 1, \"rvrn\" 1, \"kern\" 1, \"rclt\" 1, \"ss20\" 1;font-variation-settings:slnt 0}h1,h2{font-feature-settings:\"calt\" 0, \"liga\" 1, \"rlig\" 1, \"rvrn\" 1, \"kern\" 1, \"rclt\" 1, \"ss13\" 1, \"ss05\" 1, \"ss04\" 1, \"ss03\" 1, \"ss20\" 1}table td:first-child code,table th:first-child code{white-space:nowrap}:root{--sd-panel: #F1F4F7;--sd-node: #FFFFFF;--sd-node-border: #DDE3EA;--sd-final-border: #8A94A3;--sd-text: #2E3440;--sd-line: #B0BAC4;--sd-label: #6B7480;--sd-title: #8A94A3}.dark{--sd-panel: #1A1F27;--sd-node: #232A34;--sd-node-border: #364150;--sd-final-border: #8A94A3;--sd-text: #E6E9EE;--sd-line: #5D6878;--sd-label: #A3ACB9;--sd-title: #8A94A3}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .cluster rect{fill:var(--sd-panel)!important;stroke:var(--sd-panel)!important;rx:10px;ry:10px}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .cluster-label,svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .cluster-label span,svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .cluster text{color:var(--sd-title)!important;fill:var(--sd-title)!important}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .node rect,svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .node path{fill:var(--sd-node)!important;stroke:var(--sd-node-border)!important;stroke-width:1px!important}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .node rect{rx:8px;ry:8px}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .node.final rect,svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .node.final path{stroke:var(--sd-final-border)!important;stroke-width:1.5px!important}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .nodeLabel,svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .node .label{color:var(--sd-text)!important;fill:var(--sd-text)!important}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .flowchart-link{stroke:var(--sd-line)!important;stroke-width:1.5px!important}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) marker path{fill:var(--sd-line)!important;stroke:var(--sd-line)!important}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .edgeLabel,svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .edgeLabel p,svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .edgeLabel span,svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .labelBkg{background-color:var(--sd-panel)!important;border:none!important;color:var(--sd-label)!important}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .edgeLabel rect{fill:var(--sd-panel)!important;stroke:none!important}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) marker path{transform:translateX(-5px)}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .edgeLabel foreignObject{overflow:visible}svg[id^=\"mermaid\"]:has(g[id*=\"leadstyle\"]) .edgeLabel p{padding:0 6px!important;margin:0 -6px!important}"}]}
{"page":{"pagePath":"api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2","slug":"/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2","pageMetadata":{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_balances","title":"Create a User Credit Balance","description":"Create a User Credit Balance under an existing User Account. Send the parent User Account's ID as `user_account_id` in the request body. New User Credit Balances have `status: active`.","href":"/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2"},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Create a User Credit Balance under an existing User Account. Send the parent User Account’s ID as \", _jsx(_components.code, {\n children: \"user_account_id\"\n }), \" in the request body. New User Credit Balances have \", _jsx(_components.code, {\n children: \"status: active\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/api-reference/using-the-api/errors-v2`,children:`Errors`}),` for the common errors every v2 endpoint can return.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_balances","title":"Create a User Credit Balance","description":"Create a User Credit Balance under an existing User Account. Send the parent User Account's ID as `user_account_id` in the request body. New User Credit Balances have `status: active`.","href":"/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/lead/84cc1bb218160b2c/ach-settlement-calculator.js"],"openApiReferenceData":{"operation":{"tags":["User Credit Balance"],"operationId":"create-a-user-credit-balance-v2","summary":"Create a Credit Balance","description":"Create a User Credit Balance under an existing User Account. Send the parent User Account's ID as `user_account_id` in the request body. New User Credit Balances have `status: active`.","parameters":["c02a0bc7-a625-4869-b5f6-979a2de35899"],"requestBody":"ac897033-ec12-480e-b2f5-f9075b6eb8b9","responses":{"200":"cd02fc52-ca6c-453b-87f8-11303f4d025c","4XX":"a70cad26-b381-4205-88d2-32d023c584ef","5XX":"d17d64b9-121f-413f-b872-fd76d87fde7d"},"method":"post","type":"path","servers":["e020c684-e01b-4e6f-827b-acdcce172ced","1356265e-576c-4d50-ac50-8cdceb16b6a5"],"security":["de95846e-f8af-449d-837e-f85051217d3c"],"path":"/v2/user_credit_balances","baseUrlOptions":["https://api.sandbox.lead.bank","https://api.lead.bank"],"title":"Create a Credit Balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c02a0bc7-a625-4869-b5f6-979a2de35899":{"name":"Idempotency-Key","in":"header","description":"Idempotency key","required":true,"schema":{"type":"string","maxLength":255,"minLength":5,"isRequired":true,"description":"Idempotency key","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for creating a new User Credit Balance.","required":["user_account_id","name","currency_code","autopay_method","terms"],"properties":{"user_account_id":{"type":"string","description":"The ID of the parent User Account.","example":"user_account_xyz123","pattern":"^user_account_\\w+$","isRequired":true,"uniqueKey":"user_account_id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"\\S","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"currency_code":{"description":"A three-letter currency code as defined in ISO 4217.","type":"string","example":"USD","enum":["USD"],"isRequired":true,"uniqueKey":"currency_code","typeLabel":"enum\u003cstring>"},"autopay_method":{"type":"string","enum":["ach","debit_card","wire","virtual_wallet","credit_card","none"],"isRequired":true,"uniqueKey":"autopay_method","typeLabel":"enum\u003cstring>"},"terms":{"type":"object","description":"The rates are always required. Which other fields apply depends on `structure`. When\n`structure` is `non_revolving`, `expected_maturity_date`, `repayment`, `max_funding_amount`,\n`duration`, and `expected_finance_charge_amount` are required. When `structure` is\n`revolving`, only `repayment` is allowed, and it's optional.","required":["structure","interest_rate","effective_interest_rate","effective_apr"],"properties":{"structure":{"type":"string","enum":["revolving","non_revolving"],"isRequired":true,"uniqueKey":"terms.structure","typeLabel":"enum\u003cstring>"},"interest_rate":{"type":"string","description":"Decimal string with exactly 6 digits after the decimal point.","pattern":"^(0|[1-9]\\d*)\\.\\d{6}$","example":"5.250000","isRequired":true,"uniqueKey":"terms.interest_rate","typeLabel":"string"},"effective_interest_rate":{"type":"string","description":"Decimal string with exactly 6 digits after the decimal point.","pattern":"^(0|[1-9]\\d*)\\.\\d{6}$","example":"5.250000","isRequired":true,"uniqueKey":"terms.effective_interest_rate","typeLabel":"string"},"effective_apr":{"type":"string","description":"Decimal string with exactly 6 digits after the decimal point.","pattern":"^(0|[1-9]\\d*)\\.\\d{6}$","example":"5.250000","isRequired":true,"uniqueKey":"terms.effective_apr","typeLabel":"string"},"expected_maturity_date":{"type":"string","format":"date","uniqueKey":"terms.expected_maturity_date","typeLabel":"string\u003cdate>"},"repayment":{"type":"object","description":"The expected repayment schedule. `expected_payment_frequency_interval_days` is required when\n`expected_payment_frequency` is `fixed_interval`, and must be absent otherwise. When\n`terms.structure` is `revolving`, only `expected_payment_frequency` and\n`expected_payment_frequency_interval_days` are allowed.","required":["expected_payment_frequency"],"properties":{"expected_payment_frequency":{"type":"string","enum":["business_daily","weekly","biweekly","semi_monthly","monthly","quarterly","semi_annually","annually","fixed_interval","maturity","variable"],"isRequired":true,"uniqueKey":"terms.repayment.expected_payment_frequency","typeLabel":"enum\u003cstring>"},"expected_payment_frequency_interval_days":{"type":"integer","minimum":1,"maximum":730,"uniqueKey":"terms.repayment.expected_payment_frequency_interval_days","typeLabel":"integer"},"expected_number_of_payments":{"type":"integer","minimum":0,"exclusiveMinimum":true,"uniqueKey":"terms.repayment.expected_number_of_payments","typeLabel":"integer"},"expected_first_payment_date":{"type":"string","format":"date","uniqueKey":"terms.repayment.expected_first_payment_date","typeLabel":"string\u003cdate>"},"expected_first_payment_amount":{"type":"integer","description":"Minor units.","minimum":0,"exclusiveMinimum":true,"uniqueKey":"terms.repayment.expected_first_payment_amount","typeLabel":"integer"},"expected_last_payment_date":{"type":"string","format":"date","uniqueKey":"terms.repayment.expected_last_payment_date","typeLabel":"string\u003cdate>"},"expected_last_payment_amount":{"type":"integer","description":"Minor units.","minimum":0,"exclusiveMinimum":true,"uniqueKey":"terms.repayment.expected_last_payment_amount","typeLabel":"integer"},"expected_payment_amount":{"type":"integer","description":"Minor units.","minimum":0,"exclusiveMinimum":true,"uniqueKey":"terms.repayment.expected_payment_amount","typeLabel":"integer"}},"uniqueKey":"terms.repayment","typeLabel":"object"},"max_funding_amount":{"type":"integer","description":"Minor units.","minimum":0,"exclusiveMinimum":true,"uniqueKey":"terms.max_funding_amount","typeLabel":"integer"},"duration":{"type":"object","required":["length","unit"],"properties":{"length":{"type":"integer","minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"terms.duration.length","typeLabel":"integer"},"unit":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"terms.duration.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"terms.duration","typeLabel":"object"},"expected_finance_charge_amount":{"type":"integer","description":"Minor units.","minimum":0,"uniqueKey":"terms.expected_finance_charge_amount","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"terms","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"A set of key-value pairs that can be used to store additional information related to this object.","uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"user_account_id":"user_account_xyz123","name":"\u003cstring>","currency_code":"USD","terms":{"interest_rate":"5.250000","effective_interest_rate":"5.250000","effective_apr":"5.250000","expected_maturity_date":"2023-12-25","max_funding_amount":1,"expected_finance_charge_amount":1},"metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"cd02fc52-ca6c-453b-87f8-11303f4d025c":{"description":"Credit Balance created successfully","content":{"application/json":{"schema":{"type":"object","description":"A user credit balance — a virtual end-customer credit position.","required":["id","created_at"],"properties":{"id":{"type":"string","description":"The ID of the User Credit Balance object.","pattern":"^user_credit_balance_[0-9A-Za-z]{27}$","example":"user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"user_account_id":{"type":"string","description":"The parent User Account's ID.","example":"user_account_xyz123","pattern":"^user_account_\\w+$","uniqueKey":"user_account_id","typeLabel":"string"},"name":{"type":"string","description":"Human-readable name.","example":"Personal Loan - Jane Smith","uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","enum":["active","inactive","closed","reporting_stopped"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"status_reason":{"type":"string","enum":["active","frozen","dormant","other","entity_closed","partner_closed","paid_off","charged_off","canceled","receivables_sold_to_partner","data_not_available"],"uniqueKey":"status_reason","typeLabel":"enum\u003cstring>"},"currency_code":{"description":"A three-letter currency code as defined in ISO 4217.","type":"string","example":"USD","enum":["USD"],"uniqueKey":"currency_code","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","description":"Signed, minor units.","uniqueKey":"amount","typeLabel":"integer"},"amount_in_usd":{"type":"integer","description":"Signed, minor units, in USD.","uniqueKey":"amount_in_usd","typeLabel":"integer"},"amount_breakdown":{"type":"object","properties":{"principal":{"type":"integer","description":"Principal portion, minor units.","uniqueKey":"amount_breakdown.principal","typeLabel":"integer"},"interest":{"type":"integer","description":"Interest portion, minor units.","uniqueKey":"amount_breakdown.interest","typeLabel":"integer"},"fees":{"type":"integer","description":"Fees portion, minor units.","uniqueKey":"amount_breakdown.fees","typeLabel":"integer"}},"uniqueKey":"amount_breakdown","typeLabel":"object"},"fees":{"type":"object","properties":{"accrued":{"type":"integer","description":"Total fees accrued to date, minor units.","uniqueKey":"fees.accrued","typeLabel":"integer"}},"uniqueKey":"fees","typeLabel":"object"},"rewards":{"type":"object","properties":{"amount":{"type":"integer","uniqueKey":"rewards.amount","typeLabel":"integer"},"unit":{"type":"string","enum":["USD","points"],"uniqueKey":"rewards.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"rewards","typeLabel":"object"},"dispute":{"type":"object","properties":{"amount":{"type":"integer","uniqueKey":"dispute.amount","typeLabel":"integer"},"amount_breakdown":{"type":"object","properties":{"principal":{"type":"integer","description":"Principal portion, minor units.","uniqueKey":"dispute.amount_breakdown.principal","typeLabel":"integer"},"interest":{"type":"integer","description":"Interest portion, minor units.","uniqueKey":"dispute.amount_breakdown.interest","typeLabel":"integer"},"fees":{"type":"integer","description":"Fees portion, minor units.","uniqueKey":"dispute.amount_breakdown.fees","typeLabel":"integer"}},"uniqueKey":"dispute.amount_breakdown","typeLabel":"object"}},"uniqueKey":"dispute","typeLabel":"object"},"charge_off":{"type":"object","properties":{"amount":{"type":"integer","uniqueKey":"charge_off.amount","typeLabel":"integer"},"amount_breakdown":{"type":"object","properties":{"principal":{"type":"integer","description":"Principal portion, minor units.","uniqueKey":"charge_off.amount_breakdown.principal","typeLabel":"integer"},"interest":{"type":"integer","description":"Interest portion, minor units.","uniqueKey":"charge_off.amount_breakdown.interest","typeLabel":"integer"},"fees":{"type":"integer","description":"Fees portion, minor units.","uniqueKey":"charge_off.amount_breakdown.fees","typeLabel":"integer"}},"uniqueKey":"charge_off.amount_breakdown","typeLabel":"object"}},"uniqueKey":"charge_off","typeLabel":"object"},"past_due":{"type":"object","properties":{"amount":{"type":"integer","uniqueKey":"past_due.amount","typeLabel":"integer"},"days":{"type":"integer","uniqueKey":"past_due.days","typeLabel":"integer"},"amount_breakdown":{"type":"object","properties":{"principal":{"type":"integer","description":"Principal portion, minor units.","uniqueKey":"past_due.amount_breakdown.principal","typeLabel":"integer"},"interest":{"type":"integer","description":"Interest portion, minor units.","uniqueKey":"past_due.amount_breakdown.interest","typeLabel":"integer"},"fees":{"type":"integer","description":"Fees portion, minor units.","uniqueKey":"past_due.amount_breakdown.fees","typeLabel":"integer"}},"uniqueKey":"past_due.amount_breakdown","typeLabel":"object"}},"uniqueKey":"past_due","typeLabel":"object"},"autopay_method":{"type":"string","enum":["ach","debit_card","wire","virtual_wallet","credit_card","none"],"uniqueKey":"autopay_method","typeLabel":"enum\u003cstring>"},"terms":{"type":"object","properties":{"structure":{"type":"string","enum":["revolving","non_revolving"],"uniqueKey":"terms.structure","typeLabel":"enum\u003cstring>"},"interest_rate":{"type":"string","description":"Contractual annual interest rate, decimal(M,6).","pattern":"^(0|[1-9]\\d*)\\.\\d{6}$","example":"5.250000","uniqueKey":"terms.interest_rate","typeLabel":"string"},"effective_interest_rate":{"type":"string","description":"True annualized accrual rate, decimal(M,6).","pattern":"^(0|[1-9]\\d*)\\.\\d{6}$","example":"5.250000","uniqueKey":"terms.effective_interest_rate","typeLabel":"string"},"effective_apr":{"type":"string","description":"APR as disclosed to borrower, decimal(M,6).","pattern":"^(0|[1-9]\\d*)\\.\\d{6}$","example":"5.250000","uniqueKey":"terms.effective_apr","typeLabel":"string"},"expected_maturity_date":{"type":"string","format":"date","uniqueKey":"terms.expected_maturity_date","typeLabel":"string\u003cdate>"},"repayment":{"type":"object","properties":{"expected_payment_frequency":{"type":"string","enum":["business_daily","weekly","biweekly","semi_monthly","monthly","quarterly","semi_annually","annually","fixed_interval","maturity","variable"],"uniqueKey":"terms.repayment.expected_payment_frequency","typeLabel":"enum\u003cstring>"},"expected_payment_frequency_interval_days":{"type":"integer","uniqueKey":"terms.repayment.expected_payment_frequency_interval_days","typeLabel":"integer"},"expected_number_of_payments":{"type":"integer","uniqueKey":"terms.repayment.expected_number_of_payments","typeLabel":"integer"},"expected_first_payment_date":{"type":"string","format":"date","uniqueKey":"terms.repayment.expected_first_payment_date","typeLabel":"string\u003cdate>"},"expected_first_payment_amount":{"type":"integer","description":"Minor units.","uniqueKey":"terms.repayment.expected_first_payment_amount","typeLabel":"integer"},"expected_last_payment_date":{"type":"string","format":"date","uniqueKey":"terms.repayment.expected_last_payment_date","typeLabel":"string\u003cdate>"},"expected_last_payment_amount":{"type":"integer","description":"Minor units.","uniqueKey":"terms.repayment.expected_last_payment_amount","typeLabel":"integer"},"expected_payment_amount":{"type":"integer","description":"Minor units.","uniqueKey":"terms.repayment.expected_payment_amount","typeLabel":"integer"}},"uniqueKey":"terms.repayment","typeLabel":"object"},"max_funding_amount":{"type":"integer","description":"Minor units.","uniqueKey":"terms.max_funding_amount","typeLabel":"integer"},"duration":{"type":"object","properties":{"length":{"type":"integer","uniqueKey":"terms.duration.length","typeLabel":"integer"},"unit":{"type":"string","enum":["days","weeks","months","years"],"uniqueKey":"terms.duration.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"terms.duration","typeLabel":"object"},"expected_finance_charge_amount":{"type":"integer","description":"Minor units.","uniqueKey":"terms.expected_finance_charge_amount","typeLabel":"integer"}},"uniqueKey":"terms","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"A set of key-value pairs that can be used to store additional information related to this object.","uniqueKey":"metadata","typeLabel":"object"},"closed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"closed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"closed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"closed_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf","created_at":"2023-11-07T05:31:56Z","user_account_id":"user_account_xyz123","name":"Personal Loan - Jane Smith","status":"active","status_reason":"active","currency_code":"USD","amount":123,"amount_in_usd":123,"amount_breakdown":{"principal":123,"interest":123,"fees":123},"fees":{"accrued":123},"rewards":{"amount":123,"unit":"USD"},"dispute":{"amount":123,"amount_breakdown":{"principal":123,"interest":123,"fees":123}},"charge_off":{"amount":123,"amount_breakdown":{"principal":123,"interest":123,"fees":123}},"past_due":{"amount":123,"days":123,"amount_breakdown":{"principal":123,"interest":123,"fees":123}},"autopay_method":"ach","terms":{"structure":"revolving","interest_rate":"5.250000","effective_interest_rate":"5.250000","effective_apr":"5.250000","expected_maturity_date":"2023-12-25","repayment":{"expected_payment_frequency":"business_daily","expected_payment_frequency_interval_days":123,"expected_number_of_payments":123,"expected_first_payment_date":"2023-12-25","expected_first_payment_amount":123,"expected_last_payment_date":"2023-12-25","expected_last_payment_amount":123,"expected_payment_amount":123},"max_funding_amount":123,"duration":{"length":123,"unit":"days"},"expected_finance_charge_amount":123},"metadata":{},"closed_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"a70cad26-b381-4205-88d2-32d023c584ef":{"description":"Error. The response body is an Error object; `code` identifies the error family and `errors` lists field-level detail where applicable. See the Errors guide for the full list of codes per status.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"A snake_case code identifying the error family — the stable, machine-readable value partners branch on, together with the HTTP status.","example":"parameters_invalid","enum":["request_malformed","content_too_large","headers_invalid","unsupported_media_type","authentication_missing","token_invalid","source_ip_not_permitted","url_invalid","object_not_found","method_not_allowed","idempotency_key_in_use","idempotency_request_mismatched","rate_limit_exceeded","internal_server_error","service_unavailable","endpoint_disabled","gateway_timeout","parameters_invalid","related_object_invalid","related_object_not_ready","related_object_incompatible","limit_exceeded","partner_control_restricted","lead_control_restricted","object_state_mismatched","object_modified_concurrently","operation_invalid"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human-readable description of the error family. Identical for every occurrence of a given `code`; carries no request-specific detail.","example":"One or more parameters are invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","description":"Zero or more specific errors within this family. Always present for validation errors, one entry per failing field.","items":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"A snake_case code naming the specific error or sub-category.","example":"schema_violation","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of this specific error, with interpolated values where relevant.","example":"account_number_id is required.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"parameters":{"type":"array","description":"The request fields that caused this error, as `jq` paths without the leading dot. For example, a nested field is `address.city` and an array item is `beneficial_owners[1].ownership`. A key with characters other than letters, digits, and underscores is JSON-quoted, like `metadata[\"order.id\"]`. Headers appear by name, like `Idempotency-Key`. Present for validation errors.","items":{"type":"string","uniqueKey":"errors.items.[INDEX].parameters.items.[INDEX]","typeLabel":"string"},"example":["account_number_id"],"uniqueKey":"errors.items.[INDEX].parameters","typeLabel":"string[]"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"authentication_missing","message":"The request has no authentication credentials. Send your API token in the Authorization header.","errors":[{"code":"authentication_missing","message":"The Authorization header is missing. Send your API token as a bearer token.","parameters":["Authorization"]}]},"examples":{"Example":{"title":"Example","value":{"code":"authentication_missing","message":"The request has no authentication credentials. Send your API token in the Authorization header.","errors":[{"code":"authentication_missing","message":"The Authorization header is missing. Send your API token as a bearer token.","parameters":["Authorization"]}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d17d64b9-121f-413f-b872-fd76d87fde7d":{"description":"Server error. The response body is an Error object; `code` identifies the error family. See the Errors guide for the full list of codes per status.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"A snake_case code identifying the error family — the stable, machine-readable value partners branch on, together with the HTTP status.","example":"parameters_invalid","enum":["request_malformed","content_too_large","headers_invalid","unsupported_media_type","authentication_missing","token_invalid","source_ip_not_permitted","url_invalid","object_not_found","method_not_allowed","idempotency_key_in_use","idempotency_request_mismatched","rate_limit_exceeded","internal_server_error","service_unavailable","endpoint_disabled","gateway_timeout","parameters_invalid","related_object_invalid","related_object_not_ready","related_object_incompatible","limit_exceeded","partner_control_restricted","lead_control_restricted","object_state_mismatched","object_modified_concurrently","operation_invalid"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human-readable description of the error family. Identical for every occurrence of a given `code`; carries no request-specific detail.","example":"One or more parameters are invalid.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","description":"Zero or more specific errors within this family. Always present for validation errors, one entry per failing field.","items":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"A snake_case code naming the specific error or sub-category.","example":"schema_violation","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of this specific error, with interpolated values where relevant.","example":"account_number_id is required.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"parameters":{"type":"array","description":"The request fields that caused this error, as `jq` paths without the leading dot. For example, a nested field is `address.city` and an array item is `beneficial_owners[1].ownership`. A key with characters other than letters, digits, and underscores is JSON-quoted, like `metadata[\"order.id\"]`. Headers appear by name, like `Idempotency-Key`. Present for validation errors.","items":{"type":"string","uniqueKey":"errors.items.[INDEX].parameters.items.[INDEX]","typeLabel":"string"},"example":["account_number_id"],"uniqueKey":"errors.items.[INDEX].parameters","typeLabel":"string[]"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"internal_server_error","message":"Internal server error. Retry with exponential backoff. For a POST, PATCH or DELETE, reuse the same Idempotency-Key so the request isn't processed twice. If it keeps failing, contact Lead with the Lead-Request-ID."},"examples":{"Example":{"title":"Example","value":{"code":"internal_server_error","message":"Internal server error. Retry with exponential backoff. For a POST, PATCH or DELETE, reuse the same Idempotency-Key so the request isn't processed twice. If it keeps failing, contact Lead with the Lead-Request-ID."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"de95846e-f8af-449d-837e-f85051217d3c":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"e020c684-e01b-4e6f-827b-acdcce172ced":{"url":"https://api.sandbox.lead.bank"},"1356265e-576c-4d50-ac50-8cdceb16b6a5":{"url":"https://api.lead.bank"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","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":"https://docs.lead.bank/openapi.json"},"subdomain":"lead","siteName":"Lead | API Docs","title":"Create a User Credit Balance - Lead | API Docs","navMaps":{"firstHrefInVersion":{"v1":{"href":"/get-started/what-is-lead","matchLevel":4},"v2":{"href":"/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T17:16:48.690Z","originalFileLocation":"api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2.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=\"Create a User Credit Balance under an existing User Account. Send the parent User Account\u0026#x27;s ID as user_account_id in the request body. New User Credit Balances have status: active.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lead | API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lead/A4oS57fRsEfS3qru/_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/lead/A4oS57fRsEfS3qru/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lead/A4oS57fRsEfS3qru/_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/lead/A4oS57fRsEfS3qru/_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/lead/A4oS57fRsEfS3qru/_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/lead/A4oS57fRsEfS3qru/_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/lead/A4oS57fRsEfS3qru/_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/lead/A4oS57fRsEfS3qru/_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/lead/A4oS57fRsEfS3qru/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a User Credit Balance - Lead | API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a User Credit Balance under an existing User Account. Send the parent User Account\u0026#x27;s ID as user_account_id in the request body. New User Credit Balances have status: active.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lead | API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lead.mintlify.site/_mintlify/api/og/v2?division=User+Credit+Balances\u0026amp;title=Create+a+User+Credit+Balance\u0026amp;description=Create+a+User+Credit+Balance+under+an+existing+User+Account.+Send+the+parent+User+Account%27s+ID+as+%60user_account_id%60+in+the+request+body.+New+User+Credit+Balance\u0026amp;theme=319958618d627c957874ebb8\u0026amp;signature=3357e5d9c31d538dd319ffaa558e2230ff00766f995b433ff9e8542bdcaf2a30\">\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=\"Create a User Credit Balance - Lead | API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a User Credit Balance under an existing User Account. Send the parent User Account\u0026#x27;s ID as user_account_id in the request body. New User Credit Balances have status: active.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lead.mintlify.site/_mintlify/api/og/v2?division=User+Credit+Balances\u0026amp;title=Create+a+User+Credit+Balance\u0026amp;description=Create+a+User+Credit+Balance+under+an+existing+User+Account.+Send+the+parent+User+Account%27s+ID+as+%60user_account_id%60+in+the+request+body.+New+User+Credit+Balance\u0026amp;theme=319958618d627c957874ebb8\u0026amp;signature=3357e5d9c31d538dd319ffaa558e2230ff00766f995b433ff9e8542bdcaf2a30\">\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/lead/A4oS57fRsEfS3qru/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lead | API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0a7dff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lead.bank/#organization\",\"name\":\"Lead | API Docs\",\"url\":\"https://docs.lead.bank\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lead/CBhAckaMlXKGU6Mg/logo/light.png?fit=max\u0026auto=format\u0026n=CBhAckaMlXKGU6Mg\u0026q=85\u0026s=15271cba9a93ada7db90b103ceca5861\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lead.bank#website\",\"name\":\"Lead | API Docs\",\"url\":\"https://docs.lead.bank\",\"publisher\":{\"@id\":\"https://docs.lead.bank/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2#webpage\",\"url\":\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2\",\"name\":\"Create a User Credit Balance\",\"description\":\"Create a User Credit Balance under an existing User Account. Send the parent User Account's ID as user_account_id in the request body. New User Credit Balances have status: active.\",\"dateModified\":\"2026-11-17T17:16:48.690Z\",\"isPartOf\":{\"@id\":\"https://docs.lead.bank#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Lead | API Docs\",\"item\":\"https://docs.lead.bank\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a User Credit Balance\",\"item\":\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2#apireference\",\"headline\":\"Create a User Credit Balance\",\"name\":\"Create a User Credit Balance\",\"description\":\"Create a User Credit Balance under an existing User Account. Send the parent User Account's ID as user_account_id in the request body. New User Credit Balances have status: active.\",\"url\":\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lead.bank/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2#webpage\"},\"dateModified\":\"2026-11-17T17:16:48.690Z\",\"publisher\":{\"@id\":\"https://docs.lead.bank/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lead.bank#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2.md","siteName":"Lead | API Docs","nav":{"global":null,"versions":[{"version":"v1","default":true,"pages":[{"title":"v1","href":"/get-started/what-is-lead"}]},{"version":"v2","tag":"Preview","tabs":[{"tab":"Products","pages":[{"title":"Products","href":"/v2/products/overview"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/v2/guides/lend/on-sheet-loan-origination-and-servicing"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"API Overview, OAuth Authentication, and IP Allowlist","icon":"key","sidebarTitle":"Overview \u0026 Auth","href":"/api-reference/using-the-api/authentication"},{"icon":"arrow-rotate-right","title":"Idempotency","href":"/api-reference/using-the-api/idempotency-v2"},{"title":"Errors","icon":"triangle-exclamation","href":"/api-reference/using-the-api/errors-v2"}]},{"group":"Banking Infrastructure","pages":[{"group":"Core Accounts","tag":"Beta","pages":[{"openapi":"https://docs.lead.bank/openapi.json GET /v2/core_accounts","title":"List all Core Accounts","href":"/api-reference/endpoint/core-account/list-all-core-accounts"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/core_accounts/{id}","title":"Retrieve a Core Account","href":"/api-reference/endpoint/core-account/retrieve-a-core-account"}]},{"group":"Core Balances","tag":"Beta","pages":[{"openapi":"https://docs.lead.bank/openapi.json GET /v2/core_balances","title":"List all Core Balances","href":"/api-reference/endpoint/core-balance/list-all-core-balances"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/core_balances/{id}","title":"Retrieve a Core Balance","href":"/api-reference/endpoint/core-balance/retrieve-a-core-balance"}]},{"group":"Core Transactions","tag":"Beta","pages":[{"openapi":"https://docs.lead.bank/openapi.json GET /v2/core_transactions","title":"List all Core Transactions","href":"/api-reference/endpoint/core-transaction/list-all-core-transactions"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/core_transactions/{id}","title":"Retrieve a Core Transaction","href":"/api-reference/endpoint/core-transaction/retrieve-a-core-transaction"}]}]},{"group":"Customers \u0026 Accounts","pages":[{"group":"Entities","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/entities","title":"Create an Entity","href":"/api-reference/endpoint/entity/create-an-entity-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/entities/{id}","title":"Retrieve an Entity","href":"/api-reference/endpoint/entity/retrieve-an-entity-by-entity-id-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/entities","title":"Retrieve an Entity by Client Customer ID","href":"/api-reference/endpoint/entity/retrieve-an-entity-by-client-customer-id-v2"},{"openapi":"https://docs.lead.bank/openapi.json PATCH /v2/entities/{id}","title":"Update an Entity","href":"/api-reference/endpoint/entity/update-an-entity-v2"}]},{"group":"Applications","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/applications","title":"Create an Application","href":"/api-reference/endpoint/application/create-an-application-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/applications/{id}","title":"Retrieve an Application","href":"/api-reference/endpoint/application/retrieve-an-application-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/applications","title":"List Applications","href":"/api-reference/endpoint/application/list-applications-v2"},{"openapi":"https://docs.lead.bank/openapi.json PATCH /v2/applications/{id}","title":"Update an Application","href":"/api-reference/endpoint/application/update-an-application-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/applications/{id}/entity_relationships","title":"List Application Entity Relationships","href":"/api-reference/endpoint/application/list-application-entity-relationships-v2"}]},{"group":"User Accounts","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_accounts","title":"Create a User Account","href":"/api-reference/endpoint/user-account/create-a-user-account-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/user_accounts/{user_account_id}","title":"Retrieve a User Account","href":"/api-reference/endpoint/user-account/retrieve-a-user-account-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/user_accounts","title":"List User Accounts","href":"/api-reference/endpoint/user-account/list-user-accounts-v2"},{"openapi":"https://docs.lead.bank/openapi.json PATCH /v2/user_accounts/{user_account_id}","title":"Update a User Account","href":"/api-reference/endpoint/user-account/update-a-user-account-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_accounts/{user_account_id}/activate","title":"Activate a User Account","href":"/api-reference/endpoint/user-account/activate-a-user-account-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_accounts/{user_account_id}/deactivate","title":"Deactivate a User Account","href":"/api-reference/endpoint/user-account/deactivate-a-user-account-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_accounts/{user_account_id}/close","title":"Close a User Account","href":"/api-reference/endpoint/user-account/close-a-user-account-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/user_accounts/{user_account_id}/entity_relationships","title":"List User Account Entity Relationships","href":"/api-reference/endpoint/user-account/list-user-account-entity-relationships-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_accounts/{user_account_id}/entity_relationships/batch","title":"Batch Create User Account Entity Relationships","href":"/api-reference/endpoint/user-account/batch-create-user-account-entity-relationships-v2"},{"openapi":"https://docs.lead.bank/openapi.json DELETE /v2/user_accounts/{user_account_id}/entity_relationships/{entity_id}","title":"Delete User Account Entity Relationship","href":"/api-reference/endpoint/user-account/delete-user-account-entity-relationship-v2"}]},{"group":"Files","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/files","title":"Create a File","href":"/api-reference/endpoint/file/create-a-file"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/files/{id}","title":"Retrieve a File","description":"Retrieve a File's metadata by its ID. No bytes or download URL are returned.","href":"/api-reference/endpoint/file/retrieve-a-file"}]}]},{"group":"Balances and Transactions","pages":[{"group":"User Credit Balances","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_balances","title":"Create a User Credit Balance","href":"/api-reference/endpoint/user-credit-balance/create-a-user-credit-balance-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/user_credit_balances/{user_credit_balance_id}","title":"Retrieve a User Credit Balance","description":"Retrieve a User Credit Balance by its ID.","href":"/api-reference/endpoint/user-credit-balance/retrieve-a-user-credit-balance-v2"},{"openapi":"https://docs.lead.bank/openapi.json PATCH /v2/user_credit_balances/{user_credit_balance_id}","title":"Update a User Credit Balance","href":"/api-reference/endpoint/user-credit-balance/update-a-user-credit-balance-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_balances/{user_credit_balance_id}/activate","title":"Activate a User Credit Balance","href":"/api-reference/endpoint/user-credit-balance/activate-a-user-credit-balance-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_balances/{user_credit_balance_id}/deactivate","title":"Deactivate a User Credit Balance","href":"/api-reference/endpoint/user-credit-balance/deactivate-a-user-credit-balance-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_balances/{user_credit_balance_id}/close","title":"Close a User Credit Balance","href":"/api-reference/endpoint/user-credit-balance/close-a-user-credit-balance-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_balances/{user_credit_balance_id}/stop_reporting","title":"Stop Reporting on a User Credit Balance","href":"/api-reference/endpoint/user-credit-balance/stop-reporting-a-user-credit-balance-v2"}]},{"group":"User Credit Transactions","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_transactions","title":"Create a User Credit Transaction","href":"/api-reference/endpoint/user-credit-transaction/create-a-user-credit-transaction-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/user_credit_transactions/{user_credit_transaction_id}","title":"Retrieve a User Credit Transaction","href":"/api-reference/endpoint/user-credit-transaction/retrieve-a-user-credit-transaction-v2"},{"openapi":"https://docs.lead.bank/openapi.json PATCH /v2/user_credit_transactions/{user_credit_transaction_id}","title":"Update a User Credit Transaction","href":"/api-reference/endpoint/user-credit-transaction/update-a-user-credit-transaction-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/user_credit_transactions/{user_credit_transaction_id}/reverse","title":"Reverse a User Credit Transaction","href":"/api-reference/endpoint/user-credit-transaction/reverse-a-user-credit-transaction-v2"}]}]},{"group":"Lending \u0026 Receivables","pages":[{"group":"Fundings","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/fundings","title":"Create a Funding","href":"/api-reference/endpoint/funding/create-a-funding-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/fundings/{funding_id}","title":"Retrieve a Funding","href":"/api-reference/endpoint/funding/retrieve-a-funding-v2"}]},{"group":"Receivables","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json GET /v2/receivables","title":"List all Receivables","href":"/api-reference/endpoint/receivable/list-all-receivables-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/receivables/{receivable_id}","title":"Retrieve a Receivable","href":"/api-reference/endpoint/receivable/retrieve-a-receivable-v2"}]},{"group":"Receivable Sales","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json GET /v2/receivable_sales","title":"List all Receivable Sales","href":"/api-reference/endpoint/receivable-sale/list-all-receivable-sales-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/receivable_sales/{receivable_sale_id}","title":"Retrieve a Receivable Sale","href":"/api-reference/endpoint/receivable-sale/retrieve-a-receivable-sale-v2"}]}]},{"group":"Payment Rails","pages":[{"group":"Wires","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/wires","title":"Create a Wire","href":"/api-reference/endpoint/wire/create-a-wire-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/wires","title":"List all Wires","href":"/api-reference/endpoint/wire/list-all-wires-v2"},{"openapi":"https://docs.lead.bank/openapi.json GET /v2/wires/{id}","title":"Retrieve a Wire","href":"/api-reference/endpoint/wire/retrieve-a-wire-v2"},{"openapi":"https://docs.lead.bank/openapi.json PATCH /v2/wires/{id}","title":"Update a Wire","href":"/api-reference/endpoint/wire/update-a-wire-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/wires/{id}/cancel","title":"Cancel a Wire","href":"/api-reference/endpoint/wire/cancel-a-wire-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/wires/{id}/return","title":"Return a Wire","href":"/api-reference/endpoint/wire/return-a-wire-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/wires/{id}/request_return","title":"Request Return for a Wire","href":"/api-reference/endpoint/wire/request-return-for-wire-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/wires/{id}/reject_return_request","title":"Reject a Return Request for a Wire","href":"/api-reference/endpoint/wire/reject-return-request-for-wire-v2"}]}]},{"group":"Simulations","tag":"Preview","pages":[{"openapi":"https://docs.lead.bank/openapi.json POST /v2/simulate/fundings/{funding_id}/advance","title":"Simulate Advance Funding","href":"/api-reference/endpoint/simulation/simulate-advance-a-funding-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/simulate/card_network_settlements","title":"Simulate a Card Network Settlement","href":"/api-reference/endpoint/simulation/simulate-a-network-settlement-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/simulate/wires","title":"Simulate Wire","href":"/api-reference/endpoint/simulation/simulate-wire-v2"},{"openapi":"https://docs.lead.bank/openapi.json POST /v2/simulate/wires/{id}/advance","title":"Simulate Advance Wire","href":"/api-reference/endpoint/simulation/simulate-advance-wire-v2"}]},{"group":"v2 overlay spec","hidden":true,"pages":[{"group":"ACH","pages":[{"title":"List all ACHes","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/ach","href":"/api-reference/ach/list-all-aches"},{"title":"Create an ACH","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/ach","href":"/api-reference/ach/create-an-ach"},{"title":"Retrieve an ACH","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/ach/{ach_id}","href":"/api-reference/ach/retrieve-an-ach"},{"title":"Update an ACH","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v1/ach/{ach_id}","href":"/api-reference/ach/update-an-ach"},{"title":"Cancel an ACH","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/ach/{ach_id}/cancel","href":"/api-reference/ach/cancel-an-ach"},{"title":"Return an ACH","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/ach/{ach_id}/return","href":"/api-reference/ach/return-an-ach"},{"title":"Reverse an ACH","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/ach/{ach_id}/reverse","href":"/api-reference/ach/reverse-an-ach"}]},{"group":"Account Number","pages":[{"title":"List all Account Numbers","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/account_number","href":"/api-reference/account-number/list-all-account-numbers"},{"title":"Create an Account Number","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/account_number","href":"/api-reference/account-number/create-an-account-number"},{"title":"Register an Account Number","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/account_number/register","href":"/api-reference/account-number/register-an-account-number"},{"title":"Assign an Account Number","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/account_number/{account_number_id}/assign","href":"/api-reference/account-number/assign-an-account-number"},{"title":"Retrieve an Account Number","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/account_number/{account_number_id}","href":"/api-reference/account-number/retrieve-an-account-number"},{"title":"Update an Account Number","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v1/account_number/{account_number_id}","href":"/api-reference/account-number/update-an-account-number"},{"title":"Activate an Account Number","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/account_number/{account_number_id}/activate","href":"/api-reference/account-number/activate-an-account-number"},{"title":"Deactivate an Account Number","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/account_number/{account_number_id}/deactivate","href":"/api-reference/account-number/deactivate-an-account-number"},{"title":"Cancel an Account Number","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/account_number/{account_number_id}/cancel","href":"/api-reference/account-number/cancel-an-account-number"}]},{"group":"Core Account","pages":[{"title":"List all Core Accounts","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/core_accounts","href":"/api-reference/core-account/list-all-core-accounts"},{"title":"Retrieve a Core Account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/core_accounts/{id}","href":"/api-reference/core-account/retrieve-a-core-account"}]},{"group":"Core Balance","pages":[{"title":"List all Core Balances","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/core_balances","href":"/api-reference/core-balance/list-all-core-balances"},{"title":"Retrieve a Core Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/core_balances/{id}","href":"/api-reference/core-balance/retrieve-a-core-balance"}]},{"group":"Core Transaction","pages":[{"title":"List all Core Transactions","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/core_transactions","href":"/api-reference/core-transaction/list-all-core-transactions"},{"title":"Retrieve a Core Transaction","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/core_transactions/{id}","href":"/api-reference/core-transaction/retrieve-a-core-transaction"}]},{"group":"OAuth","pages":[{"title":"Get an Access Token","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/oauth/token","href":"/api-reference/oauth/get-an-access-token"}]},{"group":"Events","pages":[{"title":"Retrieve an event","deprecated":false,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/event/{event_id}","href":"/api-reference/events/retrieve-an-event"},{"title":"List all events","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/event","href":"/api-reference/events/list-all-events"}]},{"group":"Lending","pages":[{"title":"Create a Disbursement","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/lending/disbursements","href":"/api-reference/lending/create-a-disbursement"},{"title":"Retrieve a disbursement","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/lending/disbursements/{disbursement_id}","href":"/api-reference/lending/retrieve-a-disbursement"},{"title":"Cancel a disbursement","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/lending/disbursements/{disbursement_id}/cancel","href":"/api-reference/lending/cancel-a-disbursement"}]},{"group":"Lending Simulation","pages":[{"title":"Advance Sandbox Disbursement","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/simulate/lending/disbursements/{disbursement_id}/advance","href":"/api-reference/lending-simulation/advance-sandbox-disbursement"}]},{"group":"Simulation","pages":[{"title":"Simulate Incoming ACH","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/ach/incoming_ach","href":"/api-reference/simulation/simulate-incoming-ach"},{"title":"Simulate Incoming Return","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/ach/{ach_id}/incoming_return","href":"/api-reference/simulation/simulate-incoming-return"},{"title":"Advance Sandbox ACH","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/ach/{ach_id}/advance","href":"/api-reference/simulation/advance-sandbox-ach"},{"title":"Advance Sandbox Wire","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/wires/{wire_id}/advance","href":"/api-reference/simulation/advance-sandbox-wire"},{"title":"Simulate Incoming Wire","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/wires/incoming","href":"/api-reference/simulation/simulate-incoming-wire"},{"title":"Simulate Incoming Wire Return","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/wires/{wire_id}/incoming_return","href":"/api-reference/simulation/simulate-incoming-wire-return"},{"title":"Simulate Incoming Wire Return Request","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/wires/{wire_id}/incoming_return_request","href":"/api-reference/simulation/simulate-incoming-wire-return-request"},{"title":"Simulate Incoming Wire Return Request Rejection","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/wires/{wire_id}/incoming_return_request_rejection","href":"/api-reference/simulation/simulate-incoming-wire-return-request-rejection"},{"title":"Simulate Incoming Wire Return Request Acceptance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/wires/{wire_id}/incoming_return_request_acceptance","href":"/api-reference/simulation/simulate-incoming-wire-return-request-acceptance"},{"title":"Simulate Wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/simulate/wires","href":"/api-reference/simulation/simulate-wire-v2"},{"title":"Advance Sandbox Wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/simulate/wires/{id}/advance","href":"/api-reference/simulation/advance-sandbox-wire-v2"},{"title":"Simulate Advancing a Funding","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/simulate/fundings/{funding_id}/advance","href":"/api-reference/simulation/simulate-advancing-a-funding"},{"title":"Simulate Incoming Instant Payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/instant_payments/incoming","href":"/api-reference/simulation/simulate-incoming-instant-payment"},{"title":"Simulate Incoming Instant Payment Return","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/instant_payments/{instant_payment_id}/incoming_return","href":"/api-reference/simulation/simulate-incoming-instant-payment-return"},{"title":"Simulate Incoming Instant Payment Return Request","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/instant_payments/{instant_payment_id}/incoming_return_request","href":"/api-reference/simulation/simulate-incoming-instant-payment-return-request"},{"title":"Simulate Incoming Instant Payment Return Request Rejection","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/instant_payments/{instant_payment_id}/incoming_return_request_rejection","href":"/api-reference/simulation/simulate-incoming-instant-payment-return-request-rejection"},{"title":"Simulate Incoming Instant Payment Return Request Acceptance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/simulate/instant_payments/{instant_payment_id}/incoming_return_request_acceptance","href":"/api-reference/simulation/simulate-incoming-instant-payment-return-request-acceptance"},{"title":"Simulate a Card Network Settlement","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/simulate/card_network_settlements","href":"/api-reference/simulation/simulate-a-card-network-settlement"}]},{"group":"Internal Transfer","pages":[{"title":"List all Internal Transfers","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/internal_transfer","href":"/api-reference/internal-transfer/list-all-internal-transfers"},{"title":"Create an asynchronous Internal Transfer","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/internal_transfer","href":"/api-reference/internal-transfer/create-an-asynchronous-internal-transfer"},{"title":"Retrieve an Internal Transfer","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/internal_transfer/{internal_transfer_id}","href":"/api-reference/internal-transfer/retrieve-an-internal-transfer"}]},{"group":"Wire","pages":[{"title":"Retrieve a wire V1","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/wires/{wire_id}","href":"/api-reference/wire/retrieve-a-wire-v1"},{"title":"Update a wire V1","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v1/wires/{wire_id}","href":"/api-reference/wire/update-a-wire-v1"},{"title":"List all wires V1","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/wires","href":"/api-reference/wire/list-all-wires-v1"},{"title":"Create a wire V1","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/wires","href":"/api-reference/wire/create-a-wire-v1"},{"title":"Return a wire V1","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/wires/{wire_id}/return","href":"/api-reference/wire/return-a-wire-v1"},{"title":"Request return for a wire V1","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/wires/{wire_id}/request_return","href":"/api-reference/wire/request-return-for-a-wire-v1"},{"title":"Reject a return request","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/wires/{wire_id}/reject_return_request","href":"/api-reference/wire/reject-a-return-request"},{"title":"Cancel a wire V1","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/wires/{wire_id}/cancel","href":"/api-reference/wire/cancel-a-wire-v1"},{"title":"List all wires V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/wires","href":"/api-reference/wire/list-all-wires-v2"},{"title":"Create a wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/wires","href":"/api-reference/wire/create-a-wire-v2"},{"title":"Retrieve a wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/wires/{id}","href":"/api-reference/wire/retrieve-a-wire-v2"},{"title":"Update a wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v2/wires/{id}","href":"/api-reference/wire/update-a-wire-v2"},{"title":"Cancel a wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/wires/{id}/cancel","href":"/api-reference/wire/cancel-a-wire-v2"},{"title":"Return a wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/wires/{id}/return","href":"/api-reference/wire/return-a-wire-v2"},{"title":"Request return for a wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/wires/{id}/request_return","href":"/api-reference/wire/request-return-for-a-wire-v2"},{"title":"Reject a return request for a wire V2","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/wires/{id}/reject_return_request","href":"/api-reference/wire/reject-a-return-request-for-a-wire-v2"}]},{"group":"Entity","pages":[{"title":"Retrieve an entity by client customer id","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/entities","href":"/api-reference/entity/retrieve-an-entity-by-client-customer-id"},{"title":"Create an entity","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/entities","href":"/api-reference/entity/create-an-entity"},{"title":"Retrieve an entity by entity id","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/entities/{id}","href":"/api-reference/entity/retrieve-an-entity-by-entity-id"},{"title":"Update an entity","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v0/entities/{id}","href":"/api-reference/entity/update-an-entity"},{"title":"Retrieve an entity by client customer ID","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/entities","href":"/api-reference/entity/retrieve-an-entity-by-client-customer-id-1"},{"title":"Create an entity","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/entities","href":"/api-reference/entity/create-an-entity-1"},{"title":"Retrieve an entity","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/entities/{id}","href":"/api-reference/entity/retrieve-an-entity"},{"title":"Update an entity","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v2/entities/{id}","href":"/api-reference/entity/update-an-entity-1"}]},{"group":"Originator","pages":[{"title":"List all Originators","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/originators","href":"/api-reference/originator/list-all-originators"},{"title":"Create an Originator","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/originators","href":"/api-reference/originator/create-an-originator"},{"title":"Retrieve an Originator","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/originators/{originator_id}","href":"/api-reference/originator/retrieve-an-originator"},{"title":"Update an Originator","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v0/originators/{originator_id}","href":"/api-reference/originator/update-an-originator"},{"title":"Activate an Originator","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/originators/{originator_id}/activate","href":"/api-reference/originator/activate-an-originator"},{"title":"Deactivate an Originator","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/originators/{originator_id}/deactivate","href":"/api-reference/originator/deactivate-an-originator"},{"title":"Cancel an Originator","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/originators/{originator_id}/cancel","href":"/api-reference/originator/cancel-an-originator"}]},{"group":"Funding","pages":[{"title":"Create a Funding","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/fundings","href":"/api-reference/funding/create-a-funding"},{"title":"Retrieve a Funding","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/fundings/{id}","href":"/api-reference/funding/retrieve-a-funding"},{"title":"Advance a Funding (Simulation)","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/fundings/{id}/advance","href":"/api-reference/funding/advance-a-funding-simulation"},{"title":"Create a Funding","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/fundings","href":"/api-reference/funding/create-a-funding-1"},{"title":"Retrieve a Funding","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/fundings/{funding_id}","href":"/api-reference/funding/retrieve-a-funding-1"}]},{"group":"Receivable Sale","pages":[{"title":"List all Receivable Sales","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/receivable_sales","href":"/api-reference/receivable-sale/list-all-receivable-sales"},{"title":"Retrieve a Receivable Sale","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/receivable_sales/{receivable_sale_id}","href":"/api-reference/receivable-sale/retrieve-a-receivable-sale"}]},{"group":"Subledger Balances","pages":[{"title":"Create a Subledger Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/subledger_balances","href":"/api-reference/subledger-balances/create-a-subledger-balance"},{"title":"Retrieve a Subledger Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/subledger_balances/{id}","href":"/api-reference/subledger-balances/retrieve-a-subledger-balance"}]},{"group":"Instant Payments","pages":[{"title":"List all instant payments","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/instant_payments","href":"/api-reference/instant-payments/list-all-instant-payments"},{"title":"Create an instant payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/instant_payments","href":"/api-reference/instant-payments/create-an-instant-payment"},{"title":"Retrieve an instant payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v1/instant_payments/{instant_payment_id}","href":"/api-reference/instant-payments/retrieve-an-instant-payment"},{"title":"Return an instant payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/instant_payments/{instant_payment_id}/return","href":"/api-reference/instant-payments/return-an-instant-payment"},{"title":"Cancel an instant payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/instant_payments/{instant_payment_id}/cancel","href":"/api-reference/instant-payments/cancel-an-instant-payment"},{"title":"Request return for an instant payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/instant_payments/{instant_payment_id}/request_return","href":"/api-reference/instant-payments/request-return-for-an-instant-payment"},{"title":"Reject return request for an instant payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/instant_payments/{instant_payment_id}/reject_return_request","href":"/api-reference/instant-payments/reject-return-request-for-an-instant-payment"},{"title":"Check instant payment availability","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v1/instant_payments/check_availability","href":"/api-reference/instant-payments/check-instant-payment-availability"}]},{"group":"Compliance","pages":[{"title":"Retrieve an application by client application ID","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/applications","href":"/api-reference/compliance/retrieve-an-application-by-client-application-id"},{"title":"Create an application","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/applications","href":"/api-reference/compliance/create-an-application"},{"title":"Retrieve an application","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/applications/{id}","href":"/api-reference/compliance/retrieve-an-application"},{"title":"Update an application","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v0/applications/{id}","href":"/api-reference/compliance/update-an-application"},{"title":"List application entity relationships","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/applications/{id}/entity_relationships","href":"/api-reference/compliance/list-application-entity-relationships"},{"title":"Retrieve an account by client account ID","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/accounts","href":"/api-reference/compliance/retrieve-an-account-by-client-account-id"},{"title":"Create an account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/accounts","href":"/api-reference/compliance/create-an-account"},{"title":"Retrieve an account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/accounts/{id}","href":"/api-reference/compliance/retrieve-an-account"},{"title":"Update an account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v0/accounts/{id}","href":"/api-reference/compliance/update-an-account"},{"title":"Activate an account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/accounts/{id}/activate","href":"/api-reference/compliance/activate-an-account"},{"title":"Deactivate an account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/accounts/{id}/deactivate","href":"/api-reference/compliance/deactivate-an-account"},{"title":"Close an account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/accounts/{id}/close","href":"/api-reference/compliance/close-an-account"},{"title":"List account entity relationships","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/accounts/{id}/entity_relationships","href":"/api-reference/compliance/list-account-entity-relationships"},{"title":"Delete account entity relationship","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json delete /v0/accounts/{id}/entity_relationships/{entity_id}","href":"/api-reference/compliance/delete-account-entity-relationship"},{"title":"Batch create account entity relationships","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/accounts/{id}/entity_relationships/batch","href":"/api-reference/compliance/batch-create-account-entity-relationships"},{"title":"Retrieve a card by client card ID","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/cards","href":"/api-reference/compliance/retrieve-a-card-by-client-card-id"},{"title":"Create a card","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/cards","href":"/api-reference/compliance/create-a-card"},{"title":"Retrieve a card","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/cards/{id}","href":"/api-reference/compliance/retrieve-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v0/cards/{id}","href":"/api-reference/compliance/update-a-card"},{"title":"Activate a card","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/cards/{id}/activate","href":"/api-reference/compliance/activate-a-card"},{"title":"Deactivate a card","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/cards/{id}/deactivate","href":"/api-reference/compliance/deactivate-a-card"},{"title":"Close a card","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/cards/{id}/close","href":"/api-reference/compliance/close-a-card"}]},{"group":"Application","pages":[{"title":"List applications","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/applications","href":"/api-reference/application/list-applications"},{"title":"Create an application","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/applications","href":"/api-reference/application/create-an-application"},{"title":"Retrieve an application","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/applications/{id}","href":"/api-reference/application/retrieve-an-application"},{"title":"Update an application","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v2/applications/{id}","href":"/api-reference/application/update-an-application"},{"title":"List application entity relationships","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/applications/{id}/entity_relationships","href":"/api-reference/application/list-application-entity-relationships"}]},{"group":"User Account","pages":[{"title":"List user accounts","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/user_accounts","href":"/api-reference/user-account/list-user-accounts"},{"title":"Create a user account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_accounts","href":"/api-reference/user-account/create-a-user-account"},{"title":"Retrieve a user account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/user_accounts/{user_account_id}","href":"/api-reference/user-account/retrieve-a-user-account"},{"title":"Update a user account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v2/user_accounts/{user_account_id}","href":"/api-reference/user-account/update-a-user-account"},{"title":"Activate a user account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_accounts/{user_account_id}/activate","href":"/api-reference/user-account/activate-a-user-account"},{"title":"Deactivate a user account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_accounts/{user_account_id}/deactivate","href":"/api-reference/user-account/deactivate-a-user-account"},{"title":"Close a user account","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_accounts/{user_account_id}/close","href":"/api-reference/user-account/close-a-user-account"},{"title":"List user account entity relationships","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/user_accounts/{user_account_id}/entity_relationships","href":"/api-reference/user-account/list-user-account-entity-relationships"},{"title":"Delete user account entity relationship","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json delete /v2/user_accounts/{user_account_id}/entity_relationships/{entity_id}","href":"/api-reference/user-account/delete-user-account-entity-relationship"},{"title":"Batch create user account entity relationships","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_accounts/{user_account_id}/entity_relationships/batch","href":"/api-reference/user-account/batch-create-user-account-entity-relationships"}]},{"group":"User Credit Transaction","pages":[{"title":"Create a User Credit Transaction","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_credit_transactions","href":"/api-reference/user-credit-transaction/create-a-user-credit-transaction"},{"title":"Retrieve a User Credit Transaction","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/user_credit_transactions/{user_credit_transaction_id}","href":"/api-reference/user-credit-transaction/retrieve-a-user-credit-transaction"},{"title":"Update a User Credit Transaction","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v2/user_credit_transactions/{user_credit_transaction_id}","href":"/api-reference/user-credit-transaction/update-a-user-credit-transaction"},{"title":"Reverse a User Credit Transaction","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_credit_transactions/{user_credit_transaction_id}/reverse","href":"/api-reference/user-credit-transaction/reverse-a-user-credit-transaction"}]},{"group":"Blockchain Payment","pages":[{"title":"List all Blockchain Payments","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/blockchain_payments","href":"/api-reference/blockchain-payment/list-all-blockchain-payments"},{"title":"Create a Blockchain Payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v0/blockchain_payments","href":"/api-reference/blockchain-payment/create-a-blockchain-payment"},{"title":"Retrieve a Blockchain Payment","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v0/blockchain_payments/{blockchain_payment_id}","href":"/api-reference/blockchain-payment/retrieve-a-blockchain-payment"}]},{"group":"Receivable","pages":[{"title":"List all Receivables","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/receivables","href":"/api-reference/receivable/list-all-receivables"},{"title":"Retrieve a Receivable","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/receivables/{receivable_id}","href":"/api-reference/receivable/retrieve-a-receivable"}]},{"group":"User Credit Balance","pages":[{"title":"Create a Credit Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_credit_balances","href":"/api-reference/user-credit-balance/create-a-credit-balance"},{"title":"Retrieve a Credit Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/user_credit_balances/{user_credit_balance_id}","href":"/api-reference/user-credit-balance/retrieve-a-credit-balance"},{"title":"Update a Credit Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json patch /v2/user_credit_balances/{user_credit_balance_id}","href":"/api-reference/user-credit-balance/update-a-credit-balance"},{"title":"Activate a Credit Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_credit_balances/{user_credit_balance_id}/activate","href":"/api-reference/user-credit-balance/activate-a-credit-balance"},{"title":"Deactivate a Credit Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_credit_balances/{user_credit_balance_id}/deactivate","href":"/api-reference/user-credit-balance/deactivate-a-credit-balance"},{"title":"Close a Credit Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_credit_balances/{user_credit_balance_id}/close","href":"/api-reference/user-credit-balance/close-a-credit-balance"},{"title":"Stop Reporting on a Credit Balance","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/user_credit_balances/{user_credit_balance_id}/stop_reporting","href":"/api-reference/user-credit-balance/stop-reporting-on-a-credit-balance"}]},{"group":"Files","pages":[{"title":"Create a file","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json post /v2/files","href":"/api-reference/files/create-a-file"},{"title":"Retrieve a file","deprecated":null,"version":null,"openapi":"https://docs.lead.bank/openapi.json get /v2/files/{id}","href":"/api-reference/files/retrieve-a-file"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/v2/changelog"}]}]}]},"basePath":"","title":"Create a User Credit Balance - Lead | API Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}