Account bank country code of the beneficiary.
Two-letter ISO 3166-2 country code.
string
required
Account currency code of the beneficiary.
Three-letter ISO 4217 currency code.
string
required
Entity type of the beneficiary.
One of company, individual
string
required
Email of the beneficiary.
string
required
A nickname for the beneficiary. Maximum length 120
string
Required if “entity_type” is “individual”.
First name of the beneficiary. Maximum length 45
string
Required if “entity_type” is “individual”.
Last name of the beneficiary. Maximum length 45
string
Required if “entity_type” is “company”.
Company names cannot consist entirely of numbers. Maximum length 120
string
required
Payment method of the beneficiary.
One of local, swift.
It is related to clearing_system, and the relationship can be obtained from this interface Get a list of payment methods.
string
required
Bank name of the beneficiary’s bank account. Maximum length 240
string
required
Bank street address. Maximum length 240
string
required
Account holder name of the beneficiary’s bank account. Maximum length 36
string
Bank account number. Maximum length 60
If iban is not required, account_number is required.
string
International bank account number, mostly for european countries.
speaCountrys:AD,AT,BE,BG,CY,HR,CZ,DK,EE,FI,FR,DE,GR,HU,IS,IE,IT,LV,LI,LT,LU,MT,MC,NL,NO,PL,PT,RO,SM,SK,SI,ES,SE,CH,GB,VA
speaCurrency:EUR,USD
If the country and currency are in the above list, the iban is required.
string
BIC/SWIFT code Maximum length 30
string
Which clearing system should be used for this beneficiary. Maximum length 30
It is related to payment_method, and the relationship can be obtained from this interface Get a list of payment methods.
string
Routing code type.
When the validation_field value of Get a list of payment methods does not find the corresponding field in the input parameter list,
the field name is put into routing_code_type1 and the value is put into the corresponding routing_code_value1.
string
Routing code value.
Routing code for routing_code_type_1.
If supplied, routing_code_type_1 should also be supplied.
string
Routing code sub type.
When the validation_field value of Get a list of payment methods does not find the corresponding field in the input parameter list,
the field name is put into routing_code_type2 and the value is put into the corresponding routing_code_value2.
string
Routing code sub type value.
Routing code for routing_code_type_2.
If supplied, routing_code_type_2 should also be supplied.
string
required
Country code of the beneficiary
Two-letter ISO 3166-2 country code.
string
required
City of the beneficiary. Maximum length 36
string
required
State of the beneficiary. Maximum length 96
string
required
Address of the beneficiary. Maximum length 255
string
required
Postal code of the beneficiary. Maximum length 12
Response
number
Indicates whether the call was successful. 200 if successful, 400 if not.
string
Response Message. “Success” if successful, others not.
object
Hide details
string
Beneficiary UUID.
string
Entity type of the beneficiary.
One of company, individual
string
The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.
One of local, swift
string
Email of the beneficiary.
string
Nickname of the beneficiary.
string
Company name of the beneficiary.
string
Account currency code.
Three-letter ISO 4217 currency code.
string
Bank country code.
Two-letter ISO 3166-2 country code.
string
First name of the beneficiary.
string
Last name of the beneficiary.
object
Beneficiary’s bank account details where the payment will be credited.
Show details
string
Bank name of the beneficiary’s bank account.
string
Bank street address.
string
Bank country code.
Two-letter ISO 3166-2 country code.
string
Account holder name of the beneficiary’s bank account.
string
Account currency code.
Three-letter ISO 4217 currency code.
string
Account number, mostly for non-european countries, either account_number or iban should be filled.
string
International bank account number, mostly for european countries.
string
Bank swift code.
string
Which clearing system should be used for this.
string
Routing code type.
string
Routing code value.
string
Routing code sub type.
string
Routing code sub type value.
object
Beneficiary’s address details.
Show details
string
Country code of the beneficiary.
Two-letter ISO 3166-2 country code.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"UQPAY Docs","colors":{"primary":"#2165F4","light":"#0C9CFF","dark":"#0D001D"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/uqpaypteltd/uHX3BYExjP-ceVfw/logo/light.svg?fit=max\u0026auto=format\u0026n=uHX3BYExjP-ceVfw\u0026q=85\u0026s=aabcacf707570fb6b63ad12ff4172347","dark":"https://mintcdn.com/uqpaypteltd/uHX3BYExjP-ceVfw/logo/dark.svg?fit=max\u0026auto=format\u0026n=uHX3BYExjP-ceVfw\u0026q=85\u0026s=8a57373a9c81fd8f10a6fc81c641afd4"},"api":{"mdx":{"server":"https://api.sandbox.uqpay.org"}},"background":{"decoration":null,"color":{"light":null,"dark":"#090014"}},"navbar":{"links":[{"label":"Support","href":"mailto:[email protected]"}],"primary":{"type":"button","label":"Dashboard","href":"https://dash.uqpay.org"}},"footer":{"socials":{"twitter":"https://twitter.com/uqpay_cs","github":"https://github.com/uqpay","linkedin":"https://www.linkedin.com/company/uqpay"}},"navigation":{"global":{"anchors":[{"anchor":"Github","href":"https://github.com/uqpay","icon":"github"},{"anchor":"Linkedin","href":"https://www.linkedin.com/company/uqpay/","icon":"linkedin"},{"anchor":"Official Website","href":"https://www.uqpay.com","icon":"globe"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"uqpaypteltd","hasAudioNarration":false,"actualSubdomain":"uqpaypteltd","customDomains":["docs.uqpay.org"],"gitSource":{"type":"github","owner":"uqpay","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91a3e4d276d8a49573584:success","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API Reference","count":42},{"language":"default","tag":"ISSUING","count":17},{"language":"default","tag":"PAYOUT","count":15},{"language":"default","tag":"Cards","count":11},{"language":"default","tag":"Payout","count":9},{"language":"default","tag":"CORE","count":6},{"language":"default","tag":"Beneficiaries","count":6},{"language":"default","tag":"Balances","count":5},{"language":"default","tag":"Cardholders","count":4},{"language":"default","tag":"API OVERVIEW","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/beneficiaries/create","slug":"/api-reference/beneficiaries/create","pageMetadata":{"title":"Create a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/create","description":"This endpoint create a beneficiary.","href":"/api-reference/beneficiaries/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"This endpoint create a beneficiary.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`header`,children:`Header`}),`\n`,_jsx(ParamField,{header:`x-client-id`,type:`string`,required:true,id:`param-x-client-id`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`x-client-id`}),`.`]})}),`\n`,_jsx(ParamField,{header:`x-auth-token`,type:`string`,required:true,id:`param-x-auth-token`,children:_jsxs(_components.p,{children:[`Bearer `,_jsx(_components.code,{children:`YOUR_TOKEN_HERE`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`parameters`,children:`Parameters`}),`\n`,_jsx(ParamField,{body:`bank_country`,type:`string`,required:true,id:`param-bank-country`,children:_jsxs(_components.p,{children:[`Account bank country code of the beneficiary.`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),`\n`,_jsx(ParamField,{body:`account_currency`,type:`string`,required:true,id:`param-account-currency`,children:_jsxs(_components.p,{children:[`Account currency code of the beneficiary.`,_jsx(`br`,{}),`\nThree-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_4217`,children:`ISO 4217`}),` currency code.`]})}),`\n`,_jsx(ParamField,{body:`entity_type`,type:`string`,required:true,id:`param-entity-type`,children:_jsxs(_components.p,{children:[`Entity type of the beneficiary.`,_jsx(`br`,{}),`\nOne of `,_jsx(_components.code,{children:`company`}),`, `,_jsx(_components.code,{children:`individual`}),_jsx(`br`,{})]})}),`\n`,_jsx(ParamField,{body:`email`,type:`string`,required:true,id:`param-email`,children:_jsx(_components.p,{children:`Email of the beneficiary.`})}),`\n`,_jsx(ParamField,{body:`nickname`,type:`string`,required:true,id:`param-nickname`,children:_jsxs(_components.p,{children:[`A nickname for the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 120`})]})}),`\n`,_jsx(ParamField,{body:`first_name`,type:`string`,id:`param-first-name`,children:_jsxs(_components.p,{children:[`Required if “entity_type” is “individual”.`,_jsx(`br`,{}),`\nFirst name of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 45`})]})}),`\n`,_jsx(ParamField,{body:`last_name`,type:`string`,id:`param-last-name`,children:_jsxs(_components.p,{children:[`Required if “entity_type” is “individual”.\nLast name of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 45`})]})}),`\n`,_jsx(ParamField,{body:`company_name`,type:`string`,id:`param-company-name`,children:_jsxs(_components.p,{children:[`Required if “entity_type” is “company”.`,_jsx(`br`,{}),`\nCompany names cannot consist entirely of numbers.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 120`})]})}),`\n`,_jsx(ParamField,{body:`payment_method`,type:`string`,required:true,id:`param-payment-method`,children:_jsxs(_components.p,{children:[`Payment method of the beneficiary.`,_jsx(`br`,{}),`\nOne of `,_jsx(_components.code,{children:`local`}),`, `,_jsx(_components.code,{children:`swift`}),`.`,_jsx(`br`,{}),`\nIt is related to `,_jsx(_components.code,{children:`clearing_system`}),`, and the relationship can be obtained from this interface `,_jsx(_components.a,{href:`/api-reference/payout/paymentmethods_v1.1`,children:`Get a list of payment methods.`})]})}),`\n`,_jsx(ParamField,{body:`bank_name`,type:`string`,required:true,id:`param-bank-name`,children:_jsxs(_components.p,{children:[`Bank name of the beneficiary’s bank account.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 240`})]})}),`\n`,_jsx(ParamField,{body:`bank_address`,type:`string`,required:true,id:`param-bank-address`,children:_jsxs(_components.p,{children:[`Bank street address.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 240`})]})}),`\n`,_jsx(ParamField,{body:`account_holder`,type:`string`,required:true,id:`param-account-holder`,children:_jsxs(_components.p,{children:[`Account holder name of the beneficiary’s bank account.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 36`})]})}),`\n`,_jsx(ParamField,{body:`account_number`,type:`string`,id:`param-account-number`,children:_jsxs(_components.p,{children:[`Bank account number.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 60`}),_jsx(`br`,{}),`\nIf `,_jsx(_components.code,{children:`iban`}),` is not required, `,_jsx(_components.code,{children:`account_number`}),` is `,_jsx(_components.strong,{children:`required`}),`.`]})}),`\n`,_jsx(ParamField,{body:`iban`,type:`string`,id:`param-iban`,children:_jsxs(_components.p,{children:[`International bank account number, mostly for european countries.`,_jsx(`br`,{}),`\nspeaCountrys:`,_jsx(_components.code,{children:`AD`}),`,`,_jsx(_components.code,{children:`AT`}),`,`,_jsx(_components.code,{children:`BE`}),`,`,_jsx(_components.code,{children:`BG`}),`,`,_jsx(_components.code,{children:`CY`}),`,`,_jsx(_components.code,{children:`HR`}),`,`,_jsx(_components.code,{children:`CZ`}),`,`,_jsx(_components.code,{children:`DK`}),`,`,_jsx(_components.code,{children:`EE`}),`,`,_jsx(_components.code,{children:`FI`}),`,`,_jsx(_components.code,{children:`FR`}),`,`,_jsx(_components.code,{children:`DE`}),`,`,_jsx(_components.code,{children:`GR`}),`,`,_jsx(_components.code,{children:`HU`}),`,`,_jsx(_components.code,{children:`IS`}),`,`,_jsx(_components.code,{children:`IE`}),`,`,_jsx(_components.code,{children:`IT`}),`,`,_jsx(_components.code,{children:`LV`}),`,`,_jsx(_components.code,{children:`LI`}),`,`,_jsx(_components.code,{children:`LT`}),`,`,_jsx(_components.code,{children:`LU`}),`,`,_jsx(_components.code,{children:`MT`}),`,`,_jsx(_components.code,{children:`MC`}),`,`,_jsx(_components.code,{children:`NL`}),`,`,_jsx(_components.code,{children:`NO`}),`,`,_jsx(_components.code,{children:`PL`}),`,`,_jsx(_components.code,{children:`PT`}),`,`,_jsx(_components.code,{children:`RO`}),`,`,_jsx(_components.code,{children:`SM`}),`,`,_jsx(_components.code,{children:`SK`}),`,`,_jsx(_components.code,{children:`SI`}),`,`,_jsx(_components.code,{children:`ES`}),`,`,_jsx(_components.code,{children:`SE`}),`,`,_jsx(_components.code,{children:`CH`}),`,`,_jsx(_components.code,{children:`GB`}),`,`,_jsx(_components.code,{children:`VA`}),_jsx(`br`,{}),`\nspeaCurrency:`,_jsx(_components.code,{children:`EUR`}),`,`,_jsx(_components.code,{children:`USD`}),_jsx(`br`,{}),`\nIf the country and currency are in the above list, the `,_jsx(_components.code,{children:`iban`}),` is required.`]})}),`\n`,_jsx(ParamField,{body:`swift_code`,type:`string`,id:`param-swift-code`,children:_jsxs(_components.p,{children:[`BIC/SWIFT code`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 30`})]})}),`\n`,_jsx(ParamField,{body:`clearing_system`,type:`string`,id:`param-clearing-system`,children:_jsxs(_components.p,{children:[`Which clearing system should be used for this beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 30`}),_jsx(`br`,{}),`\nIt is related to `,_jsx(_components.code,{children:`payment_method`}),`, and the relationship can be obtained from this interface `,_jsx(_components.a,{href:`/api-reference/payout/paymentmethods_v1.1`,children:`Get a list of payment methods.`})]})}),`\n`,_jsx(ParamField,{body:`routing_code_type1`,type:`string`,id:`param-routing-code-type1`,children:_jsxs(_components.p,{children:[`Routing code type.`,_jsx(`br`,{}),`\nWhen the `,_jsx(_components.code,{children:`validation_field`}),` value of `,_jsx(_components.a,{href:`/api-reference/payout/paymentmethods_v1.1`,children:`Get a list of payment methods`}),` does not find the corresponding field in the input parameter list,\nthe field name is put into `,_jsx(_components.code,{children:`routing_code_type1`}),` and the value is put into the corresponding `,_jsx(_components.code,{children:`routing_code_value1`}),`.`]})}),`\n`,_jsx(ParamField,{body:`routing_code_value1`,type:`string`,id:`param-routing-code-value1`,children:_jsxs(_components.p,{children:[`Routing code value.`,_jsx(`br`,{}),`\nRouting code for routing_code_type_1.`,_jsx(`br`,{}),`\nIf supplied, routing_code_type_1 should also be supplied.`]})}),`\n`,_jsx(ParamField,{body:`routing_code_type2`,type:`string`,id:`param-routing-code-type2`,children:_jsxs(_components.p,{children:[`Routing code sub type.`,_jsx(`br`,{}),`\nWhen the `,_jsx(_components.code,{children:`validation_field`}),` value of `,_jsx(_components.a,{href:`/api-reference/payout/paymentmethods_v1.1`,children:`Get a list of payment methods`}),` does not find the corresponding field in the input parameter list,\nthe field name is put into `,_jsx(_components.code,{children:`routing_code_type2`}),` and the value is put into the corresponding `,_jsx(_components.code,{children:`routing_code_value2`}),`.`]})}),`\n`,_jsx(ParamField,{body:`routing_code_value2`,type:`string`,id:`param-routing-code-value2`,children:_jsxs(_components.p,{children:[`Routing code sub type value.`,_jsx(`br`,{}),`\nRouting code for routing_code_type_2. `,_jsx(`br`,{}),`\nIf supplied, routing_code_type_2 should also be supplied.`]})}),`\n`,_jsx(ParamField,{body:`country_code`,type:`string`,required:true,id:`param-country-code`,children:_jsxs(_components.p,{children:[`Country code of the beneficiary`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),`\n`,_jsx(ParamField,{body:`city`,type:`string`,required:true,id:`param-city`,children:_jsxs(_components.p,{children:[`City of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 36`})]})}),`\n`,_jsx(ParamField,{body:`state`,type:`string`,required:true,id:`param-state`,children:_jsxs(_components.p,{children:[`State of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 96`})]})}),`\n`,_jsx(ParamField,{body:`address`,type:`string`,required:true,id:`param-address`,children:_jsxs(_components.p,{children:[`Address of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 255`})]})}),`\n`,_jsx(ParamField,{body:`postal_code`,type:`string`,required:true,id:`param-postal-code`,children:_jsxs(_components.p,{children:[`Postal code of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 12`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`code`,type:`number`,id:`param-code`,children:_jsx(_components.p,{children:`Indicates whether the call was successful. 200 if successful, 400 if not.`})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`Response Message. “Success” if successful, others not.`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`details`,defaultOpen:true,children:[_jsx(ResponseField,{name:`beneficiary_id`,type:`string`,id:`param-beneficiary-id`,children:_jsx(_components.p,{children:`Beneficiary UUID.`})}),_jsx(ResponseField,{name:`entity_type`,type:`string`,id:`param-entity-type-1`,children:_jsxs(_components.p,{children:[`Entity type of the beneficiary.`,_jsx(`br`,{}),`\nOne of `,_jsx(_components.code,{children:`company`}),`, `,_jsx(_components.code,{children:`individual`})]})}),_jsx(ResponseField,{name:`payment_method`,type:`string`,id:`param-payment-method-1`,children:_jsxs(_components.p,{children:[`The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.`,_jsx(`br`,{}),`\nOne of `,_jsx(_components.code,{children:`local`}),`, `,_jsx(_components.code,{children:`swift`})]})}),_jsx(ResponseField,{name:`beneficiary_email`,type:`string`,id:`param-beneficiary-email`,children:_jsx(_components.p,{children:`Email of the beneficiary.`})}),_jsx(ResponseField,{name:`beneficiary_nickname`,type:`string`,id:`param-beneficiary-nickname`,children:_jsx(_components.p,{children:`Nickname of the beneficiary.`})}),_jsx(ResponseField,{name:`beneficiary_company_name`,type:`string`,id:`param-beneficiary-company-name`,children:_jsx(_components.p,{children:`Company name of the beneficiary.`})}),_jsx(ResponseField,{name:`account_currency_code`,type:`string`,id:`param-account-currency-code`,children:_jsxs(_components.p,{children:[`Account currency code.`,_jsx(`br`,{}),`\nThree-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_4217`,children:`ISO 4217`}),` currency code.`]})}),_jsx(ResponseField,{name:`bank_country_code`,type:`string`,id:`param-bank-country-code`,children:_jsxs(_components.p,{children:[`Bank country code.`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),_jsx(ResponseField,{name:`beneficiary_first_name`,type:`string`,id:`param-beneficiary-first-name`,children:_jsx(_components.p,{children:`First name of the beneficiary.`})}),_jsx(ResponseField,{name:`beneficiary_last_name`,type:`string`,id:`param-beneficiary-last-name`,children:_jsx(_components.p,{children:`Last name of the beneficiary.`})}),_jsxs(ResponseField,{name:`beneficiary_bank_details`,type:`object`,id:`param-beneficiary-bank-details`,children:[_jsx(_components.p,{children:`Beneficiary’s bank account details where the payment will be credited.`}),_jsxs(Expandable,{title:`details`,children:[_jsx(ResponseField,{name:`bank_name`,type:`string`,id:`param-bank-name-1`,children:_jsx(_components.p,{children:`Bank name of the beneficiary’s bank account.`})}),_jsx(ResponseField,{name:`bank_address`,type:`string`,id:`param-bank-address-1`,children:_jsx(_components.p,{children:`Bank street address.`})}),_jsx(ResponseField,{name:`bank_country_code`,type:`string`,id:`param-bank-country-code-1`,children:_jsxs(_components.p,{children:[`Bank country code.`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),_jsx(ResponseField,{name:`account_holder`,type:`string`,id:`param-account-holder-1`,children:_jsx(_components.p,{children:`Account holder name of the beneficiary’s bank account.`})}),_jsx(ResponseField,{name:`account_currency_code`,type:`string`,id:`param-account-currency-code-1`,children:_jsxs(_components.p,{children:[`Account currency code.`,_jsx(`br`,{}),`\nThree-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_4217`,children:`ISO 4217`}),` currency code.`]})}),_jsx(ResponseField,{name:`account_number`,type:`string`,id:`param-account-number-1`,children:_jsx(_components.p,{children:`Account number, mostly for non-european countries, either account_number or iban should be filled.`})}),_jsx(ResponseField,{name:`iban`,type:`string`,id:`param-iban-1`,children:_jsx(_components.p,{children:`International bank account number, mostly for european countries.`})}),_jsx(ResponseField,{name:`swift_code`,type:`string`,id:`param-swift-code-1`,children:_jsx(_components.p,{children:`Bank swift code.`})}),_jsx(ResponseField,{name:`clearing_system`,type:`string`,id:`param-clearing-system-1`,children:_jsx(_components.p,{children:`Which clearing system should be used for this.`})}),_jsx(ResponseField,{name:`routing_code_type1`,type:`string`,id:`param-routing-code-type1-1`,children:_jsx(_components.p,{children:`Routing code type.`})}),_jsx(ResponseField,{name:`routing_code_value1`,type:`string`,id:`param-routing-code-value1-1`,children:_jsx(_components.p,{children:`Routing code value.`})}),_jsx(ResponseField,{name:`routing_code_type2`,type:`string`,id:`param-routing-code-type2-1`,children:_jsx(_components.p,{children:`Routing code sub type.`})}),_jsx(ResponseField,{name:`routing_code_value2`,type:`string`,id:`param-routing-code-value2-1`,children:_jsx(_components.p,{children:`Routing code sub type value.`})})]})]}),_jsxs(ResponseField,{name:`beneficiary_address`,type:`object`,id:`param-beneficiary-address`,children:[_jsx(_components.p,{children:`Beneficiary’s address details.`}),_jsxs(Expandable,{title:`details`,children:[_jsx(ResponseField,{name:`country_code`,type:`string`,id:`param-country-code-1`,children:_jsxs(_components.p,{children:[`Country code of the beneficiary.`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),_jsx(ResponseField,{name:`city`,type:`string`,id:`param-city-1`,children:_jsx(_components.p,{children:`City of the beneficiary.`})}),_jsx(ResponseField,{name:`street_address`,type:`string`,id:`param-street-address`,children:_jsx(_components.p,{children:`Street address of the beneficiary.`})}),_jsx(ResponseField,{name:`postal_code`,type:`string`,id:`param-postal-code-1`,children:_jsx(_components.p,{children:`Postal code of the beneficiary.`})}),_jsx(ResponseField,{name:`state`,type:`string`,id:`param-state-1`,children:_jsx(_components.p,{children:`State of the beneficiary.`})})]})]})]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/create","description":"This endpoint create a beneficiary.","href":"/api-reference/beneficiaries/create"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,RequestExample,ResponseExample,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`header`,children:`Header`}),`\n`,_jsx(ParamField,{header:`x-client-id`,type:`string`,required:true,id:`param-x-client-id`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`x-client-id`}),`.`]})}),`\n`,_jsx(ParamField,{header:`x-auth-token`,type:`string`,required:true,id:`param-x-auth-token`,children:_jsxs(_components.p,{children:[`Bearer `,_jsx(_components.code,{children:`YOUR_TOKEN_HERE`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`parameters`,children:`Parameters`}),`\n`,_jsx(ParamField,{body:`bank_country`,type:`string`,required:true,id:`param-bank-country`,children:_jsxs(_components.p,{children:[`Account bank country code of the beneficiary.`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),`\n`,_jsx(ParamField,{body:`account_currency`,type:`string`,required:true,id:`param-account-currency`,children:_jsxs(_components.p,{children:[`Account currency code of the beneficiary.`,_jsx(`br`,{}),`\nThree-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_4217`,children:`ISO 4217`}),` currency code.`]})}),`\n`,_jsx(ParamField,{body:`entity_type`,type:`string`,required:true,id:`param-entity-type`,children:_jsxs(_components.p,{children:[`Entity type of the beneficiary.`,_jsx(`br`,{}),`\nOne of `,_jsx(_components.code,{children:`company`}),`, `,_jsx(_components.code,{children:`individual`}),_jsx(`br`,{})]})}),`\n`,_jsx(ParamField,{body:`email`,type:`string`,required:true,id:`param-email`,children:_jsx(_components.p,{children:`Email of the beneficiary.`})}),`\n`,_jsx(ParamField,{body:`nickname`,type:`string`,required:true,id:`param-nickname`,children:_jsxs(_components.p,{children:[`A nickname for the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 120`})]})}),`\n`,_jsx(ParamField,{body:`first_name`,type:`string`,id:`param-first-name`,children:_jsxs(_components.p,{children:[`Required if “entity_type” is “individual”.`,_jsx(`br`,{}),`\nFirst name of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 45`})]})}),`\n`,_jsx(ParamField,{body:`last_name`,type:`string`,id:`param-last-name`,children:_jsxs(_components.p,{children:[`Required if “entity_type” is “individual”.\nLast name of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 45`})]})}),`\n`,_jsx(ParamField,{body:`company_name`,type:`string`,id:`param-company-name`,children:_jsxs(_components.p,{children:[`Required if “entity_type” is “company”.`,_jsx(`br`,{}),`\nCompany names cannot consist entirely of numbers.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 120`})]})}),`\n`,_jsx(ParamField,{body:`payment_method`,type:`string`,required:true,id:`param-payment-method`,children:_jsxs(_components.p,{children:[`Payment method of the beneficiary.`,_jsx(`br`,{}),`\nOne of `,_jsx(_components.code,{children:`local`}),`, `,_jsx(_components.code,{children:`swift`}),`.`,_jsx(`br`,{}),`\nIt is related to `,_jsx(_components.code,{children:`clearing_system`}),`, and the relationship can be obtained from this interface `,_jsx(_components.a,{href:`/api-reference/payout/paymentmethods_v1.1`,children:`Get a list of payment methods.`})]})}),`\n`,_jsx(ParamField,{body:`bank_name`,type:`string`,required:true,id:`param-bank-name`,children:_jsxs(_components.p,{children:[`Bank name of the beneficiary’s bank account.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 240`})]})}),`\n`,_jsx(ParamField,{body:`bank_address`,type:`string`,required:true,id:`param-bank-address`,children:_jsxs(_components.p,{children:[`Bank street address.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 240`})]})}),`\n`,_jsx(ParamField,{body:`account_holder`,type:`string`,required:true,id:`param-account-holder`,children:_jsxs(_components.p,{children:[`Account holder name of the beneficiary’s bank account.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 36`})]})}),`\n`,_jsx(ParamField,{body:`account_number`,type:`string`,id:`param-account-number`,children:_jsxs(_components.p,{children:[`Bank account number.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 60`}),_jsx(`br`,{}),`\nIf `,_jsx(_components.code,{children:`iban`}),` is not required, `,_jsx(_components.code,{children:`account_number`}),` is `,_jsx(_components.strong,{children:`required`}),`.`]})}),`\n`,_jsx(ParamField,{body:`iban`,type:`string`,id:`param-iban`,children:_jsxs(_components.p,{children:[`International bank account number, mostly for european countries.`,_jsx(`br`,{}),`\nspeaCountrys:`,_jsx(_components.code,{children:`AD`}),`,`,_jsx(_components.code,{children:`AT`}),`,`,_jsx(_components.code,{children:`BE`}),`,`,_jsx(_components.code,{children:`BG`}),`,`,_jsx(_components.code,{children:`CY`}),`,`,_jsx(_components.code,{children:`HR`}),`,`,_jsx(_components.code,{children:`CZ`}),`,`,_jsx(_components.code,{children:`DK`}),`,`,_jsx(_components.code,{children:`EE`}),`,`,_jsx(_components.code,{children:`FI`}),`,`,_jsx(_components.code,{children:`FR`}),`,`,_jsx(_components.code,{children:`DE`}),`,`,_jsx(_components.code,{children:`GR`}),`,`,_jsx(_components.code,{children:`HU`}),`,`,_jsx(_components.code,{children:`IS`}),`,`,_jsx(_components.code,{children:`IE`}),`,`,_jsx(_components.code,{children:`IT`}),`,`,_jsx(_components.code,{children:`LV`}),`,`,_jsx(_components.code,{children:`LI`}),`,`,_jsx(_components.code,{children:`LT`}),`,`,_jsx(_components.code,{children:`LU`}),`,`,_jsx(_components.code,{children:`MT`}),`,`,_jsx(_components.code,{children:`MC`}),`,`,_jsx(_components.code,{children:`NL`}),`,`,_jsx(_components.code,{children:`NO`}),`,`,_jsx(_components.code,{children:`PL`}),`,`,_jsx(_components.code,{children:`PT`}),`,`,_jsx(_components.code,{children:`RO`}),`,`,_jsx(_components.code,{children:`SM`}),`,`,_jsx(_components.code,{children:`SK`}),`,`,_jsx(_components.code,{children:`SI`}),`,`,_jsx(_components.code,{children:`ES`}),`,`,_jsx(_components.code,{children:`SE`}),`,`,_jsx(_components.code,{children:`CH`}),`,`,_jsx(_components.code,{children:`GB`}),`,`,_jsx(_components.code,{children:`VA`}),_jsx(`br`,{}),`\nspeaCurrency:`,_jsx(_components.code,{children:`EUR`}),`,`,_jsx(_components.code,{children:`USD`}),_jsx(`br`,{}),`\nIf the country and currency are in the above list, the `,_jsx(_components.code,{children:`iban`}),` is required.`]})}),`\n`,_jsx(ParamField,{body:`swift_code`,type:`string`,id:`param-swift-code`,children:_jsxs(_components.p,{children:[`BIC/SWIFT code`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 30`})]})}),`\n`,_jsx(ParamField,{body:`clearing_system`,type:`string`,id:`param-clearing-system`,children:_jsxs(_components.p,{children:[`Which clearing system should be used for this beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 30`}),_jsx(`br`,{}),`\nIt is related to `,_jsx(_components.code,{children:`payment_method`}),`, and the relationship can be obtained from this interface `,_jsx(_components.a,{href:`/api-reference/payout/paymentmethods_v1.1`,children:`Get a list of payment methods.`})]})}),`\n`,_jsx(ParamField,{body:`routing_code_type1`,type:`string`,id:`param-routing-code-type1`,children:_jsxs(_components.p,{children:[`Routing code type.`,_jsx(`br`,{}),`\nWhen the `,_jsx(_components.code,{children:`validation_field`}),` value of `,_jsx(_components.a,{href:`/api-reference/payout/paymentmethods_v1.1`,children:`Get a list of payment methods`}),` does not find the corresponding field in the input parameter list,\nthe field name is put into `,_jsx(_components.code,{children:`routing_code_type1`}),` and the value is put into the corresponding `,_jsx(_components.code,{children:`routing_code_value1`}),`.`]})}),`\n`,_jsx(ParamField,{body:`routing_code_value1`,type:`string`,id:`param-routing-code-value1`,children:_jsxs(_components.p,{children:[`Routing code value.`,_jsx(`br`,{}),`\nRouting code for routing_code_type_1.`,_jsx(`br`,{}),`\nIf supplied, routing_code_type_1 should also be supplied.`]})}),`\n`,_jsx(ParamField,{body:`routing_code_type2`,type:`string`,id:`param-routing-code-type2`,children:_jsxs(_components.p,{children:[`Routing code sub type.`,_jsx(`br`,{}),`\nWhen the `,_jsx(_components.code,{children:`validation_field`}),` value of `,_jsx(_components.a,{href:`/api-reference/payout/paymentmethods_v1.1`,children:`Get a list of payment methods`}),` does not find the corresponding field in the input parameter list,\nthe field name is put into `,_jsx(_components.code,{children:`routing_code_type2`}),` and the value is put into the corresponding `,_jsx(_components.code,{children:`routing_code_value2`}),`.`]})}),`\n`,_jsx(ParamField,{body:`routing_code_value2`,type:`string`,id:`param-routing-code-value2`,children:_jsxs(_components.p,{children:[`Routing code sub type value.`,_jsx(`br`,{}),`\nRouting code for routing_code_type_2. `,_jsx(`br`,{}),`\nIf supplied, routing_code_type_2 should also be supplied.`]})}),`\n`,_jsx(ParamField,{body:`country_code`,type:`string`,required:true,id:`param-country-code`,children:_jsxs(_components.p,{children:[`Country code of the beneficiary`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),`\n`,_jsx(ParamField,{body:`city`,type:`string`,required:true,id:`param-city`,children:_jsxs(_components.p,{children:[`City of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 36`})]})}),`\n`,_jsx(ParamField,{body:`state`,type:`string`,required:true,id:`param-state`,children:_jsxs(_components.p,{children:[`State of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 96`})]})}),`\n`,_jsx(ParamField,{body:`address`,type:`string`,required:true,id:`param-address`,children:_jsxs(_components.p,{children:[`Address of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 255`})]})}),`\n`,_jsx(ParamField,{body:`postal_code`,type:`string`,required:true,id:`param-postal-code`,children:_jsxs(_components.p,{children:[`Postal code of the beneficiary.`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`Maximum length 12`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`code`,type:`number`,id:`param-code`,children:_jsx(_components.p,{children:`Indicates whether the call was successful. 200 if successful, 400 if not.`})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`Response Message. “Success” if successful, others not.`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`details`,defaultOpen:true,children:[_jsx(ResponseField,{name:`beneficiary_id`,type:`string`,id:`param-beneficiary-id`,children:_jsx(_components.p,{children:`Beneficiary UUID.`})}),_jsx(ResponseField,{name:`entity_type`,type:`string`,id:`param-entity-type-1`,children:_jsxs(_components.p,{children:[`Entity type of the beneficiary.`,_jsx(`br`,{}),`\nOne of `,_jsx(_components.code,{children:`company`}),`, `,_jsx(_components.code,{children:`individual`})]})}),_jsx(ResponseField,{name:`payment_method`,type:`string`,id:`param-payment-method-1`,children:_jsxs(_components.p,{children:[`The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.`,_jsx(`br`,{}),`\nOne of `,_jsx(_components.code,{children:`local`}),`, `,_jsx(_components.code,{children:`swift`})]})}),_jsx(ResponseField,{name:`beneficiary_email`,type:`string`,id:`param-beneficiary-email`,children:_jsx(_components.p,{children:`Email of the beneficiary.`})}),_jsx(ResponseField,{name:`beneficiary_nickname`,type:`string`,id:`param-beneficiary-nickname`,children:_jsx(_components.p,{children:`Nickname of the beneficiary.`})}),_jsx(ResponseField,{name:`beneficiary_company_name`,type:`string`,id:`param-beneficiary-company-name`,children:_jsx(_components.p,{children:`Company name of the beneficiary.`})}),_jsx(ResponseField,{name:`account_currency_code`,type:`string`,id:`param-account-currency-code`,children:_jsxs(_components.p,{children:[`Account currency code.`,_jsx(`br`,{}),`\nThree-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_4217`,children:`ISO 4217`}),` currency code.`]})}),_jsx(ResponseField,{name:`bank_country_code`,type:`string`,id:`param-bank-country-code`,children:_jsxs(_components.p,{children:[`Bank country code.`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),_jsx(ResponseField,{name:`beneficiary_first_name`,type:`string`,id:`param-beneficiary-first-name`,children:_jsx(_components.p,{children:`First name of the beneficiary.`})}),_jsx(ResponseField,{name:`beneficiary_last_name`,type:`string`,id:`param-beneficiary-last-name`,children:_jsx(_components.p,{children:`Last name of the beneficiary.`})}),_jsxs(ResponseField,{name:`beneficiary_bank_details`,type:`object`,id:`param-beneficiary-bank-details`,children:[_jsx(_components.p,{children:`Beneficiary’s bank account details where the payment will be credited.`}),_jsxs(Expandable,{title:`details`,children:[_jsx(ResponseField,{name:`bank_name`,type:`string`,id:`param-bank-name-1`,children:_jsx(_components.p,{children:`Bank name of the beneficiary’s bank account.`})}),_jsx(ResponseField,{name:`bank_address`,type:`string`,id:`param-bank-address-1`,children:_jsx(_components.p,{children:`Bank street address.`})}),_jsx(ResponseField,{name:`bank_country_code`,type:`string`,id:`param-bank-country-code-1`,children:_jsxs(_components.p,{children:[`Bank country code.`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),_jsx(ResponseField,{name:`account_holder`,type:`string`,id:`param-account-holder-1`,children:_jsx(_components.p,{children:`Account holder name of the beneficiary’s bank account.`})}),_jsx(ResponseField,{name:`account_currency_code`,type:`string`,id:`param-account-currency-code-1`,children:_jsxs(_components.p,{children:[`Account currency code.`,_jsx(`br`,{}),`\nThree-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_4217`,children:`ISO 4217`}),` currency code.`]})}),_jsx(ResponseField,{name:`account_number`,type:`string`,id:`param-account-number-1`,children:_jsx(_components.p,{children:`Account number, mostly for non-european countries, either account_number or iban should be filled.`})}),_jsx(ResponseField,{name:`iban`,type:`string`,id:`param-iban-1`,children:_jsx(_components.p,{children:`International bank account number, mostly for european countries.`})}),_jsx(ResponseField,{name:`swift_code`,type:`string`,id:`param-swift-code-1`,children:_jsx(_components.p,{children:`Bank swift code.`})}),_jsx(ResponseField,{name:`clearing_system`,type:`string`,id:`param-clearing-system-1`,children:_jsx(_components.p,{children:`Which clearing system should be used for this.`})}),_jsx(ResponseField,{name:`routing_code_type1`,type:`string`,id:`param-routing-code-type1-1`,children:_jsx(_components.p,{children:`Routing code type.`})}),_jsx(ResponseField,{name:`routing_code_value1`,type:`string`,id:`param-routing-code-value1-1`,children:_jsx(_components.p,{children:`Routing code value.`})}),_jsx(ResponseField,{name:`routing_code_type2`,type:`string`,id:`param-routing-code-type2-1`,children:_jsx(_components.p,{children:`Routing code sub type.`})}),_jsx(ResponseField,{name:`routing_code_value2`,type:`string`,id:`param-routing-code-value2-1`,children:_jsx(_components.p,{children:`Routing code sub type value.`})})]})]}),_jsxs(ResponseField,{name:`beneficiary_address`,type:`object`,id:`param-beneficiary-address`,children:[_jsx(_components.p,{children:`Beneficiary’s address details.`}),_jsxs(Expandable,{title:`details`,children:[_jsx(ResponseField,{name:`country_code`,type:`string`,id:`param-country-code-1`,children:_jsxs(_components.p,{children:[`Country code of the beneficiary.`,_jsx(`br`,{}),`\nTwo-letter `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/ISO_3166-2`,children:`ISO 3166-2`}),` country code.`]})}),_jsx(ResponseField,{name:`city`,type:`string`,id:`param-city-1`,children:_jsx(_components.p,{children:`City of the beneficiary.`})}),_jsx(ResponseField,{name:`street_address`,type:`string`,id:`param-street-address`,children:_jsx(_components.p,{children:`Street address of the beneficiary.`})}),_jsx(ResponseField,{name:`postal_code`,type:`string`,id:`param-postal-code-1`,children:_jsx(_components.p,{children:`Postal code of the beneficiary.`})}),_jsx(ResponseField,{name:`state`,type:`string`,id:`param-state-1`,children:_jsx(_components.p,{children:`State of the beneficiary.`})})]})]})]})}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL Example Request`,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/create'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'content-type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'x-client-id: Up1HIsjiETPXLy7gON9PMG'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--data-raw `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{\"bank_country\":\"US\",\"account_currency\":\"USD\",\"entity_type\":\"company\",\"email\":\"[email protected]\",\"nickname\":\"MANY A-SUN\",\"first_name\":\"\",\"last_name\":\"\",\"company_name\":\"Courtesy Hardware Store\",\"payment_method\":\"swift\",\"bank_name\":\"1ST STATE BANK\",\"bank_address\":\"4929 Briarwood Drive\",\"account_holder\":\"Robert Shishani\",\"country_code\":\"US\",\"city\":\"Montgomery\",\"state\":\"Alabama\",\"address\":\"1230 Stafford Dr\",\"postal_code\":\"36117\",\"clearing_system\":\"SWIFT\",\"account_number\":\"4865393923574557\",\"swift_code\":\"230\"}'`})]}),`\n`]})})})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`Response`,numberOfLines:`20`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`20`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`200`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"00dcbdb4-3642-424d-88bf-76629efaa168\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_currency_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SGD\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"33990319141\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"bank_country_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SG\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"{`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`country_code`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`SG`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`city`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`singapore`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`street_address`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`7 Burn Road #07-07 Trivex Singapore 413577`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`postal_code`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`413577`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`state`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`singapore`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_bank_details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"{`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`bank_name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`test bank name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`bank_address`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`test bank address`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`bank_country_code`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`SG`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`account_holder`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`zuuzj`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`account_currency_code`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`SGD`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`account_number`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`33990319141`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`iban`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`swift_code`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`UOVBSGSG`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`clearing_system`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`local`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`routing_code_type1`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`routing_code_value1`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`routing_code_type2`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`,`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`routing_code_value2`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\"\\\\\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_company_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"00dcbdb4-3642-424d-88bf-76629efaa168\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_entity_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"individual\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_first_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"00dcbdb4-3642-424d-88bf-76629efaa168\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_last_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"00dcbdb4-3642-424d-88bf-76629efaa168\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"[email protected]\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_nickname\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"zuuj88\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"payment_method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"local\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beneficiary_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pending\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/create","description":"This endpoint create a beneficiary.","href":"/api-reference/beneficiaries/create"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Header","slug":"header","depth":3,"children":[]},{"title":"Parameters","slug":"parameters","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL Example Request","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"5\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'https://api.sandbox.uqpay.org/api/v1/beneficiaries/create'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'content-type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'x-client-id: Up1HIsjiETPXLy7gON9PMG'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">--data-raw \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'{\"bank_country\":\"US\",\"account_currency\":\"USD\",\"entity_type\":\"company\",\"email\":\"[email protected]\",\"nickname\":\"MANY A-SUN\",\"first_name\":\"\",\"last_name\":\"\",\"company_name\":\"Courtesy Hardware Store\",\"payment_method\":\"swift\",\"bank_name\":\"1ST STATE BANK\",\"bank_address\":\"4929 Briarwood Drive\",\"account_holder\":\"Robert Shishani\",\"country_code\":\"US\",\"city\":\"Montgomery\",\"state\":\"Alabama\",\"address\":\"1230 Stafford Dr\",\"postal_code\":\"36117\",\"clearing_system\":\"SWIFT\",\"account_number\":\"4865393923574557\",\"swift_code\":\"230\"}'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"Response","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"20\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">200\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"00dcbdb4-3642-424d-88bf-76629efaa168\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"account_currency_code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"SGD\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"account_number\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"33990319141\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"bank_country_code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"SG\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_address\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"{\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">country_code\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">SG\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">city\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">singapore\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">street_address\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">7 Burn Road #07-07 Trivex Singapore 413577\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">postal_code\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">413577\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">state\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">singapore\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">}\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_bank_details\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"{\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">bank_name\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">test bank name\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">bank_address\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">test bank address\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">bank_country_code\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">SG\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">account_holder\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">zuuzj\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">account_currency_code\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">SGD\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">account_number\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">33990319141\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">iban\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">swift_code\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">UOVBSGSG\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">clearing_system\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">local\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">routing_code_type1\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">routing_code_value1\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">routing_code_type2\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">,\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">routing_code_value2\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\\"\\\"\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">}\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_company_name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"00dcbdb4-3642-424d-88bf-76629efaa168\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_entity_type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"individual\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_first_name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"00dcbdb4-3642-424d-88bf-76629efaa168\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_last_name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"00dcbdb4-3642-424d-88bf-76629efaa168\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_email\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"[email protected]\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_nickname\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"zuuj88\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"payment_method\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"local\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beneficiary_status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"pending\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create a beneficiary","path":"/api/v1/beneficiaries/create","servers":[{"url":"https://api.sandbox.uqpay.org"}],"method":"post","request":{"security":[],"parameters":{"query":{},"header":{"x-client-id":{"schema":[{"type":"string","description":"`x-client-id` .","required":true}]},"x-auth-token":{"schema":[{"type":"string","description":"Bearer `YOUR_TOKEN_HERE` .","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"bank_country":[{"type":"string","description":"Account bank country code of the beneficiary. Two-letter ISO 3166-2 country code.","required":true}],"account_currency":[{"type":"string","description":"Account currency code of the beneficiary. Three-letter ISO 4217 currency code.","required":true}],"entity_type":[{"type":"string","description":"Entity type of the beneficiary. One of `company` , `individual`","required":true}],"email":[{"type":"string","description":"Email of the beneficiary.","required":true}],"nickname":[{"type":"string","description":"A nickname for the beneficiary. `Maximum length 120`","required":true}],"first_name":[{"type":"string","description":"Required if “entity_type” is “individual”. First name of the beneficiary. `Maximum length 45`"}],"last_name":[{"type":"string","description":"Required if “entity_type” is “individual”. Last name of the beneficiary. `Maximum length 45`"}],"company_name":[{"type":"string","description":"Required if “entity_type” is “company”. Company names cannot consist entirely of numbers. `Maximum length 120`"}],"payment_method":[{"type":"string","description":"Payment method of the beneficiary. One of `local` , `swift` . It is related to `clearing_system` , and the relationship can be obtained from this interface Get a list of payment methods.","required":true}],"bank_name":[{"type":"string","description":"Bank name of the beneficiary’s bank account. `Maximum length 240`","required":true}],"bank_address":[{"type":"string","description":"Bank street address. `Maximum length 240`","required":true}],"account_holder":[{"type":"string","description":"Account holder name of the beneficiary’s bank account. `Maximum length 36`","required":true}],"account_number":[{"type":"string","description":"Bank account number. `Maximum length 60` If `iban` is not required, `account_number` is required ."}],"iban":[{"type":"string","description":"International bank account number, mostly for european countries. speaCountrys: `AD` , `AT` , `BE` , `BG` , `CY` , `HR` , `CZ` , `DK` , `EE` , `FI` , `FR` , `DE` , `GR` , `HU` , `IS` , `IE` , `IT` , `LV` , `LI` , `LT` , `LU` , `MT` , `MC` , `NL` , `NO` , `PL` , `PT` , `RO` , `SM` , `SK` , `SI` , `ES` , `SE` , `CH` , `GB` , `VA` speaCurrency: `EUR` , `USD` If the country and currency are in the above list, the `iban` is required."}],"swift_code":[{"type":"string","description":"BIC/SWIFT code `Maximum length 30`"}],"clearing_system":[{"type":"string","description":"Which clearing system should be used for this beneficiary. `Maximum length 30` It is related to `payment_method` , and the relationship can be obtained from this interface Get a list of payment methods."}],"routing_code_type1":[{"type":"string","description":"Routing code type. When the `validation_field` value of Get a list of payment methods does not find the corresponding field in the input parameter list, the field name is put into `routing_code_type1` and the value is put into the corresponding `routing_code_value1` ."}],"routing_code_value1":[{"type":"string","description":"Routing code value. Routing code for routing_code_type_1. If supplied, routing_code_type_1 should also be supplied."}],"routing_code_type2":[{"type":"string","description":"Routing code sub type. When the `validation_field` value of Get a list of payment methods does not find the corresponding field in the input parameter list, the field name is put into `routing_code_type2` and the value is put into the corresponding `routing_code_value2` ."}],"routing_code_value2":[{"type":"string","description":"Routing code sub type value. Routing code for routing_code_type_2. If supplied, routing_code_type_2 should also be supplied."}],"country_code":[{"type":"string","description":"Country code of the beneficiary Two-letter ISO 3166-2 country code.","required":true}],"city":[{"type":"string","description":"City of the beneficiary. `Maximum length 36`","required":true}],"state":[{"type":"string","description":"State of the beneficiary. `Maximum length 96`","required":true}],"address":[{"type":"string","description":"Address of the beneficiary. `Maximum length 255`","required":true}],"postal_code":[{"type":"string","description":"Postal code of the beneficiary. `Maximum length 12`","required":true}]}}],"examples":{"example":{"value":{"bank_country":"\u003cstring>","account_currency":"\u003cstring>","entity_type":"\u003cstring>","email":"\u003cstring>","nickname":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","company_name":"\u003cstring>","payment_method":"\u003cstring>","bank_name":"\u003cstring>","bank_address":"\u003cstring>","account_holder":"\u003cstring>","account_number":"\u003cstring>","iban":"\u003cstring>","swift_code":"\u003cstring>","clearing_system":"\u003cstring>","routing_code_type1":"\u003cstring>","routing_code_value1":"\u003cstring>","routing_code_type2":"\u003cstring>","routing_code_value2":"\u003cstring>","country_code":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","address":"\u003cstring>","postal_code":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"code":[{"type":"number","description":"Indicates whether the call was successful. 200 if successful, 400 if not."}],"message":[{"type":"string","description":"Response Message. “Success” if successful, others not."}],"data":[{"type":"object","properties":{"beneficiary_id":[{"type":"string","description":"Beneficiary UUID."}],"entity_type":[{"type":"string","description":"Entity type of the beneficiary. One of `company` , `individual`"}],"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. One of `local` , `swift`"}],"beneficiary_email":[{"type":"string","description":"Email of the beneficiary."}],"beneficiary_nickname":[{"type":"string","description":"Nickname of the beneficiary."}],"beneficiary_company_name":[{"type":"string","description":"Company name of the beneficiary."}],"account_currency_code":[{"type":"string","description":"Account currency code. Three-letter ISO 4217 currency code."}],"bank_country_code":[{"type":"string","description":"Bank country code. Two-letter ISO 3166-2 country code."}],"beneficiary_first_name":[{"type":"string","description":"First name of the beneficiary."}],"beneficiary_last_name":[{"type":"string","description":"Last name of the beneficiary."}],"beneficiary_bank_details":[{"type":"object","properties":{"bank_name":[{"type":"string","description":"Bank name of the beneficiary’s bank account."}],"bank_address":[{"type":"string","description":"Bank street address."}],"bank_country_code":[{"type":"string","description":"Bank country code. Two-letter ISO 3166-2 country code."}],"account_holder":[{"type":"string","description":"Account holder name of the beneficiary’s bank account."}],"account_currency_code":[{"type":"string","description":"Account currency code. Three-letter ISO 4217 currency code."}],"account_number":[{"type":"string","description":"Account number, mostly for non-european countries, either account_number or iban should be filled."}],"iban":[{"type":"string","description":"International bank account number, mostly for european countries."}],"swift_code":[{"type":"string","description":"Bank swift code."}],"clearing_system":[{"type":"string","description":"Which clearing system should be used for this."}],"routing_code_type1":[{"type":"string","description":"Routing code type."}],"routing_code_value1":[{"type":"string","description":"Routing code value."}],"routing_code_type2":[{"type":"string","description":"Routing code sub type."}],"routing_code_value2":[{"type":"string","description":"Routing code sub type value."}]},"description":"Beneficiary’s bank account details where the payment will be credited."}],"beneficiary_address":[{"type":"object","properties":{"country_code":[{"type":"string","description":"Country code of the beneficiary. Two-letter ISO 3166-2 country code."}],"city":[{"type":"string","description":"City of the beneficiary."}],"street_address":[{"type":"string","description":"Street address of the beneficiary."}],"postal_code":[{"type":"string","description":"Postal code of the beneficiary."}],"state":[{"type":"string","description":"State of the beneficiary."}]},"description":"Beneficiary’s address details."}]}}]}}],"examples":{"example":{"value":{"code":123,"message":"\u003cstring>","data":{"beneficiary_id":"\u003cstring>","entity_type":"\u003cstring>","payment_method":"\u003cstring>","beneficiary_email":"\u003cstring>","beneficiary_nickname":"\u003cstring>","beneficiary_company_name":"\u003cstring>","account_currency_code":"\u003cstring>","bank_country_code":"\u003cstring>","beneficiary_first_name":"\u003cstring>","beneficiary_last_name":"\u003cstring>","beneficiary_bank_details":{"bank_name":"\u003cstring>","bank_address":"\u003cstring>","bank_country_code":"\u003cstring>","account_holder":"\u003cstring>","account_currency_code":"\u003cstring>","account_number":"\u003cstring>","iban":"\u003cstring>","swift_code":"\u003cstring>","clearing_system":"\u003cstring>","routing_code_type1":"\u003cstring>","routing_code_value1":"\u003cstring>","routing_code_type2":"\u003cstring>","routing_code_value2":"\u003cstring>"},"beneficiary_address":{"country_code":"\u003cstring>","city":"\u003cstring>","street_address":"\u003cstring>","postal_code":"\u003cstring>","state":"\u003cstring>"}}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"uqpaypteltd","siteName":"UQPAY Docs","title":"Create a beneficiary - UQPAY Docs","navMaps":{"firstHrefInVersion":{"v1.1":{"href":"/api-reference/beneficiaries/create","matchLevel":0},"v1":{"href":"/api-reference/beneficiaries/create","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T23:41:14.352Z","originalFileLocation":"api-reference/beneficiaries/create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint create a beneficiary.\">\u003cmeta data-mint-head name=\"application-name\" content=\"UQPAY Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a beneficiary - UQPAY Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint create a beneficiary.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"UQPAY Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.uqpay.org/api-reference/beneficiaries/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://uqpaypteltd.mintlify.site/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Create+a+beneficiary\u0026amp;description=This+endpoint+create+a+beneficiary.\u0026amp;theme=e6ff07a035d728c20723cea6\u0026amp;signature=243cbb030f123e354ab30ec2cf9181b4e3ad4aa8623c6ceb0ba4a9e160e04197\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a beneficiary - UQPAY Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint create a beneficiary.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://uqpaypteltd.mintlify.site/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Create+a+beneficiary\u0026amp;description=This+endpoint+create+a+beneficiary.\u0026amp;theme=e6ff07a035d728c20723cea6\u0026amp;signature=243cbb030f123e354ab30ec2cf9181b4e3ad4aa8623c6ceb0ba4a9e160e04197\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/uqpaypteltd/uvx0Tz1-Sjn58-6_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"UQPAY Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2165F4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.uqpay.org/api-reference/beneficiaries/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/beneficiaries/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.uqpay.org/#organization\",\"name\":\"UQPAY Docs\",\"url\":\"https://docs.uqpay.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/uqpaypteltd/uHX3BYExjP-ceVfw/logo/light.svg?fit=max\u0026auto=format\u0026n=uHX3BYExjP-ceVfw\u0026q=85\u0026s=aabcacf707570fb6b63ad12ff4172347\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.uqpay.org#website\",\"name\":\"UQPAY Docs\",\"url\":\"https://docs.uqpay.org\",\"publisher\":{\"@id\":\"https://docs.uqpay.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.uqpay.org/api-reference/beneficiaries/create#webpage\",\"url\":\"https://docs.uqpay.org/api-reference/beneficiaries/create\",\"name\":\"Create a beneficiary\",\"description\":\"This endpoint create a beneficiary.\",\"dateModified\":\"2026-01-06T23:41:14.352Z\",\"isPartOf\":{\"@id\":\"https://docs.uqpay.org#website\"},\"breadcrumb\":{\"@id\":\"https://docs.uqpay.org/api-reference/beneficiaries/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.uqpay.org/api-reference/beneficiaries/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"PAYOUT\",\"item\":\"https://docs.uqpay.org/api-reference/payer/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Beneficiaries\",\"item\":\"https://docs.uqpay.org/api-reference/beneficiaries/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a beneficiary\",\"item\":\"https://docs.uqpay.org/api-reference/beneficiaries/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.uqpay.org/api-reference/beneficiaries/create#apireference\",\"headline\":\"Create a beneficiary\",\"name\":\"Create a beneficiary\",\"description\":\"This endpoint create a beneficiary.\",\"url\":\"https://docs.uqpay.org/api-reference/beneficiaries/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.uqpay.org/api-reference/beneficiaries/create#webpage\"},\"dateModified\":\"2026-01-06T23:41:14.352Z\",\"publisher\":{\"@id\":\"https://docs.uqpay.org/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.uqpay.org#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"UQPAY Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"UQPAY Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/beneficiaries/create.md","siteName":"UQPAY Docs","nav":{"global":{"anchors":[{"anchor":"Github","href":"https://github.com/uqpay","icon":"github"},{"anchor":"Linkedin","href":"https://www.linkedin.com/company/uqpay/","icon":"linkedin"},{"anchor":"Official Website","href":"https://www.uqpay.com","icon":"globe"}]},"versions":[{"version":"v1.1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API OVERVIEW","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Idempotent Requests","href":"/api-reference/idempotent-requests"}]},{"group":"CORE","pages":[{"group":"Auth","pages":[{"title":"Sign in via API","api":"POST https://api.sandbox.uqpay.org/api/v1/auth/signin","href":"/api-reference/auth/signin"}]},{"group":"Balances","pages":[{"title":"List all balances","api":"GET https://api.sandbox.uqpay.org/api/v1/balances","href":"/api-reference/balance/list"},{"title":"Create a balance","api":"POST https://api.sandbox.uqpay.org/api/v1/balances/create","href":"/api-reference/balance/create"},{"title":"Retrieve a balance","api":"GET https://api.sandbox.uqpay.org/api/v1/balances/retrieve/{currency}","href":"/api-reference/balance/retrieve"},{"title":"Retrieve a bank details","api":"GET https://api.sandbox.uqpay.org/api/v1/balances/{currency}/bank_details","href":"/api-reference/balance/bank_details"},{"title":"List all transactions","api":"GET https://api.sandbox.uqpay.org/api/v1/transactions","href":"/api-reference/transactions/list"}]}]},{"group":"ISSUING","pages":[{"group":"Cards","pages":[{"title":"List all cards","api":"GET https://api.sandbox.uqpay.org/api/v1/cards","href":"/api-reference/card/list"},{"title":"Create a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/create","href":"/api-reference/card/create"},{"title":"Retrieve card details","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/{card_id}","href":"/api-reference/card/retrieve"},{"title":"Retrieve sensitive card details","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/{card_id}/secure","href":"/api-reference/card/secure"},{"title":"Recharge a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/recharge","href":"/api-reference/card/recharge"},{"title":"Withdraw a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/withdraw","href":"/api-reference/card/withdraw"},{"title":"Freeze a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/freeze","href":"/api-reference/card/freeze"},{"title":"Unfreeze a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/unfreeze","href":"/api-reference/card/unfreeze"},{"title":"Update a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/update","href":"/api-reference/card/update"},{"title":"Cancel a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/cancel","href":"/api-reference/card/cancel"},{"title":"Retrieve card operation result","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/record","href":"/api-reference/card/record"}]},{"group":"Products","pages":[{"title":"List Card Products","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/products","href":"/api-reference/card/products"}]},{"group":"Cardholders","pages":[{"title":"List all cardholders","api":"GET https://api.sandbox.uqpay.org/api/v1/cardholders","href":"/api-reference/cardholder/list"},{"title":"Create a cardholder","api":"POST https://api.sandbox.uqpay.org/api/v1/cardholders/create","href":"/api-reference/cardholder/create"},{"title":"Retrieve cardholder details","api":"GET https://api.sandbox.uqpay.org/api/v1/cardholders/{card_holder_id}","href":"/api-reference/cardholder/retrieve"},{"title":"Delete a cardholder","api":"POST https://api.sandbox.uqpay.org/api/v1/cardholders/{card_holder_id}/remove","href":"/api-reference/cardholder/remove"}]},{"group":"Transactions","pages":[{"title":"List all card transactions","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/transactions","href":"/api-reference/card_transactions/list"}]}]},{"group":"PAYOUT","pages":[{"group":"Payer","pages":[{"title":"Get list of payers","api":"GET https://api.sandbox.uqpay.org/api/v1/payers","href":"/api-reference/payer/list"}]},{"group":"Payout","pages":[{"title":"List all payouts","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts","href":"/api-reference/payout/list_v1.1"},{"title":"Create a new payout","api":"POST https://api.sandbox.uqpay.org/api/v1/payouts/create","href":"/api-reference/payout/create_v1.1"},{"title":"Retrieve a payout by id","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts/{payout_id}/retrieve","href":"/api-reference/payout/retrieve_v1.1"},{"title":"Get a list of payment methods","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts/paymentmethods","href":"/api-reference/payout/paymentmethods_v1.1"},{"title":"Check payment validation","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts/validation","href":"/api-reference/payout/validation_v1.1"}]},{"group":"Beneficiaries","pages":[{"title":"List all beneficiaries","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries","description":"Get list of beneficiaries.","href":"/api-reference/beneficiaries/list"},{"title":"Create a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/create","href":"/api-reference/beneficiaries/create"},{"title":"Update a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}/update","description":"This endpoint update a beneficiary.","href":"/api-reference/beneficiaries/update"},{"title":"Delete a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}/delete","href":"/api-reference/beneficiaries/delete"},{"title":"Retrieve a beneficiary by id","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}","href":"/api-reference/beneficiaries/retrieve"},{"title":"Query a beneficiary","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries/query","href":"/api-reference/beneficiaries/query_v1.1"}]}]},{"group":"Webhooks","pages":[{"group":"Payout","pages":[{"title":"Payout webhooks","href":"/api-reference/webhooks/payout/webhooks_1.1"}]},{"group":"Beneficiary","pages":[{"title":"Beneficiaries webhooks","href":"/api-reference/webhooks/beneficiaries/beneficiaries_webhooks_1.1"}]}]}]}]},{"version":"v1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API OVERVIEW","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Idempotent Requests","href":"/api-reference/idempotent-requests"}]},{"group":"CORE","pages":[{"group":"Auth","pages":[{"title":"Sign in via API","api":"POST https://api.sandbox.uqpay.org/api/v1/auth/signin","href":"/api-reference/auth/signin"}]},{"group":"Balances","pages":[{"title":"List all balances","api":"GET https://api.sandbox.uqpay.org/api/v1/balances","href":"/api-reference/balance/list"},{"title":"Create a balance","api":"POST https://api.sandbox.uqpay.org/api/v1/balances/create","href":"/api-reference/balance/create"},{"title":"Retrieve a balance","api":"GET https://api.sandbox.uqpay.org/api/v1/balances/retrieve/{currency}","href":"/api-reference/balance/retrieve"},{"title":"Retrieve a bank details","api":"GET https://api.sandbox.uqpay.org/api/v1/balances/{currency}/bank_details","href":"/api-reference/balance/bank_details"},{"title":"List all transactions","api":"GET https://api.sandbox.uqpay.org/api/v1/transactions","href":"/api-reference/transactions/list"}]}]},{"group":"ISSUING","pages":[{"group":"Cards","pages":[{"title":"List all cards","api":"GET https://api.sandbox.uqpay.org/api/v1/cards","href":"/api-reference/card/list"},{"title":"Create a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/create","href":"/api-reference/card/create"},{"title":"Retrieve card details","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/{card_id}","href":"/api-reference/card/retrieve"},{"title":"Retrieve sensitive card details","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/{card_id}/secure","href":"/api-reference/card/secure"},{"title":"Recharge a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/recharge","href":"/api-reference/card/recharge"},{"title":"Withdraw a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/withdraw","href":"/api-reference/card/withdraw"},{"title":"Freeze a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/freeze","href":"/api-reference/card/freeze"},{"title":"Unfreeze a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/unfreeze","href":"/api-reference/card/unfreeze"},{"title":"Update a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/update","href":"/api-reference/card/update"},{"title":"Cancel a card","api":"POST https://api.sandbox.uqpay.org/api/v1/cards/cancel","href":"/api-reference/card/cancel"},{"title":"Retrieve card operation result","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/record","href":"/api-reference/card/record"}]},{"group":"Products","pages":[{"title":"List Card Products","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/products","href":"/api-reference/card/products"}]},{"group":"Cardholders","pages":[{"title":"List all cardholders","api":"GET https://api.sandbox.uqpay.org/api/v1/cardholders","href":"/api-reference/cardholder/list"},{"title":"Create a cardholder","api":"POST https://api.sandbox.uqpay.org/api/v1/cardholders/create","href":"/api-reference/cardholder/create"},{"title":"Retrieve cardholder details","api":"GET https://api.sandbox.uqpay.org/api/v1/cardholders/{card_holder_id}","href":"/api-reference/cardholder/retrieve"},{"title":"Delete a cardholder","api":"POST https://api.sandbox.uqpay.org/api/v1/cardholders/{card_holder_id}/remove","href":"/api-reference/cardholder/remove"}]},{"group":"Transactions","pages":[{"title":"List all card transactions","api":"GET https://api.sandbox.uqpay.org/api/v1/cards/transactions","href":"/api-reference/card_transactions/list"}]}]},{"group":"PAYOUT","pages":[{"group":"Payer","pages":[{"title":"Get list of payers","api":"GET https://api.sandbox.uqpay.org/api/v1/payers","href":"/api-reference/payer/list"}]},{"group":"Payout","pages":[{"title":"List all payouts","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts","href":"/api-reference/payout/list"},{"title":"Create a new payout","api":"POST https://api.sandbox.uqpay.org/api/v1/payouts/create","href":"/api-reference/payout/create"},{"title":"Retrieve a payout by id","api":"GET https://api.sandbox.uqpay.org/api/v1/payouts/{payout_id}/retrieve","href":"/api-reference/payout/retrieve"}]},{"group":"Beneficiaries","pages":[{"title":"List all beneficiaries","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries","description":"Get list of beneficiaries.","href":"/api-reference/beneficiaries/list"},{"title":"Create a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/create","href":"/api-reference/beneficiaries/create"},{"title":"Update a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}/update","description":"This endpoint update a beneficiary.","href":"/api-reference/beneficiaries/update"},{"title":"Delete a beneficiary","api":"POST https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}/delete","href":"/api-reference/beneficiaries/delete"},{"title":"Retrieve a beneficiary by id","api":"GET https://api.sandbox.uqpay.org/api/v1/beneficiaries/{beneficiary_id}","href":"/api-reference/beneficiaries/retrieve"}]}]}]}]}]},"basePath":"","title":"Create a beneficiary - UQPAY Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js"]}