Creates a merchant under a partner. A website belongs to one merchant across all partners, so MERCHANT_ALREADY_EXISTS confirms that some merchant holds it, and names none. consent records the person’s acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through agreement_acceptance. The CONSENT_AGREEMENT_* codes name the agreement in details. A retry with the same key answers the merchant the first one created, and records no consent again.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Idempotency-Key
string
required
1 to 255 printable ASCII characters with no spaces, quotes or backslashes, in double quotes as the IETF draft defines, or without them. We recommend a UUID. Make one for each thing you mean to happen once and store it before you send the request, so a retry after a crash sends the same key. Keys are scoped to your account and the endpoint, not to a token, so a new token or a rotated secret doesn't affect a retry. A partner and its merchant are separate accounts, so the same key sent with each credential starts two requests. Keys are kept for at least 7 days. After that, the same key starts a new request.
An ISO 18245 merchant category code: four digits, 0742 for veterinary services.
Pattern: ^[0-9]{4}$
country
string
Pattern: ^[A-Z]{2}$
account_owners
object[]
At most one, who becomes the primary owner.
Maximum array length: 1
Show child attributes
consent
object
The person accepts the agreements every merchant accepts: merchant_terms, privacy_notice, data_processing_addendum, prohibited_use_policy, pricing_plan, third_party_services and banking_partner_authorization. agreements must hold the current version of each, and nothing else: list agreements for them. Optional. Send it to record the person's acceptance with the create, or accept later through agreement_acceptance.
Show child attributes
Response
The merchant, in the full view.
result
object
required
Show child attributes
entities
object
required
Nothing can be included here.
not_included
object[]
required
Show child attributes
{"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":"none"}},"navbar":{"links":[{"href":"mailto:support@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":""},"entitlements":{},"buildId":"6b00bcc867c9afdbacc99c12","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":105},{"language":"default","tag":"Payment API","count":38},{"language":"default","tag":"Endpoints","count":37},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"Events","count":11},{"language":"default","tag":"Journeys","count":11},{"language":"default","tag":"Transactions","count":10},{"language":"default","tag":"transaction","count":10},{"language":"default","tag":"Webhook endpoints","count":7},{"language":"default","tag":"webhook_endpoint","count":7}]},"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":"custom-rbac-roles","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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/merchant/create-a-merchant","slug":"/api-reference/merchant/create-a-merchant","pageMetadata":{"title":"Create a merchant","description":"Creates a merchant under a partner. A website belongs to one merchant across all partners, so `MERCHANT_ALREADY_EXISTS` confirms that some merchant holds it, and names none. `consent` records the person's acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through `agreement_acceptance`. The `CONSENT_AGREEMENT_*` codes name the agreement in `details`. A retry with the same key answers the merchant the first one created, and records no consent again.\n\nCredentials: `partner`\n\nPermission: `merchants:create`","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /partners/{id}/merchants","href":"/api-reference/merchant/create-a-merchant","autogeneratedByOpenApi":true},"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 code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Creates a merchant under a partner. A website belongs to one merchant across all partners, so \", _jsx(_components.code, {\n children: \"MERCHANT_ALREADY_EXISTS\"\n }), \" confirms that some merchant holds it, and names none. \", _jsx(_components.code, {\n children: \"consent\"\n }), \" records the person’s acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through \", _jsx(_components.code, {\n children: \"agreement_acceptance\"\n }), \". The \", _jsx(_components.code, {\n children: \"CONSENT_AGREEMENT_*\"\n }), \" codes name the agreement in \", _jsx(_components.code, {\n children: \"details\"\n }), \". A retry with the same key answers the merchant the first one created, and records no consent again.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Credentials: \", _jsx(_components.code, {\n children: \"partner\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Permission: \", _jsx(_components.code, {\n children: \"merchants:create\"\n })]\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}=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 merchant","description":"Creates a merchant under a partner. A website belongs to one merchant across all partners, so `MERCHANT_ALREADY_EXISTS` confirms that some merchant holds it, and names none. `consent` records the person's acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through `agreement_acceptance`. The `CONSENT_AGREEMENT_*` codes name the agreement in `details`. A retry with the same key answers the merchant the first one created, and records no consent again.\n\nCredentials: `partner`\n\nPermission: `merchants:create`","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /partners/{id}/merchants","href":"/api-reference/merchant/create-a-merchant","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"merchant.create","summary":"Create a merchant","description":"Creates a merchant under a partner. A website belongs to one merchant across all partners, so `MERCHANT_ALREADY_EXISTS` confirms that some merchant holds it, and names none. `consent` records the person's acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through `agreement_acceptance`. The `CONSENT_AGREEMENT_*` codes name the agreement in `details`. A retry with the same key answers the merchant the first one created, and records no consent again.\n\nCredentials: `partner`\n\nPermission: `merchants:create`","tags":["merchant"],"x-credentials":["partner"],"x-permission":"merchants:create","x-views":["full"],"x-includes":[],"parameters":["9aed589f-731a-4d13-bdcf-a0d26127278b","97f97053-a9c3-4b3b-b368-3e49c463e43d"],"requestBody":"aa3b6e59-a584-46e0-ae34-7cb82b1fb951","responses":{"201":"97d5d5e6-c5d4-4dd8-b3b1-69a2d5ccc8b9","400":"8fb739e9-d9a4-48d0-9864-f5d891d6d6a4","401":"0fc9334f-c5de-4939-8ed6-b52e8d66adff","403":"ae406cb8-07e5-4d53-a7f1-cd77c6076da9","404":"7984caca-bc58-498f-9927-c0f01e633f14","406":"b3e8950d-8033-485b-8963-04f769e12a24","409":"8013dadb-300e-4894-a159-ca5962c32536","422":"d6d3056b-bc87-4e1c-9583-5b1c78909e85","429":"c67f92c2-7d5d-43f8-9ad3-a7e35053ccad","500":"2ff0e989-bc9d-444b-b3e7-c84f1810823f","503":"8a230345-3d28-4526-8fb7-58c307a6392a"},"method":"post","type":"path","servers":["5f655410-0418-4109-85f6-58c26afed797"],"security":["b3457fe4-ea31-4007-8089-c29107b203bd"],"path":"/partners/{id}/merchants","baseUrlOptions":["https://api.quidkey.com/v1"],"title":"Create a merchant","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9aed589f-731a-4d13-bdcf-a0d26127278b":{"name":"id","in":"path","required":true,"schema":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"97f97053-a9c3-4b3b-b368-3e49c463e43d":{"name":"Idempotency-Key","in":"header","required":true,"description":"1 to 255 printable ASCII characters with no spaces, quotes or backslashes, in double quotes as the IETF draft defines, or without them. We recommend a UUID. Make one for each thing you mean to happen once and store it before you send the request, so a retry after a crash sends the same key. Keys are scoped to your account and the endpoint, not to a token, so a new token or a rotated secret doesn't affect a retry. A partner and its merchant are separate accounts, so the same key sent with each credential starts two requests. Keys are kept for at least 7 days. After that, the same key starts a new request.","schema":{"type":"string","minLength":1,"maxLength":257,"pattern":"^(?:([\\x21\\x23-\\x5B\\x5D-\\x7E]{1,255})|\"([\\x21\\x23-\\x5B\\x5D-\\x7E]{1,255})\")$","isRequired":true,"description":"1 to 255 printable ASCII characters with no spaces, quotes or backslashes, in double quotes as the IETF draft defines, or without them. We recommend a UUID. Make one for each thing you mean to happen once and store it before you send the request, so a retry after a crash sends the same key. Keys are scoped to your account and the endpoint, not to a token, so a new token or a rotated secret doesn't affect a retry. A partner and its merchant are separate accounts, so the same key sent with each credential starts two requests. Keys are kept for at least 7 days. After that, the same key starts a new request.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["brand_name","website_url","category_code"],"properties":{"brand_name":{"minLength":1,"maxLength":255,"type":"string","isRequired":true,"uniqueKey":"brand_name","typeLabel":"string"},"website_url":{"format":"uri","pattern":"^https://","maxLength":255,"type":"string","isRequired":true,"uniqueKey":"website_url","typeLabel":"string\u003curi>"},"category_code":{"pattern":"^[0-9]{4}$","type":"string","description":"An ISO 18245 merchant category code: four digits, `0742` for veterinary services.","isRequired":true,"uniqueKey":"category_code","typeLabel":"string"},"country":{"pattern":"^[A-Z]{2}$","type":"string","uniqueKey":"country","typeLabel":"string"},"account_owners":{"maxItems":1,"description":"At most one, who becomes the primary owner.","type":"array","items":{"additionalProperties":false,"type":"object","required":["full_name","email"],"properties":{"full_name":{"minLength":1,"maxLength":255,"type":"string","isRequired":true,"uniqueKey":"account_owners.items.[INDEX].full_name","typeLabel":"string"},"email":{"format":"email","maxLength":255,"type":"string","pattern":"^[a-zA-Z0-9.!#$%\u0026'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","isRequired":true,"uniqueKey":"account_owners.items.[INDEX].email","typeLabel":"string\u003cemail>"},"phone":{"oneOf":[{"type":"string","minLength":8,"pattern":"^\\+[1-9]\\d{1,14}$","uniqueKey":"account_owners.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"account_owners.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"account_owners.items.[INDEX].phone","typeLabel":"string | null"},"job_title":{"oneOf":[{"type":"string","maxLength":100,"uniqueKey":"account_owners.items.[INDEX].job_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"account_owners.items.[INDEX].job_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"account_owners.items.[INDEX].job_title","typeLabel":"string | null"}},"uniqueKey":"account_owners.items.[INDEX]","typeLabel":"object"},"uniqueKey":"account_owners","typeLabel":"object[]"},"consent":{"additionalProperties":false,"type":"object","required":["is_accepted","accepted_at","accepted_by","accepted_ip","wording","locale","agreements"],"properties":{"is_accepted":{"const":true,"type":"boolean","isRequired":true,"uniqueKey":"consent.is_accepted","typeLabel":"boolean"},"accepted_at":{"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$","type":"string","description":"When the person accepted. Before the agreement took effect, more than 5 minutes in the future or more than 30 days old is refused, with `CONSENT_ACCEPTED_AT_INVALID`.","isRequired":true,"uniqueKey":"consent.accepted_at","typeLabel":"string\u003cdate-time>"},"accepted_by":{"additionalProperties":false,"type":"object","required":["full_name","email"],"properties":{"full_name":{"minLength":1,"maxLength":200,"pattern":"^[^\\x00-\\x1F\\x7F]*$","description":"On one line, with no control character.","type":"string","isRequired":true,"uniqueKey":"consent.accepted_by.full_name","typeLabel":"string"},"email":{"format":"email","maxLength":320,"type":"string","pattern":"^[a-zA-Z0-9.!#$%\u0026'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$","isRequired":true,"uniqueKey":"consent.accepted_by.email","typeLabel":"string\u003cemail>"}},"isRequired":true,"uniqueKey":"consent.accepted_by","typeLabel":"object"},"accepted_ip":{"oneOf":[{"type":"string","format":"ipv4","isRequired":true,"uniqueKey":"consent.accepted_ip.oneOf.0","typeLabel":"string\u003cipv4>"},{"type":"string","format":"ipv6","isRequired":true,"uniqueKey":"consent.accepted_ip.oneOf.1","typeLabel":"string\u003cipv6>"}],"isRequired":true,"uniqueKey":"consent.accepted_ip","typeLabel":"string\u003cipv4> | string\u003cipv6>"},"wording":{"minLength":1,"maxLength":10000,"pattern":"^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$","description":"The exact text the person saw, with no control character but a line break or a tab.","type":"string","isRequired":true,"uniqueKey":"consent.wording","typeLabel":"string"},"locale":{"pattern":"^[A-Za-z]{2,3}(-[A-Za-z0-9]{1,8})*$","type":"string","maxLength":35,"isRequired":true,"uniqueKey":"consent.locale","typeLabel":"string"},"agreements":{"minItems":1,"maxItems":7,"type":"array","items":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"minLength":1,"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"consent.agreements.items.[INDEX].id","typeLabel":"string"},"_link":{"pattern":"^/","type":"string","uniqueKey":"consent.agreements.items.[INDEX]._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","uniqueKey":"consent.agreements.items.[INDEX]._type","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"request","is_published":true},"uniqueKey":"consent.agreements.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"consent.agreements","typeLabel":"object[]"}},"description":"The person accepts the agreements every merchant accepts: `merchant_terms`, `privacy_notice`, `data_processing_addendum`, `prohibited_use_policy`, `pricing_plan`, `third_party_services` and `banking_partner_authorization`. `agreements` must hold the current version of each, and nothing else: list agreements for them. Optional. Send it to record the person's acceptance with the create, or accept later through `agreement_acceptance`.","uniqueKey":"consent","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"brand_name":"\u003cstring>","website_url":"\u003cstring>","category_code":"\u003cstring>","country":"\u003cstring>","account_owners":[{"full_name":"\u003cstring>","email":"jsmith@example.com","phone":"\u003cstring>","job_title":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"97d5d5e6-c5d4-4dd8-b3b1-69a2d5ccc8b9":{"description":"The merchant, in the full view.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}},"Location":{"description":"The URL of the created resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["result","entities","not_included"],"properties":{"result":{"additionalProperties":false,"type":"object","required":["_type","_uri","_view","id","created_at","updated_at","partner","brand_name","website_url","category_code","country","status","home_currency","is_multi_account_allowed","account_owners","onboarding","legal_entities","payment_links","agreement_acceptances","bank_accounts","capabilities","webhook_endpoints","transactions","payouts"],"properties":{"_type":{"const":"merchant","type":"string","isRequired":true,"uniqueKey":"result._type","typeLabel":"string"},"_uri":{"pattern":"^/","description":"The canonical URI, relative to the version root.","type":"string","isRequired":true,"uniqueKey":"result._uri","typeLabel":"string"},"_view":{"const":"full","type":"string","isRequired":true,"uniqueKey":"result._view","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"result.id","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$","isRequired":true,"uniqueKey":"result.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"result.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$","isRequired":true,"uniqueKey":"result.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"result.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.updated_at","typeLabel":"string\u003cdate-time> | null"},"partner":{"additionalProperties":false,"type":"object","required":["_type","id"],"properties":{"_type":{"const":"partner","type":"string","isRequired":true,"uniqueKey":"result.partner._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"result.partner.id","typeLabel":"string"}},"x-link-target":{"resource":"partner","kind":"resource","is_published":false},"isRequired":true,"uniqueKey":"result.partner","typeLabel":"object"},"brand_name":{"type":"string","isRequired":true,"uniqueKey":"result.brand_name","typeLabel":"string"},"website_url":{"oneOf":[{"type":"string","description":"Unique across all merchants. Sent as absolute HTTPS. One set outside this API can read `http://`. `null` when none is held.","format":"uri","isRequired":true,"uniqueKey":"result.website_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"Unique across all merchants. Sent as absolute HTTPS. One set outside this API can read `http://`. `null` when none is held.","isRequired":true,"uniqueKey":"result.website_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.website_url","typeLabel":"string\u003curi> | null"},"category_code":{"type":"string","isRequired":true,"uniqueKey":"result.category_code","typeLabel":"string"},"country":{"oneOf":[{"type":"string","description":"`null` when none is held.","pattern":"^[A-Z]{2}$","isRequired":true,"uniqueKey":"result.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"`null` when none is held.","isRequired":true,"uniqueKey":"result.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.country","typeLabel":"string | null"},"status":{"type":"string","enum":["pending","active","suspended"],"description":"Where the merchant stands with Quidkey.\n\n- `pending`: Not live yet: it takes no live payment transactions. Read `onboarding` for what is outstanding.\n- `active`: Live. A live payment transaction can still be refused: after 12 months with none, until Quidkey has reviewed the merchant, or while the account it would land in awaits verification.\n- `suspended`: Quidkey has paused it, whether or not it had gone live: no live payment transaction, refund or payout starts. Reinstating it answers `pending` or `active`. Why isn't shared.","isRequired":true,"uniqueKey":"result.status","typeLabel":"enum\u003cstring>"},"home_currency":{"oneOf":[{"type":"string","description":"What a payment transaction through a virtual account is converted into and paid out in when the merchant has no payout account in the transaction's own currency. A direct payment transaction is never converted. It's set from the merchant's first payout account, where that currency can be held, and only Quidkey can change it. `null` while it has none, and a merchant can't go live without one.","pattern":"^[A-Z]{3}$","isRequired":true,"uniqueKey":"result.home_currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"What a payment transaction through a virtual account is converted into and paid out in when the merchant has no payout account in the transaction's own currency. A direct payment transaction is never converted. It's set from the merchant's first payout account, where that currency can be held, and only Quidkey can change it. `null` while it has none, and a merchant can't go live without one.","isRequired":true,"uniqueKey":"result.home_currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.home_currency","typeLabel":"string | null"},"is_multi_account_allowed":{"type":"boolean","description":"Whether another `owned` account can be added while one is active. Linking a bank account isn't limited by it. It can't be set through this API.","isRequired":true,"uniqueKey":"result.is_multi_account_allowed","typeLabel":"boolean"},"account_owners":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.account_owners._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.account_owners._type","typeLabel":"string"}},"x-link-target":{"resource":"account_owner","kind":"collection","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"result.account_owners","typeLabel":"object"},"onboarding":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.onboarding._link","typeLabel":"string"},"_type":{"const":"onboarding","type":"string","isRequired":true,"uniqueKey":"result.onboarding._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"result.onboarding.id","typeLabel":"string"}},"x-link-target":{"resource":"onboarding","kind":"singleton","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"result.onboarding","typeLabel":"object"},"legal_entities":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.legal_entities._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.legal_entities._type","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"collection","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"result.legal_entities","typeLabel":"object"},"payment_links":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.payment_links._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.payment_links._type","typeLabel":"string"}},"x-link-target":{"resource":"payment_link","kind":"collection","is_published":true,"views":["full","summary"]},"isRequired":true,"uniqueKey":"result.payment_links","typeLabel":"object"},"agreement_acceptances":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.agreement_acceptances._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.agreement_acceptances._type","typeLabel":"string"}},"x-link-target":{"resource":"agreement_acceptance","kind":"collection","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"result.agreement_acceptances","typeLabel":"object"},"bank_accounts":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.bank_accounts._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.bank_accounts._type","typeLabel":"string"}},"x-link-target":{"resource":"bank_account","kind":"collection","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"result.bank_accounts","typeLabel":"object"},"capabilities":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.capabilities._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.capabilities._type","typeLabel":"string"}},"x-link-target":{"resource":"capability","kind":"collection","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"result.capabilities","typeLabel":"object"},"webhook_endpoints":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.webhook_endpoints._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.webhook_endpoints._type","typeLabel":"string"}},"x-link-target":{"resource":"webhook_endpoint","kind":"collection","is_published":true,"views":["full"]},"description":"A partner's credential can't follow this link, and answers 403.","isRequired":true,"uniqueKey":"result.webhook_endpoints","typeLabel":"object"},"transactions":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.transactions._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.transactions._type","typeLabel":"string"}},"x-link-target":{"resource":"transaction","kind":"collection","is_published":true,"views":["full","summary"]},"isRequired":true,"uniqueKey":"result.transactions","typeLabel":"object"},"payouts":{"additionalProperties":false,"type":"object","required":["_link","_type"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"result.payouts._link","typeLabel":"string"},"_type":{"const":"collection","type":"string","isRequired":true,"uniqueKey":"result.payouts._type","typeLabel":"string"}},"x-link-target":{"resource":"payout","kind":"collection","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"result.payouts","typeLabel":"object"}},"isRequired":true,"uniqueKey":"result","typeLabel":"object"},"entities":{"additionalProperties":false,"description":"Nothing can be included here.","type":"object","properties":{},"isRequired":true,"uniqueKey":"entities","typeLabel":"object"},"not_included":{"type":"array","items":{"additionalProperties":false,"type":"object","required":["link","reason"],"properties":{"link":{"oneOf":[{"type":"object","required":["_link","_type","id"],"x-link-target":{"resource":"any","kind":"any","is_published":true},"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"not_included.items.[INDEX].link.oneOf.0._link","typeLabel":"string"},"_type":{"type":"string","isRequired":true,"uniqueKey":"not_included.items.[INDEX].link.oneOf.0._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"not_included.items.[INDEX].link.oneOf.0.id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"not_included.items.[INDEX].link.oneOf.0","typeLabel":"object"},{"type":"object","required":["_type","id"],"x-link-target":{"resource":"any","kind":"any","is_published":true},"properties":{"_type":{"type":"string","isRequired":true,"uniqueKey":"not_included.items.[INDEX].link.oneOf.1._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"not_included.items.[INDEX].link.oneOf.1.id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"not_included.items.[INDEX].link.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"not_included.items.[INDEX].link","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","not_published"],"description":"Why this link has no entity.\n\n- `no_permission`: This credential can't read it. Fetching it answers 403, or 404 where a 403 would reveal that it exists.\n- `not_published`: The API doesn't show it: a type it doesn't publish, or a record it doesn't show on a type it does, such as a failed payout. Fetching it, where it has a URI, answers 404.","isRequired":true,"uniqueKey":"not_included.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"not_included.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"not_included","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"result":{"_type":"merchant","_uri":"\u003cstring>","_view":"full","id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","partner":{"_type":"partner","id":"\u003cstring>"},"brand_name":"\u003cstring>","website_url":"\u003cstring>","category_code":"\u003cstring>","country":"\u003cstring>","status":"pending","home_currency":"\u003cstring>","is_multi_account_allowed":true,"account_owners":{"_link":"\u003cstring>","_type":"collection"},"onboarding":{"_link":"\u003cstring>","_type":"onboarding","id":"\u003cstring>"},"legal_entities":{"_link":"\u003cstring>","_type":"collection"},"payment_links":{"_link":"\u003cstring>","_type":"collection"},"agreement_acceptances":{"_link":"\u003cstring>","_type":"collection"},"bank_accounts":{"_link":"\u003cstring>","_type":"collection"},"capabilities":{"_link":"\u003cstring>","_type":"collection"},"webhook_endpoints":{"_link":"\u003cstring>","_type":"collection"},"transactions":{"_link":"\u003cstring>","_type":"collection"},"payouts":{"_link":"\u003cstring>","_type":"collection"}},"entities":{},"not_included":[{"link":{"_link":"\u003cstring>","_type":"\u003cstring>","id":"\u003cstring>"},"reason":"no_permission"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"8fb739e9-d9a4-48d0-9864-f5d891d6d6a4":{"description":"`CONSENT_ACCEPTED_AT_INVALID`: accepted_at is before the agreement took effect, too far in the future or too old.\n\n`CONSENT_AGREEMENT_DUPLICATE`: Consent names the same agreement more than once.\n\n`CONSENT_AGREEMENT_MISSING`: Consent is missing an agreement this operation requires.\n\n`CONSENT_AGREEMENT_NOT_REQUIRED`: Consent names an agreement this operation doesn't require.\n\n`CONSENT_AGREEMENT_STALE`: Consent names an agreement version that isn't current.\n\n`CONSENT_NOT_ACCEPTED`: `is_accepted` must be `true`, stating that the person accepted.\n\n`IDEMPOTENCY_KEY_REQUIRED`: This endpoint requires an Idempotency-Key header.\n\n`UNKNOWN_AGREEMENT`: This names no agreement.\n\n`VALIDATION_FAILED`: The request is malformed or failed validation.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["CONSENT_ACCEPTED_AT_INVALID","CONSENT_AGREEMENT_DUPLICATE","CONSENT_AGREEMENT_MISSING","CONSENT_AGREEMENT_NOT_REQUIRED","CONSENT_AGREEMENT_STALE","CONSENT_NOT_ACCEPTED","IDEMPOTENCY_KEY_REQUIRED","UNKNOWN_AGREEMENT","VALIDATION_FAILED"],"exampleType":"generated"},"0fc9334f-c5de-4939-8ed6-b52e8d66adff":{"description":"`UNAUTHENTICATED`: A valid bearer token is required.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["UNAUTHENTICATED"],"exampleType":"generated"},"ae406cb8-07e5-4d53-a7f1-cd77c6076da9":{"description":"`FORBIDDEN`: This credential doesn't have permission for this endpoint.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["FORBIDDEN"],"exampleType":"generated"},"7984caca-bc58-498f-9927-c0f01e633f14":{"description":"`NOT_FOUND`: Not found.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["NOT_FOUND"],"exampleType":"generated"},"b3e8950d-8033-485b-8963-04f769e12a24":{"description":"`NOT_ACCEPTABLE`: This endpoint doesn't offer the format in Accept.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["NOT_ACCEPTABLE"],"exampleType":"generated"},"8013dadb-300e-4894-a159-ca5962c32536":{"description":"`IDEMPOTENCY_IN_PROGRESS`: An earlier request with this Idempotency-Key hasn't finished. If this persists, contact support.\n\n`MERCHANT_ALREADY_EXISTS`: A merchant already holds this website.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["IDEMPOTENCY_IN_PROGRESS","MERCHANT_ALREADY_EXISTS"],"exampleType":"generated"},"d6d3056b-bc87-4e1c-9583-5b1c78909e85":{"description":"`IDEMPOTENCY_KEY_REUSED`: This Idempotency-Key was used with a different request.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["IDEMPOTENCY_KEY_REUSED"],"exampleType":"generated"},"c67f92c2-7d5d-43f8-9ad3-a7e35053ccad":{"description":"`RATE_LIMITED`: Too many requests.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}},"Retry-After":{"description":"How many seconds to wait before retrying.","schema":{"minimum":0,"type":"integer"}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["RATE_LIMITED"],"exampleType":"generated"},"2ff0e989-bc9d-444b-b3e7-c84f1810823f":{"description":"`INTERNAL_ERROR`: Something went wrong on our side.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["INTERNAL_ERROR"],"exampleType":"generated"},"8a230345-3d28-4526-8fb7-58c307a6392a":{"description":"`SERVICE_UNAVAILABLE`: The service is busy. Try again shortly.","headers":{"X-Request-Id":{"description":"Identifies this request. Quote it to support.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` on a retry that answers with the first attempt's outcome.","schema":{"type":"string","enum":["true"]}},"Retry-After":{"description":"How many seconds to wait before retrying.","schema":{"minimum":0,"type":"integer"}}},"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["error"],"properties":{"error":{"additionalProperties":false,"type":"object","required":["code","message","details","retryable","request_id"],"properties":{"code":{"description":"Branch on this. New codes can appear.","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"For people. It can change.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["required_actions","message"],"properties":{"required_actions":{"description":"The `required_actions` codes holding this back.","type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.required_actions","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["available_percent","message"],"properties":{"available_percent":{"pattern":"^\\d+(\\.\\d+)?$","description":"A percentage as a decimal string: `\"25.00\"` is 25%.","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.available_percent","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["agreement","current_agreement","message"],"properties":{"agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.agreement","typeLabel":"object"},"current_agreement":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._link","typeLabel":"string"},"_type":{"const":"agreement","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement.id","typeLabel":"string"}},"x-link-target":{"resource":"agreement","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.current_agreement","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["legal_entity","message"],"properties":{"legal_entity":{"additionalProperties":false,"type":"object","required":["_link","_type","id"],"properties":{"_link":{"pattern":"^/","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._link","typeLabel":"string"},"_type":{"const":"legal_entity","type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity._type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity.id","typeLabel":"string"}},"x-link-target":{"resource":"legal_entity","kind":"resource","is_published":true,"views":["full"]},"isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.legal_entity","typeLabel":"object"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"},"retryable":{"description":"Whether sending the same request again unchanged, after a wait, can succeed with nothing else changing.","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Quote this to support.","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"retryable":true,"request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"x-error-codes":["SERVICE_UNAVAILABLE"],"exampleType":"generated"}},"security":{"b3457fe4-ea31-4007-8089-c29107b203bd":{"bearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"}}},"servers":{"5f655410-0418-4109-85f6-58c26afed797":{"url":"https://api.quidkey.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer"},"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":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/v1/openapi.json"},"subdomain":"quidkey","siteName":"Quidkey Docs","title":"Create a merchant - Quidkey Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T21:34:08.855Z","originalFileLocation":"api-reference/merchant/create-a-merchant.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=\"Creates a merchant under a partner. A website belongs to one merchant across all partners, so MERCHANT_ALREADY_EXISTS confirms that some merchant holds it, and names none. consent records the person\u0026#x27;s acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through agreement_acceptance. The CONSENT_AGREEMENT_* codes name the agreement in details. A retry with the same key answers the merchant the first one created, and records no consent again. Credentials: partner Permission: merchants:create\">\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 merchant - Quidkey Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a merchant under a partner. A website belongs to one merchant across all partners, so MERCHANT_ALREADY_EXISTS confirms that some merchant holds it, and names none. consent records the person\u0026#x27;s acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through agreement_acceptance. The CONSENT_AGREEMENT_* codes name the agreement in details. A retry with the same key answers the merchant the first one created, and records no consent again. Credentials: partner Permission: merchants:create\">\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/merchant/create-a-merchant\">\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=Merchants\u0026amp;title=Create+a+merchant\u0026amp;description=Creates+a+merchant+under+a+partner.+A+website+belongs+to+one+merchant+across+all+partners%2C+so+%60MERCHANT_ALREADY_EXISTS%60+confirms+that+some+merchant+holds+it%2C+an\u0026amp;theme=ff15ef6b43715ee77fbd23c5\u0026amp;signature=af0a2a3418cadaa1db8b92a712d1e3b313dc47784a50da6adf7d8355d9f1ee07\">\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 merchant - Quidkey Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a merchant under a partner. A website belongs to one merchant across all partners, so MERCHANT_ALREADY_EXISTS confirms that some merchant holds it, and names none. consent records the person\u0026#x27;s acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through agreement_acceptance. The CONSENT_AGREEMENT_* codes name the agreement in details. A retry with the same key answers the merchant the first one created, and records no consent again. Credentials: partner Permission: merchants:create\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://quidkey.mintlify.site/_mintlify/api/og/v2?division=Merchants\u0026amp;title=Create+a+merchant\u0026amp;description=Creates+a+merchant+under+a+partner.+A+website+belongs+to+one+merchant+across+all+partners%2C+so+%60MERCHANT_ALREADY_EXISTS%60+confirms+that+some+merchant+holds+it%2C+an\u0026amp;theme=ff15ef6b43715ee77fbd23c5\u0026amp;signature=af0a2a3418cadaa1db8b92a712d1e3b313dc47784a50da6adf7d8355d9f1ee07\">\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/merchant/create-a-merchant\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/merchant/create-a-merchant.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/merchant/create-a-merchant#webpage\",\"url\":\"https://docs.quidkey.com/api-reference/merchant/create-a-merchant\",\"name\":\"Create a merchant\",\"description\":\"Creates a merchant under a partner. A website belongs to one merchant across all partners, so MERCHANT_ALREADY_EXISTS confirms that some merchant holds it, and names none. consent records the person's acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through agreement_acceptance. The CONSENT_AGREEMENT_* codes name the agreement in details. A retry with the same key answers the merchant the first one created, and records no consent again. Credentials: partner Permission: merchants:create\",\"dateModified\":\"2026-11-20T21:34:08.855Z\",\"isPartOf\":{\"@id\":\"https://docs.quidkey.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.quidkey.com/api-reference/merchant/create-a-merchant#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.quidkey.com/api-reference/merchant/create-a-merchant#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Merchants\",\"item\":\"https://docs.quidkey.com/api-reference/merchant/read-a-merchant\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a merchant\",\"item\":\"https://docs.quidkey.com/api-reference/merchant/create-a-merchant\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.quidkey.com/api-reference/merchant/create-a-merchant#apireference\",\"headline\":\"Create a merchant\",\"name\":\"Create a merchant\",\"description\":\"Creates a merchant under a partner. A website belongs to one merchant across all partners, so MERCHANT_ALREADY_EXISTS confirms that some merchant holds it, and names none. consent records the person's acceptance of the agreements every merchant accepts with the create. Leave it out to record each later through agreement_acceptance. The CONSENT_AGREEMENT_* codes name the agreement in details. A retry with the same key answers the merchant the first one created, and records no consent again. Credentials: partner Permission: merchants:create\",\"url\":\"https://docs.quidkey.com/api-reference/merchant/create-a-merchant\",\"mainEntityOfPage\":{\"@id\":\"https://docs.quidkey.com/api-reference/merchant/create-a-merchant#webpage\"},\"dateModified\":\"2026-11-20T21:34:08.855Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Quidkey Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/merchant/create-a-merchant.md","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","groups":[{"group":"Get started","pages":[{"title":"Quidkey API v1","icon":"layer-group","href":"/api-v1/overview"},{"title":"Getting Started","icon":"rocket","href":"/api-v1/getting-started"}]},{"group":"Standards","pages":[{"title":"Responses and Links","icon":"ruler","href":"/api-v1/standards/responses"},{"title":"Lists, Pagination and Filters","icon":"list","href":"/api-v1/standards/collections"},{"title":"Errors and Retries","icon":"triangle-exclamation","href":"/api-v1/standards/errors"},{"title":"Idempotency","icon":"fingerprint","href":"/api-v1/standards/idempotency"},{"title":"Authentication and Access","icon":"key","href":"/api-v1/standards/access"},{"title":"Versioning","icon":"code-branch","href":"/api-v1/standards/versioning"}]},{"group":"Journeys","pages":[{"title":"Set Up a Partner Account","icon":"handshake","href":"/api-v1/journeys/partner-setup"},{"title":"Onboard a Merchant","icon":"building","href":"/api-v1/journeys/onboard-a-merchant"},{"title":"Set Up Partner Webhooks","icon":"webhook","href":"/api-v1/journeys/partner-webhooks"},{"title":"Take a Payment with Hosted Checkout","icon":"credit-card","href":"/api-v1/journeys/hosted-checkout"},{"title":"Take a Payment with a Payment Link","icon":"link","href":"/api-v1/journeys/payment-links"},{"title":"Refund a Payment Transaction","icon":"rotate-left","href":"/api-v1/journeys/refunds"},{"title":"Handle a Reversal","icon":"arrow-rotate-left","href":"/api-v1/journeys/reversals"},{"title":"Reconcile Payouts","icon":"scale-balanced","href":"/api-v1/journeys/reconcile"},{"title":"Recover a Lost Response","icon":"life-ring","href":"/api-v1/journeys/lost-responses"},{"title":"Integrate as a Merchant","icon":"store","href":"/api-v1/journeys/merchant-integration"},{"title":"Test an Integration","icon":"flask","href":"/api-v1/journeys/test-payments"}]},{"group":"Integrate","pages":[{"title":"Webhooks","icon":"webhook","href":"/api-v1/webhooks"}]},{"group":"Reference tables","pages":[{"title":"Payment Schemes","icon":"building-columns","href":"/api-v1/reference/payment-schemes"},{"title":"Bank Account Identifiers","icon":"id-card","href":"/api-v1/reference/bank-account-identifiers"},{"title":"Banks","icon":"landmark","href":"/api-v1/reference/banks"},{"title":"Transaction Export","icon":"file-csv","href":"/api-v1/reference/transaction-export"}]},{"group":"API keys","pages":[{"title":"Read the current API key","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /api-keys/current","href":"/api-reference/api_key/read-the-current-api-key"},{"title":"Read an API key","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /api-keys/{id}","href":"/api-reference/api_key/read-an-api-key"},{"title":"Get an access token","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /oauth2/token","href":"/api-reference/api_key/get-an-access-token"}]},{"group":"Merchants","pages":[{"title":"Read a merchant","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}","href":"/api-reference/merchant/read-a-merchant"},{"title":"Update a merchant","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json patch /merchants/{id}","href":"/api-reference/merchant/update-a-merchant"},{"title":"Read a merchant's onboarding","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/onboarding","href":"/api-reference/merchant/read-a-merchants-onboarding"},{"title":"Read receivable currencies","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/receivable-currencies","href":"/api-reference/merchant/read-receivable-currencies"},{"title":"List merchants","description":"Lists a partner's merchants, newest first. Merchant credentials have no list, since `merchants:list` is a partner permission: a merchant credential reads its merchant through `owner` on `GET /api-keys/current`.\n\nCredentials: `partner`\n\nPermission: `merchants:list`","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /partners/{id}/merchants","href":"/api-reference/merchant/list-merchants"},{"title":"Create a merchant","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /partners/{id}/merchants","href":"/api-reference/merchant/create-a-merchant"}]},{"group":"Account owners","pages":[{"title":"Read an account owner","description":"Reads one account owner.\n\nCredentials: `partner`, `merchant`\n\nPermission: `account-owners:get`","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /account-owners/{id}","href":"/api-reference/account_owner/read-an-account-owner"},{"title":"List account owners","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/account-owners","href":"/api-reference/account_owner/list-account-owners"}]},{"group":"Legal entities","pages":[{"title":"Read a legal entity","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /legal-entities/{id}","href":"/api-reference/legal_entity/read-a-legal-entity"},{"title":"Update a legal entity","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json patch /legal-entities/{id}","href":"/api-reference/legal_entity/update-a-legal-entity"},{"title":"List legal entities","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/legal-entities","href":"/api-reference/legal_entity/list-legal-entities"},{"title":"Create a legal entity","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /merchants/{id}/legal-entities","href":"/api-reference/legal_entity/create-a-legal-entity"}]},{"group":"Parties","pages":[{"title":"List parties","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /legal-entities/{id}/parties","href":"/api-reference/party/list-parties"},{"title":"Create a party","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /legal-entities/{id}/parties","href":"/api-reference/party/create-a-party"},{"title":"Read a party","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /parties/{id}","href":"/api-reference/party/read-a-party"},{"title":"Update a party","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json patch /parties/{id}","href":"/api-reference/party/update-a-party"},{"title":"Delete a party","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json delete /parties/{id}","href":"/api-reference/party/delete-a-party"},{"title":"Verify a party's identity","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /parties/{id}:verifyIdentity","href":"/api-reference/party/verify-a-partys-identity"}]},{"group":"Identity checks","pages":[{"title":"Read an identity check","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /identity-verifications/{id}","href":"/api-reference/identity_verification/read-an-identity-check"},{"title":"List identity checks","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/identity-verifications","href":"/api-reference/identity_verification/list-identity-checks"}]},{"group":"Agreements","pages":[{"title":"List agreements","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /agreements","href":"/api-reference/agreement/list-agreements"},{"title":"Read an agreement","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /agreements/{id}","href":"/api-reference/agreement/read-an-agreement"}]},{"group":"Agreement acceptances","pages":[{"title":"Read an agreement acceptance","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /agreement-acceptances/{id}","href":"/api-reference/agreement_acceptance/read-an-agreement-acceptance"},{"title":"List agreement acceptances","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/agreement-acceptances","href":"/api-reference/agreement_acceptance/list-agreement-acceptances"},{"title":"Record an agreement acceptance","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /merchants/{id}/agreement-acceptances","href":"/api-reference/agreement_acceptance/record-an-agreement-acceptance"}]},{"group":"Capabilities","pages":[{"title":"List capabilities","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/capabilities","href":"/api-reference/capability/list-capabilities"},{"title":"Read a capability","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/capabilities/{capability_id}","href":"/api-reference/capability/read-a-capability"},{"title":"Request a capability","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /merchants/{id}/capabilities/{capability_id}:request","href":"/api-reference/capability/request-a-capability"}]},{"group":"Bank accounts","pages":[{"title":"Read a bank account","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /bank-accounts/{id}","href":"/api-reference/bank_account/read-a-bank-account"},{"title":"Read a balance","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /bank-accounts/{id}/balance","href":"/api-reference/bank_account/read-a-balance"},{"title":"Deactivate a bank account","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /bank-accounts/{id}:deactivate","href":"/api-reference/bank_account/deactivate-a-bank-account"},{"title":"List bank accounts","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/bank-accounts","href":"/api-reference/bank_account/list-bank-accounts"},{"title":"Create a bank account","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /merchants/{id}/bank-accounts","href":"/api-reference/bank_account/create-a-bank-account"}]},{"group":"Countries","pages":[{"title":"List countries","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /countries","href":"/api-reference/country/list-countries"},{"title":"Read a country","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /countries/{id}","href":"/api-reference/country/read-a-country"}]},{"group":"Banks","pages":[{"title":"Read a bank","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /banks/{id}","href":"/api-reference/bank/read-a-bank"},{"title":"List a merchant's banks","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/banks","href":"/api-reference/bank/list-a-merchants-banks"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/transactions","href":"/api-reference/transaction/list-transactions"},{"title":"Create a payment transaction","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /merchants/{id}/transactions","href":"/api-reference/transaction/create-a-payment-transaction"},{"title":"Search transactions","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /merchants/{id}/transactions:search","href":"/api-reference/transaction/search-transactions"},{"title":"Read a transaction","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /transactions/{id}","href":"/api-reference/transaction/read-a-transaction"},{"title":"Read a payment transaction's customer details","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /transactions/{id}/customer-details","href":"/api-reference/transaction/read-a-payment-transactions-customer-details"},{"title":"Read the refundable amount","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /transactions/{id}/refundable-amount","href":"/api-reference/transaction/read-the-refundable-amount"},{"title":"List a payment transaction's refunds","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /transactions/{id}/refunds","href":"/api-reference/transaction/list-a-payment-transactions-refunds"},{"title":"Create a refund","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /transactions/{id}/refunds","href":"/api-reference/transaction/create-a-refund"},{"title":"Execute a refund","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /transactions/{id}:executeRefund","href":"/api-reference/transaction/execute-a-refund"},{"title":"Issue a checkout","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /transactions/{id}:issueCheckout","href":"/api-reference/transaction/issue-a-checkout"}]},{"group":"Payment links","pages":[{"title":"List payment links","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/payment-links","href":"/api-reference/payment_link/list-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /merchants/{id}/payment-links","href":"/api-reference/payment_link/create-a-payment-link"},{"title":"Read a payment link","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /payment-links/{id}","href":"/api-reference/payment_link/read-a-payment-link"}]},{"group":"Payouts","pages":[{"title":"List payouts","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/payouts","href":"/api-reference/payout/list-payouts"},{"title":"Read a payout","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /payouts/{id}","href":"/api-reference/payout/read-a-payout"}]},{"group":"Webhook endpoints","pages":[{"title":"List a merchant's webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /merchants/{id}/webhook-endpoints","href":"/api-reference/webhook_endpoint/list-a-merchants-webhook-endpoints"},{"title":"Create a merchant's webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /merchants/{id}/webhook-endpoints","href":"/api-reference/webhook_endpoint/create-a-merchants-webhook-endpoint"},{"title":"List a partner's webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /partners/{id}/webhook-endpoints","href":"/api-reference/webhook_endpoint/list-a-partners-webhook-endpoints"},{"title":"Create a partner's webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /partners/{id}/webhook-endpoints","href":"/api-reference/webhook_endpoint/create-a-partners-webhook-endpoint"},{"title":"Read a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /webhook-endpoints/{id}","href":"/api-reference/webhook_endpoint/read-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json patch /webhook-endpoints/{id}","href":"/api-reference/webhook_endpoint/update-a-webhook-endpoint"},{"title":"Rotate a webhook endpoint's signing secret","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /webhook-endpoints/{id}:rotateSecret","href":"/api-reference/webhook_endpoint/rotate-a-webhook-endpoints-signing-secret"}]},{"group":"Events","pages":[{"title":"transaction.payment.processing","openapi":"api-reference/v1/openapi.json webhook transaction.payment.processing","href":"/api-v1/events/transaction-payment-processing"},{"title":"transaction.payment.completed","openapi":"api-reference/v1/openapi.json webhook transaction.payment.completed","href":"/api-v1/events/transaction-payment-completed"},{"title":"transaction.payment.failed","openapi":"api-reference/v1/openapi.json webhook transaction.payment.failed","href":"/api-v1/events/transaction-payment-failed"},{"title":"transaction.payment.cancelled","openapi":"api-reference/v1/openapi.json webhook transaction.payment.cancelled","href":"/api-v1/events/transaction-payment-cancelled"},{"title":"transaction.payment.unresolved","openapi":"api-reference/v1/openapi.json webhook transaction.payment.unresolved","href":"/api-v1/events/transaction-payment-unresolved"},{"title":"transaction.reversal.completed","openapi":"api-reference/v1/openapi.json webhook transaction.reversal.completed","href":"/api-v1/events/transaction-reversal-completed"},{"title":"transaction.reversal.failed","openapi":"api-reference/v1/openapi.json webhook transaction.reversal.failed","href":"/api-v1/events/transaction-reversal-failed"},{"title":"transaction.reversal.cancelled","openapi":"api-reference/v1/openapi.json webhook transaction.reversal.cancelled","href":"/api-v1/events/transaction-reversal-cancelled"},{"title":"merchant.pending","openapi":"api-reference/v1/openapi.json webhook merchant.pending","href":"/api-v1/events/merchant-pending"},{"title":"merchant.active","openapi":"api-reference/v1/openapi.json webhook merchant.active","href":"/api-v1/events/merchant-active"},{"title":"merchant.suspended","openapi":"api-reference/v1/openapi.json webhook merchant.suspended","href":"/api-v1/events/merchant-suspended"}]}]},{"tab":"Payment API","pages":[{"title":"Payment API","href":"/api-v1/views/payment-api"}]}]},"basePath":"","title":"Create a merchant - Quidkey Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}