openapi: 3.0.3 info: title: 'Munzen Merchant API documentation' description: '' version: 1.0.0 servers: - url: 'https://crp-backend.munzen.io' paths: '/api/v1/merchant/invoices/{invoiceId}': get: summary: 'Get invoice by id' operationId: getInvoiceById description: 'Shows information about invoice with provided ID.' parameters: - in: query name: timestamp description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: true schema: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 - in: header name: X-Munzen-Key description: '' example: cahedD8f5164EaVkZ3gvbP6 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-73b8-72b2-8089-8f9eea1e7dbe short_id: Yu8cDwLX4nvPFVnYMje7J number: 32851181 price_currency: EUR price_amount: '85.85' pay_currency: BCH pay_amount: '720.94667359' exchange_rate: '8.39792069' exchange_rate_expires_at: '2025-04-23T11:49:22.000000Z' address: vK9YEhT705fYKONlrvZW5PxsuMBJjy address_tag: ov2kM address_uri: 'bitcoincash:vK9YEhT705fYKONlrvZW5PxsuMBJjy?amount=720.94667359' paid_amount: '12030166.652762' paid_amount_minus_fee: '12030111.500341' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: BCH received_amount: '12030111.500341' conversion_exchange_rate: null fees: processing_invoice: currency: BCH amount: '55.15242053' fiat_amounts: [] external_id: '965' customer_external_id: 0aIdBPKTxsNAkdSu external_data: '{"foo":"bar"}' name: 'Prof. Mohammed Dickens' description: 'Gunner Roob' redirect_url: 'https://schaden.biz/eum-quam-sed-sit-iusto-et.html' failure_redirect_url: 'https://gorczany.biz/possimus-debitis-exercitationem-et-rerum-eligendi-magnam-mollitia.html' created_at: '2025-04-23T11:34:22.000000Z' expires_at: '2025-04-23T12:04:22.000000Z' status: paid_partially status_context: underpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196626d-73b8-72b2-8089-8f9eea1e7dbe short_id: type: string example: Yu8cDwLX4nvPFVnYMje7J number: type: integer example: 32851181 price_currency: type: string example: EUR price_amount: type: string example: '85.85' pay_currency: type: string example: BCH pay_amount: type: string example: '720.94667359' exchange_rate: type: string example: '8.39792069' exchange_rate_expires_at: type: string example: '2025-04-23T11:49:22.000000Z' address: type: string example: vK9YEhT705fYKONlrvZW5PxsuMBJjy address_tag: type: string example: ov2kM address_uri: type: string example: 'bitcoincash:vK9YEhT705fYKONlrvZW5PxsuMBJjy?amount=720.94667359' paid_amount: type: string example: '12030166.652762' paid_amount_minus_fee: type: string example: '12030111.500341' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: BCH received_amount: type: string example: '12030111.500341' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: BCH amount: type: string example: '55.15242053' fiat_amounts: type: array example: [] external_id: type: string example: '965' customer_external_id: type: string example: 0aIdBPKTxsNAkdSu external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Prof. Mohammed Dickens' description: type: string example: 'Gunner Roob' redirect_url: type: string example: 'https://schaden.biz/eum-quam-sed-sit-iusto-et.html' failure_redirect_url: type: string example: 'https://gorczany.biz/possimus-debitis-exercitationem-et-rerum-eligendi-magnam-mollitia.html' created_at: type: string example: '2025-04-23T11:34:22.000000Z' expires_at: type: string example: '2025-04-23T12:04:22.000000Z' status: type: string example: paid_partially status_context: type: string example: underpaid status_reason: type: string example: null can_be_paid_partially: type: boolean example: true error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 404: description: 'Requested resource was not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' 422: description: 'Non-UUID invoice ID in url' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'Invoice ID url param must be valid UUID.' properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'Invoice ID url param must be valid UUID.' 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' delete: summary: 'Cancel invoice' operationId: cancelInvoice description: "Cancels customer's invoice by id or 404 error." parameters: - in: header name: X-Munzen-Key description: '' example: bdg4D15f8vekVcP6ZE3haa6 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: { } error: null properties: data: type: object properties: { } error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 404: description: 'Not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' requestBody: required: true content: application/json: schema: type: object properties: timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: - timestamp parameters: - in: path name: invoiceId description: 'The ID of the invoice.' example: 48e81488-9fb7-4771-a599-8d99df10456c required: true schema: type: uuid '/api/v1/merchant/invoices/by-external-id/{externalId}': get: summary: 'Get invoice by externalId' operationId: getInvoiceByExternalId description: 'Shows information about invoice with provided externalId.' parameters: - in: query name: timestamp description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: true schema: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 - in: header name: X-Munzen-Key description: '' example: bEDkf6Z8Pv4ghca3V61ade5 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-73f4-7196-84f9-0f7b15225885 short_id: wuFnNJFwAGau3U8ZMje7J number: 97401000 price_currency: UAH price_amount: '3602751.92' pay_currency: USDCBEP20 pay_amount: '5676962.5216589' exchange_rate: '1.57572951' exchange_rate_expires_at: '2025-04-23T11:48:22.000000Z' address: CYd0ubhJBeJFU4Ug8FdeJvCmvNSbNP address_tag: zgR8T address_uri: 'ethereum:CYd0ubhJBeJFU4Ug8FdeJvCmvNSbNP?amount=5676962.5216589' paid_amount: '60160768.2833' paid_amount_minus_fee: '59749756.196732' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCBEP20 received_amount: '59749756.196732' conversion_exchange_rate: null fees: processing_invoice: currency: USDCBEP20 amount: '411012.0865681' fiat_amounts: [] external_id: '220' customer_external_id: kI1WiqLmGu29xEnQ external_data: '{"foo":"bar"}' name: 'Kacie Doyle' description: 'Earl Gorczany Jr.' redirect_url: 'https://bailey.net/incidunt-quos-dolorum-commodi-amet-sit-velit-quia-amet.html' failure_redirect_url: 'http://mertz.com/repellendus-sunt-aut-minus-dolores-et-id.html' created_at: '2025-04-23T11:34:22.000000Z' expires_at: '2025-04-23T12:01:22.000000Z' status: refunded status_context: underpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196626d-73f4-7196-84f9-0f7b15225885 short_id: type: string example: wuFnNJFwAGau3U8ZMje7J number: type: integer example: 97401000 price_currency: type: string example: UAH price_amount: type: string example: '3602751.92' pay_currency: type: string example: USDCBEP20 pay_amount: type: string example: '5676962.5216589' exchange_rate: type: string example: '1.57572951' exchange_rate_expires_at: type: string example: '2025-04-23T11:48:22.000000Z' address: type: string example: CYd0ubhJBeJFU4Ug8FdeJvCmvNSbNP address_tag: type: string example: zgR8T address_uri: type: string example: 'ethereum:CYd0ubhJBeJFU4Ug8FdeJvCmvNSbNP?amount=5676962.5216589' paid_amount: type: string example: '60160768.2833' paid_amount_minus_fee: type: string example: '59749756.196732' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDCBEP20 received_amount: type: string example: '59749756.196732' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDCBEP20 amount: type: string example: '411012.0865681' fiat_amounts: type: array example: [] external_id: type: string example: '220' customer_external_id: type: string example: kI1WiqLmGu29xEnQ external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Kacie Doyle' description: type: string example: 'Earl Gorczany Jr.' redirect_url: type: string example: 'https://bailey.net/incidunt-quos-dolorum-commodi-amet-sit-velit-quia-amet.html' failure_redirect_url: type: string example: 'http://mertz.com/repellendus-sunt-aut-minus-dolores-et-id.html' created_at: type: string example: '2025-04-23T11:34:22.000000Z' expires_at: type: string example: '2025-04-23T12:01:22.000000Z' status: type: string example: refunded status_context: type: string example: underpaid status_reason: type: string example: null can_be_paid_partially: type: boolean example: true error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 404: description: 'Requested resource was not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' parameters: - in: path name: externalId description: 'The external ID of the invoice.' example: 48e899dfd9gb453sds10456c required: true schema: type: string /api/v1/merchant/invoices: post: summary: 'Create invoice' operationId: createInvoice description: 'Creates new invoice with provided data and shows information about it.' parameters: - in: header name: X-Munzen-Key description: '' example: 6cg8ZV5aDda13f4kEebvPh6 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-742b-7026-878d-f941ab1e7c22 short_id: qxoznmvpMCzCfrRZMje7J number: 1019328 price_currency: KZT price_amount: '8400.55' pay_currency: ETHBASE pay_amount: '59398.192164654' exchange_rate: '7.07075155' exchange_rate_expires_at: '2025-04-23T11:47:22.000000Z' address: ulu87t3Dw6qDFnm4kKeQBE5eWHgF4H address_tag: uK5Oj address_uri: 'ethereum:ulu87t3Dw6qDFnm4kKeQBE5eWHgF4H?amount=59398.192164654' paid_amount: '66.43755939' paid_amount_minus_fee: '-2351.0688617114' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: ETHBASE received_amount: '-2351.0688617114' conversion_exchange_rate: null fees: processing_invoice: currency: ETHBASE amount: '2417.5064211014' fiat_amounts: [] external_id: '878' customer_external_id: yFPNBwLFJ4ZzPxUQ external_data: '{"foo":"bar"}' name: 'Johnathan Grant' description: 'Derick Wilkinson' redirect_url: 'http://langworth.com/tenetur-veritatis-cumque-repellendus-est-sit' failure_redirect_url: 'http://jones.com/tenetur-nesciunt-quia-officia-quam-deserunt' created_at: '2025-04-23T11:34:22.000000Z' expires_at: '2025-04-23T11:54:22.000000Z' status: created status_context: underpaid status_reason: null can_be_paid_partially: false error: null properties: data: type: object properties: id: type: string example: 0196626d-742b-7026-878d-f941ab1e7c22 short_id: type: string example: qxoznmvpMCzCfrRZMje7J number: type: integer example: 1019328 price_currency: type: string example: KZT price_amount: type: string example: '8400.55' pay_currency: type: string example: ETHBASE pay_amount: type: string example: '59398.192164654' exchange_rate: type: string example: '7.07075155' exchange_rate_expires_at: type: string example: '2025-04-23T11:47:22.000000Z' address: type: string example: ulu87t3Dw6qDFnm4kKeQBE5eWHgF4H address_tag: type: string example: uK5Oj address_uri: type: string example: 'ethereum:ulu87t3Dw6qDFnm4kKeQBE5eWHgF4H?amount=59398.192164654' paid_amount: type: string example: '66.43755939' paid_amount_minus_fee: type: string example: '-2351.0688617114' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: ETHBASE received_amount: type: string example: '-2351.0688617114' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: ETHBASE amount: type: string example: '2417.5064211014' fiat_amounts: type: array example: [] external_id: type: string example: '878' customer_external_id: type: string example: yFPNBwLFJ4ZzPxUQ external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Johnathan Grant' description: type: string example: 'Derick Wilkinson' redirect_url: type: string example: 'http://langworth.com/tenetur-veritatis-cumque-repellendus-est-sit' failure_redirect_url: type: string example: 'http://jones.com/tenetur-nesciunt-quia-officia-quam-deserunt' created_at: type: string example: '2025-04-23T11:34:22.000000Z' expires_at: type: string example: '2025-04-23T11:54:22.000000Z' status: type: string example: created status_context: type: string example: underpaid status_reason: type: string example: null can_be_paid_partially: type: boolean example: false error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' requestBody: required: true content: application/json: schema: type: object properties: price_currency: type: string description: '' example: AURORANEAR enum: - BTC - BCH - LTC - ETH - MATIC - TRX - XLM - SOL - BNB - ETHBASE - NEAR - AURORA - USDTERC20 - USDTTRC20 - USDTMATIC - USDTBEP20 - USDTNEAR - USDTENEAR - USDTAURORA - USDCERC20 - USDCTRC20 - USDCMATIC - USDCNEAR - USDCENEAR - USDCBEP20 - USDCAURORA - USDCXLM - USDCBASE - AURORANEAR - ETHAURORA - EUR - USD - UAH - KZT price_amount: type: number description: '' example: 291.96108 pay_currency: type: string description: '' example: ETHBASE enum: - BTC - BCH - LTC - ETH - MATIC - TRX - XLM - SOL - BNB - ETHBASE - NEAR - AURORA - USDTERC20 - USDTTRC20 - USDTMATIC - USDTBEP20 - USDTNEAR - USDTENEAR - USDTAURORA - USDCERC20 - USDCTRC20 - USDCMATIC - USDCNEAR - USDCENEAR - USDCBEP20 - USDCAURORA - USDCXLM - USDCBASE - AURORANEAR - ETHAURORA - EUR - USD - UAH - KZT customer_external_id: type: string description: 'Customer external unique ID.' example: null external_data: type: string description: 'Must not be greater than 1024 characters.' example: '{"param1":"value1","param2":"value2"}' external_id: type: string description: '' example: null customer_email: type: string description: 'Customer email. Required if send_cheque is true. Must be a valid email address. This field is required when send_cheque is true.' example: example@gmail.com send_cheque: type: boolean description: 'Send cheque to customer email.' example: false name: type: string description: '' example: 'Your invoice name' description: type: string description: '' example: 'Your invoice description' redirect_url: type: string description: '' example: 'https://www.runolfsson.com/similique-dignissimos-ut-animi-quisquam-voluptate-architecto-id' failure_redirect_url: type: string description: '' example: 'http://little.org/sapiente-omnis-repellendus-odit-laudantium-facilis.html' timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: - price_currency - price_amount - pay_currency - customer_external_id - timestamp /api/v1/merchant/invoices/payment-link: post: summary: 'Create invoice payment link' operationId: createInvoicePaymentLink description: 'Creates new invoice payment link with provided data and shows information about it.' parameters: - in: header name: X-Munzen-Key description: '' example: P1a64v6adVeZhDgf5bkc38E schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-745c-72e4-b483-5784219188d8 short_id: eiVSJjNjHiJaPNhZMje7J number: 35857948 price_currency: UAH price_amount: '7844479.02' pay_currency: NEAR pay_amount: '73676917.0728' exchange_rate: '9.39220015' exchange_rate_expires_at: '2025-04-23T11:47:22.000000Z' address: t5J9DLXoMNhiG0fAo7SmuA1cdW13X7 address_tag: o2SDU address_uri: 'near:t5J9DLXoMNhiG0fAo7SmuA1cdW13X7?amount=73676917.0728' paid_amount: '0.597152502' paid_amount_minus_fee: '-5606812.7920876' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: NEAR received_amount: '-5606812.7920876' conversion_exchange_rate: null fees: processing_invoice: currency: NEAR amount: '5606813.3892401' fiat_amounts: [] external_id: '119' customer_external_id: LHnJEQoRQlvcExtJ external_data: '{"foo":"bar"}' name: 'Mr. Douglas Baumbach' description: 'Catalina Waelchi' redirect_url: 'http://www.rosenbaum.net/' failure_redirect_url: 'http://hoppe.com/' created_at: '2025-04-23T11:34:22.000000Z' expires_at: '2025-04-23T12:01:22.000000Z' status: expired status_context: underpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196626d-745c-72e4-b483-5784219188d8 short_id: type: string example: eiVSJjNjHiJaPNhZMje7J number: type: integer example: 35857948 price_currency: type: string example: UAH price_amount: type: string example: '7844479.02' pay_currency: type: string example: NEAR pay_amount: type: string example: '73676917.0728' exchange_rate: type: string example: '9.39220015' exchange_rate_expires_at: type: string example: '2025-04-23T11:47:22.000000Z' address: type: string example: t5J9DLXoMNhiG0fAo7SmuA1cdW13X7 address_tag: type: string example: o2SDU address_uri: type: string example: 'near:t5J9DLXoMNhiG0fAo7SmuA1cdW13X7?amount=73676917.0728' paid_amount: type: string example: '0.597152502' paid_amount_minus_fee: type: string example: '-5606812.7920876' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: NEAR received_amount: type: string example: '-5606812.7920876' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: NEAR amount: type: string example: '5606813.3892401' fiat_amounts: type: array example: [] external_id: type: string example: '119' customer_external_id: type: string example: LHnJEQoRQlvcExtJ external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Mr. Douglas Baumbach' description: type: string example: 'Catalina Waelchi' redirect_url: type: string example: 'http://www.rosenbaum.net/' failure_redirect_url: type: string example: 'http://hoppe.com/' created_at: type: string example: '2025-04-23T11:34:22.000000Z' expires_at: type: string example: '2025-04-23T12:01:22.000000Z' status: type: string example: expired status_context: type: string example: underpaid status_reason: type: string example: null can_be_paid_partially: type: boolean example: true error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' requestBody: required: true content: application/json: schema: type: object properties: price_currency: type: string description: '' example: NEAR enum: - BTC - BCH - LTC - ETH - MATIC - TRX - XLM - SOL - BNB - ETHBASE - NEAR - AURORA - USDTERC20 - USDTTRC20 - USDTMATIC - USDTBEP20 - USDTNEAR - USDTENEAR - USDTAURORA - USDCERC20 - USDCTRC20 - USDCMATIC - USDCNEAR - USDCENEAR - USDCBEP20 - USDCAURORA - USDCXLM - USDCBASE - AURORANEAR - ETHAURORA - EUR - USD - UAH - KZT price_amount: type: number description: '' example: 8854271.0 currencies_for_pay: type: array description: '' example: - BNB items: type: string enum: - BTC - BCH - LTC - ETH - MATIC - TRX - XLM - SOL - BNB - ETHBASE - NEAR - AURORA - USDTERC20 - USDTTRC20 - USDTMATIC - USDTBEP20 - USDTNEAR - USDTENEAR - USDTAURORA - USDCERC20 - USDCTRC20 - USDCMATIC - USDCNEAR - USDCENEAR - USDCBEP20 - USDCAURORA - USDCXLM - USDCBASE - AURORANEAR - ETHAURORA - EUR - USD - UAH - KZT link_expires_at: type: string description: 'Unix timestamp in seconds when invoice link will be expired. Must be a valid date in the format U. Must be a date after now.' example: 1681897689 external_data: type: string description: 'Must not be greater than 1024 characters.' example: '{"param1":"value1","param2":"value2"}' external_id: type: string description: '' example: null customer_external_id: type: string description: 'Customer external unique ID.' example: null customer_email: type: string description: 'Customer email. Required if send_cheque is true. Must be a valid email address. This field is required when send_cheque is true.' example: example@gmail.com send_cheque: type: boolean description: 'Send cheque to customer email.' example: false name: type: string description: '' example: 'Your invoice name' description: type: string description: '' example: 'Your invoice description' redirect_url: type: string description: '' example: 'http://ferry.biz/excepturi-nihil-alias-illo-sint-modi-porro.html' failure_redirect_url: type: string description: '' example: 'http://www.wiza.com/' timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: - price_currency - customer_external_id - timestamp /api/v1/merchant/payouts/request: post: summary: 'Request payout' operationId: requestPayout description: 'Creates payout request.' parameters: - in: header name: X-Munzen-Key description: '' example: 8hagD461Vf5Zbd6EPvakc3e schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-74c9-72b1-b2a8-acc1ee6829d8 amount_requested: 517.48313 amount_to_send: 509.98462 fee_amount: 7.49851 status: failed status_reason: tx_rejection currency: USDTTRC20 source_currency: EUR source_amount: 752.95017 source_exchange_rate: 531.96423 error: null properties: data: type: object properties: id: type: string example: 0196626d-74c9-72b1-b2a8-acc1ee6829d8 amount_requested: type: number example: 517.48313 amount_to_send: type: number example: 509.98462 fee_amount: type: number example: 7.49851 status: type: string example: failed status_reason: type: string example: tx_rejection currency: type: string example: USDTTRC20 source_currency: type: string example: EUR source_amount: type: number example: 752.95017 source_exchange_rate: type: number example: 531.96423 error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' requestBody: required: true content: application/json: schema: type: object properties: external_id: type: string description: 'The external ID of the payout request. Must be unique for each project.' example: '123456' customer_external_id: type: string description: 'The external ID of your customer. Must be unique for each project.' example: '123456' currency: type: string description: '' example: USDTERC20 enum: - BTC - BCH - LTC - ETH - MATIC - TRX - XLM - SOL - BNB - ETHBASE - NEAR - AURORA - USDTERC20 - USDTTRC20 - USDTMATIC - USDTBEP20 - USDTNEAR - USDTENEAR - USDTAURORA - USDCERC20 - USDCTRC20 - USDCMATIC - USDCNEAR - USDCENEAR - USDCBEP20 - USDCAURORA - USDCXLM - USDCBASE - AURORANEAR - ETHAURORA - EUR - USD - UAH - KZT amount: type: number description: 'This field is required when source_currency is not present.' example: 266.5 address: type: string description: '' example: '0xb00e5760c0ab29ecdc51e39eea0e841a14415755' address_tag: type: string description: '' example: '123456' timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 source_currency: type: string description: 'This field is required when source_amount is present.' example: EUR enum: - BTC - BCH - LTC - ETH - MATIC - TRX - XLM - SOL - BNB - ETHBASE - NEAR - AURORA - USDTERC20 - USDTTRC20 - USDTMATIC - USDTBEP20 - USDTNEAR - USDTENEAR - USDTAURORA - USDCERC20 - USDCTRC20 - USDCMATIC - USDCNEAR - USDCENEAR - USDCBEP20 - USDCAURORA - USDCXLM - USDCBASE - AURORANEAR - ETHAURORA - EUR - USD - UAH - KZT source_amount: type: number description: 'This field is required when source_currency is present.' example: 266.5 required: - customer_external_id - currency - address - timestamp '/api/v1/merchant/payouts/{payoutId}': get: summary: 'Get payout by id' operationId: getPayoutById description: 'Gives payout by provided id.' parameters: - in: query name: timestamp description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: true schema: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 - in: header name: X-Munzen-Key description: '' example: V16hea4EDbk3cf6av8ZdP5g schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-750d-7288-93d6-b98eeec25dd0 currency: XLM amount_requested: 138.91674 amount_to_send: 138.91674 amount_to_charge: 145.83435 fee_amount: 6.91761 status: processing status_reason: invalid_amount created_at: '2025-04-23T11:34:22.000000Z' fee_included: false source_currency: KZT source_amount: 412.38545 source_exchange_rate: 549.00867 error: null properties: data: type: object properties: id: type: string example: 0196626d-750d-7288-93d6-b98eeec25dd0 currency: type: string example: XLM amount_requested: type: number example: 138.91674 amount_to_send: type: number example: 138.91674 amount_to_charge: type: number example: 145.83435 fee_amount: type: number example: 6.91761 status: type: string example: processing status_reason: type: string example: invalid_amount created_at: type: string example: '2025-04-23T11:34:22.000000Z' fee_included: type: boolean example: false source_currency: type: string example: KZT source_amount: type: number example: 412.38545 source_exchange_rate: type: number example: 549.00867 error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' parameters: - in: path name: payoutId description: 'The ID of payout' example: 48e81488-9fb7-4771-a599-8d99df10456c required: true schema: type: string '/api/v1/merchant/payouts/by-external-id/{externalId}': get: summary: 'Get payout by external id' operationId: getPayoutByExternalId description: 'Gives payout by provided external id.' parameters: - in: query name: timestamp description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: true schema: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 - in: header name: X-Munzen-Key description: '' example: 5k4Ebad1c66e8gPZ3aDfhvV schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-7559-701e-bba5-f821d74c8c7f currency: SOL amount_requested: 734.57624 amount_to_send: 734.57624 amount_to_charge: 742.14654 fee_amount: 7.5703 status: pending status_reason: tx_rejection created_at: '2025-04-23T11:34:22.000000Z' fee_included: false source_currency: KZT source_amount: 325.14579 source_exchange_rate: 499.18983 error: null properties: data: type: object properties: id: type: string example: 0196626d-7559-701e-bba5-f821d74c8c7f currency: type: string example: SOL amount_requested: type: number example: 734.57624 amount_to_send: type: number example: 734.57624 amount_to_charge: type: number example: 742.14654 fee_amount: type: number example: 7.5703 status: type: string example: pending status_reason: type: string example: tx_rejection created_at: type: string example: '2025-04-23T11:34:22.000000Z' fee_included: type: boolean example: false source_currency: type: string example: KZT source_amount: type: number example: 325.14579 source_exchange_rate: type: number example: 499.18983 error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' parameters: - in: path name: externalId description: 'The external ID of payout' example: 48e814889fb74771a5998d99d required: true schema: type: string /api/v1/merchant/channels: post: summary: 'Create channel' operationId: createChannel description: 'Creates new channel with provided data and shows information about it.' parameters: - in: header name: X-Munzen-Key description: '' example: vkZdh8D643Va6P5agbEecf1 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-7583-70a6-9ac2-f0af1731736d customer_external_id: N7CVFVeUUddb9aMm external_id: RfKgUvkXHX external_data: '{"foo":"bar"}' currency: USDCBEP20 address: RTe7Ik58kyZcv6aLhudbLHbfD4AV25 address_tag: gSMiX address_uri: 'ethereum:RTe7Ik58kyZcv6aLhudbLHbfD4AV25' created_at: '2025-04-23T11:34:22.000000Z' error: null properties: data: type: object properties: id: type: string example: 0196626d-7583-70a6-9ac2-f0af1731736d customer_external_id: type: string example: N7CVFVeUUddb9aMm external_id: type: string example: RfKgUvkXHX external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDCBEP20 address: type: string example: RTe7Ik58kyZcv6aLhudbLHbfD4AV25 address_tag: type: string example: gSMiX address_uri: type: string example: 'ethereum:RTe7Ik58kyZcv6aLhudbLHbfD4AV25' created_at: type: string example: '2025-04-23T11:34:22.000000Z' error: type: string example: null 401: description: 'Not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' requestBody: required: true content: application/json: schema: type: object properties: currency: type: string description: '' example: USDTTRC20 enum: - BTC - BCH - LTC - ETH - MATIC - TRX - XLM - SOL - BNB - ETHBASE - NEAR - AURORA - USDTERC20 - USDTTRC20 - USDTMATIC - USDTBEP20 - USDTNEAR - USDTENEAR - USDTAURORA - USDCERC20 - USDCTRC20 - USDCMATIC - USDCNEAR - USDCENEAR - USDCBEP20 - USDCAURORA - USDCXLM - USDCBASE - AURORANEAR - ETHAURORA - EUR - USD - UAH - KZT customer_external_id: type: string description: '' example: '1' external_id: type: string description: '' example: null external_data: type: string description: 'Must not be greater than 1024 characters.' example: '{"param1":"value1","param2":"value2"}' timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: - currency - customer_external_id - timestamp get: summary: 'List of merchant project channels for customer' operationId: listOfMerchantProjectChannelsForCustomer description: 'Returns list of merchant project channels for provided customer external ID.' parameters: - in: query name: customer_external_id description: '' example: '1' required: true schema: type: string description: '' example: '1' - in: query name: timestamp description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: true schema: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 - in: header name: X-Munzen-Key description: '' example: V3Z6k18vchf4ba6PdEa5gDe schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 0196626d-75a4-71bf-9cd9-a5167e3536d9 customer_external_id: jr5JvF0qHCr6Jny1 external_id: HrDcpIDpfR external_data: '{"foo":"bar"}' currency: USDCBASE address: RX7S6BQ9mLhbvBZpwYPZpD9Ttf4Mmn address_tag: qlUSI address_uri: 'ethereum:RX7S6BQ9mLhbvBZpwYPZpD9Ttf4Mmn' created_at: '2025-04-23T11:34:22.000000Z' error: null properties: data: type: array example: - id: 0196626d-75a4-71bf-9cd9-a5167e3536d9 customer_external_id: jr5JvF0qHCr6Jny1 external_id: HrDcpIDpfR external_data: '{"foo":"bar"}' currency: USDCBASE address: RX7S6BQ9mLhbvBZpwYPZpD9Ttf4Mmn address_tag: qlUSI address_uri: 'ethereum:RX7S6BQ9mLhbvBZpwYPZpD9Ttf4Mmn' created_at: '2025-04-23T11:34:22.000000Z' items: type: object properties: id: type: string example: 0196626d-75a4-71bf-9cd9-a5167e3536d9 customer_external_id: type: string example: jr5JvF0qHCr6Jny1 external_id: type: string example: HrDcpIDpfR external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDCBASE address: type: string example: RX7S6BQ9mLhbvBZpwYPZpD9Ttf4Mmn address_tag: type: string example: qlUSI address_uri: type: string example: 'ethereum:RX7S6BQ9mLhbvBZpwYPZpD9Ttf4Mmn' created_at: type: string example: '2025-04-23T11:34:22.000000Z' error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 404: description: 'Not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' tags: - 'Merchant API' '/api/v1/merchant/channels/{channelId}/payments': get: summary: 'List of payments in merchant project channel' operationId: listOfPaymentsInMerchantProjectChannel description: 'Returns list of payments in merchant project channel with pagination.' parameters: - in: header name: X-Munzen-Key description: '' example: haZP6kVgeED4a1v3fc658bd schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: list: - id: 0196626d-75c7-720e-9cdc-71e8efa4cc7f channel_id: 0196626d-75c6-73f1-bd58-2d844b810824 customer_external_id: tcq2XxwcYxHCj46j external_id: 4NUszIR0Jx external_data: '{"foo":"bar"}' currency: BTC amount: '430.44439' amount_minus_fee: '430.14307893' received_currency: BTC received_amount: '430.14307893' conversion_exchange_rate: null fees: processing_channel: currency: BTC amount: '0.30131107' fiat_amounts: [] address: MQyT8CyCs0PADeS5tMlAOtCSIIkMYL address_tag: H1XsQ address_uri: 'bitcoin:MQyT8CyCs0PADeS5tMlAOtCSIIkMYL' transaction_hash: null transaction_risk_score: null created_at: '2025-04-23T11:34:22.000000Z' status: paid status_reason: null metadata: total: 384818 per_page: 320656 next_cursor: wusrKIsejaz0erg8 previous_cursor: PiwtjNhNnd65lb8w error: null properties: data: type: object properties: list: type: array example: - id: 0196626d-75c7-720e-9cdc-71e8efa4cc7f channel_id: 0196626d-75c6-73f1-bd58-2d844b810824 customer_external_id: tcq2XxwcYxHCj46j external_id: 4NUszIR0Jx external_data: '{"foo":"bar"}' currency: BTC amount: '430.44439' amount_minus_fee: '430.14307893' received_currency: BTC received_amount: '430.14307893' conversion_exchange_rate: null fees: processing_channel: currency: BTC amount: '0.30131107' fiat_amounts: [] address: MQyT8CyCs0PADeS5tMlAOtCSIIkMYL address_tag: H1XsQ address_uri: 'bitcoin:MQyT8CyCs0PADeS5tMlAOtCSIIkMYL' transaction_hash: null transaction_risk_score: null created_at: '2025-04-23T11:34:22.000000Z' status: paid status_reason: null items: type: object properties: id: type: string example: 0196626d-75c7-720e-9cdc-71e8efa4cc7f channel_id: type: string example: 0196626d-75c6-73f1-bd58-2d844b810824 customer_external_id: type: string example: tcq2XxwcYxHCj46j external_id: type: string example: 4NUszIR0Jx external_data: type: string example: '{"foo":"bar"}' currency: type: string example: BTC amount: type: string example: '430.44439' amount_minus_fee: type: string example: '430.14307893' received_currency: type: string example: BTC received_amount: type: string example: '430.14307893' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: BTC amount: type: string example: '0.30131107' fiat_amounts: type: array example: [] address: type: string example: MQyT8CyCs0PADeS5tMlAOtCSIIkMYL address_tag: type: string example: H1XsQ address_uri: type: string example: 'bitcoin:MQyT8CyCs0PADeS5tMlAOtCSIIkMYL' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-04-23T11:34:22.000000Z' status: type: string example: paid status_reason: type: string example: null metadata: type: object properties: total: type: integer example: 384818 per_page: type: integer example: 320656 next_cursor: type: string example: wusrKIsejaz0erg8 previous_cursor: type: string example: PiwtjNhNnd65lb8w error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 404: description: 'Not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' tags: - 'Merchant API' requestBody: required: true content: application/json: schema: type: object properties: cursor: type: string description: '' example: sikAiLsryrD2YGPZ per_page: type: integer description: 'Must be at least 10. Must not be greater than 500.' example: 10 timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: - timestamp parameters: - in: path name: channelId description: '' example: DDABedDd-fafb-CfAd-EaCf-FAEeddbaAadb required: true schema: type: string '/api/v1/merchant/channels/payments/{channelPaymentId}': get: summary: 'Get channel payment by id' operationId: getChannelPaymentById description: 'Returns information about channel payments in merchant project channel with pagination.' parameters: - in: query name: timestamp description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: true schema: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 - in: header name: X-Munzen-Key description: '' example: EfecbkZvh6adD14g68VPa53 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-75f1-7100-b103-598789edcb91 channel_id: 0196626d-75f0-706a-a440-970bc9a58d57 customer_external_id: JOB9gqJ8Ed74DTub external_id: tQKNCYg8uf external_data: '{"foo":"bar"}' currency: XLM amount: '425.12407' amount_minus_fee: '424.8689956' received_currency: XLM received_amount: '424.8689956' conversion_exchange_rate: null fees: processing_channel: currency: XLM amount: '0.2550744' fiat_amounts: [] address: Mu3FgYIbITKuXMtd8WLCYC5YhjRoPd address_tag: XgjFq address_uri: Mu3FgYIbITKuXMtd8WLCYC5YhjRoPd transaction_hash: null transaction_risk_score: null created_at: '2025-04-23T11:34:22.000000Z' status: paid status_reason: null error: null properties: data: type: object properties: id: type: string example: 0196626d-75f1-7100-b103-598789edcb91 channel_id: type: string example: 0196626d-75f0-706a-a440-970bc9a58d57 customer_external_id: type: string example: JOB9gqJ8Ed74DTub external_id: type: string example: tQKNCYg8uf external_data: type: string example: '{"foo":"bar"}' currency: type: string example: XLM amount: type: string example: '425.12407' amount_minus_fee: type: string example: '424.8689956' received_currency: type: string example: XLM received_amount: type: string example: '424.8689956' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: XLM amount: type: string example: '0.2550744' fiat_amounts: type: array example: [] address: type: string example: Mu3FgYIbITKuXMtd8WLCYC5YhjRoPd address_tag: type: string example: XgjFq address_uri: type: string example: Mu3FgYIbITKuXMtd8WLCYC5YhjRoPd transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-04-23T11:34:22.000000Z' status: type: string example: paid status_reason: type: string example: null error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 404: description: 'Not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' tags: - 'Merchant API' parameters: - in: path name: channelPaymentId description: '' example: deCdFdda-fbcf-dcfA-dBCa-AEdBEeabaDBC required: true schema: type: string /api/v1/merchant/exchange-rate: get: summary: 'Get exchange rate' operationId: getExchangeRate description: 'Returns exchange rate found with provided params otherwise returns not found error' parameters: - in: query name: base_currency description: 'Base currency ticker with network.' example: UAH required: true schema: type: string description: 'Base currency ticker with network.' example: UAH - in: query name: quote_currency description: 'Quote currency ticker with network.' example: USDTERC20 required: true schema: type: string description: 'Quote currency ticker with network.' example: USDTERC20 - in: header name: X-Munzen-Key description: '' example: hk8bv5fD6ge4ZEd6a3acPV1 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: base_currency: EUR quote_currency: NEAR exchange_rate: 7.66002565 decimals: 26 round_off: 10 error: null properties: data: type: object properties: base_currency: type: string example: EUR quote_currency: type: string example: NEAR exchange_rate: type: number example: 7.66002565 decimals: type: integer example: 26 round_off: type: integer example: 10 error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 404: description: 'Not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' '/api/v1/merchant/customers/by-external-id/{externalId}/limit': get: summary: 'Get limits by customer external id' operationId: getLimitsByCustomerExternalId description: "Shows information about customer's limits." parameters: - in: header name: X-Munzen-Key description: '' example: d3k4bVv81afea5E6ZhcgPD6 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: limit: 909509 remaining_amount: 3687037.420754 error: null properties: data: type: object properties: limit: type: integer example: 909509 remaining_amount: type: number example: 3687037.420754 error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' requestBody: required: true content: application/json: schema: type: object properties: timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: - timestamp parameters: - in: path name: externalId description: '' example: ipsum required: true schema: type: string /api/v1/merchant/customers/documents: post: summary: "Upload customer's documents" operationId: uploadCustomersDocuments description: 'Please note that this endpoint uses multipart/form-data' parameters: - in: header name: X-Munzen-Key description: '' example: dVa18a3Z4cPvk5gbe66EDfh schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: [] error: null properties: data: type: array example: [] error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 422: description: 'Validation error' content: application/json: schema: type: object example: data: null error: code: validation_error message: 'The given data was invalid.' payload: field: - error_1 - error_2 properties: data: type: string example: null error: type: object properties: code: type: string example: validation_error message: type: string example: 'The given data was invalid.' payload: type: object properties: field: type: array example: - error_1 - error_2 items: type: string 500: description: 'Internal server error' content: application/json: schema: type: object example: data: null error: code: internal_error message: ... properties: data: type: string example: null error: type: object properties: code: type: string example: internal_error message: type: string example: ... tags: - 'Merchant API' requestBody: required: true content: multipart/form-data: schema: type: object properties: timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 customer_external_id: type: string description: '' example: dolor documents: type: array description: '' example: - natus items: type: string required: - timestamp - customer_external_id - documents tags: - name: 'Merchant API' description: 'API methods for our merchants.' components: securitySchemes: default: type: apiKey name: X-Munzen-Key in: header description: 'To get your API key contact with us.' security: - default: []