{
"data": null,
"code": 403,
"message": "API key does not have 'pobo' permission",
"status": "Error",
"errors": [
{
"code": "403",
"message": "API key does not have 'pobo' permission",
"field": "API key does not have 'pobo' permission"
}
]
}
{
"data": null,
"code": 403,
"message": "API key does not have 'pobo' permission",
"status": "Error",
"errors": [
{
"code": "403",
"message": "API key does not have 'pobo' permission",
"field": "API key does not have 'pobo' permission"
}
]
}
The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.
Endl's numeric id for the recipient's country, from List countries. Not saved — the saved country is recipientAddress.countryId. It narrows the payout-rail check to that country; without it, the check accepts any country's rails. It does not fill in the ISO codes on POBO.
Postal address. Send countryId here as well as at the top level — this one is the country saved on the recipient. On POBO, send both countryTwoLetter (ISO 3166-1 alpha-2) and countryThreeLetter (alpha-3) for every rail except AED and CRYPTO; they are not derived from countryId here. Any key not listed here is rejected with 400.
Address of the receiving bank. Same properties as recipientAddress. Required for GBP, with a valid UK postcode. Also used as the beneficiary bank address on AED payouts. Not specific to business recipients.
The receiving bank's code. Take it from the options of the bankId field in Get recipient fields and send the option's code. Required wherever that endpoint marks bankId as REQUIRED. Top level only, never inside recipientAddress.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Endl API","description":"Official API documentation for the Endl platform.","colors":{"primary":"#245FFE","light":"#5280FE","dark":"#013FE9"},"logo":{"light":"https://mintcdn.com/zaymentfinanceltd/vAyX8M6UjfgZPY1s/logo/endl-api-light-mode.svg?fit=max\u0026auto=format\u0026n=vAyX8M6UjfgZPY1s\u0026q=85\u0026s=317a3d2271242ccb4a73e8c8cc70884d","dark":"https://mintcdn.com/zaymentfinanceltd/vAyX8M6UjfgZPY1s/logo/endl-api-dark-mode.svg?fit=max\u0026auto=format\u0026n=vAyX8M6UjfgZPY1s\u0026q=85\u0026s=b136951611411c621ca45b782a881f95"},"favicon":"https://mintcdn.com/zaymentfinanceltd/vAyX8M6UjfgZPY1s/favicon.svg?fit=max\u0026auto=format\u0026n=vAyX8M6UjfgZPY1s\u0026q=85\u0026s=535b7fe6b8d30064c6319f5c6521341a","api":{"playground":{"proxy":false}},"footer":{"socials":{"website":"https://endl.io"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zaymentfinanceltd","hasAudioNarration":false,"actualSubdomain":"zaymentfinanceltd","customDomains":["docs.endl.io"],"gitSource":{"type":"github","owner":"endl-team","repo":"endl-api-documentation-repo","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf033c8c0a1951943f3472","collectionId":"ee77d0eb-1dd7-4637-8099-0460519d2752","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf033c8c0a1951943f3472"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf033c8c0a1951943f3472","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API reference","count":128},{"language":"default","tag":"Endpoints","count":123},{"language":"default","tag":"Cards","count":28},{"language":"default","tag":"POBO","count":16},{"language":"default","tag":"Webhooks","count":15},{"language":"default","tag":"Onboarding","count":14},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Accounts","count":12},{"language":"default","tag":"Gift Cards","count":11},{"language":"default","tag":"Transactions","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#sidebar li[data-group-tag]>button{font-weight:600;background-color:rgba(100,116,139,.12);margin-bottom:2px}#sidebar li[data-group-tag]>button:hover{background-color:rgba(100,116,139,.2)}html.dark #sidebar li[data-group-tag]>button{background-color:rgba(148,163,184,.13)}html.dark #sidebar li[data-group-tag]>button:hover{background-color:rgba(148,163,184,.22)}#sidebar li[data-group-tag][data-active=true]>button{color:#013fe9;background-color:rgba(36,95,254,.16)}#sidebar li[data-group-tag][data-active=true]>button:hover{background-color:rgba(36,95,254,.22)}#sidebar li[data-group-tag][data-active=true]>button svg{color:#013fe9;opacity:1}html.dark #sidebar li[data-group-tag][data-active=true]>button{color:#5280fe;background-color:rgba(82,128,254,.22)}html.dark #sidebar li[data-group-tag][data-active=true]>button:hover{background-color:rgba(82,128,254,.3)}html.dark #sidebar li[data-group-tag][data-active=true]>button svg{color:#5280fe;opacity:1}#sidebar a[aria-current=page]{position:relative;font-weight:600;background-color:rgba(36,95,254,.16)}#sidebar a[aria-current=page]::before{content:\"\";position:absolute;left:0;top:.3rem;bottom:.3rem;width:3px;border-radius:0 2px 2px 0;background:#245ffe}html.dark #sidebar a[aria-current=page]{background-color:rgba(82,128,254,.22)}html.dark #sidebar a[aria-current=page]::before{background:#5280fe}#sidebar a[aria-current=page] span{opacity:1}body:has([role=dialog]) #search-bar-entry{visibility:hidden}body:has([role=dialog])::before{content:\"\";position:fixed;inset:0;z-index:30;background:rgba(2,6,23,.45);backdrop-filter:blur(2px);pointer-events:none}a[href*=\"utm_campaign=poweredBy\"]{display:none!important}"}],"page":{"pagePath":"api-reference/pobo/create-recipient","slug":"/api-reference/pobo/create-recipient","pageMetadata":{"title":"Create recipient","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/recipients","description":"Create a recipient under your POBO scope.\n\nWhich fields are required varies by `payoutRail` and `currency`. Ask [Get recipient fields](/api-reference/reference/get-recipient-fields) first and collect exactly what it returns.\n\nReturns a **short** recipient, not the full object — call [Get recipient](/api-reference/pobo/get-recipient) for the rest.","href":"/api-reference/pobo/create-recipient"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create a recipient under your POBO scope.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Which fields are required varies by \", _jsx(_components.code, {\n children: \"payoutRail\"\n }), \" and \", _jsx(_components.code, {\n children: \"currency\"\n }), \". Ask \", _jsx(_components.a, {\n href: \"/api-reference/reference/get-recipient-fields\",\n children: \"Get recipient fields\"\n }), \" first and collect exactly what it returns.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Returns a \", _jsx(_components.strong, {\n children: \"short\"\n }), \" recipient, not the full object — call \", _jsx(_components.a, {\n href: \"/api-reference/pobo/get-recipient\",\n children: \"Get recipient\"\n }), \" for the rest.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`pobo-error-codes`,children:`POBO error codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`HTTP`}),_jsx(_components.th,{children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRTXN_1000`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`senderId`}),` missing on pre-transaction or submit.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRTXN_1001`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`The route is not served by Paywho.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRTXN_1002`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`walletId`}),` missing on a wallet-funded transfer.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRTXN_1003`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`walletId`}),` not found or not active.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRQUO_1000`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`Quote not found.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRQUO_1017`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`No rate available for this route.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRQUO_1019`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`senderType`}),` or `,_jsx(_components.code,{children:`recipientType`}),` is not `,_jsx(_components.code,{children:`INDIVIDUAL`}),` / `,_jsx(_components.code,{children:`BUSINESS`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRREC_1000`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`Recipient not found.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`ERRREF_1000`}),` / `,_jsx(_components.code,{children:`ERRREF_1001`})]}),_jsxs(_components.td,{\"data-numeric\":`true`,children:[_jsx(_components.code,{children:`400`}),` / `,_jsx(_components.code,{children:`404`})]}),_jsx(_components.td,{children:`Malformed / unknown reference id.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRCORE_1001`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsxs(_components.td,{children:[`Sender validation failures, including `,_jsx(_components.code,{children:`Sender not found`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRCORE_1003`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsxs(_components.td,{children:[`A live sender already has this `,_jsx(_components.code,{children:`governmentId`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ERRCORE_1005`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsxs(_components.td,{children:[`The API key lacks the `,_jsx(_components.code,{children:`pobo`}),` permission.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Branch on `,_jsx(_components.code,{children:`errors[0].code`}),`. See `,_jsx(_components.a,{href:`/api-reference/error-codes`,children:`Error codes`}),` for every code.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create recipient","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/recipients","description":"Create a recipient under your POBO scope.\n\nWhich fields are required varies by `payoutRail` and `currency`. Ask [Get recipient fields](/api-reference/reference/get-recipient-fields) first and collect exactly what it returns.\n\nReturns a **short** recipient, not the full object — call [Get recipient](/api-reference/pobo/get-recipient) for the rest.","href":"/api-reference/pobo/create-recipient"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"POBO error codes","slug":"pobo-error-codes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/zaymentfinanceltd/d373d43d77eb6813/custom.js"],"openApiReferenceData":{"operation":{"tags":["Recipients"],"summary":"Create recipient","description":"Create a recipient under your POBO scope.\n\nWhich fields are required varies by `payoutRail` and `currency`. Ask [Get recipient fields](/api-reference/reference/get-recipient-fields) first and collect exactly what it returns.\n\nReturns a **short** recipient, not the full object — call [Get recipient](/api-reference/pobo/get-recipient) for the rest.","requestBody":"47297cdf-2dc7-4ffd-bffc-ce4a9216f5e1","responses":{"200":"b7c859af-3f3a-47f9-bd78-361731a8a033","400":"6cef4520-b69f-4360-addd-351eaf6ca7ec","401":"6f9e391a-2a66-4504-9d51-cdc53cf65c2b","403":"445e0743-c6c7-417d-a24f-e0548e2c195b","429":"9bc7c447-0f59-4063-86f4-1465e56be25a","500":"4b79b6c2-cee3-402b-a8dd-f8a20ad0f613","502":"5c4c869b-d323-4b4d-bfb0-9c305711e4f5"},"parameters":["dace4812-a4bf-439b-b3fb-14929542a2d9"],"method":"post","type":"path","servers":["79cdca2c-a9f4-4e73-ab4c-a115f9d74822"],"security":["81403498-5bea-40e0-a9ba-f5e332312b76"],"path":"/api/v0/pobo/recipients","baseUrlOptions":["https://api-sandbox.endl.io"],"title":"Create recipient","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"dace4812-a4bf-439b-b3fb-14929542a2d9":{"name":"Api-Version","in":"header","required":true,"description":"The API version this request targets. Required on every `/api/v0/*` call. Format `YYYY-MM.\u003crelease>`; `2026-09.1` is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with `400`.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}\\.\\d+$","default":"2026-09.1","isRequired":true,"description":"The API version this request targets. Required on every `/api/v0/*` call. Format `YYYY-MM.\u003crelease>`; `2026-09.1` is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with `400`.","uniqueKey":"","typeLabel":"string"},"example":"2026-09.1"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","currency","currencySymbol","currencyId","payoutRail","relationshipToCustomer"],"properties":{"type":{"type":"string","description":"`INDIVIDUAL` or `BUSINESS`.","enum":["INDIVIDUAL","BUSINESS"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","description":"Destination currency, ISO 4217 — `PHP`.","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"currencySymbol":{"type":"string","description":"The symbol for that currency.","isRequired":true,"uniqueKey":"currencySymbol","typeLabel":"string"},"currencyId":{"type":"integer","description":"Endl's numeric id for the currency, from [List currencies](/api-reference/reference/list-currencies).","isRequired":true,"uniqueKey":"currencyId","typeLabel":"integer"},"payoutRail":{"type":"string","description":"Payout rail. POBO accepts Paywho rails only.","isRequired":true,"uniqueKey":"payoutRail","typeLabel":"string"},"relationshipToCustomer":{"type":"string","description":"Relationship of the recipient to your customer.","isRequired":true,"uniqueKey":"relationshipToCustomer","typeLabel":"string"},"firstName":{"type":"string","description":"Given name.","uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Family name.","uniqueKey":"lastName","typeLabel":"string"},"businessName":{"type":"string","description":"Recipient's legal name. Required when `type` is `BUSINESS`.","uniqueKey":"businessName","typeLabel":"string"},"countryId":{"type":"integer","description":"Endl's numeric id for the recipient's country, from [List countries](/api-reference/reference/list-countries). **Not saved** — the saved country is `recipientAddress.countryId`. It narrows the payout-rail check to that country; without it, the check accepts any country's rails. It does **not** fill in the ISO codes on POBO.","uniqueKey":"countryId","typeLabel":"integer"},"email":{"type":"string","description":"Contact email.","uniqueKey":"email","typeLabel":"string"},"phone":{"type":"string","description":"Recipient's phone number. Digits only, up to 15. No `+`, spaces or dashes.","uniqueKey":"phone","typeLabel":"string"},"bankName":{"type":"string","description":"Receiving bank.","uniqueKey":"bankName","typeLabel":"string"},"bankAccountNumber":{"type":"string","description":"Account number at the receiving bank.","uniqueKey":"bankAccountNumber","typeLabel":"string"},"swiftBic":{"type":"string","description":"SWIFT/BIC of the receiving bank.","uniqueKey":"swiftBic","typeLabel":"string"},"accountType":{"type":"string","description":"Account type — `SAVINGS`, `CHECKING`.","uniqueKey":"accountType","typeLabel":"string"},"recipientAddress":{"type":"object","description":"Postal address. Send `countryId` here as well as at the top level — this one is the country saved on the recipient. On POBO, send both `countryTwoLetter` (ISO 3166-1 alpha-2) and `countryThreeLetter` (alpha-3) for every rail except AED and `CRYPTO`; they are not derived from `countryId` here. Any key not listed here is rejected with `400`.","properties":{"addressLine1":{"type":"string","description":"Street address.","uniqueKey":"recipientAddress.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Second address line, if any.","uniqueKey":"recipientAddress.addressLine2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"recipientAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State or province.","uniqueKey":"recipientAddress.state","typeLabel":"string"},"country":{"type":"string","description":"Country name.","uniqueKey":"recipientAddress.country","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal or ZIP code.","uniqueKey":"recipientAddress.postalCode","typeLabel":"string"},"countryThreeLetter":{"type":"string","description":"ISO 3166-1 alpha-3 country code — `PHL`.","uniqueKey":"recipientAddress.countryThreeLetter","typeLabel":"string"},"countryTwoLetter":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","uniqueKey":"recipientAddress.countryTwoLetter","typeLabel":"string"},"countryId":{"type":"integer","description":"Endl's numeric id for the country, from [List countries](/api-reference/reference/list-countries). **Saved on the recipient** and returned on it. Not sent → saved as `null`.","uniqueKey":"recipientAddress.countryId","typeLabel":"integer"},"region":{"type":"string","description":"Region.","uniqueKey":"recipientAddress.region","typeLabel":"string"}},"uniqueKey":"recipientAddress","typeLabel":"object"},"institutionalAddress":{"type":"object","description":"Address of the receiving bank. Same properties as `recipientAddress`. Required for GBP, with a valid UK postcode. Also used as the beneficiary bank address on AED payouts. Not specific to business recipients.","properties":{"addressLine1":{"type":"string","description":"Street address.","uniqueKey":"institutionalAddress.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Second address line, if any.","uniqueKey":"institutionalAddress.addressLine2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"institutionalAddress.city","typeLabel":"string"},"state":{"type":"string","description":"State or province.","uniqueKey":"institutionalAddress.state","typeLabel":"string"},"country":{"type":"string","description":"Country name.","uniqueKey":"institutionalAddress.country","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal or ZIP code.","uniqueKey":"institutionalAddress.postalCode","typeLabel":"string"},"countryThreeLetter":{"type":"string","description":"ISO 3166-1 alpha-3 country code — `PHL`.","uniqueKey":"institutionalAddress.countryThreeLetter","typeLabel":"string"},"countryTwoLetter":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","uniqueKey":"institutionalAddress.countryTwoLetter","typeLabel":"string"},"countryId":{"type":"integer","description":"Endl's numeric id for the country, from [List countries](/api-reference/reference/list-countries).","uniqueKey":"institutionalAddress.countryId","typeLabel":"integer"},"region":{"type":"string","description":"Region.","uniqueKey":"institutionalAddress.region","typeLabel":"string"}},"uniqueKey":"institutionalAddress","typeLabel":"object"},"providerBankId":{"type":"string","description":"The receiving bank's code. Take it from the `options` of the `bankId` field in Get recipient fields and send the option's `code`. Required wherever that endpoint marks `bankId` as REQUIRED. Top level only, never inside `recipientAddress`.","uniqueKey":"providerBankId","typeLabel":"string"},"dateOfBirth":{"type":"string","description":"Individual's date of birth, `DD-MM-YYYY` (for example `25-01-1994`).","uniqueKey":"dateOfBirth","typeLabel":"string"},"governmentId":{"type":"string","description":"Recipient's ID number. Get recipient fields calls this field `governmentIdNumber`.","uniqueKey":"governmentId","typeLabel":"string"},"governmentIdType":{"type":"string","description":"Type of `governmentId`, from the field's options.","uniqueKey":"governmentIdType","typeLabel":"string"},"bankBranchCode":{"type":"string","description":"Branch code.","uniqueKey":"bankBranchCode","typeLabel":"string"},"bankBranchName":{"type":"string","description":"Branch name. Required for TWD.","uniqueKey":"bankBranchName","typeLabel":"string"},"nationality":{"type":"string","description":"Recipient's nationality, from the field's options.","uniqueKey":"nationality","typeLabel":"string"},"gender":{"type":"string","description":"`M` or `F`.","uniqueKey":"gender","typeLabel":"string"},"occupation":{"type":"string","description":"Recipient's occupation, from the field's options.","uniqueKey":"occupation","typeLabel":"string"},"nativeFirstName":{"type":"string","description":"First name in local script. CNY requires Han characters.","uniqueKey":"nativeFirstName","typeLabel":"string"},"nativeLastName":{"type":"string","description":"Last name in local script.","uniqueKey":"nativeLastName","typeLabel":"string"},"nativeAddress":{"type":"string","description":"Address in local script. Top level, not inside `recipientAddress`.","uniqueKey":"nativeAddress","typeLabel":"string"},"nativeBusinessName":{"type":"string","description":"BUSINESS only. Legal name in local script.","uniqueKey":"nativeBusinessName","typeLabel":"string"},"businessStructure":{"type":"string","description":"BUSINESS only. From the field's options.","uniqueKey":"businessStructure","typeLabel":"string"},"businessRegistrationCountry":{"type":"string","description":"BUSINESS only. From the field's options.","uniqueKey":"businessRegistrationCountry","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"BUSINESS","businessName":"DEU Labs","currency":"VND","currencySymbol":"₫","currencyId":110,"countryId":241,"payoutRail":"BANK_TRANSFER","relationshipToCustomer":"SUPPLIER","providerBankId":"VIETCOMBANK","bankAccountNumber":"0032995678","email":"support@technolabs.com","phone":"84909876543","recipientAddress":{"addressLine1":"12 Nguyen Hue","city":"Ho Chi Minh City","country":"Vietnam","countryTwoLetter":"VN","countryThreeLetter":"VNM","countryId":241}},"examples":{"Example":{"title":"Example","value":{"type":"BUSINESS","businessName":"DEU Labs","currency":"VND","currencySymbol":"₫","currencyId":110,"countryId":241,"payoutRail":"BANK_TRANSFER","relationshipToCustomer":"SUPPLIER","providerBankId":"VIETCOMBANK","bankAccountNumber":"0032995678","email":"support@technolabs.com","phone":"84909876543","recipientAddress":{"addressLine1":"12 Nguyen Hue","city":"Ho Chi Minh City","country":"Vietnam","countryTwoLetter":"VN","countryThreeLetter":"VNM","countryId":241}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"b7c859af-3f3a-47f9-bd78-361731a8a033":{"description":"The created recipient, short form. **Unwrapped.**","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"`rec_…` reference id.","uniqueKey":"id","typeLabel":"string"},"firstName":{"type":"string","description":"As sent; for a business, the business name.","uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","description":"As sent.","uniqueKey":"lastName","typeLabel":"string"},"email":{"type":"string","description":"As sent.","uniqueKey":"email","typeLabel":"string"},"bankName":{"type":"string","description":"As sent.","uniqueKey":"bankName","typeLabel":"string"},"bankAccountNumber":{"type":"string","description":"As sent.","uniqueKey":"bankAccountNumber","typeLabel":"string"},"countryId":{"type":"integer","description":"`recipientAddress.countryId`.","uniqueKey":"countryId","typeLabel":"integer"},"statusAccountsProvider":{"type":"string","description":"Always `ACTIVE` for POBO (Paywho) rails: payable at once.","uniqueKey":"statusAccountsProvider","typeLabel":"string"},"deleted":{"type":"boolean","description":"Always `false`.","uniqueKey":"deleted","typeLabel":"boolean"},"wireMessage":{"type":"string","description":"Only when sent.","uniqueKey":"wireMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"rec_5Tn8Wq2Lp6Rz3Xk9Vb1M","firstName":"Van An","lastName":"Nguyen","email":"an.nguyen@example.vn","bankName":"Vietcombank","bankAccountNumber":"0071001234567","countryId":241,"statusAccountsProvider":"ACTIVE","deleted":false},"examples":{"Example":{"title":"Example","value":{"id":"rec_5Tn8Wq2Lp6Rz3Xk9Vb1M","firstName":"Van An","lastName":"Nguyen","email":"an.nguyen@example.vn","bankName":"Vietcombank","bankAccountNumber":"0071001234567","countryId":241,"statusAccountsProvider":"ACTIVE","deleted":false}}},"exampleType":"examples"}},"exampleType":"examples"},"6cef4520-b69f-4360-addd-351eaf6ca7ec":{"description":"Validation failed, or the route is not supported for POBO. A duplicate recipient — the same account number — returns `400` with message `Account exists`. `ERRREC_1001` — a recipient field fails validation. Each failing field is its own `errors[]` entry: `message` gives the reason (for example `First name is required`) and `field` names the field (for example `firstName`).","content":{"application/json":{"example":{"code":400,"message":"Rail not supported for POBO","status":"ERROR","data":null,"errors":[{"code":"ERRTXN_1001","message":"Rail not supported for POBO","field":null}]},"examples":{"Example":{"title":"Example","value":{"code":400,"message":"Rail not supported for POBO","status":"ERROR","data":null,"errors":[{"code":"ERRTXN_1001","message":"Rail not supported for POBO","field":null}]}}},"exampleType":"examples"}},"exampleType":"examples"},"6f9e391a-2a66-4504-9d51-cdc53cf65c2b":{"description":"Missing or invalid API credentials.","content":{"application/json":{"example":{"data":null,"code":401,"message":"Authentication Failed!","status":"Error","errors":[{"code":"401","message":"Authentication Failed!","field":"Authentication Failed!"}]},"examples":{"Example":{"title":"Example","value":{"data":null,"code":401,"message":"Authentication Failed!","status":"Error","errors":[{"code":"401","message":"Authentication Failed!","field":"Authentication Failed!"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"445e0743-c6c7-417d-a24f-e0548e2c195b":{"description":"The key does not carry the `pobo` permission. Raised at the edge.","content":{"application/json":{"example":{"data":null,"code":403,"message":"API key does not have 'pobo' permission","status":"Error","errors":[{"code":"403","message":"API key does not have 'pobo' permission","field":"API key does not have 'pobo' permission"}]},"examples":{"Example":{"title":"Example","value":{"data":null,"code":403,"message":"API key does not have 'pobo' permission","status":"Error","errors":[{"code":"403","message":"API key does not have 'pobo' permission","field":"API key does not have 'pobo' permission"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"9bc7c447-0f59-4063-86f4-1465e56be25a":{"description":"The per-API-key request rate limit was exceeded.","content":{"application/json":{"example":{"data":null,"code":429,"message":"Rate limit exceeded, please retry later","status":"Error","errors":[{"code":"429","message":"Rate limit exceeded, please retry later","field":"Rate limit exceeded, please retry later"}]},"examples":{"Example":{"title":"Example","value":{"data":null,"code":429,"message":"Rate limit exceeded, please retry later","status":"Error","errors":[{"code":"429","message":"Rate limit exceeded, please retry later","field":"Rate limit exceeded, please retry later"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"4b79b6c2-cee3-402b-a8dd-f8a20ad0f613":{"description":"Unexpected server error.","content":{"application/json":{"example":{"code":500,"message":"Unexpected error","status":"ERROR","data":null,"errors":[{"code":"INTERNAL_ERROR","message":"Unexpected error","field":null}]},"examples":{"Example":{"title":"Example","value":{"code":500,"message":"Unexpected error","status":"ERROR","data":null,"errors":[{"code":"INTERNAL_ERROR","message":"Unexpected error","field":null}]}}},"exampleType":"examples"}},"exampleType":"examples"},"5c4c869b-d323-4b4d-bfb0-9c305711e4f5":{"description":"Endl could not reach the service behind the edge. Retry with backoff.","content":{"application/json":{"example":{"data":null,"code":502,"message":"Upstream service error","status":"Error","errors":null},"examples":{"Example":{"title":"Example","value":{"data":null,"code":502,"message":"Upstream service error","status":"Error","errors":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"81403498-5bea-40e0-a9ba-f5e332312b76":{"apiKey":{"type":"apiKey","in":"header","name":"API-KEY","description":"Your partner API key. Must carry the `pobo` permission.","scopes":[],"schemeName":"apiKey"}}},"servers":{"79cdca2c-a9f4-4e73-ab4c-a115f9d74822":{"url":"https://api-sandbox.endl.io","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"API-KEY","description":"Your partner API key. Must carry the `pobo` permission.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"API-KEY","type":"string","description":"Your partner API key. Must carry the `pobo` permission.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"API-KEY"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/endl-pobo-api.json"},"subdomain":"zaymentfinanceltd","siteName":"Endl API","title":"Create recipient - Endl API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T07:37:45.003Z","originalFileLocation":"api-reference/pobo/create-recipient.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=\"Create a recipient under your POBO scope. Which fields are required varies by payoutRail and currency. Ask Get recipient fields first and collect exactly what it returns. Returns a short recipient, not the full object — call Get recipient for the rest.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Endl API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zaymentfinanceltd/V4tezyHprXdvGDz0/_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/zaymentfinanceltd/V4tezyHprXdvGDz0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zaymentfinanceltd/V4tezyHprXdvGDz0/_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/zaymentfinanceltd/V4tezyHprXdvGDz0/_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/zaymentfinanceltd/V4tezyHprXdvGDz0/_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/zaymentfinanceltd/V4tezyHprXdvGDz0/_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/zaymentfinanceltd/V4tezyHprXdvGDz0/_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/zaymentfinanceltd/V4tezyHprXdvGDz0/_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/zaymentfinanceltd/V4tezyHprXdvGDz0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create recipient - Endl API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a recipient under your POBO scope. Which fields are required varies by payoutRail and currency. Ask Get recipient fields first and collect exactly what it returns. Returns a short recipient, not the full object — call Get recipient for the rest.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Endl API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.endl.io/api-reference/pobo/create-recipient\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zaymentfinanceltd.mintlify.app/_mintlify/api/og/v2?division=POBO\u0026amp;title=Create+recipient\u0026amp;description=Create+a+recipient+under+your+POBO+scope.%0A%0AWhich+fields+are+required+varies+by+%60payoutRail%60+and+%60currency%60.+Ask+%5BGet+recipient+fields%5D%28%2Fapi-reference%2Freference%2F\u0026amp;theme=668efa5ed0467f58a90d23e2\u0026amp;signature=e77a7068dca54e78dc8d92ffc9ab9f02c88c8506886c46144f0606fbb66caa4e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create recipient - Endl API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a recipient under your POBO scope. Which fields are required varies by payoutRail and currency. Ask Get recipient fields first and collect exactly what it returns. Returns a short recipient, not the full object — call Get recipient for the rest.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zaymentfinanceltd.mintlify.app/_mintlify/api/og/v2?division=POBO\u0026amp;title=Create+recipient\u0026amp;description=Create+a+recipient+under+your+POBO+scope.%0A%0AWhich+fields+are+required+varies+by+%60payoutRail%60+and+%60currency%60.+Ask+%5BGet+recipient+fields%5D%28%2Fapi-reference%2Freference%2F\u0026amp;theme=668efa5ed0467f58a90d23e2\u0026amp;signature=e77a7068dca54e78dc8d92ffc9ab9f02c88c8506886c46144f0606fbb66caa4e\">\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/zaymentfinanceltd/V4tezyHprXdvGDz0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Endl API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#245FFE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.endl.io/api-reference/pobo/create-recipient\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/pobo/create-recipient.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.endl.io/#organization\",\"name\":\"Endl API\",\"url\":\"https://docs.endl.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zaymentfinanceltd/vAyX8M6UjfgZPY1s/logo/endl-api-light-mode.svg?fit=max\u0026auto=format\u0026n=vAyX8M6UjfgZPY1s\u0026q=85\u0026s=317a3d2271242ccb4a73e8c8cc70884d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.endl.io#website\",\"name\":\"Endl API\",\"url\":\"https://docs.endl.io\",\"publisher\":{\"@id\":\"https://docs.endl.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.endl.io/api-reference/pobo/create-recipient#webpage\",\"url\":\"https://docs.endl.io/api-reference/pobo/create-recipient\",\"name\":\"Create recipient\",\"description\":\"Create a recipient under your POBO scope. Which fields are required varies by payoutRail and currency. Ask Get recipient fields first and collect exactly what it returns. Returns a short recipient, not the full object — call Get recipient for the rest.\",\"dateModified\":\"2026-10-26T07:37:45.003Z\",\"isPartOf\":{\"@id\":\"https://docs.endl.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.endl.io/api-reference/pobo/create-recipient#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.endl.io/api-reference/pobo/create-recipient#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.endl.io/api-reference/onboarding/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"POBO\",\"item\":\"https://docs.endl.io/api-reference/pobo/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create recipient\",\"item\":\"https://docs.endl.io/api-reference/pobo/create-recipient\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.endl.io/api-reference/pobo/create-recipient#apireference\",\"headline\":\"Create recipient\",\"name\":\"Create recipient\",\"description\":\"Create a recipient under your POBO scope. Which fields are required varies by payoutRail and currency. Ask Get recipient fields first and collect exactly what it returns. Returns a short recipient, not the full object — call Get recipient for the rest.\",\"url\":\"https://docs.endl.io/api-reference/pobo/create-recipient\",\"mainEntityOfPage\":{\"@id\":\"https://docs.endl.io/api-reference/pobo/create-recipient#webpage\"},\"dateModified\":\"2026-10-26T07:37:45.003Z\",\"publisher\":{\"@id\":\"https://docs.endl.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.endl.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Endl API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Endl API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Introduction","pages":[{"title":"API reference overview","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Versioning","href":"/api-reference/versioning"},{"title":"Errors and the response envelope","href":"/api-reference/errors"},{"title":"Error codes","href":"/api-reference/error-codes"}]},{"group":"Endpoints","pages":[{"group":"Onboarding","expanded":true,"pages":[{"title":"Onboarding overview","href":"/api-reference/onboarding/introduction"},{"title":"Errors and lifecycle","href":"/api-reference/onboarding/errors"},{"title":"Individual (KYC)","href":"/api-reference/onboarding/individual-kyc"},{"title":"Business (KYB)","href":"/api-reference/onboarding/business-kyb"},{"title":"Create customer","openapi":"api-reference/endl-onboarding-api.json POST /api/v0/customer","href":"/api-reference/onboarding/create-customer"},{"title":"Get customer","openapi":"api-reference/endl-onboarding-api.json GET /api/v0/customer/{userId}","href":"/api-reference/onboarding/get-customer"},{"title":"Update customer","openapi":"api-reference/endl-onboarding-api.json PUT /api/v0/customer/{userId}","href":"/api-reference/onboarding/update-customer"},{"title":"List customers","openapi":"api-reference/endl-onboarding-api.json GET /api/v0/customer","href":"/api-reference/onboarding/list-customers"},{"title":"Delete customer","openapi":"api-reference/endl-onboarding-api.json DELETE /api/v0/customer/{userId}","href":"/api-reference/onboarding/delete-customer"},{"title":"Generate KYC link","openapi":"api-reference/endl-onboarding-api.json POST /api/v0/customer/{userId}/kyc-link","href":"/api-reference/onboarding/generate-kyc-link"},{"title":"Upload document","openapi":"api-reference/endl-onboarding-api.json POST /api/v0/customer/{userId}/documents","href":"/api-reference/onboarding/upload-document"},{"title":"Upload owner document","openapi":"api-reference/endl-onboarding-api.json POST /api/v0/customer/{userId}/ubo/{uboRef}/documents","href":"/api-reference/onboarding/upload-ubo-document"},{"title":"Questionnaire reference","href":"/api-reference/onboarding/questionnaires"},{"title":"Country restrictions","href":"/api-reference/onboarding/country-restrictions"}]},{"group":"Reference data","expanded":true,"pages":[{"title":"List currencies","openapi":"api-reference/endl-partner-api.json GET /api/v0/currencies","href":"/api-reference/reference/list-currencies"},{"title":"List countries","openapi":"api-reference/endl-partner-api.json GET /api/v0/countries","href":"/api-reference/reference/list-countries"},{"title":"List occupations","openapi":"api-reference/endl-partner-api.json GET /api/v0/occupations","href":"/api-reference/reference/list-occupations"},{"title":"List rails","openapi":"api-reference/endl-partner-api.json GET /api/v0/rails","href":"/api-reference/reference/list-rails"},{"title":"Get recipient fields","openapi":"api-reference/endl-partner-api.json GET /api/v0/recipient-fields","href":"/api-reference/reference/get-recipient-fields"},{"title":"Get sender fields","openapi":"api-reference/endl-partner-api.json GET /api/v0/sender-fields","href":"/api-reference/reference/get-sender-fields"}]},{"group":"Wallets","expanded":true,"pages":[{"title":"List wallets","openapi":"api-reference/endl-partner-api.json GET /api/v0/wallets/{userId}","href":"/api-reference/wallets/list-wallets"},{"title":"Create wallet","openapi":"api-reference/endl-partner-api.json POST /api/v0/wallets/{userId}","href":"/api-reference/wallets/create-wallet"},{"title":"Get wallet","openapi":"api-reference/endl-partner-api.json GET /api/v0/wallets/{userId}/{walletId}","href":"/api-reference/wallets/get-wallet"},{"title":"Get wallet balance","openapi":"api-reference/endl-partner-api.json GET /api/v0/wallets/{userId}/{walletId}/balance","href":"/api-reference/wallets/get-wallet-balance"},{"title":"Update wallet","openapi":"api-reference/endl-partner-api.json PATCH /api/v0/wallets/{userId}/{walletId}","href":"/api-reference/wallets/update-wallet"},{"title":"Delete wallet","openapi":"api-reference/endl-partner-api.json DELETE /api/v0/wallets/{userId}/{walletId}","href":"/api-reference/wallets/delete-wallet"}]},{"group":"Accounts","expanded":true,"pages":[{"title":"Accounts API","href":"/api-reference/accounts/introduction"},{"title":"Account statuses","href":"/api-reference/accounts/statuses"},{"title":"Open account","openapi":"api-reference/endl-partner-api.json POST /api/v0/accounts/{userId}","href":"/api-reference/accounts/open-account"},{"title":"List accounts","openapi":"api-reference/endl-partner-api.json GET /api/v0/accounts/{userId}","href":"/api-reference/accounts/list-accounts"},{"title":"List currencies available for opening","openapi":"api-reference/endl-partner-api.json GET /api/v0/accounts/{userId}/available-for-opening","href":"/api-reference/accounts/list-accounts-available-for-opening"},{"title":"Get account","openapi":"api-reference/endl-partner-api.json GET /api/v0/accounts/{userId}/{accountId}","href":"/api-reference/accounts/get-account"},{"title":"Get account balance","openapi":"api-reference/endl-partner-api.json GET /api/v0/accounts/{userId}/{accountId}/balance","href":"/api-reference/accounts/get-account-balance"},{"title":"Get account activity","openapi":"api-reference/endl-partner-api.json GET /api/v0/accounts/{userId}/{accountId}/activity","href":"/api-reference/accounts/get-account-activity"},{"title":"Activate account","openapi":"api-reference/endl-partner-api.json PATCH /api/v0/accounts/{userId}/{accountId}/activate","href":"/api-reference/accounts/activate-account"},{"title":"Deactivate account","openapi":"api-reference/endl-partner-api.json PATCH /api/v0/accounts/{userId}/{accountId}/deactivate","href":"/api-reference/accounts/deactivate-account"},{"title":"Response by currency","href":"/api-reference/accounts/response-by-currency"},{"title":"Accounts errors","href":"/api-reference/accounts/errors"}]},{"group":"Quotes","expanded":true,"pages":[{"title":"Generate quote","openapi":"api-reference/endl-partner-api.json POST /api/v0/quotes/{userId}/generate","href":"/api-reference/quotes/generate-quote"},{"title":"Get quote","openapi":"api-reference/endl-partner-api.json GET /api/v0/quotes/{userId}/{quoteId}","href":"/api-reference/quotes/get-quote"}]},{"group":"Recipients","expanded":true,"pages":[{"title":"Add recipient","openapi":"api-reference/endl-partner-api.json POST /api/v0/recipients/{userId}","href":"/api-reference/recipients/add-recipient"},{"title":"List recipients","openapi":"api-reference/endl-partner-api.json POST /api/v0/recipients/{userId}/all","href":"/api-reference/recipients/list-recipients"},{"title":"Get recipient","openapi":"api-reference/endl-partner-api.json GET /api/v0/recipients/{userId}/{recipientId}","href":"/api-reference/recipients/get-recipient"},{"title":"Delete recipient","openapi":"api-reference/endl-partner-api.json DELETE /api/v0/recipients/{userId}/{recipientId}","href":"/api-reference/recipients/delete-recipient"},{"title":"List supported rails","openapi":"api-reference/endl-partner-api.json GET /api/v0/recipients/{userId}/supported-rails","href":"/api-reference/recipients/list-supported-rails"},{"title":"Get counterparty checks","openapi":"api-reference/endl-partner-api.json GET /api/v0/recipients/{userId}/{recipientId}/counterparty-checks","href":"/api-reference/recipients/get-counterparty-checks"}]},{"group":"Transactions","expanded":true,"pages":[{"title":"Create pre-transaction","openapi":"api-reference/endl-partner-api.json POST /api/v0/transactions/{userId}/pre-txn","href":"/api-reference/transactions/create-pre-transaction"},{"title":"Submit transaction","openapi":"api-reference/endl-partner-api.json POST /api/v0/transactions/{userId}/submit","href":"/api-reference/transactions/submit-transaction"},{"title":"Get transaction","openapi":"api-reference/endl-partner-api.json GET /api/v0/transactions/{userId}/{txnId}","href":"/api-reference/transactions/get-transaction"},{"title":"List transactions","openapi":"api-reference/endl-partner-api.json POST /api/v0/transactions/{userId}/all","href":"/api-reference/transactions/list-transactions"},{"title":"Get transaction metadata","openapi":"api-reference/endl-partner-api.json GET /api/v0/transactions/{userId}/metadata","href":"/api-reference/transactions/get-transaction-metadata"},{"title":"List purpose codes","openapi":"api-reference/endl-partner-api.json GET /api/v0/transactions/purpose-codes","href":"/api-reference/transactions/list-purpose-codes"},{"title":"Upload invoice","openapi":"api-reference/endl-partner-api.json POST /api/v0/transactions/{userId}/invoice-upload","href":"/api-reference/transactions/upload-invoice"}]},{"group":"Cards","expanded":true,"pages":[{"title":"Cards overview","href":"/api-reference/cards/introduction"},{"title":"Enrol a customer","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{customerId}/enrollment","href":"/api-reference/cards/enroll-customer"},{"title":"Get enrolment","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/enrollment","href":"/api-reference/cards/get-enrollment"},{"title":"Add a cardholder","openapi":"api-reference/endl-cards-api.json POST /api/v0/customer/{businessId}/card-users","href":"/api-reference/cards/create-cardholder"},{"title":"List cardholders","openapi":"api-reference/endl-cards-api.json GET /api/v0/customer/{businessId}/card-users","href":"/api-reference/cards/list-cardholders"},{"title":"Get a cardholder","openapi":"api-reference/endl-cards-api.json GET /api/v0/customer/{businessId}/card-users/{cardholderId}","href":"/api-reference/cards/get-cardholder"},{"title":"Issue a card","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{cardholderId}","href":"/api-reference/cards/issue-card"},{"title":"Issue a single-use card","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{cardholderId}/single-use","href":"/api-reference/cards/issue-single-use-card"},{"title":"List cards","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}","href":"/api-reference/cards/list-cards"},{"title":"Get a card","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/{cardId}","href":"/api-reference/cards/get-card"},{"title":"Update a card","openapi":"api-reference/endl-cards-api.json PATCH /api/v0/cards/{customerId}/{cardId}","href":"/api-reference/cards/update-card"},{"title":"Freeze a card","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{customerId}/{cardId}/freeze","href":"/api-reference/cards/freeze-card"},{"title":"Unfreeze a card","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{customerId}/{cardId}/unfreeze","href":"/api-reference/cards/unfreeze-card"},{"title":"Cancel a card","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{customerId}/{cardId}/cancel","href":"/api-reference/cards/cancel-card"},{"title":"Get card details","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{customerId}/{cardId}/details","href":"/api-reference/cards/get-card-details"},{"title":"Card details encryption","href":"/api-reference/cards/encryption"},{"title":"List card transactions","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/transactions","href":"/api-reference/cards/list-card-transactions"},{"title":"Get a card transaction","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/transactions/{transactionId}","href":"/api-reference/cards/get-card-transaction"},{"title":"Get card balance","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/balance","href":"/api-reference/cards/get-card-balance"},{"title":"Get deposit instructions","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/deposit-instructions","href":"/api-reference/cards/get-deposit-instructions"},{"title":"Deposit from the Endl account","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{customerId}/deposits","href":"/api-reference/cards/create-card-deposit"},{"title":"List deposits","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/deposits","href":"/api-reference/cards/list-card-deposits"},{"title":"Get a deposit","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/deposits/{depositId}","href":"/api-reference/cards/get-card-deposit"},{"title":"Withdraw from the card balance","openapi":"api-reference/endl-cards-api.json POST /api/v0/cards/{customerId}/withdrawals","href":"/api-reference/cards/create-card-withdrawal"},{"title":"List withdrawals","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/withdrawals","href":"/api-reference/cards/list-card-withdrawals"},{"title":"Get a withdrawal","openapi":"api-reference/endl-cards-api.json GET /api/v0/cards/{customerId}/withdrawals/{withdrawalId}","href":"/api-reference/cards/get-card-withdrawal"},{"title":"Card webhook events","href":"/api-reference/cards/events"},{"title":"Card errors","href":"/api-reference/cards/errors"}]},{"group":"POBO","expanded":true,"pages":[{"title":"POBO overview","href":"/api-reference/pobo/introduction"},{"title":"Get owner","openapi":"api-reference/endl-pobo-api.json GET /api/v0/pobo/owner","href":"/api-reference/pobo/get-owner"},{"title":"Create sender","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/senders","href":"/api-reference/pobo/create-sender"},{"title":"List senders","openapi":"api-reference/endl-pobo-api.json GET /api/v0/pobo/senders","href":"/api-reference/pobo/list-senders"},{"title":"Get sender","openapi":"api-reference/endl-pobo-api.json GET /api/v0/pobo/senders/{senderId}","href":"/api-reference/pobo/get-sender"},{"title":"Delete sender","openapi":"api-reference/endl-pobo-api.json DELETE /api/v0/pobo/senders/{senderId}","description":"Delete a sender by its `snd_` reference id. Returns the sender object as it was before deletion. Later reads of that id fail.","href":"/api-reference/pobo/delete-sender"},{"title":"Create recipient","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/recipients","href":"/api-reference/pobo/create-recipient"},{"title":"List recipients","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/recipients/all","description":"A page of your POBO recipients. A `POST` because the paging and filter options travel in the body. Same shape and request rules as the standard [List recipients](/api-reference/recipients/list-recipients).","href":"/api-reference/pobo/list-recipients"},{"title":"Get recipient","openapi":"api-reference/endl-pobo-api.json GET /api/v0/pobo/recipients/{recipientId}","href":"/api-reference/pobo/get-recipient"},{"title":"Delete recipient","openapi":"api-reference/endl-pobo-api.json DELETE /api/v0/pobo/recipients/{recipientId}","href":"/api-reference/pobo/delete-recipient"},{"title":"Generate quote","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/quotes/generate","href":"/api-reference/pobo/generate-quote"},{"title":"Get quote","openapi":"api-reference/endl-pobo-api.json GET /api/v0/pobo/quotes/{quoteId}","href":"/api-reference/pobo/get-quote"},{"title":"Create pre-transaction","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/transactions/pre-txn","href":"/api-reference/pobo/create-pre-transaction"},{"title":"Submit transaction","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/transactions/submit","href":"/api-reference/pobo/submit-transaction"},{"title":"Get transaction","openapi":"api-reference/endl-pobo-api.json GET /api/v0/pobo/transactions/{txnId}","href":"/api-reference/pobo/get-transaction"},{"title":"List transactions","openapi":"api-reference/endl-pobo-api.json POST /api/v0/pobo/transactions/all","href":"/api-reference/pobo/list-transactions"}]},{"group":"Gift Cards","expanded":true,"pages":[{"title":"Giftcard API overview","href":"/giftcards/overview"},{"title":"Signing requests","href":"/giftcards/authentication"},{"title":"Conventions","href":"/giftcards/conventions"},{"title":"List products","openapi":"api-reference/endl-giftcard-api.json GET /catalog/products","href":"/giftcards/list-products"},{"title":"Create an order","openapi":"api-reference/endl-giftcard-api.json POST /orders","href":"/giftcards/create-order"},{"title":"Get an order","openapi":"api-reference/endl-giftcard-api.json GET /orders/{order_id}","href":"/giftcards/get-order"},{"title":"List orders","openapi":"api-reference/endl-giftcard-api.json GET /orders","href":"/giftcards/list-orders"},{"title":"Retrieve vouchers","openapi":"api-reference/endl-giftcard-api.json GET /orders/{order_id}/vouchers","href":"/giftcards/retrieve-vouchers"},{"title":"Order lifecycle","href":"/giftcards/lifecycle"},{"title":"Error codes","href":"/giftcards/errors"},{"title":"Worked flows","href":"/giftcards/flows"}]},{"group":"Webhooks","expanded":true,"pages":[{"title":"Webhooks overview","href":"/webhooks/overview"},{"title":"Verifying signatures","href":"/webhooks/signature-verification"},{"title":"Create subscription","openapi":"api-reference/endl-webhooks-api.json POST /api/v0/webhooks/subscriptions","href":"/webhooks/create-subscription"},{"title":"List subscriptions","openapi":"api-reference/endl-webhooks-api.json GET /api/v0/webhooks/subscriptions","href":"/webhooks/list-subscriptions"},{"title":"Get subscription","openapi":"api-reference/endl-webhooks-api.json GET /api/v0/webhooks/subscriptions/{id}","href":"/webhooks/get-subscription"},{"title":"Update subscription","openapi":"api-reference/endl-webhooks-api.json PATCH /api/v0/webhooks/subscriptions/{id}","href":"/webhooks/update-subscription"},{"title":"Delete subscription","openapi":"api-reference/endl-webhooks-api.json DELETE /api/v0/webhooks/subscriptions/{id}","href":"/webhooks/delete-subscription"},{"title":"Send event to subscription","openapi":"api-reference/endl-webhooks-api.json POST /api/v0/webhooks/subscriptions/{id}/send","href":"/webhooks/send-event"},{"title":"List deliveries","openapi":"api-reference/endl-webhooks-api.json GET /api/v0/webhooks/events","href":"/webhooks/list-deliveries"},{"title":"Get delivery","openapi":"api-reference/endl-webhooks-api.json GET /api/v0/webhooks/events/{id}","href":"/webhooks/get-delivery"},{"title":"Retry delivery","openapi":"api-reference/endl-webhooks-api.json POST /api/v0/webhooks/events/{id}/retry","href":"/webhooks/retry-delivery"},{"title":"Read the PULL feed","openapi":"api-reference/endl-webhooks-api.json GET /api/v0/events","href":"/webhooks/pull-events"},{"title":"Pagination","href":"/webhooks/pagination"},{"title":"Errors and response envelope","href":"/webhooks/errors"},{"title":"Reference","href":"/webhooks/reference"}]}]}]}]},"basePath":"","title":"Create recipient - Endl API","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}