The mass_payment_status values of the mass payment instruction.Values
Value
Description
queued for processing
The mass payment submission request has been received by Ebury and it has been queued for payment instruction, validation and beneficiary creation.
processing
The mass payment request is being processed. PaymentsSummaryTypes will have value=0 because the mass payment instruction validation and beneficiary creation is not yet complete.
processed
The payment has been processed. PaymentsSummaryTypes will now contain values (except for payments_created and trade_created which will have value=0) because the payment has not yet reached “created”.
queued for creating
The mass payment submission request has been received by Ebury and it has been queued for payment instruction validation and beneficiary creation.
creating
The mass payment has been picked up from the queue and it has been submitted for trade and payment creation. PaymentsSummaryTypes will now contain values (except for payments_created and trade_created which will have value=0) because the payment has not yet reached “created”.
created
The payment and trade have been created. PaymentsSummaryTypes will now contain relevant values as the process is now complete. Also PaymentsSummeryLinks object will contain a new property funding_account_href.
PaymentsSummary Types
This is an enumeration of PaymentsSummary types.Fields
number
Total count of received payments
number
Total count of processed payments
number
Total count of errored payments
number
Total count of created payments
PaymentsSummary Links
This is an enumeration of PaymentsSummary Links. Each link helps the user agent to fetch resources related to payment errors, payments created successfully, trade and funding accounts associated with the mass payment id. The mass_payment_id does not need to be stored as the said resources may be accessed with the provided links.Fields
** Following URL response will return back data when mass_payment_status is “processed” and includes errors.* Following URL response will return back data when mass_payment_status is “created”.
{"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/mass-payment-model","slug":"/api/mass-payment-model","pageMetadata":{"title":"Mass Payment Model","description":"Reference for the Ebury mass payment model, including mass payment status, payments summary types and summary links.","href":"/api/mass-payment-model"},"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 the Ebury mass payment model, including mass payment status, payments summary types and summary links.\"\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`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,OptimizedImage,ResponseField,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This model is a representation of a mass payment.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`mass_payment_id`,type:`string`,id:`param-mass-payment-id`,children:_jsx(_components.p,{children:`Unique UUID of the mass payment.`})}),`\n`,_jsx(ResponseField,{name:`external_reference_id`,type:`string`,id:`param-external-reference-id`,children:_jsx(_components.p,{children:`Unique ID of the external reference submitted by the client.`})}),`\n`,_jsx(ResponseField,{name:`error`,type:`object`,id:`param-error`,children:_jsxs(_components.p,{children:[`The generic `,_jsx(_components.a,{href:`/api/getting-started#error-handling`,children:`error message`}),` for the mass payment request, if any.`]})}),`\n`,_jsx(ResponseField,{name:`mass_payment_status`,type:`string`,id:`param-mass-payment-status`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.a,{href:`#masspaymentstatus`,children:`MassPaymentStatus`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`sell_currency`,type:`string`,id:`param-sell-currency`,children:_jsx(_components.p,{children:`The sell currency of the mass payment.`})}),`\n`,_jsx(ResponseField,{name:`trades_created`,type:`number`,id:`param-trades-created`,children:_jsx(_components.p,{children:`Total number of created trades.`})}),`\n`,_jsx(ResponseField,{name:`payments_summary`,type:`object`,id:`param-payments-summary`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.a,{href:`#paymentssummary-types`,children:`PaymentsSummaryTypes`})]})}),`\n`,_jsx(ResponseField,{name:`links`,type:`object`,id:`param-links`,children:_jsxs(_components.p,{children:[`Links to the `,_jsx(_components.a,{href:`#paymentssummary-links`,children:`PaymentsSummaryLinks`})]})}),`\n`,_jsx(Heading,{level:`2`,id:`masspaymentstatus`,children:`MassPaymentStatus`}),`\n`,_jsx(_components.p,{children:`The mass_payment_status values of the mass payment instruction.`}),`\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:`queued for processing`})}),_jsx(_components.td,{children:`The mass payment submission request has been received by Ebury and it has been queued for payment instruction, validation and beneficiary creation.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`processing`})}),_jsxs(_components.td,{children:[`The mass payment request is being processed. `,_jsx(_components.a,{href:`#paymentssummary-types`,children:`PaymentsSummaryTypes`}),` will have value=0 because the mass payment instruction validation and beneficiary creation is not yet complete.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`processed`})}),_jsxs(_components.td,{children:[`The payment has been processed. `,_jsx(_components.a,{href:`#paymentssummary-types`,children:`PaymentsSummaryTypes`}),` will now contain values (except for payments_created and trade_created which will have value=0) because the payment has not yet reached “created”.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`queued for creating`})}),_jsx(_components.td,{children:`The mass payment submission request has been received by Ebury and it has been queued for payment instruction validation and beneficiary creation.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`creating`})}),_jsxs(_components.td,{children:[`The mass payment has been picked up from the queue and it has been submitted for trade and payment creation. `,_jsx(_components.a,{href:`#paymentssummary-types`,children:`PaymentsSummaryTypes`}),` will now contain values (except for payments_created and trade_created which will have value=0) because the payment has not yet reached “created”.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`created`})}),_jsxs(_components.td,{children:[`The payment and trade have been created. `,_jsx(_components.a,{href:`#paymentssummary-types`,children:`PaymentsSummaryTypes`}),` will now contain relevant values as the process is now complete. Also PaymentsSummeryLinks object will contain a new property funding_account_href.`]})]})]})]}),`\n`,_jsx(OptimizedImage,{src:`https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/images/MassPayment_Flow.png?fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=8eb0d9c1c9b4fd3aff7eeed6c8cbc0b4`,style:{display:`block`,margin:`0 auto`},\"data-og-width\":`831`,width:`831`,\"data-og-height\":`201`,height:`201`,\"data-path\":`images/MassPayment_Flow.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/images/MassPayment_Flow.png?w=280\u0026fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=8716d2a81b9f99173593fbcc1f3f5973 280w, https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/images/MassPayment_Flow.png?w=560\u0026fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=b142a59a39cc1b0ad81779d5fcea3de8 560w, https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/images/MassPayment_Flow.png?w=840\u0026fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=80f28bc072084dd469e2c78bf08cde34 840w, https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/images/MassPayment_Flow.png?w=1100\u0026fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=0095764d1883f146116493b4f86a9d8a 1100w, https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/images/MassPayment_Flow.png?w=1650\u0026fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=2f19a947d1deb286e535a9e9fff02215 1650w, https://mintcdn.com/ebury/hyecsfNgRYJYRIcg/images/MassPayment_Flow.png?w=2500\u0026fit=max\u0026auto=format\u0026n=hyecsfNgRYJYRIcg\u0026q=85\u0026s=0080032c94a6ef0a2b9c7c84e27acdf5 2500w`}),`\n`,_jsx(Heading,{level:`2`,id:`paymentssummary-types`,children:`PaymentsSummary Types`}),`\n`,_jsx(_components.p,{children:`This is an enumeration of PaymentsSummary types.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`payments_received`,type:`number`,id:`param-payments-received`,children:_jsx(_components.p,{children:`Total count of received payments`})}),`\n`,_jsx(ResponseField,{name:`payments_processed`,type:`number`,id:`param-payments-processed`,children:_jsx(_components.p,{children:`Total count of processed payments`})}),`\n`,_jsx(ResponseField,{name:`payments_errored`,type:`number`,id:`param-payments-errored`,children:_jsx(_components.p,{children:`Total count of errored payments`})}),`\n`,_jsx(ResponseField,{name:`payments_created`,type:`number`,id:`param-payments-created`,children:_jsx(_components.p,{children:`Total count of created payments`})}),`\n`,_jsx(Heading,{level:`2`,id:`paymentssummary-links`,children:`PaymentsSummary Links`}),`\n`,_jsx(_components.p,{children:`This is an enumeration of PaymentsSummary Links. Each link helps the user agent to fetch resources related to payment errors, payments created successfully, trade and funding accounts associated with the mass payment id. The mass_payment_id does not need to be stored as the said resources may be accessed with the provided links.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`payments_errored_href`,type:`string`,id:`param-payments-errored-href`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`/mass-payments/$mass_payment_id/errors`}),` **`]})}),`\n`,_jsx(ResponseField,{name:`payments_created_href`,type:`string`,id:`param-payments-created-href`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`/payments?mass_payment_id=$mass_payment_id`}),` *`]})}),`\n`,_jsx(ResponseField,{name:`trades_href`,type:`string`,id:`param-trades-href`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`/trades?client_id=$client_id\u0026mass_payment_id=$mass_payment_id`}),` *`]})}),`\n`,_jsx(ResponseField,{name:`funding_account_href`,type:`string`,id:`param-funding-account-href`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`/mass-payments/$mass_payment_id/funding_account`}),` *`]})}),`\n`,_jsx(_components.p,{children:`** Following URL response will return back data when mass_payment_status is “processed” and includes errors.`}),`\n`,_jsx(_components.p,{children:`* Following URL response will return back data when mass_payment_status is “created”.`})]})}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":"Mass Payment Model","description":"Reference for the Ebury mass payment model, including mass payment status, payments summary types and summary links.","href":"/api/mass-payment-model"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"MassPaymentStatus","slug":"masspaymentstatus","depth":2,"children":[]},{"title":"PaymentsSummary Types","slug":"paymentssummary-types","depth":2,"children":[]},{"title":"PaymentsSummary Links","slug":"paymentssummary-links","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ebury/0f25bc0ed81b3628/statsig.js","/_mintlify/custom/ebury/05cc4dab1f4ee49a/legacy-anchors.js"],"subdomain":"ebury","siteName":"Ebury","title":"Mass Payment Model - Ebury","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api/mass-payment-model","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T09:16:26.683Z","originalFileLocation":"api/mass-payment-model.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 the Ebury mass payment model, including mass payment status, payments summary types and summary links.\">\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=\"Mass Payment Model - Ebury\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference for the Ebury mass payment model, including mass payment status, payments summary types and summary links.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ebury\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ebury.com/api/mass-payment-model\">\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=Mass+Payment+Model\u0026amp;description=Reference+for+the+Ebury+mass+payment+model%2C+including+mass+payment+status%2C+payments+summary+types+and+summary+links.\u0026amp;theme=82f2409686991e5640c22941\u0026amp;signature=5999754491690230a37d3ebc00038f19631b01e015760e3ed3e4fe5eb61db5e1\">\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=\"Mass Payment Model - Ebury\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference for the Ebury mass payment model, including mass payment status, payments summary types and summary links.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ebury.mintlify.site/_mintlify/api/og/v2?division=Data+models\u0026amp;title=Mass+Payment+Model\u0026amp;description=Reference+for+the+Ebury+mass+payment+model%2C+including+mass+payment+status%2C+payments+summary+types+and+summary+links.\u0026amp;theme=82f2409686991e5640c22941\u0026amp;signature=5999754491690230a37d3ebc00038f19631b01e015760e3ed3e4fe5eb61db5e1\">\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/mass-payment-model\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/mass-payment-model.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/mass-payment-model#webpage\",\"url\":\"https://docs.ebury.com/api/mass-payment-model\",\"name\":\"Mass Payment Model\",\"description\":\"Reference for the Ebury mass payment model, including mass payment status, payments summary types and summary links.\",\"dateModified\":\"2026-11-16T09:16:26.683Z\",\"isPartOf\":{\"@id\":\"https://docs.ebury.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ebury.com/api/mass-payment-model#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ebury.com/api/mass-payment-model#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data models\",\"item\":\"https://docs.ebury.com/api/account-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Mass Payment Model\",\"item\":\"https://docs.ebury.com/api/mass-payment-model\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.ebury.com/api/mass-payment-model#article\",\"headline\":\"Mass Payment Model\",\"name\":\"Mass Payment Model\",\"description\":\"Reference for the Ebury mass payment model, including mass payment status, payments summary types and summary links.\",\"url\":\"https://docs.ebury.com/api/mass-payment-model\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ebury.com/api/mass-payment-model#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/mass-payment-model.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","href":"/api/balance-models"},{"title":"Beneficiary Models","href":"/api/beneficiary-models"},{"title":"Contact Models","href":"/api/contact-models"},{"title":"Currency Models","href":"/api/currency-models"},{"title":"Mass Beneficiary Models","description":"Reference for Ebury mass beneficiary data models, including MassBeneficiary status, summary, links and beneficiary creation results and errors.","href":"/api/mass-beneficiary-models"},{"title":"Mass Payment Model","href":"/api/mass-payment-model"},{"title":"Multipayment models","description":"Reference for the Ebury NewMultiPaymentItem model, listing the fields for each payment instruction submitted in a multipayment.","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":"Mass Payment Model - Ebury","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-CkI5al_8.js","lightbox-handle-r17bVUz3.js"]}