Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout).
Colombia requires country: "CO", amount, and successUrl. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them.
The payer opens checkoutUrl, completes payment, and returns to the HG success page. successUrl is used only after payment is confirmed.
Colombia create responses include checkoutUrl and omit checkoutUrlProvider. Colombia get, list, and cancel responses omit providerData. Chile create responses include checkoutUrlProvider.
expiresInSeconds is optional. The default is 86400 seconds. The maximum is 604800 seconds.
A Bloqueada or Cerrada account returns 403 with code: ACCOUNT_NOT_OPERATIVE. A Restringida account returns 403 with code: RESTRICTED. A COP account that is not ready for checkout returns 400 with error: "Account is not ready for checkout". An account that is not a COP checkout account returns 400 with error: "Account is not supported for this checkout country".
If the hosted session cannot be created, the API returns 502 with error: "Failed to create CO payment with provider".
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"HG.Cash","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/hgcash/k1h9DZri9LhvINuR/logo/light.png?fit=max\u0026auto=format\u0026n=k1h9DZri9LhvINuR\u0026q=85\u0026s=7d5990dbc96332e996531a671998285e","dark":"https://mintcdn.com/hgcash/k1h9DZri9LhvINuR/logo/dark.png?fit=max\u0026auto=format\u0026n=k1h9DZri9LhvINuR\u0026q=85\u0026s=c5ceb594ef1952509e9278b0ed1c36cf"},"favicon":"https://mintcdn.com/hgcash/k1h9DZri9LhvINuR/favicon.ico?fit=max\u0026auto=format\u0026n=k1h9DZri9LhvINuR\u0026q=85\u0026s=9f602706d5f9b5d268c080fd6c7fcc8b","footer":{},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://hg.cash"}},"href":"introduction"},{"language":"es","navbar":{"primary":{"type":"button","label":"Ir al panel","href":"https://hg.cash"}},"href":"es/introduction"},{"language":"pt-BR","navbar":{"primary":{"type":"button","label":"Abrir painel","href":"https://hg.cash"}},"href":"pt-BR/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hgcash","hasAudioNarration":false,"actualSubdomain":"hgcash","customDomains":["docs.hg.cash"],"gitSource":{"type":"github","owner":"hg-cash","repo":"docs","deployBranch":"main","isPrivate":false,"contentDirectory":"","mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acfc439cb49a971de3b5bc4","collectionId":"88a37c64-4af5-4fb8-8c52-f62ccc678143","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acfc439cb49a971de3b5bc4"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6acfc439cb49a971de3b5bc4","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"en","tag":"API reference","count":40},{"language":"en","tag":"API documentation","count":40},{"language":"es","tag":"Referencia API","count":40},{"language":"es","tag":"Documentación API","count":40},{"language":"pt-BR","tag":"Referência da API","count":40},{"language":"pt-BR","tag":"Documentação da API","count":40},{"language":"en","tag":"Documentation","count":14},{"language":"es","tag":"Documentación","count":14},{"language":"pt-BR","tag":"Documentação","count":14},{"language":"en","tag":"Countries","count":12},{"language":"es","tag":"Países","count":12},{"language":"pt-BR","tag":"Países","count":12},{"language":"en","tag":"Checkouts","count":9},{"language":"es","tag":"Checkouts","count":9},{"language":"pt-BR","tag":"Checkouts","count":9},{"language":"en","tag":"Venezuela","count":7},{"language":"es","tag":"Venezuela","count":7},{"language":"pt-BR","tag":"Venezuela","count":7},{"language":"en","tag":"Bolivia","count":6},{"language":"en","tag":"Chile","count":6},{"language":"es","tag":"Bolivia","count":6},{"language":"es","tag":"Chile","count":6},{"language":"pt-BR","tag":"Bolívia","count":6},{"language":"pt-BR","tag":"Chile","count":6},{"language":"en","tag":"Webhooks","count":5},{"language":"en","tag":"Brazil","count":5},{"language":"es","tag":"Brasil","count":5},{"language":"es","tag":"Colombia","count":5},{"language":"pt-BR","tag":"Brasil","count":5},{"language":"pt-BR","tag":"Colômbia","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/checkouts/create-checkout-session","slug":"/api-reference/checkouts/create-checkout-session","pageMetadata":{"title":"Create checkout session","description":"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout).\nColombia requires `country: \"CO\"`, `amount`, and `successUrl`. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them.\nThe payer opens `checkoutUrl`, completes payment, and returns to the HG success page. `successUrl` is used only after payment is confirmed.\nColombia create responses include `checkoutUrl` and omit `checkoutUrlProvider`. Colombia get, list, and cancel responses omit `providerData`. Chile create responses include `checkoutUrlProvider`.\n`expiresInSeconds` is optional. The default is 86400 seconds. The maximum is 604800 seconds.\nA `Bloqueada` or `Cerrada` account returns `403` with `code: ACCOUNT_NOT_OPERATIVE`. A `Restringida` account returns `403` with `code: RESTRICTED`. A COP account that is not ready for checkout returns `400` with `error: \"Account is not ready for checkout\"`. An account that is not a COP checkout account returns `400` with `error: \"Account is not supported for this checkout country\"`.\nIf the hosted session cannot be created, the API returns `502` with `error: \"Failed to create CO payment with provider\"`.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /checkouts","href":"/api-reference/checkouts/create-checkout-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout).\\nColombia requires \", _jsx(_components.code, {\n children: \"country: \\\"CO\\\"\"\n }), \", \", _jsx(_components.code, {\n children: \"amount\"\n }), \", and \", _jsx(_components.code, {\n children: \"successUrl\"\n }), \". It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them.\\nThe payer opens \", _jsx(_components.code, {\n children: \"checkoutUrl\"\n }), \", completes payment, and returns to the HG success page. \", _jsx(_components.code, {\n children: \"successUrl\"\n }), \" is used only after payment is confirmed.\\nColombia create responses include \", _jsx(_components.code, {\n children: \"checkoutUrl\"\n }), \" and omit \", _jsx(_components.code, {\n children: \"checkoutUrlProvider\"\n }), \". Colombia get, list, and cancel responses omit \", _jsx(_components.code, {\n children: \"providerData\"\n }), \". Chile create responses include \", _jsx(_components.code, {\n children: \"checkoutUrlProvider\"\n }), \".\\n\", _jsx(_components.code, {\n children: \"expiresInSeconds\"\n }), \" is optional. The default is 86400 seconds. The maximum is 604800 seconds.\\nA \", _jsx(_components.code, {\n children: \"Bloqueada\"\n }), \" or \", _jsx(_components.code, {\n children: \"Cerrada\"\n }), \" account returns \", _jsx(_components.code, {\n children: \"403\"\n }), \" with \", _jsx(_components.code, {\n children: \"code: ACCOUNT_NOT_OPERATIVE\"\n }), \". A \", _jsx(_components.code, {\n children: \"Restringida\"\n }), \" account returns \", _jsx(_components.code, {\n children: \"403\"\n }), \" with \", _jsx(_components.code, {\n children: \"code: RESTRICTED\"\n }), \". A COP account that is not ready for checkout returns \", _jsx(_components.code, {\n children: \"400\"\n }), \" with \", _jsx(_components.code, {\n children: \"error: \\\"Account is not ready for checkout\\\"\"\n }), \". An account that is not a COP checkout account returns \", _jsx(_components.code, {\n children: \"400\"\n }), \" with \", _jsx(_components.code, {\n children: \"error: \\\"Account is not supported for this checkout country\\\"\"\n }), \".\\nIf the hosted session cannot be created, the API returns \", _jsx(_components.code, {\n children: \"502\"\n }), \" with \", _jsx(_components.code, {\n children: \"error: \\\"Failed to create CO payment with provider\\\"\"\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 checkout session","description":"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout).\nColombia requires `country: \"CO\"`, `amount`, and `successUrl`. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them.\nThe payer opens `checkoutUrl`, completes payment, and returns to the HG success page. `successUrl` is used only after payment is confirmed.\nColombia create responses include `checkoutUrl` and omit `checkoutUrlProvider`. Colombia get, list, and cancel responses omit `providerData`. Chile create responses include `checkoutUrlProvider`.\n`expiresInSeconds` is optional. The default is 86400 seconds. The maximum is 604800 seconds.\nA `Bloqueada` or `Cerrada` account returns `403` with `code: ACCOUNT_NOT_OPERATIVE`. A `Restringida` account returns `403` with `code: RESTRICTED`. A COP account that is not ready for checkout returns `400` with `error: \"Account is not ready for checkout\"`. An account that is not a COP checkout account returns `400` with `error: \"Account is not supported for this checkout country\"`.\nIf the hosted session cannot be created, the API returns `502` with `error: \"Failed to create CO payment with provider\"`.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /checkouts","href":"/api-reference/checkouts/create-checkout-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create checkout session","description":"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout).\nColombia requires `country: \"CO\"`, `amount`, and `successUrl`. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them.\nThe payer opens `checkoutUrl`, completes payment, and returns to the HG success page. `successUrl` is used only after payment is confirmed.\nColombia create responses include `checkoutUrl` and omit `checkoutUrlProvider`. Colombia get, list, and cancel responses omit `providerData`. Chile create responses include `checkoutUrlProvider`.\n`expiresInSeconds` is optional. The default is 86400 seconds. The maximum is 604800 seconds.\nA `Bloqueada` or `Cerrada` account returns `403` with `code: ACCOUNT_NOT_OPERATIVE`. A `Restringida` account returns `403` with `code: RESTRICTED`. A COP account that is not ready for checkout returns `400` with `error: \"Account is not ready for checkout\"`. An account that is not a COP checkout account returns `400` with `error: \"Account is not supported for this checkout country\"`.\nIf the hosted session cannot be created, the API returns `502` with `error: \"Failed to create CO payment with provider\"`.\n","operationId":"createCheckout","tags":["Checkouts"],"requestBody":"4a42ad80-4377-4529-a44e-9bb6485f04ba","responses":{"201":"a149e56f-4429-4e67-9d5c-f07399d14ee2","400":"fe1efc5b-1bcc-41a1-b32f-1da9baea4c34","401":"688fb4e5-fdd9-49bc-90bc-a9930c1fba5b","403":"324dd035-a1d0-47d6-aa4f-1f155d52aba0","500":"4bb5eec4-2beb-41ae-a8f4-2c4b89d6307e","502":"5d451333-a4b3-4a40-80b1-4a2c7a9461ab"},"method":"post","type":"path","servers":["12af5893-7e81-40d6-b4de-2c4902e5d3cb","fad16a69-01f5-4ef7-b7ec-b6339fabe53a"],"security":["7fc60b91-2821-4b4b-ab75-355953735bf5"],"path":"/checkouts","baseUrlOptions":["https://hg.cash/api/v1","http://dev.hg.cash/api/v1"],"title":"Create checkout session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["country","amount","successUrl"],"properties":{"country":{"type":"string","enum":["AR","BR","CL","BO","CO"],"isRequired":true,"uniqueKey":"country","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Decimal amount as string","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"successUrl":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"successUrl","typeLabel":"string\u003curi>"},"accountId":{"type":"string","format":"uuid","uniqueKey":"accountId","typeLabel":"string\u003cuuid>"},"cancelUrl":{"type":"string","format":"uri","uniqueKey":"cancelUrl","typeLabel":"string\u003curi>"},"webhookUrl":{"type":"string","format":"uri","uniqueKey":"webhookUrl","typeLabel":"string\u003curi>"},"expiresInSeconds":{"type":"integer","description":"Optional. The default is 86400 seconds. The maximum is 604800 seconds.","uniqueKey":"expiresInSeconds","typeLabel":"integer"},"idempotencyKey":{"type":"string","uniqueKey":"idempotencyKey","typeLabel":"string"},"locale":{"type":"string","enum":["es","en"],"uniqueKey":"locale","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","uniqueKey":"metadata","typeLabel":"object"},"payer":{"type":"object","properties":{"name":{"type":"string","description":"Payer full name (required for BR and BO)","uniqueKey":"payer.name","typeLabel":"string"},"document":{"type":"string","description":"AR 8-digit DNI; BR payer CPF/CNPJ; BO payer CI/document","uniqueKey":"payer.document","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"payer.email","typeLabel":"string\u003cemail>"}},"description":"BR requires name, document, and email; BO requires name, document, and email. CO does not require payer fields.","uniqueKey":"payer","typeLabel":"object"},"paymentMethodId":{"type":"string","format":"uuid","description":"Required for CL","uniqueKey":"paymentMethodId","typeLabel":"string\u003cuuid>"},"customer":{"type":"object","description":"Required for CL (see ClInboundTransactionRequest customer fields)","uniqueKey":"customer","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":"\u003cstring>","successUrl":"\u003cstring>","accountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","cancelUrl":"\u003cstring>","webhookUrl":"\u003cstring>","expiresInSeconds":123,"idempotencyKey":"\u003cstring>","metadata":{},"payer":{"name":"\u003cstring>","document":"\u003cstring>","email":"jsmith@example.com"},"paymentMethodId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customer":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a149e56f-4429-4e67-9d5c-f07399d14ee2":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"publicToken":{"type":"string","uniqueKey":"publicToken","typeLabel":"string"},"checkoutUrl":{"type":"string","format":"uri","uniqueKey":"checkoutUrl","typeLabel":"string\u003curi>"},"status":{"type":"string","uniqueKey":"status","typeLabel":"string"},"expiresAt":{"type":"string","format":"date-time","uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time>"},"accountDisplay":{"type":"object","description":"Present for AR (CVU, alias, holder)","uniqueKey":"accountDisplay","typeLabel":"object"},"qrCode":{"type":"string","uniqueKey":"qrCode","typeLabel":"string"},"pixCopiaECola":{"type":"string","uniqueKey":"pixCopiaECola","typeLabel":"string"},"checkoutUrlProvider":{"type":"string","format":"uri","description":"Present for Chile. Omitted for Colombia.","uniqueKey":"checkoutUrlProvider","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","publicToken":"\u003cstring>","checkoutUrl":"\u003cstring>","status":"\u003cstring>","expiresAt":"2023-11-07T05:31:56Z","accountDisplay":{},"qrCode":"\u003cstring>","pixCopiaECola":"\u003cstring>","checkoutUrlProvider":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fe1efc5b-1bcc-41a1-b32f-1da9baea4c34":{"description":"Validation error, the COP account is not ready for checkout (`Account is not ready for checkout`), or the account is not a COP checkout account (`Account is not supported for this checkout country`)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"688fb4e5-fdd9-49bc-90bc-a9930c1fba5b":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"324dd035-a1d0-47d6-aa4f-1f155d52aba0":{"description":"Forbidden — account is not operative (`Bloqueada` or `Cerrada`, code `ACCOUNT_NOT_OPERATIVE`), is restricted (`Restringida`, code `RESTRICTED`), or caller lacks access","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"4bb5eec4-2beb-41ae-a8f4-2c4b89d6307e":{"description":"Internal Server Error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"5d451333-a4b3-4a40-80b1-4a2c7a9461ab":{"description":"A hosted session that cannot be created returns 502.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"7fc60b91-2821-4b4b-ab75-355953735bf5":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User API authentication token with format `cash_\u003c64-char-hex>`. Sample value `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"12af5893-7e81-40d6-b4de-2c4902e5d3cb":{"url":"https://hg.cash/api/v1","description":"Production server"},"fad16a69-01f5-4ef7-b7ec-b6339fabe53a":{"url":"http://dev.hg.cash/api/v1","description":"Development server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User API authentication token with format `cash_\u003c64-char-hex>`. Sample value `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"User API authentication token with format `cash_\u003c64-char-hex>`. Sample value `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"hgcash","siteName":"HG.Cash","title":"Create checkout session - HG.Cash","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/checkouts/create-checkout-session","matchLevel":0},"es":{"href":"/es/introduction","matchLevel":4},"pt-BR":{"href":"/pt-BR/introduction","matchLevel":4}}},"lastModified":"2026-10-14T18:05:26.612Z","originalFileLocation":"api-reference/checkouts/create-checkout-session.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout). Colombia requires country: \u0026quot;CO\u0026quot;, amount, and successUrl. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them. The payer opens checkoutUrl, completes payment, and returns to the HG success page. successUrl is used only after payment is confirmed. Colombia create responses include checkoutUrl and omit checkoutUrlProvider. Colombia get, list, and cancel responses omit providerData. Chile create responses include checkoutUrlProvider. expiresInSeconds is optional. The default is 86400 seconds. The maximum is 604800 seconds. A Bloqueada or Cerrada account returns 403 with code: ACCOUNT_NOT_OPERATIVE. A Restringida account returns 403 with code: RESTRICTED. A COP account that is not ready for checkout returns 400 with error: \u0026quot;Account is not ready for checkout\u0026quot;. An account that is not a COP checkout account returns 400 with error: \u0026quot;Account is not supported for this checkout country\u0026quot;. If the hosted session cannot be created, the API returns 502 with error: \u0026quot;Failed to create CO payment with provider\u0026quot;.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HG.Cash\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create checkout session - HG.Cash\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout). Colombia requires country: \u0026quot;CO\u0026quot;, amount, and successUrl. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them. The payer opens checkoutUrl, completes payment, and returns to the HG success page. successUrl is used only after payment is confirmed. Colombia create responses include checkoutUrl and omit checkoutUrlProvider. Colombia get, list, and cancel responses omit providerData. Chile create responses include checkoutUrlProvider. expiresInSeconds is optional. The default is 86400 seconds. The maximum is 604800 seconds. A Bloqueada or Cerrada account returns 403 with code: ACCOUNT_NOT_OPERATIVE. A Restringida account returns 403 with code: RESTRICTED. A COP account that is not ready for checkout returns 400 with error: \u0026quot;Account is not ready for checkout\u0026quot;. An account that is not a COP checkout account returns 400 with error: \u0026quot;Account is not supported for this checkout country\u0026quot;. If the hosted session cannot be created, the API returns 502 with error: \u0026quot;Failed to create CO payment with provider\u0026quot;.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HG.Cash\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hgcash.mintlify.app/_mintlify/api/og/v2?division=Checkouts\u0026amp;title=Create+checkout+session\u0026amp;description=Creates+a+hosted+checkout+for+AR+%28transfer+%2B+DNI+match%29%2C+BR+%28PIX+QR%29%2C+CL+%28hosted+iframe%29%2C+BO+%28Bolivia+QR%29%2C+or+CO+%28hosted+checkout%29.%0AColombia+requires+%60country%3A+\u0026amp;theme=5f052664f780b5ab336615ab\u0026amp;signature=e8476ea6aacc034fc3bf850a0291cbf111392d2a079f229581709e04d301d55d\">\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 checkout session - HG.Cash\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout). Colombia requires country: \u0026quot;CO\u0026quot;, amount, and successUrl. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them. The payer opens checkoutUrl, completes payment, and returns to the HG success page. successUrl is used only after payment is confirmed. Colombia create responses include checkoutUrl and omit checkoutUrlProvider. Colombia get, list, and cancel responses omit providerData. Chile create responses include checkoutUrlProvider. expiresInSeconds is optional. The default is 86400 seconds. The maximum is 604800 seconds. A Bloqueada or Cerrada account returns 403 with code: ACCOUNT_NOT_OPERATIVE. A Restringida account returns 403 with code: RESTRICTED. A COP account that is not ready for checkout returns 400 with error: \u0026quot;Account is not ready for checkout\u0026quot;. An account that is not a COP checkout account returns 400 with error: \u0026quot;Account is not supported for this checkout country\u0026quot;. If the hosted session cannot be created, the API returns 502 with error: \u0026quot;Failed to create CO payment with provider\u0026quot;.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hgcash.mintlify.app/_mintlify/api/og/v2?division=Checkouts\u0026amp;title=Create+checkout+session\u0026amp;description=Creates+a+hosted+checkout+for+AR+%28transfer+%2B+DNI+match%29%2C+BR+%28PIX+QR%29%2C+CL+%28hosted+iframe%29%2C+BO+%28Bolivia+QR%29%2C+or+CO+%28hosted+checkout%29.%0AColombia+requires+%60country%3A+\u0026amp;theme=5f052664f780b5ab336615ab\u0026amp;signature=e8476ea6aacc034fc3bf850a0291cbf111392d2a079f229581709e04d301d55d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hgcash/sds497DAsUCjzCOL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HG.Cash\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/checkouts/create-checkout-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hg.cash/#organization\",\"name\":\"HG.Cash\",\"url\":\"https://docs.hg.cash\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hgcash/k1h9DZri9LhvINuR/logo/light.png?fit=max\u0026auto=format\u0026n=k1h9DZri9LhvINuR\u0026q=85\u0026s=7d5990dbc96332e996531a671998285e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hg.cash#website\",\"name\":\"HG.Cash\",\"url\":\"https://docs.hg.cash\",\"publisher\":{\"@id\":\"https://docs.hg.cash/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session#webpage\",\"url\":\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session\",\"name\":\"Create checkout session\",\"description\":\"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout). Colombia requires country: \\\"CO\\\", amount, and successUrl. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them. The payer opens checkoutUrl, completes payment, and returns to the HG success page. successUrl is used only after payment is confirmed. Colombia create responses include checkoutUrl and omit checkoutUrlProvider. Colombia get, list, and cancel responses omit providerData. Chile create responses include checkoutUrlProvider. expiresInSeconds is optional. The default is 86400 seconds. The maximum is 604800 seconds. A Bloqueada or Cerrada account returns 403 with code: ACCOUNT_NOT_OPERATIVE. A Restringida account returns 403 with code: RESTRICTED. A COP account that is not ready for checkout returns 400 with error: \\\"Account is not ready for checkout\\\". An account that is not a COP checkout account returns 400 with error: \\\"Account is not supported for this checkout country\\\". If the hosted session cannot be created, the API returns 502 with error: \\\"Failed to create CO payment with provider\\\".\",\"dateModified\":\"2026-10-14T18:05:26.612Z\",\"isPartOf\":{\"@id\":\"https://docs.hg.cash#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API documentation\",\"item\":\"https://docs.hg.cash/api-reference/transactions/create-transaction-request-cash-out\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Checkouts\",\"item\":\"https://docs.hg.cash/api-reference/checkouts/list-checkouts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create checkout session\",\"item\":\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session#apireference\",\"headline\":\"Create checkout session\",\"name\":\"Create checkout session\",\"description\":\"Creates a hosted checkout for AR (transfer + DNI match), BR (PIX QR), CL (hosted iframe), BO (Bolivia QR), or CO (hosted checkout). Colombia requires country: \\\"CO\\\", amount, and successUrl. It does not require payer name, document, or email. HG configures the available payment methods; the create request does not choose them. The payer opens checkoutUrl, completes payment, and returns to the HG success page. successUrl is used only after payment is confirmed. Colombia create responses include checkoutUrl and omit checkoutUrlProvider. Colombia get, list, and cancel responses omit providerData. Chile create responses include checkoutUrlProvider. expiresInSeconds is optional. The default is 86400 seconds. The maximum is 604800 seconds. A Bloqueada or Cerrada account returns 403 with code: ACCOUNT_NOT_OPERATIVE. A Restringida account returns 403 with code: RESTRICTED. A COP account that is not ready for checkout returns 400 with error: \\\"Account is not ready for checkout\\\". An account that is not a COP checkout account returns 400 with error: \\\"Account is not supported for this checkout country\\\". If the hosted session cannot be created, the API returns 502 with error: \\\"Failed to create CO payment with provider\\\".\",\"url\":\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hg.cash/api-reference/checkouts/create-checkout-session#webpage\"},\"dateModified\":\"2026-10-14T18:05:26.612Z\",\"publisher\":{\"@id\":\"https://docs.hg.cash/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hg.cash#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HG.Cash\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"HG.Cash","nav":{"global":null,"languages":[{"language":"en","default":true,"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://hg.cash"}},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Countries","pages":[{"title":"Countries","href":"/countries/introduction"}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"group":"Transactions","pages":[{"title":"Create Transaction Request (Cash Out)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /transactions","href":"/api-reference/transactions/create-transaction-request-cash-out"},{"title":"Get Transaction Request Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transaction/{id}/status","href":"/api-reference/transactions/get-transaction-request-status"},{"title":"Get Transaction Receipt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transactions/{id}/receipt","href":"/api-reference/transactions/get-transaction-receipt"},{"title":"Get Transaction ID for Request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transaction-requests/{id}/transaction-id","href":"/api-reference/transactions/get-transaction-id-for-request"}]},{"group":"Checkouts","pages":[{"title":"List checkouts","description":"Lists checkout sessions. Colombia responses omit `providerData`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /checkouts","href":"/api-reference/checkouts/list-checkouts"},{"title":"Create checkout session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /checkouts","href":"/api-reference/checkouts/create-checkout-session"},{"title":"Get checkout","description":"Returns one checkout. Colombia responses omit `providerData`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /checkouts/{id}","href":"/api-reference/checkouts/get-checkout"},{"title":"Cancel pending checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /checkouts/{id}/cancel","href":"/api-reference/checkouts/cancel-pending-checkout"},{"title":"Get checkout receipt download URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /checkouts/{id}/receipt","href":"/api-reference/checkouts/get-checkout-receipt-download-url"}]},{"group":"Claims","pages":[{"title":"Create claim with receipt attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /claims","href":"/api-reference/claims/create-claim-with-receipt-attachment"},{"title":"Get claim by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /claims/{id}","href":"/api-reference/claims/get-claim-by-id"}]},{"group":"Brazil","pages":[{"title":"Create Inbound Transaction (Brazil)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /br/transactions/inbound","href":"/api-reference/brazil/create-inbound-transaction-brazil"},{"title":"Create Outbound Transaction (Brazil)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /br/transactions/outbound","href":"/api-reference/brazil/create-outbound-transaction-brazil"},{"title":"Get Transaction Status (Brazil)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /br/transactions/{id}/status","href":"/api-reference/brazil/get-transaction-status-brazil"}]},{"group":"Chile","pages":[{"title":"List payment methods (Chile)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cl/payment-methods","href":"/api-reference/chile/list-payment-methods-chile"},{"title":"Create Inbound Transaction (Chile)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cl/transactions/inbound","href":"/api-reference/chile/create-inbound-transaction-chile"},{"title":"Create Outbound Transaction (Chile)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /cl/transactions/outbound","href":"/api-reference/chile/create-outbound-transaction-chile"},{"title":"Get Transaction Status (Chile)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /cl/transactions/{id}/status","href":"/api-reference/chile/get-transaction-status-chile"}]},{"group":"Bolivia","pages":[{"title":"List banks (Bolivia ACH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bo/banks","href":"/api-reference/bolivia/list-banks-bolivia-ach"},{"title":"Create Inbound Transaction (Bolivia)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bo/transactions/inbound","href":"/api-reference/bolivia/create-inbound-transaction-bolivia"},{"title":"Create Outbound Transaction (Bolivia ACH)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bo/transactions/outbound","href":"/api-reference/bolivia/create-outbound-transaction-bolivia-ach"},{"title":"Get Transaction Status (Bolivia)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bo/transactions/{id}/status","href":"/api-reference/bolivia/get-transaction-status-bolivia"}]},{"group":"Colombia","pages":[{"title":"List banks (Colombia)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /co/banks","href":"/api-reference/colombia/list-banks-colombia"},{"title":"Create Outbound Transaction (Colombia)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /co/transactions/outbound","href":"/api-reference/colombia/create-outbound-transaction-colombia"},{"title":"Get Transaction Status (Colombia)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /co/transactions/{id}/status","href":"/api-reference/colombia/get-transaction-status-colombia"}]},{"group":"Venezuela","pages":[{"title":"List banks (Venezuela)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /ve/banks","href":"/api-reference/venezuela/list-banks-venezuela"},{"title":"Create inbound transaction (Venezuela)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /ve/transactions/inbound","href":"/api-reference/venezuela/create-inbound-transaction-venezuela"},{"title":"Check recipient (Venezuela)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /ve/recipients/kyc","href":"/api-reference/venezuela/check-recipient-venezuela"},{"title":"Create outbound transaction (Venezuela)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /ve/transactions/outbound","href":"/api-reference/venezuela/create-outbound-transaction-venezuela"},{"title":"Get transaction status (Venezuela)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /ve/transactions/{id}/status","href":"/api-reference/venezuela/get-transaction-status-venezuela"}]},{"group":"Reference Data","pages":[{"title":"Look up CVU or Alias","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /alias-lookup","href":"/api-reference/reference-data/look-up-cvu-or-alias"},{"title":"Get Transaction Statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transaction-statuses","href":"/api-reference/reference-data/get-transaction-statuses"},{"title":"Get Transaction Types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /transaction-types","href":"/api-reference/reference-data/get-transaction-types"}]},{"group":"Accounts","pages":[{"title":"Get User Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts","href":"/api-reference/accounts/get-user-accounts"},{"title":"Get Account Balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /account/{id}/balance","href":"/api-reference/accounts/get-account-balance"}]},{"group":"Webhooks","pages":[{"title":"Transaction request status updated","openapi":"api-reference/openapi.yaml webhook transaction-request-status-updated","href":"/api-reference/webhooks/transaction-request-status-updated"},{"title":"Transaction request associated with transaction","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook transaction-request-associated","href":"/api-reference/webhooks/transaction-request-associated-with-transaction"},{"title":"Account movement","openapi":"api-reference/openapi.yaml webhook account-movement","href":"/api-reference/webhooks/account-movement"},{"title":"Checkout event","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook checkout-completed","href":"/api-reference/webhooks/checkout-event"},{"title":"Claim status updated","openapi":"api-reference/openapi.yaml webhook claim-status-updated","href":"/api-reference/webhooks/claim-status-updated"}]}]}]}]},{"language":"es","navbar":{"primary":{"type":"button","label":"Ir al panel","href":"https://hg.cash"}},"pages":[{"title":"es","href":"/es/introduction"}]},{"language":"pt-BR","navbar":{"primary":{"type":"button","label":"Abrir painel","href":"https://hg.cash"}},"pages":[{"title":"pt-BR","href":"/pt-BR/introduction"}]}]},"basePath":"","title":"Create checkout session - HG.Cash","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}