{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"UQPAY Docs","colors":{"primary":"#2165F4","light":"#0C9CFF","dark":"#0D001D"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/uqpaypteltd/uHX3BYExjP-ceVfw/logo/light.svg?fit=max\u0026auto=format\u0026n=uHX3BYExjP-ceVfw\u0026q=85\u0026s=aabcacf707570fb6b63ad12ff4172347","dark":"https://mintcdn.com/uqpaypteltd/uHX3BYExjP-ceVfw/logo/dark.svg?fit=max\u0026auto=format\u0026n=uHX3BYExjP-ceVfw\u0026q=85\u0026s=8a57373a9c81fd8f10a6fc81c641afd4"},"api":{"mdx":{"server":"https://api.sandbox.uqpay.org"}},"background":{"decoration":null,"color":{"light":null,"dark":"#090014"}},"navbar":{"links":[{"label":"Support","href":"mailto:[email protected]"}],"primary":{"type":"button","label":"Dashboard","href":"https://dash.uqpay.org"}},"footer":{"socials":{"twitter":"https://twitter.com/uqpay_cs","github":"https://github.com/uqpay","linkedin":"https://www.linkedin.com/company/uqpay"}},"navigation":{"global":{"anchors":[{"anchor":"Github","href":"https://github.com/uqpay","icon":"github"},{"anchor":"Linkedin","href":"https://www.linkedin.com/company/uqpay/","icon":"linkedin"},{"anchor":"Official Website","href":"https://www.uqpay.com","icon":"globe"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"uqpaypteltd","hasAudioNarration":false,"actualSubdomain":"uqpaypteltd","customDomains":["docs.uqpay.org"],"gitSource":{"type":"github","owner":"uqpay","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e60b328cd78292a4e863","collectionId":"5bec0ba3-f042-43be-bd77-1babab790fe0","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e60b328cd78292a4e863:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":42},{"language":"default","tag":"ISSUING","count":17},{"language":"default","tag":"PAYOUT","count":15},{"language":"default","tag":"Cards","count":11},{"language":"default","tag":"Payout","count":9},{"language":"default","tag":"CORE","count":6},{"language":"default","tag":"Beneficiaries","count":6},{"language":"default","tag":"Balances","count":5},{"language":"default","tag":"Cardholders","count":4},{"language":"default","tag":"API OVERVIEW","count":2}]},"assistantConfig":{},"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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payer/list","slug":"/api-reference/payer/list","pageMetadata":{"title":"Get list of payers","api":"GET https://api.sandbox.uqpay.org/api/v1/payers","description":"This endpoint returns a list of payers.","href":"/api-reference/payer/list"},"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: \"This endpoint returns a list of payers.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`header`,children:`Header`}),`\n`,_jsx(ParamField,{header:`x-client-id`,type:`string`,required:true,id:`param-x-client-id`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`x-client-id`}),`.`]})}),`\n`,_jsx(ParamField,{header:`x-auth-token`,type:`string`,required:true,id:`param-x-auth-token`,children:_jsxs(_components.p,{children:[`Bearer `,_jsx(_components.code,{children:`YOUR_TOKEN_HERE`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`parameters`,children:`Parameters`}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`code`,type:`number`,id:`param-code`,children:_jsx(_components.p,{children:`Indicates whether the call was successful. 200 if successful, 400 if not.`})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`Response Message. “Success” if successful, Others not.`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsx(Expandable,{title:`details`,defaultOpen:true,children:_jsx(ResponseField,{name:`item_list`,type:`array`,id:`param-item-list`,children:_jsxs(Expandable,{title:`details`,defaultOpen:true,children:[_jsx(ResponseField,{name:`payer_id`,type:`string`,id:`param-payer-id`,children:_jsx(_components.p,{children:`Unique UUID for the payer.`})}),_jsx(ResponseField,{name:`entity_type`,type:`string`,id:`param-entity-type`,children:_jsx(_components.p,{children:`Payer’s entity type - company or individual.`})}),_jsx(ResponseField,{name:`company_name`,type:`string`,id:`param-company-name`,children:_jsx(_components.p,{children:`The name of the company (if the payer is a company).`})}),_jsx(ResponseField,{name:`first_name`,type:`string`,id:`param-first-name`,children:_jsx(_components.p,{children:`Payer’s first name.`})}),_jsx(ResponseField,{name:`last_name`,type:`string`,id:`param-last-name`,children:_jsx(_components.p,{children:`Payer’s last name.`})}),_jsx(ResponseField,{name:`address`,type:`string`,id:`param-address`,children:_jsx(_components.p,{children:`Line of address.`})}),_jsx(ResponseField,{name:`city`,type:`string`,id:`param-city`,children:_jsx(_components.p,{children:`City of the payer.`})}),_jsx(ResponseField,{name:`state_or_province`,type:`string`,id:`param-state-or-province`,children:_jsx(_components.p,{children:`State or province of the payer.`})}),_jsx(ResponseField,{name:`country`,type:`string`,id:`param-country`,children:_jsx(_components.p,{children:`Country of the payer. Two-letter ISO country code.`})}),_jsx(ResponseField,{name:`postal_code`,type:`string`,id:`param-postal-code`,children:_jsx(_components.p,{children:`Postal code of the payer.`})}),_jsx(ResponseField,{name:`date_of_birth`,type:`string`,id:`param-date-of-birth`,children:_jsx(_components.p,{children:`Payer date of birth.`})}),_jsx(ResponseField,{name:`identification_type`,type:`string`,id:`param-identification-type`,children:_jsx(_components.p,{children:`The legal document used to verify the identity of the payer (e.g. passport).`})}),_jsx(ResponseField,{name:`identification_value`,type:`string`,id:`param-identification-value`,children:_jsx(_components.p,{children:`A unique reference code for the identification document, such as a passport number.`})})]})})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get list of payers","api":"GET https://api.sandbox.uqpay.org/api/v1/payers","description":"This endpoint returns a list of payers.","href":"/api-reference/payer/list"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,RequestExample,ResponseExample,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`header`,children:`Header`}),`\n`,_jsx(ParamField,{header:`x-client-id`,type:`string`,required:true,id:`param-x-client-id`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`x-client-id`}),`.`]})}),`\n`,_jsx(ParamField,{header:`x-auth-token`,type:`string`,required:true,id:`param-x-auth-token`,children:_jsxs(_components.p,{children:[`Bearer `,_jsx(_components.code,{children:`YOUR_TOKEN_HERE`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`parameters`,children:`Parameters`}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`code`,type:`number`,id:`param-code`,children:_jsx(_components.p,{children:`Indicates whether the call was successful. 200 if successful, 400 if not.`})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`Response Message. “Success” if successful, Others not.`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsx(Expandable,{title:`details`,defaultOpen:true,children:_jsx(ResponseField,{name:`item_list`,type:`array`,id:`param-item-list`,children:_jsxs(Expandable,{title:`details`,defaultOpen:true,children:[_jsx(ResponseField,{name:`payer_id`,type:`string`,id:`param-payer-id`,children:_jsx(_components.p,{children:`Unique UUID for the payer.`})}),_jsx(ResponseField,{name:`entity_type`,type:`string`,id:`param-entity-type`,children:_jsx(_components.p,{children:`Payer’s entity type - company or individual.`})}),_jsx(ResponseField,{name:`company_name`,type:`string`,id:`param-company-name`,children:_jsx(_components.p,{children:`The name of the company (if the payer is a company).`})}),_jsx(ResponseField,{name:`first_name`,type:`string`,id:`param-first-name`,children:_jsx(_components.p,{children:`Payer’s first name.`})}),_jsx(ResponseField,{name:`last_name`,type:`string`,id:`param-last-name`,children:_jsx(_components.p,{children:`Payer’s last name.`})}),_jsx(ResponseField,{name:`address`,type:`string`,id:`param-address`,children:_jsx(_components.p,{children:`Line of address.`})}),_jsx(ResponseField,{name:`city`,type:`string`,id:`param-city`,children:_jsx(_components.p,{children:`City of the payer.`})}),_jsx(ResponseField,{name:`state_or_province`,type:`string`,id:`param-state-or-province`,children:_jsx(_components.p,{children:`State or province of the payer.`})}),_jsx(ResponseField,{name:`country`,type:`string`,id:`param-country`,children:_jsx(_components.p,{children:`Country of the payer. Two-letter ISO country code.`})}),_jsx(ResponseField,{name:`postal_code`,type:`string`,id:`param-postal-code`,children:_jsx(_components.p,{children:`Postal code of the payer.`})}),_jsx(ResponseField,{name:`date_of_birth`,type:`string`,id:`param-date-of-birth`,children:_jsx(_components.p,{children:`Payer date of birth.`})}),_jsx(ResponseField,{name:`identification_type`,type:`string`,id:`param-identification-type`,children:_jsx(_components.p,{children:`The legal document used to verify the identity of the payer (e.g. passport).`})}),_jsx(ResponseField,{name:`identification_value`,type:`string`,id:`param-identification-value`,children:_jsx(_components.p,{children:`A unique reference code for the identification document, such as a passport number.`})})]})})})}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL Example Request`,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.sandbox.uqpay.org/api/v1/payers'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'x-client-id: Up1HIsjiETPXLy7gON9PMG'`})]}),`\n`]})})})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`Response`,numberOfLines:`28`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`28`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`200`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`200`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"payer_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"fcf09fa0-1313-41e8-9c1a-2d2721e4251a\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"entity_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"individual\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"first_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"wujing\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"last_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"lee\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"169 Ayer Rajah Crescent, #01-11 Singapore 413091\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"city\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"singapore\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"state_or_province\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"singapore\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SG\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"postal_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"000000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"date_of_birth\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1993-10-12\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"identification_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"passport\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"identification_value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1003123\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get list of payers","api":"GET https://api.sandbox.uqpay.org/api/v1/payers","description":"This endpoint returns a list of payers.","href":"/api-reference/payer/list"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Header","slug":"header","depth":3,"children":[]},{"title":"Parameters","slug":"parameters","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL Example Request","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'https://api.sandbox.uqpay.org/api/v1/payers'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'x-client-id: Up1HIsjiETPXLy7gON9PMG'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"Response","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"28\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">200\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#82071E;--shiki-light-font-style:italic;--shiki-dark:#F44747;--shiki-dark-font-style:inherit\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">200\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"payer_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"fcf09fa0-1313-41e8-9c1a-2d2721e4251a\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"entity_type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"individual\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"first_name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"wujing\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"last_name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"lee\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"address\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"169 Ayer Rajah Crescent, #01-11 Singapore 413091\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"city\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"singapore\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"state_or_province\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"singapore\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"country\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"SG\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"postal_code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"000000\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"date_of_birth\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"1993-10-12\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"identification_type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"passport\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"identification_value\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"1003123\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#82071E;--shiki-light-font-style:italic;--shiki-dark:#F44747;--shiki-dark-font-style:inherit\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Get list of payers","path":"/api/v1/payers","servers":[{"url":"https://api.sandbox.uqpay.org"}],"method":"get","request":{"security":[],"parameters":{"query":{},"header":{"x-client-id":{"schema":[{"type":"string","description":"`x-client-id` .","required":true}]},"x-auth-token":{"schema":[{"type":"string","description":"Bearer `YOUR_TOKEN_HERE` .","required":true}]}},"cookie":{},"path":{}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"code":[{"type":"number","description":"Indicates whether the call was successful. 200 if successful, 400 if not."}],"message":[{"type":"string","description":"Response Message. “Success” if successful, Others not."}],"data":[{"type":"object","properties":{"item_list":[{"type":"array","items":[{"type":"object","properties":{"payer_id":[{"type":"string","description":"Unique UUID for the payer."}],"entity_type":[{"type":"string","description":"Payer’s entity type - company or individual."}],"company_name":[{"type":"string","description":"The name of the company (if the payer is a company)."}],"first_name":[{"type":"string","description":"Payer’s first name."}],"last_name":[{"type":"string","description":"Payer’s last name."}],"address":[{"type":"string","description":"Line of address."}],"city":[{"type":"string","description":"City of the payer."}],"state_or_province":[{"type":"string","description":"State or province of the payer."}],"country":[{"type":"string","description":"Country of the payer. Two-letter ISO country code."}],"postal_code":[{"type":"string","description":"Postal code of the payer."}],"date_of_birth":[{"type":"string","description":"Payer date of birth."}],"identification_type":[{"type":"string","description":"The legal document used to verify the identity of the payer (e.g. passport)."}],"identification_value":[{"type":"string","description":"A unique reference code for the identification document, such as a passport number."}]}}]}]}}]}}],"examples":{"example":{"value":{"code":123,"message":"\u003cstring>","data":{"item_list":[{"payer_id":"\u003cstring>","entity_type":"\u003cstring>","company_name":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","address":"\u003cstring>","city":"\u003cstring>","state_or_province":"\u003cstring>","country":"\u003cstring>","postal_code":"\u003cstring>","date_of_birth":"\u003cstring>","identification_type":"\u003cstring>","identification_value":"\u003cstring>"}]}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"uqpaypteltd","siteName":"UQPAY Docs","title":"Get list of payers - UQPAY Docs","navMaps":{"firstHrefInVersion":{"v1.1":{"href":"/api-reference/payer/list","matchLevel":0},"v1":{"href":"/api-reference/payer/list","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T23:41:17.213Z","originalFileLocation":"api-reference/payer/list.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=\"This endpoint returns a list of payers.\">\u003cmeta data-mint-head name=\"application-name\" content=\"UQPAY Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_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/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_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/uqpaypteltd/uvx0Tz1-Sjn58-6_/_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/uqpaypteltd/uvx0Tz1-Sjn58-6_/_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/uqpaypteltd/uvx0Tz1-Sjn58-6_/_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/uqpaypteltd/uvx0Tz1-Sjn58-6_/_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/uqpaypteltd/uvx0Tz1-Sjn58-6_/_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/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get list of payers - UQPAY Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint returns a list of payers.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"UQPAY Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.uqpay.org/api-reference/payer/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://uqpaypteltd.mintlify.app/_mintlify/api/og/v2?division=Payer\u0026amp;title=Get+list+of+payers\u0026amp;description=This+endpoint+returns+a+list+of+payers.\u0026amp;theme=97bc0a68333c4e9c3ffaebc7\u0026amp;signature=37964456772aeffd052a3c7f992c35e0f066be4badd645813f163362a89f0994\">\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 list of payers - UQPAY Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint returns a list of payers.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uqpaypteltd.mintlify.app/_mintlify/api/og/v2?division=Payer\u0026amp;title=Get+list+of+payers\u0026amp;description=This+endpoint+returns+a+list+of+payers.\u0026amp;theme=97bc0a68333c4e9c3ffaebc7\u0026amp;signature=37964456772aeffd052a3c7f992c35e0f066be4badd645813f163362a89f0994\">\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/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"UQPAY Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2165F4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.uqpay.org/api-reference/payer/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payer/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.uqpay.org/#organization\",\"name\":\"UQPAY Docs\",\"url\":\"https://docs.uqpay.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/uqpaypteltd/uHX3BYExjP-ceVfw/logo/light.svg?fit=max\u0026auto=format\u0026n=uHX3BYExjP-ceVfw\u0026q=85\u0026s=aabcacf707570fb6b63ad12ff4172347\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.uqpay.org#website\",\"name\":\"UQPAY Docs\",\"url\":\"https://docs.uqpay.org\",\"publisher\":{\"@id\":\"https://docs.uqpay.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.uqpay.org/api-reference/payer/list#webpage\",\"url\":\"https://docs.uqpay.org/api-reference/payer/list\",\"name\":\"Get list of payers\",\"description\":\"This endpoint returns a list of payers.\",\"dateModified\":\"2026-01-06T23:41:17.213Z\",\"isPartOf\":{\"@id\":\"https://docs.uqpay.org#website\"},\"breadcrumb\":{\"@id\":\"https://docs.uqpay.org/api-reference/payer/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.uqpay.org/api-reference/payer/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"UQPAY Docs\",\"item\":\"https://docs.uqpay.org\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get list of payers\",\"item\":\"https://docs.uqpay.org/api-reference/payer/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.uqpay.org/api-reference/payer/list#apireference\",\"headline\":\"Get list of payers\",\"name\":\"Get list of payers\",\"description\":\"This endpoint returns a list of payers.\",\"url\":\"https://docs.uqpay.org/api-reference/payer/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.uqpay.org/api-reference/payer/list#webpage\"},\"dateModified\":\"2026-01-06T23:41:17.213Z\",\"publisher\":{\"@id\":\"https://docs.uqpay.org/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.uqpay.org#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"UQPAY Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"UQPAY Docs","nav":{"global":{"anchors":[{"anchor":"Github","href":"https://github.com/uqpay","icon":"github"},{"anchor":"Linkedin","href":"https://www.linkedin.com/company/uqpay/","icon":"linkedin"},{"anchor":"Official Website","href":"https://www.uqpay.com","icon":"globe"}]},"versions":[{"version":"v1.1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API OVERVIEW","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Idempotent Requests","href":"/api-reference/idempotent-requests"}]},{"group":"CORE","pages":[{"group":"Auth","pages":[{"title":"Sign in via API","api":"POST https://api.sandbox.uqpay.org/api/v1/auth/signin","href":"/api-reference/auth/signin"}]},{"group":"Balances","pages":[{"title":"List all balances","api":"GET https://api.sandbox.uqpay.org/api/v1/balances","href":"/api-reference/balance/list"},{"title":"Create a balance","api":"POST https://api.sandbox.uqpay.org/api/v1/balances/create","href":"/api-reference/balance/create"},{"title":"Retrieve a balance","api":"GET https://api.sandbox.uqpay.org/api/v1/balances/retrieve/{currency}","href":"/api-reference/balance/retrieve"},{"title":"Retrieve a bank details","api":"GET https://api.sandbox.uqpay.org/api/v1/balances/{currency}/bank_details","href":"/api-reference/balance/bank_details"},{"title":"List all transactions","api":"GET https://api.sandbox.uqpay.org/api/v1/transactions","href":"/api-reference/transactions/list"}]}]},{"group":"ISSUING","pages":[{"group":"Cards","pages":[{"title":"List all cards","api":"GET https://api.sandbox.uqpay.org/api/v1/cards","href":"/api-reference/card/list"},{"title":"Create a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/create","href":"/api-reference/card/create"},{"title":"Retrieve card details","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/{card_id}","href":"/api-reference/card/retrieve"},{"title":"Retrieve sensitive card details","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/{card_id}/secure","href":"/api-reference/card/secure"},{"title":"Recharge a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/recharge","href":"/api-reference/card/recharge"},{"title":"Withdraw a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/withdraw","href":"/api-reference/card/withdraw"},{"title":"Freeze a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/freeze","href":"/api-reference/card/freeze"},{"title":"Unfreeze a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/unfreeze","href":"/api-reference/card/unfreeze"},{"title":"Update a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/update","href":"/api-reference/card/update"},{"title":"Cancel a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/cancel","href":"/api-reference/card/cancel"},{"title":"Retrieve card operation result","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/record","href":"/api-reference/card/record"}]},{"group":"Products","pages":[{"title":"List Card Products","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/products","href":"/api-reference/card/products"}]},{"group":"Cardholders","pages":[{"title":"List all cardholders","api":"GET https://api.sandbox.uqpay.org/api/v1/cardholders","href":"/api-reference/cardholder/list"},{"title":"Create a cardholder","api":"POST https://api.sandbox.uqpay.org/api/v1/cardholders/create","href":"/api-reference/cardholder/create"},{"title":"Retrieve cardholder details","api":"GET https://api.sandbox.uqpay.org/api/v1/cardholders/{card_holder_id}","href":"/api-reference/cardholder/retrieve"},{"title":"Delete a cardholder","api":"POST https://api.sandbox.uqpay.org/api/v1/cardholders/{card_holder_id}/remove","href":"/api-reference/cardholder/remove"}]},{"group":"Transactions","pages":[{"title":"List all card transactions","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/transactions","description":"This endpoint get list of card transactions.","href":"/api-reference/card_transactions/list"}]}]},{"group":"PAYOUT","pages":[{"group":"Payer","pages":[{"title":"Get list of payers","api":"GET https://api.sandbox.uqpay.org/api/v1/payers","href":"/api-reference/payer/list"}]},{"group":"Payout","pages":[{"title":"List all payouts","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts","description":"This endpoint returns a list of payouts.","href":"/api-reference/payout/list_v1.1"},{"title":"Create a new payout","api":"POST https://api.sandbox.uqpay.org/api/v1/payouts/create","href":"/api-reference/payout/create_v1.1"},{"title":"Retrieve a payout by id","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts/{payout_id}/retrieve","href":"/api-reference/payout/retrieve_v1.1"},{"title":"Get a list of payment methods","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts/paymentmethods","href":"/api-reference/payout/paymentmethods_v1.1"},{"title":"Check payment validation","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts/validation","href":"/api-reference/payout/validation_v1.1"}]},{"group":"Beneficiaries","pages":[{"title":"List all beneficiaries","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries","href":"/api-reference/beneficiaries/list"},{"title":"Create a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/create","href":"/api-reference/beneficiaries/create"},{"title":"Update a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}/update","href":"/api-reference/beneficiaries/update"},{"title":"Delete a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}/delete","href":"/api-reference/beneficiaries/delete"},{"title":"Retrieve a beneficiary by id","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}","href":"/api-reference/beneficiaries/retrieve"},{"title":"Query a beneficiary","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries/query","href":"/api-reference/beneficiaries/query_v1.1"}]}]},{"group":"Webhooks","pages":[{"group":"Payout","pages":[{"title":"Payout webhooks","href":"/api-reference/webhooks/payout/webhooks_1.1"}]},{"group":"Beneficiary","pages":[{"title":"Beneficiaries webhooks","href":"/api-reference/webhooks/beneficiaries/beneficiaries_webhooks_1.1"}]}]}]}]},{"version":"v1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API OVERVIEW","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Idempotent Requests","href":"/api-reference/idempotent-requests"}]},{"group":"CORE","pages":[{"group":"Auth","pages":[{"title":"Sign in via API","api":"POST https://api.sandbox.uqpay.org/api/v1/auth/signin","href":"/api-reference/auth/signin"}]},{"group":"Balances","pages":[{"title":"List all balances","api":"GET https://api.sandbox.uqpay.org/api/v1/balances","href":"/api-reference/balance/list"},{"title":"Create a balance","api":"POST https://api.sandbox.uqpay.org/api/v1/balances/create","href":"/api-reference/balance/create"},{"title":"Retrieve a balance","api":"GET https://api.sandbox.uqpay.org/api/v1/balances/retrieve/{currency}","href":"/api-reference/balance/retrieve"},{"title":"Retrieve a bank details","api":"GET https://api.sandbox.uqpay.org/api/v1/balances/{currency}/bank_details","href":"/api-reference/balance/bank_details"},{"title":"List all transactions","api":"GET https://api.sandbox.uqpay.org/api/v1/transactions","href":"/api-reference/transactions/list"}]}]},{"group":"ISSUING","pages":[{"group":"Cards","pages":[{"title":"List all cards","api":"GET https://api.sandbox.uqpay.org/api/v1/cards","href":"/api-reference/card/list"},{"title":"Create a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/create","href":"/api-reference/card/create"},{"title":"Retrieve card details","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/{card_id}","href":"/api-reference/card/retrieve"},{"title":"Retrieve sensitive card details","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/{card_id}/secure","href":"/api-reference/card/secure"},{"title":"Recharge a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/recharge","href":"/api-reference/card/recharge"},{"title":"Withdraw a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/withdraw","href":"/api-reference/card/withdraw"},{"title":"Freeze a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/freeze","href":"/api-reference/card/freeze"},{"title":"Unfreeze a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/unfreeze","href":"/api-reference/card/unfreeze"},{"title":"Update a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/update","href":"/api-reference/card/update"},{"title":"Cancel a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/cancel","href":"/api-reference/card/cancel"},{"title":"Retrieve card operation result","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/record","href":"/api-reference/card/record"}]},{"group":"Products","pages":[{"title":"List Card Products","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/products","href":"/api-reference/card/products"}]},{"group":"Cardholders","pages":[{"title":"List all cardholders","api":"GET https://api.sandbox.uqpay.org/api/v1/cardholders","href":"/api-reference/cardholder/list"},{"title":"Create a cardholder","api":"POST https://api.sandbox.uqpay.org/api/v1/cardholders/create","href":"/api-reference/cardholder/create"},{"title":"Retrieve cardholder details","api":"GET https://api.sandbox.uqpay.org/api/v1/cardholders/{card_holder_id}","href":"/api-reference/cardholder/retrieve"},{"title":"Delete a cardholder","api":"POST https://api.sandbox.uqpay.org/api/v1/cardholders/{card_holder_id}/remove","href":"/api-reference/cardholder/remove"}]},{"group":"Transactions","pages":[{"title":"List all card transactions","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/transactions","description":"This endpoint get list of card transactions.","href":"/api-reference/card_transactions/list"}]}]},{"group":"PAYOUT","pages":[{"group":"Payer","pages":[{"title":"Get list of payers","api":"GET https://api.sandbox.uqpay.org/api/v1/payers","href":"/api-reference/payer/list"}]},{"group":"Payout","pages":[{"title":"List all payouts","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts","description":"This endpoint returns a list of payouts.","href":"/api-reference/payout/list"},{"title":"Create a new payout","api":"POST https://api.sandbox.uqpay.org/api/v1/payouts/create","href":"/api-reference/payout/create"},{"title":"Retrieve a payout by id","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts/{payout_id}/retrieve","href":"/api-reference/payout/retrieve"}]},{"group":"Beneficiaries","pages":[{"title":"List all beneficiaries","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries","href":"/api-reference/beneficiaries/list"},{"title":"Create a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/create","href":"/api-reference/beneficiaries/create"},{"title":"Update a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}/update","href":"/api-reference/beneficiaries/update"},{"title":"Delete a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}/delete","href":"/api-reference/beneficiaries/delete"},{"title":"Retrieve a beneficiary by id","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}","href":"/api-reference/beneficiaries/retrieve"}]}]}]}]}]},"basePath":"","title":"Get list of payers - UQPAY Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js"]}