{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Finverse API","colors":{"primary":"#009FFF","light":"#67CFFF","dark":"#004E7D"},"logo":{"light":"https://mintcdn.com/finverse/FcXUy2q84UCP-2qv/images/logo.svg?fit=max\u0026auto=format\u0026n=FcXUy2q84UCP-2qv\u0026q=85\u0026s=9fa78eb1508e7498cbf28f6ec85c2b48","dark":"https://mintcdn.com/finverse/FcXUy2q84UCP-2qv/images/logo.svg?fit=max\u0026auto=format\u0026n=FcXUy2q84UCP-2qv\u0026q=85\u0026s=9fa78eb1508e7498cbf28f6ec85c2b48"},"favicon":"https://mintcdn.com/finverse/ZbjEdqFlouvmTXg3/images/favicon.ico?fit=max\u0026auto=format\u0026n=ZbjEdqFlouvmTXg3\u0026q=85\u0026s=048e3947a09423567d07898d5f4a768c","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.finverse.com"}},"footer":{"socials":{"github":"https://github.com/finversetech","linkedin":"https://www.linkedin.com/company/finverse"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"finverse","hasAudioNarration":false,"actualSubdomain":"finverse","customDomains":["docs2.finverse.com"],"gitSource":{"type":"github","owner":"finversetech","repo":"public-docs","deployBranch":"master","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae956d5e968ff68fad8ef5b:success","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Mandates","count":10},{"language":"default","tag":"Payment links","count":7},{"language":"default","tag":"Link","count":6},{"language":"default","tag":"Payment users","count":6},{"language":"default","tag":"Accounts","count":5},{"language":"default","tag":"Login identity","count":5},{"language":"default","tag":"Payment operations","count":5},{"language":"default","tag":"Customer","count":4},{"language":"default","tag":"Payment accounts","count":3}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/bills/get-bill","slug":"/api-reference/bills/get-bill","pageMetadata":{"title":"Get bill","description":"Get a bill by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bills/{billId}","href":"/api-reference/bills/get-bill","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get a bill by ID\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get bill","description":"Get a bill by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bills/{billId}","href":"/api-reference/bills/get-bill","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["c6f6dc3a-290c-4774-af69-986e131405c2"],"description":"Get a bill by ID","tags":["bills"],"operationId":"getBill","parameters":["e85aa237-b3f1-4019-ab81-43a43a55e7d4"],"responses":{"200":"f721391a-6dec-416b-b488-caf082c17ec7","400":"7c6b5a0d-be2f-4fb6-b98f-2a3dd47c350b"},"summary":"Get bill","method":"get","type":"path","servers":["3f78a58c-f65d-4e0f-a44d-f9cae58dc18d"],"path":"/bills/{billId}","baseUrlOptions":["https://api.prod.finverse.net"],"title":"Get bill","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e85aa237-b3f1-4019-ab81-43a43a55e7d4":{"name":"billId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"f721391a-6dec-416b-b488-caf082c17ec7":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["payments","bill_id","external_bill_id","user_id","external_user_id","customer_app_id","bill_date","due_date","details","status","integration_id","sender_details","created_at","updated_at","is_finverse_autopay_eligible","integration_metadata"],"properties":{"bill_date":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"bill_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"bill_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bill_date","typeLabel":"string\u003cdate-time> | null"},"bill_id":{"type":"string","isRequired":true,"uniqueKey":"bill_id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"customer_app_id":{"type":"string","isRequired":true,"uniqueKey":"customer_app_id","typeLabel":"string"},"details":{"required":["total_amount_due","currency","bill_reference_id"],"properties":{"bill_reference_id":{"type":"string","isRequired":true,"uniqueKey":"details.bill_reference_id","typeLabel":"string"},"currency":{"type":"string","isRequired":true,"uniqueKey":"details.currency","typeLabel":"string"},"total_amount_due":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"details.total_amount_due","typeLabel":"integer\u003cint64>"},"description":{"type":"string","uniqueKey":"details.description","typeLabel":"string"}},"type":"object","isRequired":true,"uniqueKey":"details","typeLabel":"object"},"due_date":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"due_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"due_date","typeLabel":"string\u003cdate-time> | null"},"external_bill_id":{"type":"string","isRequired":true,"uniqueKey":"external_bill_id","typeLabel":"string"},"external_user_id":{"type":"string","isRequired":true,"uniqueKey":"external_user_id","typeLabel":"string"},"integration_id":{"type":"string","isRequired":true,"uniqueKey":"integration_id","typeLabel":"string"},"integration_metadata":{"required":["integration_id"],"properties":{"integration_id":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.integration_id","typeLabel":"string"},"rapidstor_metadata":{"required":["corp_code","s_location_code","tenant_id","i_anniv_days","tenant_default_currency","s_unit_name","account_token","ledger_id","unit_id","i_lease_num","d_sched_out","unit_type_id"],"properties":{"account_token":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.account_token","typeLabel":"string"},"corp_code":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.corp_code","typeLabel":"string"},"d_sched_out":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.d_sched_out","typeLabel":"string"},"i_anniv_days":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.i_anniv_days","typeLabel":"integer\u003cint64>"},"i_lease_num":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.i_lease_num","typeLabel":"string"},"ledger_id":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.ledger_id","typeLabel":"string"},"s_location_code":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.s_location_code","typeLabel":"string"},"s_unit_name":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.s_unit_name","typeLabel":"string"},"tenant_default_currency":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.tenant_default_currency","typeLabel":"string"},"tenant_id":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.tenant_id","typeLabel":"string"},"unit_id":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.unit_id","typeLabel":"string"},"unit_type_id":{"type":"string","isRequired":true,"uniqueKey":"integration_metadata.rapidstor_metadata.unit_type_id","typeLabel":"string"}},"type":"object","uniqueKey":"integration_metadata.rapidstor_metadata","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"integration_metadata","typeLabel":"object"},"is_finverse_autopay_eligible":{"type":"boolean","isRequired":true,"uniqueKey":"is_finverse_autopay_eligible","typeLabel":"boolean"},"sender_details":{"required":["name"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"sender_details.name","typeLabel":"string"}},"type":"object","isRequired":true,"uniqueKey":"sender_details","typeLabel":"object"},"status":{"type":"string","enum":["UNKNOWN","UNPAID","PAID","CANCELLED","FAILED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"},"user_id":{"type":"string","isRequired":true,"uniqueKey":"user_id","typeLabel":"string"},"payments":{"type":"array","items":{"required":["amount","surcharge_amount","amount_total_with_surcharge"],"properties":{"amount":{"description":"Amount of the payment (in minor currency unit)","type":"integer","example":100,"isRequired":true,"uniqueKey":"payments.items.[INDEX].amount","typeLabel":"integer"},"amount_total_with_surcharge":{"description":"Total amount of the payment including any transaction fee `surcharge_amount` paid by the sender (in minor currency unit). See `surcharge_amount` on transaction fee surcharges.","type":"integer","example":100,"isRequired":true,"uniqueKey":"payments.items.[INDEX].amount_total_with_surcharge","typeLabel":"integer"},"surcharge_amount":{"description":"Transaction fee surcharge_amount paid by the sender, if any surcharge has been configured (in minor currency unit). Transaction fee surcharges are off by default, but can be set for specific payment methods, or for custom scenarios (e.g. based on transaction amount, payment flow, etc). Contact [[email protected]](mailto:[email protected]) to configure surcharges.","type":"integer","example":100,"isRequired":true,"uniqueKey":"payments.items.[INDEX].surcharge_amount","typeLabel":"integer"},"created_at":{"description":"Timestamp when the payment was first created","type":"string","format":"date-time","uniqueKey":"payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"currency":{"type":"string","example":"HKD","description":"Currency of the payment (e.g. HKD)","uniqueKey":"payments.items.[INDEX].currency","typeLabel":"string"},"error":{"required":["type","error_code","message","details"],"properties":{"details":{"type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].error.details","typeLabel":"string"},"error_code":{"type":"string","example":"CREDENTIALS_INVALID","isRequired":true,"uniqueKey":"payments.items.[INDEX].error.error_code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].error.message","typeLabel":"string"},"type":{"description":"The error type","type":"string","enum":["LINK_ERROR","API_ERROR"],"example":"LINKING_ERROR","isRequired":true,"uniqueKey":"payments.items.[INDEX].error.type","typeLabel":"enum\u003cstring>"}},"description":"Details on why the payment failed (returned when `status` = `FAILED`). Note: this is used to detail any asynchronous e errors occuring after payment creation; any synchronous errors (e.g. API validation errors, real-time payment errors) will instead be returned directly during `POST /payments`.","type":"object","uniqueKey":"payments.items.[INDEX].error","typeLabel":"object"},"fees":{"type":"array","items":{"required":["amount"],"properties":{"amount":{"description":"Amount of the fee (in minor currency unit)","type":"integer","example":100,"isRequired":true,"uniqueKey":"payments.items.[INDEX].fees.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","example":"HKD","description":"Currency of the fee (e.g. HKD)","uniqueKey":"payments.items.[INDEX].fees.items.[INDEX].currency","typeLabel":"string"},"paid_by":{"type":"string","enum":["RECIPIENT","SENDER"],"example":"RECIPIENT","description":"Party who will be charged the fee. Possible values: `RECIPIENT`, `SENDER`","uniqueKey":"payments.items.[INDEX].fees.items.[INDEX].paid_by","typeLabel":"enum\u003cstring>"},"paid_by_account_id":{"description":"Finverse Payment Account ID of the party who will be charged the fee. This references the `account_id` of either the `recipient_account` or the `sender_account`.","type":"string","example":"The payment account ID","uniqueKey":"payments.items.[INDEX].fees.items.[INDEX].paid_by_account_id","typeLabel":"string"}},"type":"object","uniqueKey":"payments.items.[INDEX].fees.items.[INDEX]","typeLabel":"object"},"description":"Details on the fee(s) to be charged","uniqueKey":"payments.items.[INDEX].fees","typeLabel":"object[]"},"metadata":{"description":"Customer-supplied attributes in key:value format. E.g. `employer_name`: `Apple Inc`","type":"object","additionalProperties":{"type":"string","uniqueKey":"payments.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"payments.items.[INDEX].metadata","typeLabel":"object"},"payment_details":{"properties":{"collection_entity_name":{"type":"string","description":"Name of the legal entity directly collecting the payment. This name may be displayed to users in the Finverse UI and in email notifications and in the sender's bank statements. For payments directly collected by the merchant (e.g. SG eGIRO payments), `collection_entity_name` is typically the merchant's legal entity name, configured by Finverse during customer onboarding. Contact [[email protected]](mailto:[email protected]) to configure your merchant details. For payments collected through Finverse (e.g. HK eDDA payments), `collection_entity_name` will be the same as `processor_entity_name`","uniqueKey":"payments.items.[INDEX].payment_details.collection_entity_name","typeLabel":"string"},"description":{"description":"User-facing description for the payment transaction. SWIFT character set includes the following characters: alphanumeric, space, and symbols `/ - ? : ( ) . , ' +`","type":"string","maxLength":100,"uniqueKey":"payments.items.[INDEX].payment_details.description","typeLabel":"string"},"external_transaction_reference":{"description":"User-facing transaction reference for the payment transaction. SWIFT character set includes the following characters: alphanumeric, space, and symbols / - ? : ( ) . , ' +","type":"string","maxLength":35,"uniqueKey":"payments.items.[INDEX].payment_details.external_transaction_reference","typeLabel":"string"},"mandate_id":{"description":"`mandate_id` from Mandates object. Only returned if `type` = `MANDATE`.","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.mandate_id","typeLabel":"string"},"processor_details":{"properties":{"auth_code":{"type":"string","description":"Authorization code returned by the payment gateway","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.auth_code","typeLabel":"string"},"processor_id":{"type":"string","description":"ID of the payment gateway which processed the payment. Possible values: - `ADYEN`","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.processor_id","typeLabel":"string"},"processor_reference":{"type":"string","description":"Transaction reference returned by the payment gateway","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.processor_reference","typeLabel":"string"},"result":{"properties":{"decline_code":{"description":"Payment processor's decline code (e.g. \"2\")","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.result.decline_code","typeLabel":"string"},"decline_reason":{"description":"Decline reason returned by the payment gateway (if payment was declined)","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.result.decline_reason","typeLabel":"string"},"last_action":{"description":"Last action taken by the payment processor (e.g. \"created\", \"captured\", \"failed\", etc.)","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.result.last_action","typeLabel":"string"},"result_code":{"description":"Payment result code returned by the payment gateway","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.result.result_code","typeLabel":"string"},"status":{"description":"Status of the payment reported by processor (e.g. \"authorized\", \"captured\", \"failed\", etc.)","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.result.status","typeLabel":"string"}},"description":"Additional details on the payment processing result","type":"object","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.result","typeLabel":"object"},"scheme":{"description":"Scheme like becs, bacs, ach, etc. (applicable to Gocardless for now)","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.scheme","typeLabel":"string"},"virtual_account_bank_code":{"description":"Bank code for the virtual account without a BK prefix (e.g. KCP manual virtual account payments).","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.virtual_account_bank_code","typeLabel":"string"},"virtual_account_number":{"description":"Virtual account number issued by the processor (e.g. KCP manual virtual account payments).","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.processor_details.virtual_account_number","typeLabel":"string"}},"description":"Additional details on how the payment was processed","type":"object","uniqueKey":"payments.items.[INDEX].payment_details.processor_details","typeLabel":"object"},"processor_entity_name":{"type":"string","description":"Name of the payment processor (if any) through which payments are collected. This name may be displayed to users in the Finverse UI, in email notifications and in the sender's bank/card statements. For payments directly collected by the merchant (e.g. SG eGIRO payments, most card payments), no `processor_entity_name` is returned. For payments collected through Finverse (e.g. HK eDDA payments), `processor_entity_name` will be Finverse's legal entity name.","uniqueKey":"payments.items.[INDEX].payment_details.processor_entity_name","typeLabel":"string"},"recurring_payment_mode":{"description":"Flag used to identify recurring payment use cases (for which some payment methods can be eligible for discounted pricing). Possible values: - `FIXED_SCHEDULE`: used for subscriptions (fixed schedule, fixed or variable amount) \\- `NON_RECURRING`: used for one-off, user-initiated payments (like an Uber ride or Amazon shopping order) \\- `VARIABLE_RECURRING`: used for variable schedule + amount recurring contracts (e.g. usage based contracts like Cloud / SaaS services, or property rentals with additional adhoc charges for value-added services)","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.recurring_payment_mode","typeLabel":"string"},"references":{"properties":{"bank_transaction_reference":{"type":"string","description":"Unique bank reference ID for the payment.","uniqueKey":"payments.items.[INDEX].payment_details.references.bank_transaction_reference","typeLabel":"string"},"dda_reference":{"type":"string","description":"(Direct debit mandate payments only) Unique reference ID for the Direct Debit Authorization registered with the user's bank, used to authorized the payment. The user's bank may quote this reference in notifications to the user, and in the user's bank statements.","uniqueKey":"payments.items.[INDEX].payment_details.references.dda_reference","typeLabel":"string"},"finverse_transaction_reference":{"type":"string","description":"Finverse-generated unique transaction ID for the payment. This value may be generated and passed to 3rd party payment gateways when using the Finverse `payment_id` is not possible or desirable (e.g. when the transaction reference is user-facing, making a more user-friendly transaction reference preferable).","uniqueKey":"payments.items.[INDEX].payment_details.references.finverse_transaction_reference","typeLabel":"string"}},"description":"Additional references for the Payment (e.g. transaction IDs generated by Finverse or the payment gateway)","type":"object","uniqueKey":"payments.items.[INDEX].payment_details.references","typeLabel":"object"},"transaction_reference_id":{"description":"(DEPRECATED - replaced by `external_transaction_reference`) User-facing transaction reference ID for the payment transaction. SWIFT character set includes the following characters: alphanumeric, space, and symbols `/ - ? : ( ) . , ' +`","type":"string","uniqueKey":"payments.items.[INDEX].payment_details.transaction_reference_id","typeLabel":"string"}},"description":"Details on the payment","type":"object","uniqueKey":"payments.items.[INDEX].payment_details","typeLabel":"object"},"payment_id":{"description":"Finverse Payment ID for this payment. Always unique. Creating a payment with different idempotency keys will result in two payments with different IDs.","type":"string","uniqueKey":"payments.items.[INDEX].payment_id","typeLabel":"string"},"payment_method":{"properties":{"bank_transfer":{"properties":{"bank_transfer_details":{"properties":{"transfer_type":{"description":"The transfer type","type":"string","example":"PayNow","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.bank_transfer_details.transfer_type","typeLabel":"string"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.bank_transfer_details","typeLabel":"object"},"risk_data":{"properties":{"processor_risk_data":{"properties":{"browser_type":{"description":"The browser type","type":"string","example":"Chrome","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.risk_data.processor_risk_data.browser_type","typeLabel":"string"},"device_type":{"description":"The device type","type":"string","example":"Desktop","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.risk_data.processor_risk_data.device_type","typeLabel":"string"},"shopper_country":{"description":"The shopper country","type":"string","example":"HK","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.risk_data.processor_risk_data.shopper_country","typeLabel":"string"},"shopper_ip":{"description":"The shopper IP address","type":"string","example":"127.0.0.1","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.risk_data.processor_risk_data.shopper_ip","typeLabel":"string"},"shopper_locale":{"description":"The shopper locale","type":"string","example":"en-HK","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.risk_data.processor_risk_data.shopper_locale","typeLabel":"string"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.risk_data.processor_risk_data","typeLabel":"object"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer.risk_data","typeLabel":"object"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.bank_transfer","typeLabel":"object"},"card":{"properties":{"card_details":{"properties":{"acquirer_authorization_reference":{"description":"The acquirer authorization reference","type":"string","example":"524506894419","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.acquirer_authorization_reference","typeLabel":"string"},"brand":{"description":"Card brand. Common values: American Express, Diners Club, JCB, Mastercard, UnionPay, Visa.","type":"string","example":"VISA","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.brand","typeLabel":"string"},"brand_product_name":{"description":"The brand product name","type":"string","example":"visacommercialpremiumcredit","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.brand_product_name","typeLabel":"string"},"card_number_alias":{"description":"Unique fingerprint for the card number, if provided by the card payment gateway. The card number alias can be used to check whether the card number is the same (for example across multiple users). Unlike the card `fingerprint`, the card number alias will change if the card is reissued with a new number (e.g. upon card expiry). See also: `fingerprint` field.","type":"string","example":"F046886807590403","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.card_number_alias","typeLabel":"string"},"collection_entity_name":{"type":"string","description":"Name of the legal entity directly collecting the payment. This name may be displayed to users in the Finverse UI and in email notifications and in the sender's card statements. For card payments, `collection_entity_name` is typically the merchant's legal entity name, configured by Finverse during customer onboarding. Contact [[email protected]](mailto:[email protected]) to configure your merchant details.","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.collection_entity_name","typeLabel":"string"},"country":{"description":"Card country of issuance (e.g. \"SG\")","type":"string","example":"HK","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.country","typeLabel":"string"},"expiry_month":{"description":"Card expiry month (e.g. 3 = March)","type":"integer","example":7,"uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.expiry_month","typeLabel":"integer"},"expiry_year":{"description":"4-digit card expiry year (e.g. 2025)","type":"integer","example":2028,"uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.expiry_year","typeLabel":"integer"},"fingerprint":{"type":"string","example":"V0010013822052427221044754993","description":"Unique fingerprint for the card account, if provided by the card payment gateway. The card fingerprint remains the same even when a card expires and a new card is issued with a new card number. The fingerprint can be used to check whether the card is the same (for example across multiple users). See also: `card_number_alias` field.","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.fingerprint","typeLabel":"string"},"finverse_authorization_reference":{"type":"string","description":"Finverse-generated unique ID for the payment method authorization setup. This value may be generated and passed to 3rd party payment gateways when using the Finverse `payment_id` is not possible or desirable (e.g. when the reference is user-facing, making a more user-friendly reference preferable).","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.finverse_authorization_reference","typeLabel":"string"},"funding":{"description":"Card funding type. Possible values: `CREDIT`, `DEBIT`, `PREPAID`, `UNKNOWN`","type":"string","enum":["UNKNOWN","CREDIT","DEBIT","PREPAID"],"uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.funding","typeLabel":"enum\u003cstring>"},"is_commercial":{"oneOf":[{"description":"Whether the card is a commercial card","type":"boolean","example":true,"uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.is_commercial.oneOf.0","typeLabel":"boolean"},{"description":"Whether the card is a commercial card","type":"null","example":true,"uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.is_commercial.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.is_commercial","typeLabel":"boolean | null"},"last4":{"description":"Last 4 digits of the card number","type":"string","example":"1234","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.last4","typeLabel":"string"},"processor_details":{"properties":{"auth_code":{"type":"string","description":"Authorization code returned by the payment gateway","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.processor_details.auth_code","typeLabel":"string"},"network_transaction_reference":{"description":"The network transaction reference","type":"string","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.processor_details.network_transaction_reference","typeLabel":"string"},"processor_id":{"type":"string","description":"ID of the payment gateway which processed the payment method authorization. Possible values: - `ADYEN`","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.processor_details.processor_id","typeLabel":"string"},"processor_reference":{"type":"string","description":"Transaction reference returned by the payment gateway","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.processor_details.processor_reference","typeLabel":"string"},"token_id":{"type":"string","description":"Token ID returned by the payment gateway (for tokenized payment methods)","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.processor_details.token_id","typeLabel":"string"}},"description":"Additional details on how the payment method authorization was processed","type":"object","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.processor_details","typeLabel":"object"},"processor_entity_name":{"type":"string","description":"Name of the payment processor (if any) through which payments are collected. This name may be displayed to users in the Finverse UI, in email notifications and in the sender's bank/card statements. For payments directly collected by the merchant (e.g. SG eGIRO payments, most card payments), no `processor_entity_name` is returned. For payments collected through Finverse (e.g. HK eDDA payments), `processor_entity_name` will be Finverse's legal entity name.","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.processor_entity_name","typeLabel":"string"},"recurring_payment_mode":{"description":"Flag used to identify whether the payment method specifically has been setup for recurring payment use cases (for which some payment methods can be eligible for discounted pricing). Possible values: - `FIXED_SCHEDULE`: used for subscriptions (fixed schedule, fixed or variable amount) \\- `NON_RECURRING`: used for one-off, user-initiated payments (like an Uber ride or Amazon shopping order) \\- `VARIABLE_RECURRING`: used for variable schedule + amount recurring contracts (e.g. usage based contracts like Cloud / SaaS services, or property rentals with additional adhoc charges for value-added services)","type":"string","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details.recurring_payment_mode","typeLabel":"string"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.card.card_details","typeLabel":"object"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.card","typeLabel":"object"},"wallet":{"properties":{"risk_data":{"properties":{"processor_risk_data":{"properties":{"browser_type":{"description":"The browser type","type":"string","example":"Chrome","uniqueKey":"payments.items.[INDEX].payment_method.wallet.risk_data.processor_risk_data.browser_type","typeLabel":"string"},"device_type":{"description":"The device type","type":"string","example":"Desktop","uniqueKey":"payments.items.[INDEX].payment_method.wallet.risk_data.processor_risk_data.device_type","typeLabel":"string"},"shopper_country":{"description":"The shopper country","type":"string","example":"HK","uniqueKey":"payments.items.[INDEX].payment_method.wallet.risk_data.processor_risk_data.shopper_country","typeLabel":"string"},"shopper_ip":{"description":"The shopper IP address","type":"string","example":"127.0.0.1","uniqueKey":"payments.items.[INDEX].payment_method.wallet.risk_data.processor_risk_data.shopper_ip","typeLabel":"string"},"shopper_locale":{"description":"The shopper locale","type":"string","example":"en-HK","uniqueKey":"payments.items.[INDEX].payment_method.wallet.risk_data.processor_risk_data.shopper_locale","typeLabel":"string"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.wallet.risk_data.processor_risk_data","typeLabel":"object"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.wallet.risk_data","typeLabel":"object"},"wallet_details":{"properties":{"brand":{"description":"The wallet brand","type":"string","example":"Alipay","uniqueKey":"payments.items.[INDEX].payment_method.wallet.wallet_details.brand","typeLabel":"string"},"brand_product_name":{"description":"The brand product name","type":"string","example":"alipay_hk","uniqueKey":"payments.items.[INDEX].payment_method.wallet.wallet_details.brand_product_name","typeLabel":"string"},"country":{"description":"The issuer country","type":"string","example":"HK","uniqueKey":"payments.items.[INDEX].payment_method.wallet.wallet_details.country","typeLabel":"string"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.wallet.wallet_details","typeLabel":"object"}},"type":"object","uniqueKey":"payments.items.[INDEX].payment_method.wallet","typeLabel":"object"}},"description":"Details on the payment method","type":"object","uniqueKey":"payments.items.[INDEX].payment_method","typeLabel":"object"},"payment_method_id":{"description":"(TO BE DEPRECATED) Finverse unique ID for the payment method","type":"string","uniqueKey":"payments.items.[INDEX].payment_method_id","typeLabel":"string"},"recipient":{"required":["name"],"properties":{"name":{"description":"Merchant account name","type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].recipient.name","typeLabel":"string"}},"description":"Details on the recipient of the payment","type":"object","uniqueKey":"payments.items.[INDEX].recipient","typeLabel":"object"},"recipient_account":{"required":["account_id","account_type"],"properties":{"account_id":{"description":"Merchant account ID assigned by Finverse","type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].recipient_account.account_id","typeLabel":"string"},"account_type":{"description":"Type of recipient account.","type":"string","enum":["EXTERNAL_ACCOUNT","SETTLEMENT_ACCOUNT"],"example":"SETTLEMENT_ACCOUNT","isRequired":true,"uniqueKey":"payments.items.[INDEX].recipient_account.account_type","typeLabel":"enum\u003cstring>"}},"description":"Details on the recipient's account for the payment (i.e. the Customer App's settlement account at Finverse)","type":"object","uniqueKey":"payments.items.[INDEX].recipient_account","typeLabel":"object"},"sender":{"required":["user_id","external_user_id","user_type"],"properties":{"external_user_id":{"description":"Customer App's user ID, representing the end-user making the payment.","type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].sender.external_user_id","typeLabel":"string"},"user_id":{"description":"A unique identifier generated after creating sender","type":"string","isRequired":true,"uniqueKey":"payments.items.[INDEX].sender.user_id","typeLabel":"string"},"user_type":{"description":"Type of account held by the Sender at the Institution. Possible values are INDIVIDUAL, BUSINESS","type":"string","enum":["INDIVIDUAL","BUSINESS"],"isRequired":true,"uniqueKey":"payments.items.[INDEX].sender.user_type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","uniqueKey":"payments.items.[INDEX].sender.name","typeLabel":"string"},"user_details":{"description":"Sender details which will be used for fraud checking.","type":"array","items":{"properties":{"details_type":{"description":"Type of the user identity information submitted. Possible values: `HK_ID`, `PASSPORT`, `HK_BUSINESS_REGISTRATION`, `HK_CERTIFICATE_OF_INCORPORATION`, `ACCOUNTHOLDER_NAME`","type":"string","enum":["HK_ID","PASSPORT","HK_BUSINESS_REGISTRATION","HK_CERTIFICATE_OF_INCORPORATION"],"uniqueKey":"payments.items.[INDEX].sender.user_details.items.[INDEX].details_type","typeLabel":"enum\u003cstring>"},"values":{"description":"Value(s) of the user identity information submitted. Min 1 value required, max 10 values. Values in responses are tokenized by Finverse.","type":"array","maxItems":10,"items":{"type":"string","uniqueKey":"payments.items.[INDEX].sender.user_details.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payments.items.[INDEX].sender.user_details.items.[INDEX].values","typeLabel":"string[]"}},"type":"object","uniqueKey":"payments.items.[INDEX].sender.user_details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payments.items.[INDEX].sender.user_details","typeLabel":"object[]"}},"description":"Details on the sender of the payment","type":"object","uniqueKey":"payments.items.[INDEX].sender","typeLabel":"object"},"sender_account":{"type":"object","properties":{"account_id":{"description":"A unique identifier generated after creating sender account","type":"string","example":"sender_account_id","uniqueKey":"payments.items.[INDEX].sender_account.account_id","typeLabel":"string"},"account_number":{"type":"object","required":["type","number"],"properties":{"number":{"description":"Account number. Account numbers in responses are tokenized by Finverse.","type":"string","maxLength":100,"minLength":1,"isRequired":true,"uniqueKey":"payments.items.[INDEX].sender_account.account_number.number","typeLabel":"string"},"type":{"description":"Type of account number format. Possible values: `IBAN`, `LOCAL`","type":"string","enum":["LOCAL","IBAN"],"isRequired":true,"uniqueKey":"payments.items.[INDEX].sender_account.account_number.type","typeLabel":"enum\u003cstring>"},"number_plaintext":{"oneOf":[{"description":"Account number in plaintext","type":"string","maxLength":100,"minLength":1,"uniqueKey":"payments.items.[INDEX].sender_account.account_number.number_plaintext.oneOf.0","typeLabel":"string"},{"description":"Account number in plaintext","type":"null","maxLength":100,"minLength":1,"uniqueKey":"payments.items.[INDEX].sender_account.account_number.number_plaintext.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].sender_account.account_number.number_plaintext","typeLabel":"string | null"}},"description":"Bank account number details, including account number in plaintext","uniqueKey":"payments.items.[INDEX].sender_account.account_number","typeLabel":"object"},"account_number_masked":{"description":"Masked Account number of the sender’s account","type":"string","uniqueKey":"payments.items.[INDEX].sender_account.account_number_masked","typeLabel":"string"},"account_type":{"description":"Type of sender account.","type":"string","enum":["EXTERNAL_ACCOUNT"],"example":"EXTERNAL_ACCOUNT","uniqueKey":"payments.items.[INDEX].sender_account.account_type","typeLabel":"enum\u003cstring>"},"accountholder_name":{"description":"Tokenized accountholder name of the sender's account","type":"string","example":"01EP4A1MZDHKETZFRPF0K62S6S","uniqueKey":"payments.items.[INDEX].sender_account.accountholder_name","typeLabel":"string"},"accountholder_name_plaintext":{"oneOf":[{"description":"Accountholder name in plaintext.","type":"string","example":"Chan Li Pak","uniqueKey":"payments.items.[INDEX].sender_account.accountholder_name_plaintext.oneOf.0","typeLabel":"string"},{"description":"Accountholder name in plaintext.","type":"null","example":"Chan Li Pak","uniqueKey":"payments.items.[INDEX].sender_account.accountholder_name_plaintext.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].sender_account.accountholder_name_plaintext","typeLabel":"string | null"},"bank_code":{"type":"string","uniqueKey":"payments.items.[INDEX].sender_account.bank_code","typeLabel":"string"},"institution_id":{"description":"Finverse Institution ID for the sender’s institution.","type":"string","example":"hsbc-hk","uniqueKey":"payments.items.[INDEX].sender_account.institution_id","typeLabel":"string"},"institution_name":{"description":"Institution Name for the sender’s institution.","type":"string","example":"HSBC","uniqueKey":"payments.items.[INDEX].sender_account.institution_name","typeLabel":"string"},"metadata":{"description":"Additional attributes of the sender account in key:value format (e.g. sender_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 1000 characters respectively.","type":"object","additionalProperties":{"type":"string","uniqueKey":"payments.items.[INDEX].sender_account.metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"payments.items.[INDEX].sender_account.metadata","typeLabel":"object"},"user_id":{"description":"A unique identifier generated after creating sender (Finverse Payment User ID)","type":"string","example":"01GY6H0JA7BS8EVGY56NSHFX2E","uniqueKey":"payments.items.[INDEX].sender_account.user_id","typeLabel":"string"}},"description":"(IN DEVELOPMENT) Details on the Sender's source institution and account, which is funding the payment","uniqueKey":"payments.items.[INDEX].sender_account","typeLabel":"object"},"status":{"description":"Current status of the payment. Possible values: `CREATED`, `AUTHORIZATION_REQUIRED`, `PROCESSING`, `SUBMITTED, EXECUTED`, `CANCELLED`, `FAILED`","type":"string","enum":["AUTHORIZATION_REQUIRED","AUTHORIZING","PROCESSING","SUBMITTED","EXECUTED","FAILED","REVOKED","CANCELLED","CREATED"],"uniqueKey":"payments.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"description":"Specified payment type. Possible values: - `CARD`: payment via card gateway (e.g. Stripe) \\- `MANDATE`: direct debit bank payment \\- `MANUAL`: manual bank transfer (e.g. FPS, PayNow) \\- `SINGLE`: not used (reserved for future use)","type":"string","enum":["MANDATE","SINGLE","CARD","MANUAL","WALLET"],"uniqueKey":"payments.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Timestamp of the last update to the payment's record","type":"string","format":"date-time","uniqueKey":"payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"type":"object","uniqueKey":"payments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payments","typeLabel":"object[]"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"bill_date":"2023-11-07T05:31:56Z","bill_id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","customer_app_id":"\u003cstring>","details":{"bill_reference_id":"\u003cstring>","currency":"\u003cstring>","total_amount_due":123,"description":"\u003cstring>"},"due_date":"2023-11-07T05:31:56Z","external_bill_id":"\u003cstring>","external_user_id":"\u003cstring>","integration_id":"\u003cstring>","integration_metadata":{"integration_id":"\u003cstring>","rapidstor_metadata":{"account_token":"\u003cstring>","corp_code":"\u003cstring>","d_sched_out":"\u003cstring>","i_anniv_days":123,"i_lease_num":"\u003cstring>","ledger_id":"\u003cstring>","s_location_code":"\u003cstring>","s_unit_name":"\u003cstring>","tenant_default_currency":"\u003cstring>","tenant_id":"\u003cstring>","unit_id":"\u003cstring>","unit_type_id":"\u003cstring>"}},"is_finverse_autopay_eligible":true,"sender_details":{"name":"\u003cstring>"},"status":"UNKNOWN","updated_at":"2023-11-07T05:31:56Z","user_id":"\u003cstring>","payments":[{"amount":100,"amount_total_with_surcharge":100,"surcharge_amount":100,"created_at":"2023-11-07T05:31:56Z","currency":"HKD","error":{"details":"\u003cstring>","error_code":"CREDENTIALS_INVALID","message":"\u003cstring>","type":"LINKING_ERROR"},"fees":[{"amount":100,"currency":"HKD","paid_by":"RECIPIENT","paid_by_account_id":"The payment account ID"}],"metadata":{},"payment_details":{"collection_entity_name":"\u003cstring>","description":"\u003cstring>","external_transaction_reference":"\u003cstring>","mandate_id":"\u003cstring>","processor_details":{"auth_code":"\u003cstring>","processor_id":"\u003cstring>","processor_reference":"\u003cstring>","result":{"decline_code":"\u003cstring>","decline_reason":"\u003cstring>","last_action":"\u003cstring>","result_code":"\u003cstring>","status":"\u003cstring>"},"scheme":"\u003cstring>","virtual_account_bank_code":"\u003cstring>","virtual_account_number":"\u003cstring>"},"processor_entity_name":"\u003cstring>","recurring_payment_mode":"\u003cstring>","references":{"bank_transaction_reference":"\u003cstring>","dda_reference":"\u003cstring>","finverse_transaction_reference":"\u003cstring>"},"transaction_reference_id":"\u003cstring>"},"payment_id":"\u003cstring>","payment_method":{"bank_transfer":{"bank_transfer_details":{"transfer_type":"PayNow"},"risk_data":{"processor_risk_data":{"browser_type":"Chrome","device_type":"Desktop","shopper_country":"HK","shopper_ip":"127.0.0.1","shopper_locale":"en-HK"}}},"card":{"card_details":{"acquirer_authorization_reference":"524506894419","brand":"VISA","brand_product_name":"visacommercialpremiumcredit","card_number_alias":"F046886807590403","collection_entity_name":"\u003cstring>","country":"HK","expiry_month":7,"expiry_year":2028,"fingerprint":"V0010013822052427221044754993","finverse_authorization_reference":"\u003cstring>","funding":"UNKNOWN","is_commercial":true,"last4":"1234","processor_details":{"auth_code":"\u003cstring>","network_transaction_reference":"\u003cstring>","processor_id":"\u003cstring>","processor_reference":"\u003cstring>","token_id":"\u003cstring>"},"processor_entity_name":"\u003cstring>","recurring_payment_mode":"\u003cstring>"}},"wallet":{"risk_data":{"processor_risk_data":{"browser_type":"Chrome","device_type":"Desktop","shopper_country":"HK","shopper_ip":"127.0.0.1","shopper_locale":"en-HK"}},"wallet_details":{"brand":"Alipay","brand_product_name":"alipay_hk","country":"HK"}}},"payment_method_id":"\u003cstring>","recipient":{"name":"\u003cstring>"},"recipient_account":{"account_id":"\u003cstring>","account_type":"SETTLEMENT_ACCOUNT"},"sender":{"external_user_id":"\u003cstring>","user_id":"\u003cstring>","user_type":"INDIVIDUAL","name":"\u003cstring>","user_details":[{"details_type":"HK_ID","values":["\u003cstring>"]}]},"sender_account":{"account_id":"sender_account_id","account_number":{"number":"\u003cstring>","type":"LOCAL","number_plaintext":"\u003cstring>"},"account_number_masked":"\u003cstring>","account_type":"EXTERNAL_ACCOUNT","accountholder_name":"01EP4A1MZDHKETZFRPF0K62S6S","accountholder_name_plaintext":"Chan Li Pak","bank_code":"\u003cstring>","institution_id":"hsbc-hk","institution_name":"HSBC","metadata":{},"user_id":"01GY6H0JA7BS8EVGY56NSHFX2E"},"status":"AUTHORIZATION_REQUIRED","type":"MANDATE","updated_at":"2023-11-07T05:31:56Z"}],"metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"7c6b5a0d-be2f-4fb6-b98f-2a3dd47c350b":{"description":"Invalid Request","content":{"application/json":{"schema":{"properties":{"error":{"required":["type","error_code","message","details","request_id"],"properties":{"details":{"type":"string","isRequired":true,"uniqueKey":"error.details","typeLabel":"string"},"error_code":{"type":"string","example":"CREDENTIALS_INVALID","isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"description":"The request_id provided in the request header","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"description":"The error type","type":"string","enum":["LINK_ERROR","API_ERROR"],"example":"LINKING_ERROR","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"details":"\u003cstring>","error_code":"CREDENTIALS_INVALID","message":"\u003cstring>","request_id":"\u003cstring>","type":"LINKING_ERROR"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c6f6dc3a-290c-4774-af69-986e131405c2":{"Oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://finverse-dev.us.auth0.com/oauth/token","scopes":{"account":"Account","balance":"Balance","credit":"Credit","institution":"Institution","investment":"Investment","link":"Link","test":"Test","transaction":"Transaction"}}},"scopes":["bill:get"]}}},"servers":{"3f78a58c-f65d-4e0f-a44d-f9cae58dc18d":{"url":"https://api.prod.finverse.net"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://finverse-dev.us.auth0.com/oauth/token","scopes":{"account":"Account","balance":"Balance","credit":"Credit","institution":"Institution","investment":"Investment","link":"Link","test":"Test","transaction":"Transaction"}}},"scopes":["bill:get"]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Oauth2","name":"Authorization"}],"title":"Oauth2"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"finverse","siteName":"Finverse API","title":"Get bill - Finverse API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-30T09:08:24.677Z","originalFileLocation":"api-reference/bills/get-bill.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=\"Get a bill by ID\">\u003cmeta data-mint-head name=\"application-name\" content=\"Finverse API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get bill - Finverse API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a bill by ID\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finverse API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs2.finverse.com/api-reference/bills/get-bill\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://finverse.mintlify.site/_mintlify/api/og/v2?division=Bills\u0026amp;title=Get+bill\u0026amp;description=Get+a+bill+by+ID\u0026amp;theme=cbf26bae0487384b20dc51fd\u0026amp;signature=4bfd4c368383ea2e57d913d6d0943b7bf50859a3dc71d6b24acfce0c3bbf0c93\">\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=\"Get bill - Finverse API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a bill by ID\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finverse.mintlify.site/_mintlify/api/og/v2?division=Bills\u0026amp;title=Get+bill\u0026amp;description=Get+a+bill+by+ID\u0026amp;theme=cbf26bae0487384b20dc51fd\u0026amp;signature=4bfd4c368383ea2e57d913d6d0943b7bf50859a3dc71d6b24acfce0c3bbf0c93\">\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/finverse/ESTMJRewM2q7nXhG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Finverse API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#009FFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs2.finverse.com/api-reference/bills/get-bill\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/bills/get-bill.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs2.finverse.com/#organization\",\"name\":\"Finverse API\",\"url\":\"https://docs2.finverse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/finverse/FcXUy2q84UCP-2qv/images/logo.svg?fit=max\u0026auto=format\u0026n=FcXUy2q84UCP-2qv\u0026q=85\u0026s=9fa78eb1508e7498cbf28f6ec85c2b48\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs2.finverse.com#website\",\"name\":\"Finverse API\",\"url\":\"https://docs2.finverse.com\",\"publisher\":{\"@id\":\"https://docs2.finverse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs2.finverse.com/api-reference/bills/get-bill#webpage\",\"url\":\"https://docs2.finverse.com/api-reference/bills/get-bill\",\"name\":\"Get bill\",\"description\":\"Get a bill by ID\",\"dateModified\":\"2026-06-30T09:08:24.677Z\",\"isPartOf\":{\"@id\":\"https://docs2.finverse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs2.finverse.com/api-reference/bills/get-bill#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs2.finverse.com/api-reference/bills/get-bill#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs2.finverse.com/api-reference/accounts/get-account-number\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Bills\",\"item\":\"https://docs2.finverse.com/api-reference/bills/list-bills\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get bill\",\"item\":\"https://docs2.finverse.com/api-reference/bills/get-bill\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs2.finverse.com/api-reference/bills/get-bill#apireference\",\"headline\":\"Get bill\",\"name\":\"Get bill\",\"description\":\"Get a bill by ID\",\"url\":\"https://docs2.finverse.com/api-reference/bills/get-bill\",\"mainEntityOfPage\":{\"@id\":\"https://docs2.finverse.com/api-reference/bills/get-bill#webpage\"},\"dateModified\":\"2026-06-30T09:08:24.677Z\",\"publisher\":{\"@id\":\"https://docs2.finverse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs2.finverse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Finverse API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Finverse API","nav":{"global":null,"groups":[{"group":"API Reference","pages":[{"group":"Accounts","pages":[{"title":"Get account number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /account_numbers/{accountId}","href":"/api-reference/accounts/get-account-number"},{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Get account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts/{accountId}","href":"/api-reference/accounts/get-account"},{"title":"Get balance history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /balance_history/{accountId}","href":"/api-reference/accounts/get-balance-history"},{"title":"List card details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card_details","href":"/api-reference/accounts/list-card-details"}]},{"group":"Public","pages":[{"title":"Generate customer_token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/customer/token","href":"/api-reference/public/generate-customer_token"},{"title":"Get cred submit jwks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /jwks","href":"/api-reference/public/get-cred-submit-jwks"},{"title":"Get payments jwks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments/jwks","href":"/api-reference/public/get-payments-jwks"}]},{"group":"Link","pages":[{"title":"Exchange Link Code for login_identity_token and login_identity_id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/token","href":"/api-reference/link/exchange-link-code-for-login_identity_token-and-login_identity_id"},{"title":"Create link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /link","href":"/api-reference/link/create-link"},{"title":"Retrieve link/refresh status - for user-present refresh only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /link/action/{loginIdentityId}","href":"/api-reference/link/retrieve-linkrefresh-status--for-user-present-refresh-only"},{"title":"Relink v2","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /link/relink/{loginIdentityId}","href":"/api-reference/link/relink-v2"},{"title":"Link status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /link/status/{loginIdentityId}","href":"/api-reference/link/link-status"},{"title":"Generate link_url","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /link/token","href":"/api-reference/link/generate-link_url"}]},{"group":"Customer","pages":[{"title":"Refresh login_identity_token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/token/refresh","href":"/api-reference/customer/refresh-login_identity_token"},{"title":"Retrieve Institutions list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /institutions","href":"/api-reference/customer/retrieve-institutions-list"},{"title":"Get institutions for customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /institutions/customer","href":"/api-reference/customer/get-institutions-for-customer"},{"title":"Get institution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /institutions/{institutionId}","href":"/api-reference/customer/get-institution"}]},{"group":"Bills","pages":[{"title":"List bills","description":"List bills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bills","href":"/api-reference/bills/list-bills"},{"title":"Get bill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bills/{billId}","href":"/api-reference/bills/get-bill"}]},{"group":"Statements","pages":[{"title":"Get composite statement","description":"Retrieve the Composite Statement in .zip format. By default, this request returns a redirect (HTTP 307 code) to a temporary Composite Statement URL (valid for 15min).\n\nAuthorization: `login_identity_token`\n\n## Optional parameters\n\n### Redirect mode for Composite Statement URL\n\nURL parameter: `redirect`\n\n(e.g. GET /composite_statement?redirect=false)\n\nDescription: Toggles the behaviour for how Composite Statement URLs are returned.\n\nRecommended value: omit. This results in the default behaviour (`redirect=true`).\n\nAccepted values:","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /composite_statement","href":"/api-reference/statements/get-composite-statement"},{"title":"Get statements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /statements","href":"/api-reference/statements/get-statements"},{"title":"Get statement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /statements/{statementId}","href":"/api-reference/statements/get-statement"}]},{"group":"Disputes","pages":[{"title":"List Disputes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /disputes","href":"/api-reference/disputes/list-disputes"}]},{"group":"Identity \u0026 income","pages":[{"title":"Get identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /identity","href":"/api-reference/identity_income/get-identity"},{"title":"Get income estimate by login identity id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /income","href":"/api-reference/identity_income/get-income-estimate-by-login-identity-id"}]},{"group":"Ledger","pages":[{"title":"Generate Finverse statement CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ledger/statement","href":"/api-reference/ledger/generate-finverse-statement-csv"}]},{"group":"Login identity","pages":[{"title":"Get login identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /login_identity","href":"/api-reference/login_identity/get-login-identity"},{"title":"Unlink Login Identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /login_identity","href":"/api-reference/login_identity/unlink-login-identity"},{"title":"login_identity/refresh (User-present data refresh)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /login_identity/refresh","href":"/api-reference/login_identity/login_identityrefresh-user-present-data-refresh"},{"title":"Get login identity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /login_identity/{loginIdentityId}","href":"/api-reference/login_identity/get-login-identity-by-id"},{"title":"Get login identity history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /login_identity/{loginIdentityId}/history","href":"/api-reference/login_identity/get-login-identity-history"}]},{"group":"Mandates","pages":[{"title":"List Mandates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates","href":"/api-reference/mandates/list-mandates"},{"title":"Create Mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates","href":"/api-reference/mandates/create-mandate"},{"title":"Get mandate auth","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates/auth","href":"/api-reference/mandates/get-mandate-auth"},{"title":"Submit auth checklist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/auth","href":"/api-reference/mandates/submit-auth-checklist"},{"title":"List Mandates including plaintext sensitive account data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates/details","href":"/api-reference/mandates/list-mandates-including-plaintext-sensitive-account-data"},{"title":"Set mandate institution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/institution_selection","href":"/api-reference/mandates/set-mandate-institution"},{"title":"Generate link_url","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/link","href":"/api-reference/mandates/generate-link_url"},{"title":"Create Mandate with existing Sender Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/sender_account","href":"/api-reference/mandates/create-mandate-with-existing-sender-account"},{"title":"Get mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates/{mandateId}","href":"/api-reference/mandates/get-mandate"},{"title":"Authorize Mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/{mandateId}/authorize","href":"/api-reference/mandates/authorize-mandate"}]},{"group":"Payment accounts","pages":[{"title":"List Payment Accounts for Customer App, with payment method overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_accounts","href":"/api-reference/payment_accounts/list-payment-accounts-for-customer-app-with-payment-method-overview"},{"title":"Create Payment Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_accounts","href":"/api-reference/payment_accounts/create-payment-account"},{"title":"Delete Payment Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /payment_accounts/{paymentAccountId}","href":"/api-reference/payment_accounts/delete-payment-account"}]},{"group":"Payment links","pages":[{"title":"Get adyen card setup payment methods","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_link/fvlink/adyen/payment_methods","href":"/api-reference/payment_links/get-adyen-card-setup-payment-methods"},{"title":"Submit adyen card setup payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_link/fvlink/adyen/payments","href":"/api-reference/payment_links/submit-adyen-card-setup-payment"},{"title":"Submit adyen card setup payment details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_link/fvlink/adyen/payments/details","href":"/api-reference/payment_links/submit-adyen-card-setup-payment-details"},{"title":"Create Payment Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_links","href":"/api-reference/payment_links/create-payment-link"},{"title":"Complete kcp payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_links/kcp/payment","href":"/api-reference/payment_links/complete-kcp-payment"},{"title":"Get Payment Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_links/{paymentLinkId}","href":"/api-reference/payment_links/get-payment-link"},{"title":"Cancel Payment Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_links/{paymentLinkId}/cancel","href":"/api-reference/payment_links/cancel-payment-link"}]},{"group":"Payment methods","pages":[{"title":"Get Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_methods/{paymentMethodId}","href":"/api-reference/payment_methods/get-payment-method"},{"title":"Cancel Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_methods/{paymentMethodId}/cancel","href":"/api-reference/payment_methods/cancel-payment-method"}]},{"group":"Payment users","pages":[{"title":"Create Payment User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_users","href":"/api-reference/payment_users/create-payment-user"},{"title":"Get Payment User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_users/{paymentUserId}","href":"/api-reference/payment_users/get-payment-user"},{"title":"Update Payment User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_users/{paymentUserId}","href":"/api-reference/payment_users/update-payment-user"},{"title":"List Payment Accounts for a Payment User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_users/{paymentUserId}/payment_accounts","href":"/api-reference/payment_users/list-payment-accounts-for-a-payment-user"},{"title":"Get Payment Methods by User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_users/{paymentUserId}/payment_methods","href":"/api-reference/payment_users/get-payment-methods-by-user"},{"title":"Create Payment Method: direct debit mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_users/{paymentUserId}/payment_methods","href":"/api-reference/payment_users/create-payment-method:-direct-debit-mandate"}]},{"group":"Payment operations","pages":[{"title":"List Payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments","href":"/api-reference/payments/list-payments"},{"title":"Create Payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payments","href":"/api-reference/payments/create-payment"},{"title":"Get payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments/{paymentId}","href":"/api-reference/payments/get-payment"},{"title":"Update Payment metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payments/{paymentId}","href":"/api-reference/payments/update-payment-metadata"},{"title":"Update Manual Payment status","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /testing/payments/{paymentId}/status","href":"/api-reference/payments/update-manual-payment-status"}]},{"group":"Payouts","pages":[{"title":"List Payouts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payouts","href":"/api-reference/payouts/list-payouts"},{"title":"Get payout by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payouts/{payoutId}","href":"/api-reference/payouts/get-payout-by-id"},{"title":"Cancel payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payouts/{payoutId}/cancel","href":"/api-reference/payouts/cancel-payout"}]},{"group":"payment","pages":[{"title":"Create a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payouts","href":"/api-reference/payment/create-a-payout"},{"title":"Confirm a payout that was created with confirm = false, submitting it for processing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payouts/{payoutId}/confirm","href":"/api-reference/payment/confirm-a-payout-that-was-created-with-confirm-=-false-submitting-it-for-processing"}]},{"group":"Transactions","pages":[{"title":"List transactions by login identity id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions","href":"/api-reference/transactions/list-transactions-by-login-identity-id"},{"title":"List transactions by account id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions/{accountId}","href":"/api-reference/transactions/list-transactions-by-account-id"}]},{"group":"API Reference","pages":[{"title":"Trigger delayed error (during bank processing)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /scenario/{mandate_id}","href":"/api-reference/trigger-delayed-error-during-bank-processing"}]}]}]},"basePath":"","title":"Get bill - Finverse API","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}