A payment link delegates the payment interface to iMoney Encaissement: you redirect your customer to a hosted payment page, where they choose their payment method and confirm. It is the API equivalent of the link created from the dashboard. The response returns page_url, the page to send to the payer (redirection, email, SMS, social network).
Never treat the customer’s redirection as a payment confirmation: check the state of the link on the server side, with Retrieve a payment link or a webhook, before delivering an order.
Authentication. Keys and the Sandbox or Live choice follow the same rules as the rest of the API: see Authentication.
reference. If you provide it rather than letting the API generate it, it becomes the identifier used to check the state of the link through Retrieve a payment link, an unauthenticated operation. Generate a random, high-entropy value, never a sequential or predictable order identifier. Letting the API generate it avoids this risk.
Redirections. Both redirect URLs must use HTTPS: an HTTP URL is rejected.
Expiration. A link created through the API always expires thirty minutes after its creation, whatever value is sent in shouldExpire. Send the link to your customer right away, and create a new one rather than sharing an old link again.
Duplicates. A second creation with the same manually provided reference fails validation (422): the reference must stay unique on your account. There is no idempotency key; no guarantee is documented for concurrent calls (to be confirmed with support). An account that is not found or inactive for the target environment returns 404.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"iMoney Encaissement","description":"Documentation développeur officielle iMoney Encaissement","colors":{"primary":"#aac32e","light":"#c7df54","dark":"#7f941e"},"logo":{"light":"https://mintcdn.com/i-futur/BHX1WwpwbqNqmKjO/logo.png?fit=max\u0026auto=format\u0026n=BHX1WwpwbqNqmKjO\u0026q=85\u0026s=b87349c125edeba3ed435b9f0921be9b","dark":"https://mintcdn.com/i-futur/BHX1WwpwbqNqmKjO/logo.png?fit=max\u0026auto=format\u0026n=BHX1WwpwbqNqmKjO\u0026q=85\u0026s=b87349c125edeba3ed435b9f0921be9b"},"favicon":"https://mintcdn.com/i-futur/B4pwgot3NJ9hWojt/favicon.png?fit=max\u0026auto=format\u0026n=B4pwgot3NJ9hWojt\u0026q=85\u0026s=449e5a54e45513db6da435c93e052311","api":{"openapi":["openapi.yaml","en/openapi.yaml"],"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","javascript","python","php","ruby","java"],"prefill":true}},"background":{"color":{"light":"#ffffff","dark":"#0e1110"}},"navbar":{"links":[{"href":"https://i-pay.money","label":"Site iMoney Encaissement"}],"primary":{"type":"button","label":"Se connecter","href":"https://i-pay.money/dashboard"}},"footer":{"socials":{"website":"https://i-pay.money"}},"fonts":{"heading":{"family":"Open Sans","weight":700},"body":{"family":"Open Sans","weight":400}},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"navigation":{"languages":[{"language":"fr","default":true,"href":""},{"language":"en","navbar":{"links":[{"href":"https://i-pay.money","label":"iMoney Encaissement website"}],"primary":{"type":"button","label":"Log in","href":"https://i-pay.money/dashboard"}},"href":"en"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"i-futur","hasAudioNarration":false,"actualSubdomain":"i-futur","customDomains":["docs.i-pay.money"],"gitSource":{"type":"github","owner":"ifuturteam","repo":"ipay-money-documentation","deployBranch":"main","contentDirectory":"docs/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"e5c6e1b2-6f21-4adc-876d-3cd3c85ddc57","liveDeploymentHistoryId":"6ae39784e26a02b8d44a54be","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae39784e26a02b8d44a54be"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae39784e26a02b8d44a54be","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"fr","tag":"Référence API","count":7},{"language":"fr","tag":"Documentation","count":7},{"language":"en","tag":"API reference","count":7},{"language":"en","tag":"Documentation","count":7},{"language":"fr","tag":"SDKs","count":4},{"language":"fr","tag":"SDKs et plugins","count":4},{"language":"en","tag":"SDKs","count":4},{"language":"en","tag":"SDKs and plugins","count":4},{"language":"fr","tag":"Transactions","count":3},{"language":"fr","tag":"Guides","count":3},{"language":"en","tag":"Transactions","count":3},{"language":"en","tag":"Guides","count":3},{"language":"fr","tag":"Introduction","count":2},{"language":"fr","tag":"Liens de paiement","count":2},{"language":"fr","tag":"Démarrer","count":2},{"language":"fr","tag":"Ressources","count":2},{"language":"en","tag":"Introduction","count":2},{"language":"en","tag":"Payment by link","count":2},{"language":"en","tag":"Get started","count":2},{"language":"en","tag":"Resources","count":2}]},"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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--ipay-line:#ecece7;--ipay-line-strong:#ddddd6;--ipay-panel:#fafaf8;--ipay-primary:#bbcb44;--ipay-primary-hover:#a3b339;--ipay-primary-soft:#f2f6d6;--ipay-primary-ink:#5e6a1a}.dark{--ipay-line:#2d302b;--ipay-line-strong:#525249;--ipay-panel:#1a1d1f;--ipay-primary-soft:#2d331c;--ipay-primary-ink:#e4ecaa}#search-bar-entry{background:var(--ipay-panel);border:1px solid var(--ipay-line-strong);border-radius:999px;transition:border-color .15s ease,box-shadow .15s ease}#search-bar-entry:hover{border-color:var(--ipay-primary-hover)}#search-bar-entry:focus-within{border-color:var(--ipay-primary-hover);box-shadow:0 0 0 4px var(--ipay-primary-soft)}.prose a:not([class*=card]){color:var(--ipay-primary-ink);font-weight:600;text-underline-offset:3px}.prose table{border:1px solid var(--ipay-line);border-collapse:separate;border-radius:10px;border-spacing:0;overflow:hidden}.prose thead th{background:var(--ipay-panel);font-size:12px;letter-spacing:.04em;text-transform:uppercase}.prose td,.prose th{border-bottom:1px solid var(--ipay-line)}.prose pre,code-block{border:1px solid var(--ipay-line);border-radius:14px}#sidebar a[data-active=true],#sidebar li[data-active=true]>a{background:var(--ipay-primary-soft);border-radius:8px;color:var(--ipay-primary-ink)}"}],"page":{"pagePath":"en/api-reference/payment-by-link/create-a-payment-link","slug":"/en/api-reference/payment-by-link/create-a-payment-link","pageMetadata":{"title":"Create a hosted payment link","description":"Create a payment page hosted by iMoney Encaissement and share its URL with your customer.","openapi":"en/openapi.yaml POST /external_payments","href":"/en/api-reference/payment-by-link/create-a-payment-link"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a payment page hosted by iMoney Encaissement and share its URL with your customer.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`A payment link delegates the payment interface to iMoney Encaissement: you redirect your customer to a hosted payment page, where they choose their `,_jsx(_components.a,{href:`/en/guides/payouts-and-fees#fees-by-payment-method`,children:`payment method`}),` and confirm. It is the API equivalent of the link created from the dashboard. The response returns `,_jsx(_components.code,{children:`page_url`}),`, the page to send to the payer (redirection, email, SMS, social network).`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Never treat the customer’s redirection as a payment confirmation: check the state of the link on the server side, with `,_jsx(_components.a,{href:`/en/api-reference/payment-by-link/retrieve-a-payment-link`,children:`Retrieve a payment link`}),` or a `,_jsx(_components.a,{href:`/en/guides/webhooks`,children:`webhook`}),`, before delivering an order.`]})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Authentication.`}),` Keys and the Sandbox or Live choice follow the same rules as the rest of the API: see `,_jsx(_components.a,{href:`/en/api-reference/authentication`,children:`Authentication`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`reference`}),`.`]}),` If you provide it rather than letting the API generate it, it becomes the identifier used to check the state of the link through `,_jsx(_components.a,{href:`/en/api-reference/payment-by-link/retrieve-a-payment-link`,children:`Retrieve a payment link`}),`, an unauthenticated operation. Generate a random, high-entropy value, never a sequential or predictable order identifier. Letting the API generate it avoids this risk.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Redirections.`}),` Both redirect URLs must use HTTPS: an HTTP URL is rejected.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Expiration.`}),` A link created through the API always expires thirty minutes after its creation, whatever value is sent in `,_jsx(_components.code,{children:`shouldExpire`}),`. Send the link to your customer right away, and create a new one rather than sharing an old link again.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Duplicates.`}),` A second creation with the same manually provided `,_jsx(_components.code,{children:`reference`}),` fails validation (`,_jsx(_components.code,{children:`422`}),`): the reference must stay unique on your account. There is no idempotency key; no guarantee is documented for concurrent calls (to be confirmed with support). An account that is not found or inactive for the target environment returns `,_jsx(_components.code,{children:`404`}),`.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Common error messages: `,_jsx(_components.a,{href:`/en/api-reference/errors`,children:`Errors`}),`.`]})]})}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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Create a hosted payment link","description":"Create a payment page hosted by iMoney Encaissement and share its URL with your customer.","openapi":"en/openapi.yaml POST /external_payments","href":"/en/api-reference/payment-by-link/create-a-payment-link"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payment links"],"summary":"Create a hosted payment link","security":["3d7bdb9f-c7ea-4358-be72-fc76db0c1404"],"parameters":["57e06632-582d-4685-ac30-55d26bdfa288","19943699-1f89-4572-a119-72be30bf5192"],"requestBody":"85e1ec76-875f-4cbd-898f-a798a9a2c9cc","responses":{"200":"712951c3-09c3-4172-b321-9aabd55ae53b","404":"efa12ea2-fe0e-47e8-a15c-3434788469c3","422":"e6885532-bce6-4a47-9623-0ce18bc59f33"},"method":"post","type":"path","servers":["820a75b7-831d-4f45-b1c4-53eb207fe3fc"],"path":"/external_payments","baseUrlOptions":["https://i-pay.money/api/v1"],"title":"Create a hosted payment link","description":"Create a payment page hosted by iMoney Encaissement and share its URL with your customer.","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php","ruby","java"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.title":"Order #1001","body.description":"Transaction for order #1001","body.amount.oneOf.0":15000,"body.on_success_redirection_url":"https://your-site.com/orders/1001/success","body.on_failed_redirection_url":"https://your-site.com/orders/1001/failure"}]},"dependencies":{"parameters":{"57e06632-582d-4685-ac30-55d26bdfa288":{"name":"Ipay-Target-Environment","in":"header","required":true,"schema":{"type":"string","enum":["sandbox","live"],"isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"19943699-1f89-4572-a119-72be30bf5192":{"name":"Ipay-Payment-Type","in":"header","required":true,"schema":{"type":"string","const":"external_payment","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"amount":{"oneOf":[{"type":"integer","minimum":50,"uniqueKey":"amount.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":50,"uniqueKey":"amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount","typeLabel":"integer | null"},"reference":{"type":"string","minLength":32,"description":"Omit for automatic generation, or provide a private random value of at least 128 bits.","uniqueKey":"reference","typeLabel":"string"},"shouldExpire":{"type":"boolean","const":true,"default":true,"description":"The current v1 always creates an expiring link.","uniqueKey":"shouldExpire","typeLabel":"boolean"},"on_success_redirection_url":{"type":"string","format":"uri","pattern":"^https://","uniqueKey":"on_success_redirection_url","typeLabel":"string\u003curi>"},"on_failed_redirection_url":{"type":"string","format":"uri","pattern":"^https://","uniqueKey":"on_failed_redirection_url","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"orderLink":{"title":"orderLink","value":{"title":"Order #1001","description":"Transaction for order #1001","amount":15000,"on_success_redirection_url":"https://your-site.com/orders/1001/success","on_failed_redirection_url":"https://your-site.com/orders/1001/failure"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"712951c3-09c3-4172-b321-9aabd55ae53b":{"description":"Link created","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","uniqueKey":"title","typeLabel":"string"},"amount":{"oneOf":[{"type":"integer","uniqueKey":"amount.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount","typeLabel":"integer | null"},"reference":{"type":"string","uniqueKey":"reference","typeLabel":"string"},"status":{"type":"string","example":"initiated","uniqueKey":"status","typeLabel":"string"},"should_expire":{"type":"boolean","uniqueKey":"should_expire","typeLabel":"boolean"},"page_url":{"type":"string","format":"uri","uniqueKey":"page_url","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","amount":123,"reference":"\u003cstring>","status":"initiated","should_expire":true,"page_url":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"efa12ea2-fe0e-47e8-a15c-3434788469c3":{"description":"Account not found or inactive","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","description":"Only present on some application failures, e.g. a duplicate payment on `POST /payments`, where `status` is always `failed`. Absent from the other errors of this contract (e.g. 404 `Payment Not Found`, header/authentication errors).","x-verified":"Internal verification note (not intended for the public documentation). See `Live::PaymentService#error_response` (app/services/live/payment_service.rb:994-1005).","example":"failed","uniqueKey":"status","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","status":"failed"}}},"exampleType":"generated"}},"exampleType":"generated"},"e6885532-bce6-4a47-9623-0ce18bc59f33":{"description":"Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3d7bdb9f-c7ea-4358-be72-fc76db0c1404":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Secret key of the Sandbox or Live account","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"820a75b7-831d-4f45-b1c4-53eb207fe3fc":{"url":"https://i-pay.money/api/v1","description":"Sandbox or Live depending on the headers and the key used"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Secret key of the Sandbox or Live account","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Secret key of the Sandbox or Live account","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"en/openapi.yaml"},"subdomain":"i-futur","siteName":"iMoney Encaissement","title":"Create a hosted payment link - iMoney Encaissement","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"fr":{"href":"/","matchLevel":4},"en":{"href":"/en/api-reference/payment-by-link/create-a-payment-link","matchLevel":0}}},"lastModified":"2026-10-29T18:59:23.327Z","originalFileLocation":"en/api-reference/payment-by-link/create-a-payment-link.mdx","locale":"en"},"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 payment page hosted by iMoney Encaissement and share its URL with your customer.\">\u003cmeta data-mint-head name=\"application-name\" content=\"iMoney Encaissement\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/i-futur/kyXVeG45fkp622Ap/_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/i-futur/kyXVeG45fkp622Ap/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/i-futur/kyXVeG45fkp622Ap/_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/i-futur/kyXVeG45fkp622Ap/_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/i-futur/kyXVeG45fkp622Ap/_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/i-futur/kyXVeG45fkp622Ap/_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/i-futur/kyXVeG45fkp622Ap/_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/i-futur/kyXVeG45fkp622Ap/_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/i-futur/kyXVeG45fkp622Ap/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a hosted payment link - iMoney Encaissement\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a payment page hosted by iMoney Encaissement and share its URL with your customer.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"iMoney Encaissement\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://i-futur.mintlify.app/_mintlify/api/og/v2?division=Payment+by+link\u0026amp;title=Create+a+hosted+payment+link\u0026amp;description=Create+a+payment+page+hosted+by+iMoney+Encaissement+and+share+its+URL+with+your+customer.\u0026amp;theme=4af5335503ff29411be4ba64\u0026amp;signature=9ef0c4c02f845e09bc2cb3ec579c8754efd08c1aad31411c36f9c897b53caba3\">\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 a hosted payment link - iMoney Encaissement\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a payment page hosted by iMoney Encaissement and share its URL with your customer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://i-futur.mintlify.app/_mintlify/api/og/v2?division=Payment+by+link\u0026amp;title=Create+a+hosted+payment+link\u0026amp;description=Create+a+payment+page+hosted+by+iMoney+Encaissement+and+share+its+URL+with+your+customer.\u0026amp;theme=4af5335503ff29411be4ba64\u0026amp;signature=9ef0c4c02f845e09bc2cb3ec579c8754efd08c1aad31411c36f9c897b53caba3\">\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/i-futur/kyXVeG45fkp622Ap/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"iMoney Encaissement\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#aac32e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/payment-by-link/create-a-payment-link.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.i-pay.money/#organization\",\"name\":\"iMoney Encaissement\",\"url\":\"https://docs.i-pay.money\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/i-futur/BHX1WwpwbqNqmKjO/logo.png?fit=max\u0026auto=format\u0026n=BHX1WwpwbqNqmKjO\u0026q=85\u0026s=b87349c125edeba3ed435b9f0921be9b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.i-pay.money#website\",\"name\":\"iMoney Encaissement\",\"url\":\"https://docs.i-pay.money\",\"publisher\":{\"@id\":\"https://docs.i-pay.money/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link#webpage\",\"url\":\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link\",\"name\":\"Create a hosted payment link\",\"description\":\"Create a payment page hosted by iMoney Encaissement and share its URL with your customer.\",\"dateModified\":\"2026-10-29T18:59:23.327Z\",\"isPartOf\":{\"@id\":\"https://docs.i-pay.money#website\"},\"breadcrumb\":{\"@id\":\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"iMoney Encaissement\",\"item\":\"https://docs.i-pay.money\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a hosted payment link\",\"item\":\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link#apireference\",\"headline\":\"Create a hosted payment link\",\"name\":\"Create a hosted payment link\",\"description\":\"Create a payment page hosted by iMoney Encaissement and share its URL with your customer.\",\"url\":\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link\",\"mainEntityOfPage\":{\"@id\":\"https://docs.i-pay.money/en/api-reference/payment-by-link/create-a-payment-link#webpage\"},\"dateModified\":\"2026-10-29T18:59:23.327Z\",\"publisher\":{\"@id\":\"https://docs.i-pay.money/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.i-pay.money#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"iMoney Encaissement\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"iMoney Encaissement","nav":{"global":null,"languages":[{"language":"fr","default":true,"pages":[{"title":"fr","href":"/"}]},{"language":"en","navbar":{"links":[{"href":"https://i-pay.money","label":"iMoney Encaissement website"}],"primary":{"type":"button","label":"Log in","href":"https://i-pay.money/dashboard"}},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/en"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/en/sdks"}]},{"tab":"API reference","groups":[{"group":"Introduction","pages":[{"title":"Authentication","href":"/en/api-reference/authentication"},{"title":"Errors","href":"/en/api-reference/errors"}]},{"group":"Transactions","pages":[{"title":"Create a transaction","openapi":"en/openapi.yaml POST /payments","href":"/en/api-reference/transactions/create-a-payment"},{"title":"Retrieve a transaction","openapi":"en/openapi.yaml GET /payments/{reference}","href":"/en/api-reference/transactions/retrieve-a-payment"},{"title":"List transactions","description":"List the account's transactions with filters, for an overview or reconciliation.","openapi":"en/openapi.yaml GET /payments","href":"/en/api-reference/transactions/list-payments"}]},{"group":"Payment by link","pages":[{"title":"Create a hosted payment link","openapi":"en/openapi.yaml POST /external_payments","href":"/en/api-reference/payment-by-link/create-a-payment-link"},{"title":"Retrieve a payment link","description":"Read the state of a payment link from its reference. No key is required.","openapi":"en/openapi.yaml GET /external_payments/{reference}","href":"/en/api-reference/payment-by-link/retrieve-a-payment-link"}]}]}]}]},"title":"Create a hosted payment link - iMoney Encaissement","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}