Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account.
More information at Connected Accounts.
Unique request identifier of the payout.
Most records carry a UUID v4; records created through legacy or compatibility flows may instead carry a 64-character hexadecimal identifier.
Bank payment reference displayed in the beneficiary's bank transaction records. Sent to the recipient (e.g. For Further Credit, For Benefit of, or a custom message). aka Payment reference in Dashboard.
SWIFT payments: Must comply with the regex /^[a-zA-Z0-9/-?:().'+, ]+$/.
Allowed characters: English letters, digits, spaces, and the following special symbols: - / ? : ( ) . ' + ,.
LOCAL payments: When payment_method = LOCAL and account_currency_code is not CNH or SGD, no input format validation is applied.
The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.
LOCAL: Payment processed through domestic payment networks with local clearing systems.
SWIFT: International payment processed through the SWIFT network for cross-border transfers.
CARD: Payment to card recipients through Mastercard Send. Availability depends on your account authorization and the country, currency, and recipient entity type returned by List Payment Methods.
Details of the currency conversion for the payout.
Required only for cross-currency payout scenarios.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"UQPAY Developer Docs","colors":{"primary":"#1A56DB","light":"#3B82F6","dark":"#1E40AF"},"logo":{"light":"https://mintcdn.com/uqpay-ecc4f4d8/-ww49FTUjAmlhKN6/images/logo-light.png?fit=max\u0026auto=format\u0026n=-ww49FTUjAmlhKN6\u0026q=85\u0026s=f7d617f71b284158f3d0d2a8e2872806","dark":"https://mintcdn.com/uqpay-ecc4f4d8/-ww49FTUjAmlhKN6/images/logo-dark.png?fit=max\u0026auto=format\u0026n=-ww49FTUjAmlhKN6\u0026q=85\u0026s=3fd4b4156eb5c214e01f731ef3f34eb3","href":"/"},"favicon":"https://mintcdn.com/uqpay-ecc4f4d8/LSVZGfPa5IJvbfLG/images/favicon.png?fit=max\u0026auto=format\u0026n=LSVZGfPa5IJvbfLG\u0026q=85\u0026s=b827dc48353a177e8a524fd888b06f90","contextual":{"options":["cursor","vscode","mcp","add-mcp"],"display":"header"},"variables":{"sdk-release-line":"3.1","sdk-node-current":"3.1.0","sdk-python-current":"3.1.0","sdk-go-current":"3.1.0","sdk-java-current":"3.1.0","sdk-cli-current":"3.1.0"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"navbar":{"links":[{"href":"/changelog","label":"Changelog"}]},"href":"account-center/v1.6/guide/overview"},{"language":"zh","navbar":{"links":[{"href":"/zh/changelog","label":"更新日志"}]},"href":"zh/account-center/v1.6/guide/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"uqpay-ecc4f4d8","hasAudioNarration":false,"actualSubdomain":"uqpay-ecc4f4d8","customDomains":["developers-sandbox.uqpaytech.com"],"gitSource":{"type":"github","owner":"marshall-uq","repo":"uqpay-developer-docs","deployBranch":"sandbox","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab7d43e1f314e367e7a139f","collectionId":"cda03377-3e47-4f38-a089-845d2586e57c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab7d43e1f314e367e7a139f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ab7d43e1f314e367e7a139f","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"en","tag":"API Reference","count":136},{"language":"zh","tag":"API 参考","count":136},{"language":"en","tag":"Guide","count":93},{"language":"zh","tag":"指南","count":93},{"language":"en","tag":"Card Issuance","count":78},{"language":"zh","tag":"Card Issuance","count":78},{"language":"en","tag":"Stablecoin Account","count":70},{"language":"zh","tag":"Stablecoin Account","count":66},{"language":"en","tag":"Global Account","count":52},{"language":"zh","tag":"Global Account","count":52},{"language":"en","tag":"AI Knowledge Base","count":47},{"language":"en","tag":"Global Acquiring","count":47},{"language":"zh","tag":"AI 知识库","count":47},{"language":"zh","tag":"Global Acquiring","count":47},{"language":"en","tag":"Webhooks","count":40},{"language":"zh","tag":"Webhooks","count":40},{"language":"en","tag":"Account Center","count":37},{"language":"en","tag":"Card Issuance API","count":37},{"language":"zh","tag":"Account Center","count":37},{"language":"zh","tag":"Card Issuance API","count":37}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","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":"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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#assistant-entry,#assistant-entry-mobile,#chat-assistant-sheet{display:none!important}[data-component-part=products-selector-item]:has(svg[style*=sparkles]),[data-component-part=products-selector-trigger]:has(svg[style*=sparkles]){display:none!important}.landing-page{margin:-1.5rem -1.5rem 0}.landing-hero{padding:5rem 1.5rem 4rem;position:relative;border-bottom:1px solid #e5e7eb}.landing-badge{display:inline-block;padding:.3rem .85rem;background:#eff6ff;border:1px solid #bfdbfe;border-radius:100px;color:#1d4ed8;font-size:.8rem;font-weight:500;letter-spacing:.01em;margin-bottom:1.5rem}.landing-quickstart{margin-top:-2rem;position:relative;z-index:10;padding-bottom:1rem}.landing-steps-container{background:#fff;border-radius:1rem;box-shadow:0 4px 24px rgba(0,0,0,.06),0 1px 3px rgba(0,0,0,.03);border:1px solid #e5e7eb;overflow:hidden}.landing-step{display:flex;align-items:center;gap:1rem;padding:1.25rem 1.5rem;text-decoration:none;transition:background .15s ease;border-right:1px solid #f0f0f0}.landing-step:last-child{border-right:none}.landing-step:hover{background:#f8fafc;text-decoration:none}.landing-step-number{display:flex;align-items:center;justify-content:center;min-width:2.25rem;height:2.25rem;background:#1a56db;color:#fff;font-weight:700;font-size:.85rem;border-radius:.5rem}.landing-step-title{display:block;font-weight:600;font-size:.9rem;color:#111827}.landing-step-desc{display:block;font-size:.8rem;color:#6b7280;margin-top:.1rem}.landing-devtools{background:#f8fafc;border-radius:1.5rem;margin:0 1rem 2rem}.landing-page [class*=Card]{transition:transform .2s ease,box-shadow .2s ease}.landing-page [class*=Card]:hover{transform:translateY(-2px);box-shadow:0 8px 24px rgba(0,0,0,.06)}.dark .landing-hero{border-bottom-color:#1f2937}.dark .landing-badge{background:rgba(29,78,216,.15);border-color:rgba(59,130,246,.3);color:#60a5fa}.dark .landing-steps-container{background:#1f2937;border-color:#374151;box-shadow:0 4px 24px rgba(0,0,0,.3)}.dark .landing-step{border-right-color:#374151}.dark .landing-step:hover{background:#263244}.dark .landing-step-number{background:#2563eb}.dark .landing-step-title{color:#f3f4f6}.dark .landing-step-desc{color:#9ca3af}.dark .landing-devtools{background:#111827}@media (max-width:768px){.landing-step{border-right:none;border-bottom:1px solid #f0f0f0}.landing-step:last-child{border-bottom:none}.dark .landing-step{border-bottom-color:#374151}}@media (min-width:900px){#error-code-table{width:100%!important;min-width:0!important;table-layout:fixed}#error-code-table td,#error-code-table th{min-width:0!important;padding-left:.75rem;padding-right:.75rem;vertical-align:top;overflow-wrap:anywhere}#error-code-table th:nth-child(1){width:20%}#error-code-table th:nth-child(2){width:28%}#error-code-table th:nth-child(3){width:23%}#error-code-table th:nth-child(4){width:29%}#error-code-table code.mint-whitespace-nowrap,#error-code-table code.whitespace-nowrap{display:inline-block;max-width:100%;white-space:normal!important;overflow-wrap:anywhere;word-break:break-word}}"}],"page":{"pagePath":"global-account/v1.6/api-reference/retrieve-payout","slug":"/global-account/v1.6/api-reference/retrieve-payout","pageMetadata":{"title":"Retrieve Payout","description":"Get a specific payout by specifying the payout_id.","deprecated":null,"version":null,"sidebarTitle":"Retrieve payout","openapi":"/global-account/v1.6/banking.yaml get /v1/payouts/{id}","href":"/global-account/v1.6/api-reference/retrieve-payout","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get a specific payout by specifying the payout_id.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve Payout","description":"Get a specific payout by specifying the payout_id.","deprecated":null,"version":null,"sidebarTitle":"Retrieve payout","openapi":"/global-account/v1.6/banking.yaml get /v1/payouts/{id}","href":"/global-account/v1.6/api-reference/retrieve-payout","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/uqpay-ecc4f4d8/77dcf16d44608ed8/error-code-table.js"],"openApiReferenceData":{"operation":{"security":["084c219d-537c-4593-b249-1809a2b0811e"],"summary":"Retrieve Payout","description":"Get a specific payout by specifying the payout_id.","operationId":"retrieve-payout","x-mint":{"href":"/global-account/v1.6/api-reference/retrieve-payout"},"tags":["Payouts"],"parameters":["6c455d5f-b121-4441-b2ce-a51c19a5d3cc","c391ab02-ea84-472a-8e38-b850bc3e1bc5"],"responses":{"200":"ea581af1-2dbe-448f-a398-788816770b07"},"method":"get","type":"path","servers":["7b8025eb-b2f8-41d2-942c-69a2618d52d8","d7c65b2c-f035-4568-86a9-e648acda4f38"],"path":"/v1/payouts/{id}","baseUrlOptions":["https://api-sandbox.uqpaytech.com/api","https://api.uqpay.com/api"],"title":"Retrieve Payout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6c455d5f-b121-4441-b2ce-a51c19a5d3cc":{"in":"header","name":"x-on-behalf-of","schema":{"type":"string","isRequired":false,"description":"Specifies the sub-account on whose behalf the request is made. This should be set to the `account_id`, which can be retrieved via the [List Connected Accounts](/account-center/v1.6/api-reference/list-connected-accounts-1). If omitted or empty, the request is executed using the master account.\nMore information at [Connected Accounts](/account-center/v1.6/guide/connected-accounts).\n","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Specifies the sub-account on whose behalf the request is made. This should be set to the `account_id`, which can be retrieved via the [List Connected Accounts](/account-center/v1.6/api-reference/list-connected-accounts-1). If omitted or empty, the request is executed using the master account.\nMore information at [Connected Accounts](/account-center/v1.6/guide/connected-accounts).\n","example":"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"},"c391ab02-ea84-472a-8e38-b850bc3e1bc5":{"name":"id","description":"Universally unique identifier (UUID v4) of a resource.","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"b3d9d2d5-4c12-4946-a09d-953e82sed2b0","isRequired":true,"description":"Universally unique identifier (UUID v4) of a resource.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"ea581af1-2dbe-448f-a398-788816770b07":{"description":"OK - Successfully retrieved a payout.","headers":{"x-response-id":{"description":"Universally unique identifier (UUID v4) for the response. Helpful for identifying a request when communicating with UQPAY support.","schema":{"type":"string","format":"uuid","example":"2adba88e-9d63-44bc-b975-9b6ae3440dde"}}},"content":{"application/json":{"examples":{"sandbox":{"title":"sandbox","value":{"order_type":"payout","unique_request_id":"44c07172-0363-42c1-a0a9-2a0c45aa3e00","payout_id":"93775b87-dd00-4bb5-be7b-e3a3c048ff5b","amount_payer_pays":"1","payout_currency":"SGD","payout_amount":"1","source_currency":"SGD","source_amount":"1","amount_beneficiary_receives":"-43.6","fee_paid_by":"SHARED","fee_currency":"SGD","fee_amount":"44.6","payout_date":"2026-09-10","short_reference_id":"P260910-UGZ16W43","payout_reference":"contract-44c07172-0363-42c1-a0a9-2a0c45aa3e00","payout_reason":"business expenses","purpose_code":"BUSINESS_EXPENSES","payout_status":"COMPLETED","create_time":"2026-09-10T15:24:34+08:00","update_time":"2026-09-10T15:26:10+08:00","complete_time":"2026-09-10T15:26:10+08:00","payout_method":"LOCAL","payer":{"payer_id":"0","entity_type":"COMPANY","country":"SG","company_name":"UQPAY PTE LTD","first_name":"","last_name":"","city":"Singapore","address":"SampleStreet1","state":"11","postal_code":"1111111","date_birth":"","identification_type":"","identification_value":""},"beneficiary":{"beneficiary_id":"84ae9e5a-5d33-42c5-97e8-ae089027b1ed","short_reference_id":"BF260825-ZWLC6R49","entity_type":"INDIVIDUAL","payment_method":"LOCAL","email":"[email protected]","nickname":"Hosen Hosen","company_name":"","summary":"","id_number":"","first_name":"Hosen","last_name":"Hosen","bank_details":{"bank_name":"DBS BANK LTD","bank_address":"12 MARINA BOULEVARD, MARINA BAY FINANCIAL CENTRE","bank_country_code":"SG","account_holder":"Hosen Hosen","account_currency_code":"SGD","account_number":"445359068","iban":"445359068","swift_code":"DBSSSGSG","clearing_system":"FAST","routing_code_type1":"","routing_code_value1":"","routing_code_type2":"","routing_code_value2":""},"address":{"nationality":"SG","country":"SG","city":"Singapore","street_address":"51 Tuas south ave 1 TUAS COVE INDUSTRIAL CENTRE","postal_code":"637259","state":"Singapore"},"beneficiary_status":"ACTIVE","additional_info":{"organization_code":"","proxy_id":"","msisdn":"","id_type":"","id_number":"","tax_id":""}},"failure_returned_amount":"0","failure_reason":"","quote_id":""}}},"schema":{"type":"object","required":["unique_request_id","payout_id","amount_payer_pays","payout_currency","payout_amount","source_currency","source_amount","amount_beneficiary_receives","fee_paid_by","fee_currency","fee_amount","payout_date","short_reference_id","payout_reference","payout_reason","payout_status","create_time","update_time","complete_time","payout_method","payer","beneficiary","purpose_code"],"properties":{"unique_request_id":{"oneOf":[{"type":"string","title":"UUID","description":"Unique request identifier of the payout.\nMost records carry a UUID v4; records created through legacy or compatibility flows may instead carry a 64-character hexadecimal identifier.\n","format":"uuid","example":"b3d9d2d5-4c12-4946-a09d-953e82sed2b0","isRequired":true,"uniqueKey":"unique_request_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"string","title":"Legacy identifier","description":"Unique request identifier of the payout.\nMost records carry a UUID v4; records created through legacy or compatibility flows may instead carry a 64-character hexadecimal identifier.\n","pattern":"^[0-9a-fA-F]{64}$","example":"b3d9d2d5-4c12-4946-a09d-953e82sed2b0","isRequired":true,"uniqueKey":"unique_request_id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"unique_request_id","typeLabel":"string\u003cuuid> | string"},"payout_id":{"type":"string","format":"uuid","example":"b3d9d2d5-4c12-4946-a09d-953e82sed2b0","description":"Unique identifier for the payout.","isRequired":true,"uniqueKey":"payout_id","typeLabel":"string\u003cuuid>"},"amount_payer_pays":{"type":"string","example":"1000.00","description":"The amount actually paid by the payer for the payout.","isRequired":true,"uniqueKey":"amount_payer_pays","typeLabel":"string"},"payout_currency":{"type":"string","example":"USD","description":"Currency in which money is held in the beneficiary's bank account. Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.","maxLength":3,"minLength":3,"isRequired":true,"uniqueKey":"payout_currency","typeLabel":"string"},"payout_amount":{"type":"string","example":"1000.00","description":"The amount that the payer will send out, in `currency`.\n","isRequired":true,"uniqueKey":"payout_amount","typeLabel":"string"},"purpose_code":{"type":"string","example":"AUDIO_VISUAL_SERVICES","description":"Purpose code of payout and must be one of: \n * `AUDIO_VISUAL_SERVICES` - Audiovisual services.\n * `BILL_PAYMENT` - Bill payment.\n * `BUSINESS_EXPENSES` - Business expenses.\n * `CONSTRUCTION` - Construction.\n * `DONATION_CHARITABLE_CONTRIBUTION` - Donation/charitable contribution.\n * `EDUCATION_TRAINING` - Education/training.\n * `FAMILY_SUPPORT` - Family support.\n * `FREIGHT` - Freight.\n * `GOODS_PURCHASED` - Goods purchased.\n * `INVESTMENT_CAPITAL` - Investment capital.\n * `INVESTMENT_PROCEEDS` - Investment proceeds.\n * `LIVING_EXPENSES` - Living expenses.\n * `LOAN_CREDIT_REPAYMENT` - Loan/credit repayment.\n * `MEDICAL_SERVICES` - Medical services.\n * `PENSION` - Pension.\n * `PERSONAL_REMITTANCE` - Personal remittance.\n * `PROFESSIONAL_BUSINESS_SERVICES` - Professional/business services.\n * `REAL_ESTATE` - Real estate.\n * `TAXES` - Taxes.\n * `TECHNICAL_SERVICES` - Technical services.\n * `TRANSFER_TO_OWN_ACCOUNT` - Transfer to own account.\n * `TRAVEL` - Travel.\n * `WAGES_SALARY` - Wages/salary.\n","isRequired":true,"uniqueKey":"purpose_code","typeLabel":"string"},"source_currency":{"type":"string","example":"USD","description":"The currency that the payer will send out. \n","maxLength":3,"minLength":3,"isRequired":true,"uniqueKey":"source_currency","typeLabel":"string"},"source_amount":{"type":"string","example":"1000.00","description":"The amount paid by the payer for the payout.","isRequired":true,"uniqueKey":"source_amount","typeLabel":"string"},"amount_beneficiary_receives":{"type":"string","example":"1000.00","description":"The amount received by the beneficiary.","isRequired":true,"uniqueKey":"amount_beneficiary_receives","typeLabel":"string"},"fee_paid_by":{"type":"string","example":"SHARED","description":"The charge type of payment fee. Only effective when `payment_method = SWIFT`.\n\n- `SHARED`: Transaction fees are split between payer and recipient; payer pays sending bank fees while recipient pays receiving bank fees.\n- `OURS`: All transaction fees, including intermediary bank charges, are paid by the payer.\n\nAn empty string may be returned for records where the fee allocation mode is unavailable or not applicable.\n","enum":["SHARED","OURS",""],"isRequired":true,"uniqueKey":"fee_paid_by","typeLabel":"enum\u003cstring>"},"fee_currency":{"type":"string","example":"USD","description":"Currency used to pay fees. Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.","maxLength":3,"minLength":3,"isRequired":true,"uniqueKey":"fee_currency","typeLabel":"string"},"fee_amount":{"type":"string","example":"1.00","description":"Fee amount of the payout.","isRequired":true,"uniqueKey":"fee_amount","typeLabel":"string"},"payout_date":{"type":"string","format":"date","example":"2024-03-01","description":"Date of when the system attempt to submit the payment to the beneficiary.","isRequired":true,"uniqueKey":"payout_date","typeLabel":"string\u003cdate>"},"short_reference_id":{"type":"string","example":"P220406-LLCVLRM","description":"The reference generated by the system to identify the payout.","isRequired":true,"uniqueKey":"short_reference_id","typeLabel":"string"},"payout_reference":{"type":"string","maxLength":100,"example":"026073150","description":"Bank payment reference displayed in the beneficiary's bank transaction records. Sent to the recipient (e.g. For Further Credit, For Benefit of, or a custom message). aka Payment reference in Dashboard.\n\n- **SWIFT payments**: Must comply with the regex `/^[a-zA-Z0-9/-?:().'+, ]+$/`. \n Allowed characters: English letters, digits, spaces, and the following special symbols: `- / ? : ( ) . ' + ,`. \n- **LOCAL payments**: When `payment_method = LOCAL` and `account_currency_code` is not CNH or SGD, no input format validation is applied.\n","isRequired":true,"uniqueKey":"payout_reference","typeLabel":"string"},"payout_reason":{"type":"string","maxLength":200,"example":"Audiovisual services","description":"The custom reason for the payout which displayed in the beneficiary's bank transaction records.","isRequired":true,"uniqueKey":"payout_reason","typeLabel":"string"},"payout_status":{"type":"string","description":"The payout's status.\n\n- `READY_TO_SEND`: The payout has been validated and is ready for processing.\n- `PENDING`: The payout is currently being processed by the system.\n- `REJECTED`: The payout was rejected due to validation or compliance requirements not being met.\n- `FAILED`: The payout process encountered an error and could not be completed.\n- `COMPLETED`: The payout has been successfully processed and funds have been transferred.\n","enum":["READY_TO_SEND","PENDING","REJECTED","FAILED","COMPLETED"],"example":"COMPLETED","isRequired":true,"uniqueKey":"payout_status","typeLabel":"enum\u003cstring>"},"create_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Create time of the payout.","isRequired":true,"uniqueKey":"create_time","typeLabel":"string\u003cdate/time>"},"update_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Update time of the payout.","isRequired":true,"uniqueKey":"update_time","typeLabel":"string\u003cdate/time>"},"complete_time":{"oneOf":[{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Completed time of the payout.","isRequired":true,"uniqueKey":"complete_time.oneOf.0","typeLabel":"string\u003cdate/time>"},{"type":"null","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Completed time of the payout.","isRequired":true,"uniqueKey":"complete_time.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"complete_time","typeLabel":"string\u003cdate/time> | null"},"payout_method":{"type":"string","example":"LOCAL","description":"The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.\n\n- `LOCAL`: Payment processed through domestic payment networks with local clearing systems.\n- `SWIFT`: International payment processed through the SWIFT network for cross-border transfers.\n- `CARD`: Payment to card recipients through Mastercard Send. Availability depends on your account authorization and the country, currency, and recipient entity type returned by List Payment Methods.\n","enum":["LOCAL","SWIFT","CARD"],"isRequired":true,"uniqueKey":"payout_method","typeLabel":"enum\u003cstring>"},"payer":{"type":"object","description":"Details of the payer associated with this payout.","properties":{"payer_id":{"oneOf":[{"type":"string","title":"Registered payer","description":"The payer identifier. `0` indicates that the account to which this payout belongs is itself the payer.","format":"uuid","example":"7c4ff2cd-1bf6-4aaa-bf16-266771425011","uniqueKey":"payer.payer_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"string","title":"Payout account as payer","description":"The payer identifier. `0` indicates that the account to which this payout belongs is itself the payer.","enum":["0"],"uniqueKey":"payer.payer_id.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"payer.payer_id","typeLabel":"string\u003cuuid> | enum\u003cstring>"},"entity_type":{"type":"string","description":"Filter on entity type of the Payer.\n\n- `COMPANY`: A registered business entity, corporation, or organization.\n- `INDIVIDUAL`: A natural person acting in their personal capacity.\n","enum":["COMPANY","INDIVIDUAL"],"uniqueKey":"payer.entity_type","typeLabel":"enum\u003cstring>"},"country":{"type":"string","example":"SG","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"uniqueKey":"payer.country","typeLabel":"string"},"company_name":{"type":"string","example":"UQPAY","description":"The name of the company (if the payer is a company).","uniqueKey":"payer.company_name","typeLabel":"string"},"first_name":{"type":"string","maxLength":50,"example":"John","description":"Payer's first name.","uniqueKey":"payer.first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":50,"example":"Doe","description":"Payer's last name.","uniqueKey":"payer.last_name","typeLabel":"string"},"city":{"type":"string","example":"Singapore","maxLength":50,"description":"City of the payer.","uniqueKey":"payer.city","typeLabel":"string"},"address":{"type":"string","example":"123 Main St","maxLength":500,"description":"Line of address.","uniqueKey":"payer.address","typeLabel":"string"},"state":{"type":"string","example":"CA","description":"State or province of the payer.","uniqueKey":"payer.state","typeLabel":"string"},"postal_code":{"type":"string","maxLength":10,"example":"123456","description":"Postal code of the payer.","uniqueKey":"payer.postal_code","typeLabel":"string"},"date_birth":{"type":"string","example":"2001-01-28","description":"Birth date of the payer.","uniqueKey":"payer.date_birth","typeLabel":"string"},"identification_type":{"oneOf":[{"type":"string","title":"Identification type","description":"Type of payer identification. Empty when the response does not provide an identification type.","enum":["PASSPORT","DRIVERS_LICENSE","NATIONAL_ID","NRIC","CERTIFICATE_OF_INCORPORATION"],"example":"PASSPORT","uniqueKey":"payer.identification_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"No identification type","description":"Type of payer identification. Empty when the response does not provide an identification type.","enum":[""],"uniqueKey":"payer.identification_type.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"payer.identification_type","typeLabel":"enum\u003cstring>"},"identification_value":{"type":"string","example":"12345678","description":"A unique reference code for the identification document, such as a passport number.","uniqueKey":"payer.identification_value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payer","typeLabel":"object"},"beneficiary":{"oneOf":[{"type":"object","title":"LOCAL SGD beneficiary with a bank in SG","description":"Beneficiary snapshot saved when the order was created, including Mastercard card expiry.","required":["beneficiary_id","short_reference_id","entity_type","payment_method","email","beneficiary_status","summary","bank_details","address"],"properties":{"payment_method":{"type":"string","description":"The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.\n\n- `LOCAL`: Payment processed through domestic payment networks with local clearing systems.\n- `SWIFT`: International payment processed through the SWIFT network for cross-border transfers.\n- `CARD`: Payment to card recipients through Mastercard Send. Availability depends on your account authorization and the country, currency, and recipient entity type returned by List Payment Methods.\n","enum":["LOCAL"],"example":"LOCAL","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.payment_method","typeLabel":"enum\u003cstring>"},"bank_details":{"type":"object","required":["bank_name","bank_address","bank_country_code","account_holder","account_currency_code","clearing_system","swift_code"],"properties":{"bank_country_code":{"type":"string","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"enum":["SG"],"example":"SG","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.bank_details.bank_country_code","typeLabel":"enum\u003cstring>"},"account_currency_code":{"type":"string","description":"Currency in which money is held in the beneficiary's bank account. Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.","maxLength":3,"minLength":3,"enum":["SGD"],"example":"USD","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.bank_details.account_currency_code","typeLabel":"enum\u003cstring>"},"bank_name":{"type":"string","example":"Bank of America","description":"Name of the bank.","maxLength":240,"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.bank_details.bank_name","typeLabel":"string"},"bank_address":{"type":"string","example":"123 Main St","description":"Address of the bank.","maxLength":240,"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.bank_details.bank_address","typeLabel":"string"},"account_holder":{"type":"string","example":"John Doe","description":"Account holder name of the beneficiary's bank account.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n\n- When `entity_type = INDIVIDUAL`, `bank_details.bank_country_code = SG`, and `bank_details.account_currency_code = SGD`, another validation rules apply:\n * `account_holder` must contain only English alphabetic characters (A–Z, a–z) and spaces. \n * Length must be between 2 and 140 characters. \n * At least one space is required to separate first name and last name. \n- If the `bank_country_code = CN`, `account_currency_code = CNH`, and `payment_method = LOCAL` please provide the account holder name in **Chinese characters**, as required by local banks.\n * Furthermore, when `entity_type = COMPANY`, Chinese parentheses `()` are also supported.\n","maxLength":240,"pattern":"^[a-zA-Z0-9 _().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.bank_details.account_holder","typeLabel":"string"},"swift_code":{"type":"string","example":"WELGBE22","description":"Swift code of the beneficiary's bank account.","maxLength":30,"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.bank_details.swift_code","typeLabel":"string"},"clearing_system":{"type":"string","example":"GIRO","description":"Specifies the clearing system to be used for the transaction. The available options vary by currency and correspond to the local payment infrastructure. \n\n- **USD:** `ACH`, `Fedwire`, `SWIFT`\n- **SGD:** `FAST`, `GIRO`, `RTGS`, `SWIFT`, `PayNow`\n- **CNH:** `LOCAL`, `SWIFT`\n- **HKD:** `ACH`, `FPS`, `RTGS`, `SWIFT`\n- **EUR:** `LOCAL`, `SWIFT`\n- **CAD:** `EFT`, `Interac e-Transfer`, `SWIFT`, `Bill Payment`\n- **MYR:** `LOCAL`\n- **GBP:** `Faster Payments`, `CHAPS`, `SWIFT`\n- **IDR:** `LOCAL`\n- **JPY:** `LOCAL`, `SWIFT`\n- **NZD:** `Bank Transfer`, `SWIFT`\n- **AUD:** `Bank Transfer`, `SWIFT`\n\nFor CARD, submit MASTERCARD SEND in bank_details.clearing_system. List Payment Methods returns MASTERCARD SEND in clearing_systems.\n","maxLength":30,"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.bank_details.clearing_system","typeLabel":"string"},"account_number":{"type":"string","example":"12345678","description":"Account number, mostly for non-european countries, either account_number or iban should be filled.\n\nOnly English letters (uppercase and lowercase) and digits are allowed; dashes or other special characters are not permitted.\n","pattern":"^[a-zA-Z0-9]*$","maxLength":60,"uniqueKey":"beneficiary.oneOf.0.bank_details.account_number","typeLabel":"string"},"iban":{"type":"string","example":"GB82 WEST 1234 5698 7654 32","description":"For the following countries/regions, **IBAN is mandatory** (mostly applicable to European and some other countries):\n\n**Country Codes**:\n`AL`, `AD`, `AT`, `AZ`, `BH`, `BY`, `BE`, `BA`, `BR`, `BG`, `CR`, `HR`, `CY`, `CZ`, `DK`, `DO`, `EG`, `SV`, `EE`, `FO`, `FI`, `FR`, `GE`, `DE`, `GI`, `GR`, `GL`, `GT`, `VA`, `HU`, `IS`, `IQ`, `IE`, `IL`, `IT`, `JO`, `KZ`, `XK`, `KW`, `LV`, `LB`, `LY`, `LI`, `LT`, `LU`, `MT`, `MR`, `MU`, `MD`, `MC`, `ME`, `NL`, `MK`, `NO`, `PK`, `PS`, `PL`, `PT`, `QA`, `RO`, `LC`, `SM`, `ST`, `SA`, `RS`, `SC`, `SK`, `SI`, `ES`, `SD`, `SE`, `CH`, `TL`, `TN`, `TR`, `UA`, `AE`, `GB`, `VG`.\n\nIf the beneficiary bank is located in any of the above-listed countries/regions, **IBAN must be provided**.\n","maxLength":36,"uniqueKey":"beneficiary.oneOf.0.bank_details.iban","typeLabel":"string"},"routing_code_type1":{"type":"string","example":"aba","description":"Routing code type, must be one of: \n * `ach` - Required when account_currency_code = \"USD\" and clearing_system = \"ACH\".\n * `aba` \n - Required when account_currency_code = \"USD\" and clearing_system = \"FEDWIRE\".\n - Required when account_currency_code = \"USD\" and clearing_system = \"SWIFT\" and bank_country_code = \"US\"\n * `bank_code` - Required when account_currency_code = \"CAD\" and clearing_system = \"EFT\" OR account_currency_code = \"HKD\" and clearing_system = \"LOCAL\".\n * `sort_code` - Required when account_currency_code = \"GBP\" and clearing_system = \"FASTER PAYMENTS\". **Must be exactly 6 digits.**\n * `bsb_code` - Required when account_currency_code = \"AUD\" and clearing_system = \"LOCAL\".\n * `ifsc` - Required when account_currency_code = \"INR\" and clearing_system = \"IFSC\".\n * `cnaps_number` - Required when account_currency_code = \"CNH\" and bank_country_code = \"CN\".\n","maxLength":12,"uniqueKey":"beneficiary.oneOf.0.bank_details.routing_code_type1","typeLabel":"string"},"routing_code_value1":{"type":"string","example":"123456789","description":"Routing code value.Routing code for routing_code_type_1.If supplied, routing_code_type_1 should also be supplied.","maxLength":48,"uniqueKey":"beneficiary.oneOf.0.bank_details.routing_code_value1","typeLabel":"string"},"routing_code_type2":{"type":"string","example":"ach","description":"Routing code sub type.\n * `branch_code` - Required when account_currency_code = \"CAD\" and clearing_system = \"EFT\".\n","maxLength":12,"uniqueKey":"beneficiary.oneOf.0.bank_details.routing_code_type2","typeLabel":"string"},"routing_code_value2":{"type":"string","example":"123456789","description":"Routing code sub type value.Routing code for routing_code_type_2.If supplied, routing_code_type_2 should also be supplied.","maxLength":48,"uniqueKey":"beneficiary.oneOf.0.bank_details.routing_code_value2","typeLabel":"string"},"card_expiry":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$","description":"Card expiry month. Required for Mastercard Send. Use YYYY-MM; the current month is accepted, past months are rejected. Checked again for new payouts.","uniqueKey":"beneficiary.oneOf.0.bank_details.card_expiry","typeLabel":"string"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.bank_details","typeLabel":"object"},"address":{"oneOf":[{"type":"object","title":"Bank beneficiary address","description":"For LOCAL payments to a bank in SG with account currency SGD, city, state, and street_address may be empty strings when not provided. Non-empty values follow the corresponding field constraints. Other routes require a complete address.\n","required":["country","city","street_address","postal_code","state"],"properties":{"country":{"type":"string","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"example":"SG","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.country","typeLabel":"string"},"city":{"oneOf":[{"type":"string","title":"Provided city","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided city","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.city.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.city.oneOf.3","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.city","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"},"street_address":{"oneOf":[{"type":"string","title":"Provided street address","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.street_address.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.street_address.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided street address","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.street_address.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.street_address.oneOf.3","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.street_address","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"},"postal_code":{"type":"string","description":"Postal code of the beneficiary.","maxLength":12,"example":"123456","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.postal_code","typeLabel":"string"},"state":{"oneOf":[{"type":"string","title":"Provided state","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided state","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.state.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.state.oneOf.3","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.state","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"},"nationality":{"oneOf":[{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"example":"SG","uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.nationality.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"enum":[""],"example":"SG","uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.nationality.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"enum":[""],"example":"SG","uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.nationality.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","enum":[""],"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.nationality.oneOf.3","typeLabel":"enum\u003cstring>"}],"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0.nationality","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.0","typeLabel":"Bank beneficiary address · object"},{"type":"object","title":"Mastercard beneficiary address","description":"Mastercard beneficiary address. An individual country can be empty when not provided.","required":["country","city","street_address","postal_code","state"],"properties":{"country":{"oneOf":[{"type":"string","title":"Provided country","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"example":"SG","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.country.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"enum":[""],"example":"SG","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.country.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.country","typeLabel":"string | enum\u003cstring>"},"city":{"oneOf":[{"type":"string","title":"Provided city","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.city.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.city.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided city","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.city.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.city.oneOf.3","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.city","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"},"street_address":{"oneOf":[{"type":"string","title":"Provided street address","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.street_address.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.street_address.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided street address","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.street_address.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.street_address.oneOf.3","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.street_address","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"},"postal_code":{"type":"string","description":"Postal code of the beneficiary.","maxLength":12,"example":"123456","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.postal_code","typeLabel":"string"},"state":{"oneOf":[{"type":"string","title":"Provided state","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.state.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided state","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.state.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.state.oneOf.3","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.state","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"},"nationality":{"oneOf":[{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"example":"SG","uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.nationality.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"enum":[""],"example":"SG","uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.nationality.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"enum":[""],"example":"SG","uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.nationality.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","enum":[""],"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.nationality.oneOf.3","typeLabel":"enum\u003cstring>"}],"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1.nationality","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address.oneOf.1","typeLabel":"Mastercard beneficiary address · object"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.address","typeLabel":"Bank beneficiary address · object | Mastercard beneficiary address · object"},"beneficiary_id":{"type":"string","format":"uuid","example":"b3d9d2d5-4c12-4946-a09d-953e82sed2b0","description":"Universally unique identifier (UUID v4) of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.beneficiary_id","typeLabel":"string\u003cuuid>"},"short_reference_id":{"type":"string","example":"P220406-LLCVLRM","description":"The reference generated by the system to identify the entity.","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.short_reference_id","typeLabel":"string"},"entity_type":{"type":"string","description":"Specifies the type of beneficiary entity to filter by. Valid values are:\n- `COMPANY` : corporate entities \n- `INDIVIDUAL` : personal accounts\n","enum":["COMPANY","INDIVIDUAL"],"example":"COMPANY","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.entity_type","typeLabel":"enum\u003cstring>"},"email":{"type":"string","example":"[email protected]","description":"Email address of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.email","typeLabel":"string"},"beneficiary_status":{"type":"string","example":"ACTIVE","description":"Status of the beneficiary.\n\n- `ACTIVE`: The beneficiary has been fully verified and is eligible to receive payments.\n- `PENDING`: The beneficiary is undergoing verification process and cannot yet receive payments.\n","enum":["ACTIVE","PENDING"],"isRequired":true,"uniqueKey":"beneficiary.oneOf.0.beneficiary_status","typeLabel":"enum\u003cstring>"},"summary":{"type":"string","example":"John Doe","description":"Summary of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.0.summary","typeLabel":"string"},"nickname":{"type":"string","example":"John Doe","description":"Nickname of the beneficiary.","maxLength":120,"uniqueKey":"beneficiary.oneOf.0.nickname","typeLabel":"string"},"company_name":{"type":"string","example":"UQPAY TECHNOLOGY SG PTE LTD","description":"Company name of the beneficiary, only exist when the entity_type is COMPANY.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n- When `bank_country_code = CN` \u0026 `account_currency_code = CNH` \u0026 `payment_method = LOCAL` \u0026 `entity_type = COMPANY`, Chinese characters and Chinese parentheses `()` are supported.\n","maxLength":120,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.0.company_name","typeLabel":"string"},"first_name":{"type":"string","example":"John","description":"First name of the beneficiary, only exist when the entity_type is INDIVIDUAL.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n","maxLength":45,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.0.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","description":"Last name of the beneficiary, only exist when the entity_type is INDIVIDUAL.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n","maxLength":45,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.0.last_name","typeLabel":"string"},"id_number":{"type":"string","example":"110101199001011234","description":"The identification number of the individual beneficiary. \nMandatory when the beneficiary is a Mainland China resident and the following conditions are met: \n- `bank_details.account_currency_code` is `CNH` \n- `payment_method` is `LOCAL`\n","uniqueKey":"beneficiary.oneOf.0.id_number","typeLabel":"string"},"create_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Create time of the beneficiary.","uniqueKey":"beneficiary.oneOf.0.create_time","typeLabel":"string\u003cdate/time>"},"update_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Update time of the beneficiary.","uniqueKey":"beneficiary.oneOf.0.update_time","typeLabel":"string\u003cdate/time>"},"additional_info":{"type":"object","description":"Additional information for beneficiaries.\n","properties":{"organization_code":{"type":"string","example":"91210106MA0P46BWXY","description":"The Unified Social Credit Identifier assigned to the organization. This field is for companies registered in Mainland China.","uniqueKey":"beneficiary.oneOf.0.additional_info.organization_code","typeLabel":"string"},"proxy_id":{"type":"string","description":"PayNow proxy identifier (SGD). Supports UEN, phone number, or VPA as the value.","uniqueKey":"beneficiary.oneOf.0.additional_info.proxy_id","typeLabel":"string"},"id_type":{"type":"string","example":"PASSPORT","description":"Identification document type for individual beneficiaries.\nMay be returned as an empty string on records where it is not applicable.\n","enum":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE",""],"uniqueKey":"beneficiary.oneOf.0.additional_info.id_type","typeLabel":"enum\u003cstring>"},"id_number":{"type":"string","example":"AB1234567","description":"Identification number for individual beneficiaries.\n","uniqueKey":"beneficiary.oneOf.0.additional_info.id_number","typeLabel":"string"},"tax_id":{"type":"string","example":"123456789","description":"Tax identification number for company beneficiaries.\n","uniqueKey":"beneficiary.oneOf.0.additional_info.tax_id","typeLabel":"string"},"msisdn":{"type":"string","example":"+65111111","description":"Mobile phone number in international format with country code.\n","uniqueKey":"beneficiary.oneOf.0.additional_info.msisdn","typeLabel":"string"}},"uniqueKey":"beneficiary.oneOf.0.additional_info","typeLabel":"object"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.0","typeLabel":"LOCAL SGD beneficiary with a bank in SG · object"},{"type":"object","title":"Beneficiary with a complete address","description":"Beneficiary snapshot saved when the order was created, including Mastercard card expiry.","required":["beneficiary_id","short_reference_id","entity_type","payment_method","email","beneficiary_status","summary","bank_details","address"],"properties":{"address":{"oneOf":[{"type":"object","title":"Bank beneficiary address","description":"For LOCAL payments to a bank in SG with account currency SGD, city, state, and street_address may be empty strings when not provided. Non-empty values follow the corresponding field constraints. Other routes require a complete address.\n","required":["country","city","street_address","postal_code","state"],"properties":{"country":{"type":"string","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"example":"SG","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.country","typeLabel":"string"},"city":{"oneOf":[{"type":"string","title":"Provided city","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.city.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.city","typeLabel":"string | enum\u003cstring>"},"street_address":{"oneOf":[{"type":"string","title":"Provided street address","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.street_address.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.street_address.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.street_address","typeLabel":"string | enum\u003cstring>"},"postal_code":{"type":"string","description":"Postal code of the beneficiary.","maxLength":12,"example":"123456","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.postal_code","typeLabel":"string"},"state":{"oneOf":[{"type":"string","title":"Provided state","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.state.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.state","typeLabel":"string | enum\u003cstring>"},"nationality":{"oneOf":[{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"example":"SG","uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.nationality.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"enum":[""],"example":"SG","uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.nationality.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"enum":[""],"example":"SG","uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.nationality.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","enum":[""],"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.nationality.oneOf.3","typeLabel":"enum\u003cstring>"}],"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0.nationality","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.0","typeLabel":"Bank beneficiary address · object"},{"type":"object","title":"Mastercard beneficiary address","description":"Mastercard beneficiary address. An individual country can be empty when not provided.","required":["country","city","street_address","postal_code","state"],"properties":{"country":{"oneOf":[{"type":"string","title":"Provided country","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"example":"SG","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.country.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"enum":[""],"example":"SG","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.country.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.country","typeLabel":"string | enum\u003cstring>"},"city":{"oneOf":[{"type":"string","title":"Provided city","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.city.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.city.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.city","typeLabel":"string | enum\u003cstring>"},"street_address":{"oneOf":[{"type":"string","title":"Provided street address","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.street_address.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.street_address.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.street_address","typeLabel":"string | enum\u003cstring>"},"postal_code":{"type":"string","description":"Postal code of the beneficiary.","maxLength":12,"example":"123456","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.postal_code","typeLabel":"string"},"state":{"oneOf":[{"type":"string","title":"Provided state","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","enum":[""],"example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.state.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.state","typeLabel":"string | enum\u003cstring>"},"nationality":{"oneOf":[{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"example":"SG","uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.nationality.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"enum":[""],"example":"SG","uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.nationality.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"enum":[""],"example":"SG","uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.nationality.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","enum":[""],"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.nationality.oneOf.3","typeLabel":"enum\u003cstring>"}],"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1.nationality","typeLabel":"string · enum\u003cstring> · enum\u003cstring> · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address.oneOf.1","typeLabel":"Mastercard beneficiary address · object"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.address","typeLabel":"Bank beneficiary address · object | Mastercard beneficiary address · object"},"beneficiary_id":{"type":"string","format":"uuid","example":"b3d9d2d5-4c12-4946-a09d-953e82sed2b0","description":"Universally unique identifier (UUID v4) of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.beneficiary_id","typeLabel":"string\u003cuuid>"},"short_reference_id":{"type":"string","example":"P220406-LLCVLRM","description":"The reference generated by the system to identify the entity.","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.short_reference_id","typeLabel":"string"},"entity_type":{"type":"string","description":"Specifies the type of beneficiary entity to filter by. Valid values are:\n- `COMPANY` : corporate entities \n- `INDIVIDUAL` : personal accounts\n","enum":["COMPANY","INDIVIDUAL"],"example":"COMPANY","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.entity_type","typeLabel":"enum\u003cstring>"},"payment_method":{"type":"string","example":"LOCAL","description":"The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.\n\n- `LOCAL`: Payment processed through domestic payment networks with local clearing systems.\n- `SWIFT`: International payment processed through the SWIFT network for cross-border transfers.\n- `CARD`: Payment to card recipients through Mastercard Send. Availability depends on your account authorization and the country, currency, and recipient entity type returned by List Payment Methods.\n","enum":["LOCAL","SWIFT","CARD"],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.payment_method","typeLabel":"enum\u003cstring>"},"email":{"type":"string","example":"[email protected]","description":"Email address of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.email","typeLabel":"string"},"beneficiary_status":{"type":"string","example":"ACTIVE","description":"Status of the beneficiary.\n\n- `ACTIVE`: The beneficiary has been fully verified and is eligible to receive payments.\n- `PENDING`: The beneficiary is undergoing verification process and cannot yet receive payments.\n","enum":["ACTIVE","PENDING"],"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.beneficiary_status","typeLabel":"enum\u003cstring>"},"summary":{"type":"string","example":"John Doe","description":"Summary of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.summary","typeLabel":"string"},"bank_details":{"type":"object","required":["bank_name","bank_address","bank_country_code","account_holder","account_currency_code","clearing_system","swift_code"],"properties":{"bank_name":{"type":"string","example":"Bank of America","description":"Name of the bank.","maxLength":240,"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.bank_details.bank_name","typeLabel":"string"},"bank_address":{"type":"string","example":"123 Main St","description":"Address of the bank.","maxLength":240,"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.bank_details.bank_address","typeLabel":"string"},"bank_country_code":{"type":"string","example":"SG","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.bank_details.bank_country_code","typeLabel":"string"},"account_holder":{"type":"string","example":"John Doe","description":"Account holder name of the beneficiary's bank account.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n\n- When `entity_type = INDIVIDUAL`, `bank_details.bank_country_code = SG`, and `bank_details.account_currency_code = SGD`, another validation rules apply:\n * `account_holder` must contain only English alphabetic characters (A–Z, a–z) and spaces. \n * Length must be between 2 and 140 characters. \n * At least one space is required to separate first name and last name. \n- If the `bank_country_code = CN`, `account_currency_code = CNH`, and `payment_method = LOCAL` please provide the account holder name in **Chinese characters**, as required by local banks.\n * Furthermore, when `entity_type = COMPANY`, Chinese parentheses `()` are also supported.\n","maxLength":240,"pattern":"^[a-zA-Z0-9 _().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","isRequired":true,"uniqueKey":"beneficiary.oneOf.1.bank_details.account_holder","typeLabel":"string"},"account_currency_code":{"type":"string","example":"USD","description":"Currency in which money is held in the beneficiary's bank account. Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.","maxLength":3,"minLength":3,"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.bank_details.account_currency_code","typeLabel":"string"},"swift_code":{"type":"string","example":"WELGBE22","description":"Swift code of the beneficiary's bank account.","maxLength":30,"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.bank_details.swift_code","typeLabel":"string"},"clearing_system":{"type":"string","example":"GIRO","description":"Specifies the clearing system to be used for the transaction. The available options vary by currency and correspond to the local payment infrastructure. \n\n- **USD:** `ACH`, `Fedwire`, `SWIFT`\n- **SGD:** `FAST`, `GIRO`, `RTGS`, `SWIFT`, `PayNow`\n- **CNH:** `LOCAL`, `SWIFT`\n- **HKD:** `ACH`, `FPS`, `RTGS`, `SWIFT`\n- **EUR:** `LOCAL`, `SWIFT`\n- **CAD:** `EFT`, `Interac e-Transfer`, `SWIFT`, `Bill Payment`\n- **MYR:** `LOCAL`\n- **GBP:** `Faster Payments`, `CHAPS`, `SWIFT`\n- **IDR:** `LOCAL`\n- **JPY:** `LOCAL`, `SWIFT`\n- **NZD:** `Bank Transfer`, `SWIFT`\n- **AUD:** `Bank Transfer`, `SWIFT`\n\nFor CARD, submit MASTERCARD SEND in bank_details.clearing_system. List Payment Methods returns MASTERCARD SEND in clearing_systems.\n","maxLength":30,"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.bank_details.clearing_system","typeLabel":"string"},"account_number":{"type":"string","example":"12345678","description":"Account number, mostly for non-european countries, either account_number or iban should be filled.\n\nOnly English letters (uppercase and lowercase) and digits are allowed; dashes or other special characters are not permitted.\n","pattern":"^[a-zA-Z0-9]*$","maxLength":60,"uniqueKey":"beneficiary.oneOf.1.bank_details.account_number","typeLabel":"string"},"iban":{"type":"string","example":"GB82 WEST 1234 5698 7654 32","description":"For the following countries/regions, **IBAN is mandatory** (mostly applicable to European and some other countries):\n\n**Country Codes**:\n`AL`, `AD`, `AT`, `AZ`, `BH`, `BY`, `BE`, `BA`, `BR`, `BG`, `CR`, `HR`, `CY`, `CZ`, `DK`, `DO`, `EG`, `SV`, `EE`, `FO`, `FI`, `FR`, `GE`, `DE`, `GI`, `GR`, `GL`, `GT`, `VA`, `HU`, `IS`, `IQ`, `IE`, `IL`, `IT`, `JO`, `KZ`, `XK`, `KW`, `LV`, `LB`, `LY`, `LI`, `LT`, `LU`, `MT`, `MR`, `MU`, `MD`, `MC`, `ME`, `NL`, `MK`, `NO`, `PK`, `PS`, `PL`, `PT`, `QA`, `RO`, `LC`, `SM`, `ST`, `SA`, `RS`, `SC`, `SK`, `SI`, `ES`, `SD`, `SE`, `CH`, `TL`, `TN`, `TR`, `UA`, `AE`, `GB`, `VG`.\n\nIf the beneficiary bank is located in any of the above-listed countries/regions, **IBAN must be provided**.\n","maxLength":36,"uniqueKey":"beneficiary.oneOf.1.bank_details.iban","typeLabel":"string"},"routing_code_type1":{"type":"string","example":"aba","description":"Routing code type, must be one of: \n * `ach` - Required when account_currency_code = \"USD\" and clearing_system = \"ACH\".\n * `aba` \n - Required when account_currency_code = \"USD\" and clearing_system = \"FEDWIRE\".\n - Required when account_currency_code = \"USD\" and clearing_system = \"SWIFT\" and bank_country_code = \"US\"\n * `bank_code` - Required when account_currency_code = \"CAD\" and clearing_system = \"EFT\" OR account_currency_code = \"HKD\" and clearing_system = \"LOCAL\".\n * `sort_code` - Required when account_currency_code = \"GBP\" and clearing_system = \"FASTER PAYMENTS\". **Must be exactly 6 digits.**\n * `bsb_code` - Required when account_currency_code = \"AUD\" and clearing_system = \"LOCAL\".\n * `ifsc` - Required when account_currency_code = \"INR\" and clearing_system = \"IFSC\".\n * `cnaps_number` - Required when account_currency_code = \"CNH\" and bank_country_code = \"CN\".\n","maxLength":12,"uniqueKey":"beneficiary.oneOf.1.bank_details.routing_code_type1","typeLabel":"string"},"routing_code_value1":{"type":"string","example":"123456789","description":"Routing code value.Routing code for routing_code_type_1.If supplied, routing_code_type_1 should also be supplied.","maxLength":48,"uniqueKey":"beneficiary.oneOf.1.bank_details.routing_code_value1","typeLabel":"string"},"routing_code_type2":{"type":"string","example":"ach","description":"Routing code sub type.\n * `branch_code` - Required when account_currency_code = \"CAD\" and clearing_system = \"EFT\".\n","maxLength":12,"uniqueKey":"beneficiary.oneOf.1.bank_details.routing_code_type2","typeLabel":"string"},"routing_code_value2":{"type":"string","example":"123456789","description":"Routing code sub type value.Routing code for routing_code_type_2.If supplied, routing_code_type_2 should also be supplied.","maxLength":48,"uniqueKey":"beneficiary.oneOf.1.bank_details.routing_code_value2","typeLabel":"string"},"card_expiry":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$","description":"Card expiry month. Required for Mastercard Send. Use YYYY-MM; the current month is accepted, past months are rejected. Checked again for new payouts.","uniqueKey":"beneficiary.oneOf.1.bank_details.card_expiry","typeLabel":"string"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.1.bank_details","typeLabel":"object"},"nickname":{"type":"string","example":"John Doe","description":"Nickname of the beneficiary.","maxLength":120,"uniqueKey":"beneficiary.oneOf.1.nickname","typeLabel":"string"},"company_name":{"type":"string","example":"UQPAY TECHNOLOGY SG PTE LTD","description":"Company name of the beneficiary, only exist when the entity_type is COMPANY.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n- When `bank_country_code = CN` \u0026 `account_currency_code = CNH` \u0026 `payment_method = LOCAL` \u0026 `entity_type = COMPANY`, Chinese characters and Chinese parentheses `()` are supported.\n","maxLength":120,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.1.company_name","typeLabel":"string"},"first_name":{"type":"string","example":"John","description":"First name of the beneficiary, only exist when the entity_type is INDIVIDUAL.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n","maxLength":45,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.1.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","description":"Last name of the beneficiary, only exist when the entity_type is INDIVIDUAL.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n","maxLength":45,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.1.last_name","typeLabel":"string"},"id_number":{"type":"string","example":"110101199001011234","description":"The identification number of the individual beneficiary. \nMandatory when the beneficiary is a Mainland China resident and the following conditions are met: \n- `bank_details.account_currency_code` is `CNH` \n- `payment_method` is `LOCAL`\n","uniqueKey":"beneficiary.oneOf.1.id_number","typeLabel":"string"},"create_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Create time of the beneficiary.","uniqueKey":"beneficiary.oneOf.1.create_time","typeLabel":"string\u003cdate/time>"},"update_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Update time of the beneficiary.","uniqueKey":"beneficiary.oneOf.1.update_time","typeLabel":"string\u003cdate/time>"},"additional_info":{"type":"object","description":"Additional information for beneficiaries.\n","properties":{"organization_code":{"type":"string","example":"91210106MA0P46BWXY","description":"The Unified Social Credit Identifier assigned to the organization. This field is for companies registered in Mainland China.","uniqueKey":"beneficiary.oneOf.1.additional_info.organization_code","typeLabel":"string"},"proxy_id":{"type":"string","description":"PayNow proxy identifier (SGD). Supports UEN, phone number, or VPA as the value.","uniqueKey":"beneficiary.oneOf.1.additional_info.proxy_id","typeLabel":"string"},"id_type":{"type":"string","example":"PASSPORT","description":"Identification document type for individual beneficiaries.\nMay be returned as an empty string on records where it is not applicable.\n","enum":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE",""],"uniqueKey":"beneficiary.oneOf.1.additional_info.id_type","typeLabel":"enum\u003cstring>"},"id_number":{"type":"string","example":"AB1234567","description":"Identification number for individual beneficiaries.\n","uniqueKey":"beneficiary.oneOf.1.additional_info.id_number","typeLabel":"string"},"tax_id":{"type":"string","example":"123456789","description":"Tax identification number for company beneficiaries.\n","uniqueKey":"beneficiary.oneOf.1.additional_info.tax_id","typeLabel":"string"},"msisdn":{"type":"string","example":"+65111111","description":"Mobile phone number in international format with country code.\n","uniqueKey":"beneficiary.oneOf.1.additional_info.msisdn","typeLabel":"string"}},"uniqueKey":"beneficiary.oneOf.1.additional_info","typeLabel":"object"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.1","typeLabel":"Beneficiary with a complete address · object"},{"type":"object","title":"Mastercard beneficiary","description":"Beneficiary snapshot saved when the order was created, including Mastercard card expiry.","required":["beneficiary_id","short_reference_id","entity_type","payment_method","email","beneficiary_status","summary","bank_details","address"],"properties":{"payment_method":{"type":"string","description":"The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.\n\n- `LOCAL`: Payment processed through domestic payment networks with local clearing systems.\n- `SWIFT`: International payment processed through the SWIFT network for cross-border transfers.\n- `CARD`: Payment to card recipients through Mastercard Send. Availability depends on your account authorization and the country, currency, and recipient entity type returned by List Payment Methods.\n","enum":["CARD"],"example":"LOCAL","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.payment_method","typeLabel":"enum\u003cstring>"},"beneficiary_id":{"type":"string","format":"uuid","example":"b3d9d2d5-4c12-4946-a09d-953e82sed2b0","description":"Universally unique identifier (UUID v4) of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.beneficiary_id","typeLabel":"string\u003cuuid>"},"short_reference_id":{"type":"string","example":"P220406-LLCVLRM","description":"The reference generated by the system to identify the entity.","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.short_reference_id","typeLabel":"string"},"entity_type":{"type":"string","description":"Specifies the type of beneficiary entity to filter by. Valid values are:\n- `COMPANY` : corporate entities \n- `INDIVIDUAL` : personal accounts\n","enum":["COMPANY","INDIVIDUAL"],"example":"COMPANY","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.entity_type","typeLabel":"enum\u003cstring>"},"email":{"type":"string","example":"[email protected]","description":"Email address of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.email","typeLabel":"string"},"beneficiary_status":{"type":"string","example":"ACTIVE","description":"Status of the beneficiary.\n\n- `ACTIVE`: The beneficiary has been fully verified and is eligible to receive payments.\n- `PENDING`: The beneficiary is undergoing verification process and cannot yet receive payments.\n","enum":["ACTIVE","PENDING"],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.beneficiary_status","typeLabel":"enum\u003cstring>"},"summary":{"type":"string","example":"John Doe","description":"Summary of the beneficiary.","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.summary","typeLabel":"string"},"bank_details":{"type":"object","required":["bank_name","bank_address","bank_country_code","account_holder","account_currency_code","clearing_system","swift_code"],"properties":{"bank_name":{"type":"string","example":"Bank of America","description":"Name of the bank.","maxLength":240,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.bank_details.bank_name","typeLabel":"string"},"bank_address":{"type":"string","example":"123 Main St","description":"Address of the bank.","maxLength":240,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.bank_details.bank_address","typeLabel":"string"},"bank_country_code":{"type":"string","example":"SG","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.bank_details.bank_country_code","typeLabel":"string"},"account_holder":{"type":"string","example":"John Doe","description":"Account holder name of the beneficiary's bank account.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n\n- When `entity_type = INDIVIDUAL`, `bank_details.bank_country_code = SG`, and `bank_details.account_currency_code = SGD`, another validation rules apply:\n * `account_holder` must contain only English alphabetic characters (A–Z, a–z) and spaces. \n * Length must be between 2 and 140 characters. \n * At least one space is required to separate first name and last name. \n- If the `bank_country_code = CN`, `account_currency_code = CNH`, and `payment_method = LOCAL` please provide the account holder name in **Chinese characters**, as required by local banks.\n * Furthermore, when `entity_type = COMPANY`, Chinese parentheses `()` are also supported.\n","maxLength":240,"pattern":"^[a-zA-Z0-9 _().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.bank_details.account_holder","typeLabel":"string"},"account_currency_code":{"type":"string","example":"USD","description":"Currency in which money is held in the beneficiary's bank account. Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.","maxLength":3,"minLength":3,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.bank_details.account_currency_code","typeLabel":"string"},"swift_code":{"type":"string","example":"WELGBE22","description":"Swift code of the beneficiary's bank account.","maxLength":30,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.bank_details.swift_code","typeLabel":"string"},"clearing_system":{"type":"string","example":"GIRO","description":"Specifies the clearing system to be used for the transaction. The available options vary by currency and correspond to the local payment infrastructure. \n\n- **USD:** `ACH`, `Fedwire`, `SWIFT`\n- **SGD:** `FAST`, `GIRO`, `RTGS`, `SWIFT`, `PayNow`\n- **CNH:** `LOCAL`, `SWIFT`\n- **HKD:** `ACH`, `FPS`, `RTGS`, `SWIFT`\n- **EUR:** `LOCAL`, `SWIFT`\n- **CAD:** `EFT`, `Interac e-Transfer`, `SWIFT`, `Bill Payment`\n- **MYR:** `LOCAL`\n- **GBP:** `Faster Payments`, `CHAPS`, `SWIFT`\n- **IDR:** `LOCAL`\n- **JPY:** `LOCAL`, `SWIFT`\n- **NZD:** `Bank Transfer`, `SWIFT`\n- **AUD:** `Bank Transfer`, `SWIFT`\n\nFor CARD, submit MASTERCARD SEND in bank_details.clearing_system. List Payment Methods returns MASTERCARD SEND in clearing_systems.\n","maxLength":30,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.bank_details.clearing_system","typeLabel":"string"},"account_number":{"type":"string","example":"12345678","description":"Account number, mostly for non-european countries, either account_number or iban should be filled.\n\nOnly English letters (uppercase and lowercase) and digits are allowed; dashes or other special characters are not permitted.\n","pattern":"^[a-zA-Z0-9]*$","maxLength":60,"uniqueKey":"beneficiary.oneOf.2.bank_details.account_number","typeLabel":"string"},"iban":{"type":"string","example":"GB82 WEST 1234 5698 7654 32","description":"For the following countries/regions, **IBAN is mandatory** (mostly applicable to European and some other countries):\n\n**Country Codes**:\n`AL`, `AD`, `AT`, `AZ`, `BH`, `BY`, `BE`, `BA`, `BR`, `BG`, `CR`, `HR`, `CY`, `CZ`, `DK`, `DO`, `EG`, `SV`, `EE`, `FO`, `FI`, `FR`, `GE`, `DE`, `GI`, `GR`, `GL`, `GT`, `VA`, `HU`, `IS`, `IQ`, `IE`, `IL`, `IT`, `JO`, `KZ`, `XK`, `KW`, `LV`, `LB`, `LY`, `LI`, `LT`, `LU`, `MT`, `MR`, `MU`, `MD`, `MC`, `ME`, `NL`, `MK`, `NO`, `PK`, `PS`, `PL`, `PT`, `QA`, `RO`, `LC`, `SM`, `ST`, `SA`, `RS`, `SC`, `SK`, `SI`, `ES`, `SD`, `SE`, `CH`, `TL`, `TN`, `TR`, `UA`, `AE`, `GB`, `VG`.\n\nIf the beneficiary bank is located in any of the above-listed countries/regions, **IBAN must be provided**.\n","maxLength":36,"uniqueKey":"beneficiary.oneOf.2.bank_details.iban","typeLabel":"string"},"routing_code_type1":{"type":"string","example":"aba","description":"Routing code type, must be one of: \n * `ach` - Required when account_currency_code = \"USD\" and clearing_system = \"ACH\".\n * `aba` \n - Required when account_currency_code = \"USD\" and clearing_system = \"FEDWIRE\".\n - Required when account_currency_code = \"USD\" and clearing_system = \"SWIFT\" and bank_country_code = \"US\"\n * `bank_code` - Required when account_currency_code = \"CAD\" and clearing_system = \"EFT\" OR account_currency_code = \"HKD\" and clearing_system = \"LOCAL\".\n * `sort_code` - Required when account_currency_code = \"GBP\" and clearing_system = \"FASTER PAYMENTS\". **Must be exactly 6 digits.**\n * `bsb_code` - Required when account_currency_code = \"AUD\" and clearing_system = \"LOCAL\".\n * `ifsc` - Required when account_currency_code = \"INR\" and clearing_system = \"IFSC\".\n * `cnaps_number` - Required when account_currency_code = \"CNH\" and bank_country_code = \"CN\".\n","maxLength":12,"uniqueKey":"beneficiary.oneOf.2.bank_details.routing_code_type1","typeLabel":"string"},"routing_code_value1":{"type":"string","example":"123456789","description":"Routing code value.Routing code for routing_code_type_1.If supplied, routing_code_type_1 should also be supplied.","maxLength":48,"uniqueKey":"beneficiary.oneOf.2.bank_details.routing_code_value1","typeLabel":"string"},"routing_code_type2":{"type":"string","example":"ach","description":"Routing code sub type.\n * `branch_code` - Required when account_currency_code = \"CAD\" and clearing_system = \"EFT\".\n","maxLength":12,"uniqueKey":"beneficiary.oneOf.2.bank_details.routing_code_type2","typeLabel":"string"},"routing_code_value2":{"type":"string","example":"123456789","description":"Routing code sub type value.Routing code for routing_code_type_2.If supplied, routing_code_type_2 should also be supplied.","maxLength":48,"uniqueKey":"beneficiary.oneOf.2.bank_details.routing_code_value2","typeLabel":"string"},"card_expiry":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$","description":"Card expiry month. Required for Mastercard Send. Use YYYY-MM; the current month is accepted, past months are rejected. Checked again for new payouts.","uniqueKey":"beneficiary.oneOf.2.bank_details.card_expiry","typeLabel":"string"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.bank_details","typeLabel":"object"},"address":{"oneOf":[{"type":"object","title":"Bank beneficiary address","description":"For LOCAL payments to a bank in SG with account currency SGD, city, state, and street_address may be empty strings when not provided. Non-empty values follow the corresponding field constraints. Other routes require a complete address.\n","required":["country","city","street_address","postal_code","state"],"properties":{"country":{"type":"string","example":"SG","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.country","typeLabel":"string"},"city":{"oneOf":[{"type":"string","title":"Provided city","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.city.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.city","typeLabel":"string | enum\u003cstring>"},"street_address":{"oneOf":[{"type":"string","title":"Provided street address","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.street_address.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.street_address.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.street_address","typeLabel":"string | enum\u003cstring>"},"postal_code":{"type":"string","example":"123456","description":"Postal code of the beneficiary.","maxLength":12,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.postal_code","typeLabel":"string"},"state":{"oneOf":[{"type":"string","title":"Provided state","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.state.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.state","typeLabel":"string | enum\u003cstring>"},"nationality":{"oneOf":[{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"example":"SG","uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.nationality.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","enum":[""],"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.nationality.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0.nationality","typeLabel":"string | enum\u003cstring>"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.0","typeLabel":"Bank beneficiary address · object"},{"type":"object","title":"Mastercard beneficiary address","description":"Mastercard beneficiary address. An individual country can be empty when not provided.","required":["country","city","street_address","postal_code","state"],"properties":{"country":{"oneOf":[{"type":"string","title":"Provided country","description":"Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","maxLength":2,"minLength":2,"example":"SG","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.country.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.country.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.country","typeLabel":"string | enum\u003cstring>"},"city":{"oneOf":[{"type":"string","title":"Provided city","description":"City of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":36,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"Singapore","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.city.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.city.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.city","typeLabel":"string | enum\u003cstring>"},"street_address":{"oneOf":[{"type":"string","title":"Provided street address","description":"Street of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":255,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"123 Main St","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.street_address.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.street_address.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.street_address","typeLabel":"string | enum\u003cstring>"},"postal_code":{"type":"string","example":"123456","description":"Postal code of the beneficiary.","maxLength":12,"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.postal_code","typeLabel":"string"},"state":{"oneOf":[{"type":"string","title":"Provided state","description":"State or province of the beneficiary.\n\nFor request validation, non-empty values must match `^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$`. This applies to all currencies and payment methods.\n\nEmpty strings and omitted fields skip the character-regex check; whether the field is required is still determined by the existing required-field rules for the endpoint and payout scenario.\n","maxLength":96,"pattern":"^[A-Za-z0-9\\s\\-_().,:@#~!$%^\u0026*+={}\\[\\]\\\\|\"'\u003c>?/・……]+$","example":"CA","isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.state.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","enum":[""],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.state.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.state","typeLabel":"string | enum\u003cstring>"},"nationality":{"oneOf":[{"type":"string","title":"Provided nationality","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","maxLength":2,"minLength":2,"example":"SG","uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.nationality.oneOf.0","typeLabel":"string"},{"type":"string","title":"Not provided","description":"Two-letter country code representing nationality of the beneficiary.\nMay be returned as an empty string on records where the nationality was not provided.\n","enum":[""],"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.nationality.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1.nationality","typeLabel":"string | enum\u003cstring>"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address.oneOf.1","typeLabel":"Mastercard beneficiary address · object"}],"isRequired":true,"uniqueKey":"beneficiary.oneOf.2.address","typeLabel":"Bank beneficiary address · object | Mastercard beneficiary address · object"},"nickname":{"type":"string","example":"John Doe","description":"Nickname of the beneficiary.","maxLength":120,"uniqueKey":"beneficiary.oneOf.2.nickname","typeLabel":"string"},"company_name":{"type":"string","example":"UQPAY TECHNOLOGY SG PTE LTD","description":"Company name of the beneficiary, only exist when the entity_type is COMPANY.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n- When `bank_country_code = CN` \u0026 `account_currency_code = CNH` \u0026 `payment_method = LOCAL` \u0026 `entity_type = COMPANY`, Chinese characters and Chinese parentheses `()` are supported.\n","maxLength":120,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.2.company_name","typeLabel":"string"},"first_name":{"type":"string","example":"John","description":"First name of the beneficiary, only exist when the entity_type is INDIVIDUAL.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n","maxLength":45,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.2.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Doe","description":"Last name of the beneficiary, only exist when the entity_type is INDIVIDUAL.\n\n- When `payment_method = SWIFT`: \n * Only English letters, numbers, special characters (half-width format), and spaces can be included. \n * Allowed special characters: `-_().,@#~ ! $ % ^ \u0026 * + = { } [ ] \\ | : \" ' \u003c > ? /・……` \n\n- When `payment_method = LOCAL`: \n * No strict validation rules apply, local language characters are supported.\n\n- No need to pass this field when `bank_details.bank_country_code = SG` \u0026 `bank_details.account_currency_code = SGD` \n","maxLength":45,"pattern":"^[a-zA-Z0-9 -_().,@#~!$%^\u0026*+={}\\|:\"'\u003c>?/・……]*$","uniqueKey":"beneficiary.oneOf.2.last_name","typeLabel":"string"},"id_number":{"type":"string","example":"110101199001011234","description":"The identification number of the individual beneficiary. \nMandatory when the beneficiary is a Mainland China resident and the following conditions are met: \n- `bank_details.account_currency_code` is `CNH` \n- `payment_method` is `LOCAL`\n","uniqueKey":"beneficiary.oneOf.2.id_number","typeLabel":"string"},"create_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Create time of the beneficiary.","uniqueKey":"beneficiary.oneOf.2.create_time","typeLabel":"string\u003cdate/time>"},"update_time":{"type":"string","format":"date/time","example":"2024-03-01T00:00:00+08:00","description":"Update time of the beneficiary.","uniqueKey":"beneficiary.oneOf.2.update_time","typeLabel":"string\u003cdate/time>"},"additional_info":{"type":"object","description":"Additional information for beneficiaries.\n","properties":{"organization_code":{"type":"string","example":"91210106MA0P46BWXY","description":"The Unified Social Credit Identifier assigned to the organization. This field is for companies registered in Mainland China.","uniqueKey":"beneficiary.oneOf.2.additional_info.organization_code","typeLabel":"string"},"proxy_id":{"type":"string","description":"PayNow proxy identifier (SGD). Supports UEN, phone number, or VPA as the value.","uniqueKey":"beneficiary.oneOf.2.additional_info.proxy_id","typeLabel":"string"},"id_type":{"type":"string","example":"PASSPORT","description":"Identification document type for individual beneficiaries.\nMay be returned as an empty string on records where it is not applicable.\n","enum":["PASSPORT","NATIONAL_ID","DRIVERS_LICENSE",""],"uniqueKey":"beneficiary.oneOf.2.additional_info.id_type","typeLabel":"enum\u003cstring>"},"id_number":{"type":"string","example":"AB1234567","description":"Identification number for individual beneficiaries.\n","uniqueKey":"beneficiary.oneOf.2.additional_info.id_number","typeLabel":"string"},"tax_id":{"type":"string","example":"123456789","description":"Tax identification number for company beneficiaries.\n","uniqueKey":"beneficiary.oneOf.2.additional_info.tax_id","typeLabel":"string"},"msisdn":{"type":"string","example":"+65111111","description":"Mobile phone number in international format with country code.\n","uniqueKey":"beneficiary.oneOf.2.additional_info.msisdn","typeLabel":"string"}},"uniqueKey":"beneficiary.oneOf.2.additional_info","typeLabel":"object"}},"isRequired":true,"uniqueKey":"beneficiary.oneOf.2","typeLabel":"Mastercard beneficiary · object"}],"isRequired":true,"uniqueKey":"beneficiary","typeLabel":"LOCAL SGD beneficiary with a bank in SG · object | Beneficiary with a complete address · object | Mastercard beneficiary · object"},"failure_returned_amount":{"type":"string","example":"1000.00","description":"The amount of the failed payout to be returned.","uniqueKey":"failure_returned_amount","typeLabel":"string"},"failure_reason":{"type":"string","example":"","description":"The reason why the payout failed.","uniqueKey":"failure_reason","typeLabel":"string"},"quote_id":{"type":"string","example":"784832f7-1f8a-4b08-ac2a-8719b5b2a590","description":"ID of the pre-created quote, obtained via [Create Quote](/global-account/v1.6/api-reference/create-quote). \n\nRequired only for cross-currency payout scenarios. \nIf provided, `payout_currency` and `payout_amount` must also be supplied.\n","uniqueKey":"quote_id","typeLabel":"string"},"conversion":{"type":"object","description":"Details of the currency conversion for the payout.\nRequired only for cross-currency payout scenarios.\n","properties":{"currency_pair":{"type":"string","description":"The currency pair that the rate is for.","example":"USDEUR","uniqueKey":"conversion.currency_pair","typeLabel":"string"},"client_rate":{"type":"string","description":"The exchange rate applied to the transaction.","example":"1.355957","uniqueKey":"conversion.client_rate","typeLabel":"string"}},"uniqueKey":"conversion","typeLabel":"object"}},"title":"PayoutDetailResponse","uniqueKey":"","typeLabel":"PayoutDetailResponse · object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"084c219d-537c-4593-b249-1809a2b0811e":{"XAuthToken":{"type":"apiKey","in":"header","name":"x-auth-token","description":"The API token for login provided by UQPAY.","scopes":[]}}},"servers":{"7b8025eb-b2f8-41d2-942c-69a2618d52d8":{"url":"https://api-sandbox.uqpaytech.com/api","description":"Sandbox base URL."},"d7c65b2c-f035-4568-86a9-e648acda4f38":{"url":"https://api.uqpay.com/api","description":"Production base URL."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-auth-token","description":"The API token for login provided by UQPAY.","scopes":[]},"schema":{"title":"x-auth-token","type":"string","description":"The API token for login provided by UQPAY.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XAuthToken","name":"x-auth-token"}],"title":"XAuthToken"}]},"originalFileLocation":"global-account/v1.6/banking.yaml"},"subdomain":"uqpay-ecc4f4d8","siteName":"UQPAY Developer Docs","title":"Retrieve Payout - UQPAY Developer Docs","navMaps":{"firstHrefInVersion":{"v1.6":{"href":"/global-account/v1.6/api-reference/retrieve-payout","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/global-account/v1.6/api-reference/retrieve-payout","matchLevel":0},"zh":{"href":"/zh/global-account/v1.6/api-reference/retrieve-payout","matchLevel":1}}},"lastModified":"2026-09-26T14:19:00.880Z","originalFileLocation":"global-account/v1.6/api-reference/retrieve-payout.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get a specific payout by specifying the payout_id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"UQPAY Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_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=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve Payout - UQPAY Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a specific payout by specifying the payout_id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"UQPAY Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://uqpay-ecc4f4d8.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Retrieve+Payout\u0026amp;description=Get+a+specific+payout+by+specifying+the+payout_id.\u0026amp;theme=ee61e842face86fd00189b13\u0026amp;signature=0384cd351448ab15d6a1cf5a77976820b07cdfe540f344345e998663f9c1307a\">\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=\"Retrieve Payout - UQPAY Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a specific payout by specifying the payout_id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uqpay-ecc4f4d8.mintlify.app/_mintlify/api/og/v2?division=Payouts\u0026amp;title=Retrieve+Payout\u0026amp;description=Get+a+specific+payout+by+specifying+the+payout_id.\u0026amp;theme=ee61e842face86fd00189b13\u0026amp;signature=0384cd351448ab15d6a1cf5a77976820b07cdfe540f344345e998663f9c1307a\">\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=\"/docs/mintlify-assets/_mintlify/favicons/uqpay-ecc4f4d8/zJUnKnvS29IywmGk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"UQPAY Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A56DB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/global-account/v1.6/api-reference/retrieve-payout.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://developers-sandbox.uqpaytech.com/docs/zh/global-account/v1.6/api-reference/retrieve-payout\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers-sandbox.uqpaytech.com/#organization\",\"name\":\"UQPAY Developer Docs\",\"url\":\"https://developers-sandbox.uqpaytech.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/uqpay-ecc4f4d8/-ww49FTUjAmlhKN6/images/logo-light.png?fit=max\u0026auto=format\u0026n=-ww49FTUjAmlhKN6\u0026q=85\u0026s=f7d617f71b284158f3d0d2a8e2872806\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers-sandbox.uqpaytech.com/docs#website\",\"name\":\"UQPAY Developer Docs\",\"url\":\"https://developers-sandbox.uqpaytech.com/docs\",\"publisher\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout#webpage\",\"url\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout\",\"name\":\"Retrieve Payout\",\"description\":\"Get a specific payout by specifying the payout_id.\",\"dateModified\":\"2026-09-26T14:19:00.880Z\",\"isPartOf\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Global Account API\",\"item\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/list-transfers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payouts\",\"item\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/list-payouts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve Payout\",\"item\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout#apireference\",\"headline\":\"Retrieve Payout\",\"name\":\"Retrieve Payout\",\"description\":\"Get a specific payout by specifying the payout_id.\",\"url\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout\",\"mainEntityOfPage\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs/global-account/v1.6/api-reference/retrieve-payout#webpage\"},\"dateModified\":\"2026-09-26T14:19:00.880Z\",\"publisher\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers-sandbox.uqpaytech.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"UQPAY Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"UQPAY Developer Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"navbar":{"links":[{"href":"/changelog","label":"Changelog"}]},"products":[{"product":"Account Center","icon":"user","pages":[{"title":"Account Center","href":"/account-center/v1.6/guide/overview"}]},{"product":"Global Acquiring","icon":"cash-register","pages":[{"title":"Global Acquiring","href":"/global-acquiring/v1.6/guide/overview"}]},{"product":"Global Account","icon":"building-columns","versions":[{"version":"v1.6","tag":"Latest","tabs":[{"tab":"Guide","icon":"book-open","pages":[{"title":"Guide","href":"/global-account/v1.6/guide/overview"}]},{"tab":"Webhooks","icon":"bell","pages":[{"title":"Webhooks","href":"/global-account/v1.6/webhooks/beneficiary-created"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Global Account API","pages":[{"group":"Transfers","pages":[{"title":"List Transfers","deprecated":null,"version":null,"sidebarTitle":"List transfers","openapi":"/global-account/v1.6/banking.yaml get /v1/transfer","href":"/global-account/v1.6/api-reference/list-transfers"},{"title":"Create Transfer","deprecated":null,"version":null,"sidebarTitle":"Create transfer","openapi":"/global-account/v1.6/banking.yaml post /v1/transfer","href":"/global-account/v1.6/api-reference/create-transfer"},{"title":"Retrieve Transfer","deprecated":null,"version":null,"sidebarTitle":"Retrieve transfer","openapi":"/global-account/v1.6/banking.yaml get /v1/transfer/{id}","href":"/global-account/v1.6/api-reference/retrieve-transfer"}]},{"group":"Payouts","pages":[{"title":"List Payouts","deprecated":null,"version":null,"sidebarTitle":"List payouts","openapi":"/global-account/v1.6/banking.yaml get /v1/payouts","href":"/global-account/v1.6/api-reference/list-payouts"},{"title":"Create Payout","description":"Creates a new payout to a beneficiary. With development and support from SWIFT and local payment rails, you can make faster and more cost-effective international payments to your overseas corporate accounts, suppliers, and employees.\n\nThis API supports multiple payment modes, including standard payouts and Payment-On-Behalf-Of (POBO), enabling flexible and efficient fund management. Additionally, you can select the fee payment method to control how transaction fees are handled.\n\n#### Usage Guidelines\n- Supports payouts to over 180 countries in 30+ currencies, including CNY payouts in Mainland China.\n- Sub-accounts for POBO transactions must be created in advance, and the account status must be active.\n- To enable POBO mode, include the `x-on-behalf-of` parameter in the request header and specify the sub-account ID used for the payout. The beneficiary will see the customized payer name instead of the actual paying entity.\n- Users can select the fee charge type by `fee_paid_by` parameter to determine who covers transaction costs:\n 1. `SHARED` – Transaction fees are split between payer and recipient; payer pays sending bank fees while recipient pays receiving bank fees.\n 2. `OURS` – All transaction fees, including intermediary bank charges, are paid by the payer.\n- There are two ways to specify the beneficiary:\n 1. Using `beneficiary_id` – If the beneficiary has already been created, provide the `beneficiary_id` to reference an existing beneficiary.\n 2. Providing full beneficiary details – If the beneficiary has not been created before, include the full beneficiary information in the request. In this case, do not pass `beneficiary_id`.\n\n **Note**: A beneficiary will be created when full details are provided. For any future payouts to the same beneficiary, you should pass the corresponding `beneficiary_id`, not the full details of beneficiary.\n\n- If you intend to make cross-currency payouts, you can refer to the [Cross-Currency Guide](/global-account/v1.6/guide/cross-currency-payout-guide) for details and examples.\n\nFor Mastercard Send, use a saved CARD beneficiary_id or provide the full CARD beneficiary object. Do not provide both. Card fields are nested under beneficiary.bank_details, not at the payout top level. A successful creation response is acceptance, not confirmation of payment completion.","deprecated":null,"version":null,"sidebarTitle":"Create payout","openapi":"/global-account/v1.6/banking.yaml post /v1/payouts","href":"/global-account/v1.6/api-reference/create-payout"},{"title":"Retrieve Payout","deprecated":null,"version":null,"sidebarTitle":"Retrieve payout","openapi":"/global-account/v1.6/banking.yaml get /v1/payouts/{id}","href":"/global-account/v1.6/api-reference/retrieve-payout"},{"title":"Validate payout","description":"Checks a saved beneficiary, amount, fees, balance, and channel availability without creating a payout. Mastercard expiry is checked again. Results do not reserve funds or guarantee that a later creation succeeds.","deprecated":null,"version":null,"sidebarTitle":"Validate payout","openapi":"/global-account/v1.6/banking.yaml get /v1/payouts/validation","href":"/global-account/v1.6/api-reference/validate-payout"}]},{"group":"Beneficiaries","pages":[{"title":"List Beneficiaries","deprecated":null,"version":null,"sidebarTitle":"List beneficiaries","openapi":"/global-account/v1.6/banking.yaml get /v1/beneficiaries","href":"/global-account/v1.6/api-reference/list-beneficiaries"},{"title":"Create Beneficiary","deprecated":null,"version":null,"sidebarTitle":"Create beneficiary","openapi":"/global-account/v1.6/banking.yaml post /v1/beneficiaries","href":"/global-account/v1.6/api-reference/create-beneficiary"},{"title":"Retrieve Beneficiary","deprecated":null,"version":null,"sidebarTitle":"Retrieve beneficiary","openapi":"/global-account/v1.6/banking.yaml get /v1/beneficiaries/{id}","href":"/global-account/v1.6/api-reference/retrieve-beneficiary"},{"title":"Update Beneficiary","deprecated":null,"version":null,"sidebarTitle":"Update beneficiary","openapi":"/global-account/v1.6/banking.yaml post /v1/beneficiaries/{id}","href":"/global-account/v1.6/api-reference/update-beneficiary"},{"title":"Delete Beneficiary","deprecated":null,"version":null,"sidebarTitle":"Delete beneficiary","openapi":"/global-account/v1.6/banking.yaml post /v1/beneficiaries/{id}/delete","href":"/global-account/v1.6/api-reference/delete-beneficiary"},{"title":"List Payment Methods","deprecated":null,"version":null,"sidebarTitle":"List payment methods","openapi":"/global-account/v1.6/banking.yaml get /v1/beneficiaries/paymentmethods","href":"/global-account/v1.6/api-reference/list-payment-methods"},{"title":"Check Beneficiary","deprecated":null,"version":null,"sidebarTitle":"Check beneficiary","openapi":"/global-account/v1.6/banking.yaml post /v1/beneficiaries/check","href":"/global-account/v1.6/api-reference/check-beneficiary"}]},{"group":"Balances","pages":[{"title":"Retrieve Balance","deprecated":null,"version":null,"sidebarTitle":"Retrieve balance","openapi":"/global-account/v1.6/banking.yaml get /v1/balances/{currency}","href":"/global-account/v1.6/api-reference/retrieve-balance"},{"title":"List Balances","deprecated":null,"version":null,"sidebarTitle":"List balances","openapi":"/global-account/v1.6/banking.yaml get /v1/balances","href":"/global-account/v1.6/api-reference/list-balances"},{"title":"List Balances Transactions","deprecated":null,"version":null,"sidebarTitle":"List balances transactions","openapi":"/global-account/v1.6/banking.yaml get /v1/balances/transactions","href":"/global-account/v1.6/api-reference/list-balances-transactions"}]},{"group":"Deposits","pages":[{"title":"List Deposits","deprecated":null,"version":null,"sidebarTitle":"List deposits","openapi":"/global-account/v1.6/banking.yaml get /v1/deposit","href":"/global-account/v1.6/api-reference/list-deposits"},{"title":"Retrieve Deposit","deprecated":null,"version":null,"sidebarTitle":"Retrieve deposit","openapi":"/global-account/v1.6/banking.yaml get /v1/deposit/{id}","href":"/global-account/v1.6/api-reference/retrieve-deposit"}]},{"group":"Virtual Accounts","pages":[{"title":"List Virtual Accounts","deprecated":null,"version":null,"sidebarTitle":"List virtual accounts","openapi":"/global-account/v1.6/banking.yaml get /v1/virtual/accounts","href":"/global-account/v1.6/api-reference/list-virtual-accounts"},{"title":"Create Virtual Account","deprecated":null,"version":null,"sidebarTitle":"Create virtual account","openapi":"/global-account/v1.6/banking.yaml post /v1/virtual/accounts","href":"/global-account/v1.6/api-reference/create-virtual-account"},{"title":"List Virtual Account Applications","deprecated":null,"version":null,"sidebarTitle":"List virtual account applications","openapi":"/global-account/v1.6/banking.yaml get /v1/virtual/applications","href":"/global-account/v1.6/api-reference/list-virtual-account-applications"},{"title":"Retrieve Virtual Account Application","deprecated":null,"version":null,"sidebarTitle":"Retrieve virtual account application","openapi":"/global-account/v1.6/banking.yaml get /v1/virtual/applications/{application_id}","href":"/global-account/v1.6/api-reference/retrieve-virtual-account-application"}]},{"group":"Conversion","pages":[{"title":"List Conversion","deprecated":null,"version":null,"sidebarTitle":"List conversion","openapi":"/global-account/v1.6/banking.yaml get /v1/conversion","href":"/global-account/v1.6/api-reference/list-conversion"},{"title":"Create Conversion","deprecated":null,"version":null,"sidebarTitle":"Create conversion","openapi":"/global-account/v1.6/banking.yaml post /v1/conversion","href":"/global-account/v1.6/api-reference/create-conversion"},{"title":"Retrieve Conversion","deprecated":null,"version":null,"sidebarTitle":"Retrieve conversion","openapi":"/global-account/v1.6/banking.yaml get /v1/conversion/{id}","href":"/global-account/v1.6/api-reference/retrieve-conversion"},{"title":"List Conversion Dates","deprecated":null,"version":null,"sidebarTitle":"List conversion dates","openapi":"/global-account/v1.6/banking.yaml get /v1/conversion/conversion_dates","href":"/global-account/v1.6/api-reference/list-conversion-dates"},{"title":"Create Quote","deprecated":null,"version":null,"sidebarTitle":"Create quote","openapi":"/global-account/v1.6/banking.yaml post /v1/conversion/quote","href":"/global-account/v1.6/api-reference/create-quote"}]},{"group":"Exchange Rates","pages":[{"title":"List Current Rates","deprecated":null,"version":null,"sidebarTitle":"List current rates","openapi":"/global-account/v1.6/banking.yaml get /v1/exchange/rates","href":"/global-account/v1.6/api-reference/list-current-rates"}]},{"group":"Simulator","pages":[]}]}]}]}]},{"product":"Card Issuance","icon":"credit-card","pages":[{"title":"Card Issuance","href":"/card-issuance/v1.6/guide/overview"}]},{"product":"Stablecoin Account","icon":"arrow-right-arrow-left","pages":[{"title":"Stablecoin Account","href":"/stablecoin-account/v1.6/guide/overview"}]},{"product":"Developer Tools","icon":"code","pages":[{"title":"Developer Tools","href":"/developer-tools/mcp/mcp-integration-guide"}]},{"product":"AI Knowledge Base","icon":"sparkles","pages":[{"title":"AI Knowledge Base","href":"/ai-knowledge-base/card-issuing/corpus_overview"}]}]},{"language":"zh","navbar":{"links":[{"href":"/zh/changelog","label":"更新日志"}]},"pages":[{"title":"zh","href":"/zh/global-account/v1.6/api-reference/retrieve-payout"}]}]},"basePath":"","title":"Retrieve Payout - UQPAY Developer Docs","buildId":"dpl_GWQzn6k13MqphA3qck3hQKoQXDzM","deploymentId":"dpl_GWQzn6k13MqphA3qck3hQKoQXDzM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-vlKR2tYY.js","utils-DBDPZSWe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CxHK4zz2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-27b98BOz.js","snippetPresets-DNnui32z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-cDVS2zyo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BEE-OyDQ.js","shallow-fqEMZOYR.js","getApiPlaygroundDisplay-BPut1_OB.js","CodeSnippet-h9vp8UTG.js","CodeSnippets-DoMjCW5Q.js","Page-BOWGOUSK.js","getPastedJson-C4r-hmQ_.js","icon-CCDahfhO.js","MethodPill-Dpq0JSrS.js","DuplicateIcon-BGPwFt-j.js","createIcon-DBULrQp7.js","DynamicMarkdown-B74atANy.js","SectionHeading-DZCpbSmT.js","axios-vUo_bRtp.js","Markdown-BwkgxkAH.js","clsx-CEIlvfOI.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-f6OgbvLC.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DvlTOml0.js"]}