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: 1a6af6hc53db8vgPVZEeD4k 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: 019898c7-c1be-71a5-88e4-6fdc1270fe00 short_id: SX9c3QQ7ooHkcneZvUeCJ number: 50173786 price_currency: USD price_amount: '29.41' pay_currency: USDCENEAR pay_amount: '111.358484' exchange_rate: '3.7860122' exchange_rate_expires_at: '2025-08-11T11:10:04.000000Z' address: 8sImKXtPJY6KXkY1XqrLRHROw3eOoN address_tag: e9Dp5 address_uri: 'near:8sImKXtPJY6KXkY1XqrLRHROw3eOoN?amount=111.358484' paid_amount: '2881877.38878' paid_amount_minus_fee: '2881872.811946' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCENEAR received_amount: '2881872.811946' conversion_exchange_rate: null fees: processing_invoice: currency: USDCENEAR amount: '4.576834' fiat_amounts: [] external_id: '564' customer_external_id: WNMSM407N6iSXlcz external_data: '{"foo":"bar"}' name: 'Zaria Streich' description: 'Yasmeen Stiedemann Sr.' redirect_url: 'http://witting.net/voluptates-aut-excepturi-eum-repudiandae-facilis-necessitatibus-ducimus' failure_redirect_url: 'http://www.schroeder.com/' created_at: '2025-08-11T10:58:04.000000Z' expires_at: '2025-08-11T11:19:04.000000Z' status: paid_partially status_context: underpaid status_reason: null can_be_paid_partially: false error: null properties: data: type: object properties: id: type: string example: 019898c7-c1be-71a5-88e4-6fdc1270fe00 short_id: type: string example: SX9c3QQ7ooHkcneZvUeCJ number: type: integer example: 50173786 price_currency: type: string example: USD price_amount: type: string example: '29.41' pay_currency: type: string example: USDCENEAR pay_amount: type: string example: '111.358484' exchange_rate: type: string example: '3.7860122' exchange_rate_expires_at: type: string example: '2025-08-11T11:10:04.000000Z' address: type: string example: 8sImKXtPJY6KXkY1XqrLRHROw3eOoN address_tag: type: string example: e9Dp5 address_uri: type: string example: 'near:8sImKXtPJY6KXkY1XqrLRHROw3eOoN?amount=111.358484' paid_amount: type: string example: '2881877.38878' paid_amount_minus_fee: type: string example: '2881872.811946' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDCENEAR received_amount: type: string example: '2881872.811946' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDCENEAR amount: type: string example: '4.576834' fiat_amounts: type: array example: [] external_id: type: string example: '564' customer_external_id: type: string example: WNMSM407N6iSXlcz external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Zaria Streich' description: type: string example: 'Yasmeen Stiedemann Sr.' redirect_url: type: string example: 'http://witting.net/voluptates-aut-excepturi-eum-repudiandae-facilis-necessitatibus-ducimus' failure_redirect_url: type: string example: 'http://www.schroeder.com/' created_at: type: string example: '2025-08-11T10:58:04.000000Z' expires_at: type: string example: '2025-08-11T11:19:04.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: 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. 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: hP5agZ1vDf46bkeEdVa63c8 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: Paa468fDhkV5ZEe3bv1cd6g 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: 019898c7-c214-7300-b520-6e6ef6129771 short_id: 8iNJh7kk2pNXQz8avUeCJ number: 33053551 price_currency: KZT price_amount: '6573.93' pay_currency: ETHAURORA pay_amount: '15891.440605977' exchange_rate: '2.41734332' exchange_rate_expires_at: '2025-08-11T11:08:04.000000Z' address: U1dgh3AB60jg4DdWO4EbqcTEq98wSp address_tag: Y99LG address_uri: 'aurora:U1dgh3AB60jg4DdWO4EbqcTEq98wSp?amount=15891.440605977' paid_amount: '12' paid_amount_minus_fee: '-809.58747932903' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: ETHAURORA received_amount: '-809.58747932903' conversion_exchange_rate: null fees: processing_invoice: currency: ETHAURORA amount: '821.58747932903' fiat_amounts: [] external_id: '079' customer_external_id: dWCxv5mmWFykc8zB external_data: '{"foo":"bar"}' name: 'Sabrina Beer' description: 'Prof. Enos Ferry MD' redirect_url: 'http://www.turner.org/' failure_redirect_url: 'https://harber.net/explicabo-officia-sed-est-voluptas-id-velit-nostrum.html' created_at: '2025-08-11T10:58:04.000000Z' expires_at: '2025-08-11T11:27:04.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: 019898c7-c214-7300-b520-6e6ef6129771 short_id: type: string example: 8iNJh7kk2pNXQz8avUeCJ number: type: integer example: 33053551 price_currency: type: string example: KZT price_amount: type: string example: '6573.93' pay_currency: type: string example: ETHAURORA pay_amount: type: string example: '15891.440605977' exchange_rate: type: string example: '2.41734332' exchange_rate_expires_at: type: string example: '2025-08-11T11:08:04.000000Z' address: type: string example: U1dgh3AB60jg4DdWO4EbqcTEq98wSp address_tag: type: string example: Y99LG address_uri: type: string example: 'aurora:U1dgh3AB60jg4DdWO4EbqcTEq98wSp?amount=15891.440605977' paid_amount: type: string example: '12' paid_amount_minus_fee: type: string example: '-809.58747932903' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: ETHAURORA received_amount: type: string example: '-809.58747932903' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: ETHAURORA amount: type: string example: '821.58747932903' fiat_amounts: type: array example: [] external_id: type: string example: '079' customer_external_id: type: string example: dWCxv5mmWFykc8zB external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Sabrina Beer' description: type: string example: 'Prof. Enos Ferry MD' redirect_url: type: string example: 'http://www.turner.org/' failure_redirect_url: type: string example: 'https://harber.net/explicabo-officia-sed-est-voluptas-id-velit-nostrum.html' created_at: type: string example: '2025-08-11T10:58:04.000000Z' expires_at: type: string example: '2025-08-11T11:27:04.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. 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: dhga51V6evbE64Zc3PkfaD8 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: 019898c7-c25b-73bb-ae75-2b68cc8d8679 short_id: z7XmnSFRUrs3gTXavUeCJ number: 96011086 price_currency: UAH price_amount: '32550924.03' pay_currency: USDCENEAR pay_amount: '113184925.95953' exchange_rate: '3.47716476' exchange_rate_expires_at: '2025-08-11T11:12:05.000000Z' address: R4ZXizZKmKj3ax78duwfuobGFmvoEI address_tag: R642o address_uri: 'near:R4ZXizZKmKj3ax78duwfuobGFmvoEI?amount=113184925.95953' paid_amount: '8.69122' paid_amount_minus_fee: '-3123895.265263' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCENEAR received_amount: '-3123895.265263' conversion_exchange_rate: null fees: processing_invoice: currency: USDCENEAR amount: '3123903.956483' fiat_amounts: [] external_id: '876' customer_external_id: 6A9t0VUeMdnxzElY external_data: '{"foo":"bar"}' name: 'Deangelo Ernser' description: 'Mr. Carleton Okuneva V' redirect_url: 'http://leannon.com/ut-unde-fuga-nesciunt-amet-expedita-accusamus-saepe' failure_redirect_url: 'http://lemke.com/facilis-adipisci-soluta-ex-est-eum-possimus.html' created_at: '2025-08-11T10:58:05.000000Z' expires_at: '2025-08-11T11:24:05.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: 019898c7-c25b-73bb-ae75-2b68cc8d8679 short_id: type: string example: z7XmnSFRUrs3gTXavUeCJ number: type: integer example: 96011086 price_currency: type: string example: UAH price_amount: type: string example: '32550924.03' pay_currency: type: string example: USDCENEAR pay_amount: type: string example: '113184925.95953' exchange_rate: type: string example: '3.47716476' exchange_rate_expires_at: type: string example: '2025-08-11T11:12:05.000000Z' address: type: string example: R4ZXizZKmKj3ax78duwfuobGFmvoEI address_tag: type: string example: R642o address_uri: type: string example: 'near:R4ZXizZKmKj3ax78duwfuobGFmvoEI?amount=113184925.95953' paid_amount: type: string example: '8.69122' paid_amount_minus_fee: type: string example: '-3123895.265263' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDCENEAR received_amount: type: string example: '-3123895.265263' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDCENEAR amount: type: string example: '3123903.956483' fiat_amounts: type: array example: [] external_id: type: string example: '876' customer_external_id: type: string example: 6A9t0VUeMdnxzElY external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Deangelo Ernser' description: type: string example: 'Mr. Carleton Okuneva V' redirect_url: type: string example: 'http://leannon.com/ut-unde-fuga-nesciunt-amet-expedita-accusamus-saepe' failure_redirect_url: type: string example: 'http://lemke.com/facilis-adipisci-soluta-ex-est-eum-possimus.html' created_at: type: string example: '2025-08-11T10:58:05.000000Z' expires_at: type: string example: '2025-08-11T11:24:05.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: LTC 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: 3029261.0 pay_currency: type: string description: '' example: MATIC 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: 'http://www.klocko.com/ullam-est-rerum-animi-quae-consequatur-sunt-est' failure_redirect_url: type: string description: '' example: 'http://braun.net/illo-nemo-ducimus-tempora-voluptatibus-quo' 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: v54PaagbVDE6edZh3fk168c 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: 019898c7-c297-708b-bfe2-fa085a6a9b60 short_id: UdThrmM3EqzDLSravUeCJ number: 86996981 price_currency: KZT price_amount: '1086043.56' pay_currency: USDCXLM pay_amount: '3937862.031778' exchange_rate: '3.62587853' exchange_rate_expires_at: '2025-08-11T11:09:05.000000Z' address: zr0QmWcJYLHxLvNkeqeGLkU68Rbiuk address_tag: V1Il8 address_uri: 'zr0QmWcJYLHxLvNkeqeGLkU68Rbiuk?amount=3937862.031778' paid_amount: '545918227.82992' paid_amount_minus_fee: '545600048.57775' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCXLM received_amount: '545600048.57775' conversion_exchange_rate: null fees: processing_invoice: currency: USDCXLM amount: '318179.252168' fiat_amounts: [] external_id: '660' customer_external_id: TZxxCGxtqymn1aAR external_data: '{"foo":"bar"}' name: 'Courtney Lubowitz DDS' description: 'Dr. Adriel Barrows' redirect_url: 'http://auer.com/sapiente-ex-sit-maiores-est-sunt.html' failure_redirect_url: 'http://hammes.info/quae-asperiores-id-eaque-ea-laboriosam-eos-amet.html' created_at: '2025-08-11T10:58:05.000000Z' expires_at: '2025-08-11T11:21:05.000000Z' status: paid status_context: underpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 019898c7-c297-708b-bfe2-fa085a6a9b60 short_id: type: string example: UdThrmM3EqzDLSravUeCJ number: type: integer example: 86996981 price_currency: type: string example: KZT price_amount: type: string example: '1086043.56' pay_currency: type: string example: USDCXLM pay_amount: type: string example: '3937862.031778' exchange_rate: type: string example: '3.62587853' exchange_rate_expires_at: type: string example: '2025-08-11T11:09:05.000000Z' address: type: string example: zr0QmWcJYLHxLvNkeqeGLkU68Rbiuk address_tag: type: string example: V1Il8 address_uri: type: string example: 'zr0QmWcJYLHxLvNkeqeGLkU68Rbiuk?amount=3937862.031778' paid_amount: type: string example: '545918227.82992' paid_amount_minus_fee: type: string example: '545600048.57775' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDCXLM received_amount: type: string example: '545600048.57775' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDCXLM amount: type: string example: '318179.252168' fiat_amounts: type: array example: [] external_id: type: string example: '660' customer_external_id: type: string example: TZxxCGxtqymn1aAR external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Courtney Lubowitz DDS' description: type: string example: 'Dr. Adriel Barrows' redirect_url: type: string example: 'http://auer.com/sapiente-ex-sit-maiores-est-sunt.html' failure_redirect_url: type: string example: 'http://hammes.info/quae-asperiores-id-eaque-ea-laboriosam-eos-amet.html' created_at: type: string example: '2025-08-11T10:58:05.000000Z' expires_at: type: string example: '2025-08-11T11:21:05.000000Z' status: type: string example: paid 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: USDTAURORA 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: 212846.235 currencies_for_pay: type: array description: '' example: - TRX 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://fadel.com/velit-impedit-nesciunt-pariatur-voluptatem-officia' failure_redirect_url: type: string description: '' example: 'http://www.jones.info/' 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: ekdbDa6c14PgEhf6Zav358V 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: 019898c7-c348-7300-acdd-1d8cb1176444 amount_requested: 425.37863 amount_to_send: 425.37863 fee_amount: 8.38145 status: processing status_reason: network_fee_estimation_failed currency: USDTAURORA source_currency: EUR source_amount: 502.27578 source_exchange_rate: 242.20498 error: null properties: data: type: object properties: id: type: string example: 019898c7-c348-7300-acdd-1d8cb1176444 amount_requested: type: number example: 425.37863 amount_to_send: type: number example: 425.37863 fee_amount: type: number example: 8.38145 status: type: string example: processing status_reason: type: string example: network_fee_estimation_failed currency: type: string example: USDTAURORA source_currency: type: string example: EUR source_amount: type: number example: 502.27578 source_exchange_rate: type: number example: 242.20498 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: a6dfk6e18P5gZhDEbac43Vv 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: 019898c7-c3b4-71d7-81d2-6e4747a08a5d currency: USDCBASE amount_requested: 797.14093 amount_to_send: 785.12899 amount_to_charge: 797.14093 fee_amount: 12.01194 status: complete status_reason: network_fee_estimation_failed created_at: '2025-08-11T10:58:05.000000Z' fee_included: true source_currency: EUR source_amount: 94.82526 source_exchange_rate: 702.99201 error: null properties: data: type: object properties: id: type: string example: 019898c7-c3b4-71d7-81d2-6e4747a08a5d currency: type: string example: USDCBASE amount_requested: type: number example: 797.14093 amount_to_send: type: number example: 785.12899 amount_to_charge: type: number example: 797.14093 fee_amount: type: number example: 12.01194 status: type: string example: complete status_reason: type: string example: network_fee_estimation_failed created_at: type: string example: '2025-08-11T10:58:05.000000Z' fee_included: type: boolean example: true source_currency: type: string example: EUR source_amount: type: number example: 94.82526 source_exchange_rate: type: number example: 702.99201 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: a8Pv6ba1dg35kcDEf6ZVe4h 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: 019898c7-c40b-719d-8778-e5627cf78196 currency: USDTMATIC amount_requested: 19.06141 amount_to_send: 19.06141 amount_to_charge: 25.92468 fee_amount: 6.86327 status: complete status_reason: insufficient_funds created_at: '2025-08-11T10:58:05.000000Z' fee_included: false source_currency: KZT source_amount: 643.80724 source_exchange_rate: 201.35079 error: null properties: data: type: object properties: id: type: string example: 019898c7-c40b-719d-8778-e5627cf78196 currency: type: string example: USDTMATIC amount_requested: type: number example: 19.06141 amount_to_send: type: number example: 19.06141 amount_to_charge: type: number example: 25.92468 fee_amount: type: number example: 6.86327 status: type: string example: complete status_reason: type: string example: insufficient_funds created_at: type: string example: '2025-08-11T10:58:05.000000Z' fee_included: type: boolean example: false source_currency: type: string example: KZT source_amount: type: number example: 643.80724 source_exchange_rate: type: number example: 201.35079 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: e1E5Pgv6Z86Vfbc3Dhk4aad 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: 019898c7-c448-71bb-9f15-2b4a60aa5c3d customer_external_id: YAm5AWAQxA5hwVU5 external_id: cAPLx8zEak external_data: '{"foo":"bar"}' currency: SOL address: 1JizkM5IfKVbjq5UkPMsiiACXHIByv address_tag: OQ9io address_uri: 'solana:1JizkM5IfKVbjq5UkPMsiiACXHIByv' created_at: '2025-08-11T10:58:05.000000Z' error: null properties: data: type: object properties: id: type: string example: 019898c7-c448-71bb-9f15-2b4a60aa5c3d customer_external_id: type: string example: YAm5AWAQxA5hwVU5 external_id: type: string example: cAPLx8zEak external_data: type: string example: '{"foo":"bar"}' currency: type: string example: SOL address: type: string example: 1JizkM5IfKVbjq5UkPMsiiACXHIByv address_tag: type: string example: OQ9io address_uri: type: string example: 'solana:1JizkM5IfKVbjq5UkPMsiiACXHIByv' created_at: type: string example: '2025-08-11T10:58:05.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: vEeg5aP4b8a6VcdDk16fh3Z 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: 019898c7-c46d-73d6-9f41-d7cb4df37c02 customer_external_id: k7UIJLlwVv6Dv90u external_id: a9bz6VhIvN external_data: '{"foo":"bar"}' currency: USDTTRC20 address: gRvTbseaRo6Td340tJWnGCnLYDb5WH address_tag: 867Zz address_uri: 'tron:gRvTbseaRo6Td340tJWnGCnLYDb5WH' created_at: '2025-08-11T10:58:05.000000Z' error: null properties: data: type: array example: - id: 019898c7-c46d-73d6-9f41-d7cb4df37c02 customer_external_id: k7UIJLlwVv6Dv90u external_id: a9bz6VhIvN external_data: '{"foo":"bar"}' currency: USDTTRC20 address: gRvTbseaRo6Td340tJWnGCnLYDb5WH address_tag: 867Zz address_uri: 'tron:gRvTbseaRo6Td340tJWnGCnLYDb5WH' created_at: '2025-08-11T10:58:05.000000Z' items: type: object properties: id: type: string example: 019898c7-c46d-73d6-9f41-d7cb4df37c02 customer_external_id: type: string example: k7UIJLlwVv6Dv90u external_id: type: string example: a9bz6VhIvN external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDTTRC20 address: type: string example: gRvTbseaRo6Td340tJWnGCnLYDb5WH address_tag: type: string example: 867Zz address_uri: type: string example: 'tron:gRvTbseaRo6Td340tJWnGCnLYDb5WH' created_at: type: string example: '2025-08-11T10:58:05.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: 34caa6DhEk1bdfvg8P6eVZ5 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: 019898c7-c4a0-708e-a100-f69c75e343d2 channel_id: 019898c7-c49f-7392-b252-c1a62be3b0b8 customer_external_id: RcPu79RSqfImbZ2y external_id: NNMr2u5IYu external_data: '{"foo":"bar"}' currency: USDTAURORA amount: '795.69949' amount_minus_fee: '795.30164' received_currency: USDTAURORA received_amount: '795.30164' conversion_exchange_rate: null fees: processing_channel: currency: USDTAURORA amount: '0.39785' fiat_amounts: [] address: mvm7g5pCn8wv4C1NoLdHc9pizqErlA address_tag: 3hj8z address_uri: 'aurora:mvm7g5pCn8wv4C1NoLdHc9pizqErlA' transaction_hash: null transaction_risk_score: null created_at: '2025-08-11T10:58:05.000000Z' status: refunded status_reason: null metadata: total: 840060 per_page: 46171 next_cursor: 67D7NEwJj5s6BaCr previous_cursor: Et6qkUTjkglI5LJ2 error: null properties: data: type: object properties: list: type: array example: - id: 019898c7-c4a0-708e-a100-f69c75e343d2 channel_id: 019898c7-c49f-7392-b252-c1a62be3b0b8 customer_external_id: RcPu79RSqfImbZ2y external_id: NNMr2u5IYu external_data: '{"foo":"bar"}' currency: USDTAURORA amount: '795.69949' amount_minus_fee: '795.30164' received_currency: USDTAURORA received_amount: '795.30164' conversion_exchange_rate: null fees: processing_channel: currency: USDTAURORA amount: '0.39785' fiat_amounts: [] address: mvm7g5pCn8wv4C1NoLdHc9pizqErlA address_tag: 3hj8z address_uri: 'aurora:mvm7g5pCn8wv4C1NoLdHc9pizqErlA' transaction_hash: null transaction_risk_score: null created_at: '2025-08-11T10:58:05.000000Z' status: refunded status_reason: null items: type: object properties: id: type: string example: 019898c7-c4a0-708e-a100-f69c75e343d2 channel_id: type: string example: 019898c7-c49f-7392-b252-c1a62be3b0b8 customer_external_id: type: string example: RcPu79RSqfImbZ2y external_id: type: string example: NNMr2u5IYu external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDTAURORA amount: type: string example: '795.69949' amount_minus_fee: type: string example: '795.30164' received_currency: type: string example: USDTAURORA received_amount: type: string example: '795.30164' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: USDTAURORA amount: type: string example: '0.39785' fiat_amounts: type: array example: [] address: type: string example: mvm7g5pCn8wv4C1NoLdHc9pizqErlA address_tag: type: string example: 3hj8z address_uri: type: string example: 'aurora:mvm7g5pCn8wv4C1NoLdHc9pizqErlA' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-08-11T10:58:05.000000Z' status: type: string example: refunded status_reason: type: string example: null metadata: type: object properties: total: type: integer example: 840060 per_page: type: integer example: 46171 next_cursor: type: string example: 67D7NEwJj5s6BaCr previous_cursor: type: string example: Et6qkUTjkglI5LJ2 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: IkS3XHh1FvwiWICI 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: dfddFAde-cAcc-ecbC-Cfba-acCEdFddEadF 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: d8bDa5Z1E6V43fPvha6kcge 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: 019898c7-c4d7-72e5-995b-eb351bcf8836 channel_id: 019898c7-c4d5-7347-ad2a-ec79f01d52ed customer_external_id: MeLzBcs4n5fAVp3N external_id: pXiYuAPlWF external_data: '{"foo":"bar"}' currency: LTC amount: '496.81104' amount_minus_fee: '496.7613589' received_currency: LTC received_amount: '496.7613589' conversion_exchange_rate: null fees: processing_channel: currency: LTC amount: '0.0496811' fiat_amounts: [] address: aTQDpXrP8OD2Oe47lZM3cKbcbuYFsy address_tag: VSod1 address_uri: 'litecoin:aTQDpXrP8OD2Oe47lZM3cKbcbuYFsy' transaction_hash: null transaction_risk_score: null created_at: '2025-08-11T10:58:05.000000Z' status: blocked status_reason: null error: null properties: data: type: object properties: id: type: string example: 019898c7-c4d7-72e5-995b-eb351bcf8836 channel_id: type: string example: 019898c7-c4d5-7347-ad2a-ec79f01d52ed customer_external_id: type: string example: MeLzBcs4n5fAVp3N external_id: type: string example: pXiYuAPlWF external_data: type: string example: '{"foo":"bar"}' currency: type: string example: LTC amount: type: string example: '496.81104' amount_minus_fee: type: string example: '496.7613589' received_currency: type: string example: LTC received_amount: type: string example: '496.7613589' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: LTC amount: type: string example: '0.0496811' fiat_amounts: type: array example: [] address: type: string example: aTQDpXrP8OD2Oe47lZM3cKbcbuYFsy address_tag: type: string example: VSod1 address_uri: type: string example: 'litecoin:aTQDpXrP8OD2Oe47lZM3cKbcbuYFsy' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-08-11T10:58:05.000000Z' status: type: string example: blocked 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: abdecCDc-bFfF-BAac-eaCd-cDfDdECCcAee 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: dahVebEZcg6D15v86a4f3Pk 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: UAH quote_currency: USDCBEP20 exchange_rate: 6.25181695 decimals: 18 round_off: 18 error: null properties: data: type: object properties: base_currency: type: string example: UAH quote_currency: type: string example: USDCBEP20 exchange_rate: type: number example: 6.25181695 decimals: type: integer example: 18 round_off: type: integer example: 18 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: aeb4c1v6g3VP6ah85EkZfDd 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: 71008 remaining_amount: 7.00572544 error: null properties: data: type: object properties: limit: type: integer example: 71008 remaining_amount: type: number example: 7.00572544 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: aliquid 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: Dead8ba5VkPZc6g14h3fEv6 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: ut documents: type: array description: '' example: - dolorum 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: []