This model is a representation of a payment.Fields
string
Unique identifier for the payment (Always)
string
Unique identifier of the contact who booked the payment (Always)
string
Unique identifier of the trade the payment is allocated to (Always)
string
Unique identifier for the multi payment formatted
string
Unique identifier for the multi payment
string
Internal unique reference for the multi-payment
string
Unique identifier for the mass payment
string
Unique End-to-end Transaction Reference (UETR) used for SWIFT gpi tracking.
boolean
Boolean flag indicating if the uuid can be used for SWIFT tracking. It is true only if the payment is recent (< 124 days), valid, and uses SCHEMA_SWIFT.
string
Account number of the beneficiary
number
Payment amount
string
The identifier of the beneficiary’s bank
string
Unique identifier for the beneficiary
string
Name of the beneficiary
string
Beneficiary ID formatted
boolean
Indicates if the beneficiary account is currently active
boolean
Indicates if the beneficiary has been authorised in the system
boolean
Indicates if the beneficiary is blocked from receiving payments
boolean
Indicates if the beneficiary profile setup is complete
boolean
Indicates if the beneficiary identity/account has been verified
string
Payment instruction created date
string
Unique reference submitted by the client to identify the payment
number
Fee amount
string
Fee currency
string
The IBAN of the beneficiary’s bank account
string
Name of the contact who ordered the payment
string
Currency the payment was made in
string
Target payment date. YYYY-MM-DD format
string
URI to download payment instruction
string
URI to download payment receipt
string
Simplified representation of the payment status designed for easy consumption in client applications. See Status
object
The raw/detailed internal status used by the system to track the complete lifecycle of payments. See Internal Status
string
The SWIFT code of the beneficiary’s bank account
string
The user who authorised the payment
string
The date when payment was authorised
string
The user who rejected the payment
string
The date when payment was rejected
boolean
Boolean flag indicating if the payment has been cancelled
string
The user who cancelled the payment
string
The date when payment was cancelled
boolean
Boolean indicating if the payment is currently in a state that allows cancellation
string
The authorisation workflow of the payment. Acceptable values:
simple
4-eyes
boolean
Whether or not the payment requires an invoice
string
The payment reference
string
Charges applied to the payment
number
Numerical status code representing the AML check result
boolean
Indicates if the AML verification process has exceeded the expected timeframe
boolean
Boolean indicating if the payment has been successfully executed
boolean
Indicates if the account has sufficient funds to cover the payment
boolean
Indicates if the payment amount exceeds the trade or balance allocation
boolean
Boolean indicating if the payment was returned by the receiving bank
boolean
Indicates if the payment details have been verified
This model is a representation of a payment fee.Fields
number
Fee amount (Always)
string
Fee currency (Always)
number
Payment amount
string
Currency the payment was made in (Always)
string
The destination country of the payment (Always)
number
Payment instruction (Always)
boolean
True if payment is Ebury intra payments, False otherwise
Approvals Workflow
For clients that have NEyes Plus enabled, the payments will go through the new Approvals Workflow, which means the following fields will be populated:
Value
Description
authorisations
List of current authorisations the payment has already received. Includes the date when the payment was approved / rejected and the contact identifier and name
contact_authorisation_actions
Includes allowed actions for the current contact (approve / reject if the contact is allowed to perform those actions according to the Approvals Workflow, and cancel for the creator of the payment) and the executed action, if any
n_eyes_plus_status
Neyes Plus status of the payment
{"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":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/payment-models","slug":"/api/payment-models","pageMetadata":{"title":"Payment Models","description":"Reference for Ebury Payments API data models, including Payment, payment statuses and filters, internal status, fees and approval workflows.","href":"/api/payment-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 Payments API data models, including Payment, payment statuses and filters, internal status, fees and approval workflows.\"\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`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._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:`payment`,children:`Payment`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`73`,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:`73`,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:` \"payment_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:` \"contact_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:` \"trade_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:` \"multipayment\"`}),_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:` \"multipayment_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:` \"multipayment_unique_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:` \"mass_payment_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:` \"uuid\"`}),_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:` \"is_uuid_used_for_tracking\"`}),_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:` \"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:` \"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_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:` \"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:` \"beneficiary_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:` \"beneficiary_aml_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:` \"beneficiary_active\"`}),_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:` \"beneficiary_authorised\"`}),_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:` \"beneficiary_blocked\"`}),_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:` \"beneficiary_completed\"`}),_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:` \"beneficiary_verified\"`}),_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:` \"created_date\"`}),_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:` \"external_reference_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:` \"fee_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_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:` \"fee_currency\"`}),_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:` \"payment_currency\"`}),_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:` \"payment_date\"`}),_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:` \"payment_instruction\"`}),_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:` \"payment_receipt\"`}),_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:` \"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:` \"internal_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"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:` \"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:` \"authorised_by\"`}),_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:` \"authorised_date\"`}),_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:` \"rejected_by\"`}),_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:` \"rejected_date\"`}),_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:` \"cancelled\"`}),_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:` \"cancelled_by\"`}),_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:` \"cancelled_date\"`}),_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:` \"can_be_cancelled\"`}),_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:` \"authorisation_workflow\"`}),_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:` \"invoice_required\"`}),_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:` \"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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"charges\"`}),_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:`\"number\"`}),_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_overdue\"`}),_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:` \"executed\"`}),_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:` \"fully_funded\"`}),_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:` \"over_paid\"`}),_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:` \"returned\"`}),_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:` \"verified\"`}),_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:` \"approvals_workflow\"`}),_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:` \"authorisations\"`}),_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:` \"date\"`}),_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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_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:` \"contact_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:` \"level\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_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:` \"contact_name\"`}),_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`,_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:` \"contact_authorisation_actions\"`}),_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:` \"allowed\"`}),_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:` \"executed\"`}),_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`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"minimum_remaining_authorisations\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_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:` \"n_eyes_plus_status\"`}),_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`,_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 payment.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`payment_id`,type:`string`,id:`param-payment-id`,children:_jsx(_components.p,{children:`Unique identifier for the payment (Always)`})}),`\n`,_jsx(ResponseField,{name:`contact_id`,type:`string`,id:`param-contact-id`,children:_jsx(_components.p,{children:`Unique identifier of the contact who booked the payment (Always)`})}),`\n`,_jsx(ResponseField,{name:`trade_id`,type:`string`,id:`param-trade-id`,children:_jsx(_components.p,{children:`Unique identifier of the trade the payment is allocated to (Always)`})}),`\n`,_jsx(ResponseField,{name:`multipayment`,type:`string`,id:`param-multipayment`,children:_jsx(_components.p,{children:`Unique identifier for the multi payment formatted`})}),`\n`,_jsx(ResponseField,{name:`multipayment_id`,type:`string`,id:`param-multipayment-id`,children:_jsx(_components.p,{children:`Unique identifier for the multi payment`})}),`\n`,_jsx(ResponseField,{name:`multipayment_unique_id`,type:`string`,id:`param-multipayment-unique-id`,children:_jsx(_components.p,{children:`Internal unique reference for the multi-payment`})}),`\n`,_jsx(ResponseField,{name:`mass_payment_id`,type:`string`,id:`param-mass-payment-id`,children:_jsx(_components.p,{children:`Unique identifier for the mass payment`})}),`\n`,_jsx(ResponseField,{name:`uuid`,type:`string`,id:`param-uuid`,children:_jsx(_components.p,{children:`Unique End-to-end Transaction Reference (UETR) used for SWIFT gpi tracking.`})}),`\n`,_jsx(ResponseField,{name:`is_uuid_used_for_tracking`,type:`boolean`,id:`param-is-uuid-used-for-tracking`,children:_jsxs(_components.p,{children:[`Boolean flag indicating if the `,_jsx(_components.code,{children:`uuid`}),` can be used for SWIFT tracking. It is `,_jsx(_components.code,{children:`true`}),` only if the payment is recent (\u003c 124 days), valid, and uses `,_jsx(_components.code,{children:`SCHEMA_SWIFT`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`account_number`,type:`string`,id:`param-account-number`,children:_jsx(_components.p,{children:`Account number of the beneficiary`})}),`\n`,_jsx(ResponseField,{name:`amount`,type:`number`,id:`param-amount`,children:_jsx(_components.p,{children:`Payment amount`})}),`\n`,_jsx(ResponseField,{name:`bank_identifier`,type:`string`,id:`param-bank-identifier`,children:_jsx(_components.p,{children:`The identifier of the beneficiary’s bank`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_id`,type:`string`,id:`param-beneficiary-id`,children:_jsx(_components.p,{children:`Unique identifier for the beneficiary`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_name`,type:`string`,id:`param-beneficiary-name`,children:_jsx(_components.p,{children:`Name of the beneficiary`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_aml_id`,type:`string`,id:`param-beneficiary-aml-id`,children:_jsx(_components.p,{children:`Beneficiary ID formatted`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_active`,type:`boolean`,id:`param-beneficiary-active`,children:_jsx(_components.p,{children:`Indicates if the beneficiary account is currently active`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_authorised`,type:`boolean`,id:`param-beneficiary-authorised`,children:_jsx(_components.p,{children:`Indicates if the beneficiary has been authorised in the system`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_blocked`,type:`boolean`,id:`param-beneficiary-blocked`,children:_jsx(_components.p,{children:`Indicates if the beneficiary is blocked from receiving payments`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_completed`,type:`boolean`,id:`param-beneficiary-completed`,children:_jsx(_components.p,{children:`Indicates if the beneficiary profile setup is complete`})}),`\n`,_jsx(ResponseField,{name:`beneficiary_verified`,type:`boolean`,id:`param-beneficiary-verified`,children:_jsx(_components.p,{children:`Indicates if the beneficiary identity/account has been verified`})}),`\n`,_jsx(ResponseField,{name:`created_date`,type:`string`,id:`param-created-date`,children:_jsx(_components.p,{children:`Payment instruction created date`})}),`\n`,_jsx(ResponseField,{name:`external_reference_id`,type:`string`,id:`param-external-reference-id`,children:_jsx(_components.p,{children:`Unique reference submitted by the client to identify the payment`})}),`\n`,_jsx(ResponseField,{name:`fee_amount`,type:`number`,id:`param-fee-amount`,children:_jsx(_components.p,{children:`Fee amount`})}),`\n`,_jsx(ResponseField,{name:`fee_currency`,type:`string`,id:`param-fee-currency`,children:_jsx(_components.p,{children:`Fee currency`})}),`\n`,_jsx(ResponseField,{name:`iban`,type:`string`,id:`param-iban`,children:_jsx(_components.p,{children:`The IBAN of the beneficiary’s bank account`})}),`\n`,_jsx(ResponseField,{name:`ordered_by_name`,type:`string`,id:`param-ordered-by-name`,children:_jsx(_components.p,{children:`Name of the contact who ordered the payment`})}),`\n`,_jsx(ResponseField,{name:`payment_currency`,type:`string`,id:`param-payment-currency`,children:_jsx(_components.p,{children:`Currency the payment was made in`})}),`\n`,_jsx(ResponseField,{name:`payment_date`,type:`string`,id:`param-payment-date`,children:_jsx(_components.p,{children:`Target payment date. YYYY-MM-DD format`})}),`\n`,_jsx(ResponseField,{name:`payment_instruction`,type:`string`,id:`param-payment-instruction`,children:_jsx(_components.p,{children:`URI to download payment instruction`})}),`\n`,_jsx(ResponseField,{name:`payment_receipt`,type:`string`,id:`param-payment-receipt`,children:_jsx(_components.p,{children:`URI to download payment receipt`})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`Simplified representation of the payment status designed for easy consumption in client applications. See `,_jsx(_components.a,{href:`#status`,children:`Status`})]})}),`\n`,_jsx(ResponseField,{name:`internal_status`,type:`object`,id:`param-internal-status`,children:_jsxs(_components.p,{children:[`The raw/detailed internal status used by the system to track the complete lifecycle of payments. See `,_jsx(_components.a,{href:`#internal-status`,children:`Internal Status`})]})}),`\n`,_jsx(ResponseField,{name:`swift_code`,type:`string`,id:`param-swift-code`,children:_jsx(_components.p,{children:`The SWIFT code of the beneficiary’s bank account`})}),`\n`,_jsx(ResponseField,{name:`authorised_by`,type:`string`,id:`param-authorised-by`,children:_jsx(_components.p,{children:`The user who authorised the payment`})}),`\n`,_jsx(ResponseField,{name:`authorised_date`,type:`string`,id:`param-authorised-date`,children:_jsx(_components.p,{children:`The date when payment was authorised`})}),`\n`,_jsx(ResponseField,{name:`rejected_by`,type:`string`,id:`param-rejected-by`,children:_jsx(_components.p,{children:`The user who rejected the payment`})}),`\n`,_jsx(ResponseField,{name:`rejected_date`,type:`string`,id:`param-rejected-date`,children:_jsx(_components.p,{children:`The date when payment was rejected`})}),`\n`,_jsx(ResponseField,{name:`cancelled`,type:`boolean`,id:`param-cancelled`,children:_jsx(_components.p,{children:`Boolean flag indicating if the payment has been cancelled`})}),`\n`,_jsx(ResponseField,{name:`cancelled_by`,type:`string`,id:`param-cancelled-by`,children:_jsx(_components.p,{children:`The user who cancelled the payment`})}),`\n`,_jsx(ResponseField,{name:`cancelled_date`,type:`string`,id:`param-cancelled-date`,children:_jsx(_components.p,{children:`The date when payment was cancelled`})}),`\n`,_jsx(ResponseField,{name:`can_be_cancelled`,type:`boolean`,id:`param-can-be-cancelled`,children:_jsx(_components.p,{children:`Boolean indicating if the payment is currently in a state that allows cancellation`})}),`\n`,_jsxs(ResponseField,{name:`authorisation_workflow`,type:`string`,id:`param-authorisation-workflow`,children:[_jsx(_components.p,{children:`The authorisation workflow of the payment. Acceptable values:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`simple`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`4-eyes`})}),`\n`]})]}),`\n`,_jsx(ResponseField,{name:`invoice_required`,type:`boolean`,id:`param-invoice-required`,children:_jsx(_components.p,{children:`Whether or not the payment requires an invoice`})}),`\n`,_jsx(ResponseField,{name:`reference`,type:`string`,id:`param-reference`,children:_jsx(_components.p,{children:`The payment reference`})}),`\n`,_jsx(ResponseField,{name:`charges`,type:`string`,id:`param-charges`,children:_jsx(_components.p,{children:`Charges applied to the payment`})}),`\n`,_jsx(ResponseField,{name:`AML_status`,type:`number`,id:`param-aml-status`,children:_jsx(_components.p,{children:`Numerical status code representing the AML check result`})}),`\n`,_jsx(ResponseField,{name:`AML_overdue`,type:`boolean`,id:`param-aml-overdue`,children:_jsx(_components.p,{children:`Indicates if the AML verification process has exceeded the expected timeframe`})}),`\n`,_jsx(ResponseField,{name:`executed`,type:`boolean`,id:`param-executed`,children:_jsx(_components.p,{children:`Boolean indicating if the payment has been successfully executed`})}),`\n`,_jsx(ResponseField,{name:`fully_funded`,type:`boolean`,id:`param-fully-funded`,children:_jsx(_components.p,{children:`Indicates if the account has sufficient funds to cover the payment`})}),`\n`,_jsx(ResponseField,{name:`over_paid`,type:`boolean`,id:`param-over-paid`,children:_jsx(_components.p,{children:`Indicates if the payment amount exceeds the trade or balance allocation`})}),`\n`,_jsx(ResponseField,{name:`returned`,type:`boolean`,id:`param-returned`,children:_jsx(_components.p,{children:`Boolean indicating if the payment was returned by the receiving bank`})}),`\n`,_jsx(ResponseField,{name:`verified`,type:`boolean`,id:`param-verified`,children:_jsx(_components.p,{children:`Indicates if the payment details have been verified`})}),`\n`,_jsx(ResponseField,{name:`approvals_workflow`,type:`object`,id:`param-approvals-workflow`,children:_jsxs(_components.p,{children:[`New approvals workflow related fields. See `,_jsx(_components.a,{href:`#approvals-workflow`,children:`Approvals Workflow`})]})}),`\n`,_jsx(Heading,{level:`2`,id:`status`,children:`Status`}),`\n`,_jsx(_components.p,{children:`A simplified representation of the payment status designed for easy consumption in client applications.`}),`\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:`Need more beneficiary information`})}),_jsx(_components.td,{children:`Beneficiary information is not complete, more details are required.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Validating beneficiary information`})}),_jsx(_components.td,{children:`Beneficiary information is complete, but not validated yet.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Waiting for payment date`})}),_jsx(_components.td,{children:`Payment is ready to be executed, waiting for payment execution date.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Payment complete`})}),_jsx(_components.td,{children:`Payment has been executed.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Executing Payment`})}),_jsx(_components.td,{children:`Payment is in the process of being executed.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Payment pending of authorization`})}),_jsx(_components.td,{children:`Payment has been verified but not authorised.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Payment rejected`})}),_jsx(_components.td,{children:`Payment has been rejected.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Payment cancelled`})}),_jsx(_components.td,{children:`Payment has been cancelled.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`payment-status-filter`,children:`Payment Status Filter`}),`\n`,_jsxs(_components.p,{children:[`Valid values for the `,_jsx(_components.code,{children:`status`}),` query parameter when filtering payments.`]}),`\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:`pending`})}),_jsx(_components.td,{children:`Payments not yet executed (excludes completed, rejected, and cancelled).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pending_to_authorise`})}),_jsx(_components.td,{children:`Payments awaiting authorisation.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`authorised`})}),_jsx(_components.td,{children:`Payments that have been authorised.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`cancelled`})}),_jsx(_components.td,{children:`Payments that have been cancelled.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`rejected`})}),_jsx(_components.td,{children:`Payments that have been rejected.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`complete`})}),_jsx(_components.td,{children:`Payments that have been fully executed.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pending_your_approval`})}),_jsx(_components.td,{children:`(N-Eyes Plus) Payments awaiting approval from the current contact.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pending_others_approval`})}),_jsx(_components.td,{children:`(N-Eyes Plus) Payments awaiting approval from other contacts.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`internal-status`,children:`Internal Status`}),`\n`,_jsx(_components.p,{children:`The raw/detailed internal status used by the system to track the complete lifecycle of payments.`}),`\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:`Status`}),_jsx(_components.th,{children:`CODE`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`START`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`0`}),_jsx(_components.td,{children:`Initial state`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`CREATED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`1`}),_jsx(_components.td,{children:`Payment created`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`PENDING_OF_AUTHORIZATION`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`2`}),_jsx(_components.td,{children:`Awaiting authorization`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`AUTHORISED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`3`}),_jsx(_components.td,{children:`Payment authorized`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`REJECTED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`4`}),_jsx(_components.td,{children:`Payment rejected`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`CANCELLED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`5`}),_jsx(_components.td,{children:`Payment cancelled`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`DELIVERED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`6`}),_jsx(_components.td,{children:`Payment delivered`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`DISCARDED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`7`}),_jsx(_components.td,{children:`Payment discarded`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`QUERIED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`8`}),_jsx(_components.td,{children:`Payment queried`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`AMENDED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`9`}),_jsx(_components.td,{children:`Payment amended`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`MESSAGED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`10`}),_jsx(_components.td,{children:`Message sent`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`ABORTED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`11`}),_jsx(_components.td,{children:`Process aborted`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`RECONCILED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`12`}),_jsx(_components.td,{children:`Payment reconciled`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`PENDING_RETURN`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`13`}),_jsx(_components.td,{children:`Awaiting return`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`RETURNED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`14`}),_jsx(_components.td,{children:`Payment returned`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`INVALIDATED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`15`}),_jsx(_components.td,{children:`Payment invalidated`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`CLOSED`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`16`}),_jsx(_components.td,{children:`Payment closed`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`payment-fee`,children:`Payment Fee`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,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:`9`,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:` \"fee_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_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:` \"fee_currency\"`}),_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:` \"payment_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"payment_country\"`}),_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:` \"payment_currency\"`}),_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:` \"payment_instruction\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"payment_is_intra\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"boolean\"`})]}),`\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 payment fee.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Fields`})}),`\n`,_jsx(ResponseField,{name:`fee_amount`,type:`number`,id:`param-fee-amount-1`,children:_jsx(_components.p,{children:`Fee amount (Always)`})}),`\n`,_jsx(ResponseField,{name:`fee_currency`,type:`string`,id:`param-fee-currency-1`,children:_jsx(_components.p,{children:`Fee currency (Always)`})}),`\n`,_jsx(ResponseField,{name:`payment_amount`,type:`number`,id:`param-payment-amount`,children:_jsx(_components.p,{children:`Payment amount`})}),`\n`,_jsx(ResponseField,{name:`payment_currency`,type:`string`,id:`param-payment-currency-1`,children:_jsx(_components.p,{children:`Currency the payment was made in (Always)`})}),`\n`,_jsx(ResponseField,{name:`payment_country`,type:`string`,id:`param-payment-country`,children:_jsx(_components.p,{children:`The destination country of the payment (Always)`})}),`\n`,_jsx(ResponseField,{name:`payment_instruction`,type:`number`,id:`param-payment-instruction-1`,children:_jsx(_components.p,{children:`Payment instruction (Always)`})}),`\n`,_jsx(ResponseField,{name:`payment_is_intra`,type:`boolean`,id:`param-payment-is-intra`,children:_jsx(_components.p,{children:`True if payment is Ebury intra payments, False otherwise`})}),`\n`,_jsx(Heading,{level:`2`,id:`approvals-workflow`,children:`Approvals Workflow`}),`\n`,_jsx(_components.p,{children:`For clients that have NEyes Plus enabled, the payments will go through the new Approvals Workflow, which means the following fields will be populated:`}),`\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:`authorisations`})}),_jsx(_components.td,{children:`List of current authorisations the payment has already received. Includes the date when the payment was approved / rejected and the contact identifier and name`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`contact_authorisation_actions`})}),_jsxs(_components.td,{children:[`Includes `,_jsx(_components.code,{children:`allowed`}),` actions for the current contact (`,_jsx(_components.code,{children:`approve`}),` / `,_jsx(_components.code,{children:`reject`}),` if the contact is allowed to perform those actions according to the Approvals Workflow, and `,_jsx(_components.code,{children:`cancel`}),` for the creator of the payment) and the `,_jsx(_components.code,{children:`executed`}),` action, if any`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`n_eyes_plus_status`})}),_jsx(_components.td,{children:`Neyes Plus status of the payment`})]})]})]})]})}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":"Payment Models","description":"Reference for Ebury Payments API data models, including Payment, payment statuses and filters, internal status, fees and approval workflows.","href":"/api/payment-models"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Payment","slug":"payment","depth":2,"children":[]},{"title":"Status","slug":"status","depth":2,"children":[]},{"title":"Payment Status Filter","slug":"payment-status-filter","depth":2,"children":[]},{"title":"Internal Status","slug":"internal-status","depth":2,"children":[]},{"title":"Payment Fee","slug":"payment-fee","depth":2,"children":[]},{"title":"Approvals Workflow","slug":"approvals-workflow","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ebury/0f25bc0ed81b3628/statsig.js","/_mintlify/custom/ebury/05cc4dab1f4ee49a/legacy-anchors.js"],"subdomain":"ebury","siteName":"Ebury","title":"Payment Models - Ebury","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api/payment-models","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T09:16:26.683Z","originalFileLocation":"api/payment-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 Payments API data models, including Payment, payment statuses and filters, internal status, fees and approval workflows.\">\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=\"Payment Models - Ebury\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference for Ebury Payments API data models, including Payment, payment statuses and filters, internal status, fees and approval workflows.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ebury\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ebury.com/api/payment-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=Payment+Models\u0026amp;description=Reference+for+Ebury+Payments+API+data+models%2C+including+Payment%2C+payment+statuses+and+filters%2C+internal+status%2C+fees+and+approval+workflows.\u0026amp;theme=82f2409686991e5640c22941\u0026amp;signature=6790d0eb496a84d2d22230c70913454a18bccb5dd2d79114e1c680f28e2c31c2\">\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=\"Payment Models - Ebury\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference for Ebury Payments API data models, including Payment, payment statuses and filters, internal status, fees and approval workflows.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ebury.mintlify.site/_mintlify/api/og/v2?division=Data+models\u0026amp;title=Payment+Models\u0026amp;description=Reference+for+Ebury+Payments+API+data+models%2C+including+Payment%2C+payment+statuses+and+filters%2C+internal+status%2C+fees+and+approval+workflows.\u0026amp;theme=82f2409686991e5640c22941\u0026amp;signature=6790d0eb496a84d2d22230c70913454a18bccb5dd2d79114e1c680f28e2c31c2\">\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/payment-models\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/payment-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/payment-models#webpage\",\"url\":\"https://docs.ebury.com/api/payment-models\",\"name\":\"Payment Models\",\"description\":\"Reference for Ebury Payments API data models, including Payment, payment statuses and filters, internal status, fees and approval workflows.\",\"dateModified\":\"2026-11-16T09:16:26.683Z\",\"isPartOf\":{\"@id\":\"https://docs.ebury.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ebury.com/api/payment-models#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ebury.com/api/payment-models#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data models\",\"item\":\"https://docs.ebury.com/api/account-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payment Models\",\"item\":\"https://docs.ebury.com/api/payment-models\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.ebury.com/api/payment-models#article\",\"headline\":\"Payment Models\",\"name\":\"Payment Models\",\"description\":\"Reference for Ebury Payments API data models, including Payment, payment statuses and filters, internal status, fees and approval workflows.\",\"url\":\"https://docs.ebury.com/api/payment-models\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ebury.com/api/payment-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/payment-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","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","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","description":"Reference for the Ebury payment instruction model, listing the beneficiary, bank and payment fields required to submit a payment.","href":"/api/payment-instructions-model"},{"title":"Payment Models","href":"/api/payment-models"},{"title":"Statements Models","description":"Reference for Ebury Statements API data models, including supported formats, statement status and requests to email account, trade and MT940 statements.","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":"Payment Models - Ebury","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}