List of Mandate objects that satisfy the filters in the request. Refer to Mandate object data model in GET /mandates/{mandate_id}
Show child attributes
{"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/mandates/list-mandates","slug":"/api-reference/mandates/list-mandates","pageMetadata":{"title":"List Mandates","description":"List Mandates associated with a Customer App.\n\n**Authorization**: `customer_token`\n\n## URL query parameters\n\nThe following optional URL query parameters can be used to filter the list of items to be returned.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates","href":"/api-reference/mandates/list-mandates","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h2: \"h2\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"List Mandates associated with a Customer App.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Authorization\"\n }), \": \", _jsx(_components.code, {\n children: \"customer_token\"\n })]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"URL query parameters\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The following optional URL query parameters can be used to filter the list of items to be returned.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Mandates","description":"List Mandates associated with a Customer App.\n\n**Authorization**: `customer_token`\n\n## URL query parameters\n\nThe following optional URL query parameters can be used to filter the list of items to be returned.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates","href":"/api-reference/mandates/list-mandates","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["730c2a8f-a26b-415d-a72b-8209f0f42f7f"],"description":"List Mandates associated with a Customer App.\n\n**Authorization**: `customer_token`\n\n## URL query parameters\n\nThe following optional URL query parameters can be used to filter the list of items to be returned.","tags":["mandates"],"operationId":"listMandates","parameters":["b0141709-106b-4020-89e2-444468433bda","6c1ecb71-5872-435c-8c80-eab6ba300ee2","dc188904-4fd5-411a-b073-fc7bb9ed3c08","52c67aa6-fc04-4d4c-a814-feffceba8924","3e36c683-b62b-4eea-a5da-19d2183ea378","ce90a4aa-fcc9-4fcf-87a8-3a9473aa38df","5f056550-64ce-4a42-a518-dace062bb1e7","ceaf4247-cb12-443a-b68c-2c86d80eedde"],"responses":{"200":"e315438d-5e17-4ed8-a2a6-a1ee580e7797","400":"15cf415c-3c0a-4f9e-8594-84e4b4f0ad3b","401":"d2eea56a-bcdd-4eac-a587-3a2db0757288","500":"256eb2bb-3b26-4d8d-9580-f414a080b7b4"},"summary":"List Mandates","method":"get","type":"path","servers":["3f78a58c-f65d-4e0f-a44d-f9cae58dc18d"],"path":"/mandates","baseUrlOptions":["https://api.prod.finverse.net"],"title":"List Mandates","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b0141709-106b-4020-89e2-444468433bda":{"description":"Start date for filtering (applied to Mandate `updated_at` field)","name":"date_from","in":"query","schema":{"type":"string","format":"date","description":"Start date for filtering (applied to Mandate `updated_at` field)","uniqueKey":"","typeLabel":"string\u003cdate>"}},"6c1ecb71-5872-435c-8c80-eab6ba300ee2":{"description":"End date for filtering (applied to Mandate `updated_at` field)","name":"date_to","in":"query","schema":{"type":"string","format":"date","description":"End date for filtering (applied to Mandate `updated_at` field)","uniqueKey":"","typeLabel":"string\u003cdate>"}},"dc188904-4fd5-411a-b073-fc7bb9ed3c08":{"description":"Comma-separated filter for specific Mandate statuses. Example: `statuses=SUCCEEDED,FAILED` Refer to mandate statuses in `GET /mandates/{mandate_id}`","name":"statuses","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"enum":["AUTHORIZATION_REQUIRED","AUTHORIZING","PROCESSING","SUBMITTED","SUCCEEDED","FAILED","REVOKED","READY_TO_SUBMIT","CLOSED","CANCELLED"],"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Comma-separated filter for specific Mandate statuses. Example: `statuses=SUCCEEDED,FAILED` Refer to mandate statuses in `GET /mandates/{mandate_id}`","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"52c67aa6-fc04-4d4c-a814-feffceba8924":{"description":"Filter for a specific sender type. Refer to Mandate sender_type in `GET /mandates/{mandate_id}`","name":"sender_type","in":"query","schema":{"type":"string","enum":["INDIVIDUAL","BUSINESS"],"description":"Filter for a specific sender type. Refer to Mandate sender_type in `GET /mandates/{mandate_id}`","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"3e36c683-b62b-4eea-a5da-19d2183ea378":{"description":"The user_id the mandate was setup for","name":"user_id","in":"query","schema":{"type":"string","description":"The user_id the mandate was setup for","uniqueKey":"","typeLabel":"string"}},"ce90a4aa-fcc9-4fcf-87a8-3a9473aa38df":{"description":"Filter for a specific Institution ID","name":"institution_id","in":"query","schema":{"type":"string","description":"Filter for a specific Institution ID","uniqueKey":"","typeLabel":"string"}},"5f056550-64ce-4a42-a518-dace062bb1e7":{"description":"Pagination offset (default: 0)","name":"offset","in":"query","schema":{"type":"integer","default":0,"description":"Pagination offset (default: 0)","uniqueKey":"","typeLabel":"integer"}},"ceaf4247-cb12-443a-b68c-2c86d80eedde":{"description":"Maximum number of records per page (default: 500, max: 1000)","name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000,"default":500,"description":"Maximum number of records per page (default: 500, max: 1000)","uniqueKey":"","typeLabel":"integer"}}},"responses":{"e315438d-5e17-4ed8-a2a6-a1ee580e7797":{"description":"Successful","content":{"application/json":{"schema":{"required":["total_mandates"],"properties":{"total_mandates":{"type":"integer","description":"Total number of Mandate records available for the selected filtering criteria (can be used to inform pagination requests)","isRequired":true,"uniqueKey":"total_mandates","typeLabel":"integer"},"mandates":{"type":"array","items":{"required":["updated_at","mandate_id","status","recipient","sender","mandate_details"],"properties":{"mandate_details":{"required":["currency"],"properties":{"currency":{"description":"Currency of the mandate (e.g. HKD)","type":"string","isRequired":true,"uniqueKey":"mandates.items.[INDEX].mandate_details.currency","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 bank statements. For direct debit 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 direct debit payments collected through Finverse (e.g. HK eDDA payments), `collection_entity_name` will be the same as `processor_entity_name`","uniqueKey":"mandates.items.[INDEX].mandate_details.collection_entity_name","typeLabel":"string"},"dda_reference":{"description":"Unique reference ID for the Direct Debit Authorization registered with the user's bank. The user's bank may quote this reference in notifications to the user, and in direct debit payment records on the user's bank statements.","type":"string","uniqueKey":"mandates.items.[INDEX].mandate_details.dda_reference","typeLabel":"string"},"description":{"description":"User-facing description for the mandate","type":"string","uniqueKey":"mandates.items.[INDEX].mandate_details.description","typeLabel":"string"},"end_date":{"oneOf":[{"description":"Expiration date of the mandate, e.g. `2022-12-31`. Payment requests will be allowed up to this date (inclusive). All date inputs assume UTC times (e.g. if `end_date` = `2022-12-31`, then a payment will be allowed until 2022-12-31 at 23:59:59 UTC). `end_date` must be equal to or greater than `start_date` (in UTC).","type":"string","format":"date","uniqueKey":"mandates.items.[INDEX].mandate_details.end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Expiration date of the mandate, e.g. `2022-12-31`. Payment requests will be allowed up to this date (inclusive). All date inputs assume UTC times (e.g. if `end_date` = `2022-12-31`, then a payment will be allowed until 2022-12-31 at 23:59:59 UTC). `end_date` must be equal to or greater than `start_date` (in UTC).","type":"null","format":"date","uniqueKey":"mandates.items.[INDEX].mandate_details.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"mandates.items.[INDEX].mandate_details.end_date","typeLabel":"string\u003cdate> | null"},"mandate_bank_reference":{"description":"Bank-generated reference for the mandate, usually shown to senders on their bank notifications or statements. Only returned once mandate has been processed successfully by the sender's bank (i.e. mandate `status`\\= `SUCCESSFUL`).","type":"string","uniqueKey":"mandates.items.[INDEX].mandate_details.mandate_bank_reference","typeLabel":"string"},"payment_schedule":{"required":["amount","frequency"],"properties":{"amount":{"description":"Amount of the scheduled payment in major currency","type":"integer","example":100,"isRequired":true,"uniqueKey":"mandates.items.[INDEX].mandate_details.payment_schedule.amount","typeLabel":"integer"},"frequency":{"description":"Frequency of the scheduled payment. Possible values: `DAILY`, `WEEKLY`, `MONTHLY`","type":"string","enum":["DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY"],"isRequired":true,"uniqueKey":"mandates.items.[INDEX].mandate_details.payment_schedule.frequency","typeLabel":"enum\u003cstring>"}},"description":"RESERVED FOR FUTURE USE - Specifies scheduled auto-payments","type":"object","uniqueKey":"mandates.items.[INDEX].mandate_details.payment_schedule","typeLabel":"object"},"processor_entity_name":{"type":"string","description":"Name of the payment processor (if any) through which the payment is collected. This name may be displayed to users in the Finverse UI, in email notifications and in the sender's bank statements. For direct debit payments directly collected by the merchant (e.g. SG eGIRO payments), no `processor_entity_name` is returned. For direct debit payments collected through Finverse (e.g. HK eDDA payments), `processor_entity_name` will be Finverse's legal entity name.","uniqueKey":"mandates.items.[INDEX].mandate_details.processor_entity_name","typeLabel":"string"},"start_date":{"oneOf":[{"description":"Start date of the mandate, e.g. `2022-06-01`. Payment requests will be allowed from this date onwards (inclusive). All date inputs assume UTC times (e.g. if `start_date` = `2022-06-01`, then a payment will be allowed starting from 2022-06-01 at 00:00:00 UTC). `start_date` must be equal to or greater than today's date (in UTC).","type":"string","format":"date","uniqueKey":"mandates.items.[INDEX].mandate_details.start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Start date of the mandate, e.g. `2022-06-01`. Payment requests will be allowed from this date onwards (inclusive). All date inputs assume UTC times (e.g. if `start_date` = `2022-06-01`, then a payment will be allowed starting from 2022-06-01 at 00:00:00 UTC). `start_date` must be equal to or greater than today's date (in UTC).","type":"null","format":"date","uniqueKey":"mandates.items.[INDEX].mandate_details.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"mandates.items.[INDEX].mandate_details.start_date","typeLabel":"string\u003cdate> | null"},"transaction_limits":{"properties":{"max_period_amount":{"description":"Maximum cumulative amount (in minor currency unit) of payment transactions (for the specified `period` unit)","type":"integer","minimum":1,"uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.max_period_amount","typeLabel":"integer"},"max_period_count":{"description":"Maximum number of payment transactions (for the specified `period` unit)","type":"integer","minimum":1,"uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.max_period_count","typeLabel":"integer"},"max_transaction_amount":{"description":"Maximum amount per single payment transaction, set by your Customer App (in minor currency units). Note: to avoid your Customer App triggering over-limit payments, Finverse will block any `POST /payments` requests exceeding the `max_transaction_amount` Banks may separately apply their own per transaction limit (see `max_transaction_amount_set_by_payer_initial` below)","type":"integer","minimum":1,"uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.max_transaction_amount","typeLabel":"integer"},"max_transaction_amount_set_by_payer_initial":{"oneOf":[{"description":"Maximum amount per single payment transaction, optionally set by the end-user at the time of direct debit mandate creation, e.g. for eGIRO in Singapore (in minor currency units). Note: Finverse will attempt to submit `POST /payments` requests to banks even when the payment amount exceeds this limit, however you should expect the end-user's bank will reject over-limit payemnt requests, unless the user directly updates their limit through their bank (e.g. through their bank's internet banking portal > eGIRO management page). Finverse separately applies its own per transaction limit (see `max_transaction_limit` above)","type":"integer","uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.max_transaction_amount_set_by_payer_initial.oneOf.0","typeLabel":"integer"},{"description":"Maximum amount per single payment transaction, optionally set by the end-user at the time of direct debit mandate creation, e.g. for eGIRO in Singapore (in minor currency units). Note: Finverse will attempt to submit `POST /payments` requests to banks even when the payment amount exceeds this limit, however you should expect the end-user's bank will reject over-limit payemnt requests, unless the user directly updates their limit through their bank (e.g. through their bank's internet banking portal > eGIRO management page). Finverse separately applies its own per transaction limit (see `max_transaction_limit` above)","type":"null","uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.max_transaction_amount_set_by_payer_initial.oneOf.1","typeLabel":"null"}],"uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.max_transaction_amount_set_by_payer_initial","typeLabel":"integer | null"},"period":{"oneOf":[{"description":"Returned if `max_period_amount` or `max_period_count` are set.","type":"string","enum":["DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY"],"uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.period.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Returned if `max_period_amount` or `max_period_count` are set.","type":"null","enum":["DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY"],"uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.period.oneOf.1","typeLabel":"null"}],"uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits.period","typeLabel":"enum\u003cstring> | null"}},"description":"Specifies custom limits per payment transaction","type":"object","uniqueKey":"mandates.items.[INDEX].mandate_details.transaction_limits","typeLabel":"object"}},"description":"Details on the mandate","type":"object","isRequired":true,"uniqueKey":"mandates.items.[INDEX].mandate_details","typeLabel":"object"},"mandate_id":{"description":"Finverse Mandate ID for this mandate. Always unique. Creating a mandate with different idempotency keys will result in two mandates with different IDs.","type":"string","isRequired":true,"uniqueKey":"mandates.items.[INDEX].mandate_id","typeLabel":"string"},"recipient":{"required":["name"],"properties":{"name":{"description":"Merchant account name","type":"string","isRequired":true,"uniqueKey":"mandates.items.[INDEX].recipient.name","typeLabel":"string"}},"description":"Details on the recipient of the payment","type":"object","isRequired":true,"uniqueKey":"mandates.items.[INDEX].recipient","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":"mandates.items.[INDEX].sender.external_user_id","typeLabel":"string"},"user_id":{"description":"A unique identifier generated after creating sender","type":"string","isRequired":true,"uniqueKey":"mandates.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":"mandates.items.[INDEX].sender.user_type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","uniqueKey":"mandates.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":"mandates.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":"mandates.items.[INDEX].sender.user_details.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"mandates.items.[INDEX].sender.user_details.items.[INDEX].values","typeLabel":"string[]"}},"type":"object","uniqueKey":"mandates.items.[INDEX].sender.user_details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"mandates.items.[INDEX].sender.user_details","typeLabel":"object[]"}},"description":"Details on the sender of the payment","type":"object","isRequired":true,"uniqueKey":"mandates.items.[INDEX].sender","typeLabel":"object"},"status":{"description":"Current status of the mandate. Possible values: `AUTHORIZATION_REQUIRED`, `PROCESSING`, `READY_TO_SUBMIT`, `SUBMITTED`, `SUCCEEDED`, `CANCELLED`, `CLOSED`, `FAILED` Note: `CLOSED` occurs when a draft Mandate is created by a Finverse Payment Link (with status `AUTHORIZATION_REQUIRED`), and the user then drops-off or creates a new Payment Method or Mandate. In these cases, Finverse closes the draft Mandate in order to associate a new Payment Method / Mandate with the same Payment Link.","type":"string","enum":["AUTHORIZATION_REQUIRED","AUTHORIZING","PROCESSING","SUBMITTED","SUCCEEDED","FAILED","REVOKED"],"isRequired":true,"uniqueKey":"mandates.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Timestamp of the last update to the mandate's record","type":"string","format":"date-time","isRequired":true,"uniqueKey":"mandates.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"created_at":{"description":"Timestamp when the mandate was first created","type":"string","format":"date-time","uniqueKey":"mandates.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"error":{"required":["type","error_code","message","details"],"properties":{"details":{"type":"string","isRequired":true,"uniqueKey":"mandates.items.[INDEX].error.details","typeLabel":"string"},"error_code":{"type":"string","example":"CREDENTIALS_INVALID","isRequired":true,"uniqueKey":"mandates.items.[INDEX].error.error_code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"mandates.items.[INDEX].error.message","typeLabel":"string"},"type":{"description":"The error type","type":"string","enum":["LINK_ERROR","API_ERROR"],"example":"LINKING_ERROR","isRequired":true,"uniqueKey":"mandates.items.[INDEX].error.type","typeLabel":"enum\u003cstring>"}},"description":"Details on why the mandate failed (returned when `status` = `FAILED`). Note: this is used to detail any asynchronous e errors occuring after mandate creation; any synchronous errors (e.g. API validation errors) will instead be returned directly during `POST /mandates`.","type":"object","uniqueKey":"mandates.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":"mandates.items.[INDEX].fees.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","example":"HKD","description":"Currency of the fee (e.g. HKD)","uniqueKey":"mandates.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":"mandates.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":"mandates.items.[INDEX].fees.items.[INDEX].paid_by_account_id","typeLabel":"string"}},"type":"object","uniqueKey":"mandates.items.[INDEX].fees.items.[INDEX]","typeLabel":"object"},"description":"Details on the fee(s) to be charged","uniqueKey":"mandates.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":"mandates.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"mandates.items.[INDEX].metadata","typeLabel":"object"},"payment_method_id":{"description":"Finverse Payment Method ID for this mandate, used to create payments using the mandate (see `POST /`payments). Always unique. Creating a mandate with different idempotency keys will result in two mandates with different IDs.","type":"string","uniqueKey":"mandates.items.[INDEX].payment_method_id","typeLabel":"string"},"recipient_account":{"required":["account_id","account_type"],"properties":{"account_id":{"description":"Merchant account ID assigned by Finverse","type":"string","isRequired":true,"uniqueKey":"mandates.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":"mandates.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":"mandates.items.[INDEX].recipient_account","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":"mandates.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":"mandates.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":"mandates.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":"mandates.items.[INDEX].sender_account.account_number.number_plaintext.oneOf.0","typeLabel":"string"},{"description":"Account number in plaintext","type":"null","maxLength":100,"minLength":1,"uniqueKey":"mandates.items.[INDEX].sender_account.account_number.number_plaintext.oneOf.1","typeLabel":"null"}],"uniqueKey":"mandates.items.[INDEX].sender_account.account_number.number_plaintext","typeLabel":"string | null"}},"description":"Bank account number details, including account number in plaintext","uniqueKey":"mandates.items.[INDEX].sender_account.account_number","typeLabel":"object"},"account_number_masked":{"description":"Masked Account number of the sender’s account","type":"string","uniqueKey":"mandates.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":"mandates.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":"mandates.items.[INDEX].sender_account.accountholder_name","typeLabel":"string"},"accountholder_name_plaintext":{"oneOf":[{"description":"Accountholder name in plaintext.","type":"string","example":"Chan Li Pak","uniqueKey":"mandates.items.[INDEX].sender_account.accountholder_name_plaintext.oneOf.0","typeLabel":"string"},{"description":"Accountholder name in plaintext.","type":"null","example":"Chan Li Pak","uniqueKey":"mandates.items.[INDEX].sender_account.accountholder_name_plaintext.oneOf.1","typeLabel":"null"}],"uniqueKey":"mandates.items.[INDEX].sender_account.accountholder_name_plaintext","typeLabel":"string | null"},"bank_code":{"type":"string","uniqueKey":"mandates.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":"mandates.items.[INDEX].sender_account.institution_id","typeLabel":"string"},"institution_name":{"description":"Institution Name for the sender’s institution.","type":"string","example":"HSBC","uniqueKey":"mandates.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":"mandates.items.[INDEX].sender_account.metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"mandates.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":"mandates.items.[INDEX].sender_account.user_id","typeLabel":"string"}},"description":"Details on the sender's source institution and account, which is funding the payment","uniqueKey":"mandates.items.[INDEX].sender_account","typeLabel":"object"}},"type":"object","uniqueKey":"mandates.items.[INDEX]","typeLabel":"object"},"description":"List of Mandate objects that satisfy the filters in the request. Refer to Mandate object data model in `GET /mandates/{mandate_id}`","uniqueKey":"mandates","typeLabel":"object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"success":{"title":"success","value":{"mandates":[{"created_at":"2025-06-21T06:30:22.964Z","fees":[{"amount":0,"currency":"HKD","paid_by":"RECIPIENT","paid_by_account_id":"01JY8AKPBC32AZ5TPD99R27JZP"}],"mandate_details":{"collection_entity_name":"Finverse Technologies Limited","currency":"HKD","dda_reference":"FINVERSE T-62F2-FINV","description":"Test Mandate","end_date":"2025-12-01","mandate_bank_reference":"01JY8JWMAV62AVC00FP2EC6509","processor_entity_name":"Finverse Technologies Limited","start_date":"2025-06-21","transaction_limits":{"max_period_amount":10000,"max_period_count":10,"max_transaction_amount":10000,"max_transaction_amount_set_by_payer_initial":5000,"period":"MONTHLY"}},"mandate_id":"01JY8JWDY51SYHP006XZBAMVGN","metadata":{"employer_name":"Apple Inc","key":"value"},"payment_method_id":"01JY8JWE50618D9RGH44AR884F","recipient":{"name":"Finverse Test"},"recipient_account":{"account_id":"01JY8AKPBC32AZ5TPD99R27JZP","account_type":"SETTLEMENT_ACCOUNT"},"sender":{"external_user_id":"user_id_1_1750487415","name":"John Doe","user_details":[],"user_id":"01JY8JWE3NG8CJ7DVJZJC3HMJT","user_type":"INDIVIDUAL"},"sender_account":{"account_id":"01JY8JWKX2HSZJ500DNEJ3JGHQ","account_number":{"number":"01JY8JWM06NV1VNCPM6D5JJ9Y9","type":"LOCAL"},"account_number_masked":"XXX45","account_type":"EXTERNAL_ACCOUNT","accountholder_name":"01JY8JWKZRZ32FFE4G0FPM19H1","institution_id":"testbank-dbs-hk","institution_name":"Testbank (HK) Payments - Personal","user_id":"01JY8JWE3NG8CJ7DVJZJC3HMJT"},"status":"SUCCEEDED","updated_at":"2025-06-21T06:30:22.964Z"},{"created_at":"2025-06-21T05:58:18.257Z","fees":[{"amount":0,"currency":"HKD","paid_by":"RECIPIENT","paid_by_account_id":"01JY8AKPBC32AZ5TPD99R27JZP"}],"mandate_details":{"collection_entity_name":"Finverse Technologies Limited","currency":"HKD","dda_reference":"FINVERSE T-R885-FINV","description":"Payment link mandate","mandate_bank_reference":"01JY8H1X2H8FSQHV5DPPBAXTD8","processor_entity_name":"Finverse Technologies Limited","start_date":"2025-06-21","transaction_limits":{"max_transaction_amount":500000}},"mandate_id":"01JY8H1ATJXEZGV3EDCK0MWY6Z","payment_method_id":"01JY8H1AX3TRC1TBHMB45WASEH","recipient":{"name":"Finverse Test"},"recipient_account":{"account_id":"01JY8AKPBC32AZ5TPD99R27JZP","account_type":"SETTLEMENT_ACCOUNT"},"sender":{"external_user_id":"user_id_1||1750485452","name":"John Doe","user_details":[],"user_id":"01JY8H0J30ZBW17EG37128HRPN","user_type":"INDIVIDUAL"},"sender_account":{"account_id":"01JY8H1W0C66V5F8NJW9CG62PF","account_number":{"number":"01JY8H1W6XJETFS21BEPV0BGEC","type":"LOCAL"},"account_number_masked":"434XXXX49","account_type":"EXTERNAL_ACCOUNT","accountholder_name":"01JY8H1W5T5FGB22TZCDBGDM33","institution_id":"testbank-dbs-hk","institution_name":"Testbank (HK) Payments - Personal","user_id":"01JY8H0J30ZBW17EG37128HRPN"},"status":"SUCCEEDED","updated_at":"2025-06-21T05:58:18.257Z"},{"created_at":"2025-06-21T05:35:23.088Z","fees":[{"amount":0,"currency":"HKD","paid_by":"RECIPIENT","paid_by_account_id":"01JY8AKPBC32AZ5TPD99R27JZP"}],"mandate_details":{"collection_entity_name":"Finverse Technologies Limited","currency":"HKD","dda_reference":"FINVERSE T-8F52-FINV","description":"Payment link mandate","mandate_bank_reference":"01JY8FQX8ZAENPWSRG87961DXC","processor_entity_name":"Finverse Technologies Limited","start_date":"2025-06-21","transaction_limits":{"max_transaction_amount":500000,"max_transaction_amount_set_by_payer_initial":5000}},"mandate_id":"01JY8FQHTEX7FAJMM4SGK4GRSZ","payment_method_id":"01JY8FQHXCZXWYN2EG383YAGR2","recipient":{"name":"Finverse Test"},"recipient_account":{"account_id":"01JY8AKPBC32AZ5TPD99R27JZP","account_type":"SETTLEMENT_ACCOUNT"},"sender":{"external_user_id":"user_id_1||1750484076","name":"John Doe","user_details":[],"user_id":"01JY8FPJ0XFTEBPH5VHF379XF3","user_type":"INDIVIDUAL"},"sender_account":{"account_id":"01JY8FQWS1D4ZX8PJJS9ZY6B58","account_number":{"number":"01JY8FQWYTG44WF6RECHN6M09F","type":"LOCAL"},"account_number_masked":"300XXXX03","account_type":"EXTERNAL_ACCOUNT","accountholder_name":"01JY8FQWXZN9CFXFKPPKEHTE2M","institution_id":"testbank-dbs-hk","institution_name":"Testbank (HK) Payments - Personal","user_id":"01JY8FPJ0XFTEBPH5VHF379XF3"},"status":"SUCCEEDED","updated_at":"2025-06-21T05:35:23.088Z"},{"created_at":"2025-06-21T04:31:20.442Z","fees":[{"amount":0,"currency":"HKD","paid_by":"RECIPIENT","paid_by_account_id":"01JY8AKPBC32AZ5TPD99R27JZP"}],"mandate_details":{"collection_entity_name":"Finverse Technologies Limited","currency":"HKD","dda_reference":"FINVERSE T-2X6K-FINV","description":"Test Mandate","end_date":"2025-12-01","mandate_bank_reference":"01JY8C2N74X3E4Y2A5YT030KCD","processor_entity_name":"Finverse Technologies Limited","start_date":"2025-06-21","transaction_limits":{"max_period_amount":10000,"max_period_count":10,"max_transaction_amount":10000,"period":"MONTHLY"}},"mandate_id":"01JY8C0V23FPKZXH1YAHC9JBD5","metadata":{"employer_name":"Apple Inc","key":"value"},"payment_method_id":"01JY8C0V652P775DQG7DXH9HNR","recipient":{"name":"Finverse Test"},"recipient_account":{"account_id":"01JY8AKPBC32AZ5TPD99R27JZP","account_type":"SETTLEMENT_ACCOUNT"},"sender":{"external_user_id":"user_id_1_1750480219","name":"John Doe","user_details":[],"user_id":"01JY8C0V4VMZRC8YM399JF84BP","user_type":"INDIVIDUAL"},"sender_account":{"account_id":"01JY8C2MR456G4EXKVZHB45WPR","account_number":{"number":"01JY8C2MWT0M5NXR1V7FW8ZJEG","type":"LOCAL"},"account_number_masked":"XXX45","account_type":"EXTERNAL_ACCOUNT","accountholder_name":"01JY8C2MW9WT09SK3AA0928518","institution_id":"testbank-dbs-hk","institution_name":"Testbank (HK) Payments - Personal","user_id":"01JY8C0V4VMZRC8YM399JF84BP"},"status":"SUCCEEDED","updated_at":"2025-06-21T04:31:20.442Z"},{"created_at":"2025-06-21T04:22:58.369Z","fees":[],"mandate_details":{"collection_entity_name":"Finverse Technologies Limited","currency":"SGD","dda_reference":"DDA-1234567890","description":"Paper eGIRO Mandate","processor_entity_name":"Finverse Technologies Limited","transaction_limits":{"max_period_amount":100000000,"max_period_count":100000,"max_transaction_amount":100000000,"period":"MONTHLY"}},"mandate_id":"01JY8BKCGV63S66V3VDSTXF29D","payment_method_id":"01JY8BKCGV63S66V3VDS3G6NX3","recipient":{"name":"Finverse Test"},"recipient_account":{"account_id":"01JY8AKPBC32AZ5TPD99R27JZP","account_type":"SETTLEMENT_ACCOUNT"},"sender":{"external_user_id":"user_id_1||1750479613","name":"John Doe","user_details":[],"user_id":"01JY8BECD0ARSWMA0YX0DRY57A","user_type":"INDIVIDUAL"},"sender_account":{"account_id":"01JY8BF0GD7H9WWSD892FP5FJT","account_number":{"number":"01JY8BF0Q7VGR0H60M00ZG4HXZ","type":"LOCAL"},"account_number_masked":"030XXXXX4004","account_type":"EXTERNAL_ACCOUNT","accountholder_name":"01JY8BF0MPCWYC25B4AFJNGGSQ","institution_id":"testbank-dbs-hk","institution_name":"Testbank (HK) Payments - Personal","user_id":"01JY8BECD0ARSWMA0YX0DRY57A"},"status":"SUCCEEDED","updated_at":"2025-06-21T04:22:58.369Z"},{"created_at":"2025-06-21T04:20:38.049Z","fees":[{"amount":0,"currency":"HKD","paid_by":"RECIPIENT","paid_by_account_id":"01JY8AKPBC32AZ5TPD99R27JZP"}],"mandate_details":{"collection_entity_name":"Finverse Technologies Limited","currency":"HKD","dda_reference":"FINVERSE T-8M2Z-FINV","description":"Payment link mandate","mandate_bank_reference":"01JY8BF14GNY1N0TBA5H168X0E","processor_entity_name":"Finverse Technologies Limited","start_date":"2025-06-21","transaction_limits":{"max_transaction_amount":500000}},"mandate_id":"01JY8BEMF3AGBQ7C9CJWTV2W4X","payment_method_id":"01JY8BEMJZQQWGFTCKNSJGB0BD","recipient":{"name":"Finverse Test"},"recipient_account":{"account_id":"01JY8AKPBC32AZ5TPD99R27JZP","account_type":"SETTLEMENT_ACCOUNT"},"sender":{"external_user_id":"user_id_1||1750479613","name":"John Doe","user_details":[],"user_id":"01JY8BECD0ARSWMA0YX0DRY57A","user_type":"INDIVIDUAL"},"sender_account":{"account_id":"01JY8BF0GD7H9WWSD892FP5FJT","account_number":{"number":"01JY8BF0Q7VGR0H60M00ZG4HXZ","type":"LOCAL"},"account_number_masked":"030XXXXX4004","account_type":"EXTERNAL_ACCOUNT","accountholder_name":"01JY8BF0MPCWYC25B4AFJNGGSQ","institution_id":"testbank-dbs-hk","institution_name":"Testbank (HK) Payments - Personal","user_id":"01JY8BECD0ARSWMA0YX0DRY57A"},"status":"SUCCEEDED","updated_at":"2025-06-21T04:20:38.049Z"},{"created_at":"2025-06-21T04:15:07.903Z","fees":[{"amount":0,"currency":"HKD","paid_by":"RECIPIENT","paid_by_account_id":"01JY8AKPBC32AZ5TPD99R27JZP"}],"mandate_details":{"collection_entity_name":"Finverse Technologies Limited","currency":"HKD","dda_reference":"FINVERSE T-0KMR-FINV","description":"Payment link mandate","mandate_bank_reference":"01JY8B4YT7GHP4625QEJNFN5DV","processor_entity_name":"Finverse Technologies Limited","start_date":"2025-06-21","transaction_limits":{"max_transaction_amount":500000}},"mandate_id":"01JY8B4MK6T0KFYPV028FRW1YS","payment_method_id":"01JY8B4MPYMWNJ7XT603HV2SZ8","recipient":{"name":"Finverse Test"},"recipient_account":{"account_id":"01JY8AKPBC32AZ5TPD99R27JZP","account_type":"SETTLEMENT_ACCOUNT"},"sender":{"external_user_id":"user_id_1||1750479256","name":"John Doe","user_details":[],"user_id":"01JY8B3FK244XNJCZV2J2PBRMN","user_type":"INDIVIDUAL"},"sender_account":{"account_id":"01JY8B4XY0N1AVRR88WWHC7NK2","account_number":{"number":"01JY8B4Y2W8GJGVV1G6ZZNAPE9","type":"LOCAL"},"account_number_masked":"404XXXXX4040","account_type":"EXTERNAL_ACCOUNT","accountholder_name":"01JY8B4Y1HQFKHXKG2RGA0CZZ3","institution_id":"testbank-dbs-hk","institution_name":"Testbank (HK) Payments - Personal","user_id":"01JY8B3FK244XNJCZV2J2PBRMN"},"status":"SUCCEEDED","updated_at":"2025-06-21T04:15:07.903Z"}],"total_mandates":7}}},"exampleType":"examples"}},"exampleType":"examples"},"15cf415c-3c0a-4f9e-8594-84e4b4f0ad3b":{"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"},"d2eea56a-bcdd-4eac-a587-3a2db0757288":{"description":"Unauthorized","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"},"256eb2bb-3b26-4d8d-9580-f414a080b7b4":{"description":"Internal Server Error","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":{"730c2a8f-a26b-415d-a72b-8209f0f42f7f":{"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":["mandate:list"]}}},"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":["mandate:list"]},"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":"List Mandates - Finverse API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-30T09:08:24.898Z","originalFileLocation":"api-reference/mandates/list-mandates.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=\"List Mandates associated with a Customer App. Authorization: customer_token ## URL query parameters The following optional URL query parameters can be used to filter the list of items to be returned.\">\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=\"List Mandates - Finverse API\">\u003cmeta data-mint-head property=\"og:description\" content=\"List Mandates associated with a Customer App. Authorization: customer_token ## URL query parameters The following optional URL query parameters can be used to filter the list of items to be returned.\">\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/mandates/list-mandates\">\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=Mandates\u0026amp;title=List+Mandates\u0026amp;description=List+Mandates+associated+with+a+Customer+App.%0A%0A**Authorization**%3A+%60customer_token%60%0A%0A%23%23+URL+query+parameters%0A%0AThe+following+optional+URL+query+parameters+can+be+\u0026amp;theme=cbf26bae0487384b20dc51fd\u0026amp;signature=140ec337e413d6d9dc9152a5b76007278ecf667343f138908f22cbc67738d88b\">\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=\"List Mandates - Finverse API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List Mandates associated with a Customer App. Authorization: customer_token ## URL query parameters The following optional URL query parameters can be used to filter the list of items to be returned.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finverse.mintlify.site/_mintlify/api/og/v2?division=Mandates\u0026amp;title=List+Mandates\u0026amp;description=List+Mandates+associated+with+a+Customer+App.%0A%0A**Authorization**%3A+%60customer_token%60%0A%0A%23%23+URL+query+parameters%0A%0AThe+following+optional+URL+query+parameters+can+be+\u0026amp;theme=cbf26bae0487384b20dc51fd\u0026amp;signature=140ec337e413d6d9dc9152a5b76007278ecf667343f138908f22cbc67738d88b\">\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/mandates/list-mandates\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/mandates/list-mandates.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/mandates/list-mandates#webpage\",\"url\":\"https://docs2.finverse.com/api-reference/mandates/list-mandates\",\"name\":\"List Mandates\",\"description\":\"List Mandates associated with a Customer App. Authorization: customer_token ## URL query parameters The following optional URL query parameters can be used to filter the list of items to be returned.\",\"dateModified\":\"2026-06-30T09:08:24.898Z\",\"isPartOf\":{\"@id\":\"https://docs2.finverse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs2.finverse.com/api-reference/mandates/list-mandates#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs2.finverse.com/api-reference/mandates/list-mandates#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\":\"List Mandates\",\"item\":\"https://docs2.finverse.com/api-reference/mandates/list-mandates\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs2.finverse.com/api-reference/mandates/list-mandates#apireference\",\"headline\":\"List Mandates\",\"name\":\"List Mandates\",\"description\":\"List Mandates associated with a Customer App. Authorization: customer_token ## URL query parameters The following optional URL query parameters can be used to filter the list of items to be returned.\",\"url\":\"https://docs2.finverse.com/api-reference/mandates/list-mandates\",\"mainEntityOfPage\":{\"@id\":\"https://docs2.finverse.com/api-reference/mandates/list-mandates#webpage\"},\"dateModified\":\"2026-06-30T09:08:24.898Z\",\"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","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","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","description":"Retrieve status history for a Login Identity (using a specific `login_identity_id`).\n\nThis is primarily useful to debug Login Identity data retrieval issues, and to evaluate authentication \u0026 data retrieval speeds.\n\n**Authorization:** `customer_token`","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","description":"Create a Mandate (i.e. pre-authorization) that will be used to make payments, without any existing/known sender account details (the end-user will be requested to input these in the mandate authorization UI).\n\n`Idempotency-Key` header is **required**. This makes it safe to retry the request without re-triggering the underlying create Mandate operation. Any retries will return the same Mandate response as the first request using the same key.\n\n**Authorization**: `customer_token`\n\n### mandate_details (object, required)\n\nDetails describing the Mandate.\n\n### payment_schedule (object, optional)\n\nRESERVED FOR FUTURE USE - Specifies scheduled auto-payments with the specified amounts and dates.\n\n### transaction_limits (object, optional)\n\nSpecifies custom limits on payment transactions executed under the Mandate.\n\n### recipient_account (object, required)\n\nDetails on the recipient account of the payment (i.e. the Customer App's receiving account).\n\n### sender (object, required)\n\nDetails on the sender of the payment.\n\n### user_details (array of objects, optional)\n\nAdditional information about the user's identity, used for validating any end-user submitted identity details in the Finverse Link UI.\n\n## Response fields\n\nThe response is a Mandate object.\n\nRefer to Mandate object data model in `GET /mandates/{mandate_id}`.","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":"List Mandates - 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"]}