{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Quidkey Docs","colors":{"primary":"#3A81FF","light":"#CEDFFF","dark":"#3A81FF"},"logo":{"light":"https://mintcdn.com/quidkey/7NkUiKnWcUGlDJSA/logo/light.svg?fit=max\u0026auto=format\u0026n=7NkUiKnWcUGlDJSA\u0026q=85\u0026s=1067f2a5004e7edba3ebd43a16c921cc","dark":"https://mintcdn.com/quidkey/7NkUiKnWcUGlDJSA/logo/dark.svg?fit=max\u0026auto=format\u0026n=7NkUiKnWcUGlDJSA\u0026q=85\u0026s=2b8257584b646c3ad15e653130392022"},"favicon":"https://storage.googleapis.com/quidkey-resources-public/quidkey-logo-fav.png","api":{"playground":{"display":"interactive","proxy":true}},"navbar":{"links":[{"href":"mailto:rabea@quidkey.com","label":"Support"}],"primary":{"type":"button","label":"Get Started","href":"https://console.quidkey.com"}},"footer":{"socials":{"x":"https://x.com/quidkeyHQ","github":"https://github.com/quidkey","linkedin":"https://linkedin.com/company/quidkey"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://quidkey.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"quidkey","hasAudioNarration":false,"actualSubdomain":"quidkey","customDomains":["docs.quidkey.com"],"gitSource":{"type":"github","owner":"banqzinc","repo":"quidkey-monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb4128b21018c2553e2a3b","collectionId":"b0313419-cbf9-46ab-90c3-dc4cc758e8ab","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb4128b21018c2553e2a3b"},"entitlements":{},"buildId":"6aee6f35f538f2c21575de14","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Payment API","count":24},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"API reference","count":13},{"language":"default","tag":"Core concepts","count":6},{"language":"default","tag":"Payment Links","count":6},{"language":"default","tag":"API Reference","count":4},{"language":"default","tag":"Embedded Flow (with Stripe)","count":4},{"language":"default","tag":"Getting started","count":3},{"language":"default","tag":"Accept a payment","count":3},{"language":"default","tag":"Get started","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow","slug":"/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow","pageMetadata":{"title":"Create a payment request via the redirect (Pay by Bank) flow","description":"Create a payment request via the redirect (Pay by Bank) flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/payment-requests:redirect","href":"/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow","autogeneratedByOpenApi":true},"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 request via the redirect (Pay by Bank) flow\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a payment request via the redirect (Pay by Bank) flow","description":"Create a payment request via the redirect (Pay by Bank) flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/payment-requests:redirect","href":"/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payments"],"summary":"Create a payment request via the redirect (Pay by Bank) flow","description":"Create a payment request via the redirect (Pay by Bank) flow","responses":{"201":"97db30f4-ea76-43f0-9f42-1a043f17d9d5","400":"2f8f0b46-cbc8-495a-b2e3-00c0afd7f83a","401":"1ec932a1-c073-455b-84c6-ad3553d1c3d7"},"security":["3756f92f-3f2c-48a8-b5c6-f784a37e87f3"],"requestBody":"f0756e07-a6a7-4a32-b1a2-025e537722cd","method":"post","type":"path","servers":["514eb494-9a9e-4dbf-9142-612db55608b1"],"path":"/api/v1/payment-requests:redirect","baseUrlOptions":["https://core.quidkey.com"],"title":"Create a payment request via the redirect (Pay by Bank) flow","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"description":"Strict input parameters for the redirect (Pay by Bank) payment request","content":{"application/json":{"schema":{"title":"Redirect Payment Request Input","description":"Strict input parameters for the redirect (Pay by Bank) payment request","additionalProperties":false,"type":"object","required":["customer","billing_address","amount","currency","locale"],"properties":{"customer":{"title":"Redirect Customer Input","description":"Customer information for the redirect payment request","additionalProperties":false,"type":"object","required":["name","email"],"properties":{"name":{"description":"The name of the customer","examples":["John Doe"],"type":"string","isRequired":true,"uniqueKey":"customer.name","typeLabel":"string"},"email":{"format":"email","description":"The email of the customer","examples":["john.doe@example.com"],"type":"string","isRequired":true,"uniqueKey":"customer.email","typeLabel":"string\u003cemail>"},"phone_number":{"description":"The phone number of the customer","examples":["+447123456789"],"type":"string","uniqueKey":"customer.phone_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"customer","typeLabel":"Redirect Customer Input · object"},"billing_address":{"title":"Address","description":"A physical address","additionalProperties":false,"type":"object","required":["address_line1","city","country","postal_code"],"properties":{"address_line1":{"description":"The first line of the address","examples":["12 West Common Drive"],"type":"string","isRequired":true,"uniqueKey":"billing_address.address_line1","typeLabel":"string"},"city":{"description":"The city","examples":["London"],"type":"string","isRequired":true,"uniqueKey":"billing_address.city","typeLabel":"string"},"country":{"pattern":"^[A-Za-z]{2}$","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country code","examples":["GB","US","FR","DE"],"type":"string","isRequired":true,"uniqueKey":"billing_address.country","typeLabel":"string"},"postal_code":{"description":"The postal code","examples":["SE1 1AA"],"type":"string","isRequired":true,"uniqueKey":"billing_address.postal_code","typeLabel":"string"},"address_line2":{"description":"The second line of the address","examples":["Flat 1"],"type":"string","uniqueKey":"billing_address.address_line2","typeLabel":"string"},"apartment":{"description":"The apartment, unit, or suite number","examples":["Apt 5B","Unit 12","Suite 200"],"type":"string","uniqueKey":"billing_address.apartment","typeLabel":"string"},"state_province":{"description":"The state or province","examples":["Greater London"],"type":"string","uniqueKey":"billing_address.state_province","typeLabel":"string"},"company_name":{"description":"The company name (if applicable)","examples":["Acme Ltd"],"type":"string","uniqueKey":"billing_address.company_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"billing_address","typeLabel":"Address · object"},"amount":{"minimum":1,"maximum":9999999,"description":"Minor-unit amount (e.g. pence/cents). Decimals are rejected.","examples":[1999],"type":"integer","isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"currency":{"pattern":"^[A-Za-z]{3}$","minLength":3,"maxLength":3,"description":"The currency of the payment request","examples":["GBP","USD","EUR","JPY"],"type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"locale":{"description":"The locale of the payment request","examples":["en_GB"],"type":"string","isRequired":true,"uniqueKey":"locale","typeLabel":"string"},"merchant_id":{"format":"uuid","description":"Merchant ID. Defaults to the logged-in merchant if not provided. Required for admin tokens.","examples":["550e8400-e29b-41d4-a716-446655440000"],"type":"string","uniqueKey":"merchant_id","typeLabel":"string\u003cuuid>"},"payment_reference":{"description":"Payment reference to appear on the payer’s bank statement (max 18 alphanumeric characters)","examples":["ORDER123"],"maxLength":18,"pattern":"^[A-Za-z0-9]{1,18}$","type":"string","uniqueKey":"payment_reference","typeLabel":"string"},"order_id":{"description":"The unique identifier for the merchant's order","examples":["1140"],"type":"string","uniqueKey":"order_id","typeLabel":"string"},"success_url_redirect":{"description":"URL to redirect on successful payment","examples":["https://storename.com/success"],"type":"string","uniqueKey":"success_url_redirect","typeLabel":"string"},"fail_url_redirect":{"description":"URL to redirect on failed payment","examples":["https://storename.com/failure"],"type":"string","uniqueKey":"fail_url_redirect","typeLabel":"string"},"test_transaction":{"description":"Flag for test transactions","examples":[false],"type":"boolean","uniqueKey":"test_transaction","typeLabel":"boolean"},"selected_bank_id":{"description":"Selected bank reference","examples":["38c39d03-8df3-4980-b0a8-7e283c8c62dd"],"type":"string","uniqueKey":"selected_bank_id","typeLabel":"string"},"simulation":{"additionalProperties":false,"description":"Sandbox simulation config. Honoured only when the upstream provider is a fake/sandbox backend; live providers ignore it.","type":"object","properties":{"straddle":{"additionalProperties":false,"type":"object","properties":{"customer_outcome":{"oneOf":[{"type":"string","description":"Simulated identity verification outcome","const":"standard","uniqueKey":"simulation.straddle.customer_outcome.oneOf.0","typeLabel":"string"},{"type":"string","description":"Simulated identity verification outcome","const":"verified","uniqueKey":"simulation.straddle.customer_outcome.oneOf.1","typeLabel":"string"},{"type":"string","description":"Simulated identity verification outcome","const":"rejected","uniqueKey":"simulation.straddle.customer_outcome.oneOf.2","typeLabel":"string"},{"type":"string","description":"Simulated identity verification outcome","const":"review","uniqueKey":"simulation.straddle.customer_outcome.oneOf.3","typeLabel":"string"}],"uniqueKey":"simulation.straddle.customer_outcome","typeLabel":"string"},"paykey_outcome":{"oneOf":[{"type":"string","description":"Simulated bank account link outcome","const":"standard","uniqueKey":"simulation.straddle.paykey_outcome.oneOf.0","typeLabel":"string"},{"type":"string","description":"Simulated bank account link outcome","const":"active","uniqueKey":"simulation.straddle.paykey_outcome.oneOf.1","typeLabel":"string"},{"type":"string","description":"Simulated bank account link outcome","const":"rejected","uniqueKey":"simulation.straddle.paykey_outcome.oneOf.2","typeLabel":"string"}],"uniqueKey":"simulation.straddle.paykey_outcome","typeLabel":"string"},"charge_outcome":{"oneOf":[{"type":"string","description":"Simulated charge outcome","const":"standard","uniqueKey":"simulation.straddle.charge_outcome.oneOf.0","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"paid","uniqueKey":"simulation.straddle.charge_outcome.oneOf.1","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"on_hold_daily_limit","uniqueKey":"simulation.straddle.charge_outcome.oneOf.2","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"cancelled_for_fraud_risk","uniqueKey":"simulation.straddle.charge_outcome.oneOf.3","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"cancelled_for_balance_check","uniqueKey":"simulation.straddle.charge_outcome.oneOf.4","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"failed_insufficient_funds","uniqueKey":"simulation.straddle.charge_outcome.oneOf.5","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"reversed_insufficient_funds","uniqueKey":"simulation.straddle.charge_outcome.oneOf.6","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"failed_customer_dispute","uniqueKey":"simulation.straddle.charge_outcome.oneOf.7","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"reversed_customer_dispute","uniqueKey":"simulation.straddle.charge_outcome.oneOf.8","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"failed_closed_bank_account","uniqueKey":"simulation.straddle.charge_outcome.oneOf.9","typeLabel":"string"},{"type":"string","description":"Simulated charge outcome","const":"reversed_closed_bank_account","uniqueKey":"simulation.straddle.charge_outcome.oneOf.10","typeLabel":"string"}],"uniqueKey":"simulation.straddle.charge_outcome","typeLabel":"string"},"balance_check":{"oneOf":[{"type":"string","description":"Balance verification behaviour","const":"required","uniqueKey":"simulation.straddle.balance_check.oneOf.0","typeLabel":"string"},{"type":"string","description":"Balance verification behaviour","const":"enabled","uniqueKey":"simulation.straddle.balance_check.oneOf.1","typeLabel":"string"},{"type":"string","description":"Balance verification behaviour","const":"disabled","uniqueKey":"simulation.straddle.balance_check.oneOf.2","typeLabel":"string"}],"uniqueKey":"simulation.straddle.balance_check","typeLabel":"string"}},"uniqueKey":"simulation.straddle","typeLabel":"object"},"flinks":{"additionalProperties":false,"type":"object","properties":{"outcome":{"oneOf":[{"type":"string","description":"Simulated bank-linking lifecycle and data shape","const":"happy","uniqueKey":"simulation.flinks.outcome.oneOf.0","typeLabel":"string"},{"type":"string","description":"Simulated bank-linking lifecycle and data shape","const":"async","uniqueKey":"simulation.flinks.outcome.oneOf.1","typeLabel":"string"},{"type":"string","description":"Simulated bank-linking lifecycle and data shape","const":"no_us_account","uniqueKey":"simulation.flinks.outcome.oneOf.2","typeLabel":"string"},{"type":"string","description":"Simulated bank-linking lifecycle and data shape","const":"partial_data","uniqueKey":"simulation.flinks.outcome.oneOf.3","typeLabel":"string"},{"type":"string","description":"Simulated bank-linking lifecycle and data shape","const":"webhook_only","uniqueKey":"simulation.flinks.outcome.oneOf.4","typeLabel":"string"},{"type":"string","description":"Simulated bank-linking lifecycle and data shape","const":"rate_limit","uniqueKey":"simulation.flinks.outcome.oneOf.5","typeLabel":"string"},{"type":"string","description":"Simulated bank-linking lifecycle and data shape","const":"unreachable","uniqueKey":"simulation.flinks.outcome.oneOf.6","typeLabel":"string"}],"uniqueKey":"simulation.flinks.outcome","typeLabel":"string"},"account":{"additionalProperties":false,"type":"object","required":["total"],"properties":{"total":{"minimum":1,"description":"Total accounts to return","type":"number","isRequired":true,"uniqueKey":"simulation.flinks.account.total","typeLabel":"number"},"existing":{"description":"Ids of existing accounts to include; (total - existing.length) new ones are minted","type":"array","items":{"type":"string","uniqueKey":"simulation.flinks.account.existing.items.[INDEX]","typeLabel":"string"},"uniqueKey":"simulation.flinks.account.existing","typeLabel":"string[]"}},"uniqueKey":"simulation.flinks.account","typeLabel":"object"},"mfa":{"oneOf":[{"type":"string","description":"Whether an MFA challenge is presented and how it is answered","const":"skip","uniqueKey":"simulation.flinks.mfa.oneOf.0","typeLabel":"string"},{"type":"string","description":"Whether an MFA challenge is presented and how it is answered","const":"correct","uniqueKey":"simulation.flinks.mfa.oneOf.1","typeLabel":"string"},{"type":"string","description":"Whether an MFA challenge is presented and how it is answered","const":"wrong","uniqueKey":"simulation.flinks.mfa.oneOf.2","typeLabel":"string"}],"uniqueKey":"simulation.flinks.mfa","typeLabel":"string"}},"uniqueKey":"simulation.flinks","typeLabel":"object"}},"uniqueKey":"simulation","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Redirect Payment Request Input · object"},"example":{"merchant_id":"550e8400-e29b-41d4-a716-446655440000","customer":{"name":"John Doe","email":"john.doe@example.com","phone_number":"+447123456789"},"billing_address":{"address_line1":"12 West Common Drive","address_line2":"Flat 1","apartment":"Apt 5B","city":"London","state_province":"Greater London","country":"GB","postal_code":"SE1 1AA","company_name":"Acme Ltd"},"amount":1999,"currency":"GBP","payment_reference":"ORDER123","order_id":"1140","locale":"en_GB","success_url_redirect":"https://storename.com/success","fail_url_redirect":"https://storename.com/failure","test_transaction":false,"selected_bank_id":"38c39d03-8df3-4980-b0a8-7e283c8c62dd","simulation":{"straddle":{"customer_outcome":"standard","paykey_outcome":"standard","charge_outcome":"standard","balance_check":"required"},"flinks":{"outcome":"happy","mfa":"skip"}}},"examples":{"Example":{"title":"Example","value":{"merchant_id":"550e8400-e29b-41d4-a716-446655440000","customer":{"name":"John Doe","email":"john.doe@example.com","phone_number":"+447123456789"},"billing_address":{"address_line1":"12 West Common Drive","address_line2":"Flat 1","apartment":"Apt 5B","city":"London","state_province":"Greater London","country":"GB","postal_code":"SE1 1AA","company_name":"Acme Ltd"},"amount":1999,"currency":"GBP","payment_reference":"ORDER123","order_id":"1140","locale":"en_GB","success_url_redirect":"https://storename.com/success","fail_url_redirect":"https://storename.com/failure","test_transaction":false,"selected_bank_id":"38c39d03-8df3-4980-b0a8-7e283c8c62dd","simulation":{"straddle":{"customer_outcome":"standard","paykey_outcome":"standard","charge_outcome":"standard","balance_check":"required"},"flinks":{"outcome":"happy","mfa":"skip"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"97db30f4-ea76-43f0-9f42-1a043f17d9d5":{"description":"Created","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"description":"Indicates if the request was successful","examples":[true],"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"title":"Redirect Payment Request Data","description":"Redirect payment request response data","additionalProperties":false,"type":"object","required":["redirect_url"],"properties":{"redirect_url":{"description":"URL to redirect the customer to in order to complete payment","examples":["https://example.com/redirect"],"type":"string","isRequired":true,"uniqueKey":"data.redirect_url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data","typeLabel":"Redirect Payment Request Data · object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"redirect_url":"https://example.com/redirect"}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"redirect_url":"https://example.com/redirect"}}}},"exampleType":"examples"}},"exampleType":"examples"},"2f8f0b46-cbc8-495a-b2e3-00c0afd7f83a":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Bad Request Error","description":"400 Bad Request Error Response","type":"object","required":["success","error"],"properties":{"success":{"description":"Always false for error responses","examples":[false],"const":false,"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code for the specific error type","example":"VALIDATION_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"Human-readable error message","examples":["Invalid input provided"],"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"metadata":{"additionalProperties":true,"description":"Additional error context. For VALIDATION_ERROR, includes a per-field `errors` array.","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.metadata.errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.metadata.errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.metadata.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.metadata.errors","typeLabel":"object[]"}},"uniqueKey":"error.metadata","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Bad Request Error · object"},"example":{"success":false,"error":{"message":"Invalid input provided"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"message":"Invalid input provided"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1ec932a1-c073-455b-84c6-ad3553d1c3d7":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"Unauthorized Error","description":"401 Unauthorized Error Response","type":"object","required":["success","error"],"properties":{"success":{"description":"Always false for error responses","examples":[false],"const":false,"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code for the specific error type","const":"UNAUTHORIZED","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"Human-readable error message","examples":["Invalid input provided"],"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Unauthorized Error · object"},"example":{"success":false,"error":{"message":"Invalid input provided"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"message":"Invalid input provided"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3756f92f-3f2c-48a8-b5c6-f784a37e87f3":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"514eb494-9a9e-4dbf-9142-612db55608b1":{"url":"https://core.quidkey.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"quidkey","siteName":"Quidkey Docs","title":"Create a payment request via the redirect (Pay by Bank) flow - Quidkey Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T14:29:01.344Z","originalFileLocation":"api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow.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 payment request via the redirect (Pay by Bank) flow\">\u003cmeta data-mint-head name=\"application-name\" content=\"Quidkey Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://storage.googleapis.com/quidkey-resources-public/quidkey-logo-fav.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://storage.googleapis.com/quidkey-resources-public/quidkey-logo-fav.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://storage.googleapis.com/quidkey-resources-public/quidkey-logo-fav.png\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://storage.googleapis.com/quidkey-resources-public/quidkey-logo-fav.png\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a payment request via the redirect (Pay by Bank) flow - Quidkey Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a payment request via the redirect (Pay by Bank) flow\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Quidkey Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://quidkey.mintlify.site/_mintlify/api/og/v2?division=API+reference\u0026amp;title=Create+a+payment+request+via+the+redirect+%28Pay+by+Bank%29+flow\u0026amp;description=Create+a+payment+request+via+the+redirect+%28Pay+by+Bank%29+flow\u0026amp;theme=6ebdeb000b14436295b343ed\u0026amp;signature=90acf0beb07dbfbc8db615eade105d2e5b8e5a622052cc3078a6f9d601af1124\">\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 payment request via the redirect (Pay by Bank) flow - Quidkey Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a payment request via the redirect (Pay by Bank) flow\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://quidkey.mintlify.site/_mintlify/api/og/v2?division=API+reference\u0026amp;title=Create+a+payment+request+via+the+redirect+%28Pay+by+Bank%29+flow\u0026amp;description=Create+a+payment+request+via+the+redirect+%28Pay+by+Bank%29+flow\u0026amp;theme=6ebdeb000b14436295b343ed\u0026amp;signature=90acf0beb07dbfbc8db615eade105d2e5b8e5a622052cc3078a6f9d601af1124\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/quidkey/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Quidkey Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3A81FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.quidkey.com/#organization\",\"name\":\"Quidkey Docs\",\"url\":\"https://docs.quidkey.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/quidkey/7NkUiKnWcUGlDJSA/logo/light.svg?fit=max\u0026auto=format\u0026n=7NkUiKnWcUGlDJSA\u0026q=85\u0026s=1067f2a5004e7edba3ebd43a16c921cc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.quidkey.com#website\",\"name\":\"Quidkey Docs\",\"url\":\"https://docs.quidkey.com\",\"publisher\":{\"@id\":\"https://docs.quidkey.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow#webpage\",\"url\":\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow\",\"name\":\"Create a payment request via the redirect (Pay by Bank) flow\",\"description\":\"Create a payment request via the redirect (Pay by Bank) flow\",\"dateModified\":\"2026-11-04T14:29:01.344Z\",\"isPartOf\":{\"@id\":\"https://docs.quidkey.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.quidkey.com/api-reference/auth/issue-a-new-access-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a payment request via the redirect (Pay by Bank) flow\",\"item\":\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow#apireference\",\"headline\":\"Create a payment request via the redirect (Pay by Bank) flow\",\"name\":\"Create a payment request via the redirect (Pay by Bank) flow\",\"description\":\"Create a payment request via the redirect (Pay by Bank) flow\",\"url\":\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow\",\"mainEntityOfPage\":{\"@id\":\"https://docs.quidkey.com/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow#webpage\"},\"dateModified\":\"2026-11-04T14:29:01.344Z\",\"publisher\":{\"@id\":\"https://docs.quidkey.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.quidkey.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Quidkey Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Quidkey Docs","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://quidkey.com/blog"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"Payment API","groups":[{"group":"Get started","pages":[{"title":"Payment API","icon":"money-bill-transfer","href":"/guides/payment-api/overview"},{"title":"Quickstart","icon":"rocket","href":"/guides/payment-api/quickstart"}]},{"group":"Core concepts","pages":[{"title":"Authentication","icon":"key","href":"/guides/payment-api/concepts/authentication"},{"title":"Idempotency","icon":"fingerprint","href":"/guides/payment-api/concepts/idempotency"},{"title":"Errors","icon":"triangle-exclamation","href":"/guides/payment-api/concepts/errors"},{"title":"Webhooks","icon":"webhook","href":"/guides/payment-api/concepts/webhooks"},{"title":"Testing","icon":"flask","href":"/guides/payment-api/concepts/testing"},{"title":"Amounts \u0026 Currencies","icon":"coins","href":"/guides/payment-api/concepts/amounts-and-currencies"}]},{"group":"Accept a payment","pages":[{"title":"Redirect (Pay by Bank)","icon":"arrow-up-right-from-square","href":"/guides/payment-api/accept-a-payment/redirect"},{"title":"Embedded (with Stripe)","icon":"credit-card","href":"/guides/payment-api/accept-a-payment/embedded"},{"title":"Hosted Checkout","icon":"link","href":"/guides/payment-api/accept-a-payment/hosted-checkout"}]},{"group":"API reference","pages":[{"title":"Issue a new access token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/oauth2/token","href":"/api-reference/auth/issue-a-new-access-token"},{"title":"Refresh an existing access token","description":"Refresh an existing access token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/oauth2/refresh","href":"/api-reference/auth/refresh-an-existing-access-token"},{"title":"Create a payment request via the redirect (Pay by Bank) flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/payment-requests:redirect","href":"/api-reference/payments/create-a-payment-request-via-the-redirect-pay-by-bank-flow"},{"title":"Retrieve the curated top banks for a market. `country` selects the market; optional `currency` filters further; `limit` caps the result count. Public and cacheable at the market level.","description":"Retrieve the curated top banks for a market. `country` selects the market; optional `currency` filters further; `limit` caps the result count. Public and cacheable at the market level.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/banks/top","href":"/api-reference/banks/retrieve-the-curated-top-banks-for-a-market-`country`-selects-the-market;-optional-`currency`-filters-further;-`limit`-caps-the-result-count-public-and-cacheable-at-the-market-level"},{"title":"Create a payment request and return a payment_token for iframe flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/embedded/payment-requests","href":"/api-reference/embedded/create-a-payment-request-and-return-a-payment_token-for-iframe-flow"},{"title":"Update an embedded payment request (amount and/or rewards) before payment initiation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/embedded/payment-requests","href":"/api-reference/embedded/update-an-embedded-payment-request-amount-andor-rewards-before-payment-initiation"},{"title":"Create a new payment link (Partner or Merchant authentication)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/payment-links","href":"/api-reference/payment-links/create-a-new-payment-link-partner-or-merchant-authentication"},{"title":"Get payment link details by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/payment-links/{id}","href":"/api-reference/payment-links/get-payment-link-details-by-id"},{"title":"Check the status of one of your payment requests by id. Documented fallback for missed webhooks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/payment-requests/{paymentRequestId}/status","href":"/api-reference/payments/check-the-status-of-one-of-your-payment-requests-by-id-documented-fallback-for-missed-webhooks"},{"title":"List account balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/balances","href":"/api-reference/balances/list-account-balances"},{"title":"Register or update a merchant webhook URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks","href":"/api-reference/webhook/register-or-update-a-merchant-webhook-url"},{"title":"Generate a webhook signing secret for the authenticated merchant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/secret","href":"/api-reference/webhook/generate-a-webhook-signing-secret-for-the-authenticated-merchant"},{"title":"Revoke the current webhook signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/webhooks/secret/revoke","href":"/api-reference/webhook/revoke-the-current-webhook-signing-secret"}]}]}]},"basePath":"","title":"Create a payment request via the redirect (Pay by Bank) flow - Quidkey Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}