Bank account data. Refer to the Metadata API for valid field combinations.Fields
string
The account number of the bank account
string
The first address line of the bank
string
required
The ISO 3166-1 alpha-2 code of the bank’s country
string
required
The ISO 4217 code of the bank account’s currency
string
The identifier of the bank
string
The identifier type of the bank
string
Name of the bank account holder
string
The account for the correspondent account of the bank
string
The SWIFT code for the correspondent account of the bank
string
The IBAN of the bank account
string
The INN of the bank account
string
The KBK of the bank account
string
The KIO of the bank account
string
The KPP of the bank account
string
The purpose of payment is mandatory when the beneficiary account has specific currency types. See the section PurposeOfPayment for the currencies and their acceptable values.
string
The reason for trade of the bank account
string
The reference information which will be used as the default payment reference during payment initiation.
string
The Russian central account number of the bank account
This model is a representation of a beneficiary’s core data.Fields
string
required
The name of the beneficiary
array
The list of beneficiary’s email addresses
boolean
required
Whether the beneficiary should receive email notification of payments
string
The first address line of the beneficiary
string
The street name of the beneficiary*
string
The building number of the beneficiary*
string
The floor of the beneficiary*
string
The apartment/office number of the beneficiary*
string
required
The city of the beneficiary*
string
The state/region of the beneficiary*
string
The postcode of the beneficiary
string
required
The ISO 3166-1 alpha-2 code of the beneficiary’s country
* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.
True if beneficiary is active, False otherwise (Always)
string
Unique external reference ID submitted by the client for the beneficiary.
* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.
AMLStatus
AML status of the BeneficiaryValues
Value
Description
OK
Beneficiary checks completed, ready to be paid
Pending Review
Reviewing beneficiary information
Pending information
Awaiting beneficiary information
Blocked
Client account blocked
PurposeOfPayment
Valid purpose of payment values.When country is China, the following purpose of payment values are mandatory only for CNY currency. See values listWhen country is United Arab Emirates, the following purpose of payment values are mandatory for all currencies. See values list
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Ebury","colors":{"primary":"#73B0CA","light":"#73B0CA","dark":"#73B0CA"},"logo":{"light":"https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/logo/light.svg?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=171beecd1c422bb5a896ebdf7a2bf872","dark":"https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/logo/dark.svg?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=30c0d6ec67e487abc63236d0cdfb784e"},"favicon":"https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/logo/favicon.png?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=64cdb26e56d359bc7493b9fb4bd17158","navbar":{"links":[{"href":"https://postman.ebury.io/","label":"Postman"}],"primary":{"type":"button","label":"Get started","href":"https://ebury.com/contact-us"}},"footer":{"socials":{"facebook":"https://www.facebook.com/EburyFintech","instagram":"https://www.instagram.com/ebury_fintech","linkedin":"https://www.linkedin.com/company/ebury","x":"https://twitter.com/Ebury_Fintech"},"links":[{"items":[{"label":"Ebury.com","href":"https://ebury.com/"},{"label":"Legal","href":"https://ebury.com/legal"},{"label":"Privacy Notice","href":"https://ebury.com/legal/privacy-notice"},{"label":"Cookie Notice","href":"https://ebury.com/legal/cookie-notice"}]}]},"integrations":{"ga4":{"measurementId":"G-4851W0ZHR1"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ebury","hasAudioNarration":false,"actualSubdomain":"ebury","customDomains":["docs.ebury.com"],"gitSource":{"type":"github","owner":"ebury","repo":"ebury-api-mintlify-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afac9e014079de35bcc6ba8","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":105},{"language":"default","tag":"Endpoints","count":84},{"language":"default","tag":"Guides","count":19},{"language":"default","tag":"Data models","count":16},{"language":"default","tag":"Getting started","count":11},{"language":"default","tag":"Ebury payments","count":8},{"language":"default","tag":"Account details","count":7},{"language":"default","tag":"OAuth2.0","count":7},{"language":"default","tag":"Payments","count":7},{"language":"default","tag":"Statements","count":7}],"searchSettings":{"maxResults":12}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/beneficiary-models","slug":"/api/beneficiary-models","pageMetadata":{"title":"Beneficiary Models","description":"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.","href":"/api/beneficiary-models"},"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: \"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.\"\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`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`bankaccount`,children:`BankAccount`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`23`,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:`23`,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:` \"account_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_address_line_1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:`\"string\"`}),_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_currency_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_identifier\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_identifier_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"correspondent_account\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"correspondent_swift_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"iban\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"inn\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"kbk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"kio\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"kpp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"purpose_of_payment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"reason_for_trade\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"reference_information\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"russian_central_bank_account\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"swift_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"vo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Bank account data. Refer to the `,_jsx(_components.a,{href:`/v1/api-reference/metadata/get-beneficiary-metadata`,children:`Metadata API`}),` for valid field combinations.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`account_number`,type:`string`,id:`param-account-number`,children:_jsx(_components.p,{children:`The account number of the bank account`})}),`\n`,_jsx(ResponseField,{name:`bank_address_line_1`,type:`string`,id:`param-bank-address-line-1`,children:_jsx(_components.p,{children:`The first address line of the bank`})}),`\n`,_jsx(ResponseField,{name:`bank_country_code`,type:`string`,required:true,id:`param-bank-country-code`,children:_jsx(_components.p,{children:`The ISO 3166-1 alpha-2 code of the bank’s country`})}),`\n`,_jsx(ResponseField,{name:`bank_currency_code`,type:`string`,required:true,id:`param-bank-currency-code`,children:_jsx(_components.p,{children:`The ISO 4217 code of the bank account’s currency`})}),`\n`,_jsx(ResponseField,{name:`bank_identifier`,type:`string`,id:`param-bank-identifier`,children:_jsx(_components.p,{children:`The identifier of the bank`})}),`\n`,_jsx(ResponseField,{name:`bank_identifier_type`,type:`string`,id:`param-bank-identifier-type`,children:_jsx(_components.p,{children:`The identifier type of the bank`})}),`\n`,_jsx(ResponseField,{name:`bank_name`,type:`string`,id:`param-bank-name`,children:_jsx(_components.p,{children:`Name of the bank account holder`})}),`\n`,_jsx(ResponseField,{name:`correspondent_account`,type:`string`,id:`param-correspondent-account`,children:_jsx(_components.p,{children:`The account for the correspondent account of the bank`})}),`\n`,_jsx(ResponseField,{name:`correspondent_swift_code`,type:`string`,id:`param-correspondent-swift-code`,children:_jsx(_components.p,{children:`The SWIFT code for the correspondent account of the bank`})}),`\n`,_jsx(ResponseField,{name:`iban`,type:`string`,id:`param-iban`,children:_jsx(_components.p,{children:`The IBAN of the bank account`})}),`\n`,_jsx(ResponseField,{name:`inn`,type:`string`,id:`param-inn`,children:_jsx(_components.p,{children:`The INN of the bank account`})}),`\n`,_jsx(ResponseField,{name:`kbk`,type:`string`,id:`param-kbk`,children:_jsx(_components.p,{children:`The KBK of the bank account`})}),`\n`,_jsx(ResponseField,{name:`kio`,type:`string`,id:`param-kio`,children:_jsx(_components.p,{children:`The KIO of the bank account`})}),`\n`,_jsx(ResponseField,{name:`kpp`,type:`string`,id:`param-kpp`,children:_jsx(_components.p,{children:`The KPP of the bank account`})}),`\n`,_jsx(ResponseField,{name:`purpose_of_payment`,type:`string`,id:`param-purpose-of-payment`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.a,{href:`#purposeofpayment`,children:`purpose of payment`}),` is mandatory when the beneficiary account has specific currency types. See the section `,_jsx(_components.a,{href:`#purposeofpayment`,children:`PurposeOfPayment`}),` for the currencies and their acceptable values.`]})}),`\n`,_jsx(ResponseField,{name:`reason_for_trade`,type:`string`,id:`param-reason-for-trade`,children:_jsx(_components.p,{children:`The reason for trade of the bank account`})}),`\n`,_jsx(ResponseField,{name:`reference_information`,type:`string`,id:`param-reference-information`,children:_jsx(_components.p,{children:`The reference information which will be used as the default payment reference during payment initiation.`})}),`\n`,_jsx(ResponseField,{name:`russian_central_bank_account`,type:`string`,id:`param-russian-central-bank-account`,children:_jsx(_components.p,{children:`The Russian central account number of the bank account`})}),`\n`,_jsx(ResponseField,{name:`swift_code`,type:`string`,id:`param-swift-code`,children:_jsx(_components.p,{children:`The SWIFT code of the bank account`})}),`\n`,_jsx(ResponseField,{name:`vo`,type:`string`,id:`param-vo`,children:_jsx(_components.p,{children:`The VO of the bank account`})}),`\n`,_jsx(ResponseField,{name:`account_id`,type:`string`,required:true,id:`param-account-id`,children:_jsx(_components.p,{children:`The identifier of the bank account`})}),`\n`,_jsx(Heading,{level:`2`,id:`beneficiarycoredata`,children:`BeneficiaryCoreData`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`16`,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:`16`,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:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"email_addresses\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"string\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email_notification\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"address_line_1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"street_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"building_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"floor\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"apartment_office_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"city\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"state_region\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"post_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"country_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`This model is a representation of a beneficiary’s core data.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`The name of the beneficiary`})}),`\n`,_jsx(ResponseField,{name:`email_addresses`,type:`array`,id:`param-email-addresses`,children:_jsx(_components.p,{children:`The list of beneficiary’s email addresses`})}),`\n`,_jsx(ResponseField,{name:`email_notification`,type:`boolean`,required:true,id:`param-email-notification`,children:_jsx(_components.p,{children:`Whether the beneficiary should receive email notification of payments`})}),`\n`,_jsx(ResponseField,{name:`address_line_1`,type:`string`,id:`param-address-line-1`,children:_jsx(_components.p,{children:`The first address line of the beneficiary`})}),`\n`,_jsx(ResponseField,{name:`street_name`,type:`string`,id:`param-street-name`,children:_jsx(_components.p,{children:`The street name of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`building_number`,type:`string`,id:`param-building-number`,children:_jsx(_components.p,{children:`The building number of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`floor`,type:`string`,id:`param-floor`,children:_jsx(_components.p,{children:`The floor of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`apartment_office_number`,type:`string`,id:`param-apartment-office-number`,children:_jsx(_components.p,{children:`The apartment/office number of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`city`,type:`string`,required:true,id:`param-city`,children:_jsx(_components.p,{children:`The city of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`state_region`,type:`string`,id:`param-state-region`,children:_jsx(_components.p,{children:`The state/region of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`post_code`,type:`string`,id:`param-post-code`,children:_jsx(_components.p,{children:`The postcode of the beneficiary`})}),`\n`,_jsx(ResponseField,{name:`country_code`,type:`string`,required:true,id:`param-country-code`,children:_jsx(_components.p,{children:`The ISO 3166-1 alpha-2 code of the beneficiary’s country`})}),`\n`,_jsx(_components.p,{children:`* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.`}),`\n`,_jsx(Heading,{level:`2`,id:`beneficiary`,children:`Beneficiary`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`46`,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:`46`,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:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"email_addresses\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"string\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email_notification\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"address_line_1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"street_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"building_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"floor\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"apartment_office_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"city\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"state_region\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"post_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"country_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_accounts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_address_line_1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:`\"string\"`}),_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_currency_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_identifier\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_identifier_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"correspondent_account\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"correspondent_swift_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"iban\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"inn\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"kbk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"kio\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"kpp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"purpose_of_payment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"reason_for_trade\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"reference_information\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"russian_central_bank_account\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"swift_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"vo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"integer\"`})]}),`\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`,_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:`\"string\"`}),_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:` \"created\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"aml_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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:` \"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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_reference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_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`]})})}),`\n`,_jsx(_components.p,{children:`This model is a representation of a beneficiary.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`name`,type:`string`,required:true,id:`param-name-1`,children:_jsx(_components.p,{children:`The name of the beneficiary (Always)`})}),`\n`,_jsx(ResponseField,{name:`email_addresses`,type:`array`,id:`param-email-addresses-1`,children:_jsx(_components.p,{children:`The list of beneficiary’s email addresses`})}),`\n`,_jsx(ResponseField,{name:`email_notification`,type:`boolean`,required:true,id:`param-email-notification-1`,children:_jsx(_components.p,{children:`Whether the beneficiary should receive email notification of payments (Always)`})}),`\n`,_jsx(ResponseField,{name:`address_line_1`,type:`string`,id:`param-address-line-1-1`,children:_jsx(_components.p,{children:`The first address line of the beneficiary`})}),`\n`,_jsx(ResponseField,{name:`street_name`,type:`string`,id:`param-street-name-1`,children:_jsx(_components.p,{children:`The street name of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`building_number`,type:`string`,id:`param-building-number-1`,children:_jsx(_components.p,{children:`The building number of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`floor`,type:`string`,id:`param-floor-1`,children:_jsx(_components.p,{children:`The floor of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`apartment_office_number`,type:`string`,id:`param-apartment-office-number-1`,children:_jsx(_components.p,{children:`The apartment/office number of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`city`,type:`string`,required:true,id:`param-city-1`,children:_jsx(_components.p,{children:`The city of the beneficiary* (Always)`})}),`\n`,_jsx(ResponseField,{name:`state_region`,type:`string`,id:`param-state-region-1`,children:_jsx(_components.p,{children:`The state/region of the beneficiary*`})}),`\n`,_jsx(ResponseField,{name:`post_code`,type:`string`,id:`param-post-code-1`,children:_jsx(_components.p,{children:`The postcode of the beneficiary`})}),`\n`,_jsx(ResponseField,{name:`country_code`,type:`string`,required:true,id:`param-country-code-1`,children:_jsx(_components.p,{children:`The ISO 3166-1 alpha-2 code of the beneficiary’s country (Always)`})}),`\n`,_jsx(ResponseField,{name:`bank_accounts`,type:`array`,required:true,id:`param-bank-accounts`,children:_jsxs(_components.p,{children:[`The list of beneficiary’s `,_jsx(_components.a,{href:`#bankaccount`,children:`bank accounts`}),` (Always)`]})}),`\n`,_jsx(ResponseField,{name:`beneficiary_id`,type:`string`,required:true,id:`param-beneficiary-id`,children:_jsx(_components.p,{children:`The beneficiary ID (Always)`})}),`\n`,_jsx(ResponseField,{name:`created`,type:`string`,required:true,id:`param-created`,children:_jsx(_components.p,{children:`Creation date of the beneficiary (Always)`})}),`\n`,_jsx(ResponseField,{name:`aml_status`,type:`string`,required:true,id:`param-aml-status`,children:_jsxs(_components.p,{children:[_jsx(_components.a,{href:`#amlstatus`,children:`AML status`}),` of the beneficiary (Always)`]})}),`\n`,_jsx(ResponseField,{name:`active`,type:`boolean`,required:true,id:`param-active`,children:_jsx(_components.p,{children:`True if beneficiary is active, False otherwise (Always)`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_reference`,type:`string`,id:`param-beneficiary-reference`,children:_jsx(_components.p,{children:`Unique external reference ID submitted by the client for the beneficiary.`})}),`\n`,_jsx(_components.p,{children:`* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.`}),`\n`,_jsx(Heading,{level:`2`,id:`amlstatus`,children:`AMLStatus`}),`\n`,_jsx(_components.p,{children:`AML status of the Beneficiary`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Values`})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Value`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`OK`})}),_jsx(_components.td,{children:`Beneficiary checks completed, ready to be paid`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Pending Review`})}),_jsx(_components.td,{children:`Reviewing beneficiary information`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Pending information`})}),_jsx(_components.td,{children:`Awaiting beneficiary information`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Blocked`})}),_jsx(_components.td,{children:`Client account blocked`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`purposeofpayment`,children:`PurposeOfPayment`}),`\n`,_jsx(_components.p,{children:`Valid purpose of payment values.`}),`\n`,_jsxs(_components.p,{children:[`When country is China, the following purpose of payment values are mandatory only for CNY currency. `,_jsx(_components.a,{href:`/api/resources/chn-pop-codes`,children:`See values list`})]}),`\n`,_jsxs(_components.p,{children:[`When country is United Arab Emirates, the following purpose of payment values are mandatory for all currencies. `,_jsx(_components.a,{href:`/api/resources/uae-pop-codes`,children:`See values list`})]})]})}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":"Beneficiary Models","description":"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.","href":"/api/beneficiary-models"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"BankAccount","slug":"bankaccount","depth":2,"children":[]},{"title":"BeneficiaryCoreData","slug":"beneficiarycoredata","depth":2,"children":[]},{"title":"Beneficiary","slug":"beneficiary","depth":2,"children":[]},{"title":"AMLStatus","slug":"amlstatus","depth":2,"children":[]},{"title":"PurposeOfPayment","slug":"purposeofpayment","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ebury/0f25bc0ed81b3628/statsig.js","/_mintlify/custom/ebury/05cc4dab1f4ee49a/legacy-anchors.js"],"subdomain":"ebury","siteName":"Ebury","title":"Beneficiary Models - Ebury","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api/beneficiary-models","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T09:16:26.683Z","originalFileLocation":"api/beneficiary-models.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=\"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ebury\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_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/ebury/jbllhyGxPl7PK0TE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ebury/jbllhyGxPl7PK0TE/_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/ebury/jbllhyGxPl7PK0TE/_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/ebury/jbllhyGxPl7PK0TE/_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/ebury/jbllhyGxPl7PK0TE/_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/ebury/jbllhyGxPl7PK0TE/_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/ebury/jbllhyGxPl7PK0TE/_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/ebury/jbllhyGxPl7PK0TE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Beneficiary Models - Ebury\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ebury\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ebury.com/api/beneficiary-models\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ebury.mintlify.site/_mintlify/api/og/v2?division=Data+models\u0026amp;title=Beneficiary+Models\u0026amp;description=Reference+for+Ebury+beneficiary+data+models%2C+including+BankAccount%2C+BeneficiaryCoreData%2C+Beneficiary%2C+AML+status+and+purpose+of+payment.\u0026amp;theme=82f2409686991e5640c22941\u0026amp;signature=d2d7035a56988aa24c85473844a73bb2df1784fee570d5a9e7d3e154fef733ae\">\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=\"Beneficiary Models - Ebury\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ebury.mintlify.site/_mintlify/api/og/v2?division=Data+models\u0026amp;title=Beneficiary+Models\u0026amp;description=Reference+for+Ebury+beneficiary+data+models%2C+including+BankAccount%2C+BeneficiaryCoreData%2C+Beneficiary%2C+AML+status+and+purpose+of+payment.\u0026amp;theme=82f2409686991e5640c22941\u0026amp;signature=d2d7035a56988aa24c85473844a73bb2df1784fee570d5a9e7d3e154fef733ae\">\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/ebury/jbllhyGxPl7PK0TE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ebury\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#73B0CA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ebury.com/api/beneficiary-models\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/beneficiary-models.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ebury.com/#organization\",\"name\":\"Ebury\",\"url\":\"https://docs.ebury.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/logo/light.svg?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=171beecd1c422bb5a896ebdf7a2bf872\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ebury.com#website\",\"name\":\"Ebury\",\"url\":\"https://docs.ebury.com\",\"publisher\":{\"@id\":\"https://docs.ebury.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ebury.com/api/beneficiary-models#webpage\",\"url\":\"https://docs.ebury.com/api/beneficiary-models\",\"name\":\"Beneficiary Models\",\"description\":\"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.\",\"dateModified\":\"2026-11-16T09:16:26.683Z\",\"isPartOf\":{\"@id\":\"https://docs.ebury.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ebury.com/api/beneficiary-models#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ebury.com/api/beneficiary-models#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data models\",\"item\":\"https://docs.ebury.com/api/account-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Beneficiary Models\",\"item\":\"https://docs.ebury.com/api/beneficiary-models\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.ebury.com/api/beneficiary-models#article\",\"headline\":\"Beneficiary Models\",\"name\":\"Beneficiary Models\",\"description\":\"Reference for Ebury beneficiary data models, including BankAccount, BeneficiaryCoreData, Beneficiary, AML status and purpose of payment.\",\"url\":\"https://docs.ebury.com/api/beneficiary-models\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ebury.com/api/beneficiary-models#webpage\"},\"dateModified\":\"2026-11-16T09:16:26.683Z\",\"publisher\":{\"@id\":\"https://docs.ebury.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ebury.com#website\"}}]}\u003c/script>","agentPointerHref":"/api/beneficiary-models.md","siteName":"Ebury","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/introduction"}]},{"tab":"API Reference","versions":[{"version":"v1","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Getting Started","href":"/api/getting-started"},{"title":"Authentication","href":"/api/authentication"},{"title":"Example Workflow","href":"/api/example-workflow"},{"title":"Webhook notifications","href":"/api/webhooks"}]},{"group":"Endpoints","pages":[{"group":"OAuth2.0","pages":[{"title":"Authenticate","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /authenticate","href":"/v1/api-reference/oauth20/authenticate"},{"title":"Authenticate","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /authenticate","href":"/v1/api-reference/oauth20/authenticate-1"},{"title":"Available contacts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /info/available-contacts","href":"/v1/api-reference/oauth20/available-contacts"},{"title":"Login","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /login","href":"/v1/api-reference/oauth20/login"},{"title":"Send verification code","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /send-verification-code","href":"/v1/api-reference/oauth20/send-verification-code"},{"title":"Token","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /token","href":"/v1/api-reference/oauth20/token"},{"title":"Verify","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /verify","href":"/v1/api-reference/oauth20/verify"}]},{"group":"Account details","pages":[{"title":"Get the list of account details of the referred client","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /account-details","href":"/v1/api-reference/account-details/get-the-list-of-account-details-of-the-referred-client"},{"title":"Get all the account details (pooled, virtual, segregated)","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /account-details/all","href":"/v1/api-reference/account-details/get-all-the-account-details-pooled-virtual-segregated"},{"title":"Retrieve the account details PDF","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /account-details/pdf","href":"/v1/api-reference/account-details/retrieve-the-account-details-pdf"},{"title":"Request a Dedicated account for a currency+country pair.","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /account-details/request","href":"/v1/api-reference/account-details/request-a-dedicated-account-for-a-currency+country-pair"},{"title":"Assign a new Virtual account for a currency","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /account-details/virtual/{currency}","href":"/v1/api-reference/account-details/assign-a-new-virtual-account-for-a-currency"},{"title":"Update the alias of an account details","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /account-details/{account_details_id}","href":"/v1/api-reference/account-details/update-the-alias-of-an-account-details"},{"title":"Mark the account as primary (default) for its holder and currency","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /account-details/{account_details_id}/make-default","href":"/v1/api-reference/account-details/mark-the-account-as-primary-default-for-its-holder-and-currency"}]},{"group":"Accounts","pages":[{"title":"Retrieve a list of accounts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts","href":"/v1/api-reference/accounts/retrieve-a-list-of-accounts"},{"title":"Retrieve currency accounts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/currency-accounts","href":"/v1/api-reference/accounts/retrieve-currency-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}","href":"/v1/api-reference/accounts/get-an-account"},{"title":"Get funding account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /funding-account","href":"/v1/api-reference/accounts/get-funding-account"}]},{"group":"Balances","pages":[{"title":"Get a balance for a single account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}/balances","href":"/v1/api-reference/balances/get-a-balance-for-a-single-account"},{"title":"Retrieve a list of the client's balances","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /balances","href":"/v1/api-reference/balances/retrieve-a-list-of-the-clients-balances"}]},{"group":"Statements Create","pages":[{"title":"Create statement file for an account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /accounts/{account_id}/statements/file","href":"/v1/api-reference/statements-create/create-statement-file-for-an-account"}]},{"group":"Statement Fetch","pages":[{"title":"Get an account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}/statements/{statement_id}/file","href":"/v1/api-reference/statement-fetch/get-an-account"}]},{"group":"Transactions","pages":[{"title":"Get transactions for a single account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}/transactions","href":"/v1/api-reference/transactions/get-transactions-for-a-single-account"},{"title":"Get a single transactions for an account","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /accounts/{account_id}/transactions/{transaction_id}","href":"/v1/api-reference/transactions/get-a-single-transactions-for-an-account"},{"title":"Get transactions for all client accounts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /transactions","href":"/v1/api-reference/transactions/get-transactions-for-all-client-accounts"}]},{"group":"Approvals Workflow","pages":[{"title":"Get the Approvals Workflow configuration","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /approvals-workflow/config","href":"/v1/api-reference/approvals-workflow/get-the-approvals-workflow-configuration"},{"title":"Update the Approvals Workflow configuration","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /approvals-workflow/config","href":"/v1/api-reference/approvals-workflow/update-the-approvals-workflow-configuration"},{"title":"Get the Approvals Workflow settings","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /approvals-workflow/settings","href":"/v1/api-reference/approvals-workflow/get-the-approvals-workflow-settings"},{"title":"Update the Approvals Workflow settings","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /approvals-workflow/settings","href":"/v1/api-reference/approvals-workflow/update-the-approvals-workflow-settings"}]},{"group":"Beneficiaries","pages":[{"title":"Get beneficiaries","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /beneficiaries","href":"/v1/api-reference/beneficiaries/get-beneficiaries"},{"title":"Create a new beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /beneficiaries","href":"/v1/api-reference/beneficiaries/create-a-new-beneficiary"},{"title":"Get a beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /beneficiaries/{beneficiary_id}","href":"/v1/api-reference/beneficiaries/get-a-beneficiary"},{"title":"Delete a beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json delete /beneficiaries/{beneficiary_id}","href":"/v1/api-reference/beneficiaries/delete-a-beneficiary"},{"title":"Update a beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /beneficiaries/{beneficiary_id}","href":"/v1/api-reference/beneficiaries/update-a-beneficiary"}]},{"group":"Clients","pages":[{"title":"Get clients","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /clients","href":"/v1/api-reference/clients/get-clients"}]},{"group":"Contacts","pages":[{"title":"Get contacts","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /contacts","href":"/v1/api-reference/contacts/get-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /contacts/{contact_id}","href":"/v1/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /contacts/{contact_id}","href":"/v1/api-reference/contacts/update-a-contact"}]},{"group":"Credit Conditions","pages":[{"title":"Get credit conditions limit","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /credit-conditions/limit/pad","href":"/v1/api-reference/credit-conditions/get-credit-conditions-limit"}]},{"group":"Currencies","pages":[{"title":"Retrieve a list of the client's currencies","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /currencies","href":"/v1/api-reference/currencies/retrieve-a-list-of-the-clients-currencies"}]},{"group":"Documents","pages":[{"title":"Get a document","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /documents","href":"/v1/api-reference/documents/get-a-document"}]},{"group":"Drawdowns","pages":[{"title":"Create a drawdown","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /drawdowns","href":"/v1/api-reference/drawdowns/create-a-drawdown"},{"title":"Get available drawdown margin","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /drawdowns/available_margin","href":"/v1/api-reference/drawdowns/get-available-drawdown-margin"}]},{"group":"Mass Beneficiaries","pages":[{"title":"Retrieve all mass beneficiary submissions","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-beneficiaries","href":"/v1/api-reference/mass-beneficiaries/retrieve-all-mass-beneficiary-submissions"},{"title":"Create a mass beneficiary instruction","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /mass-beneficiaries","href":"/v1/api-reference/mass-beneficiaries/create-a-mass-beneficiary-instruction"},{"title":"Retrieve a mass beneficiary submission","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-beneficiaries/{mass_beneficiary_id}","href":"/v1/api-reference/mass-beneficiaries/retrieve-a-mass-beneficiary-submission"},{"title":"Retrieve the beneficiary creation errors of a mass beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-beneficiaries/{mass_beneficiary_id}/errors","href":"/v1/api-reference/mass-beneficiaries/retrieve-the-beneficiary-creation-errors-of-a-mass-beneficiary"},{"title":"Retrieve the beneficiaries created by a mass beneficiary","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-beneficiaries/{mass_beneficiary_id}/beneficiaries","href":"/v1/api-reference/mass-beneficiaries/retrieve-the-beneficiaries-created-by-a-mass-beneficiary"}]},{"group":"Mass Payments","pages":[{"title":"Fetch mass payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-payments","href":"/v1/api-reference/mass-payments/fetch-mass-payments"},{"title":"Create a mass payment instruction","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /mass-payments","href":"/v1/api-reference/mass-payments/create-a-mass-payment-instruction"},{"title":"Confirm a mass payment instruction","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /mass-payments/{mass_payment_id}/confirm","href":"/v1/api-reference/mass-payments/confirm-a-mass-payment-instruction"},{"title":"Fetch the payment instructions with errors for a mass payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-payments/{mass_payment_id}/errors","href":"/v1/api-reference/mass-payments/fetch-the-payment-instructions-with-errors-for-a-mass-payment"},{"title":"Fetch the funding account of a mass payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-payments/{mass_payment_id}/funding-account","href":"/v1/api-reference/mass-payments/fetch-the-funding-account-of-a-mass-payment"},{"title":"Fetch the payment instructions submitted for a mass payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /mass-payments/{mass_payment_id}/payments-received","href":"/v1/api-reference/mass-payments/fetch-the-payment-instructions-submitted-for-a-mass-payment"}]},{"group":"Metadata","pages":[{"title":"Get beneficiary metadata","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /metadata/beneficiary","href":"/v1/api-reference/metadata/get-beneficiary-metadata"},{"title":"Get currency metadata","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /metadata/currency","href":"/v1/api-reference/metadata/get-currency-metadata"}]},{"group":"Multi Payments","pages":[{"title":"Create a multi payment instruction","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /multipayments","href":"/v1/api-reference/multi-payments/create-a-multi-payment-instruction"},{"title":"Rejects a multi payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json delete /multipayments/{multipayment_id}","href":"/v1/api-reference/multi-payments/rejects-a-multi-payment"},{"title":"Accept a multi payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /multipayments/{multipayment_id}","href":"/v1/api-reference/multi-payments/accept-a-multi-payment"}]},{"group":"Payments","pages":[{"title":"Search or retrieve payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /payments","href":"/v1/api-reference/payments/search-or-retrieve-payments"},{"title":"Create one or more payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /payments","href":"/v1/api-reference/payments/create-one-or-more-payments"},{"title":"Get the fee of payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /payments/fees","href":"/v1/api-reference/payments/get-the-fee-of-payments"},{"title":"Get the estimate fee of payments","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /payments/fees_estimate","href":"/v1/api-reference/payments/get-the-estimate-fee-of-payments"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /payments/{payment_id}","href":"/v1/api-reference/payments/retrieve-a-payment"},{"title":"Delete a payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json delete /payments/{payment_id}","href":"/v1/api-reference/payments/delete-a-payment"},{"title":"Authorise or reject a payment","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json patch /payments/{payment_id}","href":"/v1/api-reference/payments/authorise-or-reject-a-payment"}]},{"group":"Ping","pages":[{"title":"Test connectivity","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /ping","href":"/v1/api-reference/ping/test-connectivity"},{"title":"Test connectivity","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /ping","href":"/v1/api-reference/ping/test-connectivity-1"}]},{"group":"Quotes","pages":[{"title":"Get an estimate or firm quote","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /quotes","href":"/v1/api-reference/quotes/get-an-estimate-or-firm-quote"},{"title":"Get the availability for FX markets","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /quotes/fx-availability","href":"/v1/api-reference/quotes/get-the-availability-for-fx-markets"}]},{"group":"Statements","pages":[{"title":"List statement requests","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /statements","href":"/v1/api-reference/statements/list-statement-requests"},{"title":"Create a statement request","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements","href":"/v1/api-reference/statements/create-a-statement-request"},{"title":"Request accounts statement via email","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements/accounts","href":"/v1/api-reference/statements/request-accounts-statement-via-email"},{"title":"Request incoming funds statement via email","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements/incoming-funds","href":"/v1/api-reference/statements/request-incoming-funds-statement-via-email"},{"title":"Request MT940 statement via email","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements/mt940","href":"/v1/api-reference/statements/request-mt940-statement-via-email"},{"title":"Request trades statement via email","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /statements/trades","href":"/v1/api-reference/statements/request-trades-statement-via-email"},{"title":"Get statement details","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /statements/{statement_id}","href":"/v1/api-reference/statements/get-statement-details"}]},{"group":"TrustedAuthentication","pages":[{"title":"Token for a Contact","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /token/{contact_id}","href":"/v1/api-reference/trustedauthentication/token-for-a-contact"}]},{"group":"Trades","pages":[{"title":"Get all trades","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /trades","href":"/v1/api-reference/trades/get-all-trades"},{"title":"Create a Trade","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /trades","href":"/v1/api-reference/trades/create-a-trade"},{"title":"Get a trade","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json get /trades/{trade_id}","href":"/v1/api-reference/trades/get-a-trade"}]},{"group":"VoP","pages":[{"title":"Run a standalone Verification of Payee check for a list of beneficiaries","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /vop","href":"/v1/api-reference/vop/run-a-standalone-verification-of-payee-check-for-a-list-of-beneficiaries"}]},{"group":"Webhooks","pages":[{"title":"Execute a GraphQL query over the webhooks API","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /webhooks/graphql","href":"/v1/api-reference/webhooks/execute-a-graphql-query-over-the-webhooks-api"},{"title":"Ping a subscription","deprecated":null,"version":null,"openapi":"/openapi/ebury-api-public.json post /webhooks/ping/{subscription_id}","href":"/v1/api-reference/webhooks/ping-a-subscription"}]}]},{"group":"Data models","pages":[{"title":"Account Models","href":"/api/account-models"},{"title":"Account Details Model","href":"/api/account-details-model"},{"title":"Balance Models","description":"Reference for Ebury Balances API data models, including BalanceData, Amount, BalanceType and CreditDebitIndicator.","href":"/api/balance-models"},{"title":"Beneficiary Models","href":"/api/beneficiary-models"},{"title":"Contact Models","description":"Reference for Ebury Contacts API data models, including the Contact profile, its permissions and the ContactUpdate request body.","href":"/api/contact-models"},{"title":"Currency Models","href":"/api/currency-models"},{"title":"Mass Beneficiary Models","href":"/api/mass-beneficiary-models"},{"title":"Mass Payment Model","href":"/api/mass-payment-model"},{"title":"Multipayment models","href":"/api/multipayment-models"},{"title":"Payment Instructions Model","href":"/api/payment-instructions-model"},{"title":"Payment Models","href":"/api/payment-models"},{"title":"Statements Models","href":"/api/statements-models"},{"title":"Trade Models","href":"/api/trade-models"},{"title":"Transaction Models","href":"/api/transaction-models"},{"group":"Purpose of payment codes","pages":[{"title":"China Purpose of Payment Codes","href":"/api/resources/chn-pop-codes"},{"title":"UAE Purpose of Payment Codes","href":"/api/resources/uae-pop-codes"}]}]}]}]}]},"basePath":"","title":"Beneficiary Models - Ebury","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}