openapi: 3.0.3 info: title: 'Munzen Merchant API documentation' description: '' version: 1.0.0 servers: - url: 'https://sandbox-api-processing.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: V5k4c3Z6ah1DE6agbPd8vfe 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-4ef2-7127-9b7d-2f35344baeec short_id: L4RUsvydRwz6NFZhsUeCJ number: 44607079 price_currency: USD price_amount: '189324.91' pay_currency: USDCNEAR pay_amount: '892261.550363' exchange_rate: '4.7128588' exchange_rate_expires_at: '2025-08-11T11:09:35.000000Z' address: BscaNHktiXcnb6L1g3ke2HFxjPZtbx address_tag: 0yBV0 address_uri: 'near:BscaNHktiXcnb6L1g3ke2HFxjPZtbx?amount=892261.550363' paid_amount: '7311.8305' paid_amount_minus_fee: '-49525.230258' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCNEAR received_amount: '-49525.230258' conversion_exchange_rate: null fees: processing_invoice: currency: USDCNEAR amount: '56837.060758' fiat_amounts: [] external_id: '176' customer_external_id: iLP0okELSkPfmc8U external_data: '{"foo":"bar"}' name: 'Gardner Strosin MD' description: 'Dr. Jessie Schulist' redirect_url: 'http://www.schmidt.com/dolorem-accusamus-et-dicta-voluptate-est' failure_redirect_url: 'http://jerde.com/' created_at: '2025-08-11T10:57:35.000000Z' expires_at: '2025-08-11T11:24:35.000000Z' status: paid_partially status_context: overpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 019898c7-4ef2-7127-9b7d-2f35344baeec short_id: type: string example: L4RUsvydRwz6NFZhsUeCJ number: type: integer example: 44607079 price_currency: type: string example: USD price_amount: type: string example: '189324.91' pay_currency: type: string example: USDCNEAR pay_amount: type: string example: '892261.550363' exchange_rate: type: string example: '4.7128588' exchange_rate_expires_at: type: string example: '2025-08-11T11:09:35.000000Z' address: type: string example: BscaNHktiXcnb6L1g3ke2HFxjPZtbx address_tag: type: string example: 0yBV0 address_uri: type: string example: 'near:BscaNHktiXcnb6L1g3ke2HFxjPZtbx?amount=892261.550363' paid_amount: type: string example: '7311.8305' paid_amount_minus_fee: type: string example: '-49525.230258' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDCNEAR received_amount: type: string example: '-49525.230258' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDCNEAR amount: type: string example: '56837.060758' fiat_amounts: type: array example: [] external_id: type: string example: '176' customer_external_id: type: string example: iLP0okELSkPfmc8U external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Gardner Strosin MD' description: type: string example: 'Dr. Jessie Schulist' redirect_url: type: string example: 'http://www.schmidt.com/dolorem-accusamus-et-dicta-voluptate-est' failure_redirect_url: type: string example: 'http://jerde.com/' created_at: type: string example: '2025-08-11T10:57:35.000000Z' expires_at: type: string example: '2025-08-11T11:24:35.000000Z' status: type: string example: paid_partially status_context: type: string example: overpaid 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: EPgDZk86vah6cfd3b14Ve5a 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: hfkc8Da3v1b4eZP6dgaVE65 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-4f2c-7092-850b-1e095f98f90f short_id: mbKiha9hKWyA9bshsUeCJ number: 31322506 price_currency: UAH price_amount: '900.33' pay_currency: USDCAURORA pay_amount: '1318.81333' exchange_rate: '1.46480412' exchange_rate_expires_at: '2025-08-11T11:09:35.000000Z' address: srQPxL7ve4nTXl6uAkxQODEN3sNeQY address_tag: P1Zl7 address_uri: 'aurora:srQPxL7ve4nTXl6uAkxQODEN3sNeQY?amount=1318.81333' paid_amount: '83614900.086678' paid_amount_minus_fee: '83614783.50358' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCAURORA received_amount: '83614783.50358' conversion_exchange_rate: null fees: processing_invoice: currency: USDCAURORA amount: '116.583098' fiat_amounts: [] external_id: '575' customer_external_id: OEy6E9jF5mKDz0F9 external_data: '{"foo":"bar"}' name: 'Wiley Towne' description: 'Prof. Leon Hermiston' redirect_url: 'http://mosciski.com/sint-voluptatibus-et-animi-quaerat-harum-aut-facilis-qui' failure_redirect_url: 'http://sanford.com/cumque-doloribus-quas-eos-a-ut' created_at: '2025-08-11T10:57:35.000000Z' expires_at: '2025-08-11T11:20:35.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: 019898c7-4f2c-7092-850b-1e095f98f90f short_id: type: string example: mbKiha9hKWyA9bshsUeCJ number: type: integer example: 31322506 price_currency: type: string example: UAH price_amount: type: string example: '900.33' pay_currency: type: string example: USDCAURORA pay_amount: type: string example: '1318.81333' exchange_rate: type: string example: '1.46480412' exchange_rate_expires_at: type: string example: '2025-08-11T11:09:35.000000Z' address: type: string example: srQPxL7ve4nTXl6uAkxQODEN3sNeQY address_tag: type: string example: P1Zl7 address_uri: type: string example: 'aurora:srQPxL7ve4nTXl6uAkxQODEN3sNeQY?amount=1318.81333' paid_amount: type: string example: '83614900.086678' paid_amount_minus_fee: type: string example: '83614783.50358' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDCAURORA received_amount: type: string example: '83614783.50358' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDCAURORA amount: type: string example: '116.583098' fiat_amounts: type: array example: [] external_id: type: string example: '575' customer_external_id: type: string example: OEy6E9jF5mKDz0F9 external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Wiley Towne' description: type: string example: 'Prof. Leon Hermiston' redirect_url: type: string example: 'http://mosciski.com/sint-voluptatibus-et-animi-quaerat-harum-aut-facilis-qui' failure_redirect_url: type: string example: 'http://sanford.com/cumque-doloribus-quas-eos-a-ut' created_at: type: string example: '2025-08-11T10:57:35.000000Z' expires_at: type: string example: '2025-08-11T11:20:35.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: Za5aD1Eh63g8cfbVd4vPke6 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-4f5d-704d-9431-3a0f1fd9eb1d short_id: 2LBy35gPKDySe6AisUeCJ number: 55620335 price_currency: EUR price_amount: '59.07' pay_currency: ETHAURORA pay_amount: '344.94023674199' exchange_rate: '5.8394507' exchange_rate_expires_at: '2025-08-11T11:10:35.000000Z' address: Jf2cStquDZGqmWcPbm4vWBheS7bRST address_tag: hfH4B address_uri: 'aurora:Jf2cStquDZGqmWcPbm4vWBheS7bRST?amount=344.94023674199' paid_amount: '12989.677085' paid_amount_minus_fee: '12973.947810205' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: ETHAURORA received_amount: '12973.947810205' conversion_exchange_rate: null fees: processing_invoice: currency: ETHAURORA amount: '15.729274795435' fiat_amounts: [] external_id: '581' customer_external_id: QXhq1Xt4rPhmQoue external_data: '{"foo":"bar"}' name: 'Ole Langosh' description: 'Joseph Hyatt' redirect_url: 'http://kshlerin.net/reprehenderit-libero-architecto-repudiandae-rem-omnis' failure_redirect_url: 'http://cummings.org/in-in-a-reiciendis-voluptas-ullam' created_at: '2025-08-11T10:57:35.000000Z' expires_at: '2025-08-11T11:21:35.000000Z' status: pending_payment status_context: overpaid status_reason: null can_be_paid_partially: false error: null properties: data: type: object properties: id: type: string example: 019898c7-4f5d-704d-9431-3a0f1fd9eb1d short_id: type: string example: 2LBy35gPKDySe6AisUeCJ number: type: integer example: 55620335 price_currency: type: string example: EUR price_amount: type: string example: '59.07' pay_currency: type: string example: ETHAURORA pay_amount: type: string example: '344.94023674199' exchange_rate: type: string example: '5.8394507' exchange_rate_expires_at: type: string example: '2025-08-11T11:10:35.000000Z' address: type: string example: Jf2cStquDZGqmWcPbm4vWBheS7bRST address_tag: type: string example: hfH4B address_uri: type: string example: 'aurora:Jf2cStquDZGqmWcPbm4vWBheS7bRST?amount=344.94023674199' paid_amount: type: string example: '12989.677085' paid_amount_minus_fee: type: string example: '12973.947810205' 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: '12973.947810205' 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: '15.729274795435' fiat_amounts: type: array example: [] external_id: type: string example: '581' customer_external_id: type: string example: QXhq1Xt4rPhmQoue external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Ole Langosh' description: type: string example: 'Joseph Hyatt' redirect_url: type: string example: 'http://kshlerin.net/reprehenderit-libero-architecto-repudiandae-rem-omnis' failure_redirect_url: type: string example: 'http://cummings.org/in-in-a-reiciendis-voluptas-ullam' created_at: type: string example: '2025-08-11T10:57:35.000000Z' expires_at: type: string example: '2025-08-11T11:21:35.000000Z' status: type: string example: pending_payment status_context: type: string example: overpaid 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: UAH 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: 497.425791414 pay_currency: type: string description: '' example: USDCBASE 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://larson.com/' failure_redirect_url: type: string description: '' example: 'http://www.pollich.net/voluptate-culpa-suscipit-et-quaerat-unde-consequatur-et-voluptas' 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: c4P63kvV61gEd8fheDaZb5a 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-4f8c-7276-9dfd-6f13e1a13fa3 short_id: mmiDHUW9GUiuGxQisUeCJ number: 48272665 price_currency: EUR price_amount: '36.3' pay_currency: USDCMATIC pay_amount: '78.880686' exchange_rate: '2.17324927' exchange_rate_expires_at: '2025-08-11T11:08:35.000000Z' address: Oqy5AMZDkRNi9yB6dVpCP9uS1oHdWH address_tag: gReNv address_uri: 'ethereum:Oqy5AMZDkRNi9yB6dVpCP9uS1oHdWH?amount=78.880686' paid_amount: '70' paid_amount_minus_fee: '66.552914' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCMATIC received_amount: '66.552914' conversion_exchange_rate: null fees: processing_invoice: currency: USDCMATIC amount: '3.447086' fiat_amounts: [] external_id: '659' customer_external_id: u9HMupgpEIPZ0I7C external_data: '{"foo":"bar"}' name: 'Kacie Leuschke' description: 'Lavada Lind' redirect_url: 'http://goyette.org/quos-hic-aut-placeat-ut-cupiditate-animi' failure_redirect_url: 'http://littel.com/' created_at: '2025-08-11T10:57:35.000000Z' expires_at: '2025-08-11T11:23:35.000000Z' status: paid_partially status_context: overpaid status_reason: null can_be_paid_partially: false error: null properties: data: type: object properties: id: type: string example: 019898c7-4f8c-7276-9dfd-6f13e1a13fa3 short_id: type: string example: mmiDHUW9GUiuGxQisUeCJ number: type: integer example: 48272665 price_currency: type: string example: EUR price_amount: type: string example: '36.3' pay_currency: type: string example: USDCMATIC pay_amount: type: string example: '78.880686' exchange_rate: type: string example: '2.17324927' exchange_rate_expires_at: type: string example: '2025-08-11T11:08:35.000000Z' address: type: string example: Oqy5AMZDkRNi9yB6dVpCP9uS1oHdWH address_tag: type: string example: gReNv address_uri: type: string example: 'ethereum:Oqy5AMZDkRNi9yB6dVpCP9uS1oHdWH?amount=78.880686' paid_amount: type: string example: '70' paid_amount_minus_fee: type: string example: '66.552914' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDCMATIC received_amount: type: string example: '66.552914' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDCMATIC amount: type: string example: '3.447086' fiat_amounts: type: array example: [] external_id: type: string example: '659' customer_external_id: type: string example: u9HMupgpEIPZ0I7C external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Kacie Leuschke' description: type: string example: 'Lavada Lind' redirect_url: type: string example: 'http://goyette.org/quos-hic-aut-placeat-ut-cupiditate-animi' failure_redirect_url: type: string example: 'http://littel.com/' created_at: type: string example: '2025-08-11T10:57:35.000000Z' expires_at: type: string example: '2025-08-11T11:23:35.000000Z' status: type: string example: paid_partially status_context: type: string example: overpaid 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: 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 price_amount: type: number description: '' example: 572585.0 currencies_for_pay: type: array description: '' example: - EUR 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://www.kulas.com/' failure_redirect_url: type: string description: '' example: 'http://schultz.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: 3aD6cbvdPE48hVgaZf16k5e 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-5002-712d-9a22-6f7764eeaf4c amount_requested: 946.11419 amount_to_send: 946.11419 fee_amount: 2.79881 status: rejected status_reason: invalid_amount currency: BNB source_currency: EUR source_amount: 765.9779 source_exchange_rate: 620.0603 error: null properties: data: type: object properties: id: type: string example: 019898c7-5002-712d-9a22-6f7764eeaf4c amount_requested: type: number example: 946.11419 amount_to_send: type: number example: 946.11419 fee_amount: type: number example: 2.79881 status: type: string example: rejected status_reason: type: string example: invalid_amount currency: type: string example: BNB source_currency: type: string example: EUR source_amount: type: number example: 765.9779 source_exchange_rate: type: number example: 620.0603 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: dD66ahkP8vbEaVg5Z43ecf1 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-5052-7260-9b92-eb346930f493 currency: USDTENEAR amount_requested: 438.97468 amount_to_send: 438.97468 amount_to_charge: 451.18239 fee_amount: 12.20771 status: complete status_reason: insufficient_funds created_at: '2025-08-11T10:57:35.000000Z' fee_included: false source_currency: EUR source_amount: 186.52905 source_exchange_rate: 293.49617 error: null properties: data: type: object properties: id: type: string example: 019898c7-5052-7260-9b92-eb346930f493 currency: type: string example: USDTENEAR amount_requested: type: number example: 438.97468 amount_to_send: type: number example: 438.97468 amount_to_charge: type: number example: 451.18239 fee_amount: type: number example: 12.20771 status: type: string example: complete status_reason: type: string example: insufficient_funds created_at: type: string example: '2025-08-11T10:57:35.000000Z' fee_included: type: boolean example: false source_currency: type: string example: EUR source_amount: type: number example: 186.52905 source_exchange_rate: type: number example: 293.49617 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: dk6VD81aZv4fhePa3bg65Ec 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-50a0-73d5-85ad-64a0e6faa18f currency: USDCNEAR amount_requested: 213.10417 amount_to_send: 205.64219 amount_to_charge: 213.10417 fee_amount: 7.46198 status: complete status_reason: invalid_amount created_at: '2025-08-11T10:57:35.000000Z' fee_included: true source_currency: EUR source_amount: 178.2975 source_exchange_rate: 288.25114 error: null properties: data: type: object properties: id: type: string example: 019898c7-50a0-73d5-85ad-64a0e6faa18f currency: type: string example: USDCNEAR amount_requested: type: number example: 213.10417 amount_to_send: type: number example: 205.64219 amount_to_charge: type: number example: 213.10417 fee_amount: type: number example: 7.46198 status: type: string example: complete status_reason: type: string example: invalid_amount created_at: type: string example: '2025-08-11T10:57:35.000000Z' fee_included: type: boolean example: true source_currency: type: string example: EUR source_amount: type: number example: 178.2975 source_exchange_rate: type: number example: 288.25114 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: gkh8adeP6Vba6vE51D3c4Zf 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-50c8-7107-a09b-69535b81a155 customer_external_id: Z9NYO7Jm3z3TEpC1 external_id: 6oTg58V3V4 external_data: '{"foo":"bar"}' currency: SOL address: A67gPFQRKHaUOMxjUD71NhoH2HVXdJ address_tag: gYDJM address_uri: 'solana:A67gPFQRKHaUOMxjUD71NhoH2HVXdJ' created_at: '2025-08-11T10:57:35.000000Z' error: null properties: data: type: object properties: id: type: string example: 019898c7-50c8-7107-a09b-69535b81a155 customer_external_id: type: string example: Z9NYO7Jm3z3TEpC1 external_id: type: string example: 6oTg58V3V4 external_data: type: string example: '{"foo":"bar"}' currency: type: string example: SOL address: type: string example: A67gPFQRKHaUOMxjUD71NhoH2HVXdJ address_tag: type: string example: gYDJM address_uri: type: string example: 'solana:A67gPFQRKHaUOMxjUD71NhoH2HVXdJ' created_at: type: string example: '2025-08-11T10:57:35.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: ZDg6ab65kPe3Vchda148Efv 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-50e1-7106-be95-1362a84062f0 customer_external_id: PkfueuSLvFUsuHv9 external_id: UrVAyMdjTu external_data: '{"foo":"bar"}' currency: ETH address: O7SR6jC0W1BK7jPo6kgckODxbQBhkS address_tag: RASo7 address_uri: 'ethereum:O7SR6jC0W1BK7jPo6kgckODxbQBhkS' created_at: '2025-08-11T10:57:35.000000Z' error: null properties: data: type: array example: - id: 019898c7-50e1-7106-be95-1362a84062f0 customer_external_id: PkfueuSLvFUsuHv9 external_id: UrVAyMdjTu external_data: '{"foo":"bar"}' currency: ETH address: O7SR6jC0W1BK7jPo6kgckODxbQBhkS address_tag: RASo7 address_uri: 'ethereum:O7SR6jC0W1BK7jPo6kgckODxbQBhkS' created_at: '2025-08-11T10:57:35.000000Z' items: type: object properties: id: type: string example: 019898c7-50e1-7106-be95-1362a84062f0 customer_external_id: type: string example: PkfueuSLvFUsuHv9 external_id: type: string example: UrVAyMdjTu external_data: type: string example: '{"foo":"bar"}' currency: type: string example: ETH address: type: string example: O7SR6jC0W1BK7jPo6kgckODxbQBhkS address_tag: type: string example: RASo7 address_uri: type: string example: 'ethereum:O7SR6jC0W1BK7jPo6kgckODxbQBhkS' created_at: type: string example: '2025-08-11T10:57:35.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: V6h3ca84fvd1eDPab5gE6kZ 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-5102-73de-984e-b8e7a624d156 channel_id: 019898c7-5100-72c8-8ea6-144590ed37fc customer_external_id: ZeUSxwCiGloHv0Y6 external_id: GxPmSxnnF7 external_data: '{"foo":"bar"}' currency: USDCTRC20 amount: '532.06345' amount_minus_fee: '531.797418' received_currency: USDCTRC20 received_amount: '531.797418' conversion_exchange_rate: null fees: processing_channel: currency: USDCTRC20 amount: '0.266032' fiat_amounts: [] address: 1EuFlKuPu8VmNofoNysxMIj8WBvM2M address_tag: sEP6e address_uri: 'tron:1EuFlKuPu8VmNofoNysxMIj8WBvM2M' transaction_hash: null transaction_risk_score: null created_at: '2025-08-11T10:57:36.000000Z' status: on_hold status_reason: null metadata: total: 607701 per_page: 509512 next_cursor: fJLqZm3gZzZoToi8 previous_cursor: KhqNSxlFhhe9Eefv error: null properties: data: type: object properties: list: type: array example: - id: 019898c7-5102-73de-984e-b8e7a624d156 channel_id: 019898c7-5100-72c8-8ea6-144590ed37fc customer_external_id: ZeUSxwCiGloHv0Y6 external_id: GxPmSxnnF7 external_data: '{"foo":"bar"}' currency: USDCTRC20 amount: '532.06345' amount_minus_fee: '531.797418' received_currency: USDCTRC20 received_amount: '531.797418' conversion_exchange_rate: null fees: processing_channel: currency: USDCTRC20 amount: '0.266032' fiat_amounts: [] address: 1EuFlKuPu8VmNofoNysxMIj8WBvM2M address_tag: sEP6e address_uri: 'tron:1EuFlKuPu8VmNofoNysxMIj8WBvM2M' transaction_hash: null transaction_risk_score: null created_at: '2025-08-11T10:57:36.000000Z' status: on_hold status_reason: null items: type: object properties: id: type: string example: 019898c7-5102-73de-984e-b8e7a624d156 channel_id: type: string example: 019898c7-5100-72c8-8ea6-144590ed37fc customer_external_id: type: string example: ZeUSxwCiGloHv0Y6 external_id: type: string example: GxPmSxnnF7 external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDCTRC20 amount: type: string example: '532.06345' amount_minus_fee: type: string example: '531.797418' received_currency: type: string example: USDCTRC20 received_amount: type: string example: '531.797418' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: USDCTRC20 amount: type: string example: '0.266032' fiat_amounts: type: array example: [] address: type: string example: 1EuFlKuPu8VmNofoNysxMIj8WBvM2M address_tag: type: string example: sEP6e address_uri: type: string example: 'tron:1EuFlKuPu8VmNofoNysxMIj8WBvM2M' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-08-11T10:57:36.000000Z' status: type: string example: on_hold status_reason: type: string example: null metadata: type: object properties: total: type: integer example: 607701 per_page: type: integer example: 509512 next_cursor: type: string example: fJLqZm3gZzZoToi8 previous_cursor: type: string example: KhqNSxlFhhe9Eefv 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: gpMJPFfeBauVSFKi 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: CFFdbaEB-Dfea-ddEc-bFEF-aaEDbdbFaFCe 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: kve1fD3d4gEc6aP6h5bZ8aV 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-5123-71b3-b813-b5fec4932275 channel_id: 019898c7-5122-72f4-8d4e-6c139a6abdf2 customer_external_id: 0DuzvreoMM9xTWUa external_id: kzfYefWDoJ external_data: '{"foo":"bar"}' currency: USDTMATIC amount: '982.98195' amount_minus_fee: '982.883652' received_currency: USDTMATIC received_amount: '982.883652' conversion_exchange_rate: null fees: processing_channel: currency: USDTMATIC amount: '0.098298' fiat_amounts: [] address: 3EMioLpdCvUEa1utUQc8SE0kLLLuy2 address_tag: pcmCN address_uri: 'ethereum:3EMioLpdCvUEa1utUQc8SE0kLLLuy2' transaction_hash: null transaction_risk_score: null created_at: '2025-08-11T10:57:36.000000Z' status: created status_reason: null error: null properties: data: type: object properties: id: type: string example: 019898c7-5123-71b3-b813-b5fec4932275 channel_id: type: string example: 019898c7-5122-72f4-8d4e-6c139a6abdf2 customer_external_id: type: string example: 0DuzvreoMM9xTWUa external_id: type: string example: kzfYefWDoJ external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDTMATIC amount: type: string example: '982.98195' amount_minus_fee: type: string example: '982.883652' received_currency: type: string example: USDTMATIC received_amount: type: string example: '982.883652' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: USDTMATIC amount: type: string example: '0.098298' fiat_amounts: type: array example: [] address: type: string example: 3EMioLpdCvUEa1utUQc8SE0kLLLuy2 address_tag: type: string example: pcmCN address_uri: type: string example: 'ethereum:3EMioLpdCvUEa1utUQc8SE0kLLLuy2' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-08-11T10:57:36.000000Z' status: type: string example: created 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: aabFaCbD-dBDF-Cbdc-AbeA-BdEceFdfbAed 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: V6EvchPg1feakd4Dba385Z6 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: KZT quote_currency: BCH exchange_rate: 3.15188328 decimals: 8 round_off: 8 error: null properties: data: type: object properties: base_currency: type: string example: KZT quote_currency: type: string example: BCH exchange_rate: type: number example: 3.15188328 decimals: type: integer example: 8 round_off: type: integer example: 8 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: a3Z8fh1akb66decgvV54PDE 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: 126905 remaining_amount: 115.5079638 error: null properties: data: type: object properties: limit: type: integer example: 126905 remaining_amount: type: number example: 115.5079638 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: voluptatum 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: kZbvg6P4V8aEe5f6Dc1dah3 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: fuga documents: type: array description: '' example: - corporis 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: []