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: a51bEPc6da3kef6Dg4Zv8Vh 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: 0196ed8a-59aa-713f-84c9-1c03bab2dfcd short_id: nhJ2Y8UL85LBV9wr4gs8J number: 93220322 price_currency: UAH price_amount: '17571.53' pay_currency: BTC pay_amount: '98760.09127369' exchange_rate: '5.62046099' exchange_rate_expires_at: '2025-05-20T12:07:09.000000Z' address: jW6nXT3kvDHc0XkwnKi1oSbzQ1vBHH address_tag: kUTfi address_uri: 'bitcoin:jW6nXT3kvDHc0XkwnKi1oSbzQ1vBHH?amount=98760.09127369' paid_amount: '51026.6967571' paid_amount_minus_fee: '45259.10742672' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: BTC received_amount: '45259.10742672' conversion_exchange_rate: null fees: processing_invoice: currency: BTC amount: '5767.58933038' fiat_amounts: [] external_id: '064' customer_external_id: gqZBpZMCzjiE4Jw8 external_data: '{"foo":"bar"}' name: 'Gwendolyn Borer' description: 'Stephen Eichmann II' redirect_url: 'http://www.ullrich.com/accusamus-dolore-quas-consequatur-voluptas' failure_redirect_url: 'http://bechtelar.info/deleniti-voluptas-provident-molestiae-eaque-mollitia' created_at: '2025-05-20T11:53:09.000000Z' expires_at: '2025-05-20T12:22:09.000000Z' status: expired status_context: underpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196ed8a-59aa-713f-84c9-1c03bab2dfcd short_id: type: string example: nhJ2Y8UL85LBV9wr4gs8J number: type: integer example: 93220322 price_currency: type: string example: UAH price_amount: type: string example: '17571.53' pay_currency: type: string example: BTC pay_amount: type: string example: '98760.09127369' exchange_rate: type: string example: '5.62046099' exchange_rate_expires_at: type: string example: '2025-05-20T12:07:09.000000Z' address: type: string example: jW6nXT3kvDHc0XkwnKi1oSbzQ1vBHH address_tag: type: string example: kUTfi address_uri: type: string example: 'bitcoin:jW6nXT3kvDHc0XkwnKi1oSbzQ1vBHH?amount=98760.09127369' paid_amount: type: string example: '51026.6967571' paid_amount_minus_fee: type: string example: '45259.10742672' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: BTC received_amount: type: string example: '45259.10742672' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: BTC amount: type: string example: '5767.58933038' fiat_amounts: type: array example: [] external_id: type: string example: '064' customer_external_id: type: string example: gqZBpZMCzjiE4Jw8 external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Gwendolyn Borer' description: type: string example: 'Stephen Eichmann II' redirect_url: type: string example: 'http://www.ullrich.com/accusamus-dolore-quas-consequatur-voluptas' failure_redirect_url: type: string example: 'http://bechtelar.info/deleniti-voluptas-provident-molestiae-eaque-mollitia' created_at: type: string example: '2025-05-20T11:53:09.000000Z' expires_at: type: string example: '2025-05-20T12:22:09.000000Z' status: type: string example: expired status_context: type: string example: underpaid status_reason: type: string example: null can_be_paid_partially: type: boolean example: true error: type: string example: null 401: description: 'Unauthenticated request' content: application/json: schema: type: object example: data: null error: code: authentication_error message: Unauthenticated. properties: data: type: string example: null error: type: object properties: code: type: string example: authentication_error message: type: string example: Unauthenticated. 404: description: 'Requested resource was not found' content: application/json: schema: type: object example: data: null error: code: http_error message: 'Not found.' properties: data: type: string example: null error: type: object properties: code: type: string example: http_error message: type: string example: 'Not found.' 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: 4ahvEVZ1658ac3dPkb6fDge 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: gfahEe1dVaP6Z683cv5Dbk4 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: 0196ed8a-59e9-711b-b45c-ef4ef30ab248 short_id: cdtTcerqtNgvS5Js4gs8J number: 8302939 price_currency: EUR price_amount: '186.53' pay_currency: BCH pay_amount: '1701.78083159' exchange_rate: '9.1231189' exchange_rate_expires_at: '2025-05-20T12:04:09.000000Z' address: yZ6cPkfAPGYI3bV9cKyQJADVm9I9pV address_tag: 7FzNz address_uri: 'bitcoincash:yZ6cPkfAPGYI3bV9cKyQJADVm9I9pV?amount=1701.78083159' paid_amount: '4615.1521939' paid_amount_minus_fee: '4595.07118009' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: BCH received_amount: '4595.07118009' conversion_exchange_rate: null fees: processing_invoice: currency: BCH amount: '20.08101381' fiat_amounts: [] external_id: '577' customer_external_id: TjdJXiCrMPsd4jhW external_data: '{"foo":"bar"}' name: 'Zetta Green' description: 'Bridget Bosco' redirect_url: 'http://www.boyer.biz/at-saepe-ex-accusamus-ea-eum' failure_redirect_url: 'http://rau.com/modi-ad-natus-sed-quo' created_at: '2025-05-20T11:53:09.000000Z' expires_at: '2025-05-20T12:19:09.000000Z' status: on_hold status_context: overpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196ed8a-59e9-711b-b45c-ef4ef30ab248 short_id: type: string example: cdtTcerqtNgvS5Js4gs8J number: type: integer example: 8302939 price_currency: type: string example: EUR price_amount: type: string example: '186.53' pay_currency: type: string example: BCH pay_amount: type: string example: '1701.78083159' exchange_rate: type: string example: '9.1231189' exchange_rate_expires_at: type: string example: '2025-05-20T12:04:09.000000Z' address: type: string example: yZ6cPkfAPGYI3bV9cKyQJADVm9I9pV address_tag: type: string example: 7FzNz address_uri: type: string example: 'bitcoincash:yZ6cPkfAPGYI3bV9cKyQJADVm9I9pV?amount=1701.78083159' paid_amount: type: string example: '4615.1521939' paid_amount_minus_fee: type: string example: '4595.07118009' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: BCH received_amount: type: string example: '4595.07118009' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: BCH amount: type: string example: '20.08101381' fiat_amounts: type: array example: [] external_id: type: string example: '577' customer_external_id: type: string example: TjdJXiCrMPsd4jhW external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Zetta Green' description: type: string example: 'Bridget Bosco' redirect_url: type: string example: 'http://www.boyer.biz/at-saepe-ex-accusamus-ea-eum' failure_redirect_url: type: string example: 'http://rau.com/modi-ad-natus-sed-quo' created_at: type: string example: '2025-05-20T11:53:09.000000Z' expires_at: type: string example: '2025-05-20T12:19: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: 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: fa5c6dvg3k1E8PZeD46abhV 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: 0196ed8a-5a1f-7324-af11-32c2d0434878 short_id: L3EVY4hr2V9PHAbs4gs8J number: 53843446 price_currency: KZT price_amount: '175.02' pay_currency: SOL pay_amount: '1123.888859888' exchange_rate: '6.42161255' exchange_rate_expires_at: '2025-05-20T12:07:09.000000Z' address: ex4OJZJes8PVvgjIAnQ6MqW3V7fMkE address_tag: 8mPCs address_uri: 'solana:ex4OJZJes8PVvgjIAnQ6MqW3V7fMkE?amount=1123.888859888' paid_amount: '21234864.3' paid_amount_minus_fee: '21234801.811779' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: SOL received_amount: '21234801.811779' conversion_exchange_rate: null fees: processing_invoice: currency: SOL amount: '62.48822061' fiat_amounts: [] external_id: '237' customer_external_id: mjoOK7BidRMppDbt external_data: '{"foo":"bar"}' name: 'Abigail Jacobson' description: 'Precious Anderson DVM' redirect_url: 'http://www.little.com/amet-doloremque-facilis-eum-deserunt-temporibus-commodi-qui-cumque' failure_redirect_url: 'http://wolff.info/' created_at: '2025-05-20T11:53:09.000000Z' expires_at: '2025-05-20T12:23:09.000000Z' status: created status_context: underpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196ed8a-5a1f-7324-af11-32c2d0434878 short_id: type: string example: L3EVY4hr2V9PHAbs4gs8J number: type: integer example: 53843446 price_currency: type: string example: KZT price_amount: type: string example: '175.02' pay_currency: type: string example: SOL pay_amount: type: string example: '1123.888859888' exchange_rate: type: string example: '6.42161255' exchange_rate_expires_at: type: string example: '2025-05-20T12:07:09.000000Z' address: type: string example: ex4OJZJes8PVvgjIAnQ6MqW3V7fMkE address_tag: type: string example: 8mPCs address_uri: type: string example: 'solana:ex4OJZJes8PVvgjIAnQ6MqW3V7fMkE?amount=1123.888859888' paid_amount: type: string example: '21234864.3' paid_amount_minus_fee: type: string example: '21234801.811779' transaction_hash: type: string example: null transaction_risk_score: type: string example: null transactions: type: array example: [] received_currency: type: string example: SOL received_amount: type: string example: '21234801.811779' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_invoice: type: object properties: currency: type: string example: SOL amount: type: string example: '62.48822061' fiat_amounts: type: array example: [] external_id: type: string example: '237' customer_external_id: type: string example: mjoOK7BidRMppDbt external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Abigail Jacobson' description: type: string example: 'Precious Anderson DVM' redirect_url: type: string example: 'http://www.little.com/amet-doloremque-facilis-eum-deserunt-temporibus-commodi-qui-cumque' failure_redirect_url: type: string example: 'http://wolff.info/' created_at: type: string example: '2025-05-20T11:53:09.000000Z' expires_at: type: string example: '2025-05-20T12:23:09.000000Z' status: type: string example: created status_context: type: string example: underpaid status_reason: type: string example: null can_be_paid_partially: type: boolean example: 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: AURORA 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: 507863.288 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://corkery.biz/corporis-dolorem-libero-suscipit-qui' failure_redirect_url: type: string description: '' example: 'http://mertz.com/dolorum-dolores-eos-quod-magni-quam.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: 3VaE5k866ZDP4gbad1hcvef 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: 0196ed8a-5a4e-71dc-8e1d-b36254a66a19 short_id: XSpdcnDPtVC3f2rs4gs8J number: 16557364 price_currency: UAH price_amount: '1846860.96' pay_currency: USDCAURORA pay_amount: '9990887.244413' exchange_rate: '5.40965859' exchange_rate_expires_at: '2025-05-20T12:04:09.000000Z' address: J9dosOfyUkPjpRygehZJHEssHdajKu address_tag: 7Diki address_uri: 'aurora:J9dosOfyUkPjpRygehZJHEssHdajKu?amount=9990887.244413' paid_amount: '57016.31211' paid_amount_minus_fee: '-141802.344054' transaction_hash: null transaction_risk_score: null transactions: [] received_currency: USDCAURORA received_amount: '-141802.344054' conversion_exchange_rate: null fees: processing_invoice: currency: USDCAURORA amount: '198818.656164' fiat_amounts: [] external_id: '921' customer_external_id: QiRDTlaFSCoEDKat external_data: '{"foo":"bar"}' name: 'Aiyana Johnston DDS' description: 'Bell Herman' redirect_url: 'http://www.glover.com/' failure_redirect_url: 'http://www.ratke.com/' created_at: '2025-05-20T11:53:09.000000Z' expires_at: '2025-05-20T12:22:09.000000Z' status: pending_payment status_context: overpaid status_reason: null can_be_paid_partially: true error: null properties: data: type: object properties: id: type: string example: 0196ed8a-5a4e-71dc-8e1d-b36254a66a19 short_id: type: string example: XSpdcnDPtVC3f2rs4gs8J number: type: integer example: 16557364 price_currency: type: string example: UAH price_amount: type: string example: '1846860.96' pay_currency: type: string example: USDCAURORA pay_amount: type: string example: '9990887.244413' exchange_rate: type: string example: '5.40965859' exchange_rate_expires_at: type: string example: '2025-05-20T12:04:09.000000Z' address: type: string example: J9dosOfyUkPjpRygehZJHEssHdajKu address_tag: type: string example: 7Diki address_uri: type: string example: 'aurora:J9dosOfyUkPjpRygehZJHEssHdajKu?amount=9990887.244413' paid_amount: type: string example: '57016.31211' paid_amount_minus_fee: type: string example: '-141802.344054' 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: '-141802.344054' 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: '198818.656164' fiat_amounts: type: array example: [] external_id: type: string example: '921' customer_external_id: type: string example: QiRDTlaFSCoEDKat external_data: type: string example: '{"foo":"bar"}' name: type: string example: 'Aiyana Johnston DDS' description: type: string example: 'Bell Herman' redirect_url: type: string example: 'http://www.glover.com/' failure_redirect_url: type: string example: 'http://www.ratke.com/' created_at: type: string example: '2025-05-20T11:53:09.000000Z' expires_at: type: string example: '2025-05-20T12:22:09.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: 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: USDTENEAR 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: 1.7 currencies_for_pay: type: array description: '' example: - KZT 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://thompson.com/aut-vitae-ut-qui-quos-dolore-vitae-sint' failure_redirect_url: type: string description: '' example: 'http://moore.info/vel-hic-quam-delectus-ut-iusto-fugiat.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: fhebaEv1a643d5gcZ6PD8Vk 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: 0196ed8a-5ab9-7001-89dc-60fcc0d98ea9 amount_requested: 216.84383 amount_to_send: 216.84383 fee_amount: 5.82122 status: failed status_reason: high_risk_score currency: TRX source_currency: EUR source_amount: 575.02407 source_exchange_rate: 301.87779 error: null properties: data: type: object properties: id: type: string example: 0196ed8a-5ab9-7001-89dc-60fcc0d98ea9 amount_requested: type: number example: 216.84383 amount_to_send: type: number example: 216.84383 fee_amount: type: number example: 5.82122 status: type: string example: failed status_reason: type: string example: high_risk_score currency: type: string example: TRX source_currency: type: string example: EUR source_amount: type: number example: 575.02407 source_exchange_rate: type: number example: 301.87779 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: 4ecZV83D16ghakPfb6avd5E 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: 0196ed8a-5b10-7133-8c08-83cb1f0f6ebc currency: USDCERC20 amount_requested: 614.37211 amount_to_send: 605.14123 amount_to_charge: 614.37211 fee_amount: 9.23088 status: rejected status_reason: internal_error created_at: '2025-05-20T11:53:09.000000Z' fee_included: true source_currency: UAH source_amount: 831.84605 source_exchange_rate: 493.07824 error: null properties: data: type: object properties: id: type: string example: 0196ed8a-5b10-7133-8c08-83cb1f0f6ebc currency: type: string example: USDCERC20 amount_requested: type: number example: 614.37211 amount_to_send: type: number example: 605.14123 amount_to_charge: type: number example: 614.37211 fee_amount: type: number example: 9.23088 status: type: string example: rejected status_reason: type: string example: internal_error created_at: type: string example: '2025-05-20T11:53:09.000000Z' fee_included: type: boolean example: true source_currency: type: string example: UAH source_amount: type: number example: 831.84605 source_exchange_rate: type: number example: 493.07824 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: v6V3dDe8Zk51afhPac6Ebg4 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: 0196ed8a-5b56-7079-a680-f46d6409c729 currency: ETHBASE amount_requested: 134.71128 amount_to_send: 132.50045 amount_to_charge: 134.71128 fee_amount: 2.21083 status: failed status_reason: tx_rejection created_at: '2025-05-20T11:53:09.000000Z' fee_included: true source_currency: KZT source_amount: 130.06345 source_exchange_rate: 342.95322 error: null properties: data: type: object properties: id: type: string example: 0196ed8a-5b56-7079-a680-f46d6409c729 currency: type: string example: ETHBASE amount_requested: type: number example: 134.71128 amount_to_send: type: number example: 132.50045 amount_to_charge: type: number example: 134.71128 fee_amount: type: number example: 2.21083 status: type: string example: failed status_reason: type: string example: tx_rejection created_at: type: string example: '2025-05-20T11:53:09.000000Z' fee_included: type: boolean example: true source_currency: type: string example: KZT source_amount: type: number example: 130.06345 source_exchange_rate: type: number example: 342.95322 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: h5E4ac8eDvd31PbZgk6fV6a 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: 0196ed8a-5b82-70ad-9645-1fba2ed5df47 customer_external_id: D0rBABDZVEsSxsV0 external_id: Q23sTEeys6 external_data: '{"foo":"bar"}' currency: USDCERC20 address: 9Q6Hj8tR8YlC3rB3VmPaNifdClJJBk address_tag: HZeP8 address_uri: 'ethereum:9Q6Hj8tR8YlC3rB3VmPaNifdClJJBk' created_at: '2025-05-20T11:53:09.000000Z' error: null properties: data: type: object properties: id: type: string example: 0196ed8a-5b82-70ad-9645-1fba2ed5df47 customer_external_id: type: string example: D0rBABDZVEsSxsV0 external_id: type: string example: Q23sTEeys6 external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDCERC20 address: type: string example: 9Q6Hj8tR8YlC3rB3VmPaNifdClJJBk address_tag: type: string example: HZeP8 address_uri: type: string example: 'ethereum:9Q6Hj8tR8YlC3rB3VmPaNifdClJJBk' created_at: type: string example: '2025-05-20T11:53:09.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: a5hk86VbfvE1ZD3gP6c4dea 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: 0196ed8a-5ba1-71f6-ba3d-e43beadd3ab9 customer_external_id: Vdmf8Iy2XOJkSff1 external_id: qnPzxx9Qtc external_data: '{"foo":"bar"}' currency: USDCNEAR address: Mc5te86RCPrQdCDjbfiVPPgeCNAgGW address_tag: jblbE address_uri: 'near:Mc5te86RCPrQdCDjbfiVPPgeCNAgGW' created_at: '2025-05-20T11:53:09.000000Z' error: null properties: data: type: array example: - id: 0196ed8a-5ba1-71f6-ba3d-e43beadd3ab9 customer_external_id: Vdmf8Iy2XOJkSff1 external_id: qnPzxx9Qtc external_data: '{"foo":"bar"}' currency: USDCNEAR address: Mc5te86RCPrQdCDjbfiVPPgeCNAgGW address_tag: jblbE address_uri: 'near:Mc5te86RCPrQdCDjbfiVPPgeCNAgGW' created_at: '2025-05-20T11:53:09.000000Z' items: type: object properties: id: type: string example: 0196ed8a-5ba1-71f6-ba3d-e43beadd3ab9 customer_external_id: type: string example: Vdmf8Iy2XOJkSff1 external_id: type: string example: qnPzxx9Qtc external_data: type: string example: '{"foo":"bar"}' currency: type: string example: USDCNEAR address: type: string example: Mc5te86RCPrQdCDjbfiVPPgeCNAgGW address_tag: type: string example: jblbE address_uri: type: string example: 'near:Mc5te86RCPrQdCDjbfiVPPgeCNAgGW' created_at: type: string example: '2025-05-20T11:53:09.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: P8akDc34Vdv6afhge5E1Z6b 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: 0196ed8a-5bed-73de-b6b1-87e82e17ee7b channel_id: 0196ed8a-5bec-73ed-8a58-245a312ff160 customer_external_id: HKavCmdJIsnK1Biy external_id: cb9QWAsOph external_data: '{"foo":"bar"}' currency: TRX amount: '273.51307' amount_minus_fee: '273.29426' received_currency: TRX received_amount: '273.29426' conversion_exchange_rate: null fees: processing_channel: currency: TRX amount: '0.21881' fiat_amounts: [] address: tJVfRYR3xAEb6virCAa98PEJpX1ASi address_tag: 5W5Ya address_uri: 'tron:tJVfRYR3xAEb6virCAa98PEJpX1ASi' transaction_hash: null transaction_risk_score: null created_at: '2025-05-20T11:53:09.000000Z' status: on_hold status_reason: null metadata: total: 394514 per_page: 530380 next_cursor: rhGhGNc87dSGvRcJ previous_cursor: Bupw0zd7ubTkNY1n error: null properties: data: type: object properties: list: type: array example: - id: 0196ed8a-5bed-73de-b6b1-87e82e17ee7b channel_id: 0196ed8a-5bec-73ed-8a58-245a312ff160 customer_external_id: HKavCmdJIsnK1Biy external_id: cb9QWAsOph external_data: '{"foo":"bar"}' currency: TRX amount: '273.51307' amount_minus_fee: '273.29426' received_currency: TRX received_amount: '273.29426' conversion_exchange_rate: null fees: processing_channel: currency: TRX amount: '0.21881' fiat_amounts: [] address: tJVfRYR3xAEb6virCAa98PEJpX1ASi address_tag: 5W5Ya address_uri: 'tron:tJVfRYR3xAEb6virCAa98PEJpX1ASi' transaction_hash: null transaction_risk_score: null created_at: '2025-05-20T11:53:09.000000Z' status: on_hold status_reason: null items: type: object properties: id: type: string example: 0196ed8a-5bed-73de-b6b1-87e82e17ee7b channel_id: type: string example: 0196ed8a-5bec-73ed-8a58-245a312ff160 customer_external_id: type: string example: HKavCmdJIsnK1Biy external_id: type: string example: cb9QWAsOph external_data: type: string example: '{"foo":"bar"}' currency: type: string example: TRX amount: type: string example: '273.51307' amount_minus_fee: type: string example: '273.29426' received_currency: type: string example: TRX received_amount: type: string example: '273.29426' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: TRX amount: type: string example: '0.21881' fiat_amounts: type: array example: [] address: type: string example: tJVfRYR3xAEb6virCAa98PEJpX1ASi address_tag: type: string example: 5W5Ya address_uri: type: string example: 'tron:tJVfRYR3xAEb6virCAa98PEJpX1ASi' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-05-20T11:53:09.000000Z' status: type: string example: on_hold status_reason: type: string example: null metadata: type: object properties: total: type: integer example: 394514 per_page: type: integer example: 530380 next_cursor: type: string example: rhGhGNc87dSGvRcJ previous_cursor: type: string example: Bupw0zd7ubTkNY1n 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: RCL3SyvofFxeDk59 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: AdDfdfFF-eCeA-EFde-FACc-DBCbCaFDAdFd 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: cdE3a5vae64kD81VZPh6bfg 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: 0196ed8a-5c1a-72c3-b27d-29153566136f channel_id: 0196ed8a-5c19-7191-bad7-8e9b772827c0 customer_external_id: 65SQvzNQB0B12cYS external_id: wdsR9JudtR external_data: '{"foo":"bar"}' currency: LTC amount: '124.5945' amount_minus_fee: '124.5695811' received_currency: LTC received_amount: '124.5695811' conversion_exchange_rate: null fees: processing_channel: currency: LTC amount: '0.0249189' fiat_amounts: [] address: fOczFMFaFg4l2XERMthxdmNK4fRMbn address_tag: 71LmA address_uri: 'litecoin:fOczFMFaFg4l2XERMthxdmNK4fRMbn' transaction_hash: null transaction_risk_score: null created_at: '2025-05-20T11:53:09.000000Z' status: created status_reason: null error: null properties: data: type: object properties: id: type: string example: 0196ed8a-5c1a-72c3-b27d-29153566136f channel_id: type: string example: 0196ed8a-5c19-7191-bad7-8e9b772827c0 customer_external_id: type: string example: 65SQvzNQB0B12cYS external_id: type: string example: wdsR9JudtR external_data: type: string example: '{"foo":"bar"}' currency: type: string example: LTC amount: type: string example: '124.5945' amount_minus_fee: type: string example: '124.5695811' received_currency: type: string example: LTC received_amount: type: string example: '124.5695811' conversion_exchange_rate: type: string example: null fees: type: object properties: processing_channel: type: object properties: currency: type: string example: LTC amount: type: string example: '0.0249189' fiat_amounts: type: array example: [] address: type: string example: fOczFMFaFg4l2XERMthxdmNK4fRMbn address_tag: type: string example: 71LmA address_uri: type: string example: 'litecoin:fOczFMFaFg4l2XERMthxdmNK4fRMbn' transaction_hash: type: string example: null transaction_risk_score: type: string example: null created_at: type: string example: '2025-05-20T11:53:09.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: FDdeBcCe-Cfcc-bddF-AABE-BFCEECcCAaFd 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: 5kfVv6D1bha4gZaEe3cP6d8 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: USDCBASE exchange_rate: 3.90886484 decimals: 6 round_off: 6 error: null properties: data: type: object properties: base_currency: type: string example: UAH quote_currency: type: string example: USDCBASE exchange_rate: type: number example: 3.90886484 decimals: type: integer example: 6 round_off: type: integer example: 6 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: 35hkga1fc8bZVPDa6e4vE6d 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: 366665 remaining_amount: 3662.65302 error: null properties: data: type: object properties: limit: type: integer example: 366665 remaining_amount: type: number example: 3662.65302 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: suscipit 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: aDVP14cfZg5E3bhked66a8v 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: aliquam documents: type: array description: '' example: - odit 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: []