{"items":[{"type":"link","label":"xMoney Crypto API","link":"/crypto_api/reference","routeSlug":"/crypto_api/reference","content":{"contentType":"overview","meta":{"name":"xMoney Crypto API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"integrations@xmoney.com","label":"integrations@xmoney.com","withCopyButton":true,"copyContent":"integrations@xmoney.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"ruby","title":"Ruby","lang":"Ruby"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"xMoney Crypto API (1.1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The xMoney Crypto API allows merchants to integrate cryptocurrency payments into their platforms. It follows RESTful principles and uses JSON:API specifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key features:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource-oriented URLs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard HTTP response codes and verbs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API keys are used for authentication to ensure secure communication. Webhooks are supported for real-time payment notifications."},"children":[]}]}]}]}],"sectionId":"/crypto_api/reference"}],"sectionId":"/crypto_api/reference"}]}]}},{"type":"group","label":"Order","link":"/crypto_api/reference/order","routeSlug":"/crypto_api/reference/order","items":[{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/crypto_api/reference/order/create-an-order","routeSlug":"/crypto_api/reference/order/create-an-order","metadata":{"seo":{"title":"Create an order","description":"Creates a new order for payment processing and returns a URL where the buyer can complete the payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-an-order","name":"Create an order","isWebhook":false,"pointer":"/paths/~1stores~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new order for payment processing and returns a URL where the buyer can complete the payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.api+json"],"mediaTypeSchemas":{"application/vnd.api+json":{"schemaId":"schema_126"}},"schemaId":"schema_126","pointer":"/paths/~1stores~1orders/post/requestBody","description":"The order information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stores/orders","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/vnd.api+json":{"schemaId":"schema_126"}},"responseCodes":["201"],"pointer":"/stores/orders","href":"order/create-an-order","openApiOperationId":"create-an-order","summary":"Create an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"schemaId":"schema_126","mediaTypes":["application/vnd.api+json"],"mediaTypeSchemas":{"application/vnd.api+json":{"schemaId":"schema_126"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created an order.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_127"}},"schemaId":"schema_127"}],"pointer":"/paths/~1stores~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_127","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_127"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/create-an-order"}],"panels":[]}]},"httpPath":"/stores/orders"},{"label":"List all orders of the merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/crypto_api/reference/order/listorders","routeSlug":"/crypto_api/reference/order/listorders","metadata":{"seo":{"title":"List all orders of the merchant","description":"List all orders of the merchant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrders","name":"List all orders of the merchant","isWebhook":false,"pointer":"/paths/~1stores~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all orders of the merchant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page[page]","in":"query","schemaId":"schema_128","description":"The 1-based page number to fetch (offset pagination)."},{"name":"page[size]","in":"query","schemaId":"schema_129","description":"The maximum number of results to return per page."},{"name":"filter[status]","in":"query","schemaId":"schema_130","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter orders by status. Accepts the high-level aliases "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"placed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a comma-separated combination of refund statuses (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund_proposed,refund_processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or an exact internal status string."},"children":[]}]}]}]},{"name":"filter[search]","in":"query","schemaId":"schema_131","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case-insensitive search matching the order "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer email, or part of the order UUID."},"children":[]}]}]}]},{"name":"filter[date_range]","in":"query","schemaId":"schema_132","description":"Filter orders by a predefined creation-date range."},{"name":"sort","in":"query","schemaId":"schema_133","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field. Prefix with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for descending order (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_134"}],"pointer":"/paths/~1stores~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stores/orders","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"parameters":{"path":[],"query":[{"name":"page[page]","in":"query","schemaId":"schema_128"},{"name":"page[size]","in":"query","schemaId":"schema_129"},{"name":"filter[status]","in":"query","example":"paid","schemaId":"schema_130"},{"name":"filter[search]","in":"query","schemaId":"schema_131"},{"name":"filter[date_range]","in":"query","schemaId":"schema_132"},{"name":"sort","in":"query","schemaId":"schema_133"},{"name":"include","in":"query","schemaId":"schema_134"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/stores/orders","href":"order/listorders","openApiOperationId":"listOrders","summary":"List all orders of the merchant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of orders for merchant","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_135"}},"schemaId":"schema_135"}],"pointer":"/paths/~1stores~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_135","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_135"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/listorders"}],"panels":[]}]},"httpPath":"/stores/orders"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/crypto_api/reference/order/retrieve-an-order","routeSlug":"/crypto_api/reference/order/retrieve-an-order","metadata":{"seo":{"title":"Retrieve an order","description":"Retrieve the details of an existing order using its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-an-order","name":"Retrieve an order","isWebhook":false,"pointer":"/paths/~1stores~1orders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of an existing order using its unique identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_136","description":"The unique identifier (UUID) of the order.","required":true}],"pointer":"/paths/~1stores~1orders~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_131","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of related resources to include in the response. Currently, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}]}],"pointer":"/paths/~1stores~1orders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stores/orders/{id}","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_136"}],"query":[{"name":"include","in":"query","schemaId":"schema_131"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/stores/orders/{id}","href":"order/retrieve-an-order","openApiOperationId":"retrieve-an-order","summary":"Retrieve an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order details retrieved successfully.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_137"}},"schemaId":"schema_137"},{"code":"404","description":"Order not found.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_138"}},"schemaId":"schema_138"}],"pointer":"/paths/~1stores~1orders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_137","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_137"}}},{"code":"404","schemaId":"schema_138","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_138"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/retrieve-an-order"}],"panels":[]}]},"httpPath":"/stores/orders/{id}"}],"content":{"contentType":"group","meta":{"name":"Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to managing orders."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stores/orders","summary":"Create an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/create-an-order","deprecated":false},{"title":"/stores/orders","summary":"List all orders of the merchant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/listorders","deprecated":false},{"title":"/stores/orders/{id}","summary":"Retrieve an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/retrieve-an-order","deprecated":false}]}]}]}]}},{"type":"group","label":"Refund","link":"/crypto_api/reference/refund","routeSlug":"/crypto_api/reference/refund","items":[{"label":"Creates a refund proposal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/crypto_api/reference/refund/createpaymentrefundproposal","routeSlug":"/crypto_api/reference/refund/createpaymentrefundproposal","metadata":{"seo":{"title":"Creates a refund proposal","description":"As a merchant you can only propose refunds; it is ultimately the buyer's decision to either accept or reject it (within a reasonable timeframe)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentRefundProposal","name":"Creates a refund proposal","isWebhook":false,"pointer":"/paths/~1stores~1refund~1{payment_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a refund proposal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a merchant you can only propose refunds; it is ultimately the buyer's decision to either accept or reject it (within a reasonable timeframe)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following rules apply when proposing a refund:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunds must be enabled for your merchant account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There can only be one active refund per payment. A new proposal is only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowed if the previous one was rejected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The proposed amount must be at least "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and cannot exceed the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"original payment total."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunds are not allowed for payments older than 3 months."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offramp payments cannot be refunded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A proposal that the buyer does not accept expires after 30 days, after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which its status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_136","description":"The unique identifier (UUID) of the payment to refund.","required":true}],"pointer":"/paths/~1stores~1refund~1{payment_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.api+json"],"mediaTypeSchemas":{"application/vnd.api+json":{"schemaId":"schema_139"}},"schemaId":"schema_139","pointer":"/paths/~1stores~1refund~1{payment_id}/post/requestBody","description":"Refund proposal to send to the buyer"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stores/refund/{payment_id}","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_136"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/vnd.api+json":{"schemaId":"schema_139"}},"responseCodes":["200","401","404"],"pointer":"/stores/refund/{payment_id}","href":"refund/createpaymentrefundproposal","openApiOperationId":"createPaymentRefundProposal","summary":"Creates a refund proposal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"schemaId":"schema_139","mediaTypes":["application/vnd.api+json"],"mediaTypeSchemas":{"application/vnd.api+json":{"schemaId":"schema_139"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Refund details","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_140"}},"schemaId":"schema_140"},{"code":"401","description":"Refund not Allowed","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_141"}},"schemaId":"schema_141"},{"code":"404","description":"Refund not found","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1stores~1refund~1{payment_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_140","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_140"}}},{"code":"401","schemaId":"schema_141","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_141"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund/createpaymentrefundproposal"}],"panels":[]}]},"httpPath":"/stores/refund/{payment_id}"},{"label":"Returns a refund for the given payment, if there is one","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/crypto_api/reference/refund/getpaymentrefund","routeSlug":"/crypto_api/reference/refund/getpaymentrefund","metadata":{"seo":{"title":"Returns a refund for the given payment, if there is one","description":"Returns a refund for the given payment, if there is one"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentRefund","name":"Returns a refund for the given payment, if there is one","isWebhook":false,"pointer":"/paths/~1stores~1refund~1{payment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a refund for the given payment, if there is one","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_136","description":"The unique identifier (UUID) of the order to operate on.","required":true}],"pointer":"/paths/~1stores~1refund~1{payment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stores/refund/{payment_id}","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_136"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/stores/refund/{payment_id}","href":"refund/getpaymentrefund","openApiOperationId":"getPaymentRefund","summary":"Returns a refund for the given payment, if there is one"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Refund details","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_140"}},"schemaId":"schema_140"},{"code":"404","description":"Refund not found","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_142"}},"schemaId":"schema_142"}],"pointer":"/paths/~1stores~1refund~1{payment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_140","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_140"}}},{"code":"404","schemaId":"schema_142","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_142"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund/getpaymentrefund"}],"panels":[]}]},"httpPath":"/stores/refund/{payment_id}"}],"content":{"contentType":"group","meta":{"name":"Refund"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to proposing and retrieving refunds."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stores/refund/{payment_id}","summary":"Creates a refund proposal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refund/createpaymentrefundproposal","deprecated":false},{"title":"/stores/refund/{payment_id}","summary":"Returns a refund for the given payment, if there is one","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refund/getpaymentrefund","deprecated":false}]}]}]}]}},{"type":"group","label":"Currency","link":"/crypto_api/reference/currency","routeSlug":"/crypto_api/reference/currency","items":[{"label":"List the store's available currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/crypto_api/reference/currency/listavailablecurrencies","routeSlug":"/crypto_api/reference/currency/listavailablecurrencies","metadata":{"seo":{"title":"List the store's available currencies","description":"Returns the cryptocurrency and blockchain-network pairs that the store accepts. The list depends on the currencies enabled for your store. Common pairs include BTC on BTC, ETH on ETH, USDC on ETH, USDT on ETH, and EGLD on MultiversX."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAvailableCurrencies","name":"List the store's available currencies","isWebhook":false,"pointer":"/paths/~1stores~1available_currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the store's available currencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the cryptocurrency and blockchain-network pairs that the store accepts. The list depends on the currencies enabled for your store. Common pairs include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USDC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USDT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EGLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MultiversX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stores/available_currencies","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/stores/available_currencies","href":"currency/listavailablecurrencies","openApiOperationId":"listAvailableCurrencies","summary":"List the store's available currencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of accepted currency/blockchain pairs.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_143"}},"schemaId":"schema_143"},{"code":"401","description":"Unauthorized.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1stores~1available_currencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_143","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_143"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency/listavailablecurrencies"}],"panels":[]}]},"httpPath":"/stores/available_currencies"}],"content":{"contentType":"group","meta":{"name":"Currency"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Currency","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to the currencies a store accepts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stores/available_currencies","summary":"List the store's available currencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currency/listavailablecurrencies","deprecated":false}]}]}]}]}},{"type":"group","label":"Exchange rate","link":"/crypto_api/reference/exchange-rate","routeSlug":"/crypto_api/reference/exchange-rate","items":[{"label":"Create an exchange rate quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/crypto_api/reference/exchange-rate/createexchangerate","routeSlug":"/crypto_api/reference/exchange-rate/createexchangerate","metadata":{"seo":{"title":"Create an exchange rate quote","description":"Creates a short-lived (60 second) exchange-rate quote between two currencies. For crypto quotes, from must be a crypto currency the store accepts and to must be a supported settlement currency."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExchangeRate","name":"Create an exchange rate quote","isWebhook":false,"pointer":"/paths/~1stores~1exchange_rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an exchange rate quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a short-lived (60 second) exchange-rate quote between two currencies. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crypto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quotes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a crypto currency the store accepts and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a supported settlement currency."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.api+json"],"mediaTypeSchemas":{"application/vnd.api+json":{"schemaId":"schema_144"}},"schemaId":"schema_144","pointer":"/paths/~1stores~1exchange_rates/post/requestBody","description":"The currency pair to quote."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stores/exchange_rates","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/vnd.api+json":{"schemaId":"schema_144"}},"responseCodes":["201","401"],"pointer":"/stores/exchange_rates","href":"exchange-rate/createexchangerate","openApiOperationId":"createExchangeRate","summary":"Create an exchange rate quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"schemaId":"schema_144","mediaTypes":["application/vnd.api+json"],"mediaTypeSchemas":{"application/vnd.api+json":{"schemaId":"schema_144"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Exchange rate quote created.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_145"}},"schemaId":"schema_145"},{"code":"401","description":"Unauthorized.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1stores~1exchange_rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_145","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_145"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-rate/createexchangerate"}],"panels":[]}]},"httpPath":"/stores/exchange_rates"}],"content":{"contentType":"group","meta":{"name":"Exchange rate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange rate","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to exchange-rate quotes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stores/exchange_rates","summary":"Create an exchange rate quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exchange-rate/createexchangerate","deprecated":false}]}]}]}]}},{"type":"group","label":"Session","link":"/crypto_api/reference/session","routeSlug":"/crypto_api/reference/session","items":[{"label":"Exchange credentials for an API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/crypto_api/reference/session/createsession","routeSlug":"/crypto_api/reference/session/createsession","metadata":{"seo":{"title":"Exchange credentials for an API key","description":"Exchanges a store's client_id and client_secret for its API key, which can then be used as the Bearer token for authenticated requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSession","name":"Exchange credentials for an API key","isWebhook":false,"pointer":"/paths/~1stores~1session/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange credentials for an API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchanges a store's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for its API key, which can then be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" token for authenticated requests."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/vnd.api+json"],"mediaTypeSchemas":{"application/vnd.api+json":{"schemaId":"schema_146"}},"schemaId":"schema_146","pointer":"/paths/~1stores~1session/post/requestBody","description":"The store credentials to exchange."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stores/session","servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/vnd.api+json":{"schemaId":"schema_146"}},"responseCodes":["200","401"],"pointer":"/stores/session","href":"session/createsession","openApiOperationId":"createSession","summary":"Exchange credentials for an API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/crypto_api/reference","description":"Development","isMockServer":true},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}],"schemaId":"schema_146","mediaTypes":["application/vnd.api+json"],"mediaTypeSchemas":{"application/vnd.api+json":{"schemaId":"schema_146"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store API key.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_147"}},"schemaId":"schema_147"},{"code":"401","description":"Authentication failed.","mediaType":"application/vnd.api+json","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1stores~1session/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_147","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"schema_147"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/vnd.api+json"],"mediaTypeContent":{"application/vnd.api+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session/createsession"}],"panels":[]}]},"httpPath":"/stores/session"}],"content":{"contentType":"group","meta":{"name":"Session"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Session","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to exchanging credentials for an API key."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stores/session","summary":"Exchange credentials for an API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/session/createsession","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"type":"object","description":"Represents an amount with currency and optional details.","properties":{"total":{"type":"string","format":"decimal","example":"1090.00","description":"The total amount, formatted as a decimal string (e.g., \"1090.00\")."},"currency":{"type":"string","example":"USD","enum":["AED","ARS","AUD","BRL","CAD","CHF","CLP","CNY","CZK","DKK","DOP","EUR","GBP","HKD","HUF","IDR","ILS","INR","JPY","KRW","MYR","MXN","NOK","NZD","PHP","PKR","PLN","RON","RUB","SEK","SGD","THB","TWD","USD","ZAR"],"description":"The 3-letter currency code (ISO 4217)."},"details":{"type":"object","description":"Optional details about the amount breakdown.","properties":{"subtotal":{"type":"string","format":"decimal","example":"39.00","description":"The subtotal amount."},"shipping":{"type":"string","format":"decimal","example":"1.00","description":"The shipping amount."},"tax":{"type":"string","format":"decimal","example":"1.00","description":"The tax amount."},"discount":{"type":"string","format":"decimal","example":"2.00","description":"The discount amount."}}}},"required":["total","currency"]}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"type":"object","description":"Represents a currency value.","properties":{"value":{"type":"string","format":"decimal","example":"40.00","description":"The numerical value of the currency."},"currency":{"type":"string","example":"USD","description":"The 3-letter currency code (ISO 4217)."}}}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"type":"object","description":"Represents customer information.","properties":{"name":{"type":"string","example":"John Doe","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name of the customer (first_name + last_name). Only available in responses."},"children":[]}]}]}]},"first_name":{"type":"string","example":"John","description":"The customer's first name."},"last_name":{"type":"string","example":"Doe","description":"The customer's last name."},"email":{"type":"string","format":"email","example":"john@example.com","description":"The customer's email address."},"billing_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full billing address (address1 + address2). Only available in responses."},"children":[]}]}]}],"example":"118 Main St"},"address1":{"type":"string","description":"The first line of the billing address.","example":"118 Main St"},"address2":{"type":"string","description":"The second line of the billing address (optional).","example":"Apartment 1"},"city":{"type":"string","description":"The billing city.","example":"Anytown"},"state":{"type":"string","description":"The billing state or region.","example":"CA"},"postcode":{"type":"string","description":"The billing postal code.","example":"12345"},"country":{"type":"string","description":"The billing country code (ISO 3166-1 alpha-2).","example":"US"}},"required":["email","country"]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","description":"Represents an error response.","properties":{"errors":{"type":"array","description":"A list of errors.","items":{"type":"object","properties":{"detail":{"type":"string","description":"A human-readable explanation of the error.","example":"Explanation of the problem."}}}}}}},"components/schemas/OrderInput":{"id":"components/schemas/OrderInput","kind":"json-schema","title":"OrderInput","data":{"type":"object","description":"Represents the input data for creating an order.","properties":{"reference":{"type":"string","example":"order-1977","description":"Your internal reference for the order."},"amount":{"allOf":[{"$ref":"#/components/schemas/Amount"}],"example":{"total":"1090.00","currency":"USD","details":{"subtotal":"98.00","shipping":"10.00","tax":"3.00","discount":"2.00"}},"description":"The amount details for the order."},"return_urls":{"type":"object","description":"URLs for redirecting the user after payment.","properties":{"return_url":{"type":"string","description":"URL to redirect to upon successful payment.","format":"url","example":"https://example.com/success"},"cancel_url":{"type":"string","description":"URL to redirect to if the payment is canceled.","format":"url","example":"https://example.com/cancel"},"callback_url":{"type":"string","description":"URL to send webhooks to for payment status updates.","format":"url","example":"https://example.com/webhook"}},"required":["return_url"]},"line_items":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/LineItem"},"description":"Deprecated. Line items are no longer used when creating an order; any value provided here is ignored."}},"required":["reference","amount","return_urls"]}},"components/schemas/LineItem":{"id":"components/schemas/LineItem","kind":"json-schema","title":"LineItem","data":{"type":"object","description":"Represents a line item in an order (deprecated).","properties":{"sku":{"type":"string","example":"tsh-6110","description":"The SKU (Stock Keeping Unit) of the item."},"name":{"type":"string","example":"T-Shirt White Large","description":"The name of the item."},"price":{"type":"string","example":"100.00","description":"The price of the item."},"currency":{"type":"string","example":"USD","description":"The currency of the item price."},"quantity":{"type":"integer","minimum":1,"example":5,"description":"The quantity of the item."}},"required":["name","price","currency","quantity"]}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"type":"object","description":"Represents an order.","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/UUID"}],"description":"The unique identifier (UUID) of the order."},"type":{"type":"string","enum":["orders"],"description":"The type of resource. Always 'orders'."},"attributes":{"type":"object","description":"Attributes of the order.","properties":{"status":{"type":"string","enum":["pending","paid","cancelled","refund_proposed","refund_processing","refund_completed","refund_expired","in_dispute","in_claim","unsupported_country"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the order. The most common values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (an expired or cancelled order). Refund- and dispute-related statuses ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund_proposed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund_processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund_completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund_expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_claim"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsupported_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may also be returned for orders that have progressed beyond a simple payment."},"children":[]}]}]}]},"reference":{"type":"string","example":"order-1977","description":"Your internal reference for the order."},"created_at":{"type":"string","format":"date-time","example":"2018-04-26T12:48:11.954503","description":"The date and time when the order was created."},"total_amount":{"allOf":[{"$ref":"#/components/schemas/Currency"}],"description":"The total amount of the order."},"reference_amount":{"allOf":[{"$ref":"#/components/schemas/Currency"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order total converted to the merchant's reference currency, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not available."},"children":[]}]}]}]},"settlement_amount":{"allOf":[{"$ref":"#/components/schemas/Currency"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount settled to the merchant, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the order has not been settled yet."},"children":[]}]}]}]},"pricing_details":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Breakdown of the order amount. Each entry is a currency value or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"subtotal":{"allOf":[{"$ref":"#/components/schemas/Currency"}]},"shipping":{"allOf":[{"$ref":"#/components/schemas/Currency"}]},"tax":{"allOf":[{"$ref":"#/components/schemas/Currency"}]},"discount":{"allOf":[{"$ref":"#/components/schemas/Currency"}]}}},"customer":{"$ref":"#/components/schemas/Customer"},"merchant_uuid":{"allOf":[{"$ref":"#/components/schemas/UUID"}],"description":"The unique identifier (UUID) of the merchant."},"payment_uuid":{"allOf":[{"$ref":"#/components/schemas/UUID"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier (UUID) of the payment associated with the order, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the order has not been paid."},"children":[]}]}]}]},"dispute_id":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the dispute associated with the order, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when there is no dispute."},"children":[]}]}]}]},"refundable":{"type":"boolean","description":"Whether the order's payment is currently eligible for a refund proposal."},"items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"},"deprecated":true,"description":"The items included in the order (deprecated)."}}}}}},"components/schemas/Refund":{"id":"components/schemas/Refund","kind":"json-schema","title":"Refund","data":{"type":"object","properties":{"id":{"type":"string","example":"payment-c8d65cc2-0c82-429a-95ea-3f65011fc2cc","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The refund identifier. There is at most one refund per payment, so the id has the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment-{payment_uuid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type":{"type":"string","enum":["refunds"]},"attributes":{"type":"object","properties":{"requested_amount":{"type":"string","description":"Value that was proposed"},"requested_currency":{"type":"string","description":"Currency in which the refund was proposed (this will match the currency used by the store at the time of purchase)"},"status":{"type":"string","enum":["proposed","accepted","rejected","complete","processing","expired"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the refund. A merchant proposal starts as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proposed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; once the buyer accepts it becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while the on-chain refund is executed, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when finished. A proposal can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by the buyer or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it is not accepted within the allowed window."},"children":[]}]}]}]},"reason":{"type":"string","description":"Reason provided by the merchant to propose a refund"},"proposed_by":{"type":"string","description":"The email address of the merchant contact that proposed the refund."}}}}}},"components/schemas/AvailableCurrency":{"id":"components/schemas/AvailableCurrency","kind":"json-schema","title":"AvailableCurrency","data":{"type":"object","description":"A cryptocurrency / blockchain-network pair accepted by the store.","properties":{"type":{"type":"string","enum":["currencies"],"description":"The type of resource. Always 'currencies'."},"attributes":{"type":"object","properties":{"currency":{"type":"string","example":"USDC","description":"The cryptocurrency code."},"blockchain":{"type":"string","example":"ETH","description":"The blockchain network the currency is accepted on."}}}}}},"components/schemas/ExchangeRate":{"id":"components/schemas/ExchangeRate","kind":"json-schema","title":"ExchangeRate","data":{"type":"object","description":"A short-lived exchange-rate quote.","properties":{"type":{"type":"string","enum":["exchange_rates"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of resource. Always 'exchange_rates'."},"children":[]}]}]}]},"id":{"allOf":[{"$ref":"#/components/schemas/UUID"}],"description":"The unique identifier (UUID) of the quote."},"attributes":{"type":"object","properties":{"from":{"type":"string","example":"BTC","description":"The source currency code."},"to":{"type":"string","example":"EUR","description":"The target currency code."},"rate":{"type":"string","example":"57000.00","description":"The quoted exchange rate."},"expires_at":{"type":"string","format":"date-time","description":"When the quote expires (60 seconds after creation)."}}}}}},"components/schemas/UUID":{"id":"components/schemas/UUID","kind":"json-schema","title":"UUID","data":{"type":"string","format":"UUID","example":"c8d65cc2-0c82-429a-95ea-3f65011fc2cc","description":"A universally unique identifier (UUID)."}},"schema_126":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["orders"]},"attributes":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInput"},"customer":{"$ref":"#/components/schemas/Customer"}},"required":["order","customer"]}}}}},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["orders_redirect"]},"id":{"allOf":[{"$ref":"#/components/schemas/UUID"}]},"attributes":{"type":"object","properties":{"redirect_url":{"type":"string","format":"URL","example":"https://bill.crypto.xmoney.com/uuid"}}}}}}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"string","example":"paid"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"string"},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"string","default":"all","enum":["all","current_day","last_day","current_week","last_week","current_month","last_month","current_year"]},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"string","enum":["created_at","reference","customer_email","currency","total","settlement_amount","status"]},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"string","enum":["payment"]},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":[{"$ref":"#/components/schemas/Order"}]}}},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"string","format":"UUID"},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Order"}}},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"Order not found"}}}}}},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["payment_refund_proposal"]},"attributes":{"type":"object","properties":{"amount":{"type":"string","example":"10.90"},"reason":{"type":"string","example":"Shirt size did not fit"}},"required":["amount"]}}}}},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Refund"}}},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"Refund not Allowed"}}}}}},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"Refund not found"}}}}}},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AvailableCurrency"}}}},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["exchange_rates"]},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["crypto","fiat"],"default":"crypto","description":"The kind of quote to create."},"from":{"type":"string","example":"BTC","description":"The source currency code."},"to":{"type":"string","example":"EUR","description":"The target currency code."}},"required":["from","to"]}}}}},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExchangeRate"}}},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["session"]},"attributes":{"type":"object","properties":{"client_id":{"type":"string","description":"The store access key."},"client_secret":{"type":"string","description":"The store secret key."}},"required":["client_id","client_secret"]}}}}},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["session"]},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The store API key (same value as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute)."},"children":[]}]}]}]},"attributes":{"type":"object","properties":{"token":{"type":"string","description":"The store API key to use as the Bearer token."}}}}}}},"id":"schema_147"}},"exampleStore":{},"securitySchemeStore":{"ApiKey":{"id":"ApiKey","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate requests using your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"u_test_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <api-key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer u_live_XXXXXXXXXXXXXXXXXXXXXXXX"},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"/_mock/crypto_api/reference","isMockServer":true,"description":"Development"},{"url":"https://merchants.api.crypto.xmoney.com/api","description":"Production server (live)"},{"url":"https://merchants.api.sandbox.crypto.xmoney.com/api","description":"Sandbox server (test)"}]},"options":{"sortRequiredPropsFirst":true,"layout":"three-panel","hideDownloadButtons":true,"hideSchemaTitles":true,"hideInfoMetadata":true,"onlyRequiredInSamples":true,"sanitize":true,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"PHP"},{"lang":"Python"},{"lang":"Java"},{"lang":"Ruby"}]},"hideSidebar":true,"mockServer":{"url":"/_mock/crypto_api/reference","position":"first","description":"Development","strictExamples":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/crypto_api/reference.json?download"},{"url":"/_bundle/crypto_api/reference.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"xMoney Crypto API","description":"The xMoney Crypto API allows merchants to integrate cryptocurrency payments into their platforms. It follows RESTful principles and uses JSON:API specifications. \n\nKey features:\n\n* Resource-oriented URLs\n* JSON responses\n* Standard HTTP response codes and verbs\n\nAPI keys are used for authentication to ensure secure communication. Webhooks are supported for real-time payment notifications.\n"}},"baseSlug":"/crypto_api/reference","routesMapping":{}}