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: 1fedvahg3E45cZbV6DakP86 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-420a-7382-8788-6f276213e60f short_id: m7eK7aqzEquoVJDKLje7J number: 71529634 price_currency: UAH price_amount: '70502828.79' pay_currency: USDTNEAR pay_amount: '32528383.638958' exchange_rate: '0.461377' exchange_rate_expires_at: '2025-04-23T11:44:09.000000Z' address: JxU2hD1GnsDPKRmnZRl7PgTNu8MpiB address_tag: ELpP3 address_uri: 'near:JxU2hD1GnsDPKRmnZRl7PgTNu8MpiB?amount=32528383.638958' paid_amount: '31318717.206325' paid_amount_minus_fee: '30089144.304772' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDTNEAR received_amount: '30089144.304772' conversion_exchange_rate: null fees: processing_invoice: currency: USDTNEAR amount: '1229572.901553' fiat_amounts: [] external_id: '761' customer_external_id: LqJktQEdt91Nm1B0 external_data: '{"foo":"bar"}' name: 'Boyd Osinski' description: 'Gustave McDermott' redirect_url: 'https://bosco.info/aut-expedita-nostrum-est-rerum-quae-quia-perferendis-illo.html' failure_redirect_url: 'https://www.smith.net/et-mollitia-quasi-nemo-dolorem-dignissimos-ut-voluptatem' created_at: '2025-04-23T11:34:09.000000Z' expires_at: '2025-04-23T12:01:09.000000Z' status: expired status_context: overpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196626d-420a-7382-8788-6f276213e60f short_id: type: string example: m7eK7aqzEquoVJDKLje7J number: type: integer example: 71529634 price_currency: type: string example: UAH price_amount: type: string example: '70502828.79' pay_currency: type: string example: USDTNEAR pay_amount: type: string example: '32528383.638958' exchange_rate: type: string example: '0.461377' exchange_rate_expires_at: type: string example: '2025-04-23T11:44:09.000000Z' address: type: string example: JxU2hD1GnsDPKRmnZRl7PgTNu8MpiB address_tag: type: string example: ELpP3 address_uri: type: string example: 'near:JxU2hD1GnsDPKRmnZRl7PgTNu8MpiB?amount=32528383.638958' paid_amount: type: string example: '31318717.206325' paid_amount_minus_fee: type: string example: '30089144.304772' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDTNEAR received_amount: type: string example: '30089144.304772' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDTNEAR amount: type: string example: '1229572.901553' fiat_amounts: type: array example: [] external_id: type: string example: '761' customer_external_id: type: string example: LqJktQEdt91Nm1B0 external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Boyd Osinski' description: type: string example: 'Gustave McDermott' redirect_url: type: string example: 'https://bosco.info/aut-expedita-nostrum-est-rerum-quae-quia-perferendis-illo.html' failure_redirect_url: type: string example: 'https://www.smith.net/et-mollitia-quasi-nemo-dolorem-dignissimos-ut-voluptatem' created_at: type: string example: '2025-04-23T11:34:09.000000Z' expires_at: type: string example: '2025-04-23T12:01:09.000000Z' status: type: string example: expired 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: 6va6ehk5V1cDEd8gfb34PaZ 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: f16DkceVP8d3bhaEgZ4av65 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-424b-704e-a4f8-d101f7d95649 short_id: a4cT7sXX4WdqJrZKLje7J number: 31849168 price_currency: EUR price_amount: '5.59' pay_currency: NEAR pay_amount: '6.6848574759045' exchange_rate: '1.19517041' exchange_rate_expires_at: '2025-04-23T11:48:09.000000Z' address: LcO2KFGLtYTIxOeP2DF21sxjTJ7rsn address_tag: 1QFMS address_uri: 'near:LcO2KFGLtYTIxOeP2DF21sxjTJ7rsn?amount=6.6848574759045' paid_amount: '42832.5328' paid_amount_minus_fee: '42832.241340214' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: NEAR received_amount: '42832.241340214' conversion_exchange_rate: null fees: processing_invoice: currency: NEAR amount: '0.29145978594944' fiat_amounts: [] external_id: '592' customer_external_id: ng7lQkGnmZwf2MC3 external_data: '{"foo":"bar"}' name: 'Prof. Wilfredo Orn V' description: 'Gerardo Weissnat III' redirect_url: 'http://connelly.org/aut-repellat-aut-eius.html' failure_redirect_url: 'https://www.bernhard.org/et-et-in-aperiam-vel-dolor-fugiat-optio' created_at: '2025-04-23T11:34:09.000000Z' expires_at: '2025-04-23T12:00:09.000000Z' status: on_hold status_context: overpaid status_reason: null can_be_paid_partially: false error: null properties: data: type: object properties: id: type: string example: 0196626d-424b-704e-a4f8-d101f7d95649 short_id: type: string example: a4cT7sXX4WdqJrZKLje7J number: type: integer example: 31849168 price_currency: type: string example: EUR price_amount: type: string example: '5.59' pay_currency: type: string example: NEAR pay_amount: type: string example: '6.6848574759045' exchange_rate: type: string example: '1.19517041' exchange_rate_expires_at: type: string example: '2025-04-23T11:48:09.000000Z' address: type: string example: LcO2KFGLtYTIxOeP2DF21sxjTJ7rsn address_tag: type: string example: 1QFMS address_uri: type: string example: 'near:LcO2KFGLtYTIxOeP2DF21sxjTJ7rsn?amount=6.6848574759045' paid_amount: type: string example: '42832.5328' paid_amount_minus_fee: type: string example: '42832.241340214' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: NEAR received_amount: type: string example: '42832.241340214' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: NEAR amount: type: string example: '0.29145978594944' fiat_amounts: type: array example: [] external_id: type: string example: '592' customer_external_id: type: string example: ng7lQkGnmZwf2MC3 external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Prof. Wilfredo Orn V' description: type: string example: 'Gerardo Weissnat III' redirect_url: type: string example: 'http://connelly.org/aut-repellat-aut-eius.html' failure_redirect_url: type: string example: 'https://www.bernhard.org/et-et-in-aperiam-vel-dolor-fugiat-optio' created_at: type: string example: '2025-04-23T11:34:09.000000Z' expires_at: type: string example: '2025-04-23T12:00:09.000000Z' status: type: string example: on_hold 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. 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: 1V5a6a64vcg8Dh3EkbPdfeZ schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-427f-7028-b3eb-1edb51c421cc short_id: jJc3SSwDHaDxuJrKLje7J number: 56873064 price_currency: UAH price_amount: '373.17' pay_currency: USDCTRC20 pay_amount: '1934.973886' exchange_rate: '5.18516585' exchange_rate_expires_at: '2025-04-23T11:46:09.000000Z' address: xnPT4x6EKVdpvxXwcYxG3ea9hkgw5c address_tag: j5zjZ address_uri: 'tron:xnPT4x6EKVdpvxXwcYxG3ea9hkgw5c?amount=1934.973886' paid_amount: '59716333' paid_amount_minus_fee: '59716303.975392' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCTRC20 received_amount: '59716303.975392' conversion_exchange_rate: null fees: processing_invoice: currency: USDCTRC20 amount: '29.024608' fiat_amounts: [] external_id: '091' customer_external_id: THGkYvq2TM22xQF0 external_data: '{"foo":"bar"}' name: 'Carolyn Stamm' description: 'Pietro Weber' redirect_url: 'http://www.wolff.org/ut-alias-nam-nisi-inventore' failure_redirect_url: 'http://marks.biz/quis-aut-eligendi-maxime-quas-cumque-eaque' created_at: '2025-04-23T11:34:09.000000Z' expires_at: '2025-04-23T12:02:09.000000Z' status: canceled status_context: underpaid status_reason: null can_be_paid_partially: false error: null properties: data: type: object properties: id: type: string example: 0196626d-427f-7028-b3eb-1edb51c421cc short_id: type: string example: jJc3SSwDHaDxuJrKLje7J number: type: integer example: 56873064 price_currency: type: string example: UAH price_amount: type: string example: '373.17' pay_currency: type: string example: USDCTRC20 pay_amount: type: string example: '1934.973886' exchange_rate: type: string example: '5.18516585' exchange_rate_expires_at: type: string example: '2025-04-23T11:46:09.000000Z' address: type: string example: xnPT4x6EKVdpvxXwcYxG3ea9hkgw5c address_tag: type: string example: j5zjZ address_uri: type: string example: 'tron:xnPT4x6EKVdpvxXwcYxG3ea9hkgw5c?amount=1934.973886' paid_amount: type: string example: '59716333' paid_amount_minus_fee: type: string example: '59716303.975392' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: USDCTRC20 received_amount: type: string example: '59716303.975392' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: USDCTRC20 amount: type: string example: '29.024608' fiat_amounts: type: array example: [] external_id: type: string example: '091' customer_external_id: type: string example: THGkYvq2TM22xQF0 external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Carolyn Stamm' description: type: string example: 'Pietro Weber' redirect_url: type: string example: 'http://www.wolff.org/ut-alias-nam-nisi-inventore' failure_redirect_url: type: string example: 'http://marks.biz/quis-aut-eligendi-maxime-quas-cumque-eaque' created_at: type: string example: '2025-04-23T11:34:09.000000Z' expires_at: type: string example: '2025-04-23T12:02:09.000000Z' status: type: string example: canceled 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: USDTNEAR 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: 48527.73001 pay_currency: type: string description: '' example: AURORANEAR enum: - BTC - BCH - LTC - ETH - MATIC - TRX - XLM - SOL - BNB - ETHBASE - NEAR - AURORA - USDTERC20 - USDTTRC20 - USDTMATIC - USDTBEP20 - USDTNEAR - USDTENEAR - USDTAURORA - USDCERC20 - USDCTRC20 - USDCMATIC - USDCNEAR - USDCENEAR - USDCBEP20 - USDCAURORA - USDCXLM - USDCBASE - AURORANEAR - ETHAURORA - EUR - USD - UAH - KZT 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://hegmann.biz/' failure_redirect_url: type: string description: '' example: 'http://www.stoltenberg.info/laborum-non-eum-beatae.html' timestamp: type: string description: 'Current Unix timestamp in seconds. Must be a valid date in the format U.' example: 1681897688 required: - price_currency - price_amount - pay_currency - customer_external_id - timestamp /api/v1/merchant/invoices/payment-link: post: summary: 'Create invoice payment link' operationId: createInvoicePaymentLink description: 'Creates new invoice payment link with provided data and shows information about it.' parameters: - in: header name: X-Munzen-Key description: '' example: fhZc6bgaPkVvdDaeE518436 schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-42b1-71ec-866b-6fc64353f491 short_id: Rm7pcbVTnRMCc89LLje7J number: 87640783 price_currency: USD price_amount: '155.81' pay_currency: USDCMATIC pay_amount: '1412.561183' exchange_rate: '9.06615269' exchange_rate_expires_at: '2025-04-23T11:47:09.000000Z' address: DbAtWkvg8i0WOYt9GkzwNMLZzZTgew address_tag: zAp4G address_uri: 'ethereum:DbAtWkvg8i0WOYt9GkzwNMLZzZTgew?amount=1412.561183' paid_amount: '763.421735' paid_amount_minus_fee: '705.930495' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCMATIC received_amount: '705.930495' conversion_exchange_rate: null fees: processing_invoice: currency: USDCMATIC amount: '57.49124' fiat_amounts: [] external_id: '709' customer_external_id: fDneD80SA5368ogg external_data: '{"foo":"bar"}' name: 'Pablo Rippin' description: 'Rosetta Lesch' redirect_url: 'http://www.williamson.com/' failure_redirect_url: 'http://www.rice.org/consequatur-excepturi-a-quos-repellat-est' created_at: '2025-04-23T11:34:09.000000Z' expires_at: '2025-04-23T12:01:09.000000Z' status: blocked status_context: underpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196626d-42b1-71ec-866b-6fc64353f491 short_id: type: string example: Rm7pcbVTnRMCc89LLje7J number: type: integer example: 87640783 price_currency: type: string example: USD price_amount: type: string example: '155.81' pay_currency: type: string example: USDCMATIC pay_amount: type: string example: '1412.561183' exchange_rate: type: string example: '9.06615269' exchange_rate_expires_at: type: string example: '2025-04-23T11:47:09.000000Z' address: type: string example: DbAtWkvg8i0WOYt9GkzwNMLZzZTgew address_tag: type: string example: zAp4G address_uri: type: string example: 'ethereum:DbAtWkvg8i0WOYt9GkzwNMLZzZTgew?amount=1412.561183' paid_amount: type: string example: '763.421735' paid_amount_minus_fee: type: string example: '705.930495' 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: '705.930495' 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: '57.49124' fiat_amounts: type: array example: [] external_id: type: string example: '709' customer_external_id: type: string example: fDneD80SA5368ogg external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Pablo Rippin' description: type: string example: 'Rosetta Lesch' redirect_url: type: string example: 'http://www.williamson.com/' failure_redirect_url: type: string example: 'http://www.rice.org/consequatur-excepturi-a-quos-repellat-est' created_at: type: string example: '2025-04-23T11:34:09.000000Z' expires_at: type: string example: '2025-04-23T12:01:09.000000Z' status: type: string example: blocked 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: USDCNEAR 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: 2526.3255 currencies_for_pay: type: array description: '' example: - SOL 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.beahan.biz/fuga-qui-sunt-quia-doloribus-velit-a.html' failure_redirect_url: type: string description: '' example: 'https://abshire.biz/fuga-distinctio-earum-eveniet-pariatur-deleniti-sit-ea-labore.html' 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: 415kEvd36aDZcPVebf6ah8g schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-4323-7038-be18-984fae6c5d5f amount_requested: 28.29548 amount_to_send: 18.45067 fee_amount: 9.84481 status: rejected status_reason: tx_stale currency: USDCAURORA source_currency: EUR source_amount: 143.67557 source_exchange_rate: 593.55223 error: null properties: data: type: object properties: id: type: string example: 0196626d-4323-7038-be18-984fae6c5d5f amount_requested: type: number example: 28.29548 amount_to_send: type: number example: 18.45067 fee_amount: type: number example: 9.84481 status: type: string example: rejected status_reason: type: string example: tx_stale currency: type: string example: USDCAURORA source_currency: type: string example: EUR source_amount: type: number example: 143.67557 source_exchange_rate: type: number example: 593.55223 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: ac18av53geE6VDkbZ6f4Phd schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-4370-7390-8f45-f711358ab449 currency: USDCBEP20 amount_requested: 146.64777 amount_to_send: 146.64777 amount_to_charge: 150.4605 fee_amount: 3.81273 status: rejected status_reason: tx_stale created_at: '2025-04-23T11:34:10.000000Z' fee_included: false source_currency: USD source_amount: 448.95888 source_exchange_rate: 557.11588 error: null properties: data: type: object properties: id: type: string example: 0196626d-4370-7390-8f45-f711358ab449 currency: type: string example: USDCBEP20 amount_requested: type: number example: 146.64777 amount_to_send: type: number example: 146.64777 amount_to_charge: type: number example: 150.4605 fee_amount: type: number example: 3.81273 status: type: string example: rejected status_reason: type: string example: tx_stale created_at: type: string example: '2025-04-23T11:34:10.000000Z' fee_included: type: boolean example: false source_currency: type: string example: USD source_amount: type: number example: 448.95888 source_exchange_rate: type: number example: 557.11588 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: 6kZa5Pv8Vce4dfD316ghaEb schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-43bf-71b4-81c6-4f74396ba2fa currency: USDCBASE amount_requested: 887.60182 amount_to_send: 880.04301 amount_to_charge: 887.60182 fee_amount: 7.55881 status: processing status_reason: month_limit_exceeded created_at: '2025-04-23T11:34:10.000000Z' fee_included: true source_currency: UAH source_amount: 773.32773 source_exchange_rate: 747.4075 error: null properties: data: type: object properties: id: type: string example: 0196626d-43bf-71b4-81c6-4f74396ba2fa currency: type: string example: USDCBASE amount_requested: type: number example: 887.60182 amount_to_send: type: number example: 880.04301 amount_to_charge: type: number example: 887.60182 fee_amount: type: number example: 7.55881 status: type: string example: processing status_reason: type: string example: month_limit_exceeded created_at: type: string example: '2025-04-23T11:34:10.000000Z' fee_included: type: boolean example: true source_currency: type: string example: UAH source_amount: type: number example: 773.32773 source_exchange_rate: type: number example: 747.4075 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: 3e6f5ZEd1khD4abv6Pg8Vac schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-43e8-70a3-8574-060969abc6c0 customer_external_id: B3oSqo9kikailudN external_id: WhY0wH4MkW external_data: '{"foo":"bar"}' currency: TRX address: 4qqNGVneiUwqEaKKGikjZ3sRFw8TY3 address_tag: 0I3IM address_uri: 'tron:4qqNGVneiUwqEaKKGikjZ3sRFw8TY3' created_at: '2025-04-23T11:34:10.000000Z' error: null properties: data: type: object properties: id: type: string example: 0196626d-43e8-70a3-8574-060969abc6c0 customer_external_id: type: string example: B3oSqo9kikailudN external_id: type: string example: WhY0wH4MkW external_data: type: string example: '{"foo":"bar"}' currency: type: string example: TRX address: type: string example: 4qqNGVneiUwqEaKKGikjZ3sRFw8TY3 address_tag: type: string example: 0I3IM address_uri: type: string example: 'tron:4qqNGVneiUwqEaKKGikjZ3sRFw8TY3' created_at: type: string example: '2025-04-23T11:34:10.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: c8Ehbk315av6ZeVfag64DPd schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 0196626d-4432-7109-a763-63c1b2615046 customer_external_id: PPDW4oPWIL0zkMOc external_id: wV4OXaS4gR external_data: '{"foo":"bar"}' currency: USDCBASE address: AOBiWhvFQrSb2uu4ZyQg1fkP592G1o address_tag: Ebuet address_uri: 'ethereum:AOBiWhvFQrSb2uu4ZyQg1fkP592G1o' created_at: '2025-04-23T11:34:10.000000Z' error: null properties: data: type: array example: - id: 0196626d-4432-7109-a763-63c1b2615046 customer_external_id: PPDW4oPWIL0zkMOc external_id: wV4OXaS4gR external_data: '{"foo":"bar"}' currency: USDCBASE address: AOBiWhvFQrSb2uu4ZyQg1fkP592G1o address_tag: Ebuet address_uri: 'ethereum:AOBiWhvFQrSb2uu4ZyQg1fkP592G1o' created_at: '2025-04-23T11:34:10.000000Z' items: type: object properties: id: type: string example: 0196626d-4432-7109-a763-63c1b2615046 customer_external_id: type: string example: PPDW4oPWIL0zkMOc external_id: type: string example: wV4OXaS4gR external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDCBASE address: type: string example: AOBiWhvFQrSb2uu4ZyQg1fkP592G1o address_tag: type: string example: Ebuet address_uri: type: string example: 'ethereum:AOBiWhvFQrSb2uu4ZyQg1fkP592G1o' created_at: type: string example: '2025-04-23T11:34:10.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: fdEVc4Phve81g536aDZ6abk schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: list: - id: 0196626d-4455-73a7-946e-bb3cbaea8b29 channel_id: 0196626d-4454-728a-8a5f-0b7b1cf35ce0 customer_external_id: 92J8uJToWrH0FeRM external_id: r8iuOBDBH6 external_data: '{"foo":"bar"}' currency: SOL amount: '34.11018' amount_minus_fee: '34.103357964' received_currency: SOL received_amount: '34.103357964' conversion_exchange_rate: null fees: processing_channel: currency: SOL amount: '0.006822036' fiat_amounts: [] address: EMAKyn10wsHIdQyiTp5iGzCuJHe9Fv address_tag: rJer5 address_uri: 'solana:EMAKyn10wsHIdQyiTp5iGzCuJHe9Fv' transaction_hash: null transaction_risk_score: null created_at: '2025-04-23T11:34:10.000000Z' status: blocked status_reason: null metadata: total: 678030 per_page: 389112 next_cursor: gKJctXoK5Za9NXNq previous_cursor: Bie7HdA6hZ9ht0Mw error: null properties: data: type: object properties: list: type: array example: - id: 0196626d-4455-73a7-946e-bb3cbaea8b29 channel_id: 0196626d-4454-728a-8a5f-0b7b1cf35ce0 customer_external_id: 92J8uJToWrH0FeRM external_id: r8iuOBDBH6 external_data: '{"foo":"bar"}' currency: SOL amount: '34.11018' amount_minus_fee: '34.103357964' received_currency: SOL received_amount: '34.103357964' conversion_exchange_rate: null fees: processing_channel: currency: SOL amount: '0.006822036' fiat_amounts: [] address: EMAKyn10wsHIdQyiTp5iGzCuJHe9Fv address_tag: rJer5 address_uri: 'solana:EMAKyn10wsHIdQyiTp5iGzCuJHe9Fv' transaction_hash: null transaction_risk_score: null created_at: '2025-04-23T11:34:10.000000Z' status: blocked status_reason: null items: type: object properties: id: type: string example: 0196626d-4455-73a7-946e-bb3cbaea8b29 channel_id: type: string example: 0196626d-4454-728a-8a5f-0b7b1cf35ce0 customer_external_id: type: string example: 92J8uJToWrH0FeRM external_id: type: string example: r8iuOBDBH6 external_data: type: string example: '{"foo":"bar"}' currency: type: string example: SOL amount: type: string example: '34.11018' amount_minus_fee: type: string example: '34.103357964' received_currency: type: string example: SOL received_amount: type: string example: '34.103357964' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: SOL amount: type: string example: '0.006822036' fiat_amounts: type: array example: [] address: type: string example: EMAKyn10wsHIdQyiTp5iGzCuJHe9Fv address_tag: type: string example: rJer5 address_uri: type: string example: 'solana:EMAKyn10wsHIdQyiTp5iGzCuJHe9Fv' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-04-23T11:34:10.000000Z' status: type: string example: blocked status_reason: type: string example: null metadata: type: object properties: total: type: integer example: 678030 per_page: type: integer example: 389112 next_cursor: type: string example: gKJctXoK5Za9NXNq previous_cursor: type: string example: Bie7HdA6hZ9ht0Mw 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: Lqg2qb0z4RHXfx8g 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: BACDeaFb-dBCd-ADAa-deCE-DDdfBeEAabEA 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: d6ch3eV4baP1vg86ka5ZfDE schema: type: string - in: header name: X-Munzen-Signature description: '' example: '{YOUR_REQUEST_SIGNATURE}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 0196626d-447d-714e-97db-65bfdc3ca35a channel_id: 0196626d-447c-7273-9c37-731c0ddc3a42 customer_external_id: 05RQEdou2jH3KZCo external_id: xdwW4Fe8l9 external_data: '{"foo":"bar"}' currency: USDCNEAR amount: '366.48141' amount_minus_fee: '366.224873' received_currency: USDCNEAR received_amount: '366.224873' conversion_exchange_rate: null fees: processing_channel: currency: USDCNEAR amount: '0.256537' fiat_amounts: [] address: Yh1BKucguwEjHggupAhnNskZVt5OC4 address_tag: G3wft address_uri: 'near:Yh1BKucguwEjHggupAhnNskZVt5OC4' transaction_hash: null transaction_risk_score: null created_at: '2025-04-23T11:34:10.000000Z' status: blocked status_reason: null error: null properties: data: type: object properties: id: type: string example: 0196626d-447d-714e-97db-65bfdc3ca35a channel_id: type: string example: 0196626d-447c-7273-9c37-731c0ddc3a42 customer_external_id: type: string example: 05RQEdou2jH3KZCo external_id: type: string example: xdwW4Fe8l9 external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDCNEAR amount: type: string example: '366.48141' amount_minus_fee: type: string example: '366.224873' received_currency: type: string example: USDCNEAR received_amount: type: string example: '366.224873' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: USDCNEAR amount: type: string example: '0.256537' fiat_amounts: type: array example: [] address: type: string example: Yh1BKucguwEjHggupAhnNskZVt5OC4 address_tag: type: string example: G3wft address_uri: type: string example: 'near:Yh1BKucguwEjHggupAhnNskZVt5OC4' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-04-23T11:34:10.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: dcDfeaeC-fAed-dAAA-CbCF-DBdeAFECBeCA 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: bca4dPDZkg158EVh63f6vae 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: AURORA exchange_rate: 1.90685329 decimals: 18 round_off: 18 error: null properties: data: type: object properties: base_currency: type: string example: UAH quote_currency: type: string example: AURORA exchange_rate: type: number example: 1.90685329 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: 63Ze54E8DdaabcP1Vgk6hvf 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: 940535 remaining_amount: 2467.5337 error: null properties: data: type: object properties: limit: type: integer example: 940535 remaining_amount: type: number example: 2467.5337 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: dignissimos 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: e5da4v3Z8bacPD6gEkf1V6h 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: at documents: type: array description: '' example: - sit 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: []