Creating a beneficiary involves a multi-step process to ensure data accuracy and compliance. The flow varies depending on the payout method (Bank Transfer, Cash Pickup, or Mobile Money) but the core process is the same.
Payment Type Configuration: The available payout methods and their specific configuration are managed at the admin level by the principal firm. This is out of scope for the client integration but determines which options are available for your customers.
Bank Transfer
Cash Pickup
Mobile Money
Bank Transfer Flow
For Bank Transfers, the process involves validating the bank account details before creating the beneficiary profile and linking the account.
Step 1: List Supported Banks
First, retrieve the list of supported banks for the destination country.
List Banks
View list of supported beneficiary banks
Step 2: Get Required Fields
Different countries and banks require different fields (e.g., IBAN vs. Account Number + Sort Code). Fetch the dynamic requirements for the selected country.
Required Bank Fields
View required bank fields
Step 3: Get Dynamic Forms (Optional)
Some corridors require additional sender information when creating a beneficiary. Check for any dynamic fields group REGISTERED_CUSTOMER_CREATE_BENE.
Dynamic Fields
View dynamic fields
Step 4: Validate Bank Account
Before creation, validate the bank account details. This ensures the account exists and matches the beneficiary name (where supported).
Validate Bank Account
View validate bank account endpoint
Response:
If validation is supported and successful, the response will contain the accountName which should be used to pre-fill the beneficiary name.
Step 5: Create Beneficiary
Create the beneficiary profile using the validated details.
Create Beneficiary
Create beneficiary endpoint
Step 6: Add Bank Details
Finally, link the validated bank account to the newly created beneficiary. This can be done immediately after creation or at a later time.
Add Bank Details
Add bank details endpoint
Cash Pickup Flow
For Cash Pickup, no bank account is required. The beneficiary is identified by their name and phone number only.
Step 1: Validate Phone (Optional)
If supported for the corridor and the payout partner, validate the phone number using the validation endpoint (similar to bank account validation but for phone).
Validate Mobile Number
View validate mobile number endpoint
Step 2: Create Beneficiary
Create the beneficiary profile. Ensure the phone field is populated as it is compulsory for Cash Pickup.
Create Beneficiary
Create beneficiary endpoint
Note: Do not call “Add Bank Details” for Cash Pickup beneficiaries.
Mobile Money Flow
Mobile Money transfers require validating the mobile number with the specific operator(if supported/activated) before creation.
Step 1: List Mobile Operators
Retrieve the list of supported mobile money operators for the destination country.
List Mobile Operators
View supported mobile operators
Step 2: Validate Mobile Number
Validate the mobile number and operator code. This checks if the number is active and registered.
Validate Mobile Number
Use transactionType: MOBILE_MONEY and mobileOperatorCode
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FinCode Platform","colors":{"primary":"#734CDC","light":"#734CDC","dark":"#79359F"},"logo":{"light":"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d","dark":"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d","href":"https://docs.fincode.technology"},"favicon":"https://mintcdn.com/fincode/ryDAHkGMzsGXiEgb/favicon.svg?fit=max\u0026auto=format\u0026n=ryDAHkGMzsGXiEgb\u0026q=85\u0026s=bc4af5ca2aa38e3d5a719288084c0e4e","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Contact Sales","href":"https://fincode.co.uk/contact-us/"}},"footer":{"socials":{"github":"https://github.com/fincodeuk","linkedin":"https://linkedin.com/company/fincodeUk","twitter":"https://twitter.com/fincodehq"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fincode","hasAudioNarration":false,"actualSubdomain":"fincode","customDomains":["docs.fincode.technology"],"gitSource":{"type":"github","owner":"trillionclues-fincode","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af6ff7d565e709b752983ff","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":152},{"language":"default","tag":"Customer Identity \u0026 Access Management","count":59},{"language":"default","tag":"Lending","count":37},{"language":"default","tag":"Remittance","count":26},{"language":"default","tag":"Getting Started","count":17},{"language":"default","tag":"Deposit Engine","count":15},{"language":"default","tag":"Core Flows","count":14},{"language":"default","tag":"Ledger Engine","count":12},{"language":"default","tag":"Songhai Exchange (Payment Switch)","count":12},{"language":"default","tag":"Savings \u0026 Investment","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"remittance/beneficiary-lifecycle","slug":"/remittance/beneficiary-lifecycle","pageMetadata":{"title":"Beneficiary Lifecycle","icon":"user-plus","description":null,"href":"/remittance/beneficiary-lifecycle"},"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={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{Card,CodeBlock,Heading,Note,Tab,Tabs}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Creating a beneficiary involves a multi-step process to ensure data accuracy and compliance. The flow varies depending on the payout method (Bank Transfer, Cash Pickup, or Mobile Money) but the core process is the same.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Payment Type Configuration`}),`: The available payout methods and their specific configuration are managed at the admin level by the principal firm. This is out of scope for the client integration but determines which options are available for your customers.`]})}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Bank Transfer`,id:`bank-transfer`,\"data-child-heading-ids\":`[\"bank-transfer-flow\",\"step-1%3A-list-supported-banks\",\"step-2%3A-get-required-fields\",\"step-3%3A-get-dynamic-forms-optional\",\"step-4%3A-validate-bank-account\",\"step-5%3A-create-beneficiary\",\"step-6%3A-add-bank-details\"]`,children:[_jsx(Heading,{level:`3`,id:`bank-transfer-flow`,children:`Bank Transfer Flow`}),_jsx(_components.p,{children:`For Bank Transfers, the process involves validating the bank account details before creating the beneficiary profile and linking the account.`}),_jsx(Heading,{level:`4`,id:`step-1-list-supported-banks`,children:`Step 1: List Supported Banks`}),_jsx(_components.p,{children:`First, retrieve the list of supported banks for the destination country.`}),_jsx(Card,{title:`List Banks`,href:`/api/transactions/list-supported-banks`,children:_jsx(_components.p,{children:`View list of supported beneficiary banks`})}),_jsx(Heading,{level:`4`,id:`step-2-get-required-fields`,children:`Step 2: Get Required Fields`}),_jsx(_components.p,{children:`Different countries and banks require different fields (e.g., IBAN vs. Account Number + Sort Code). Fetch the dynamic requirements for the selected country.`}),_jsx(Card,{title:`Required Bank Fields`,href:`/api/transactions/required-bank-fields`,children:_jsx(_components.p,{children:`View required bank fields`})}),_jsx(Heading,{level:`4`,id:`step-3-get-dynamic-forms-optional`,children:`Step 3: Get Dynamic Forms (Optional)`}),_jsxs(_components.p,{children:[`Some corridors require additional sender information when creating a beneficiary. Check for any dynamic fields group `,_jsx(_components.code,{children:`REGISTERED_CUSTOMER_CREATE_BENE`}),`.`]}),_jsx(Card,{title:`Dynamic Fields`,href:`/api/compliance/dynamic-fields`,children:_jsx(_components.p,{children:`View dynamic fields`})}),_jsx(Heading,{level:`4`,id:`step-4-validate-bank-account`,children:`Step 4: Validate Bank Account`}),_jsx(_components.p,{children:`Before creation, validate the bank account details. This ensures the account exists and matches the beneficiary name (where supported).`}),_jsx(Card,{title:`Validate Bank Account`,href:`/api/transactions/validate-account`,children:_jsx(_components.p,{children:`View validate bank account endpoint`})}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Response:`}),`\nIf validation is supported and successful, the response will contain the `,_jsx(_components.code,{children:`accountName`}),` which should be used to pre-fill the beneficiary name.`]}),_jsx(Heading,{level:`4`,id:`step-5-create-beneficiary`,children:`Step 5: Create Beneficiary`}),_jsx(_components.p,{children:`Create the beneficiary profile using the validated details.`}),_jsx(Card,{title:`Create Beneficiary`,href:`/api/transactions/create-beneficiary`,children:_jsx(_components.p,{children:`Create beneficiary endpoint`})}),_jsx(Heading,{level:`4`,id:`step-6-add-bank-details`,children:`Step 6: Add Bank Details`}),_jsx(_components.p,{children:`Finally, link the validated bank account to the newly created beneficiary. This can be done immediately after creation or at a later time.`}),_jsx(Card,{title:`Add Bank Details`,href:`/api/transactions/add-bank-details`,children:_jsx(_components.p,{children:`Add bank details endpoint`})})]}),_jsxs(Tab,{title:`Cash Pickup`,id:`cash-pickup`,\"data-child-heading-ids\":`[\"cash-pickup-flow\",\"step-1%3A-validate-phone-optional\",\"step-2%3A-create-beneficiary\"]`,children:[_jsx(Heading,{level:`3`,id:`cash-pickup-flow`,children:`Cash Pickup Flow`}),_jsx(_components.p,{children:`For Cash Pickup, no bank account is required. The beneficiary is identified by their name and phone number only.`}),_jsx(Heading,{level:`4`,id:`step-1-validate-phone-optional`,children:`Step 1: Validate Phone (Optional)`}),_jsx(_components.p,{children:`If supported for the corridor and the payout partner, validate the phone number using the validation endpoint (similar to bank account validation but for phone).`}),_jsx(Card,{title:`Validate Mobile Number`,href:`/api/transactions/validate-account`,children:_jsx(_components.p,{children:`View validate mobile number endpoint`})}),_jsx(Heading,{level:`4`,id:`step-2-create-beneficiary`,children:`Step 2: Create Beneficiary`}),_jsxs(_components.p,{children:[`Create the beneficiary profile. Ensure the `,_jsx(_components.code,{children:`phone`}),` field is populated as it is compulsory for Cash Pickup.`]}),_jsx(Card,{title:`Create Beneficiary`,href:`/api/transactions/create-beneficiary`,children:_jsx(_components.p,{children:`Create beneficiary endpoint`})}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note:`}),` Do not call “Add Bank Details” for Cash Pickup beneficiaries.`]})]}),_jsxs(Tab,{title:`Mobile Money`,id:`mobile-money`,\"data-child-heading-ids\":`[\"mobile-money-flow\",\"step-1%3A-list-mobile-operators\",\"step-2%3A-validate-mobile-number\",\"step-3%3A-create-beneficiary\",\"step-4%3A-create-transaction\"]`,children:[_jsx(Heading,{level:`3`,id:`mobile-money-flow`,children:`Mobile Money Flow`}),_jsx(_components.p,{children:`Mobile Money transfers require validating the mobile number with the specific operator(if supported/activated) before creation.`}),_jsx(Heading,{level:`4`,id:`step-1-list-mobile-operators`,children:`Step 1: List Mobile Operators`}),_jsx(_components.p,{children:`Retrieve the list of supported mobile money operators for the destination country.`}),_jsx(Card,{title:`List Mobile Operators`,href:`/api/transactions/list-mobile-operators`,children:_jsx(_components.p,{children:`View supported mobile operators`})}),_jsx(Heading,{level:`4`,id:`step-2-validate-mobile-number`,children:`Step 2: Validate Mobile Number`}),_jsx(_components.p,{children:`Validate the mobile number and operator code. This checks if the number is active and registered.`}),_jsx(Card,{title:`Validate Mobile Number`,href:`/api/transactions/validate-account`,children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`transactionType: MOBILE_MONEY`}),` and `,_jsx(_components.code,{children:`mobileOperatorCode`})]})}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Example Validation Request:`})}),_jsx(CodeBlock,{filename:``,numberOfLines:`7`,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:`7`,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:` \"mobileOperatorCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ORANGE\"`}),_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:` \"transactionType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"MOBILE_MONEY\"`}),_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:` \"topUpMobileNumber\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"090382738\"`}),_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:` \"accountNumberCountry\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"GIN\"`}),_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:` \"expectedCurrencyCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"GNF\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(Heading,{level:`4`,id:`step-3-create-beneficiary`,children:`Step 3: Create Beneficiary`}),_jsx(_components.p,{children:`If validation is successful (or if validation is not supported but the format is correct), create the beneficiary profile.`}),_jsx(Card,{title:`Create Beneficiary`,href:`/api/transactions/create-beneficiary`,children:_jsx(_components.p,{children:`Create beneficiary endpoint`})}),_jsx(Heading,{level:`4`,id:`step-4-create-transaction`,children:`Step 4: Create Transaction`}),_jsxs(_components.p,{children:[`When creating the transaction, include the mobile money details in the `,_jsx(_components.code,{children:`creditParty`}),` array.`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`4`,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:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"creditParty\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"mobilemoneynumber\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0903827384\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"mobileoperatorcode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ORANGE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})}),`\n`]})})})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Beneficiary Lifecycle","icon":"user-plus","description":null,"href":"/remittance/beneficiary-lifecycle"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Bank Transfer Flow","slug":"bank-transfer-flow","depth":3,"children":[],"tabId":"bank-transfer"},{"title":"Step 1: List Supported Banks","slug":"step-1-list-supported-banks","depth":4,"children":[],"tabId":"bank-transfer"},{"title":"Step 2: Get Required Fields","slug":"step-2-get-required-fields","depth":4,"children":[],"tabId":"bank-transfer"},{"title":"Step 3: Get Dynamic Forms (Optional)","slug":"step-3-get-dynamic-forms-optional","depth":4,"children":[],"tabId":"bank-transfer"},{"title":"Step 4: Validate Bank Account","slug":"step-4-validate-bank-account","depth":4,"children":[],"tabId":"bank-transfer"},{"title":"Step 5: Create Beneficiary","slug":"step-5-create-beneficiary","depth":4,"children":[],"tabId":"bank-transfer"},{"title":"Step 6: Add Bank Details","slug":"step-6-add-bank-details","depth":4,"children":[],"tabId":"bank-transfer"},{"title":"Cash Pickup Flow","slug":"cash-pickup-flow","depth":3,"children":[],"tabId":"cash-pickup"},{"title":"Step 1: Validate Phone (Optional)","slug":"step-1-validate-phone-optional","depth":4,"children":[],"tabId":"cash-pickup"},{"title":"Step 2: Create Beneficiary","slug":"step-2-create-beneficiary","depth":4,"children":[],"tabId":"cash-pickup"},{"title":"Mobile Money Flow","slug":"mobile-money-flow","depth":3,"children":[],"tabId":"mobile-money"},{"title":"Step 1: List Mobile Operators","slug":"step-1-list-mobile-operators","depth":4,"children":[],"tabId":"mobile-money"},{"title":"Step 2: Validate Mobile Number","slug":"step-2-validate-mobile-number","depth":4,"children":[],"tabId":"mobile-money"},{"title":"Step 3: Create Beneficiary","slug":"step-3-create-beneficiary","depth":4,"children":[],"tabId":"mobile-money"},{"title":"Step 4: Create Transaction","slug":"step-4-create-transaction","depth":4,"children":[],"tabId":"mobile-money"}],"codeExamples":{}},"jsLinks":[],"subdomain":"fincode","siteName":"FinCode Platform","title":"Beneficiary Lifecycle - FinCode Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T13:19:34.266Z","originalFileLocation":"remittance/beneficiary-lifecycle.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=\"light\"}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=\"application-name\" content=\"FinCode Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_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/fincode/F2sLn9W_rtCfFlNs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Beneficiary Lifecycle - FinCode Platform\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FinCode Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fincode.technology/remittance/beneficiary-lifecycle\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fincode.mintlify.site/_mintlify/api/og/v2?division=Transaction+Core\u0026amp;title=Beneficiary+Lifecycle\u0026amp;theme=5cb295c43f2caf87cf931732\u0026amp;signature=7d21d2f3800914f935f65f11ed09f47a51078d5a21bb7c6cd726307139d7537d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Beneficiary Lifecycle - FinCode Platform\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fincode.mintlify.site/_mintlify/api/og/v2?division=Transaction+Core\u0026amp;title=Beneficiary+Lifecycle\u0026amp;theme=5cb295c43f2caf87cf931732\u0026amp;signature=7d21d2f3800914f935f65f11ed09f47a51078d5a21bb7c6cd726307139d7537d\">\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/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FinCode Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#734CDC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fincode.technology/remittance/beneficiary-lifecycle\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/remittance/beneficiary-lifecycle.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fincode.technology/#organization\",\"name\":\"FinCode Platform\",\"url\":\"https://docs.fincode.technology\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fincode.technology#website\",\"name\":\"FinCode Platform\",\"url\":\"https://docs.fincode.technology\",\"publisher\":{\"@id\":\"https://docs.fincode.technology/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fincode.technology/remittance/beneficiary-lifecycle#webpage\",\"url\":\"https://docs.fincode.technology/remittance/beneficiary-lifecycle\",\"name\":\"Beneficiary Lifecycle\",\"dateModified\":\"2026-11-11T13:19:34.266Z\",\"isPartOf\":{\"@id\":\"https://docs.fincode.technology#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fincode.technology/remittance/beneficiary-lifecycle#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fincode.technology/remittance/beneficiary-lifecycle#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Transaction Core\",\"item\":\"https://docs.fincode.technology/remittance/transactions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Beneficiary Lifecycle\",\"item\":\"https://docs.fincode.technology/remittance/beneficiary-lifecycle\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.fincode.technology/remittance/beneficiary-lifecycle#article\",\"headline\":\"Beneficiary Lifecycle\",\"name\":\"Beneficiary Lifecycle\",\"url\":\"https://docs.fincode.technology/remittance/beneficiary-lifecycle\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fincode.technology/remittance/beneficiary-lifecycle#webpage\"},\"dateModified\":\"2026-11-11T13:19:34.266Z\",\"publisher\":{\"@id\":\"https://docs.fincode.technology/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fincode.technology#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FinCode Platform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"FinCode Platform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/remittance/beneficiary-lifecycle.md","siteName":"FinCode Platform","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Remittance","groups":[{"group":"Getting Started","pages":[{"title":"Overview","icon":"atom","href":"/remittance/overview"},{"title":"Process Flow","icon":"diagram-project","href":"/remittance/process-flows"},{"title":"Agent Integration Guide","icon":"plug","href":"/remittance/agent-integration"}]},{"group":"Transaction Core","pages":[{"title":"Transaction Lifecycle","description":"Understand transaction states, transitions, and what triggers each status change.","icon":"timeline","href":"/remittance/transactions"},{"title":"Beneficiary Lifecycle","icon":"user-plus","href":"/remittance/beneficiary-lifecycle"},{"title":"FX Conversion","description":"Understanding exchange rates, and how currency conversion works in remittance.","icon":"money-bill-transfer","href":"/remittance/fx-rates"}]},{"group":"API Endpoints","pages":[{"title":"Wallet Account List","openapi":"GET /walletmanagement/walletaccountlist","href":"/api/transactions/wallet-account"},{"title":"Find All Beneficiary","openapi":"GET /usermanagement/find-all-beneficiery","href":"/api/transactions/beneficiary-list"},{"title":"Transaction Types","openapi":"GET /transactionmanagement/transaction-types","href":"/api/transactions/transaction-types"},{"title":"Beneficiary Details","openapi":"GET /usermanagement/view-beneficiery-details/{beneficiaryId}","href":"/api/transactions/beneficiary-details"},{"title":"Delivery Currencies","openapi":"GET /quote/supported-delivery-currencies/{sendingCountryCode}/{receivingCountryCode}/{deliveryMethod}/{sendingCurrencyCode}","href":"/api/transactions/delivery-currencies"},{"title":"Destination Countries","openapi":"GET /quote/destination-country-by-delivery-method/{sendingCountryCode}/{deliveryMethod}","href":"/api/transactions/destination-countries"},{"title":"Supported Currencies","openapi":"GET /quote/supported-currencies/{sendingCountryCode}/{receivingCountryCode}/{deliveryMethod}","href":"/api/transactions/supported-currencies"},{"title":"Validate Recipient Account","openapi":"GET /usermanagement/validate-bank-account","href":"/api/transactions/validate-account"},{"title":"List Supported Banks","openapi":"GET /bankmanagement/list-supported-banks-iso3/{country}","href":"/api/transactions/list-supported-banks"},{"title":"Required Bank Fields","openapi":"GET /bankmanagement/required-bank-fields/{country}","href":"/api/transactions/required-bank-fields"},{"title":"List Mobile Operators","openapi":"GET /admin/bank/config/find-all-mobile-operator/{country}","href":"/api/transactions/list-mobile-operators"},{"title":"Add Bank Details","openapi":"POST /bankmanagement/add-bank-details-key-value-pairs","href":"/api/transactions/add-bank-details"},{"title":"Get Transaction Quote","openapi":"POST /quote/callQuote","href":"/api/transactions/call-quote"},{"title":"Payment Methods","api":"POST /paymentmanagement/supported-payment-methods","href":"/api/transactions/payment-methods"},{"title":"Create Beneficiary","openapi":"POST /usermanagement/new-beneficiary","href":"/api/transactions/create-beneficiary"},{"title":"Customer Transaction History","openapi":"POST /transactionmanagement/history-data","href":"/api/transactions/history-data"},{"title":"Check Transaction Status","openapi":"GET /transactionmanagement/checktransactionstatus/{transaction_identification_number}","href":"/api/transactions/check-transaction-status"},{"title":"Fetch Transaction Details","openapi":"GET /transactionmanagement/fetch-payable-type/{pcn}/{payable_type}","href":"/api/transactions/fetch-transaction-details"},{"title":"Create Transaction","openapi":"POST /transactionmanagement/create-transaction","href":"/api/transactions/create-transaction"},{"title":"Create Transaction (Direct)","openapi":"POST /transactionmanagement/create-transaction","href":"/api/transactions/create-transaction-direct"}]}]},{"tab":"Lending","pages":[{"title":"Lending","href":"/lending/overview"}]},{"tab":"Savings \u0026 Investment","pages":[{"title":"Savings \u0026 Investment","href":"/investment/overview"}]},{"tab":"Customer Identity \u0026 Access Management","pages":[{"title":"Customer Identity \u0026 Access Management","href":"/ciam/overview"}]},{"tab":"Payment Switch","pages":[{"title":"Payment Switch","href":"/songhai-exchange/overview"}]},{"tab":"Ledger Engine","pages":[{"title":"Ledger Engine","href":"/ledger/overview"}]},{"tab":"Deposit Engine","pages":[{"title":"Deposit Engine","href":"/deposit-engine/overview"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api/authentication"}]}]},"basePath":"","title":"Beneficiary Lifecycle - FinCode Platform","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}