From ee95929cefaef6e93979f4eeb5b338d13bb00649 Mon Sep 17 00:00:00 2001
From: dima <dima.chebakov@ukrainiansoftware.com>
Date: Tue, 16 Mar 2021 14:47:22 +0200
Subject: [PATCH] frn-2170 add explanatory test

---
 index.html | 28 +++++++++++++++++++++++-----
 1 file changed, 23 insertions(+), 5 deletions(-)

diff --git a/index.html b/index.html
index 548dfb9..a9c4e1d 100644
--- a/index.html
+++ b/index.html
@@ -186,6 +186,13 @@
       }])
     }));
 //# sourceMappingURL=redoc.standalone.js.map</script>
+
+    <script async>
+        const __redoc_state = { "menu": { "activeItemIdx": -1 }, "spec": { "data": { "openapi": "3.0.1", "info": { "title": "CoinPayments API", "description": "CoinPayments Backend API.\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->", "version": "v1", "x-logo": { "url": "https://api.coinpayments.net/cps_logo.svg", "backgroundColor": "#FFFFFF", "altText": "CoinPayments logo" } }, "paths": { "/api/v1/accounts/balances": { "get": { "tags": ["Accounts"], "summary": "lists the financial account balances grouped by the currency", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountBalancesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountBalancesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountBalancesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts": { "get": { "tags": ["Accounts"], "summary": "lists all the user's financial accounts", "description": "Returns a page of the financial accounts that the authorized consumer has access to.  Accounts can represent crypto and token wallets (including multi-signature and shared wallets) or fiat currency accounts.", "parameters": [{ "name": "currencyId", "in": "query", "description": "optional id of the currency to filter the accounts by", "schema": { "type": "integer", "format": "int32" } }, { "name": "withBalance", "in": "query", "description": "optional to query accounts either with a balance or for those that are empty", "schema": { "type": "boolean" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedAccountsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedAccountsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedAccountsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/addresses": { "get": { "tags": ["Accounts"], "summary": "lists all the user accounts deposit addresses, ordering by newest first", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account for which to get addresses for", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedAccountAddressesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedAccountAddressesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedAccountAddressesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["Accounts"], "summary": "sends a request to create a new address for an account", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to retrieve", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/addresses/{addressId}": { "get": { "tags": ["Accounts"], "summary": "finds an address by its id or network address", "operationId": "GetAccountAddress", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account the address belongs", "required": true, "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "description": "the id of the address to retrieve", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountAddressDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/label": { "put": { "tags": ["Accounts"], "summary": "sends a request to change the account label", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to retrieve", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeWalletLabelRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeWalletLabelRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeWalletLabelRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeWalletLabelRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/addresses/{addressId}/label": { "put": { "tags": ["Accounts"], "summary": "sends a request to change the address label", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeAddressLabelRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeAddressLabelRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeAddressLabelRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeAddressLabelRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}": { "get": { "tags": ["Accounts"], "summary": "finds an account by its id", "operationId": "GetAccount", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to retrieve", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["Accounts"], "summary": "sends a request to delete a singlesig financial account", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/keys": { "put": { "tags": ["Accounts"], "summary": "sends a request to add or update an accounts client keys. Update happens when user changes their account password.", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to update the client key for", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountAddClientKeysOrChangePasswordDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountAddClientKeysOrChangePasswordDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountAddClientKeysOrChangePasswordDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountAddClientKeysOrChangePasswordDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/fee/{masterKeyId}/{currencyId}": { "get": { "tags": ["Accounts"], "parameters": [{ "name": "masterKeyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currencyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend/validate": { "post": { "tags": ["Accounts"], "summary": "validates a request to spend funds from the account", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the details of the spend request, including the recipients the amount to send to each", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend/all/validate": { "post": { "tags": ["Accounts"], "summary": "validates a request to spend all funds from the account", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the details of the spend request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend": { "post": { "tags": ["Accounts"], "summary": "sends a request to spend funds from the account", "description": "if approval is required then the request will first be sent to account administrators for approval before it's actually sent out", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account from which to spend funds from", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the details of the spend request, including the recipients the amount to send to each", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend/all": { "post": { "tags": ["Accounts"], "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/convert": { "post": { "tags": ["Accounts"], "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountConvertRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountConvertRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountConvertRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountConvertRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend/{spendRequestId}/broadcast": { "post": { "tags": ["Accounts"], "summary": "submits a client signed spend request to broadcast", "description": "the server will validate the signed requests, co-sign it using the server key and then broadcast to the network", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account from which the spend request was created", "required": true, "schema": { "type": "string" } }, { "name": "spendRequestId", "in": "path", "description": "the id of the spend request", "required": true, "schema": { "type": "string", "format": "uuid" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestBroadcastDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestBroadcastDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestBroadcastDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestBroadcastDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/multisig": { "post": { "tags": ["Accounts"], "summary": "sends a request to create a new multisig financial account", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMultiSigAccountRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMultiSigAccountRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMultiSigAccountRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMultiSigAccountRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/singlesig": { "post": { "tags": ["Accounts"], "summary": "sends a request to create a new singlesig financial account", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateSingleSigAccountRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSingleSigAccountRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSingleSigAccountRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSingleSigAccountRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/channels": { "get": { "tags": ["Affiliate"], "summary": "List the channels the affiliate has created", "parameters": [{ "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedAffiliateChannelsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedAffiliateChannelsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedAffiliateChannelsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["Affiliate"], "summary": "Create a new channel", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewAffiliateChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewAffiliateChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewAffiliateChannelDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewAffiliateChannelDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/channels/{id}": { "get": { "tags": ["Affiliate"], "summary": "Finds a channel by its id", "operationId": "FindChannel", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateChannelDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Affiliate"], "summary": "Updates the details of a channel", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateChannelDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateChannelDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateChannelDetailsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateChannelDetailsDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate": { "get": { "tags": ["Affiliate"], "summary": "Gets the affiliate information", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateInfoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateInfoDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateInfoDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/fees": { "get": { "tags": ["Affiliate"], "summary": "Gets the commission fee structure that the affiliate can earn on the CoinPayments platform", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateCommissionFeesInfoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateCommissionFeesInfoDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateCommissionFeesInfoDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/earnings": { "get": { "tags": ["Affiliate"], "summary": "List the earnings of the affiliate, optionally filtered by a channel and time range", "parameters": [{ "name": "channelId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/earnings/summary": { "get": { "tags": ["Affiliate"], "summary": "Get a summary of earnings", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsSummaryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsSummaryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsSummaryDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/impressions/daily": { "get": { "tags": ["Affiliate"], "summary": "List the impressions and conversions by day for the affiliate, optionally filtered by a channel and time period", "parameters": [{ "name": "channelId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/impressions/country": { "get": { "tags": ["Affiliate"], "summary": "List the impressions and conversions by country for the affiliate, optionally filtered by a channel and time period", "parameters": [{ "name": "channelId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/impressions": { "get": { "tags": ["Affiliate"], "summary": "List the total impressions, optionally filtered by a channel and time period", "parameters": [{ "name": "channelId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsSummaryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsSummaryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsSummaryDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/currencies": { "get": { "tags": ["Currencies"], "summary": "lists platform supported currencies and their capabilities.", "description": "Returns a page of the supported currencies on the CoinPayments.net platform, by default ordered by their rank on CoinPayments.net.", "parameters": [{ "name": "q", "in": "query", "description": "optional search query to find currencies with names and/or codes similar to the specified search string", "schema": { "type": "string" } }, { "name": "types", "in": "query", "description": "comma separated list of the types of currencies to return (e.g. 'coin', 'token', 'fiat', etc.).  By default currencies of all types are returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyType" } } }, { "name": "capabilities", "in": "query", "description": "comma separated list of capabilities, currencies without the specified capabilities won't be returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCapability" } } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedCurrenciesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedCurrenciesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedCurrenciesDto" } } } } } } }, "/api/v1/currencies/{id}": { "get": { "tags": ["Currencies"], "summary": "finds a currency by its id", "parameters": [{ "name": "id", "in": "path", "description": "the id of the currency to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } } } } } } }, "/api/v1/currencies/conversions": { "get": { "tags": ["Currencies"], "summary": "gets a list of all possible currency conversions", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyConversion" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyConversion" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyConversion" } } } } } } } }, "/api/v1/invoices": { "post": { "tags": ["Invoices"], "summary": "Creates a new invoice", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/invoices/{id}": { "put": { "tags": ["Invoices"], "summary": "Updates the buyer information on an invoice, if it was requested by the merchant", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceBuyerInfoRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceBuyerInfoRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceBuyerInfoRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceBuyerInfoRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": ["Invoices"], "summary": "Finds an invoice by its id", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/masterkeys/{id}": { "get": { "tags": ["MasterKeys"], "summary": "find a master key by its id", "operationId": "GetMasterKey", "parameters": [{ "name": "id", "in": "path", "description": "the id of the masterkey to retrieve", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MasterKeyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MasterKeyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MasterKeyDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["MasterKeys"], "summary": "updates a master key label and encrypted client private key", "parameters": [{ "name": "id", "in": "path", "description": "the id of the masterkey to update", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMasterKeyRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMasterKeyRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMasterKeyRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMasterKeyRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/masterkeys": { "get": { "tags": ["MasterKeys"], "summary": "lists all the activated master keys the user has created", "description": "the master keys can be used to create crypto wallets", "parameters": [{ "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedMasterKeysDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedMasterKeysDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedMasterKeysDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["MasterKeys"], "summary": "sends a request to create a new MasterKey", "description": "the new master key must be activated before wallets can be created", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/masterkeys/{id}/activate": { "post": { "tags": ["MasterKeys"], "summary": "Activates a master key", "parameters": [{ "name": "id", "in": "path", "description": "the id of the masterkey to activate", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ActivateMasterKeyRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivateMasterKeyRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivateMasterKeyRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivateMasterKeyRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant": { "post": { "tags": ["Merchant"], "summary": "Creates a merchant profile for a user or organization", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantProfileDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantProfileDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/profile": { "get": { "tags": ["Merchant"], "summary": "Get the profile of the current merchant", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantProfileDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Merchant"], "summary": "Updates the profile of the current merchant", "requestBody": { "description": "The fields to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantProfileDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantProfileDto" } } } }, "responses": { "204": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/merchant/currencies": { "get": { "tags": ["Merchant"], "summary": "Gets the merchant's currently accepted currencies.\r\nCurrencies that are ranked (ordered) will be returned at the top of the list.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptedCurrenciesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptedCurrenciesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptedCurrenciesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/currencies/{id}": { "post": { "tags": ["Merchant"], "summary": "Adds a currency that a merchant wishes to receive as payments from Buyers", "parameters": [{ "name": "id", "in": "path", "description": "The currency to add", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "The payout configs for the currency", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddAcceptedCurrencyConfigDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddAcceptedCurrencyConfigDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddAcceptedCurrencyConfigDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddAcceptedCurrencyConfigDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Merchant"], "summary": "Updates a currency that a merchant wishes to receive as payments from Buyers", "parameters": [{ "name": "id", "in": "path", "description": "The currency to add", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAcceptedCurrencyConfigDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAcceptedCurrencyConfigDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAcceptedCurrencyConfigDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAcceptedCurrencyConfigDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["Merchant"], "summary": "Deletes a currency that a merchant no longer wishes to accept", "parameters": [{ "name": "id", "in": "path", "description": "The id of the currency to delete", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/currencies/{id}/order": { "put": { "tags": ["Merchant"], "summary": "Update the order (ranking) of an accepted coin. Will update the rest of the payment currencies so that they can be returned in the correct order.\r\nTo unassign the rank for a currency, pass in 0 for the order.", "description": "Example:\r\nA merchant has coins in this rank:\r\n1. Bitcoin\r\n2. Litecoin\r\n3. Ethereum\r\n            \r\nScenario 1: Merchant would like to update Ethereum to rank 1. The new ranks will be:\r\n1. Ethereum\r\n2. Bitcoin\r\n3. Litecoin\r\n            \r\nScenario 2: Merchant would like to unassign the rank for Bitcoin. The new ranks will be:\r\n1. Litecoin\r\n2. Ethereum\r\n0. Bitcoin", "parameters": [{ "name": "id", "in": "path", "description": "The id of the currency", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the order for the currency", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeAcceptedCurrencyOrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeAcceptedCurrencyOrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeAcceptedCurrencyOrderDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeAcceptedCurrencyOrderDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/logo": { "post": { "tags": ["Merchant"], "summary": "Uploads a merchant logo", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantLogoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantLogoDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantLogoDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["Merchant"], "summary": "Delete a merchant logo", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/callbacks": { "post": { "tags": ["MerchantCallbacks"], "summary": "Creates a new callback address", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewCallbackAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewCallbackAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewCallbackAddressDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewCallbackAddressDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": ["MerchantCallbacks"], "summary": "list all callback addresses sorted descending by the creation date", "parameters": [{ "name": "clientId", "in": "query", "schema": { "type": "string" } }, { "name": "currencyId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedCallbackAddressesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedCallbackAddressesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedCallbackAddressesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/callbacks/{id}": { "get": { "tags": ["MerchantCallbacks"], "summary": "find a callback address by id", "operationId": "FindCallbackAddress", "parameters": [{ "name": "id", "in": "path", "description": "the id of the callback address", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["MerchantCallbacks"], "summary": "updates a callback address", "parameters": [{ "name": "id", "in": "path", "description": "the id of the callback address", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the callback address data to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCallbackAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCallbackAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCallbackAddressDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCallbackAddressDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/callbacks/deposits": { "get": { "tags": ["MerchantCallbacks"], "summary": "list all deposit transactions to callback addresses, ordered newest first and optionally filtering by address,\r\ncurrency and date range", "parameters": [{ "name": "callbackId", "in": "query", "schema": { "type": "string" } }, { "name": "currencyId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedCallbackDepositTransactionsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedCallbackDepositTransactionsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedCallbackDepositTransactionsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients": { "get": { "tags": ["MerchantClients"], "summary": "Get all clients belonging to the merchant", "parameters": [{ "name": "search", "in": "query", "description": "The string to search for in the client name", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "The state of the client (active or disabled)", "schema": { "$ref": "#/components/schemas/MerchantClientPublicState" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantClientsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantClientsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantClientsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["MerchantClients"], "summary": "Create a new client belonging to the merchant", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients/{clientId}": { "get": { "tags": ["MerchantClients"], "summary": "Find a client by its clientId", "operationId": "FindClientAsync", "parameters": [{ "name": "clientId", "in": "path", "description": "the id of the client", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantClientDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantClientDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantClientDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["MerchantClients"], "summary": "Update an existing client belonging to the merchant", "parameters": [{ "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["MerchantClients"], "summary": "Delete an existing client", "parameters": [{ "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients/{clientId}/secret": { "post": { "tags": ["MerchantClients"], "summary": "Regenerates the clients secret, the old secret will no longer be valid for communicating with the API", "parameters": [{ "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegenerateSecretResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateSecretResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegenerateSecretResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients/{clientId}/webhooks": { "get": { "tags": ["MerchantClients"], "summary": "List all of the webhooks for a particular client", "operationId": "ListWebhooksForClientAsync", "parameters": [{ "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/MerchantClientWebhookNotification" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantClientWebhookEndpointsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantClientWebhookEndpointsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantClientWebhookEndpointsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["MerchantClients"], "summary": "Create a new webhook for a client", "parameters": [{ "name": "clientId", "in": "path", "description": "The public ID of a client", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientWebhookRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientWebhookRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientWebhookRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientWebhookRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients/{clientId}/webhooks/{webhookId}": { "put": { "tags": ["MerchantClients"], "summary": "Update an existing webhook for a client", "parameters": [{ "name": "clientId", "in": "path", "description": "The public ID of a client", "required": true, "schema": { "type": "string" } }, { "name": "webhookId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientWebhookDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientWebhookDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientWebhookDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientWebhookDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["MerchantClients"], "summary": "Delete a webhook for a client", "parameters": [{ "name": "clientId", "in": "path", "description": "the public ID of a client", "required": true, "schema": { "type": "string" } }, { "name": "webhookId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/buy-now-button": { "post": { "tags": ["MerchantInvoices"], "summary": "Creates payment button code for the specified invoice", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceBuyNowButtonHtmlRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceBuyNowButtonHtmlRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceBuyNowButtonHtmlRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceBuyNowButtonHtmlRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/nextid": { "post": { "tags": ["MerchantInvoices"], "summary": "Generates the next invoice number", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceNextIdDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceNextIdDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceNextIdDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceNextIdDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices": { "get": { "tags": ["MerchantInvoices"], "summary": "Get a list of the current merchant's invoices.", "parameters": [{ "name": "clientId", "in": "query", "description": "optional query to filter the invoices by pending, completed, or expired status", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "optional query to fetch invoices that were created with the specific client", "schema": { "$ref": "#/components/schemas/InvoiceStatus" } }, { "name": "from", "in": "query", "description": "optional query to fetch from and including the time specified up to the current time", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "optional query to fetch all invoices up to and including the specified time", "schema": { "type": "string", "format": "date-time" } }, { "name": "q", "in": "query", "description": "optional search string to find invoices with these words", "schema": { "type": "string" } }, { "name": "integration", "in": "query", "description": "optional integration by which the invoice was created", "schema": { "type": "string" } }, { "name": "payoutWalletId", "in": "query", "description": "optional query to filter the invoices by the wallet they were paid out to (for 'paid' and 'completed' invoices)", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceSummariesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceSummariesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceSummariesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["MerchantInvoices"], "summary": "Creates a new invoice", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}": { "get": { "tags": ["MerchantInvoices"], "summary": "Find invoice belonging to merchant by the invoice ID", "operationId": "FindInvoiceAsync", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["MerchantInvoices"], "summary": "Updates an existing invoice in draft state", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantInvoiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantInvoiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantInvoiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantInvoiceRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}/history": { "get": { "tags": ["MerchantInvoices"], "summary": "Lists the history events of an invoice by the invoice ID", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}/cancel": { "post": { "tags": ["MerchantInvoices"], "summary": "Cancels an invoice", "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}/delete": { "delete": { "tags": ["MerchantInvoices"], "summary": "Deletes a draft or scheduled invoice", "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}/payouts": { "get": { "tags": ["MerchantInvoices"], "summary": "Get payout details for an invoice, including if invoice has been fully paid out, the exact amount they will receive\r\nand in what currency, which address payout will be deposited, and who (Buyer) performed the payment.", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoicePayoutsDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePayoutsDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoicePayoutsDetailsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/preferences": { "get": { "tags": ["Preferences"], "summary": "gets the user preferences", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserPreferencesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Preferences"], "summary": "sends a request to update user preferences", "requestBody": { "description": "the preferences to update, each of the body fields is optional and if not specified, or specified as `null`, then the current value will be retained", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeUserPreferencesRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeUserPreferencesRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeUserPreferencesRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeUserPreferencesRequestDto" } } } }, "responses": { "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/rates": { "get": { "tags": ["Rates"], "summary": "lists the current conversion rates between currencies", "description": "Returns the currency conversion rates for the specified `from` currencies converted to the specified `to` currencies", "parameters": [{ "name": "from", "in": "query", "description": "comma separated list of currency ids to use as the source for rate calculations", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "comma separated list of currency ids for which to retrieve conversion rates for (from the `from` currencies)", "schema": { "type": "string" } }, { "name": "fromToken", "in": "query", "description": "optional, contract address of the token on the from currency", "schema": { "type": "string" } }, { "name": "toToken", "in": "query", "description": "optional, contract address of the token on the quote currency", "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RatesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RatesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RatesDto" } } } } } } }, "/api/v1/reports": { "post": { "tags": ["Reports"], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/settings": { "post": { "tags": ["Settings"], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Settings"], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/settings/{key}": { "get": { "tags": ["Settings"], "parameters": [{ "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/shared-invoices/{sharedInvoiceId}": { "get": { "tags": ["SharedInvoices"], "summary": "Finds an invoice shared by a merchant", "parameters": [{ "name": "sharedInvoiceId", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/smartcontracts/{currencyId}": { "get": { "tags": ["SmartContracts"], "summary": "Lists the smart contracts (like ERC20) known to the system", "parameters": [{ "name": "currencyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartContract" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartContract" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartContract" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/smartcontracts/{currencyId}/{contractsAddress}": { "get": { "tags": ["SmartContracts"], "summary": "Lists the smart contracts (like ERC20) known to the system", "parameters": [{ "name": "currencyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "contractsAddress", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmartContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmartContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmartContract" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/topups/orders": { "get": { "tags": ["TopUps"], "summary": "Gets user's top up orders (history)", "parameters": [{ "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TopUpOrdersDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TopUpOrdersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TopUpOrdersDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/topups/providers": { "get": { "tags": ["TopUps"], "summary": "Gets list of providers available to the user in which to place top up order", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TopUpProvidersDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TopUpProvidersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TopUpProvidersDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions": { "get": { "tags": ["Transactions"], "summary": "lists all the transactions", "description": "lists all transactions, sorted by the created date with the most recent first", "parameters": [{ "name": "accountId", "in": "query", "description": "optional, id of the account for which to list transactions for", "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "description": "optional, ISO 8601 formatted UTC date from which to list transactions starting from (e.g. '2019-01-17')", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "optional, ISO 8601 formatted UTC date until which to list transactions (e.g. '2019-01-27')", "schema": { "type": "string", "format": "date-time" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionDtoPagedItemsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDtoPagedItemsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionDtoPagedItemsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions/{id}": { "get": { "tags": ["Transactions"], "summary": "find a transaction by id", "parameters": [{ "name": "id", "in": "path", "description": "the id of the transaction to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions/{id}/events": { "get": { "tags": ["Transactions"], "summary": "list all the events of a transaction", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionHistoryEventsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHistoryEventsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionHistoryEventsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions/{id}/memo": { "put": { "tags": ["Transactions"], "summary": "sends a request to change the transaction memo", "parameters": [{ "name": "id", "in": "path", "description": "the id of the transaction to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeTransactionMemoRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeTransactionMemoRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeTransactionMemoRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeTransactionMemoRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions/volume": { "get": { "tags": ["Transactions"], "summary": "Get currently logged in user's transacted volume (total value of incoming and outgoing transactions)\r\nand the volume limit set in the system, with option to pass in user's preferred currency", "parameters": [{ "name": "currencyId", "in": "query", "description": "The currency the transacted volume and limit should be returned in", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactedVolumeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactedVolumeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactedVolumeDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/user/features": { "get": { "tags": ["User"], "summary": "Indicates which features, that are only available to certain users, are available for this particular user", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserFeaturesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserFeaturesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserFeaturesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/notifications": { "get": { "tags": ["UserNotifications"], "summary": "Get list of active notifications", "parameters": [{ "name": "languageCode", "in": "query", "description": "", "schema": { "pattern": "^([a-z]|[A-Z]){2}$", "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserNotificationsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserNotificationsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/notifications/{id}/read": { "post": { "tags": ["UserNotifications"], "summary": "Mark a notification as read", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } } }, "components": { "schemas": { "MoneyDto": { "type": "object", "properties": { "displayValue": { "type": "string", "description": "the value formatted for display", "nullable": true }, "value": { "type": "string", "description": "the amount of money, as an integer, in the currencies base (smallest) monetary unit.  For example,\r\nBitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC\r\nwould have a value of 100000000 and 0.00031 BTC a value of 31000.  An amount of $9.99 USD would\r\nhave the value 999 (i.e, 999 cents).  Zero-decimal currencies such as the Yen would represent\r\na value of ¥500 as 500.", "nullable": true, "example": "31000" }, "amount": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "currencyId": { "type": "integer", "description": "the currency the monetary `value` is represented in", "format": "int32", "example": 1235 } }, "additionalProperties": false, "description": "Monetary value (an amount with a currency)." }, "AccountBalancesForCurrencyDto": { "type": "object", "properties": { "currencyId": { "type": "integer", "description": "the id of the currency for the current balances", "format": "int32" }, "totalBalance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total unconfirmed balance", "nullable": true }, "totalAvailable": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total balance available for transactions", "nullable": true }, "totalNativeBalance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total unconfirmed balance, in the users native currency", "nullable": true }, "totalNativeAvailable": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total balance available for transactions, in the users native currency", "nullable": true } }, "additionalProperties": false, "description": "Represents the total account balances for a single currency" }, "AccountBalancesDto": { "type": "object", "properties": { "balancesByCurrency": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalancesForCurrencyDto" }, "description": "the balances for accounts grouped by the currency", "nullable": true }, "totalNativeBalance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total unconfirmed balance in all accounts, in the users native currency", "nullable": true }, "totalNativeAvailable": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total balance available for transactions in all accounts, in the users native currency", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the total account balances" }, "AccountType": { "enum": ["multiSigCryptoWallet", "singleSigCryptoWallet"], "type": "string" }, "CurrencyType": { "enum": ["crypto", "token", "fiat"], "type": "string", "description": "Type of currency" }, "CurrencyLogoDto": { "type": "object", "properties": { "imageUrl": { "type": "string", "description": "Link to a CoinPayments hosted image for a currency, 64x64 is the default size returned.\r\nReplace \"64x64\" in the image url with these alternative sizes: 32, 64, 128, 200.", "nullable": true }, "vectorUrl": { "type": "string", "description": "If available then the link to a CoinPayments hosted vector image (SVG) for the currency.", "nullable": true } }, "additionalProperties": false, "description": "Contains the logo URLs for a currency" }, "CurrencyStatus": { "enum": ["active", "underMaintenance"], "type": "string", "description": "The status of the currency on the CoinPayments platform" }, "CurrencyCapability": { "enum": ["multiSigAccounts", "sharedAccounts", "payments", "singleSigAccounts"], "type": "string" }, "CurrencyUrlsDto": { "type": "object", "properties": { "websites": { "type": "array", "items": { "type": "string" }, "description": "the websites for the currency", "nullable": true }, "explorers": { "type": "array", "items": { "type": "string" }, "description": "the explorers for the currency (if crypto or a token)", "nullable": true } }, "additionalProperties": false, "description": "Contains various URLs for a currency" }, "CurrencyDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "the unique id of the currency on the CoinPayments platform", "format": "int32", "example": 1235 }, "type": { "allOf": [{ "$ref": "#/components/schemas/CurrencyType" }], "description": "the type of the currency" }, "symbol": { "type": "string", "description": "ticker symbol for the currency.  For fiat currencies this is the three character (ISO-4217) currency code,\r\nand for crypto currencies their multi-character symbol.", "nullable": true, "example": "BTC" }, "name": { "type": "string", "description": "the name of the currency, e.g. 'United States Dollar' or 'Bitcoin'", "nullable": true, "example": "Bitcoin" }, "logo": { "allOf": [{ "$ref": "#/components/schemas/CurrencyLogoDto" }], "description": "the logo urls for the currency", "nullable": true }, "decimalPlaces": { "type": "integer", "description": "the number of digits after the decimal separator, e.g. 2 for USD, 8 for BTC, 0 for JPY", "format": "int32" }, "rank": { "type": "integer", "description": "the relative ordering/ranking of this currency to the other supported currencies on the\r\nCoinPayments platform", "format": "int32" }, "status": { "allOf": [{ "$ref": "#/components/schemas/CurrencyStatus" }], "description": "The status of the currency on the CoinPayments platform" }, "capabilities": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCapability" }, "description": "the capabilities of the currency on the CoinPayments platform", "nullable": true }, "urls": { "allOf": [{ "$ref": "#/components/schemas/CurrencyUrlsDto" }], "description": "object containing various urls for the currency", "nullable": true } }, "additionalProperties": false, "description": "Represents money, in any form (e.g. crypto/fiat currencies and tokens), supported on the CoinPayments\r\nplatform in some capacity (e.g. holding in a wallet and/or payment processing)." }, "AccountMultiSigKeysDto": { "type": "object", "properties": { "serverPublicKey": { "type": "string", "description": "the servers public key, the private key is held by CoinPayments", "nullable": true }, "backupPublicKey": { "type": "string", "description": "the backup public key, the private key is held by the Key Recovery Service (KRS)", "nullable": true }, "clientPublicKey": { "type": "string", "description": "the clients public key", "nullable": true }, "clientEncryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key", "nullable": true } }, "additionalProperties": false, "description": "Keys for multi signature accounts" }, "TokenDto": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Blockchain address of the contract respresenting the token", "nullable": true }, "nativeValue": { "type": "string", "description": "Token amount equivalent in native currency", "nullable": true }, "nativeCurrencyId": { "type": "integer", "format": "int32" }, "displayValue": { "type": "string", "description": "the value formatted for display", "nullable": true }, "value": { "type": "string", "description": "the amount of money, as an integer, in the currencies base (smallest) monetary unit.  For example,\r\nBitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC\r\nwould have a value of 100000000 and 0.00031 BTC a value of 31000.  An amount of $9.99 USD would\r\nhave the value 999 (i.e, 999 cents).  Zero-decimal currencies such as the Yen would represent\r\na value of ¥500 as 500.", "nullable": true, "example": "31000" }, "amount": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "currencyId": { "type": "integer", "description": "the currency the monetary `value` is represented in", "format": "int32", "example": 1235 } }, "additionalProperties": false, "description": "Monetary value (an amount with a currency and contract address)." }, "AccountDto": { "type": "object", "properties": { "accountId": { "type": "string", "description": "the unique id of the account", "nullable": true, "example": "283b271a2db744c0b10c" }, "accountType": { "allOf": [{ "$ref": "#/components/schemas/AccountType" }], "description": "the type of the account" }, "currencyId": { "type": "integer", "description": "the id of the currency this account holds", "format": "int32", "example": 1235 }, "isActive": { "type": "boolean", "description": "Indicates whether this wallet is active (not deleted or deactivated)" }, "currency": { "allOf": [{ "$ref": "#/components/schemas/CurrencyDto" }], "description": "the currency this account holds", "nullable": true }, "label": { "type": "string", "description": "the user or system defined name of the account", "nullable": true, "example": "My BitCoin Wallet 😀" }, "keys": { "allOf": [{ "$ref": "#/components/schemas/AccountMultiSigKeysDto" }], "description": "the keys for the multi signature account (for accountType=`MultiSigCryptoWallet`)", "nullable": true }, "depositAddress": { "type": "string", "description": "the current (last) deposit address for the account (for crypto currency accounts)", "nullable": true }, "balance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total (unconfirmed) balance in the account", "nullable": true }, "available": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the amount of funds available for transactions, this is the `balance` amount reduced by limits\r\nimposed by the user or the system on this account", "nullable": true }, "nativeBalance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total (unconfirmed) balance in the account, in the users native currency", "nullable": true }, "nativeAvailable": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the amount of funds available for transactions, in the users native currency, this is the `balance`\r\namount reduced by limits imposed by the user or the system on this account", "nullable": true }, "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/TokenDto" }, "description": "the amount of tokens (like ERC20) available for this account", "nullable": true } }, "additionalProperties": false, "description": "Represents a financial account on the CoinPayments® platform." }, "PagingCursorsDto": { "type": "object", "properties": { "before": { "type": "string", "nullable": true }, "after": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PagingDto": { "type": "object", "properties": { "cursors": { "allOf": [{ "$ref": "#/components/schemas/PagingCursorsDto" }], "nullable": true }, "limit": { "type": "integer", "format": "int32" }, "first": { "type": "string", "format": "uri", "nullable": true }, "next": { "type": "string", "format": "uri", "nullable": true }, "previous": { "type": "string", "format": "uri", "nullable": true }, "last": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "PagedAccountsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "AccountAddressDto": { "type": "object", "properties": { "addressId": { "type": "string", "description": "the unique id of the address", "nullable": true }, "label": { "type": "string", "description": "user supplied or system generated label for this address", "nullable": true }, "address": { "type": "string", "description": "the network address", "nullable": true } }, "additionalProperties": false, "description": "Represents a deposit address of a financial account on the CoinPayments® platform." }, "PagedAccountAddressesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountAddressDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "CreateAccountAddressRequestDto": { "type": "object", "properties": { "label": { "type": "string", "description": "the optional label for the new address", "nullable": true } }, "additionalProperties": false, "description": "Request to create a new address for an existing account" }, "CreateAccountAddressResponseDto": { "type": "object", "properties": { "addressId": { "type": "string", "description": "the id of the address that will be created.\r\nNote that this is NOT the network address, one will be assigned when creation is completed", "nullable": true } }, "additionalProperties": false, "description": "Response to an address creation request" }, "ChangeWalletLabelRequestDto": { "type": "object", "properties": { "label": { "type": "string", "description": "The new label for the account", "nullable": true } }, "additionalProperties": false, "description": "Request to change the label of an account" }, "ChangeAddressLabelRequestDto": { "type": "object", "properties": { "label": { "type": "string", "description": "The new label for the address", "nullable": true } }, "additionalProperties": false, "description": "Request to change the label of an address" }, "AccountAddClientKeysOrChangePasswordDto": { "required": ["clientEncryptedPrivateKey"], "type": "object", "properties": { "clientPublicKey": { "type": "string", "description": "the clients public key", "nullable": true }, "clientEncryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key" } }, "additionalProperties": false, "description": "Request to add the client keys to the account" }, "AccountSpendRequestRecipientDto": { "required": ["address", "amount"], "type": "object", "properties": { "address": { "type": "string", "description": "the address of the recipients account/wallet" }, "amount": { "type": "string", "description": "the amount of money (in the currencies smallest unit, e.g. Satoshis for BTC) to send to the recipient address" }, "blockChainFee": { "type": "string", "description": "the amount of money (in the currencies smallest unit, e.g. Satoshis for BTC) to pay as a blockchain network fee", "nullable": true } }, "additionalProperties": false, "description": "Recipient of a transaction" }, "AccountSpendRequestDto": { "required": ["recipients"], "type": "object", "properties": { "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/AccountSpendRequestRecipientDto" }, "description": "the list of recipients to send funds to" }, "memo": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Custom memo to attach to this transaction, this will only be visible within CoinPayments®", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "description": "Optional additional information for the spend request e.g. \"UseHopAddress\" for Ethereum", "nullable": true } }, "additionalProperties": false, "description": "Request to create a transaction and spend funds from an account" }, "SpendRequestValidateResponseErrorDto": { "type": "object", "properties": { "code": { "type": "string", "description": "the code for the error", "nullable": true }, "description": { "type": "string", "description": "the description for the error", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates an error from the wallet spend request validator" }, "SpendRequestValidateResponseDto": { "type": "object", "properties": { "isValid": { "type": "boolean", "description": "value indicating whether the provided request is valid" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/SpendRequestValidateResponseErrorDto" }, "description": "the list of errors, if any", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the response to a wallet spend validation request" }, "AccountSpendRequestResponseDto": { "type": "object", "properties": { "spendRequestId": { "type": "string", "description": "the id of the created request to spend funds", "nullable": true }, "spendRequestToken": { "type": "string", "description": "additional validation token that must be sent up with the signed request", "nullable": true } }, "additionalProperties": false, "description": "The response to a request to spend funds from an account" }, "AccountConvertRequestDto": { "required": ["convertToCurrency", "recipients"], "type": "object", "properties": { "convertToCurrency": { "type": "integer", "description": "Currency into which funds should be converted", "format": "int32" }, "convertToContractAddress": { "type": "string", "description": "Address of the contract of the token to convert to", "nullable": true }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/AccountSpendRequestRecipientDto" }, "description": "the list of recipients to send funds to" }, "memo": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Custom memo to attach to this transaction, this will only be visible within CoinPayments®", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "description": "Optional additional information for the spend request e.g. \"UseHopAddress\" for Ethereum", "nullable": true } }, "additionalProperties": false, "description": "Request to create a transaction and convert funds from an account" }, "AccountSpendRequestBroadcastDto": { "required": ["otp", "signedTxHex", "spendRequestToken"], "type": "object", "properties": { "spendRequestToken": { "type": "string", "description": "the validation token from the original request" }, "signedTxHex": { "type": "string", "description": "the client signed transaction encoded in hex" }, "otp": { "type": "string", "description": "2fa token" } }, "additionalProperties": false, "description": "Client signed spend request" }, "CreateMultiSigAccountRequestDto": { "required": ["currencyId", "label", "masterKeyId"], "type": "object", "properties": { "masterKeyId": { "type": "string", "description": "the id of the master key from which the wallet is to be created from", "example": "4174c0b10b271a2db74c" }, "currencyId": { "type": "string", "description": "the id of the currency that the account will hold", "example": "1235" }, "label": { "type": "string", "description": "the user specified name for the new account", "example": "My new BTC account" }, "ownerId": { "type": "string", "description": "optional, owner id of the created wallet.  If not specified then defaults to the currently\r\nauthenticated user, otherwise it must be the id of an organization the user has access to.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "Request to create a new account" }, "CreateSingleSigAccountRequestDto": { "required": ["currencyId", "label"], "type": "object", "properties": { "currencyId": { "type": "string", "description": "the id of the currency that the account will hold", "example": "1235" }, "label": { "type": "string", "description": "the user specified name for the new account", "example": "My new BTC account" }, "ownerId": { "type": "string", "description": "optional, owner id of the created wallet.  If not specified then defaults to the currently\r\nauthenticated user, otherwise it must be the id of an organization the user has access to.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "Request to create a new account" }, "AffiliateChannelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the unique id of the channel", "nullable": true }, "name": { "type": "string", "description": "the name of the channel (unique to an affiliate)", "nullable": true }, "created": { "type": "string", "description": "the timestamp of when the channel was created", "format": "date-time" }, "description": { "type": "string", "description": "the description of the channel", "nullable": true }, "earningsType": { "type": "string", "description": "determines how the affiliate will be earning commissions through this channel", "nullable": true }, "impressionsTotal": { "type": "integer", "description": "the total number of people that viewed the CoinPayments homepage using the referral link", "format": "int32" }, "impressionsUnique": { "type": "integer", "description": "the total number unique number of people that viewed the CoinPayments homepage using the referral link", "format": "int32" }, "conversions": { "type": "integer", "description": "the total number of people that signed up for CoinPayments using the referral link", "format": "int32" }, "totalEarnings": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total earnings for this channel in the users native currency", "nullable": true }, "referralLink": { "type": "string", "description": "the referral link for this channel", "nullable": true } }, "additionalProperties": false, "description": "Individually tracked channel with its own referral link through which an affiliate promotes CoinPayments\r\nand earns commissions on service fees generated for CoinPayments." }, "PagedAffiliateChannelsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AffiliateChannelDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "NewAffiliateChannelDto": { "required": ["earningsType", "name"], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string", "description": "the name of the channel (unique to an affiliate)" }, "description": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the description of the channel", "nullable": true }, "earningsType": { "type": "string", "description": "determines how the affiliate will be earning commissions through this channel" } }, "additionalProperties": false, "description": "Request to create a new affiliate channel" }, "UpdateAffiliateChannelDetailsDto": { "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string", "description": "the name of the channel", "nullable": true }, "description": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the description of the channel", "nullable": true } }, "additionalProperties": false, "description": "Request to update the details of an affiliate channel" }, "AffiliateCommissionsSingleLevelFeesInfoDto": { "type": "object", "properties": { "percentOfPaymentFees": { "type": "number", "description": "the percentage (0..100) of fees collected by CoinPayments for a referred user that the affiliate will be paid", "format": "float" }, "durationYears": { "type": "number", "description": "the duration in the number of years since a referred users signup that the affiliate will earn\r\nfees on all of their transaction fees charged", "format": "float" } }, "additionalProperties": false, "description": "Information about commission fees for single level referrals on the CoinPayments platform" }, "AffiliateCommissionFeesInfoDto": { "type": "object", "properties": { "singleLevel": { "allOf": [{ "$ref": "#/components/schemas/AffiliateCommissionsSingleLevelFeesInfoDto" }], "description": "information about commissions earned for single level referrals", "nullable": true } }, "additionalProperties": false, "description": "Information about commissions that can be earned on the CoinPayments platform" }, "AffiliateInfoDto": { "type": "object", "properties": { "defaultReferralLink": { "type": "string", "description": "the referral link for the default channel", "nullable": true }, "fees": { "allOf": [{ "$ref": "#/components/schemas/AffiliateCommissionFeesInfoDto" }], "description": "Information about commissions rates that the affiliate earns on the CoinPayments platform", "nullable": true } }, "additionalProperties": false, "description": "Information about the affiliate" }, "AffiliateEarningPerCurrencyDto": { "type": "object", "properties": { "currencyId": { "type": "integer", "description": "the id of the currency for the current earnings", "format": "int32" }, "totalEarnings": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total earnings in the earned currency", "nullable": true }, "totalNativeEarnings": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total earnings in the users currency", "nullable": true } }, "additionalProperties": false, "description": "The earnings for a single currency" }, "AffiliateEarningsDto": { "type": "object", "properties": { "earningsByCurrency": { "type": "array", "items": { "$ref": "#/components/schemas/AffiliateEarningPerCurrencyDto" }, "description": "the earnings grouped by the currency", "nullable": true }, "totalNativeEarnings": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total earnings in all currencies, in the users native currency", "nullable": true } }, "additionalProperties": false, "description": "The affiliate earnings" }, "AffiliateEarningsSummaryDto": { "type": "object", "properties": { "last24h": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the earnings in the last 24-hours", "nullable": true }, "last7Days": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the earnings in the last 7-days (week)", "nullable": true }, "last30Days": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the earnings in the last 30-days (month)", "nullable": true }, "lastYear": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the earnings in the last year (365 days)", "nullable": true }, "allTime": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the all time earnings", "nullable": true }, "totalConversions": { "type": "integer", "description": "the total conversions through every channel", "format": "int32" } }, "additionalProperties": false }, "AffiliateImpressionsDayDto": { "type": "object", "properties": { "day": { "type": "string", "description": "the timestamp of the day (\"yyyy-MM-dd\")", "nullable": true }, "impressionsTotal": { "type": "integer", "description": "the total number of impressions on the day", "format": "int32" }, "impressionsUnique": { "type": "integer", "description": "the total number of unique impressions on the day", "format": "int32" }, "conversions": { "type": "integer", "description": "the total number of conversions on the day", "format": "int32" } }, "additionalProperties": false, "description": "Information about impressions and conversions on a particular day" }, "AffiliateImpressionsDailyDto": { "type": "object", "properties": { "from": { "type": "string", "description": "the start date that was requested", "format": "date-time", "nullable": true }, "to": { "type": "string", "description": "the end date that was requested", "format": "date-time", "nullable": true }, "channelId": { "type": "string", "description": "the channel id if filtering by channel", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AffiliateImpressionsDayDto" }, "description": "the daily impressions, if any, between the requested period.  Zero impression/conversion days will not be returned", "nullable": true } }, "additionalProperties": false, "description": "Information about the impressions for an affiliate by day" }, "AffiliateImpressionsSummaryDto": { "type": "object", "properties": { "impressionsTotal": { "type": "integer", "description": "the total number of impressions", "format": "int32" }, "impressionsUnique": { "type": "integer", "description": "the total number of unique impressions", "format": "int32" }, "conversions": { "type": "integer", "description": "the total number of conversions", "format": "int32" } }, "additionalProperties": false, "description": "Information about the total impressions" }, "PagedCurrenciesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Page of currencies" }, "CurrencyConversion": { "type": "object", "properties": { "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FullNameDto": { "type": "object", "properties": { "firstName": { "maxLength": 140, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 140, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "AddressDto": { "type": "object", "properties": { "address1": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "address2": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "address3": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "provinceOrState": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "suburbOrDistrict": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "countryCode": { "maxLength": 2, "minLength": 2, "pattern": "^([A-Z]{2})$", "type": "string", "nullable": true }, "postalCode": { "maxLength": 60, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "BuyerDto": { "type": "object", "properties": { "companyName": { "type": "string", "nullable": true }, "name": { "allOf": [{ "$ref": "#/components/schemas/FullNameDto" }], "nullable": true }, "emailAddress": { "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "type": "string", "format": "tel", "nullable": true }, "address": { "allOf": [{ "$ref": "#/components/schemas/AddressDto" }], "nullable": true } }, "additionalProperties": false }, "InvoiceMoneyDto": { "type": "object", "properties": { "currencyId": { "type": "integer", "format": "int32" }, "contractAddress": { "type": "string", "nullable": true }, "displayValue": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LineItemDto": { "required": ["amount", "name", "quantity"], "type": "object", "properties": { "customId": { "maxLength": 127, "minLength": 0, "type": "string", "nullable": true }, "sku": { "maxLength": 127, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 127, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "maximum": 999999999, "minimum": 1, "type": "integer", "format": "int32" }, "originalAmount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }] }, "tax": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true } }, "additionalProperties": false }, "InvoiceAmountBreakdownDto": { "required": ["subtotal"], "type": "object", "properties": { "subtotal": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }] }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true }, "handling": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true }, "taxTotal": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true }, "discount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true } }, "additionalProperties": false }, "InvoiceAmountDto": { "type": "object", "properties": { "breakdown": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountBreakdownDto" }], "nullable": true }, "currencyId": { "type": "integer", "format": "int32" }, "contractAddress": { "type": "string", "nullable": true }, "displayValue": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceShippingDetailDto": { "type": "object", "properties": { "method": { "maxLength": 127, "minLength": 0, "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "name": { "allOf": [{ "$ref": "#/components/schemas/FullNameDto" }], "nullable": true }, "emailAddress": { "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "type": "string", "format": "tel", "nullable": true }, "address": { "allOf": [{ "$ref": "#/components/schemas/AddressDto" }], "nullable": true } }, "additionalProperties": false }, "InvoiceMetadataDto": { "type": "object", "properties": { "integration": { "type": "string", "nullable": true }, "hostname": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateInvoiceRequestDto": { "required": ["amount", "clientId"], "type": "object", "properties": { "clientId": { "type": "string", "description": "the id of the client creating this invoice" }, "currencyId": { "type": "integer", "description": "the id of the currency the invoice is to be in, alternatively this can be set individually per field", "format": "int32", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information, if not provided it can be requested during payment if needed", "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "description": "the purchase description, can be provided instead of a list of `items`", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDto" }, "description": "the optional array of items that a buyer intends to purchase from the merchant", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }], "description": "the total amount of the invoice, with an optional breakdown that provides details, such as the total item\r\namount, total tax amount, shipping, handling, insurance and discounts, if any" }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the optional shipping method and address", "nullable": true }, "requireBuyerNameAndEmail": { "type": "boolean", "description": "flag indicating whether a buyer name and email are required, they will be requested at checkout\r\nif not provider by the caller.  The Orion.Api.Models.Merchant.CreateInvoiceRequestDto.BuyerDataCollectionMessage will be displayed\r\nto the buyer when prompted." }, "buyerDataCollectionMessage": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the message to display when collecting buyer user data", "nullable": true }, "notesToRecipient": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any additional information to share with the buyer about the transaction", "nullable": true }, "termsAndConditions": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any terms and conditions, e.g. a cancellation policy", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "any custom data the caller wishes to attach to the invoice which will be sent back in notifications", "nullable": true }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMetadataDto" }], "nullable": true } }, "additionalProperties": false, "description": "Request to create an invoice, which is a list of goods or services with a statement of the sum due provided\r\nby the merchant, that a buyer intends to purchase" }, "UpdateInvoiceBuyerInfoRequestDto": { "type": "object", "properties": { "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the shipping method and address", "nullable": true } }, "additionalProperties": false, "description": "Request to update an invoice" }, "MasterKeyDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the unique id of the master key", "nullable": true }, "masterKeyId": { "type": "string", "description": "the unique id of the master key", "nullable": true, "readOnly": true, "deprecated": true }, "created": { "type": "string", "description": "timestamp when the master key was created", "format": "date-time" }, "label": { "type": "string", "description": "the user or system generated label of the master key", "nullable": true }, "clientPublicKey": { "type": "string", "description": "the clients public key", "nullable": true }, "clientEncryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key", "nullable": true }, "serverPublicKey": { "type": "string", "description": "the servers public key", "nullable": true }, "keyRecoveryServiceName": { "type": "string", "description": "the name of the key recovery service (KRS) that provided the backup key", "nullable": true }, "backupPublicKey": { "type": "string", "description": "the public key from the KRS", "nullable": true } }, "additionalProperties": false, "description": "Represents a Master Key from which crypto currency wallets can be created from.  The Master Key contains  \r\nthree BIP32 HD keys for the sole purpose of 2-of-3 wallet tree generation, utilizing BIP44 paths, it is\r\nunable to sign transactions by itself." }, "UpdateMasterKeyRequestDto": { "type": "object", "properties": { "encryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key", "nullable": true }, "label": { "type": "string", "description": "optional label to apply to the master key", "nullable": true } }, "additionalProperties": false, "description": "Request from the client to update an existing master key, the client can send a new `Label` and/or\r\n`EncryptedPrivateKey` when changing passwords" }, "PagedMasterKeysDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MasterKeyDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Page of master keys" }, "CreateMasterKeyRequestDto": { "required": ["encryptedPrivateKey", "originalPasscodeEncryptionCode", "publicKey"], "type": "object", "properties": { "publicKey": { "type": "string", "description": "the clients public key" }, "encryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key" }, "label": { "type": "string", "description": "optional label to apply to the master key", "nullable": true }, "originalPasscodeEncryptionCode": { "maxLength": 40, "minLength": 8, "type": "string", "description": "the encryption code that was used to encrypt the original passcode on the printed PDF\r\nthe user downloaded.  Saved by the server in case the user needs to recover it." } }, "additionalProperties": false, "description": "Request from the client to create a new master key, supplying the clients public and encrypted private keys." }, "CreateMasterKeyResponseDto": { "type": "object", "properties": { "masterKeyId": { "type": "string", "description": "the id of the created master key", "nullable": true } }, "additionalProperties": false, "description": "Response to a successful `CreateMasterKeyRequest`" }, "ActivateMasterKeyRequestDto": { "required": ["activationCode"], "type": "object", "properties": { "activationCode": { "maxLength": 6, "minLength": 6, "type": "string", "description": "the activation code found on the Backup PDF" } }, "additionalProperties": false, "description": "Request from the client to activate a master key" }, "CreateMerchantProfileDto": { "type": "object", "properties": { "name": { "type": "string", "description": "the business name of the merchant", "nullable": true }, "uboName": { "type": "string", "description": "full name of the Ultimate Beneficiary Owner (UBO) of the business", "nullable": true }, "country": { "type": "string", "description": "the merchant's business country of registration", "nullable": true }, "websiteUrl": { "type": "string", "description": "the url to the merchants website", "format": "uri", "nullable": true }, "address": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "the merchant's business address", "nullable": true }, "email": { "type": "string", "description": "the merchant's business email", "nullable": true }, "phone": { "type": "string", "description": "the phone number of the business", "nullable": true }, "description": { "type": "string", "description": "the description of the merchant", "nullable": true }, "registrationNumber": { "type": "string", "description": "the business registration number", "nullable": true } }, "additionalProperties": false, "description": "Represents info needed when creating a Merchant" }, "MerchantProfileDto": { "type": "object", "properties": { "name": { "type": "string", "description": "the business name of the merchant", "nullable": true }, "uboName": { "type": "string", "description": "full name of the Ultimate Beneficiary Owner (UBO) of the business", "nullable": true }, "websiteUrl": { "type": "string", "description": "the url to the merchants website", "nullable": true }, "country": { "type": "string", "description": "the merchant's business country of registration", "nullable": true }, "logoUrl": { "type": "string", "description": "the url to the merchant's logo", "nullable": true }, "email": { "type": "string", "description": "the merchant's business email", "nullable": true }, "address": { "type": "string", "description": "the merchant's business address", "nullable": true }, "phone": { "type": "string", "description": "the phone number of the business", "nullable": true }, "description": { "type": "string", "description": "the description of the merchant", "nullable": true }, "registrationNumber": { "type": "string", "description": "the business registration number", "nullable": true } }, "additionalProperties": false, "description": "Represents a merchant's profile info" }, "UpdateMerchantProfileDto": { "type": "object", "properties": { "name": { "type": "string", "description": "the business name of the merchant", "nullable": true }, "uboName": { "type": "string", "description": "full name of the Ultimate Beneficiary Owner (UBO) of the business", "nullable": true }, "country": { "type": "string", "description": "the merchant's business country of registration", "nullable": true }, "websiteUrl": { "type": "string", "description": "the url to the merchants website", "nullable": true }, "address": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "the merchant's business address", "nullable": true }, "email": { "type": "string", "description": "the merchant's business email", "nullable": true }, "phone": { "type": "string", "description": "the phone number of the business", "nullable": true }, "description": { "type": "string", "description": "the description of the merchant", "nullable": true }, "registrationNumber": { "type": "string", "description": "the business registration number", "nullable": true } }, "additionalProperties": false, "description": "Represents info to update for a Merchant" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "extensions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "MerchantPaymentCurrencyPayoutFrequency": { "enum": ["normal", "asSoonAsPossible", "hourly", "nightly", "weekly"], "type": "string" }, "PayoutConfigDto": { "type": "object", "properties": { "walletId": { "type": "string", "description": "the id of the wallet into which to payout to", "nullable": true }, "currencyId": { "type": "integer", "description": "the currency id of the wallet or address into which to payout to", "format": "int32" }, "address": { "type": "string", "description": "the external address into which to payout to", "nullable": true }, "payoutSplit": { "type": "integer", "description": "the percentage of payout to be sent to this endpoint (0..100).\r\nSince we are only supporting single payout for now, it is set to 100.", "format": "int32", "readOnly": true } }, "additionalProperties": false, "description": "Represents info needed to specify payout configuration for payments" }, "AcceptedCurrencyDto": { "type": "object", "properties": { "currency": { "allOf": [{ "$ref": "#/components/schemas/CurrencyDto" }], "description": "the currency that the merchant accepts", "nullable": true }, "payoutFrequency": { "allOf": [{ "$ref": "#/components/schemas/MerchantPaymentCurrencyPayoutFrequency" }], "description": "the frequency of payments into merchant wallets for the current payment currency" }, "order": { "type": "integer", "description": "the ranking of this payment currency relative to other payment currencies of the merchant", "format": "int32" }, "discountPercent": { "type": "number", "description": "the discount to give buyers when paying in this currency, maybe as a promotional tool", "format": "float" }, "markupPercent": { "type": "number", "description": "the markup to charge buyers when paying in this currency, maybe to cover local crypto/fiat conversion costs", "format": "float" }, "payoutConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutConfigDto" }, "description": "the configurations defining how the merchant would like to receive funds from the current payment currency", "nullable": true } }, "additionalProperties": false, "description": "Represents info about a merchant's accepted currency" }, "AcceptedCurrenciesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AcceptedCurrencyDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Represents a merchant's accepted currencies" }, "AddAcceptedCurrencyConfigDto": { "type": "object", "properties": { "frequency": { "allOf": [{ "$ref": "#/components/schemas/MerchantPaymentCurrencyPayoutFrequency" }], "description": "the frequency of payments into merchant wallets for the current payment currency", "nullable": true }, "discountPercent": { "maximum": 99.99, "minimum": 0, "type": "number", "description": "the discount to give buyers when paying in this currency, maybe as a promotional tool", "format": "float", "nullable": true }, "markupPercent": { "maximum": 999999999, "minimum": 0, "type": "number", "description": "the markup to charge buyers when paying in this currency, maybe to cover local crypto/fiat conversion costs", "format": "float", "nullable": true }, "payouts": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutConfigDto" }, "description": "the configurations defining how the merchant would like to receive funds from the current payment currency", "nullable": true } }, "additionalProperties": false, "description": "Add info needed to configure an accepted Currency" }, "UpdateAcceptedCurrencyConfigDto": { "type": "object", "properties": { "frequency": { "allOf": [{ "$ref": "#/components/schemas/MerchantPaymentCurrencyPayoutFrequency" }], "description": "the frequency of payments into merchant wallets for the current payment currency", "nullable": true }, "discountPercent": { "maximum": 99.99, "minimum": 0, "type": "number", "description": "the discount to give buyers when paying in this currency, maybe as a promotional tool", "format": "float", "nullable": true }, "markupPercent": { "maximum": 999999999, "minimum": 0, "type": "number", "description": "the markup to charge buyers when paying in this currency, maybe to cover local crypto/fiat conversion costs", "format": "float", "nullable": true }, "payouts": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutConfigDto" }, "description": "the configurations defining how the merchant would like to receive funds from the current payment currency", "nullable": true } }, "additionalProperties": false, "description": "Update for info needed to configure an accepted Currency" }, "ChangeAcceptedCurrencyOrderDto": { "required": ["order"], "type": "object", "properties": { "order": { "type": "integer", "description": "The order (preferred rank) of a payment currency. The smaller the number, the more the currency is preferred for payment.\r\nTo unassign the rank of a payment currency (ie, currency is still accepted but no longer preferred), pass in a 0 for the Order.", "format": "int32" } }, "additionalProperties": false }, "MerchantLogoDto": { "type": "object", "properties": { "logoUrl": { "type": "string", "description": "The url to the merchant's logo", "nullable": true } }, "additionalProperties": false, "description": "Represents merchant's logo" }, "CallbackAddressWebhookDto": { "type": "object", "properties": { "url": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "the url to send notifications to when deposits are detected (if null then URLs configured in client are used)", "nullable": true }, "nativeCurrencyId": { "type": "integer", "description": "the id of the native currency to include a conversion to in any webhook notifications sent", "format": "int32", "nullable": true }, "customData": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "custom data that will be sent back in all webhook notifications sent", "nullable": true } }, "additionalProperties": false, "description": "Webhook notification customizations for a callback address, if not specified the settings for the client will be used" }, "NewCallbackAddressDto": { "required": ["currencyId"], "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "currencyId": { "type": "integer", "description": "the id of the currency the address will be receiving", "format": "int32" }, "label": { "maxLength": 100, "minLength": 0, "type": "string", "description": "the label of the address (display only)", "nullable": true }, "webhook": { "allOf": [{ "$ref": "#/components/schemas/CallbackAddressWebhookDto" }], "description": "the webhook notification information and customizations", "nullable": true } }, "additionalProperties": false, "description": "Request to create a new merchant callback address" }, "CallbackAddressDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the unique id of the callback address", "nullable": true }, "clientId": { "type": "string", "description": "the merchant client this callback address is linked to", "nullable": true }, "created": { "type": "string", "description": "the timestamp of when the callback address was created", "format": "date-time" }, "currencyId": { "type": "integer", "description": "the id of the currency the address is receiving", "format": "int32" }, "address": { "type": "string", "description": "the actual deposit address", "nullable": true }, "label": { "type": "string", "description": "the display label of the callback address", "nullable": true }, "webhook": { "allOf": [{ "$ref": "#/components/schemas/CallbackAddressWebhookDto" }], "description": "the webhook notification information and customizations", "nullable": true } }, "additionalProperties": false, "description": "Merchant deposit address which sends Webhook notifications when deposits are detected and received" }, "PagedCallbackAddressesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackAddressDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "UpdateCallbackAddressDto": { "type": "object", "properties": { "label": { "maxLength": 100, "minLength": 0, "type": "string", "description": "the label of the address (display only)", "nullable": true }, "webhook": { "allOf": [{ "$ref": "#/components/schemas/CallbackAddressWebhookDto" }], "description": "the webhook notification information and customizations", "nullable": true } }, "additionalProperties": false, "description": "Request to update a callback address" }, "InvoiceCurrencyTokenDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "symbol": { "type": "string", "nullable": true }, "contractAddress": { "type": "string", "nullable": true }, "decimalPlaces": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "InvoiceCurrencyLogoDto": { "type": "object", "properties": { "imageUrl": { "type": "string", "nullable": true }, "vectorUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceCurrencyDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "symbol": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "token": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyTokenDto" }], "nullable": true }, "logo": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyLogoDto" }], "nullable": true }, "decimalPlaces": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CallbackDepositTransactionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the CoinPayments id of the callback deposit transaction", "nullable": true }, "created": { "type": "string", "description": "the timestamp when the transaction was created in the system", "format": "date-time" }, "completed": { "type": "string", "description": "the timestamp when the transaction was completed in the system (confirmed on the blockchain)", "format": "date-time", "nullable": true }, "blockchainTxId": { "type": "string", "description": "the blockchain transaction id, if available", "nullable": true }, "callbackAddressId": { "type": "string", "description": "the id of the callback address receiving the payment", "nullable": true }, "address": { "type": "string", "description": "the address the payment was received on", "nullable": true }, "currency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyDto" }], "description": "the currency the payment is in", "nullable": true }, "nativeCurrency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyDto" }], "description": "the currency the native amounts are in", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total amount of the payment in the payment currency (e.g. Bitcoin)", "nullable": true }, "coinPaymentsFee": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the fee deducted by CoinPayments in the payment currency (e.g. Bitcoin)", "nullable": true }, "nativeAmount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total amount of the payment in the native currency (e.g. USD)", "nullable": true }, "nativeCoinPaymentsFee": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the fee deducted by CoinPayments in the native currency (e.g. USD)", "nullable": true }, "status": { "type": "string", "description": "the status of the payment (Detected or Confirmed)", "nullable": true } }, "additionalProperties": false, "description": "Deposit transaction to a callback address" }, "PagedCallbackDepositTransactionsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackDepositTransactionDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "MerchantClientPublicState": { "enum": ["active", "disabled"], "type": "string", "description": "Specifies the states that are exposed publicly through the API" }, "MerchantClientDto": { "type": "object", "properties": { "clientId": { "type": "string", "description": "the unique id for the client app that the merchant will use to communicate with CoinPayments REST API", "nullable": true }, "integration": { "type": "string", "description": "the name of the integration for which this client was created", "nullable": true }, "name": { "type": "string", "description": "the name of the client app", "nullable": true }, "state": { "allOf": [{ "$ref": "#/components/schemas/MerchantClientPublicState" }], "description": "the state of the client" }, "storeUrl": { "type": "string", "description": "the store url of the client", "nullable": true } }, "additionalProperties": false }, "MerchantClientsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "CreateMerchantClientDto": { "required": ["name", "storeUrl"], "type": "object", "properties": { "integration": { "maxLength": 100, "minLength": 1, "type": "string", "description": "the name of the integration for which this client was created (e.g. 'Magento', or 'Shopify')", "nullable": true }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "the name of the client that the merchant should provide" }, "storeUrl": { "type": "string", "description": "the store url of the client", "format": "uri" } }, "additionalProperties": false, "description": "Represents the name of the merchant's client" }, "UpdateMerchantClientDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the client provided by the merchant", "nullable": true }, "storeUrl": { "type": "string", "description": "the store url of the client", "nullable": true }, "state": { "allOf": [{ "$ref": "#/components/schemas/MerchantClientPublicState" }], "description": "The state of the client to update to", "nullable": true } }, "additionalProperties": false }, "RegenerateSecretResponseDto": { "type": "object", "properties": { "clientSecret": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantClientWebhookNotification": { "enum": ["invoiceCreated", "invoicePending", "invoicePaid", "invoiceCompleted", "invoiceCancelled"], "type": "string", "description": "The notification types for a webhook" }, "MerchantClientWebhookEndpointDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the id of the notifications endpoint", "nullable": true }, "notificationsUrl": { "type": "string", "description": "the url to which to POST webhook notifications to", "nullable": true }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientWebhookNotification" }, "description": "the types of notifications to send to this endpoint", "nullable": true } }, "additionalProperties": false, "description": "Represents an endpoint at which the merchant wishes to receive webhook notifications for the client app" }, "MerchantClientWebhookEndpointsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientWebhookEndpointDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Represents an endpoint at which the merchant wishes to receive webhook notifications for the client app" }, "CreateMerchantClientWebhookRequestDto": { "required": ["notifications", "notificationsUrl"], "type": "object", "properties": { "notificationsUrl": { "type": "string", "description": "the url to which to POST webhook notifications to", "format": "uri" }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientWebhookNotification" }, "description": "the types of notifications to send to this endpoint" } }, "additionalProperties": false }, "UpdateMerchantClientWebhookDto": { "type": "object", "properties": { "notificationsUrl": { "type": "string", "description": "the url to which to POST webhook notifications to", "format": "uri", "nullable": true }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientWebhookNotification" }, "description": "the types of notifications to send to this endpoint", "nullable": true } }, "additionalProperties": false }, "MerchantInvoiceEmailDeliveryOptionsDto": { "type": "object", "properties": { "to": { "maxLength": 500, "minLength": 0, "type": "string", "description": "the email `to` field, multiple addresses separated by semicolons", "nullable": true }, "cc": { "maxLength": 500, "minLength": 0, "type": "string", "description": "the email `cc` field, multiple addresses separated by semicolons", "nullable": true }, "bcc": { "maxLength": 500, "minLength": 0, "type": "string", "description": "the email `bcc` field, multiple addresses separated by semicolons", "nullable": true } }, "additionalProperties": false, "description": "Email delivery options of a merchant invoice" }, "MerchantInvoiceLineItemDto": { "type": "object", "properties": { "customId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the API caller provided external ID for the item.  Appears on the Merchant dashboard and reports only.", "nullable": true }, "sku": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the stock keeping unit (SKU) of the item", "nullable": true }, "name": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the name or title of the item", "nullable": true }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "the detailed description of the item", "nullable": true }, "quantity": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "the quantity of the item.  Must be greater than 0 and less than 999,999,999‬.\r\ndefaults to 1 if not provided.", "format": "int32" }, "originalAmount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "the original total price of the item if Orion.Api.Models.Merchant.Dashboard.MerchantInvoices.MerchantInvoiceLineItemDto.Amount represents a discounted price", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "the subtotal price of the item (note: this is not a per unit price but the total price for the total quantity)", "nullable": true }, "tax": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "the total taxes charged on this item", "nullable": true } }, "additionalProperties": false, "description": "Represents an item of a merchant invoice that a buyer intends to purchase from a merchant" }, "InvoiceMerchantOptionsDto": { "type": "object", "properties": { "showAddress": { "type": "boolean" }, "showEmail": { "type": "boolean" }, "showPhone": { "type": "boolean" }, "showRegistrationNumber": { "type": "boolean" }, "additionalInfo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateMerchantInvoiceBuyNowButtonHtmlRequestDto": { "required": ["cancelUrl", "successUrl"], "type": "object", "properties": { "successUrl": { "type": "string", "description": "the url to redirect to once an invoice is successfully paid" }, "cancelUrl": { "type": "string", "description": "the url to redirect to if payment of an invoice fails (e.g. expired) or is cancelled by the user" }, "ipnUrl": { "type": "string", "description": "the url to send a payment complete message to once the invoice has been paid", "nullable": true }, "emailNotifications": { "type": "boolean", "description": "flag indicating whether to send an email notification once payment completes successfully" }, "buttonWidth": { "type": "integer", "description": "the desired width of the \"Buy Now\" button", "format": "int32", "nullable": true }, "buttonStyle": { "type": "string", "description": "the style of the button", "nullable": true }, "isEmailDelivery": { "type": "boolean", "description": "indicates if invoice will be email delivered" }, "emailDelivery": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceEmailDeliveryOptionsDto" }], "description": "the invoice email delivery options if the invoice is to be emailed", "nullable": true }, "dueDate": { "type": "string", "description": "optional due date to be shown on the invoice", "format": "date-time", "nullable": true }, "invoiceDate": { "type": "string", "description": "optional custom invoice date if not the created date of the invoice, invoices with a future date will\r\nbe scheduled", "format": "date-time", "nullable": true }, "draft": { "type": "boolean", "description": "flag indicating whether this is a draft invoice", "nullable": true }, "clientId": { "type": "string", "description": "the id of the client creating this invoice (optional)", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information, if not provided it can be requested during payment if needed", "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "description": "the purchase description, can be provided instead of a list of `items`", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceLineItemDto" }, "description": "the optional array of items that a buyer intends to purchase from the merchant", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }], "description": "the total amount of the invoice, with an optional breakdown that provides details, such as the total item\r\namount, total tax amount, shipping, handling, insurance and discounts, if any", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the optional shipping method and address", "nullable": true }, "requireBuyerNameAndEmail": { "type": "boolean", "description": "flag indicating whether a buyer name and email are required, they will be requested at checkout\r\nif not provider by the caller.  The Orion.Api.Models.Merchant.CreateMerchantInvoiceRequestDto.BuyerDataCollectionMessage will be displayed\r\nto the buyer when prompted.", "nullable": true }, "buyerDataCollectionMessage": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the message to display when collecting buyer user data", "nullable": true }, "notes": { "maxLength": 500, "minLength": 0, "type": "string", "description": "notes for the merchant only, these are not visible to the buyers", "nullable": true }, "notesToRecipient": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any additional information to share with the buyer about the transaction", "nullable": true }, "termsAndConditions": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any terms and conditions, e.g. a cancellation policy", "nullable": true }, "merchantOptions": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantOptionsDto" }], "description": "options to show/hide merchant information on an invoice, or include additional merchant information specific to an invoice", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "any custom data the caller wishes to attach to the invoice which will be sent back in notifications", "nullable": true }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMetadataDto" }], "nullable": true } }, "additionalProperties": false, "description": "Request to create the HTML for a \"Buy Now\" Button" }, "MerchantInvoiceNextIdDto": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "Merchant invoice id, if not unique will be appended with auto-incrementing numbers, otherwise\r\nif unique will be used directly", "nullable": true } }, "additionalProperties": false }, "InvoiceStatus": { "enum": ["draft", "scheduled", "unpaid", "pending", "paid", "completed", "cancelled", "timedOut"], "type": "string" }, "MerchantInvoiceSummaryMoneyDto": { "type": "object", "properties": { "currencySymbol": { "type": "string", "nullable": true }, "currencyId": { "type": "integer", "format": "int32" }, "contractAddress": { "type": "string", "nullable": true }, "displayValue": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantInvoiceSummaryShippingDto": { "type": "object", "properties": { "address": { "allOf": [{ "$ref": "#/components/schemas/AddressDto" }], "description": "the address of the party to ship the items to", "nullable": true } }, "additionalProperties": false, "description": "The buyer's shipping address" }, "MerchantInvoiceSummaryMetadataDto": { "type": "object", "properties": { "integration": { "type": "string", "description": "the integration from which the invoice was created", "nullable": true } }, "additionalProperties": false }, "MerchantInvoiceSummaryDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the CoinPayments id for the invoice", "nullable": true }, "invoiceId": { "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "created": { "type": "string", "description": "the timestamp when the invoice entity was created", "format": "date-time" }, "invoiceDate": { "type": "string", "description": "the date of the invoice, either the system created date or custom date specified by the merchant", "format": "date-time" }, "dueDate": { "type": "string", "description": "optional due date of the invoice", "format": "date-time", "nullable": true }, "confirmed": { "type": "string", "description": "the timestamp when the invoice was confirmed (paid)", "format": "date-time", "nullable": true }, "completed": { "type": "string", "description": "the timestamp when the invoice was completed (paid out to the merchant and CoinPayments fees)", "format": "date-time", "nullable": true }, "cancelled": { "type": "string", "description": "the timestamp when the invoice was manually cancelled. Applicable for payment invoices only", "format": "date-time", "nullable": true }, "currency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyDto" }], "description": "the currency the invoice is in", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information", "nullable": true }, "description": { "type": "string", "description": "the purchase description", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceSummaryMoneyDto" }], "description": "the total amount of the invoice", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceSummaryShippingDto" }], "description": "the shipping info", "nullable": true }, "status": { "allOf": [{ "$ref": "#/components/schemas/InvoiceStatus" }], "description": "the status of the invoice (including payments received and payments confirmed)" }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceSummaryMetadataDto" }], "description": "the invoice metadata, the integration where the invoice was created", "nullable": true }, "payouts": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceSummaryMoneyDto" }, "description": "the payout amounts expected or received", "nullable": true }, "isEmailDelivery": { "type": "boolean", "description": "indicates if invoice was delivered or to be delivered by email" } }, "additionalProperties": false, "description": "Summary for a merchant invoice" }, "MerchantInvoiceSummariesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceSummaryDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "CreateMerchantInvoiceRequestDto": { "type": "object", "properties": { "isEmailDelivery": { "type": "boolean", "description": "indicates if invoice will be email delivered" }, "emailDelivery": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceEmailDeliveryOptionsDto" }], "description": "the invoice email delivery options if the invoice is to be emailed", "nullable": true }, "dueDate": { "type": "string", "description": "optional due date to be shown on the invoice", "format": "date-time", "nullable": true }, "invoiceDate": { "type": "string", "description": "optional custom invoice date if not the created date of the invoice, invoices with a future date will\r\nbe scheduled", "format": "date-time", "nullable": true }, "draft": { "type": "boolean", "description": "flag indicating whether this is a draft invoice", "nullable": true }, "clientId": { "type": "string", "description": "the id of the client creating this invoice (optional)", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information, if not provided it can be requested during payment if needed", "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "description": "the purchase description, can be provided instead of a list of `items`", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceLineItemDto" }, "description": "the optional array of items that a buyer intends to purchase from the merchant", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }], "description": "the total amount of the invoice, with an optional breakdown that provides details, such as the total item\r\namount, total tax amount, shipping, handling, insurance and discounts, if any", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the optional shipping method and address", "nullable": true }, "requireBuyerNameAndEmail": { "type": "boolean", "description": "flag indicating whether a buyer name and email are required, they will be requested at checkout\r\nif not provider by the caller.  The Orion.Api.Models.Merchant.CreateMerchantInvoiceRequestDto.BuyerDataCollectionMessage will be displayed\r\nto the buyer when prompted.", "nullable": true }, "buyerDataCollectionMessage": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the message to display when collecting buyer user data", "nullable": true }, "notes": { "maxLength": 500, "minLength": 0, "type": "string", "description": "notes for the merchant only, these are not visible to the buyers", "nullable": true }, "notesToRecipient": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any additional information to share with the buyer about the transaction", "nullable": true }, "termsAndConditions": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any terms and conditions, e.g. a cancellation policy", "nullable": true }, "merchantOptions": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantOptionsDto" }], "description": "options to show/hide merchant information on an invoice, or include additional merchant information specific to an invoice", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "any custom data the caller wishes to attach to the invoice which will be sent back in notifications", "nullable": true }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMetadataDto" }], "nullable": true } }, "additionalProperties": false, "description": "Used for creating an invoice on the dashboard.\r\nRequest to create an invoice, which is a list of goods or services with a statement of the sum due provided\r\nby the merchant, that a buyer intends to purchase" }, "InvoiceMerchantDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "uboName": { "type": "string", "nullable": true }, "websiteUrl": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "logoUrl": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "registrationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceEmailDeliveryOptionsDto": { "type": "object", "properties": { "to": { "type": "string", "nullable": true }, "cc": { "type": "string", "nullable": true }, "bcc": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceDto": { "required": ["amount"], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "confirmed": { "type": "string", "format": "date-time", "nullable": true }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "cancelled": { "type": "string", "format": "date-time", "nullable": true }, "currency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyDto" }], "nullable": true }, "merchant": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantDto" }], "nullable": true }, "merchantOptions": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantOptionsDto" }], "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDto" }, "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }] }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "status": { "allOf": [{ "$ref": "#/components/schemas/InvoiceStatus" }] }, "requireBuyerNameAndEmail": { "type": "boolean", "nullable": true }, "buyerDataCollectionMessage": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "notesToRecipient": { "type": "string", "nullable": true }, "termsAndConditions": { "type": "string", "nullable": true }, "emailDelivery": { "allOf": [{ "$ref": "#/components/schemas/InvoiceEmailDeliveryOptionsDto" }], "nullable": true }, "isEmailDelivery": { "type": "boolean" }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMetadataDto" }], "nullable": true }, "ref": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateMerchantInvoiceRequestDto": { "type": "object", "properties": { "isEmailDelivery": { "type": "boolean", "description": "indicates if invoice will be email delivered" }, "emailDelivery": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceEmailDeliveryOptionsDto" }], "description": "the invoice email delivery options if the invoice is to be emailed", "nullable": true }, "dueDate": { "type": "string", "description": "optional due date to be shown on the invoice", "format": "date-time", "nullable": true }, "invoiceDate": { "type": "string", "description": "optional custom invoice date if not the created date of the invoice, invoices with a future date will\r\nbe scheduled", "format": "date-time", "nullable": true }, "draft": { "type": "boolean", "description": "flag indicating whether this is a draft invoice", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information, if not provided it can be requested during payment if needed", "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "description": "the purchase description, can be provided instead of a list of `items`", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceLineItemDto" }, "description": "the optional array of items that a buyer intends to purchase from the merchant", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }], "description": "the total amount of the invoice, with an optional breakdown that provides details, such as the total item\r\namount, total tax amount, shipping, handling, insurance and discounts, if any", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the optional shipping method and address", "nullable": true }, "requireBuyerNameAndEmail": { "type": "boolean", "description": "flag indicating whether a buyer name and email are required, they will be requested at checkout\r\nif not provider by the caller.  The Orion.Api.Models.Merchant.UpdateMerchantInvoiceRequestDto.BuyerDataCollectionMessage will be displayed\r\nto the buyer when prompted.", "nullable": true }, "buyerDataCollectionMessage": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the message to display when collecting buyer user data", "nullable": true }, "notes": { "maxLength": 500, "minLength": 0, "type": "string", "description": "notes for the merchant only, these are not visible to the buyers", "nullable": true }, "notesToRecipient": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any additional information to share with the buyer about the transaction", "nullable": true }, "termsAndConditions": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any terms and conditions, e.g. a cancellation policy", "nullable": true }, "merchantOptions": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantOptionsDto" }], "description": "options to show/hide merchant information on an invoice, or include additional merchant information specific to an invoice", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "any custom data the caller wishes to attach to the invoice which will be sent back in notifications", "nullable": true } }, "additionalProperties": false, "description": "Used for creating an invoice on the dashboard.\r\nRequest to create an invoice, which is a list of goods or services with a statement of the sum due provided\r\nby the merchant, that a buyer intends to purchase" }, "InvoicePaymentHotWalletPayoutState": { "enum": ["scheduled", "sending", "sent", "confirmed"], "type": "string" }, "InvoicePayoutDetailsDto": { "type": "object", "properties": { "currency": { "allOf": [{ "$ref": "#/components/schemas/CurrencyDto" }], "description": "the currency (merchant's accepted currency) that will be received", "nullable": true }, "merchantFees": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "The amount for service fees in the merchant's accepted currency", "nullable": true }, "payoutAmount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "This is the amount to be finally paid out to the merchant in the merchant's accepted currency", "nullable": true }, "payoutAmountInInvoiceCurrency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "The Orion.Api.Models.Merchant.InvoicePayoutDetailsDto.PayoutAmount in the invoice currency", "nullable": true }, "merchantFeesInInvoiceCurrency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "The Orion.Api.Models.Merchant.InvoicePayoutDetailsDto.MerchantFees in the invoice currency", "nullable": true }, "merchantPayoutAddress": { "type": "string", "description": "the merchants payment output address at the time the hot wallet was created", "nullable": true }, "created": { "type": "string", "description": "the timestamp of when this payout was created (or scheduled)", "format": "date-time" }, "sent": { "type": "string", "description": "the timestamp of when this payout was sent (e.g. broadcast on the blockchain)", "format": "date-time", "nullable": true }, "expected": { "type": "string", "description": "the approximate timestamp of when this payout is expected to be sent (e.g. broadcast on the blockchain)", "format": "date-time", "nullable": true }, "confirmed": { "type": "string", "description": "the timestamp of when this payout was confirmed (e.g. on the blockchain)", "format": "date-time", "nullable": true }, "state": { "allOf": [{ "$ref": "#/components/schemas/InvoicePaymentHotWalletPayoutState" }], "description": "the current state of the payout" } }, "additionalProperties": false, "description": "Represents a payout to a Merchant" }, "InvoicePayoutsDetailsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePayoutDetailsDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Represents information about a payouts to a Merchant" }, "UserPreferencesDto": { "type": "object", "properties": { "nativeCurrencyId": { "type": "string", "description": "the users native currency id, api calls will return monetary amounts in this currency along with the\r\noriginal currencies", "nullable": true, "example": "1235" }, "notifyOnFundsReceived": { "type": "boolean", "description": "value indicating whether to send the user a notification when funds are received into one of their accounts" }, "notifyOnFundsSent": { "type": "boolean", "description": "value indicating whether to send the user a notification when funds are sent from one of their accounts" }, "language": { "type": "string", "description": "the language code for the user (e.g. 'EN' or 'EN-US')", "nullable": true } }, "additionalProperties": false }, "ChangeUserPreferencesRequestDto": { "type": "object", "properties": { "nativeCurrencyId": { "type": "string", "description": "the users native currency id, api calls will return monetary amounts in this currency along with the\r\noriginal currencies.  If not specified then the current preference will not be updated.", "nullable": true, "example": "1235" }, "notifyOnFundsReceived": { "type": "boolean", "description": "optional value indicating whether to send the user a notification when funds are received into one of,\r\ntheir accounts.  If not specified then the current preference will not be updated.", "nullable": true }, "notifyOnFundsSent": { "type": "boolean", "description": "optional value indicating whether to send the user a notification when funds are sent from one of their\r\naccounts.  If not specified then the current preference will not be updated.", "nullable": true }, "language": { "maxLength": 5, "minLength": 2, "type": "string", "description": "optional language code for the user (e.g. 'EN' or 'EN-US')", "nullable": true } }, "additionalProperties": false }, "RateDto": { "type": "object", "properties": { "baseCurrencyId": { "type": "integer", "description": "the currency code of the source/base currency", "format": "int32", "example": 123 }, "baseToken": { "type": "string", "description": "the contract address of the source/base token on the base currency platform", "nullable": true }, "quoteCurrencyId": { "type": "integer", "description": "the currency code of the target/quoted currency", "format": "int32", "example": 456 }, "quoteToken": { "type": "string", "description": "the contract address of the target/quoted token on the quoted currency platform", "nullable": true }, "rate": { "type": "string", "description": "the conversion rate to convert from `BaseCurrencyId` into `QuoteCurrencyId`", "nullable": true, "example": "0.011488196994190" } }, "additionalProperties": false, "description": "Conversion rate between two currencies" }, "RatesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RateDto" }, "nullable": true } }, "additionalProperties": false }, "ReportRequest": { "type": "object", "properties": { "txTypes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UserSettingsDto": { "required": ["key", "value"], "type": "object", "properties": { "key": { "maxLength": 95, "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "SmartContract": { "type": "object", "properties": { "currencyId": { "type": "integer", "format": "int32" }, "contractAddress": { "type": "string", "nullable": true }, "contractName": { "type": "string", "nullable": true }, "contractSymbol": { "type": "string", "nullable": true }, "isVerified": { "type": "boolean" }, "decimals": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TopUpOrderStatus": { "enum": ["new", "placed", "pending", "completed", "cancelled", "failed"], "type": "string" }, "TopUpOrderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the top up order", "nullable": true }, "created": { "type": "string", "description": "Time when the top up order was created", "format": "date-time" }, "blockchainTxId": { "type": "string", "description": "The blockchain transaction ID (hash)", "nullable": true }, "purchaseAmount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "The amount used to purchase crypto", "nullable": true }, "status": { "allOf": [{ "$ref": "#/components/schemas/TopUpOrderStatus" }], "description": "The status of the order" }, "coinReceived": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "The amount received or will be received in the purchased crypto", "nullable": true } }, "additionalProperties": false, "description": "Represents a top up order (crypto purchase)" }, "TopUpOrdersDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopUpOrderDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "TopUpProviderCurrencyDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "the unique id of the currency on the CoinPayments platform", "format": "int32", "example": 1235 }, "symbol": { "type": "string", "description": "ticker symbol for the currency.  For fiat currencies this is the three character (ISO-4217) currency code,\r\nand for crypto currencies their multi-character symbol.", "nullable": true, "example": "BTC" } }, "additionalProperties": false, "description": "Represents the currencies that can be purchased through a provider" }, "TopUpProviderDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the provider", "nullable": true }, "logoUrl": { "type": "string", "description": "the url to the logo of the provider", "nullable": true }, "currenciesCanPurchase": { "type": "array", "items": { "$ref": "#/components/schemas/TopUpProviderCurrencyDto" }, "description": "the currencies that can be purchased through this provider", "nullable": true } }, "additionalProperties": false, "description": "Represents details of a topup provider" }, "TopUpProvidersDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopUpProviderDto" }, "nullable": true } }, "additionalProperties": false }, "TransactionState": { "enum": ["created", "pending", "completed"], "type": "string" }, "TransactionInputOutputDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the amount in the original currency", "nullable": true }, "nativeAmount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the amount in the native currency of the user (rate at time of transaction)", "nullable": true }, "coinPaymentsFee": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the fee charged by CoinPayments on this side of the transaction", "nullable": true } }, "additionalProperties": false, "description": "Details of the input/output (origin/receiver) of a transaction" }, "TransactionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the unique id of the transaction on the CoinPayments® platform", "nullable": true }, "created": { "type": "string", "description": "timestamp when the transaction was created", "format": "date-time", "nullable": true, "example": "04/23/2018 18:25:43 +00:00" }, "completed": { "type": "string", "description": "timestamp when the transaction was completed/confirmed", "format": "date-time", "nullable": true, "example": "04/23/2018 18:25:43 +00:00" }, "state": { "allOf": [{ "$ref": "#/components/schemas/TransactionState" }], "description": "the state of the transaction" }, "memo": { "type": "string", "description": "the user's custom memo for this transaction", "nullable": true }, "from": { "allOf": [{ "$ref": "#/components/schemas/TransactionInputOutputDto" }], "description": "the input for the transaction, origin of where the funds came from", "nullable": true }, "to": { "allOf": [{ "$ref": "#/components/schemas/TransactionInputOutputDto" }], "description": "the output for the transaction, receiver of the funds, where funds were sent", "nullable": true }, "transactionType": { "type": "integer", "description": "Type of the transaction", "format": "int32" }, "contractAddress": { "type": "string", "description": "Source contract address for token transfers of account-based currencies like ERC20 for ETH", "nullable": true }, "toContractAddress": { "type": "string", "description": "Destination contract address for token transfers of account-based currencies like ERC20 for ETH", "nullable": true }, "conversionId": { "type": "integer", "description": "Id of the conversion corresponding to this transaction in the coinflip service", "format": "int64", "nullable": true } }, "additionalProperties": false, "description": "Transactions represent an event on one or more accounts (e.g. debit, withdrawal, transfer or conversion)" }, "TransactionDtoPagedItemsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "TransactionHistoryEventDto": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "the timestamp of when the this event was observed", "format": "date-time" }, "eventType": { "type": "string", "description": "the type of event that was observed", "nullable": true }, "data": { "type": "object", "additionalProperties": false, "description": "optional custom data for the event", "nullable": true } }, "additionalProperties": false }, "TransactionHistoryEventsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionHistoryEventDto" }, "nullable": true } }, "additionalProperties": false }, "ChangeTransactionMemoRequestDto": { "type": "object", "properties": { "memo": { "type": "string", "description": "The new memo for the transaction", "nullable": true } }, "additionalProperties": false, "description": "Request to change the memo of a transaction" }, "TransactedVolumeDto": { "type": "object", "properties": { "volume": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total value of incoming and outgoing transactions", "nullable": true }, "limit": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "The maximum volume a user can reach before KYC is required", "nullable": true } }, "additionalProperties": false, "description": "Represents a user's transacted volume" }, "UserFeaturesDto": { "type": "object", "properties": { "topUp": { "type": "boolean", "description": "Indicates whether top up feature is available to user" } }, "additionalProperties": false, "description": "Represents specific features that are available or not available to certain users\r\n(for example, a feature will not be available to a user depending on which country they KYC'ed from)" }, "UserNotificationType": { "enum": ["warning", "news", "promotion"], "type": "string" }, "UserNotificationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the id of the notification", "nullable": true }, "heading": { "type": "string", "description": "the heading of the notification", "nullable": true }, "body": { "type": "string", "description": "the body of the notification", "nullable": true }, "actionUrl": { "type": "string", "description": "link to go view more information about the notification or to take some action", "nullable": true }, "actionName": { "type": "string", "description": "the name to give the action (e.g. such as a button to go to the Orion.Api.Models.UserNotificationDto.ActionUrl)", "nullable": true }, "type": { "allOf": [{ "$ref": "#/components/schemas/UserNotificationType" }], "description": "the type of the notification" }, "publishedDate": { "type": "string", "description": "The date the notification started showing (was published)", "format": "date-time" }, "isRead": { "type": "boolean", "description": "indicates whether notification has been read by the user" } }, "additionalProperties": false, "description": "Active notification on a user's dashboard" }, "UserNotificationsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "implicit": { "authorizationUrl": "https://alpha-signin.coinpayments.net/connect/authorize", "scopes": { "orion": "Access to coinpayments apis" } } } } } } } }, "searchIndex": { "store": ["section/Authentication", "tag/Accounts", "tag/Accounts/paths/~1api~1v1~1accounts~1balances/get", "tag/Accounts/paths/~1api~1v1~1accounts/get", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1addresses/get", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1addresses/post", "operation/GetAccountAddress", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1label/put", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1addresses~1{addressId}~1label/put", "operation/GetAccount", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}/delete", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1keys/put", "tag/Accounts/paths/~1api~1v1~1accounts~1fee~1{masterKeyId}~1{currencyId}/get", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend~1validate/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend~1all~1validate/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend~1all/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1convert/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend~1{spendRequestId}~1broadcast/post", "tag/Accounts/paths/~1api~1v1~1accounts~1multisig/post", "tag/Accounts/paths/~1api~1v1~1accounts~1singlesig/post", "tag/Affiliate", "tag/Affiliate/paths/~1api~1v1~1affiliate~1channels/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1channels/post", "operation/FindChannel", "tag/Affiliate/paths/~1api~1v1~1affiliate~1channels~1{id}/put", "tag/Affiliate/paths/~1api~1v1~1affiliate/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1fees/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1earnings/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1earnings~1summary/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1impressions~1daily/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1impressions~1country/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1impressions/get", "tag/Currencies", "tag/Currencies/paths/~1api~1v1~1currencies/get", "tag/Currencies/paths/~1api~1v1~1currencies~1{id}/get", "tag/Currencies/paths/~1api~1v1~1currencies~1conversions/get", "tag/Invoices", "tag/Invoices/paths/~1api~1v1~1invoices/post", "tag/Invoices/paths/~1api~1v1~1invoices~1{id}/put", "tag/Invoices/paths/~1api~1v1~1invoices~1{id}/get", "tag/MasterKeys", "operation/GetMasterKey", "tag/MasterKeys/paths/~1api~1v1~1masterkeys~1{id}/put", "tag/MasterKeys/paths/~1api~1v1~1masterkeys/get", "tag/MasterKeys/paths/~1api~1v1~1masterkeys/post", "tag/MasterKeys/paths/~1api~1v1~1masterkeys~1{id}~1activate/post", "tag/Merchant", "tag/Merchant/paths/~1api~1v1~1merchant/post", "tag/Merchant/paths/~1api~1v1~1merchant~1profile/get", "tag/Merchant/paths/~1api~1v1~1merchant~1profile/put", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies/get", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies~1{id}/post", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies~1{id}/put", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies~1{id}/delete", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies~1{id}~1order/put", "tag/Merchant/paths/~1api~1v1~1merchant~1logo/post", "tag/Merchant/paths/~1api~1v1~1merchant~1logo/delete", "tag/MerchantCallbacks", "tag/MerchantCallbacks/paths/~1api~1v1~1merchant~1callbacks/post", "tag/MerchantCallbacks/paths/~1api~1v1~1merchant~1callbacks/get", "operation/FindCallbackAddress", "tag/MerchantCallbacks/paths/~1api~1v1~1merchant~1callbacks~1{id}/put", "tag/MerchantCallbacks/paths/~1api~1v1~1merchant~1callbacks~1deposits/get", "tag/MerchantClients", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients/get", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients/post", "operation/FindClientAsync", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}/put", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}/delete", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}~1secret/post", "operation/ListWebhooksForClientAsync", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}~1webhooks/post", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}~1webhooks~1{webhookId}/put", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}~1webhooks~1{webhookId}/delete", "tag/MerchantInvoices", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1buy-now-button/post", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1nextid/post", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices/get", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices/post", "operation/FindInvoiceAsync", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}/put", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}~1history/get", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}~1cancel/post", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}~1delete/delete", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}~1payouts/get", "tag/Preferences", "tag/Preferences/paths/~1api~1v1~1preferences/get", "tag/Preferences/paths/~1api~1v1~1preferences/put", "tag/Rates", "tag/Rates/paths/~1api~1v1~1rates/get", "tag/Reports", "tag/Reports/paths/~1api~1v1~1reports/post", "tag/Settings", "tag/Settings/paths/~1api~1v1~1settings/post", "tag/Settings/paths/~1api~1v1~1settings/put", "tag/Settings/paths/~1api~1v1~1settings~1{key}/get", "tag/SharedInvoices", "tag/SharedInvoices/paths/~1api~1v1~1shared-invoices~1{sharedInvoiceId}/get", "tag/SmartContracts", "tag/SmartContracts/paths/~1api~1v1~1smartcontracts~1{currencyId}/get", "tag/SmartContracts/paths/~1api~1v1~1smartcontracts~1{currencyId}~1{contractsAddress}/get", "tag/TopUps", "tag/TopUps/paths/~1api~1v1~1topups~1orders/get", "tag/TopUps/paths/~1api~1v1~1topups~1providers/get", "tag/Transactions", "tag/Transactions/paths/~1api~1v1~1transactions/get", "tag/Transactions/paths/~1api~1v1~1transactions~1{id}/get", "tag/Transactions/paths/~1api~1v1~1transactions~1{id}~1events/get", "tag/Transactions/paths/~1api~1v1~1transactions~1{id}~1memo/put", "tag/Transactions/paths/~1api~1v1~1transactions~1volume/get", "tag/User", "tag/User/paths/~1api~1v1~1user~1features/get", "tag/UserNotifications", "tag/UserNotifications/paths/~1api~1v1~1notifications/get", "tag/UserNotifications/paths/~1api~1v1~1notifications~1{id}~1read/post"], "index": { "version": "2.3.8", "fields": ["title", "description"], "fieldVectors": [["title/0", [0, 6.398]], ["description/0", [1, 3.382, 2, 2.053, 3, 2.053]], ["title/1", [4, 2.877]], ["description/1", []], ["title/2", [4, 1.732, 5, 1.347, 6, 2.555, 7, 3.851, 8, 3.851, 9, 1.68]], ["description/2", []], ["title/3", [4, 2.06, 5, 1.602, 6, 3.039, 10, 3.69]], ["description/3", [4, 0.67, 6, 0.368, 9, 0.242, 11, 0.389, 12, 0.489, 13, 0.554, 14, 0.554, 15, 0.554, 16, 0.554, 17, 0.489, 18, 0.554, 19, 0.844, 20, 0.489, 21, 0.554, 22, 0.489, 23, 0.554]], ["title/4", [4, 1.494, 5, 1.162, 24, 1.915, 25, 2.676, 26, 1.839, 27, 2.095, 28, 2.933, 29, 2.485]], ["description/4", []], ["title/5", [4, 1.732, 26, 2.131, 30, 2.051, 31, 1.68, 32, 1.68, 33, 1.977]], ["description/5", []], ["title/6", [26, 3.224, 34, 2.228, 35, 2.316, 36, 3.694]], ["description/6", []], ["title/7", [4, 1.881, 30, 2.228, 31, 1.825, 37, 3.129, 38, 3.371]], ["description/7", []], ["title/8", [26, 2.316, 30, 2.228, 31, 1.825, 37, 3.129, 38, 3.371]], ["description/8", []], ["title/9", [4, 2.275, 34, 2.694, 35, 2.8]], ["description/9", []], ["title/10", [4, 1.732, 6, 2.555, 30, 2.051, 31, 1.68, 39, 2.555, 40, 3.4]], ["description/10", []], ["title/11", [4, 1.768, 24, 1.425, 30, 1.317, 31, 1.079, 37, 1.85, 41, 2.183, 42, 1.949, 43, 1.226, 44, 1.489, 45, 2.473, 46, 2.473]], ["description/11", []], ["title/12", [47, 3.851]], ["description/12", []], ["title/13", [4, 1.881, 31, 1.825, 48, 3.129, 49, 3.129, 50, 3.371]], ["description/13", []], ["title/14", [4, 1.881, 31, 1.825, 48, 3.129, 49, 3.129, 50, 3.371]], ["description/14", []], ["title/15", [4, 1.881, 30, 2.228, 31, 1.825, 49, 3.129, 50, 3.371]], ["description/15", [4, 0.352, 29, 0.585, 31, 0.341, 51, 1.447, 52, 0.783, 53, 1.447, 54, 0.783, 55, 0.691, 56, 0.783, 57, 0.783, 58, 0.691]], ["title/16", [47, 3.851]], ["description/16", []], ["title/17", [47, 3.851]], ["description/17", []], ["title/18", [31, 1.68, 43, 1.909, 49, 2.88, 59, 3.851, 60, 3.4, 61, 3.4]], ["description/18", [31, 0.43, 36, 0.871, 44, 0.594, 48, 0.737, 60, 0.871, 61, 0.871, 62, 1.788, 63, 0.986, 64, 0.871]], ["title/19", [4, 1.604, 6, 2.367, 30, 1.9, 31, 1.556, 32, 1.556, 33, 1.831, 65, 3.567]], ["description/19", []], ["title/20", [4, 1.604, 6, 2.367, 30, 1.9, 31, 1.556, 32, 1.556, 33, 1.831, 40, 3.149]], ["description/20", []], ["title/21", [66, 4.034]], ["description/21", []], ["title/22", [5, 1.602, 32, 1.998, 66, 2.889, 67, 2.757]], ["description/22", []], ["title/23", [32, 2.207, 33, 2.597, 67, 3.045]], ["description/23", []], ["title/24", [34, 2.694, 35, 2.8, 67, 3.045]], ["description/24", []], ["title/25", [42, 2.508, 67, 3.045, 68, 4.467]], ["description/25", []], ["title/26", [66, 3.191, 69, 3.191, 70, 4.467]], ["description/26", []], ["title/27", [66, 2.095, 69, 2.095, 71, 3.322, 72, 3.322, 73, 3.322, 74, 2.676, 75, 3.322, 76, 2.676]], ["description/27", []], ["title/28", [5, 1.162, 66, 2.095, 67, 2, 74, 2.676, 77, 2.204, 78, 2.332, 79, 2.485, 80, 2.933]], ["description/28", []], ["title/29", [47, 3.401, 74, 4.552]], ["description/29", []], ["title/30", [5, 1.022, 66, 1.842, 67, 1.758, 77, 1.938, 78, 2.05, 79, 2.185, 81, 2.353, 82, 2.05, 83, 2.921, 84, 2.353]], ["description/30", []], ["title/31", [5, 1.022, 66, 1.842, 67, 1.758, 77, 1.938, 78, 2.05, 79, 2.185, 81, 2.353, 82, 2.05, 84, 2.353, 85, 2.921]], ["description/31", []], ["title/32", [5, 1.162, 67, 2, 77, 2.204, 78, 2.332, 79, 2.485, 81, 2.676, 84, 2.676, 86, 2.933]], ["description/32", []], ["title/33", [9, 2.79]], ["description/33", []], ["title/34", [5, 1.463, 9, 1.825, 76, 3.371, 87, 3.694, 88, 4.185]], ["description/34", [9, 0.43, 11, 0.692, 12, 0.871, 27, 0.622, 76, 0.794, 87, 0.871, 89, 1.788, 90, 0.986, 91, 0.737]], ["title/35", [9, 2.207, 34, 2.694, 35, 2.8]], ["description/35", []], ["title/36", [5, 1.463, 9, 1.825, 69, 2.639, 82, 2.937, 92, 4.185]], ["description/36", []], ["title/37", [93, 2.968]], ["description/37", []], ["title/38", [32, 2.207, 33, 2.597, 93, 2.348]], ["description/38", []], ["title/39", [31, 1.68, 42, 1.909, 70, 3.4, 93, 1.787, 94, 2.88, 95, 1.732]], ["description/39", []], ["title/40", [34, 2.694, 35, 2.8, 93, 2.348]], ["description/40", []], ["title/41", [96, 5.648]], ["description/41", []], ["title/42", [34, 2.439, 35, 2.535, 44, 2.757, 97, 3.039]], ["description/42", []], ["title/43", [38, 2.676, 42, 1.647, 43, 1.647, 44, 2.97, 97, 2.204, 98, 3.322, 99, 3.322]], ["description/43", []], ["title/44", [5, 1.347, 24, 2.22, 32, 1.68, 44, 2.318, 97, 2.555, 100, 2.88]], ["description/44", [17, 1.332, 19, 1.216, 32, 0.658, 44, 0.908, 64, 1.332, 97, 1.001]], ["title/45", [30, 2.228, 31, 1.825, 32, 1.825, 33, 2.148, 96, 3.694]], ["description/45", [19, 1.073, 32, 0.581, 33, 0.684, 44, 0.802, 55, 1.176, 97, 0.884, 100, 0.996]], ["title/46", [44, 3.045, 97, 3.357, 100, 3.784]], ["description/46", []], ["title/47", [95, 2.877]], ["description/47", []], ["title/48", [24, 2.412, 32, 1.825, 95, 1.881, 101, 3.371, 102, 4.185]], ["description/48", []], ["title/49", [95, 2.275, 101, 4.076, 103, 3.357]], ["description/49", []], ["title/50", [42, 2.271, 95, 2.06, 101, 3.69, 103, 3.039]], ["description/50", []], ["title/51", [5, 0.963, 9, 1.866, 11, 1.933, 27, 1.737, 69, 1.737, 91, 2.06, 103, 1.828, 104, 2.432, 105, 2.219, 106, 2.219]], ["description/51", []], ["title/52", [9, 1.556, 41, 3.149, 94, 2.668, 95, 1.604, 107, 2.874, 108, 2.874, 109, 2.504]], ["description/52", []], ["title/53", [9, 1.556, 42, 1.768, 94, 2.668, 95, 1.604, 107, 2.874, 108, 2.874, 109, 2.504]], ["description/53", []], ["title/54", [9, 1.68, 39, 2.555, 95, 1.732, 105, 3.102, 107, 3.102, 110, 3.4]], ["description/54", []], ["title/55", [9, 1.425, 11, 1.382, 27, 2.641, 42, 1.62, 91, 2.444, 105, 1.587, 109, 1.382, 111, 1.739, 112, 1.97, 113, 1.97, 114, 1.739, 115, 1.739, 116, 1.739]], ["description/55", [33, 0.28, 42, 0.139, 91, 0.94, 95, 0.358, 111, 0.248, 114, 0.248, 116, 0.248, 117, 0.281, 118, 1.257, 119, 1.032, 120, 1.032, 121, 0.796, 122, 0.546, 123, 1.032, 124, 0.546]], ["title/56", [95, 2.275, 125, 5.06, 126, 4.467]], ["description/56", []], ["title/57", [39, 3.357, 95, 2.275, 126, 4.467]], ["description/57", []], ["title/58", [127, 6.398]], ["description/58", []], ["title/59", [26, 2.535, 32, 1.998, 33, 2.351, 128, 3.215]], ["description/59", []], ["title/60", [5, 1.248, 26, 1.974, 128, 2.504, 129, 3.149, 130, 3.567, 131, 3.567, 132, 2.874]], ["description/60", []], ["title/61", [26, 2.535, 34, 2.439, 35, 2.535, 128, 3.215]], ["description/61", []], ["title/62", [26, 2.8, 42, 2.508, 128, 3.551]], ["description/62", []], ["title/63", [5, 0.823, 9, 1.026, 25, 1.895, 26, 2.091, 27, 1.484, 28, 2.077, 29, 1.76, 77, 1.561, 78, 1.651, 80, 2.077, 128, 1.651, 132, 1.895, 133, 1.416]], ["description/63", []], ["title/64", [134, 6.398]], ["description/64", []], ["title/65", [43, 2.508, 95, 2.275, 135, 3.784]], ["description/65", []], ["title/66", [32, 1.825, 33, 2.148, 43, 2.074, 95, 1.881, 135, 3.129]], ["description/66", []], ["title/67", [34, 2.694, 43, 2.508, 136, 5.06]], ["description/67", []], ["title/68", [42, 2.074, 43, 2.074, 95, 1.881, 135, 3.129, 137, 3.129]], ["description/68", []], ["title/69", [39, 3.357, 43, 2.508, 137, 3.784]], ["description/69", []], ["title/70", [43, 1.541, 48, 2.325, 110, 2.744, 138, 3.109, 139, 4.695, 140, 3.109, 141, 3.109, 142, 3.109]], ["description/70", []], ["title/71", [5, 1.602, 43, 2.271, 143, 3.426, 144, 4.044]], ["description/71", []], ["title/72", [32, 1.998, 33, 2.351, 43, 2.271, 143, 3.426]], ["description/72", []], ["title/73", [42, 2.271, 43, 2.271, 137, 3.426, 143, 3.426]], ["description/73", []], ["title/74", [39, 3.357, 43, 2.508, 143, 3.784]], ["description/74", []], ["title/75", [145, 6.398]], ["description/75", []], ["title/76", [32, 1.68, 93, 1.787, 109, 2.703, 146, 3.851, 147, 3.851, 148, 3.4]], ["description/76", []], ["title/77", [93, 2.125, 149, 4.581, 150, 4.581, 151, 4.581]], ["description/77", []], ["title/78", [5, 1.602, 93, 2.125, 103, 3.039, 104, 4.044]], ["description/78", []], ["title/79", [32, 2.207, 33, 2.597, 93, 2.348]], ["description/79", []], ["title/80", [34, 2.051, 35, 2.131, 93, 2.549, 95, 1.732, 135, 2.88]], ["description/80", []], ["title/81", [42, 2.074, 93, 1.941, 137, 3.129, 152, 3.694, 153, 4.185]], ["description/81", []], ["title/82", [5, 1.347, 35, 2.131, 93, 2.549, 154, 3.4, 155, 3.4]], ["description/82", []], ["title/83", [93, 2.622, 156, 5.651]], ["description/83", []], ["title/84", [39, 3.039, 93, 2.125, 152, 4.044, 157, 4.581]], ["description/84", []], ["title/85", [9, 0.859, 20, 1.739, 25, 1.587, 26, 1.09, 58, 1.739, 68, 1.739, 93, 1.516, 94, 1.473, 108, 1.587, 109, 1.382, 158, 3.268, 159, 1.97, 160, 1.97, 161, 1.97, 162, 1.97, 163, 1.97]], ["description/85", []], ["title/86", [164, 4.785]], ["description/86", []], ["title/87", [24, 2.916, 69, 3.191, 164, 3.784]], ["description/87", []], ["title/88", [24, 2.412, 30, 2.228, 31, 1.825, 42, 2.074, 164, 3.129]], ["description/88", []], ["title/89", [165, 5.154]], ["description/89", []], ["title/90", [5, 1.347, 9, 1.68, 82, 2.703, 103, 2.555, 165, 3.102, 166, 3.851]], ["description/90", [9, 1.153, 11, 0.758, 82, 0.758, 148, 1.713, 165, 0.87, 167, 1.08]], ["title/91", [168, 6.398]], ["description/91", []], ["title/92", [47, 3.851]], ["description/92", []], ["title/93", [169, 5.648]], ["description/93", []], ["title/94", [47, 3.851]], ["description/94", []], ["title/95", [47, 3.851]], ["description/95", []], ["title/96", [47, 3.851]], ["description/96", []], ["title/97", [170, 6.398]], ["description/97", []], ["title/98", [22, 4.044, 34, 2.439, 93, 2.125, 95, 2.06]], ["description/98", []], ["title/99", [171, 6.398]], ["description/99", []], ["title/100", [5, 1.347, 172, 3.4, 173, 3.4, 174, 3.4, 175, 3.4, 176, 3.102]], ["description/100", []], ["title/101", [5, 1.347, 172, 3.4, 173, 3.4, 174, 3.4, 175, 3.4, 176, 3.102]], ["description/101", []], ["title/102", [177, 6.398]], ["description/102", []], ["title/103", [10, 3.102, 27, 2.429, 69, 2.429, 106, 3.102, 154, 3.4, 178, 3.4]], ["description/103", []], ["title/104", [5, 1.087, 24, 1.792, 27, 1.96, 69, 1.96, 106, 2.504, 178, 2.744, 179, 3.109, 180, 2.744, 181, 3.109]], ["description/104", []], ["title/105", [133, 3.851]], ["description/105", []], ["title/106", [5, 1.976, 133, 3.401]], ["description/106", [5, 0.466, 29, 0.996, 32, 0.581, 129, 1.176, 132, 1.073, 133, 0.802, 182, 1.332]], ["title/107", [34, 2.694, 35, 2.8, 133, 3.045]], ["description/107", []], ["title/108", [5, 1.769, 133, 3.045, 155, 4.467]], ["description/108", []], ["title/109", [30, 2.228, 31, 1.825, 37, 3.129, 133, 2.518, 183, 4.185]], ["description/109", []], ["title/110", [9, 0.825, 10, 2.546, 77, 1.256, 86, 1.671, 103, 1.256, 115, 1.671, 133, 1.903, 164, 1.415, 169, 1.671, 176, 1.525, 184, 1.893, 185, 3.161, 186, 1.893, 187, 1.893, 188, 1.893, 189, 1.893]], ["description/110", []], ["title/111", [24, 3.687]], ["description/111", []], ["title/112", [24, 2.844, 144, 2.933, 180, 4.356, 190, 3.322, 191, 3.322, 192, 3.322]], ["description/112", []], ["title/113", [193, 6.398]], ["description/113", []], ["title/114", [5, 1.769, 100, 3.784, 194, 4.467]], ["description/114", []], ["title/115", [194, 4.467, 195, 5.06, 196, 5.06]], ["description/115", []]], "invertedIndex": [["", { "_index": 1, "title": {}, "description": { "0": {} } }], ["0", { "_index": 116, "title": { "55": {} }, "description": { "55": {} } }], ["1", { "_index": 118, "title": {}, "description": { "55": {} } }], ["2", { "_index": 120, "title": {}, "description": { "55": {} } }], ["3", { "_index": 122, "title": {}, "description": { "55": {} } }], ["accept", { "_index": 105, "title": { "51": {}, "54": {}, "55": {} }, "description": {} }], ["access", { "_index": 15, "title": {}, "description": { "3": {} } }], ["account", { "_index": 4, "title": { "1": {}, "2": {}, "3": {}, "4": {}, "5": {}, "7": {}, "9": {}, "10": {}, "11": {}, "13": {}, "14": {}, "15": {}, "19": {}, "20": {} }, "description": { "3": {}, "15": {} } }], ["activ", { "_index": 100, "title": { "44": {}, "46": {}, "114": {} }, "description": { "45": {} } }], ["actual", { "_index": 57, "title": {}, "description": { "15": {} } }], ["add", { "_index": 41, "title": { "11": {}, "52": {} }, "description": {} }], ["address", { "_index": 26, "title": { "4": {}, "5": {}, "6": {}, "8": {}, "59": {}, "60": {}, "61": {}, "62": {}, "63": {}, "85": {} }, "description": {} }], ["administr", { "_index": 54, "title": {}, "description": { "15": {} } }], ["affili", { "_index": 66, "title": { "21": {}, "22": {}, "26": {}, "27": {}, "28": {}, "30": {}, "31": {} }, "description": {} }], ["amount", { "_index": 162, "title": { "85": {} }, "description": {} }], ["api", { "_index": 142, "title": { "70": {} }, "description": {} }], ["approv", { "_index": 51, "title": {}, "description": { "15": {} } }], ["authent", { "_index": 0, "title": { "0": {} }, "description": {} }], ["author", { "_index": 13, "title": {}, "description": { "3": {} } }], ["avail", { "_index": 180, "title": { "104": {}, "112": {} }, "description": {} }], ["balanc", { "_index": 7, "title": { "2": {} }, "description": {} }], ["befor", { "_index": 55, "title": {}, "description": { "15": {}, "45": {} } }], ["belong", { "_index": 135, "title": { "65": {}, "66": {}, "68": {}, "80": {} }, "description": {} }], ["between", { "_index": 166, "title": { "90": {} }, "description": {} }], ["bitcoin", { "_index": 119, "title": {}, "description": { "55": {} } }], ["broadcast", { "_index": 61, "title": { "18": {} }, "description": { "18": {} } }], ["button", { "_index": 146, "title": { "76": {} }, "description": {} }], ["buyer", { "_index": 94, "title": { "39": {}, "52": {}, "53": {}, "85": {} }, "description": {} }], ["callback", { "_index": 128, "title": { "59": {}, "60": {}, "61": {}, "62": {}, "63": {} }, "description": {} }], ["cancel", { "_index": 156, "title": { "83": {} }, "description": {} }], ["capabl", { "_index": 88, "title": { "34": {} }, "description": {} }], ["certain", { "_index": 192, "title": { "112": {} }, "description": {} }], ["chang", { "_index": 37, "title": { "7": {}, "8": {}, "11": {}, "109": {} }, "description": {} }], ["channel", { "_index": 67, "title": { "22": {}, "23": {}, "24": {}, "25": {}, "28": {}, "30": {}, "31": {}, "32": {} }, "description": {} }], ["client", { "_index": 43, "title": { "11": {}, "18": {}, "43": {}, "65": {}, "66": {}, "67": {}, "68": {}, "69": {}, "70": {}, "71": {}, "72": {}, "73": {}, "74": {} }, "description": {} }], ["clientid", { "_index": 136, "title": { "67": {} }, "description": {} }], ["co-sign", { "_index": 63, "title": {}, "description": { "18": {} } }], ["code", { "_index": 147, "title": { "76": {} }, "description": {} }], ["coin", { "_index": 111, "title": { "55": {} }, "description": { "55": {} } }], ["coinpay", { "_index": 75, "title": { "27": {} }, "description": {} }], ["coinpayments.net", { "_index": 89, "title": {}, "description": { "34": {} } }], ["commiss", { "_index": 71, "title": { "27": {} }, "description": {} }], ["commun", { "_index": 141, "title": { "70": {} }, "description": {} }], ["consum", { "_index": 14, "title": {}, "description": { "3": {} } }], ["contract", { "_index": 173, "title": { "100": {}, "101": {} }, "description": {} }], ["convers", { "_index": 82, "title": { "30": {}, "31": {}, "36": {}, "90": {} }, "description": { "90": {} } }], ["convert", { "_index": 167, "title": {}, "description": { "90": {} } }], ["correct", { "_index": 113, "title": { "55": {} }, "description": {} }], ["countri", { "_index": 85, "title": { "31": {} }, "description": {} }], ["creat", { "_index": 32, "title": { "5": {}, "19": {}, "20": {}, "22": {}, "23": {}, "38": {}, "44": {}, "45": {}, "48": {}, "59": {}, "66": {}, "72": {}, "76": {}, "79": {} }, "description": { "44": {}, "45": {}, "106": {} } }], ["creation", { "_index": 131, "title": { "60": {} }, "description": {} }], ["crypto", { "_index": 17, "title": {}, "description": { "3": {}, "44": {} } }], ["currenc", { "_index": 9, "title": { "2": {}, "33": {}, "34": {}, "35": {}, "36": {}, "51": {}, "52": {}, "53": {}, "54": {}, "55": {}, "63": {}, "85": {}, "90": {}, "110": {} }, "description": { "3": {}, "34": {}, "90": {} } }], ["current", { "_index": 103, "title": { "49": {}, "50": {}, "51": {}, "78": {}, "90": {}, "110": {} }, "description": {} }], ["date", { "_index": 132, "title": { "60": {}, "63": {} }, "description": { "106": {} } }], ["day", { "_index": 83, "title": { "30": {} }, "description": {} }], ["default", { "_index": 90, "title": {}, "description": { "34": {} } }], ["delet", { "_index": 39, "title": { "10": {}, "54": {}, "57": {}, "69": {}, "74": {}, "84": {} }, "description": {} }], ["deposit", { "_index": 25, "title": { "4": {}, "63": {}, "85": {} }, "description": {} }], ["descend", { "_index": 130, "title": { "60": {} }, "description": {} }], ["detail", { "_index": 68, "title": { "25": {}, "85": {} }, "description": {} }], ["draft", { "_index": 152, "title": { "81": {}, "84": {} }, "description": {} }], ["earn", { "_index": 74, "title": { "27": {}, "28": {}, "29": {} }, "description": {} }], ["encrypt", { "_index": 98, "title": { "43": {} }, "description": {} }], ["erc20", { "_index": 174, "title": { "100": {}, "101": {} }, "description": {} }], ["ethereum", { "_index": 123, "title": {}, "description": { "55": {} } }], ["event", { "_index": 155, "title": { "82": {}, "108": {} }, "description": {} }], ["exact", { "_index": 161, "title": { "85": {} }, "description": {} }], ["exampl", { "_index": 117, "title": {}, "description": { "55": {} } }], ["exist", { "_index": 137, "title": { "68": {}, "69": {}, "73": {}, "81": {} }, "description": {} }], ["featur", { "_index": 191, "title": { "112": {} }, "description": {} }], ["fee", { "_index": 72, "title": { "27": {} }, "description": {} }], ["fiat", { "_index": 23, "title": {}, "description": { "3": {} } }], ["filter", { "_index": 78, "title": { "28": {}, "30": {}, "31": {}, "32": {}, "63": {} }, "description": {} }], ["financi", { "_index": 6, "title": { "2": {}, "3": {}, "10": {}, "19": {}, "20": {} }, "description": { "3": {} } }], ["find", { "_index": 34, "title": { "6": {}, "9": {}, "24": {}, "35": {}, "40": {}, "42": {}, "61": {}, "67": {}, "80": {}, "98": {}, "107": {} }, "description": {} }], ["first", { "_index": 29, "title": { "4": {}, "63": {} }, "description": { "15": {}, "106": {} } }], ["fulli", { "_index": 159, "title": { "85": {} }, "description": {} }], ["fund", { "_index": 50, "title": { "13": {}, "14": {}, "15": {} }, "description": {} }], ["gener", { "_index": 149, "title": { "77": {} }, "description": {} }], ["get", { "_index": 69, "title": { "26": {}, "27": {}, "36": {}, "51": {}, "87": {}, "103": {}, "104": {} }, "description": {} }], ["group", { "_index": 8, "title": { "2": {} }, "description": {} }], ["happen", { "_index": 45, "title": { "11": {} }, "description": {} }], ["histori", { "_index": 154, "title": { "82": {}, "103": {} }, "description": {} }], ["id", { "_index": 35, "title": { "6": {}, "9": {}, "24": {}, "35": {}, "40": {}, "42": {}, "61": {}, "80": {}, "82": {}, "107": {} }, "description": {} }], ["impress", { "_index": 81, "title": { "30": {}, "31": {}, "32": {} }, "description": {} }], ["includ", { "_index": 20, "title": { "85": {} }, "description": { "3": {} } }], ["incom", { "_index": 187, "title": { "110": {} }, "description": {} }], ["indic", { "_index": 190, "title": { "112": {} }, "description": {} }], ["inform", { "_index": 70, "title": { "26": {}, "39": {} }, "description": {} }], ["invoic", { "_index": 93, "title": { "37": {}, "38": {}, "39": {}, "40": {}, "76": {}, "77": {}, "78": {}, "79": {}, "80": {}, "81": {}, "82": {}, "83": {}, "84": {}, "85": {}, "98": {} }, "description": {} }], ["it'", { "_index": 56, "title": {}, "description": { "15": {} } }], ["key", { "_index": 44, "title": { "11": {}, "42": {}, "43": {}, "44": {}, "46": {} }, "description": { "18": {}, "44": {}, "45": {} } }], ["known", { "_index": 175, "title": { "100": {}, "101": {} }, "description": {} }], ["label", { "_index": 38, "title": { "7": {}, "8": {}, "43": {} }, "description": {} }], ["limit", { "_index": 189, "title": { "110": {} }, "description": {} }], ["list", { "_index": 5, "title": { "2": {}, "3": {}, "4": {}, "22": {}, "28": {}, "30": {}, "31": {}, "32": {}, "34": {}, "36": {}, "44": {}, "51": {}, "60": {}, "63": {}, "71": {}, "78": {}, "82": {}, "90": {}, "100": {}, "101": {}, "104": {}, "106": {}, "108": {}, "114": {} }, "description": { "106": {} } }], ["litecoin", { "_index": 121, "title": {}, "description": { "55": {} } }], ["log", { "_index": 184, "title": { "110": {} }, "description": {} }], ["logo", { "_index": 126, "title": { "56": {}, "57": {} }, "description": {} }], ["longer", { "_index": 110, "title": { "54": {}, "70": {} }, "description": {} }], ["mark", { "_index": 195, "title": { "115": {} }, "description": {} }], ["master", { "_index": 97, "title": { "42": {}, "43": {}, "44": {}, "46": {} }, "description": { "44": {}, "45": {} } }], ["masterkey", { "_index": 96, "title": { "41": {}, "45": {} }, "description": {} }], ["memo", { "_index": 183, "title": { "109": {} }, "description": {} }], ["merchant", { "_index": 95, "title": { "39": {}, "47": {}, "48": {}, "49": {}, "50": {}, "52": {}, "53": {}, "54": {}, "56": {}, "57": {}, "65": {}, "66": {}, "68": {}, "80": {}, "98": {} }, "description": { "55": {} } }], ["merchant'", { "_index": 104, "title": { "51": {}, "78": {} }, "description": {} }], ["merchantcallback", { "_index": 127, "title": { "58": {} }, "description": {} }], ["merchantcli", { "_index": 134, "title": { "64": {} }, "description": {} }], ["merchantinvoic", { "_index": 145, "title": { "75": {} }, "description": {} }], ["multi-signatur", { "_index": 21, "title": {}, "description": { "3": {} } }], ["multisig", { "_index": 65, "title": { "19": {} }, "description": {} }], ["network", { "_index": 36, "title": { "6": {} }, "description": { "18": {} } }], ["new", { "_index": 33, "title": { "5": {}, "19": {}, "20": {}, "23": {}, "38": {}, "45": {}, "59": {}, "66": {}, "72": {}, "79": {} }, "description": { "45": {}, "55": {} } }], ["newest", { "_index": 28, "title": { "4": {}, "63": {} }, "description": {} }], ["next", { "_index": 150, "title": { "77": {} }, "description": {} }], ["notif", { "_index": 194, "title": { "114": {}, "115": {} }, "description": {} }], ["number", { "_index": 151, "title": { "77": {} }, "description": {} }], ["old", { "_index": 140, "title": { "70": {} }, "description": {} }], ["option", { "_index": 77, "title": { "28": {}, "30": {}, "31": {}, "32": {}, "63": {}, "110": {} }, "description": {} }], ["order", { "_index": 27, "title": { "4": {}, "51": {}, "55": {}, "63": {}, "103": {}, "104": {} }, "description": { "34": {} } }], ["organ", { "_index": 102, "title": { "48": {} }, "description": {} }], ["out", { "_index": 58, "title": { "85": {} }, "description": { "15": {} } }], ["outgo", { "_index": 188, "title": { "110": {} }, "description": {} }], ["page", { "_index": 12, "title": {}, "description": { "3": {}, "34": {} } }], ["paid", { "_index": 160, "title": { "85": {} }, "description": {} }], ["particular", { "_index": 144, "title": { "71": {}, "112": {} }, "description": {} }], ["pass", { "_index": 115, "title": { "55": {}, "110": {} }, "description": {} }], ["password", { "_index": 46, "title": { "11": {} }, "description": {} }], ["payment", { "_index": 109, "title": { "52": {}, "53": {}, "55": {}, "76": {}, "85": {} }, "description": {} }], ["payout", { "_index": 158, "title": { "85": {} }, "description": {} }], ["perform", { "_index": 163, "title": { "85": {} }, "description": {} }], ["period", { "_index": 84, "title": { "30": {}, "31": {}, "32": {} }, "description": {} }], ["place", { "_index": 181, "title": { "104": {} }, "description": {} }], ["platform", { "_index": 76, "title": { "27": {}, "34": {} }, "description": { "34": {} } }], ["possibl", { "_index": 92, "title": { "36": {} }, "description": {} }], ["prefer", { "_index": 164, "title": { "86": {}, "87": {}, "88": {}, "110": {} }, "description": {} }], ["privat", { "_index": 99, "title": { "43": {} }, "description": {} }], ["profil", { "_index": 101, "title": { "48": {}, "49": {}, "50": {} }, "description": {} }], ["provid", { "_index": 179, "title": { "104": {} }, "description": {} }], ["rang", { "_index": 80, "title": { "28": {}, "63": {} }, "description": {} }], ["rank", { "_index": 91, "title": { "51": {}, "55": {} }, "description": { "34": {}, "55": {} } }], ["rate", { "_index": 165, "title": { "89": {}, "90": {} }, "description": { "90": {} } }], ["read", { "_index": 196, "title": { "115": {} }, "description": {} }], ["receiv", { "_index": 108, "title": { "52": {}, "53": {}, "85": {} }, "description": {} }], ["recent", { "_index": 182, "title": {}, "description": { "106": {} } }], ["redoc-inject", { "_index": 2, "title": {}, "description": { "0": {} } }], ["regener", { "_index": 138, "title": { "70": {} }, "description": {} }], ["report", { "_index": 168, "title": { "91": {} }, "description": {} }], ["repres", { "_index": 16, "title": {}, "description": { "3": {} } }], ["request", { "_index": 31, "title": { "5": {}, "7": {}, "8": {}, "10": {}, "11": {}, "13": {}, "14": {}, "15": {}, "18": {}, "19": {}, "20": {}, "39": {}, "45": {}, "88": {}, "109": {} }, "description": { "15": {}, "18": {} } }], ["requir", { "_index": 52, "title": {}, "description": { "15": {} } }], ["rest", { "_index": 112, "title": { "55": {} }, "description": {} }], ["return", { "_index": 11, "title": { "51": {}, "55": {} }, "description": { "3": {}, "34": {}, "90": {} } }], ["scenario", { "_index": 124, "title": {}, "description": { "55": {} } }], ["schedul", { "_index": 157, "title": { "84": {} }, "description": {} }], ["secret", { "_index": 139, "title": { "70": {} }, "description": {} }], ["security-definit", { "_index": 3, "title": {}, "description": { "0": {} } }], ["send", { "_index": 30, "title": { "5": {}, "7": {}, "8": {}, "10": {}, "11": {}, "15": {}, "19": {}, "20": {}, "45": {}, "88": {}, "109": {} }, "description": {} }], ["sent", { "_index": 53, "title": {}, "description": { "15": {} } }], ["server", { "_index": 62, "title": {}, "description": { "18": {} } }], ["set", { "_index": 169, "title": { "93": {}, "110": {} }, "description": {} }], ["share", { "_index": 22, "title": { "98": {} }, "description": { "3": {} } }], ["sharedinvoic", { "_index": 170, "title": { "97": {} }, "description": {} }], ["sign", { "_index": 60, "title": { "18": {} }, "description": { "18": {} } }], ["singlesig", { "_index": 40, "title": { "10": {}, "20": {} }, "description": {} }], ["smart", { "_index": 172, "title": { "100": {}, "101": {} }, "description": {} }], ["smartcontract", { "_index": 171, "title": { "99": {} }, "description": {} }], ["sort", { "_index": 129, "title": { "60": {} }, "description": { "106": {} } }], ["specifi", { "_index": 148, "title": { "76": {} }, "description": { "90": {} } }], ["spend", { "_index": 49, "title": { "13": {}, "14": {}, "15": {}, "18": {} }, "description": {} }], ["state", { "_index": 153, "title": { "81": {} }, "description": {} }], ["structur", { "_index": 73, "title": { "27": {} }, "description": {} }], ["submit", { "_index": 59, "title": { "18": {} }, "description": {} }], ["summari", { "_index": 47, "title": { "12": {}, "16": {}, "17": {}, "29": {}, "92": {}, "94": {}, "95": {}, "96": {} }, "description": {} }], ["support", { "_index": 87, "title": { "34": {} }, "description": { "34": {} } }], ["system", { "_index": 176, "title": { "100": {}, "101": {}, "110": {} }, "description": {} }], ["time", { "_index": 79, "title": { "28": {}, "30": {}, "31": {}, "32": {} }, "description": {} }], ["token", { "_index": 18, "title": {}, "description": { "3": {} } }], ["top", { "_index": 106, "title": { "51": {}, "103": {}, "104": {} }, "description": {} }], ["topup", { "_index": 177, "title": { "102": {} }, "description": {} }], ["total", { "_index": 86, "title": { "32": {}, "110": {} }, "description": {} }], ["transact", { "_index": 133, "title": { "63": {}, "105": {}, "106": {}, "107": {}, "108": {}, "109": {}, "110": {} }, "description": { "106": {} } }], ["unassign", { "_index": 114, "title": { "55": {} }, "description": { "55": {} } }], ["up", { "_index": 178, "title": { "103": {}, "104": {} }, "description": {} }], ["updat", { "_index": 42, "title": { "11": {}, "25": {}, "39": {}, "43": {}, "50": {}, "53": {}, "55": {}, "62": {}, "68": {}, "73": {}, "81": {}, "88": {} }, "description": { "55": {} } }], ["upload", { "_index": 125, "title": { "56": {} }, "description": {} }], ["us", { "_index": 64, "title": {}, "description": { "18": {}, "44": {} } }], ["user", { "_index": 24, "title": { "4": {}, "11": {}, "44": {}, "48": {}, "87": {}, "88": {}, "104": {}, "111": {}, "112": {} }, "description": {} }], ["user'", { "_index": 10, "title": { "3": {}, "103": {}, "110": {} }, "description": {} }], ["usernotif", { "_index": 193, "title": { "113": {} }, "description": {} }], ["valid", { "_index": 48, "title": { "13": {}, "14": {}, "70": {} }, "description": { "18": {} } }], ["valu", { "_index": 186, "title": { "110": {} }, "description": {} }], ["volum", { "_index": 185, "title": { "110": {} }, "description": {} }], ["wallet", { "_index": 19, "title": {}, "description": { "3": {}, "44": {}, "45": {} } }], ["webhook", { "_index": 143, "title": { "71": {}, "72": {}, "73": {}, "74": {} }, "description": {} }], ["wish", { "_index": 107, "title": { "52": {}, "53": {}, "54": {} }, "description": {} }]], "pipeline": [] } }, "options": {} }
+
+        var container = document.getElementById('redoc');
+        Redoc.hydrate(__redoc_state, container);;
+    </script>
   <style
     data-styled="bxcHYI jzMYjV YzuTm hZCbNs kKQhLA ibpoCO kzNiFq  hclups ghctpd cLEtWf bbViyS iNzLCk gpbcFk fyUykq SmuWE hjRNaf NifDa OtKQc gBhLRG jjozHG cFwMcp nGwee fXybtJ fWqlcz iniCdN dluJDj hiuczA eesUPo cjtbAK dTJWQH jIdpVJ flfxUM gDsWLk WxWXp kGvRyb ioYTqA cvbzka evvbxn bSFXlp espozG fDvFMp iquxJz hLVzSF byLrBg dtUibw ldTMcP dHLKeu jBjYbV bNYCAJ hOczRB hPskZd iENVAs lkvpfX eftLSo bwgXFh kBWwoV irpqyy ecxnvs dpMbau hrtKLV byIIPy boajtD LiUBH eCjbJc bIrgla bcLONg kGwPhO fKyGWc hqYVjx jsTAxL gsJOdw bKmuNy gwfZGU kZHJcC kwGRVL fCJmC gbTit jCgylq iNoDtm edBCth beUper lpeYvY bMfIUD gzAoUb gGicuY fLUKgj"
     data-styled-version="4.4.1">
@@ -195,6 +202,12 @@
       padding: 0 40px;
     }
 
+    .text-oauth {
+        color: grey;
+        font-size: 16px;
+        margin-bottom: 20px;
+    }
+
     @media print,
     screen and (max-width:85rem) {
       .cjtbAK {
@@ -3644,6 +3657,7 @@ <h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#section/Authentic
           <div class="sc-gzVnrw eesUPo">
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/Accounts"></a>Accounts</h1>
+                <p class="text-oauth">*OAuth method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -6661,6 +6675,7 @@ <h3 class="sc-gZMcBi kBWwoV"> Request samples </h3>
           <div class="sc-gzVnrw eesUPo">
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/Affiliate"></a>Affiliate</h1>
+                <p class="text-oauth">*OAuth method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -7961,6 +7976,7 @@ <h3 class="sc-gZMcBi kBWwoV"> Response samples </h3>
           <div class="sc-gzVnrw eesUPo">
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/Currencies"></a>Currencies</h1>
+                <p class="text-oauth">*OAuth method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -8303,6 +8319,7 @@ <h3 class="sc-gZMcBi kBWwoV"> Response samples </h3>
           <div class="sc-gzVnrw eesUPo">
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/Invoices"></a>Invoices</h1>
+                <p class="text-oauth">*OAuth method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -8919,6 +8936,7 @@ <h3 class="sc-eXEjpC espozG"> Responses </h3>
           <div class="sc-gzVnrw eesUPo">
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/MasterKeys"></a>MasterKeys</h1>
+                <p class="text-oauth">*OAuth method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -9639,6 +9657,7 @@ <h3 class="sc-gZMcBi kBWwoV"> Request samples </h3>
           <div class="sc-gzVnrw eesUPo">
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/Merchant"></a>Merchant</h1>
+                <p class="text-oauth">*Client Id/Client Secret method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -11154,6 +11173,7 @@ <h3 class="sc-eXEjpC espozG"> Responses </h3>
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/MerchantCallbacks"></a>MerchantCallbacks
               </h1>
+                <p class="text-oauth">*Client Id/Client Secret method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -11953,6 +11973,7 @@ <h3 class="sc-gZMcBi kBWwoV"> Response samples </h3>
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/MerchantClients"></a>MerchantClients
               </h1>
+                <p class="text-oauth">*Client Id/Client Secret method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -13283,6 +13304,7 @@ <h3 class="sc-eXEjpC espozG"> Responses </h3>
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/MerchantInvoices"></a>MerchantInvoices
               </h1>
+                <p class="text-oauth">*Client Id/Client Secret method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -15685,6 +15707,7 @@ <h3 class="sc-gZMcBi kBWwoV"> Response samples </h3>
           <div class="sc-gzVnrw eesUPo">
             <div class="sc-bxivhb cjtbAK">
               <h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/Preferences"></a>Preferences</h1>
+                <p class="text-oauth">*OAuth method of authentication is used</p>
             </div>
           </div>
         </div>
@@ -18036,13 +18059,8 @@ <h3 class="sc-eXEjpC espozG"> Responses </h3>
       <div class="sc-iuJeZd fLUKgj"></div>
     </div>
   </div>
-  <script>
-    const __redoc_state = { "menu": { "activeItemIdx": -1 }, "spec": { "data": { "openapi": "3.0.1", "info": { "title": "CoinPayments API", "description": "CoinPayments Backend API.\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->", "version": "v1", "x-logo": { "url": "https://api.coinpayments.net/cps_logo.svg", "backgroundColor": "#FFFFFF", "altText": "CoinPayments logo" } }, "paths": { "/api/v1/accounts/balances": { "get": { "tags": ["Accounts"], "summary": "lists the financial account balances grouped by the currency", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountBalancesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountBalancesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountBalancesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts": { "get": { "tags": ["Accounts"], "summary": "lists all the user's financial accounts", "description": "Returns a page of the financial accounts that the authorized consumer has access to.  Accounts can represent crypto and token wallets (including multi-signature and shared wallets) or fiat currency accounts.", "parameters": [{ "name": "currencyId", "in": "query", "description": "optional id of the currency to filter the accounts by", "schema": { "type": "integer", "format": "int32" } }, { "name": "withBalance", "in": "query", "description": "optional to query accounts either with a balance or for those that are empty", "schema": { "type": "boolean" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedAccountsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedAccountsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedAccountsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/addresses": { "get": { "tags": ["Accounts"], "summary": "lists all the user accounts deposit addresses, ordering by newest first", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account for which to get addresses for", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedAccountAddressesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedAccountAddressesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedAccountAddressesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["Accounts"], "summary": "sends a request to create a new address for an account", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to retrieve", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountAddressResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/addresses/{addressId}": { "get": { "tags": ["Accounts"], "summary": "finds an address by its id or network address", "operationId": "GetAccountAddress", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account the address belongs", "required": true, "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "description": "the id of the address to retrieve", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountAddressDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/label": { "put": { "tags": ["Accounts"], "summary": "sends a request to change the account label", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to retrieve", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeWalletLabelRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeWalletLabelRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeWalletLabelRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeWalletLabelRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/addresses/{addressId}/label": { "put": { "tags": ["Accounts"], "summary": "sends a request to change the address label", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeAddressLabelRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeAddressLabelRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeAddressLabelRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeAddressLabelRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}": { "get": { "tags": ["Accounts"], "summary": "finds an account by its id", "operationId": "GetAccount", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to retrieve", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["Accounts"], "summary": "sends a request to delete a singlesig financial account", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/keys": { "put": { "tags": ["Accounts"], "summary": "sends a request to add or update an accounts client keys. Update happens when user changes their account password.", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account to update the client key for", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountAddClientKeysOrChangePasswordDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountAddClientKeysOrChangePasswordDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountAddClientKeysOrChangePasswordDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountAddClientKeysOrChangePasswordDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/fee/{masterKeyId}/{currencyId}": { "get": { "tags": ["Accounts"], "parameters": [{ "name": "masterKeyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currencyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend/validate": { "post": { "tags": ["Accounts"], "summary": "validates a request to spend funds from the account", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the details of the spend request, including the recipients the amount to send to each", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend/all/validate": { "post": { "tags": ["Accounts"], "summary": "validates a request to spend all funds from the account", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the details of the spend request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpendRequestValidateResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend": { "post": { "tags": ["Accounts"], "summary": "sends a request to spend funds from the account", "description": "if approval is required then the request will first be sent to account administrators for approval before it's actually sent out", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account from which to spend funds from", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the details of the spend request, including the recipients the amount to send to each", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend/all": { "post": { "tags": ["Accounts"], "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/convert": { "post": { "tags": ["Accounts"], "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountConvertRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountConvertRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountConvertRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountConvertRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/{id}/spend/{spendRequestId}/broadcast": { "post": { "tags": ["Accounts"], "summary": "submits a client signed spend request to broadcast", "description": "the server will validate the signed requests, co-sign it using the server key and then broadcast to the network", "parameters": [{ "name": "id", "in": "path", "description": "the id of the account from which the spend request was created", "required": true, "schema": { "type": "string" } }, { "name": "spendRequestId", "in": "path", "description": "the id of the spend request", "required": true, "schema": { "type": "string", "format": "uuid" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestBroadcastDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestBroadcastDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestBroadcastDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSpendRequestBroadcastDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/multisig": { "post": { "tags": ["Accounts"], "summary": "sends a request to create a new multisig financial account", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMultiSigAccountRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMultiSigAccountRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMultiSigAccountRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMultiSigAccountRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/accounts/singlesig": { "post": { "tags": ["Accounts"], "summary": "sends a request to create a new singlesig financial account", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateSingleSigAccountRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSingleSigAccountRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSingleSigAccountRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSingleSigAccountRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/channels": { "get": { "tags": ["Affiliate"], "summary": "List the channels the affiliate has created", "parameters": [{ "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedAffiliateChannelsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedAffiliateChannelsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedAffiliateChannelsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["Affiliate"], "summary": "Create a new channel", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewAffiliateChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewAffiliateChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewAffiliateChannelDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewAffiliateChannelDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/channels/{id}": { "get": { "tags": ["Affiliate"], "summary": "Finds a channel by its id", "operationId": "FindChannel", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateChannelDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Affiliate"], "summary": "Updates the details of a channel", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateChannelDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateChannelDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateChannelDetailsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateChannelDetailsDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate": { "get": { "tags": ["Affiliate"], "summary": "Gets the affiliate information", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateInfoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateInfoDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateInfoDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/fees": { "get": { "tags": ["Affiliate"], "summary": "Gets the commission fee structure that the affiliate can earn on the CoinPayments platform", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateCommissionFeesInfoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateCommissionFeesInfoDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateCommissionFeesInfoDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/earnings": { "get": { "tags": ["Affiliate"], "summary": "List the earnings of the affiliate, optionally filtered by a channel and time range", "parameters": [{ "name": "channelId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/earnings/summary": { "get": { "tags": ["Affiliate"], "summary": "Get a summary of earnings", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsSummaryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsSummaryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateEarningsSummaryDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/impressions/daily": { "get": { "tags": ["Affiliate"], "summary": "List the impressions and conversions by day for the affiliate, optionally filtered by a channel and time period", "parameters": [{ "name": "channelId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/impressions/country": { "get": { "tags": ["Affiliate"], "summary": "List the impressions and conversions by country for the affiliate, optionally filtered by a channel and time period", "parameters": [{ "name": "channelId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsDailyDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/affiliate/impressions": { "get": { "tags": ["Affiliate"], "summary": "List the total impressions, optionally filtered by a channel and time period", "parameters": [{ "name": "channelId", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsSummaryDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsSummaryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AffiliateImpressionsSummaryDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/currencies": { "get": { "tags": ["Currencies"], "summary": "lists platform supported currencies and their capabilities.", "description": "Returns a page of the supported currencies on the CoinPayments.net platform, by default ordered by their rank on CoinPayments.net.", "parameters": [{ "name": "q", "in": "query", "description": "optional search query to find currencies with names and/or codes similar to the specified search string", "schema": { "type": "string" } }, { "name": "types", "in": "query", "description": "comma separated list of the types of currencies to return (e.g. 'coin', 'token', 'fiat', etc.).  By default currencies of all types are returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyType" } } }, { "name": "capabilities", "in": "query", "description": "comma separated list of capabilities, currencies without the specified capabilities won't be returned", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCapability" } } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedCurrenciesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedCurrenciesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedCurrenciesDto" } } } } } } }, "/api/v1/currencies/{id}": { "get": { "tags": ["Currencies"], "summary": "finds a currency by its id", "parameters": [{ "name": "id", "in": "path", "description": "the id of the currency to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } } } } } } }, "/api/v1/currencies/conversions": { "get": { "tags": ["Currencies"], "summary": "gets a list of all possible currency conversions", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyConversion" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyConversion" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyConversion" } } } } } } } }, "/api/v1/invoices": { "post": { "tags": ["Invoices"], "summary": "Creates a new invoice", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/invoices/{id}": { "put": { "tags": ["Invoices"], "summary": "Updates the buyer information on an invoice, if it was requested by the merchant", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceBuyerInfoRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceBuyerInfoRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceBuyerInfoRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceBuyerInfoRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": ["Invoices"], "summary": "Finds an invoice by its id", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/masterkeys/{id}": { "get": { "tags": ["MasterKeys"], "summary": "find a master key by its id", "operationId": "GetMasterKey", "parameters": [{ "name": "id", "in": "path", "description": "the id of the masterkey to retrieve", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MasterKeyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MasterKeyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MasterKeyDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["MasterKeys"], "summary": "updates a master key label and encrypted client private key", "parameters": [{ "name": "id", "in": "path", "description": "the id of the masterkey to update", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMasterKeyRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMasterKeyRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMasterKeyRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMasterKeyRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/masterkeys": { "get": { "tags": ["MasterKeys"], "summary": "lists all the activated master keys the user has created", "description": "the master keys can be used to create crypto wallets", "parameters": [{ "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedMasterKeysDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedMasterKeysDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedMasterKeysDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["MasterKeys"], "summary": "sends a request to create a new MasterKey", "description": "the new master key must be activated before wallets can be created", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMasterKeyResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/masterkeys/{id}/activate": { "post": { "tags": ["MasterKeys"], "summary": "Activates a master key", "parameters": [{ "name": "id", "in": "path", "description": "the id of the masterkey to activate", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ActivateMasterKeyRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivateMasterKeyRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivateMasterKeyRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivateMasterKeyRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant": { "post": { "tags": ["Merchant"], "summary": "Creates a merchant profile for a user or organization", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantProfileDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantProfileDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/profile": { "get": { "tags": ["Merchant"], "summary": "Get the profile of the current merchant", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantProfileDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Merchant"], "summary": "Updates the profile of the current merchant", "requestBody": { "description": "The fields to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantProfileDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantProfileDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantProfileDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantProfileDto" } } } }, "responses": { "204": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/merchant/currencies": { "get": { "tags": ["Merchant"], "summary": "Gets the merchant's currently accepted currencies.\r\nCurrencies that are ranked (ordered) will be returned at the top of the list.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptedCurrenciesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptedCurrenciesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptedCurrenciesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/currencies/{id}": { "post": { "tags": ["Merchant"], "summary": "Adds a currency that a merchant wishes to receive as payments from Buyers", "parameters": [{ "name": "id", "in": "path", "description": "The currency to add", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "The payout configs for the currency", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddAcceptedCurrencyConfigDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddAcceptedCurrencyConfigDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddAcceptedCurrencyConfigDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddAcceptedCurrencyConfigDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Merchant"], "summary": "Updates a currency that a merchant wishes to receive as payments from Buyers", "parameters": [{ "name": "id", "in": "path", "description": "The currency to add", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAcceptedCurrencyConfigDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAcceptedCurrencyConfigDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAcceptedCurrencyConfigDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAcceptedCurrencyConfigDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["Merchant"], "summary": "Deletes a currency that a merchant no longer wishes to accept", "parameters": [{ "name": "id", "in": "path", "description": "The id of the currency to delete", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/currencies/{id}/order": { "put": { "tags": ["Merchant"], "summary": "Update the order (ranking) of an accepted coin. Will update the rest of the payment currencies so that they can be returned in the correct order.\r\nTo unassign the rank for a currency, pass in 0 for the order.", "description": "Example:\r\nA merchant has coins in this rank:\r\n1. Bitcoin\r\n2. Litecoin\r\n3. Ethereum\r\n            \r\nScenario 1: Merchant would like to update Ethereum to rank 1. The new ranks will be:\r\n1. Ethereum\r\n2. Bitcoin\r\n3. Litecoin\r\n            \r\nScenario 2: Merchant would like to unassign the rank for Bitcoin. The new ranks will be:\r\n1. Litecoin\r\n2. Ethereum\r\n0. Bitcoin", "parameters": [{ "name": "id", "in": "path", "description": "The id of the currency", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the order for the currency", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeAcceptedCurrencyOrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeAcceptedCurrencyOrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeAcceptedCurrencyOrderDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeAcceptedCurrencyOrderDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/logo": { "post": { "tags": ["Merchant"], "summary": "Uploads a merchant logo", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantLogoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantLogoDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantLogoDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["Merchant"], "summary": "Delete a merchant logo", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/callbacks": { "post": { "tags": ["MerchantCallbacks"], "summary": "Creates a new callback address", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewCallbackAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewCallbackAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewCallbackAddressDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewCallbackAddressDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": ["MerchantCallbacks"], "summary": "list all callback addresses sorted descending by the creation date", "parameters": [{ "name": "clientId", "in": "query", "schema": { "type": "string" } }, { "name": "currencyId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedCallbackAddressesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedCallbackAddressesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedCallbackAddressesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/callbacks/{id}": { "get": { "tags": ["MerchantCallbacks"], "summary": "find a callback address by id", "operationId": "FindCallbackAddress", "parameters": [{ "name": "id", "in": "path", "description": "the id of the callback address", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallbackAddressDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["MerchantCallbacks"], "summary": "updates a callback address", "parameters": [{ "name": "id", "in": "path", "description": "the id of the callback address", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "the callback address data to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCallbackAddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCallbackAddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCallbackAddressDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCallbackAddressDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/callbacks/deposits": { "get": { "tags": ["MerchantCallbacks"], "summary": "list all deposit transactions to callback addresses, ordered newest first and optionally filtering by address,\r\ncurrency and date range", "parameters": [{ "name": "callbackId", "in": "query", "schema": { "type": "string" } }, { "name": "currencyId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedCallbackDepositTransactionsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PagedCallbackDepositTransactionsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedCallbackDepositTransactionsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients": { "get": { "tags": ["MerchantClients"], "summary": "Get all clients belonging to the merchant", "parameters": [{ "name": "search", "in": "query", "description": "The string to search for in the client name", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "The state of the client (active or disabled)", "schema": { "$ref": "#/components/schemas/MerchantClientPublicState" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantClientsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantClientsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantClientsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["MerchantClients"], "summary": "Create a new client belonging to the merchant", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients/{clientId}": { "get": { "tags": ["MerchantClients"], "summary": "Find a client by its clientId", "operationId": "FindClientAsync", "parameters": [{ "name": "clientId", "in": "path", "description": "the id of the client", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantClientDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantClientDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantClientDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["MerchantClients"], "summary": "Update an existing client belonging to the merchant", "parameters": [{ "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["MerchantClients"], "summary": "Delete an existing client", "parameters": [{ "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients/{clientId}/secret": { "post": { "tags": ["MerchantClients"], "summary": "Regenerates the clients secret, the old secret will no longer be valid for communicating with the API", "parameters": [{ "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegenerateSecretResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateSecretResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegenerateSecretResponseDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients/{clientId}/webhooks": { "get": { "tags": ["MerchantClients"], "summary": "List all of the webhooks for a particular client", "operationId": "ListWebhooksForClientAsync", "parameters": [{ "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/MerchantClientWebhookNotification" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantClientWebhookEndpointsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantClientWebhookEndpointsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantClientWebhookEndpointsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["MerchantClients"], "summary": "Create a new webhook for a client", "parameters": [{ "name": "clientId", "in": "path", "description": "The public ID of a client", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientWebhookRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientWebhookRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientWebhookRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantClientWebhookRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/clients/{clientId}/webhooks/{webhookId}": { "put": { "tags": ["MerchantClients"], "summary": "Update an existing webhook for a client", "parameters": [{ "name": "clientId", "in": "path", "description": "The public ID of a client", "required": true, "schema": { "type": "string" } }, { "name": "webhookId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientWebhookDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientWebhookDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientWebhookDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantClientWebhookDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": ["MerchantClients"], "summary": "Delete a webhook for a client", "parameters": [{ "name": "clientId", "in": "path", "description": "the public ID of a client", "required": true, "schema": { "type": "string" } }, { "name": "webhookId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/buy-now-button": { "post": { "tags": ["MerchantInvoices"], "summary": "Creates payment button code for the specified invoice", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceBuyNowButtonHtmlRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceBuyNowButtonHtmlRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceBuyNowButtonHtmlRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceBuyNowButtonHtmlRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/nextid": { "post": { "tags": ["MerchantInvoices"], "summary": "Generates the next invoice number", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceNextIdDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceNextIdDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceNextIdDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceNextIdDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices": { "get": { "tags": ["MerchantInvoices"], "summary": "Get a list of the current merchant's invoices.", "parameters": [{ "name": "clientId", "in": "query", "description": "optional query to filter the invoices by pending, completed, or expired status", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "optional query to fetch invoices that were created with the specific client", "schema": { "$ref": "#/components/schemas/InvoiceStatus" } }, { "name": "from", "in": "query", "description": "optional query to fetch from and including the time specified up to the current time", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "optional query to fetch all invoices up to and including the specified time", "schema": { "type": "string", "format": "date-time" } }, { "name": "q", "in": "query", "description": "optional search string to find invoices with these words", "schema": { "type": "string" } }, { "name": "integration", "in": "query", "description": "optional integration by which the invoice was created", "schema": { "type": "string" } }, { "name": "payoutWalletId", "in": "query", "description": "optional query to filter the invoices by the wallet they were paid out to (for 'paid' and 'completed' invoices)", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceSummariesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceSummariesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MerchantInvoiceSummariesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": ["MerchantInvoices"], "summary": "Creates a new invoice", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantInvoiceRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}": { "get": { "tags": ["MerchantInvoices"], "summary": "Find invoice belonging to merchant by the invoice ID", "operationId": "FindInvoiceAsync", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["MerchantInvoices"], "summary": "Updates an existing invoice in draft state", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantInvoiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantInvoiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantInvoiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMerchantInvoiceRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}/history": { "get": { "tags": ["MerchantInvoices"], "summary": "Lists the history events of an invoice by the invoice ID", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}/cancel": { "post": { "tags": ["MerchantInvoices"], "summary": "Cancels an invoice", "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}/delete": { "delete": { "tags": ["MerchantInvoices"], "summary": "Deletes a draft or scheduled invoice", "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/merchant/invoices/{id}/payouts": { "get": { "tags": ["MerchantInvoices"], "summary": "Get payout details for an invoice, including if invoice has been fully paid out, the exact amount they will receive\r\nand in what currency, which address payout will be deposited, and who (Buyer) performed the payment.", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoicePayoutsDetailsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePayoutsDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoicePayoutsDetailsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/preferences": { "get": { "tags": ["Preferences"], "summary": "gets the user preferences", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserPreferencesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPreferencesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Preferences"], "summary": "sends a request to update user preferences", "requestBody": { "description": "the preferences to update, each of the body fields is optional and if not specified, or specified as `null`, then the current value will be retained", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeUserPreferencesRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeUserPreferencesRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeUserPreferencesRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeUserPreferencesRequestDto" } } } }, "responses": { "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/rates": { "get": { "tags": ["Rates"], "summary": "lists the current conversion rates between currencies", "description": "Returns the currency conversion rates for the specified `from` currencies converted to the specified `to` currencies", "parameters": [{ "name": "from", "in": "query", "description": "comma separated list of currency ids to use as the source for rate calculations", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "comma separated list of currency ids for which to retrieve conversion rates for (from the `from` currencies)", "schema": { "type": "string" } }, { "name": "fromToken", "in": "query", "description": "optional, contract address of the token on the from currency", "schema": { "type": "string" } }, { "name": "toToken", "in": "query", "description": "optional, contract address of the token on the quote currency", "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RatesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RatesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RatesDto" } } } } } } }, "/api/v1/reports": { "post": { "tags": ["Reports"], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/settings": { "post": { "tags": ["Settings"], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": ["Settings"], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/settings/{key}": { "get": { "tags": ["Settings"], "parameters": [{ "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/shared-invoices/{sharedInvoiceId}": { "get": { "tags": ["SharedInvoices"], "summary": "Finds an invoice shared by a merchant", "parameters": [{ "name": "sharedInvoiceId", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/smartcontracts/{currencyId}": { "get": { "tags": ["SmartContracts"], "summary": "Lists the smart contracts (like ERC20) known to the system", "parameters": [{ "name": "currencyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartContract" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartContract" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartContract" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/smartcontracts/{currencyId}/{contractsAddress}": { "get": { "tags": ["SmartContracts"], "summary": "Lists the smart contracts (like ERC20) known to the system", "parameters": [{ "name": "currencyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "contractsAddress", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmartContract" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmartContract" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmartContract" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/topups/orders": { "get": { "tags": ["TopUps"], "summary": "Gets user's top up orders (history)", "parameters": [{ "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TopUpOrdersDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TopUpOrdersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TopUpOrdersDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/topups/providers": { "get": { "tags": ["TopUps"], "summary": "Gets list of providers available to the user in which to place top up order", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TopUpProvidersDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TopUpProvidersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TopUpProvidersDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions": { "get": { "tags": ["Transactions"], "summary": "lists all the transactions", "description": "lists all transactions, sorted by the created date with the most recent first", "parameters": [{ "name": "accountId", "in": "query", "description": "optional, id of the account for which to list transactions for", "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "description": "optional, ISO 8601 formatted UTC date from which to list transactions starting from (e.g. '2019-01-17')", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "optional, ISO 8601 formatted UTC date until which to list transactions (e.g. '2019-01-27')", "schema": { "type": "string", "format": "date-time" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionDtoPagedItemsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDtoPagedItemsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionDtoPagedItemsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions/{id}": { "get": { "tags": ["Transactions"], "summary": "find a transaction by id", "parameters": [{ "name": "id", "in": "path", "description": "the id of the transaction to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions/{id}/events": { "get": { "tags": ["Transactions"], "summary": "list all the events of a transaction", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactionHistoryEventsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactionHistoryEventsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactionHistoryEventsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions/{id}/memo": { "put": { "tags": ["Transactions"], "summary": "sends a request to change the transaction memo", "parameters": [{ "name": "id", "in": "path", "description": "the id of the transaction to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeTransactionMemoRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeTransactionMemoRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeTransactionMemoRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeTransactionMemoRequestDto" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/transactions/volume": { "get": { "tags": ["Transactions"], "summary": "Get currently logged in user's transacted volume (total value of incoming and outgoing transactions)\r\nand the volume limit set in the system, with option to pass in user's preferred currency", "parameters": [{ "name": "currencyId", "in": "query", "description": "The currency the transacted volume and limit should be returned in", "schema": { "type": "integer", "format": "int32" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransactedVolumeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransactedVolumeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransactedVolumeDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/user/features": { "get": { "tags": ["User"], "summary": "Indicates which features, that are only available to certain users, are available for this particular user", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserFeaturesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserFeaturesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserFeaturesDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/notifications": { "get": { "tags": ["UserNotifications"], "summary": "Get list of active notifications", "parameters": [{ "name": "languageCode", "in": "query", "description": "", "schema": { "pattern": "^([a-z]|[A-Z]){2}$", "type": "string" } }], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserNotificationsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserNotificationsDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/api/v1/notifications/{id}/read": { "post": { "tags": ["UserNotifications"], "summary": "Mark a notification as read", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } } }, "components": { "schemas": { "MoneyDto": { "type": "object", "properties": { "displayValue": { "type": "string", "description": "the value formatted for display", "nullable": true }, "value": { "type": "string", "description": "the amount of money, as an integer, in the currencies base (smallest) monetary unit.  For example,\r\nBitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC\r\nwould have a value of 100000000 and 0.00031 BTC a value of 31000.  An amount of $9.99 USD would\r\nhave the value 999 (i.e, 999 cents).  Zero-decimal currencies such as the Yen would represent\r\na value of ¥500 as 500.", "nullable": true, "example": "31000" }, "amount": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "currencyId": { "type": "integer", "description": "the currency the monetary `value` is represented in", "format": "int32", "example": 1235 } }, "additionalProperties": false, "description": "Monetary value (an amount with a currency)." }, "AccountBalancesForCurrencyDto": { "type": "object", "properties": { "currencyId": { "type": "integer", "description": "the id of the currency for the current balances", "format": "int32" }, "totalBalance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total unconfirmed balance", "nullable": true }, "totalAvailable": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total balance available for transactions", "nullable": true }, "totalNativeBalance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total unconfirmed balance, in the users native currency", "nullable": true }, "totalNativeAvailable": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total balance available for transactions, in the users native currency", "nullable": true } }, "additionalProperties": false, "description": "Represents the total account balances for a single currency" }, "AccountBalancesDto": { "type": "object", "properties": { "balancesByCurrency": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalancesForCurrencyDto" }, "description": "the balances for accounts grouped by the currency", "nullable": true }, "totalNativeBalance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total unconfirmed balance in all accounts, in the users native currency", "nullable": true }, "totalNativeAvailable": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total balance available for transactions in all accounts, in the users native currency", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the total account balances" }, "AccountType": { "enum": ["multiSigCryptoWallet", "singleSigCryptoWallet"], "type": "string" }, "CurrencyType": { "enum": ["crypto", "token", "fiat"], "type": "string", "description": "Type of currency" }, "CurrencyLogoDto": { "type": "object", "properties": { "imageUrl": { "type": "string", "description": "Link to a CoinPayments hosted image for a currency, 64x64 is the default size returned.\r\nReplace \"64x64\" in the image url with these alternative sizes: 32, 64, 128, 200.", "nullable": true }, "vectorUrl": { "type": "string", "description": "If available then the link to a CoinPayments hosted vector image (SVG) for the currency.", "nullable": true } }, "additionalProperties": false, "description": "Contains the logo URLs for a currency" }, "CurrencyStatus": { "enum": ["active", "underMaintenance"], "type": "string", "description": "The status of the currency on the CoinPayments platform" }, "CurrencyCapability": { "enum": ["multiSigAccounts", "sharedAccounts", "payments", "singleSigAccounts"], "type": "string" }, "CurrencyUrlsDto": { "type": "object", "properties": { "websites": { "type": "array", "items": { "type": "string" }, "description": "the websites for the currency", "nullable": true }, "explorers": { "type": "array", "items": { "type": "string" }, "description": "the explorers for the currency (if crypto or a token)", "nullable": true } }, "additionalProperties": false, "description": "Contains various URLs for a currency" }, "CurrencyDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "the unique id of the currency on the CoinPayments platform", "format": "int32", "example": 1235 }, "type": { "allOf": [{ "$ref": "#/components/schemas/CurrencyType" }], "description": "the type of the currency" }, "symbol": { "type": "string", "description": "ticker symbol for the currency.  For fiat currencies this is the three character (ISO-4217) currency code,\r\nand for crypto currencies their multi-character symbol.", "nullable": true, "example": "BTC" }, "name": { "type": "string", "description": "the name of the currency, e.g. 'United States Dollar' or 'Bitcoin'", "nullable": true, "example": "Bitcoin" }, "logo": { "allOf": [{ "$ref": "#/components/schemas/CurrencyLogoDto" }], "description": "the logo urls for the currency", "nullable": true }, "decimalPlaces": { "type": "integer", "description": "the number of digits after the decimal separator, e.g. 2 for USD, 8 for BTC, 0 for JPY", "format": "int32" }, "rank": { "type": "integer", "description": "the relative ordering/ranking of this currency to the other supported currencies on the\r\nCoinPayments platform", "format": "int32" }, "status": { "allOf": [{ "$ref": "#/components/schemas/CurrencyStatus" }], "description": "The status of the currency on the CoinPayments platform" }, "capabilities": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCapability" }, "description": "the capabilities of the currency on the CoinPayments platform", "nullable": true }, "urls": { "allOf": [{ "$ref": "#/components/schemas/CurrencyUrlsDto" }], "description": "object containing various urls for the currency", "nullable": true } }, "additionalProperties": false, "description": "Represents money, in any form (e.g. crypto/fiat currencies and tokens), supported on the CoinPayments\r\nplatform in some capacity (e.g. holding in a wallet and/or payment processing)." }, "AccountMultiSigKeysDto": { "type": "object", "properties": { "serverPublicKey": { "type": "string", "description": "the servers public key, the private key is held by CoinPayments", "nullable": true }, "backupPublicKey": { "type": "string", "description": "the backup public key, the private key is held by the Key Recovery Service (KRS)", "nullable": true }, "clientPublicKey": { "type": "string", "description": "the clients public key", "nullable": true }, "clientEncryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key", "nullable": true } }, "additionalProperties": false, "description": "Keys for multi signature accounts" }, "TokenDto": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Blockchain address of the contract respresenting the token", "nullable": true }, "nativeValue": { "type": "string", "description": "Token amount equivalent in native currency", "nullable": true }, "nativeCurrencyId": { "type": "integer", "format": "int32" }, "displayValue": { "type": "string", "description": "the value formatted for display", "nullable": true }, "value": { "type": "string", "description": "the amount of money, as an integer, in the currencies base (smallest) monetary unit.  For example,\r\nBitcoin which can be divided down to 8 decimal places is represented in Satoshi's, so 1 BTC\r\nwould have a value of 100000000 and 0.00031 BTC a value of 31000.  An amount of $9.99 USD would\r\nhave the value 999 (i.e, 999 cents).  Zero-decimal currencies such as the Yen would represent\r\na value of ¥500 as 500.", "nullable": true, "example": "31000" }, "amount": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "currencyId": { "type": "integer", "description": "the currency the monetary `value` is represented in", "format": "int32", "example": 1235 } }, "additionalProperties": false, "description": "Monetary value (an amount with a currency and contract address)." }, "AccountDto": { "type": "object", "properties": { "accountId": { "type": "string", "description": "the unique id of the account", "nullable": true, "example": "283b271a2db744c0b10c" }, "accountType": { "allOf": [{ "$ref": "#/components/schemas/AccountType" }], "description": "the type of the account" }, "currencyId": { "type": "integer", "description": "the id of the currency this account holds", "format": "int32", "example": 1235 }, "isActive": { "type": "boolean", "description": "Indicates whether this wallet is active (not deleted or deactivated)" }, "currency": { "allOf": [{ "$ref": "#/components/schemas/CurrencyDto" }], "description": "the currency this account holds", "nullable": true }, "label": { "type": "string", "description": "the user or system defined name of the account", "nullable": true, "example": "My BitCoin Wallet 😀" }, "keys": { "allOf": [{ "$ref": "#/components/schemas/AccountMultiSigKeysDto" }], "description": "the keys for the multi signature account (for accountType=`MultiSigCryptoWallet`)", "nullable": true }, "depositAddress": { "type": "string", "description": "the current (last) deposit address for the account (for crypto currency accounts)", "nullable": true }, "balance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total (unconfirmed) balance in the account", "nullable": true }, "available": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the amount of funds available for transactions, this is the `balance` amount reduced by limits\r\nimposed by the user or the system on this account", "nullable": true }, "nativeBalance": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total (unconfirmed) balance in the account, in the users native currency", "nullable": true }, "nativeAvailable": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the amount of funds available for transactions, in the users native currency, this is the `balance`\r\namount reduced by limits imposed by the user or the system on this account", "nullable": true }, "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/TokenDto" }, "description": "the amount of tokens (like ERC20) available for this account", "nullable": true } }, "additionalProperties": false, "description": "Represents a financial account on the CoinPayments® platform." }, "PagingCursorsDto": { "type": "object", "properties": { "before": { "type": "string", "nullable": true }, "after": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PagingDto": { "type": "object", "properties": { "cursors": { "allOf": [{ "$ref": "#/components/schemas/PagingCursorsDto" }], "nullable": true }, "limit": { "type": "integer", "format": "int32" }, "first": { "type": "string", "format": "uri", "nullable": true }, "next": { "type": "string", "format": "uri", "nullable": true }, "previous": { "type": "string", "format": "uri", "nullable": true }, "last": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "PagedAccountsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "AccountAddressDto": { "type": "object", "properties": { "addressId": { "type": "string", "description": "the unique id of the address", "nullable": true }, "label": { "type": "string", "description": "user supplied or system generated label for this address", "nullable": true }, "address": { "type": "string", "description": "the network address", "nullable": true } }, "additionalProperties": false, "description": "Represents a deposit address of a financial account on the CoinPayments® platform." }, "PagedAccountAddressesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountAddressDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "CreateAccountAddressRequestDto": { "type": "object", "properties": { "label": { "type": "string", "description": "the optional label for the new address", "nullable": true } }, "additionalProperties": false, "description": "Request to create a new address for an existing account" }, "CreateAccountAddressResponseDto": { "type": "object", "properties": { "addressId": { "type": "string", "description": "the id of the address that will be created.\r\nNote that this is NOT the network address, one will be assigned when creation is completed", "nullable": true } }, "additionalProperties": false, "description": "Response to an address creation request" }, "ChangeWalletLabelRequestDto": { "type": "object", "properties": { "label": { "type": "string", "description": "The new label for the account", "nullable": true } }, "additionalProperties": false, "description": "Request to change the label of an account" }, "ChangeAddressLabelRequestDto": { "type": "object", "properties": { "label": { "type": "string", "description": "The new label for the address", "nullable": true } }, "additionalProperties": false, "description": "Request to change the label of an address" }, "AccountAddClientKeysOrChangePasswordDto": { "required": ["clientEncryptedPrivateKey"], "type": "object", "properties": { "clientPublicKey": { "type": "string", "description": "the clients public key", "nullable": true }, "clientEncryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key" } }, "additionalProperties": false, "description": "Request to add the client keys to the account" }, "AccountSpendRequestRecipientDto": { "required": ["address", "amount"], "type": "object", "properties": { "address": { "type": "string", "description": "the address of the recipients account/wallet" }, "amount": { "type": "string", "description": "the amount of money (in the currencies smallest unit, e.g. Satoshis for BTC) to send to the recipient address" }, "blockChainFee": { "type": "string", "description": "the amount of money (in the currencies smallest unit, e.g. Satoshis for BTC) to pay as a blockchain network fee", "nullable": true } }, "additionalProperties": false, "description": "Recipient of a transaction" }, "AccountSpendRequestDto": { "required": ["recipients"], "type": "object", "properties": { "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/AccountSpendRequestRecipientDto" }, "description": "the list of recipients to send funds to" }, "memo": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Custom memo to attach to this transaction, this will only be visible within CoinPayments®", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "description": "Optional additional information for the spend request e.g. \"UseHopAddress\" for Ethereum", "nullable": true } }, "additionalProperties": false, "description": "Request to create a transaction and spend funds from an account" }, "SpendRequestValidateResponseErrorDto": { "type": "object", "properties": { "code": { "type": "string", "description": "the code for the error", "nullable": true }, "description": { "type": "string", "description": "the description for the error", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates an error from the wallet spend request validator" }, "SpendRequestValidateResponseDto": { "type": "object", "properties": { "isValid": { "type": "boolean", "description": "value indicating whether the provided request is valid" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/SpendRequestValidateResponseErrorDto" }, "description": "the list of errors, if any", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the response to a wallet spend validation request" }, "AccountSpendRequestResponseDto": { "type": "object", "properties": { "spendRequestId": { "type": "string", "description": "the id of the created request to spend funds", "nullable": true }, "spendRequestToken": { "type": "string", "description": "additional validation token that must be sent up with the signed request", "nullable": true } }, "additionalProperties": false, "description": "The response to a request to spend funds from an account" }, "AccountConvertRequestDto": { "required": ["convertToCurrency", "recipients"], "type": "object", "properties": { "convertToCurrency": { "type": "integer", "description": "Currency into which funds should be converted", "format": "int32" }, "convertToContractAddress": { "type": "string", "description": "Address of the contract of the token to convert to", "nullable": true }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/AccountSpendRequestRecipientDto" }, "description": "the list of recipients to send funds to" }, "memo": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Custom memo to attach to this transaction, this will only be visible within CoinPayments®", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "description": "Optional additional information for the spend request e.g. \"UseHopAddress\" for Ethereum", "nullable": true } }, "additionalProperties": false, "description": "Request to create a transaction and convert funds from an account" }, "AccountSpendRequestBroadcastDto": { "required": ["otp", "signedTxHex", "spendRequestToken"], "type": "object", "properties": { "spendRequestToken": { "type": "string", "description": "the validation token from the original request" }, "signedTxHex": { "type": "string", "description": "the client signed transaction encoded in hex" }, "otp": { "type": "string", "description": "2fa token" } }, "additionalProperties": false, "description": "Client signed spend request" }, "CreateMultiSigAccountRequestDto": { "required": ["currencyId", "label", "masterKeyId"], "type": "object", "properties": { "masterKeyId": { "type": "string", "description": "the id of the master key from which the wallet is to be created from", "example": "4174c0b10b271a2db74c" }, "currencyId": { "type": "string", "description": "the id of the currency that the account will hold", "example": "1235" }, "label": { "type": "string", "description": "the user specified name for the new account", "example": "My new BTC account" }, "ownerId": { "type": "string", "description": "optional, owner id of the created wallet.  If not specified then defaults to the currently\r\nauthenticated user, otherwise it must be the id of an organization the user has access to.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "Request to create a new account" }, "CreateSingleSigAccountRequestDto": { "required": ["currencyId", "label"], "type": "object", "properties": { "currencyId": { "type": "string", "description": "the id of the currency that the account will hold", "example": "1235" }, "label": { "type": "string", "description": "the user specified name for the new account", "example": "My new BTC account" }, "ownerId": { "type": "string", "description": "optional, owner id of the created wallet.  If not specified then defaults to the currently\r\nauthenticated user, otherwise it must be the id of an organization the user has access to.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "Request to create a new account" }, "AffiliateChannelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the unique id of the channel", "nullable": true }, "name": { "type": "string", "description": "the name of the channel (unique to an affiliate)", "nullable": true }, "created": { "type": "string", "description": "the timestamp of when the channel was created", "format": "date-time" }, "description": { "type": "string", "description": "the description of the channel", "nullable": true }, "earningsType": { "type": "string", "description": "determines how the affiliate will be earning commissions through this channel", "nullable": true }, "impressionsTotal": { "type": "integer", "description": "the total number of people that viewed the CoinPayments homepage using the referral link", "format": "int32" }, "impressionsUnique": { "type": "integer", "description": "the total number unique number of people that viewed the CoinPayments homepage using the referral link", "format": "int32" }, "conversions": { "type": "integer", "description": "the total number of people that signed up for CoinPayments using the referral link", "format": "int32" }, "totalEarnings": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total earnings for this channel in the users native currency", "nullable": true }, "referralLink": { "type": "string", "description": "the referral link for this channel", "nullable": true } }, "additionalProperties": false, "description": "Individually tracked channel with its own referral link through which an affiliate promotes CoinPayments\r\nand earns commissions on service fees generated for CoinPayments." }, "PagedAffiliateChannelsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AffiliateChannelDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "NewAffiliateChannelDto": { "required": ["earningsType", "name"], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string", "description": "the name of the channel (unique to an affiliate)" }, "description": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the description of the channel", "nullable": true }, "earningsType": { "type": "string", "description": "determines how the affiliate will be earning commissions through this channel" } }, "additionalProperties": false, "description": "Request to create a new affiliate channel" }, "UpdateAffiliateChannelDetailsDto": { "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string", "description": "the name of the channel", "nullable": true }, "description": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the description of the channel", "nullable": true } }, "additionalProperties": false, "description": "Request to update the details of an affiliate channel" }, "AffiliateCommissionsSingleLevelFeesInfoDto": { "type": "object", "properties": { "percentOfPaymentFees": { "type": "number", "description": "the percentage (0..100) of fees collected by CoinPayments for a referred user that the affiliate will be paid", "format": "float" }, "durationYears": { "type": "number", "description": "the duration in the number of years since a referred users signup that the affiliate will earn\r\nfees on all of their transaction fees charged", "format": "float" } }, "additionalProperties": false, "description": "Information about commission fees for single level referrals on the CoinPayments platform" }, "AffiliateCommissionFeesInfoDto": { "type": "object", "properties": { "singleLevel": { "allOf": [{ "$ref": "#/components/schemas/AffiliateCommissionsSingleLevelFeesInfoDto" }], "description": "information about commissions earned for single level referrals", "nullable": true } }, "additionalProperties": false, "description": "Information about commissions that can be earned on the CoinPayments platform" }, "AffiliateInfoDto": { "type": "object", "properties": { "defaultReferralLink": { "type": "string", "description": "the referral link for the default channel", "nullable": true }, "fees": { "allOf": [{ "$ref": "#/components/schemas/AffiliateCommissionFeesInfoDto" }], "description": "Information about commissions rates that the affiliate earns on the CoinPayments platform", "nullable": true } }, "additionalProperties": false, "description": "Information about the affiliate" }, "AffiliateEarningPerCurrencyDto": { "type": "object", "properties": { "currencyId": { "type": "integer", "description": "the id of the currency for the current earnings", "format": "int32" }, "totalEarnings": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total earnings in the earned currency", "nullable": true }, "totalNativeEarnings": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total earnings in the users currency", "nullable": true } }, "additionalProperties": false, "description": "The earnings for a single currency" }, "AffiliateEarningsDto": { "type": "object", "properties": { "earningsByCurrency": { "type": "array", "items": { "$ref": "#/components/schemas/AffiliateEarningPerCurrencyDto" }, "description": "the earnings grouped by the currency", "nullable": true }, "totalNativeEarnings": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total earnings in all currencies, in the users native currency", "nullable": true } }, "additionalProperties": false, "description": "The affiliate earnings" }, "AffiliateEarningsSummaryDto": { "type": "object", "properties": { "last24h": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the earnings in the last 24-hours", "nullable": true }, "last7Days": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the earnings in the last 7-days (week)", "nullable": true }, "last30Days": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the earnings in the last 30-days (month)", "nullable": true }, "lastYear": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the earnings in the last year (365 days)", "nullable": true }, "allTime": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the all time earnings", "nullable": true }, "totalConversions": { "type": "integer", "description": "the total conversions through every channel", "format": "int32" } }, "additionalProperties": false }, "AffiliateImpressionsDayDto": { "type": "object", "properties": { "day": { "type": "string", "description": "the timestamp of the day (\"yyyy-MM-dd\")", "nullable": true }, "impressionsTotal": { "type": "integer", "description": "the total number of impressions on the day", "format": "int32" }, "impressionsUnique": { "type": "integer", "description": "the total number of unique impressions on the day", "format": "int32" }, "conversions": { "type": "integer", "description": "the total number of conversions on the day", "format": "int32" } }, "additionalProperties": false, "description": "Information about impressions and conversions on a particular day" }, "AffiliateImpressionsDailyDto": { "type": "object", "properties": { "from": { "type": "string", "description": "the start date that was requested", "format": "date-time", "nullable": true }, "to": { "type": "string", "description": "the end date that was requested", "format": "date-time", "nullable": true }, "channelId": { "type": "string", "description": "the channel id if filtering by channel", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AffiliateImpressionsDayDto" }, "description": "the daily impressions, if any, between the requested period.  Zero impression/conversion days will not be returned", "nullable": true } }, "additionalProperties": false, "description": "Information about the impressions for an affiliate by day" }, "AffiliateImpressionsSummaryDto": { "type": "object", "properties": { "impressionsTotal": { "type": "integer", "description": "the total number of impressions", "format": "int32" }, "impressionsUnique": { "type": "integer", "description": "the total number of unique impressions", "format": "int32" }, "conversions": { "type": "integer", "description": "the total number of conversions", "format": "int32" } }, "additionalProperties": false, "description": "Information about the total impressions" }, "PagedCurrenciesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Page of currencies" }, "CurrencyConversion": { "type": "object", "properties": { "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FullNameDto": { "type": "object", "properties": { "firstName": { "maxLength": 140, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 140, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "AddressDto": { "type": "object", "properties": { "address1": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "address2": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "address3": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "provinceOrState": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 120, "minLength": 0, "type": "string", "nullable": true }, "suburbOrDistrict": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "countryCode": { "maxLength": 2, "minLength": 2, "pattern": "^([A-Z]{2})$", "type": "string", "nullable": true }, "postalCode": { "maxLength": 60, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "BuyerDto": { "type": "object", "properties": { "companyName": { "type": "string", "nullable": true }, "name": { "allOf": [{ "$ref": "#/components/schemas/FullNameDto" }], "nullable": true }, "emailAddress": { "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "type": "string", "format": "tel", "nullable": true }, "address": { "allOf": [{ "$ref": "#/components/schemas/AddressDto" }], "nullable": true } }, "additionalProperties": false }, "InvoiceMoneyDto": { "type": "object", "properties": { "currencyId": { "type": "integer", "format": "int32" }, "contractAddress": { "type": "string", "nullable": true }, "displayValue": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LineItemDto": { "required": ["amount", "name", "quantity"], "type": "object", "properties": { "customId": { "maxLength": 127, "minLength": 0, "type": "string", "nullable": true }, "sku": { "maxLength": 127, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 127, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "quantity": { "maximum": 999999999, "minimum": 1, "type": "integer", "format": "int32" }, "originalAmount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }] }, "tax": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true } }, "additionalProperties": false }, "InvoiceAmountBreakdownDto": { "required": ["subtotal"], "type": "object", "properties": { "subtotal": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }] }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true }, "handling": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true }, "taxTotal": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true }, "discount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "nullable": true } }, "additionalProperties": false }, "InvoiceAmountDto": { "type": "object", "properties": { "breakdown": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountBreakdownDto" }], "nullable": true }, "currencyId": { "type": "integer", "format": "int32" }, "contractAddress": { "type": "string", "nullable": true }, "displayValue": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceShippingDetailDto": { "type": "object", "properties": { "method": { "maxLength": 127, "minLength": 0, "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "name": { "allOf": [{ "$ref": "#/components/schemas/FullNameDto" }], "nullable": true }, "emailAddress": { "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "type": "string", "format": "tel", "nullable": true }, "address": { "allOf": [{ "$ref": "#/components/schemas/AddressDto" }], "nullable": true } }, "additionalProperties": false }, "InvoiceMetadataDto": { "type": "object", "properties": { "integration": { "type": "string", "nullable": true }, "hostname": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateInvoiceRequestDto": { "required": ["amount", "clientId"], "type": "object", "properties": { "clientId": { "type": "string", "description": "the id of the client creating this invoice" }, "currencyId": { "type": "integer", "description": "the id of the currency the invoice is to be in, alternatively this can be set individually per field", "format": "int32", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information, if not provided it can be requested during payment if needed", "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "description": "the purchase description, can be provided instead of a list of `items`", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDto" }, "description": "the optional array of items that a buyer intends to purchase from the merchant", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }], "description": "the total amount of the invoice, with an optional breakdown that provides details, such as the total item\r\namount, total tax amount, shipping, handling, insurance and discounts, if any" }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the optional shipping method and address", "nullable": true }, "requireBuyerNameAndEmail": { "type": "boolean", "description": "flag indicating whether a buyer name and email are required, they will be requested at checkout\r\nif not provider by the caller.  The Orion.Api.Models.Merchant.CreateInvoiceRequestDto.BuyerDataCollectionMessage will be displayed\r\nto the buyer when prompted." }, "buyerDataCollectionMessage": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the message to display when collecting buyer user data", "nullable": true }, "notesToRecipient": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any additional information to share with the buyer about the transaction", "nullable": true }, "termsAndConditions": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any terms and conditions, e.g. a cancellation policy", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "any custom data the caller wishes to attach to the invoice which will be sent back in notifications", "nullable": true }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMetadataDto" }], "nullable": true } }, "additionalProperties": false, "description": "Request to create an invoice, which is a list of goods or services with a statement of the sum due provided\r\nby the merchant, that a buyer intends to purchase" }, "UpdateInvoiceBuyerInfoRequestDto": { "type": "object", "properties": { "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the shipping method and address", "nullable": true } }, "additionalProperties": false, "description": "Request to update an invoice" }, "MasterKeyDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the unique id of the master key", "nullable": true }, "masterKeyId": { "type": "string", "description": "the unique id of the master key", "nullable": true, "readOnly": true, "deprecated": true }, "created": { "type": "string", "description": "timestamp when the master key was created", "format": "date-time" }, "label": { "type": "string", "description": "the user or system generated label of the master key", "nullable": true }, "clientPublicKey": { "type": "string", "description": "the clients public key", "nullable": true }, "clientEncryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key", "nullable": true }, "serverPublicKey": { "type": "string", "description": "the servers public key", "nullable": true }, "keyRecoveryServiceName": { "type": "string", "description": "the name of the key recovery service (KRS) that provided the backup key", "nullable": true }, "backupPublicKey": { "type": "string", "description": "the public key from the KRS", "nullable": true } }, "additionalProperties": false, "description": "Represents a Master Key from which crypto currency wallets can be created from.  The Master Key contains  \r\nthree BIP32 HD keys for the sole purpose of 2-of-3 wallet tree generation, utilizing BIP44 paths, it is\r\nunable to sign transactions by itself." }, "UpdateMasterKeyRequestDto": { "type": "object", "properties": { "encryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key", "nullable": true }, "label": { "type": "string", "description": "optional label to apply to the master key", "nullable": true } }, "additionalProperties": false, "description": "Request from the client to update an existing master key, the client can send a new `Label` and/or\r\n`EncryptedPrivateKey` when changing passwords" }, "PagedMasterKeysDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MasterKeyDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Page of master keys" }, "CreateMasterKeyRequestDto": { "required": ["encryptedPrivateKey", "originalPasscodeEncryptionCode", "publicKey"], "type": "object", "properties": { "publicKey": { "type": "string", "description": "the clients public key" }, "encryptedPrivateKey": { "type": "string", "description": "the clients encrypted private key" }, "label": { "type": "string", "description": "optional label to apply to the master key", "nullable": true }, "originalPasscodeEncryptionCode": { "maxLength": 40, "minLength": 8, "type": "string", "description": "the encryption code that was used to encrypt the original passcode on the printed PDF\r\nthe user downloaded.  Saved by the server in case the user needs to recover it." } }, "additionalProperties": false, "description": "Request from the client to create a new master key, supplying the clients public and encrypted private keys." }, "CreateMasterKeyResponseDto": { "type": "object", "properties": { "masterKeyId": { "type": "string", "description": "the id of the created master key", "nullable": true } }, "additionalProperties": false, "description": "Response to a successful `CreateMasterKeyRequest`" }, "ActivateMasterKeyRequestDto": { "required": ["activationCode"], "type": "object", "properties": { "activationCode": { "maxLength": 6, "minLength": 6, "type": "string", "description": "the activation code found on the Backup PDF" } }, "additionalProperties": false, "description": "Request from the client to activate a master key" }, "CreateMerchantProfileDto": { "type": "object", "properties": { "name": { "type": "string", "description": "the business name of the merchant", "nullable": true }, "uboName": { "type": "string", "description": "full name of the Ultimate Beneficiary Owner (UBO) of the business", "nullable": true }, "country": { "type": "string", "description": "the merchant's business country of registration", "nullable": true }, "websiteUrl": { "type": "string", "description": "the url to the merchants website", "format": "uri", "nullable": true }, "address": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "the merchant's business address", "nullable": true }, "email": { "type": "string", "description": "the merchant's business email", "nullable": true }, "phone": { "type": "string", "description": "the phone number of the business", "nullable": true }, "description": { "type": "string", "description": "the description of the merchant", "nullable": true }, "registrationNumber": { "type": "string", "description": "the business registration number", "nullable": true } }, "additionalProperties": false, "description": "Represents info needed when creating a Merchant" }, "MerchantProfileDto": { "type": "object", "properties": { "name": { "type": "string", "description": "the business name of the merchant", "nullable": true }, "uboName": { "type": "string", "description": "full name of the Ultimate Beneficiary Owner (UBO) of the business", "nullable": true }, "websiteUrl": { "type": "string", "description": "the url to the merchants website", "nullable": true }, "country": { "type": "string", "description": "the merchant's business country of registration", "nullable": true }, "logoUrl": { "type": "string", "description": "the url to the merchant's logo", "nullable": true }, "email": { "type": "string", "description": "the merchant's business email", "nullable": true }, "address": { "type": "string", "description": "the merchant's business address", "nullable": true }, "phone": { "type": "string", "description": "the phone number of the business", "nullable": true }, "description": { "type": "string", "description": "the description of the merchant", "nullable": true }, "registrationNumber": { "type": "string", "description": "the business registration number", "nullable": true } }, "additionalProperties": false, "description": "Represents a merchant's profile info" }, "UpdateMerchantProfileDto": { "type": "object", "properties": { "name": { "type": "string", "description": "the business name of the merchant", "nullable": true }, "uboName": { "type": "string", "description": "full name of the Ultimate Beneficiary Owner (UBO) of the business", "nullable": true }, "country": { "type": "string", "description": "the merchant's business country of registration", "nullable": true }, "websiteUrl": { "type": "string", "description": "the url to the merchants website", "nullable": true }, "address": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "the merchant's business address", "nullable": true }, "email": { "type": "string", "description": "the merchant's business email", "nullable": true }, "phone": { "type": "string", "description": "the phone number of the business", "nullable": true }, "description": { "type": "string", "description": "the description of the merchant", "nullable": true }, "registrationNumber": { "type": "string", "description": "the business registration number", "nullable": true } }, "additionalProperties": false, "description": "Represents info to update for a Merchant" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "extensions": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "MerchantPaymentCurrencyPayoutFrequency": { "enum": ["normal", "asSoonAsPossible", "hourly", "nightly", "weekly"], "type": "string" }, "PayoutConfigDto": { "type": "object", "properties": { "walletId": { "type": "string", "description": "the id of the wallet into which to payout to", "nullable": true }, "currencyId": { "type": "integer", "description": "the currency id of the wallet or address into which to payout to", "format": "int32" }, "address": { "type": "string", "description": "the external address into which to payout to", "nullable": true }, "payoutSplit": { "type": "integer", "description": "the percentage of payout to be sent to this endpoint (0..100).\r\nSince we are only supporting single payout for now, it is set to 100.", "format": "int32", "readOnly": true } }, "additionalProperties": false, "description": "Represents info needed to specify payout configuration for payments" }, "AcceptedCurrencyDto": { "type": "object", "properties": { "currency": { "allOf": [{ "$ref": "#/components/schemas/CurrencyDto" }], "description": "the currency that the merchant accepts", "nullable": true }, "payoutFrequency": { "allOf": [{ "$ref": "#/components/schemas/MerchantPaymentCurrencyPayoutFrequency" }], "description": "the frequency of payments into merchant wallets for the current payment currency" }, "order": { "type": "integer", "description": "the ranking of this payment currency relative to other payment currencies of the merchant", "format": "int32" }, "discountPercent": { "type": "number", "description": "the discount to give buyers when paying in this currency, maybe as a promotional tool", "format": "float" }, "markupPercent": { "type": "number", "description": "the markup to charge buyers when paying in this currency, maybe to cover local crypto/fiat conversion costs", "format": "float" }, "payoutConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutConfigDto" }, "description": "the configurations defining how the merchant would like to receive funds from the current payment currency", "nullable": true } }, "additionalProperties": false, "description": "Represents info about a merchant's accepted currency" }, "AcceptedCurrenciesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AcceptedCurrencyDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Represents a merchant's accepted currencies" }, "AddAcceptedCurrencyConfigDto": { "type": "object", "properties": { "frequency": { "allOf": [{ "$ref": "#/components/schemas/MerchantPaymentCurrencyPayoutFrequency" }], "description": "the frequency of payments into merchant wallets for the current payment currency", "nullable": true }, "discountPercent": { "maximum": 99.99, "minimum": 0, "type": "number", "description": "the discount to give buyers when paying in this currency, maybe as a promotional tool", "format": "float", "nullable": true }, "markupPercent": { "maximum": 999999999, "minimum": 0, "type": "number", "description": "the markup to charge buyers when paying in this currency, maybe to cover local crypto/fiat conversion costs", "format": "float", "nullable": true }, "payouts": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutConfigDto" }, "description": "the configurations defining how the merchant would like to receive funds from the current payment currency", "nullable": true } }, "additionalProperties": false, "description": "Add info needed to configure an accepted Currency" }, "UpdateAcceptedCurrencyConfigDto": { "type": "object", "properties": { "frequency": { "allOf": [{ "$ref": "#/components/schemas/MerchantPaymentCurrencyPayoutFrequency" }], "description": "the frequency of payments into merchant wallets for the current payment currency", "nullable": true }, "discountPercent": { "maximum": 99.99, "minimum": 0, "type": "number", "description": "the discount to give buyers when paying in this currency, maybe as a promotional tool", "format": "float", "nullable": true }, "markupPercent": { "maximum": 999999999, "minimum": 0, "type": "number", "description": "the markup to charge buyers when paying in this currency, maybe to cover local crypto/fiat conversion costs", "format": "float", "nullable": true }, "payouts": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutConfigDto" }, "description": "the configurations defining how the merchant would like to receive funds from the current payment currency", "nullable": true } }, "additionalProperties": false, "description": "Update for info needed to configure an accepted Currency" }, "ChangeAcceptedCurrencyOrderDto": { "required": ["order"], "type": "object", "properties": { "order": { "type": "integer", "description": "The order (preferred rank) of a payment currency. The smaller the number, the more the currency is preferred for payment.\r\nTo unassign the rank of a payment currency (ie, currency is still accepted but no longer preferred), pass in a 0 for the Order.", "format": "int32" } }, "additionalProperties": false }, "MerchantLogoDto": { "type": "object", "properties": { "logoUrl": { "type": "string", "description": "The url to the merchant's logo", "nullable": true } }, "additionalProperties": false, "description": "Represents merchant's logo" }, "CallbackAddressWebhookDto": { "type": "object", "properties": { "url": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "the url to send notifications to when deposits are detected (if null then URLs configured in client are used)", "nullable": true }, "nativeCurrencyId": { "type": "integer", "description": "the id of the native currency to include a conversion to in any webhook notifications sent", "format": "int32", "nullable": true }, "customData": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "custom data that will be sent back in all webhook notifications sent", "nullable": true } }, "additionalProperties": false, "description": "Webhook notification customizations for a callback address, if not specified the settings for the client will be used" }, "NewCallbackAddressDto": { "required": ["currencyId"], "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "currencyId": { "type": "integer", "description": "the id of the currency the address will be receiving", "format": "int32" }, "label": { "maxLength": 100, "minLength": 0, "type": "string", "description": "the label of the address (display only)", "nullable": true }, "webhook": { "allOf": [{ "$ref": "#/components/schemas/CallbackAddressWebhookDto" }], "description": "the webhook notification information and customizations", "nullable": true } }, "additionalProperties": false, "description": "Request to create a new merchant callback address" }, "CallbackAddressDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the unique id of the callback address", "nullable": true }, "clientId": { "type": "string", "description": "the merchant client this callback address is linked to", "nullable": true }, "created": { "type": "string", "description": "the timestamp of when the callback address was created", "format": "date-time" }, "currencyId": { "type": "integer", "description": "the id of the currency the address is receiving", "format": "int32" }, "address": { "type": "string", "description": "the actual deposit address", "nullable": true }, "label": { "type": "string", "description": "the display label of the callback address", "nullable": true }, "webhook": { "allOf": [{ "$ref": "#/components/schemas/CallbackAddressWebhookDto" }], "description": "the webhook notification information and customizations", "nullable": true } }, "additionalProperties": false, "description": "Merchant deposit address which sends Webhook notifications when deposits are detected and received" }, "PagedCallbackAddressesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackAddressDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "UpdateCallbackAddressDto": { "type": "object", "properties": { "label": { "maxLength": 100, "minLength": 0, "type": "string", "description": "the label of the address (display only)", "nullable": true }, "webhook": { "allOf": [{ "$ref": "#/components/schemas/CallbackAddressWebhookDto" }], "description": "the webhook notification information and customizations", "nullable": true } }, "additionalProperties": false, "description": "Request to update a callback address" }, "InvoiceCurrencyTokenDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "symbol": { "type": "string", "nullable": true }, "contractAddress": { "type": "string", "nullable": true }, "decimalPlaces": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "InvoiceCurrencyLogoDto": { "type": "object", "properties": { "imageUrl": { "type": "string", "nullable": true }, "vectorUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceCurrencyDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "symbol": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "token": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyTokenDto" }], "nullable": true }, "logo": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyLogoDto" }], "nullable": true }, "decimalPlaces": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CallbackDepositTransactionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the CoinPayments id of the callback deposit transaction", "nullable": true }, "created": { "type": "string", "description": "the timestamp when the transaction was created in the system", "format": "date-time" }, "completed": { "type": "string", "description": "the timestamp when the transaction was completed in the system (confirmed on the blockchain)", "format": "date-time", "nullable": true }, "blockchainTxId": { "type": "string", "description": "the blockchain transaction id, if available", "nullable": true }, "callbackAddressId": { "type": "string", "description": "the id of the callback address receiving the payment", "nullable": true }, "address": { "type": "string", "description": "the address the payment was received on", "nullable": true }, "currency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyDto" }], "description": "the currency the payment is in", "nullable": true }, "nativeCurrency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyDto" }], "description": "the currency the native amounts are in", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total amount of the payment in the payment currency (e.g. Bitcoin)", "nullable": true }, "coinPaymentsFee": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the fee deducted by CoinPayments in the payment currency (e.g. Bitcoin)", "nullable": true }, "nativeAmount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total amount of the payment in the native currency (e.g. USD)", "nullable": true }, "nativeCoinPaymentsFee": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the fee deducted by CoinPayments in the native currency (e.g. USD)", "nullable": true }, "status": { "type": "string", "description": "the status of the payment (Detected or Confirmed)", "nullable": true } }, "additionalProperties": false, "description": "Deposit transaction to a callback address" }, "PagedCallbackDepositTransactionsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackDepositTransactionDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "MerchantClientPublicState": { "enum": ["active", "disabled"], "type": "string", "description": "Specifies the states that are exposed publicly through the API" }, "MerchantClientDto": { "type": "object", "properties": { "clientId": { "type": "string", "description": "the unique id for the client app that the merchant will use to communicate with CoinPayments REST API", "nullable": true }, "integration": { "type": "string", "description": "the name of the integration for which this client was created", "nullable": true }, "name": { "type": "string", "description": "the name of the client app", "nullable": true }, "state": { "allOf": [{ "$ref": "#/components/schemas/MerchantClientPublicState" }], "description": "the state of the client" }, "storeUrl": { "type": "string", "description": "the store url of the client", "nullable": true } }, "additionalProperties": false }, "MerchantClientsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "CreateMerchantClientDto": { "required": ["name", "storeUrl"], "type": "object", "properties": { "integration": { "maxLength": 100, "minLength": 1, "type": "string", "description": "the name of the integration for which this client was created (e.g. 'Magento', or 'Shopify')", "nullable": true }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "the name of the client that the merchant should provide" }, "storeUrl": { "type": "string", "description": "the store url of the client", "format": "uri" } }, "additionalProperties": false, "description": "Represents the name of the merchant's client" }, "UpdateMerchantClientDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the client provided by the merchant", "nullable": true }, "storeUrl": { "type": "string", "description": "the store url of the client", "nullable": true }, "state": { "allOf": [{ "$ref": "#/components/schemas/MerchantClientPublicState" }], "description": "The state of the client to update to", "nullable": true } }, "additionalProperties": false }, "RegenerateSecretResponseDto": { "type": "object", "properties": { "clientSecret": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantClientWebhookNotification": { "enum": ["invoiceCreated", "invoicePending", "invoicePaid", "invoiceCompleted", "invoiceCancelled"], "type": "string", "description": "The notification types for a webhook" }, "MerchantClientWebhookEndpointDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the id of the notifications endpoint", "nullable": true }, "notificationsUrl": { "type": "string", "description": "the url to which to POST webhook notifications to", "nullable": true }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientWebhookNotification" }, "description": "the types of notifications to send to this endpoint", "nullable": true } }, "additionalProperties": false, "description": "Represents an endpoint at which the merchant wishes to receive webhook notifications for the client app" }, "MerchantClientWebhookEndpointsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientWebhookEndpointDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Represents an endpoint at which the merchant wishes to receive webhook notifications for the client app" }, "CreateMerchantClientWebhookRequestDto": { "required": ["notifications", "notificationsUrl"], "type": "object", "properties": { "notificationsUrl": { "type": "string", "description": "the url to which to POST webhook notifications to", "format": "uri" }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientWebhookNotification" }, "description": "the types of notifications to send to this endpoint" } }, "additionalProperties": false }, "UpdateMerchantClientWebhookDto": { "type": "object", "properties": { "notificationsUrl": { "type": "string", "description": "the url to which to POST webhook notifications to", "format": "uri", "nullable": true }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantClientWebhookNotification" }, "description": "the types of notifications to send to this endpoint", "nullable": true } }, "additionalProperties": false }, "MerchantInvoiceEmailDeliveryOptionsDto": { "type": "object", "properties": { "to": { "maxLength": 500, "minLength": 0, "type": "string", "description": "the email `to` field, multiple addresses separated by semicolons", "nullable": true }, "cc": { "maxLength": 500, "minLength": 0, "type": "string", "description": "the email `cc` field, multiple addresses separated by semicolons", "nullable": true }, "bcc": { "maxLength": 500, "minLength": 0, "type": "string", "description": "the email `bcc` field, multiple addresses separated by semicolons", "nullable": true } }, "additionalProperties": false, "description": "Email delivery options of a merchant invoice" }, "MerchantInvoiceLineItemDto": { "type": "object", "properties": { "customId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the API caller provided external ID for the item.  Appears on the Merchant dashboard and reports only.", "nullable": true }, "sku": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the stock keeping unit (SKU) of the item", "nullable": true }, "name": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the name or title of the item", "nullable": true }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "the detailed description of the item", "nullable": true }, "quantity": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "the quantity of the item.  Must be greater than 0 and less than 999,999,999‬.\r\ndefaults to 1 if not provided.", "format": "int32" }, "originalAmount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "the original total price of the item if Orion.Api.Models.Merchant.Dashboard.MerchantInvoices.MerchantInvoiceLineItemDto.Amount represents a discounted price", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "the subtotal price of the item (note: this is not a per unit price but the total price for the total quantity)", "nullable": true }, "tax": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "the total taxes charged on this item", "nullable": true } }, "additionalProperties": false, "description": "Represents an item of a merchant invoice that a buyer intends to purchase from a merchant" }, "InvoiceMerchantOptionsDto": { "type": "object", "properties": { "showAddress": { "type": "boolean" }, "showEmail": { "type": "boolean" }, "showPhone": { "type": "boolean" }, "showRegistrationNumber": { "type": "boolean" }, "additionalInfo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateMerchantInvoiceBuyNowButtonHtmlRequestDto": { "required": ["cancelUrl", "successUrl"], "type": "object", "properties": { "successUrl": { "type": "string", "description": "the url to redirect to once an invoice is successfully paid" }, "cancelUrl": { "type": "string", "description": "the url to redirect to if payment of an invoice fails (e.g. expired) or is cancelled by the user" }, "ipnUrl": { "type": "string", "description": "the url to send a payment complete message to once the invoice has been paid", "nullable": true }, "emailNotifications": { "type": "boolean", "description": "flag indicating whether to send an email notification once payment completes successfully" }, "buttonWidth": { "type": "integer", "description": "the desired width of the \"Buy Now\" button", "format": "int32", "nullable": true }, "buttonStyle": { "type": "string", "description": "the style of the button", "nullable": true }, "isEmailDelivery": { "type": "boolean", "description": "indicates if invoice will be email delivered" }, "emailDelivery": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceEmailDeliveryOptionsDto" }], "description": "the invoice email delivery options if the invoice is to be emailed", "nullable": true }, "dueDate": { "type": "string", "description": "optional due date to be shown on the invoice", "format": "date-time", "nullable": true }, "invoiceDate": { "type": "string", "description": "optional custom invoice date if not the created date of the invoice, invoices with a future date will\r\nbe scheduled", "format": "date-time", "nullable": true }, "draft": { "type": "boolean", "description": "flag indicating whether this is a draft invoice", "nullable": true }, "clientId": { "type": "string", "description": "the id of the client creating this invoice (optional)", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information, if not provided it can be requested during payment if needed", "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "description": "the purchase description, can be provided instead of a list of `items`", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceLineItemDto" }, "description": "the optional array of items that a buyer intends to purchase from the merchant", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }], "description": "the total amount of the invoice, with an optional breakdown that provides details, such as the total item\r\namount, total tax amount, shipping, handling, insurance and discounts, if any", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the optional shipping method and address", "nullable": true }, "requireBuyerNameAndEmail": { "type": "boolean", "description": "flag indicating whether a buyer name and email are required, they will be requested at checkout\r\nif not provider by the caller.  The Orion.Api.Models.Merchant.CreateMerchantInvoiceRequestDto.BuyerDataCollectionMessage will be displayed\r\nto the buyer when prompted.", "nullable": true }, "buyerDataCollectionMessage": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the message to display when collecting buyer user data", "nullable": true }, "notes": { "maxLength": 500, "minLength": 0, "type": "string", "description": "notes for the merchant only, these are not visible to the buyers", "nullable": true }, "notesToRecipient": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any additional information to share with the buyer about the transaction", "nullable": true }, "termsAndConditions": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any terms and conditions, e.g. a cancellation policy", "nullable": true }, "merchantOptions": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantOptionsDto" }], "description": "options to show/hide merchant information on an invoice, or include additional merchant information specific to an invoice", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "any custom data the caller wishes to attach to the invoice which will be sent back in notifications", "nullable": true }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMetadataDto" }], "nullable": true } }, "additionalProperties": false, "description": "Request to create the HTML for a \"Buy Now\" Button" }, "MerchantInvoiceNextIdDto": { "type": "object", "properties": { "invoiceId": { "type": "string", "description": "Merchant invoice id, if not unique will be appended with auto-incrementing numbers, otherwise\r\nif unique will be used directly", "nullable": true } }, "additionalProperties": false }, "InvoiceStatus": { "enum": ["draft", "scheduled", "unpaid", "pending", "paid", "completed", "cancelled", "timedOut"], "type": "string" }, "MerchantInvoiceSummaryMoneyDto": { "type": "object", "properties": { "currencySymbol": { "type": "string", "nullable": true }, "currencyId": { "type": "integer", "format": "int32" }, "contractAddress": { "type": "string", "nullable": true }, "displayValue": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantInvoiceSummaryShippingDto": { "type": "object", "properties": { "address": { "allOf": [{ "$ref": "#/components/schemas/AddressDto" }], "description": "the address of the party to ship the items to", "nullable": true } }, "additionalProperties": false, "description": "The buyer's shipping address" }, "MerchantInvoiceSummaryMetadataDto": { "type": "object", "properties": { "integration": { "type": "string", "description": "the integration from which the invoice was created", "nullable": true } }, "additionalProperties": false }, "MerchantInvoiceSummaryDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the CoinPayments id for the invoice", "nullable": true }, "invoiceId": { "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "created": { "type": "string", "description": "the timestamp when the invoice entity was created", "format": "date-time" }, "invoiceDate": { "type": "string", "description": "the date of the invoice, either the system created date or custom date specified by the merchant", "format": "date-time" }, "dueDate": { "type": "string", "description": "optional due date of the invoice", "format": "date-time", "nullable": true }, "confirmed": { "type": "string", "description": "the timestamp when the invoice was confirmed (paid)", "format": "date-time", "nullable": true }, "completed": { "type": "string", "description": "the timestamp when the invoice was completed (paid out to the merchant and CoinPayments fees)", "format": "date-time", "nullable": true }, "cancelled": { "type": "string", "description": "the timestamp when the invoice was manually cancelled. Applicable for payment invoices only", "format": "date-time", "nullable": true }, "currency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyDto" }], "description": "the currency the invoice is in", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information", "nullable": true }, "description": { "type": "string", "description": "the purchase description", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceSummaryMoneyDto" }], "description": "the total amount of the invoice", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceSummaryShippingDto" }], "description": "the shipping info", "nullable": true }, "status": { "allOf": [{ "$ref": "#/components/schemas/InvoiceStatus" }], "description": "the status of the invoice (including payments received and payments confirmed)" }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceSummaryMetadataDto" }], "description": "the invoice metadata, the integration where the invoice was created", "nullable": true }, "payouts": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceSummaryMoneyDto" }, "description": "the payout amounts expected or received", "nullable": true }, "isEmailDelivery": { "type": "boolean", "description": "indicates if invoice was delivered or to be delivered by email" } }, "additionalProperties": false, "description": "Summary for a merchant invoice" }, "MerchantInvoiceSummariesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceSummaryDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "CreateMerchantInvoiceRequestDto": { "type": "object", "properties": { "isEmailDelivery": { "type": "boolean", "description": "indicates if invoice will be email delivered" }, "emailDelivery": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceEmailDeliveryOptionsDto" }], "description": "the invoice email delivery options if the invoice is to be emailed", "nullable": true }, "dueDate": { "type": "string", "description": "optional due date to be shown on the invoice", "format": "date-time", "nullable": true }, "invoiceDate": { "type": "string", "description": "optional custom invoice date if not the created date of the invoice, invoices with a future date will\r\nbe scheduled", "format": "date-time", "nullable": true }, "draft": { "type": "boolean", "description": "flag indicating whether this is a draft invoice", "nullable": true }, "clientId": { "type": "string", "description": "the id of the client creating this invoice (optional)", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information, if not provided it can be requested during payment if needed", "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "description": "the purchase description, can be provided instead of a list of `items`", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceLineItemDto" }, "description": "the optional array of items that a buyer intends to purchase from the merchant", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }], "description": "the total amount of the invoice, with an optional breakdown that provides details, such as the total item\r\namount, total tax amount, shipping, handling, insurance and discounts, if any", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the optional shipping method and address", "nullable": true }, "requireBuyerNameAndEmail": { "type": "boolean", "description": "flag indicating whether a buyer name and email are required, they will be requested at checkout\r\nif not provider by the caller.  The Orion.Api.Models.Merchant.CreateMerchantInvoiceRequestDto.BuyerDataCollectionMessage will be displayed\r\nto the buyer when prompted.", "nullable": true }, "buyerDataCollectionMessage": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the message to display when collecting buyer user data", "nullable": true }, "notes": { "maxLength": 500, "minLength": 0, "type": "string", "description": "notes for the merchant only, these are not visible to the buyers", "nullable": true }, "notesToRecipient": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any additional information to share with the buyer about the transaction", "nullable": true }, "termsAndConditions": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any terms and conditions, e.g. a cancellation policy", "nullable": true }, "merchantOptions": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantOptionsDto" }], "description": "options to show/hide merchant information on an invoice, or include additional merchant information specific to an invoice", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "any custom data the caller wishes to attach to the invoice which will be sent back in notifications", "nullable": true }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMetadataDto" }], "nullable": true } }, "additionalProperties": false, "description": "Used for creating an invoice on the dashboard.\r\nRequest to create an invoice, which is a list of goods or services with a statement of the sum due provided\r\nby the merchant, that a buyer intends to purchase" }, "InvoiceMerchantDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "uboName": { "type": "string", "nullable": true }, "websiteUrl": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "logoUrl": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "registrationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceEmailDeliveryOptionsDto": { "type": "object", "properties": { "to": { "type": "string", "nullable": true }, "cc": { "type": "string", "nullable": true }, "bcc": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceDto": { "required": ["amount"], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "confirmed": { "type": "string", "format": "date-time", "nullable": true }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "cancelled": { "type": "string", "format": "date-time", "nullable": true }, "currency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceCurrencyDto" }], "nullable": true }, "merchant": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantDto" }], "nullable": true }, "merchantOptions": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantOptionsDto" }], "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDto" }, "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }] }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "status": { "allOf": [{ "$ref": "#/components/schemas/InvoiceStatus" }] }, "requireBuyerNameAndEmail": { "type": "boolean", "nullable": true }, "buyerDataCollectionMessage": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "notesToRecipient": { "type": "string", "nullable": true }, "termsAndConditions": { "type": "string", "nullable": true }, "emailDelivery": { "allOf": [{ "$ref": "#/components/schemas/InvoiceEmailDeliveryOptionsDto" }], "nullable": true }, "isEmailDelivery": { "type": "boolean" }, "metadata": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMetadataDto" }], "nullable": true }, "ref": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateMerchantInvoiceRequestDto": { "type": "object", "properties": { "isEmailDelivery": { "type": "boolean", "description": "indicates if invoice will be email delivered" }, "emailDelivery": { "allOf": [{ "$ref": "#/components/schemas/MerchantInvoiceEmailDeliveryOptionsDto" }], "description": "the invoice email delivery options if the invoice is to be emailed", "nullable": true }, "dueDate": { "type": "string", "description": "optional due date to be shown on the invoice", "format": "date-time", "nullable": true }, "invoiceDate": { "type": "string", "description": "optional custom invoice date if not the created date of the invoice, invoices with a future date will\r\nbe scheduled", "format": "date-time", "nullable": true }, "draft": { "type": "boolean", "description": "flag indicating whether this is a draft invoice", "nullable": true }, "invoiceId": { "maxLength": 127, "minLength": 0, "type": "string", "description": "the optional API caller provided external invoice number.  Appears in screens shown to the Buyer and emails sent.", "nullable": true }, "buyer": { "allOf": [{ "$ref": "#/components/schemas/BuyerDto" }], "description": "the buyer information, if not provided it can be requested during payment if needed", "nullable": true }, "description": { "maxLength": 200, "minLength": 0, "type": "string", "description": "the purchase description, can be provided instead of a list of `items`", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantInvoiceLineItemDto" }, "description": "the optional array of items that a buyer intends to purchase from the merchant", "nullable": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceAmountDto" }], "description": "the total amount of the invoice, with an optional breakdown that provides details, such as the total item\r\namount, total tax amount, shipping, handling, insurance and discounts, if any", "nullable": true }, "shipping": { "allOf": [{ "$ref": "#/components/schemas/InvoiceShippingDetailDto" }], "description": "the optional shipping method and address", "nullable": true }, "requireBuyerNameAndEmail": { "type": "boolean", "description": "flag indicating whether a buyer name and email are required, they will be requested at checkout\r\nif not provider by the caller.  The Orion.Api.Models.Merchant.UpdateMerchantInvoiceRequestDto.BuyerDataCollectionMessage will be displayed\r\nto the buyer when prompted.", "nullable": true }, "buyerDataCollectionMessage": { "maxLength": 300, "minLength": 0, "type": "string", "description": "the message to display when collecting buyer user data", "nullable": true }, "notes": { "maxLength": 500, "minLength": 0, "type": "string", "description": "notes for the merchant only, these are not visible to the buyers", "nullable": true }, "notesToRecipient": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any additional information to share with the buyer about the transaction", "nullable": true }, "termsAndConditions": { "maxLength": 500, "minLength": 0, "type": "string", "description": "any terms and conditions, e.g. a cancellation policy", "nullable": true }, "merchantOptions": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMerchantOptionsDto" }], "description": "options to show/hide merchant information on an invoice, or include additional merchant information specific to an invoice", "nullable": true }, "customData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "any custom data the caller wishes to attach to the invoice which will be sent back in notifications", "nullable": true } }, "additionalProperties": false, "description": "Used for creating an invoice on the dashboard.\r\nRequest to create an invoice, which is a list of goods or services with a statement of the sum due provided\r\nby the merchant, that a buyer intends to purchase" }, "InvoicePaymentHotWalletPayoutState": { "enum": ["scheduled", "sending", "sent", "confirmed"], "type": "string" }, "InvoicePayoutDetailsDto": { "type": "object", "properties": { "currency": { "allOf": [{ "$ref": "#/components/schemas/CurrencyDto" }], "description": "the currency (merchant's accepted currency) that will be received", "nullable": true }, "merchantFees": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "The amount for service fees in the merchant's accepted currency", "nullable": true }, "payoutAmount": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "This is the amount to be finally paid out to the merchant in the merchant's accepted currency", "nullable": true }, "payoutAmountInInvoiceCurrency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "The Orion.Api.Models.Merchant.InvoicePayoutDetailsDto.PayoutAmount in the invoice currency", "nullable": true }, "merchantFeesInInvoiceCurrency": { "allOf": [{ "$ref": "#/components/schemas/InvoiceMoneyDto" }], "description": "The Orion.Api.Models.Merchant.InvoicePayoutDetailsDto.MerchantFees in the invoice currency", "nullable": true }, "merchantPayoutAddress": { "type": "string", "description": "the merchants payment output address at the time the hot wallet was created", "nullable": true }, "created": { "type": "string", "description": "the timestamp of when this payout was created (or scheduled)", "format": "date-time" }, "sent": { "type": "string", "description": "the timestamp of when this payout was sent (e.g. broadcast on the blockchain)", "format": "date-time", "nullable": true }, "expected": { "type": "string", "description": "the approximate timestamp of when this payout is expected to be sent (e.g. broadcast on the blockchain)", "format": "date-time", "nullable": true }, "confirmed": { "type": "string", "description": "the timestamp of when this payout was confirmed (e.g. on the blockchain)", "format": "date-time", "nullable": true }, "state": { "allOf": [{ "$ref": "#/components/schemas/InvoicePaymentHotWalletPayoutState" }], "description": "the current state of the payout" } }, "additionalProperties": false, "description": "Represents a payout to a Merchant" }, "InvoicePayoutsDetailsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePayoutDetailsDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false, "description": "Represents information about a payouts to a Merchant" }, "UserPreferencesDto": { "type": "object", "properties": { "nativeCurrencyId": { "type": "string", "description": "the users native currency id, api calls will return monetary amounts in this currency along with the\r\noriginal currencies", "nullable": true, "example": "1235" }, "notifyOnFundsReceived": { "type": "boolean", "description": "value indicating whether to send the user a notification when funds are received into one of their accounts" }, "notifyOnFundsSent": { "type": "boolean", "description": "value indicating whether to send the user a notification when funds are sent from one of their accounts" }, "language": { "type": "string", "description": "the language code for the user (e.g. 'EN' or 'EN-US')", "nullable": true } }, "additionalProperties": false }, "ChangeUserPreferencesRequestDto": { "type": "object", "properties": { "nativeCurrencyId": { "type": "string", "description": "the users native currency id, api calls will return monetary amounts in this currency along with the\r\noriginal currencies.  If not specified then the current preference will not be updated.", "nullable": true, "example": "1235" }, "notifyOnFundsReceived": { "type": "boolean", "description": "optional value indicating whether to send the user a notification when funds are received into one of,\r\ntheir accounts.  If not specified then the current preference will not be updated.", "nullable": true }, "notifyOnFundsSent": { "type": "boolean", "description": "optional value indicating whether to send the user a notification when funds are sent from one of their\r\naccounts.  If not specified then the current preference will not be updated.", "nullable": true }, "language": { "maxLength": 5, "minLength": 2, "type": "string", "description": "optional language code for the user (e.g. 'EN' or 'EN-US')", "nullable": true } }, "additionalProperties": false }, "RateDto": { "type": "object", "properties": { "baseCurrencyId": { "type": "integer", "description": "the currency code of the source/base currency", "format": "int32", "example": 123 }, "baseToken": { "type": "string", "description": "the contract address of the source/base token on the base currency platform", "nullable": true }, "quoteCurrencyId": { "type": "integer", "description": "the currency code of the target/quoted currency", "format": "int32", "example": 456 }, "quoteToken": { "type": "string", "description": "the contract address of the target/quoted token on the quoted currency platform", "nullable": true }, "rate": { "type": "string", "description": "the conversion rate to convert from `BaseCurrencyId` into `QuoteCurrencyId`", "nullable": true, "example": "0.011488196994190" } }, "additionalProperties": false, "description": "Conversion rate between two currencies" }, "RatesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RateDto" }, "nullable": true } }, "additionalProperties": false }, "ReportRequest": { "type": "object", "properties": { "txTypes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UserSettingsDto": { "required": ["key", "value"], "type": "object", "properties": { "key": { "maxLength": 95, "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "SmartContract": { "type": "object", "properties": { "currencyId": { "type": "integer", "format": "int32" }, "contractAddress": { "type": "string", "nullable": true }, "contractName": { "type": "string", "nullable": true }, "contractSymbol": { "type": "string", "nullable": true }, "isVerified": { "type": "boolean" }, "decimals": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TopUpOrderStatus": { "enum": ["new", "placed", "pending", "completed", "cancelled", "failed"], "type": "string" }, "TopUpOrderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the top up order", "nullable": true }, "created": { "type": "string", "description": "Time when the top up order was created", "format": "date-time" }, "blockchainTxId": { "type": "string", "description": "The blockchain transaction ID (hash)", "nullable": true }, "purchaseAmount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "The amount used to purchase crypto", "nullable": true }, "status": { "allOf": [{ "$ref": "#/components/schemas/TopUpOrderStatus" }], "description": "The status of the order" }, "coinReceived": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "The amount received or will be received in the purchased crypto", "nullable": true } }, "additionalProperties": false, "description": "Represents a top up order (crypto purchase)" }, "TopUpOrdersDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopUpOrderDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "TopUpProviderCurrencyDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "the unique id of the currency on the CoinPayments platform", "format": "int32", "example": 1235 }, "symbol": { "type": "string", "description": "ticker symbol for the currency.  For fiat currencies this is the three character (ISO-4217) currency code,\r\nand for crypto currencies their multi-character symbol.", "nullable": true, "example": "BTC" } }, "additionalProperties": false, "description": "Represents the currencies that can be purchased through a provider" }, "TopUpProviderDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the provider", "nullable": true }, "logoUrl": { "type": "string", "description": "the url to the logo of the provider", "nullable": true }, "currenciesCanPurchase": { "type": "array", "items": { "$ref": "#/components/schemas/TopUpProviderCurrencyDto" }, "description": "the currencies that can be purchased through this provider", "nullable": true } }, "additionalProperties": false, "description": "Represents details of a topup provider" }, "TopUpProvidersDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopUpProviderDto" }, "nullable": true } }, "additionalProperties": false }, "TransactionState": { "enum": ["created", "pending", "completed"], "type": "string" }, "TransactionInputOutputDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true }, "amount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the amount in the original currency", "nullable": true }, "nativeAmount": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the amount in the native currency of the user (rate at time of transaction)", "nullable": true }, "coinPaymentsFee": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the fee charged by CoinPayments on this side of the transaction", "nullable": true } }, "additionalProperties": false, "description": "Details of the input/output (origin/receiver) of a transaction" }, "TransactionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the unique id of the transaction on the CoinPayments® platform", "nullable": true }, "created": { "type": "string", "description": "timestamp when the transaction was created", "format": "date-time", "nullable": true, "example": "04/23/2018 18:25:43 +00:00" }, "completed": { "type": "string", "description": "timestamp when the transaction was completed/confirmed", "format": "date-time", "nullable": true, "example": "04/23/2018 18:25:43 +00:00" }, "state": { "allOf": [{ "$ref": "#/components/schemas/TransactionState" }], "description": "the state of the transaction" }, "memo": { "type": "string", "description": "the user's custom memo for this transaction", "nullable": true }, "from": { "allOf": [{ "$ref": "#/components/schemas/TransactionInputOutputDto" }], "description": "the input for the transaction, origin of where the funds came from", "nullable": true }, "to": { "allOf": [{ "$ref": "#/components/schemas/TransactionInputOutputDto" }], "description": "the output for the transaction, receiver of the funds, where funds were sent", "nullable": true }, "transactionType": { "type": "integer", "description": "Type of the transaction", "format": "int32" }, "contractAddress": { "type": "string", "description": "Source contract address for token transfers of account-based currencies like ERC20 for ETH", "nullable": true }, "toContractAddress": { "type": "string", "description": "Destination contract address for token transfers of account-based currencies like ERC20 for ETH", "nullable": true }, "conversionId": { "type": "integer", "description": "Id of the conversion corresponding to this transaction in the coinflip service", "format": "int64", "nullable": true } }, "additionalProperties": false, "description": "Transactions represent an event on one or more accounts (e.g. debit, withdrawal, transfer or conversion)" }, "TransactionDtoPagedItemsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false }, "TransactionHistoryEventDto": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "the timestamp of when the this event was observed", "format": "date-time" }, "eventType": { "type": "string", "description": "the type of event that was observed", "nullable": true }, "data": { "type": "object", "additionalProperties": false, "description": "optional custom data for the event", "nullable": true } }, "additionalProperties": false }, "TransactionHistoryEventsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionHistoryEventDto" }, "nullable": true } }, "additionalProperties": false }, "ChangeTransactionMemoRequestDto": { "type": "object", "properties": { "memo": { "type": "string", "description": "The new memo for the transaction", "nullable": true } }, "additionalProperties": false, "description": "Request to change the memo of a transaction" }, "TransactedVolumeDto": { "type": "object", "properties": { "volume": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "the total value of incoming and outgoing transactions", "nullable": true }, "limit": { "allOf": [{ "$ref": "#/components/schemas/MoneyDto" }], "description": "The maximum volume a user can reach before KYC is required", "nullable": true } }, "additionalProperties": false, "description": "Represents a user's transacted volume" }, "UserFeaturesDto": { "type": "object", "properties": { "topUp": { "type": "boolean", "description": "Indicates whether top up feature is available to user" } }, "additionalProperties": false, "description": "Represents specific features that are available or not available to certain users\r\n(for example, a feature will not be available to a user depending on which country they KYC'ed from)" }, "UserNotificationType": { "enum": ["warning", "news", "promotion"], "type": "string" }, "UserNotificationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "the id of the notification", "nullable": true }, "heading": { "type": "string", "description": "the heading of the notification", "nullable": true }, "body": { "type": "string", "description": "the body of the notification", "nullable": true }, "actionUrl": { "type": "string", "description": "link to go view more information about the notification or to take some action", "nullable": true }, "actionName": { "type": "string", "description": "the name to give the action (e.g. such as a button to go to the Orion.Api.Models.UserNotificationDto.ActionUrl)", "nullable": true }, "type": { "allOf": [{ "$ref": "#/components/schemas/UserNotificationType" }], "description": "the type of the notification" }, "publishedDate": { "type": "string", "description": "The date the notification started showing (was published)", "format": "date-time" }, "isRead": { "type": "boolean", "description": "indicates whether notification has been read by the user" } }, "additionalProperties": false, "description": "Active notification on a user's dashboard" }, "UserNotificationsDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationDto" }, "nullable": true }, "paging": { "allOf": [{ "$ref": "#/components/schemas/PagingDto" }], "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "implicit": { "authorizationUrl": "https://alpha-signin.coinpayments.net/connect/authorize", "scopes": { "orion": "Access to coinpayments apis" } } } } } } } }, "searchIndex": { "store": ["section/Authentication", "tag/Accounts", "tag/Accounts/paths/~1api~1v1~1accounts~1balances/get", "tag/Accounts/paths/~1api~1v1~1accounts/get", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1addresses/get", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1addresses/post", "operation/GetAccountAddress", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1label/put", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1addresses~1{addressId}~1label/put", "operation/GetAccount", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}/delete", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1keys/put", "tag/Accounts/paths/~1api~1v1~1accounts~1fee~1{masterKeyId}~1{currencyId}/get", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend~1validate/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend~1all~1validate/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend~1all/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1convert/post", "tag/Accounts/paths/~1api~1v1~1accounts~1{id}~1spend~1{spendRequestId}~1broadcast/post", "tag/Accounts/paths/~1api~1v1~1accounts~1multisig/post", "tag/Accounts/paths/~1api~1v1~1accounts~1singlesig/post", "tag/Affiliate", "tag/Affiliate/paths/~1api~1v1~1affiliate~1channels/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1channels/post", "operation/FindChannel", "tag/Affiliate/paths/~1api~1v1~1affiliate~1channels~1{id}/put", "tag/Affiliate/paths/~1api~1v1~1affiliate/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1fees/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1earnings/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1earnings~1summary/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1impressions~1daily/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1impressions~1country/get", "tag/Affiliate/paths/~1api~1v1~1affiliate~1impressions/get", "tag/Currencies", "tag/Currencies/paths/~1api~1v1~1currencies/get", "tag/Currencies/paths/~1api~1v1~1currencies~1{id}/get", "tag/Currencies/paths/~1api~1v1~1currencies~1conversions/get", "tag/Invoices", "tag/Invoices/paths/~1api~1v1~1invoices/post", "tag/Invoices/paths/~1api~1v1~1invoices~1{id}/put", "tag/Invoices/paths/~1api~1v1~1invoices~1{id}/get", "tag/MasterKeys", "operation/GetMasterKey", "tag/MasterKeys/paths/~1api~1v1~1masterkeys~1{id}/put", "tag/MasterKeys/paths/~1api~1v1~1masterkeys/get", "tag/MasterKeys/paths/~1api~1v1~1masterkeys/post", "tag/MasterKeys/paths/~1api~1v1~1masterkeys~1{id}~1activate/post", "tag/Merchant", "tag/Merchant/paths/~1api~1v1~1merchant/post", "tag/Merchant/paths/~1api~1v1~1merchant~1profile/get", "tag/Merchant/paths/~1api~1v1~1merchant~1profile/put", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies/get", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies~1{id}/post", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies~1{id}/put", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies~1{id}/delete", "tag/Merchant/paths/~1api~1v1~1merchant~1currencies~1{id}~1order/put", "tag/Merchant/paths/~1api~1v1~1merchant~1logo/post", "tag/Merchant/paths/~1api~1v1~1merchant~1logo/delete", "tag/MerchantCallbacks", "tag/MerchantCallbacks/paths/~1api~1v1~1merchant~1callbacks/post", "tag/MerchantCallbacks/paths/~1api~1v1~1merchant~1callbacks/get", "operation/FindCallbackAddress", "tag/MerchantCallbacks/paths/~1api~1v1~1merchant~1callbacks~1{id}/put", "tag/MerchantCallbacks/paths/~1api~1v1~1merchant~1callbacks~1deposits/get", "tag/MerchantClients", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients/get", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients/post", "operation/FindClientAsync", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}/put", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}/delete", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}~1secret/post", "operation/ListWebhooksForClientAsync", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}~1webhooks/post", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}~1webhooks~1{webhookId}/put", "tag/MerchantClients/paths/~1api~1v1~1merchant~1clients~1{clientId}~1webhooks~1{webhookId}/delete", "tag/MerchantInvoices", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1buy-now-button/post", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1nextid/post", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices/get", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices/post", "operation/FindInvoiceAsync", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}/put", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}~1history/get", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}~1cancel/post", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}~1delete/delete", "tag/MerchantInvoices/paths/~1api~1v1~1merchant~1invoices~1{id}~1payouts/get", "tag/Preferences", "tag/Preferences/paths/~1api~1v1~1preferences/get", "tag/Preferences/paths/~1api~1v1~1preferences/put", "tag/Rates", "tag/Rates/paths/~1api~1v1~1rates/get", "tag/Reports", "tag/Reports/paths/~1api~1v1~1reports/post", "tag/Settings", "tag/Settings/paths/~1api~1v1~1settings/post", "tag/Settings/paths/~1api~1v1~1settings/put", "tag/Settings/paths/~1api~1v1~1settings~1{key}/get", "tag/SharedInvoices", "tag/SharedInvoices/paths/~1api~1v1~1shared-invoices~1{sharedInvoiceId}/get", "tag/SmartContracts", "tag/SmartContracts/paths/~1api~1v1~1smartcontracts~1{currencyId}/get", "tag/SmartContracts/paths/~1api~1v1~1smartcontracts~1{currencyId}~1{contractsAddress}/get", "tag/TopUps", "tag/TopUps/paths/~1api~1v1~1topups~1orders/get", "tag/TopUps/paths/~1api~1v1~1topups~1providers/get", "tag/Transactions", "tag/Transactions/paths/~1api~1v1~1transactions/get", "tag/Transactions/paths/~1api~1v1~1transactions~1{id}/get", "tag/Transactions/paths/~1api~1v1~1transactions~1{id}~1events/get", "tag/Transactions/paths/~1api~1v1~1transactions~1{id}~1memo/put", "tag/Transactions/paths/~1api~1v1~1transactions~1volume/get", "tag/User", "tag/User/paths/~1api~1v1~1user~1features/get", "tag/UserNotifications", "tag/UserNotifications/paths/~1api~1v1~1notifications/get", "tag/UserNotifications/paths/~1api~1v1~1notifications~1{id}~1read/post"], "index": { "version": "2.3.8", "fields": ["title", "description"], "fieldVectors": [["title/0", [0, 6.398]], ["description/0", [1, 3.382, 2, 2.053, 3, 2.053]], ["title/1", [4, 2.877]], ["description/1", []], ["title/2", [4, 1.732, 5, 1.347, 6, 2.555, 7, 3.851, 8, 3.851, 9, 1.68]], ["description/2", []], ["title/3", [4, 2.06, 5, 1.602, 6, 3.039, 10, 3.69]], ["description/3", [4, 0.67, 6, 0.368, 9, 0.242, 11, 0.389, 12, 0.489, 13, 0.554, 14, 0.554, 15, 0.554, 16, 0.554, 17, 0.489, 18, 0.554, 19, 0.844, 20, 0.489, 21, 0.554, 22, 0.489, 23, 0.554]], ["title/4", [4, 1.494, 5, 1.162, 24, 1.915, 25, 2.676, 26, 1.839, 27, 2.095, 28, 2.933, 29, 2.485]], ["description/4", []], ["title/5", [4, 1.732, 26, 2.131, 30, 2.051, 31, 1.68, 32, 1.68, 33, 1.977]], ["description/5", []], ["title/6", [26, 3.224, 34, 2.228, 35, 2.316, 36, 3.694]], ["description/6", []], ["title/7", [4, 1.881, 30, 2.228, 31, 1.825, 37, 3.129, 38, 3.371]], ["description/7", []], ["title/8", [26, 2.316, 30, 2.228, 31, 1.825, 37, 3.129, 38, 3.371]], ["description/8", []], ["title/9", [4, 2.275, 34, 2.694, 35, 2.8]], ["description/9", []], ["title/10", [4, 1.732, 6, 2.555, 30, 2.051, 31, 1.68, 39, 2.555, 40, 3.4]], ["description/10", []], ["title/11", [4, 1.768, 24, 1.425, 30, 1.317, 31, 1.079, 37, 1.85, 41, 2.183, 42, 1.949, 43, 1.226, 44, 1.489, 45, 2.473, 46, 2.473]], ["description/11", []], ["title/12", [47, 3.851]], ["description/12", []], ["title/13", [4, 1.881, 31, 1.825, 48, 3.129, 49, 3.129, 50, 3.371]], ["description/13", []], ["title/14", [4, 1.881, 31, 1.825, 48, 3.129, 49, 3.129, 50, 3.371]], ["description/14", []], ["title/15", [4, 1.881, 30, 2.228, 31, 1.825, 49, 3.129, 50, 3.371]], ["description/15", [4, 0.352, 29, 0.585, 31, 0.341, 51, 1.447, 52, 0.783, 53, 1.447, 54, 0.783, 55, 0.691, 56, 0.783, 57, 0.783, 58, 0.691]], ["title/16", [47, 3.851]], ["description/16", []], ["title/17", [47, 3.851]], ["description/17", []], ["title/18", [31, 1.68, 43, 1.909, 49, 2.88, 59, 3.851, 60, 3.4, 61, 3.4]], ["description/18", [31, 0.43, 36, 0.871, 44, 0.594, 48, 0.737, 60, 0.871, 61, 0.871, 62, 1.788, 63, 0.986, 64, 0.871]], ["title/19", [4, 1.604, 6, 2.367, 30, 1.9, 31, 1.556, 32, 1.556, 33, 1.831, 65, 3.567]], ["description/19", []], ["title/20", [4, 1.604, 6, 2.367, 30, 1.9, 31, 1.556, 32, 1.556, 33, 1.831, 40, 3.149]], ["description/20", []], ["title/21", [66, 4.034]], ["description/21", []], ["title/22", [5, 1.602, 32, 1.998, 66, 2.889, 67, 2.757]], ["description/22", []], ["title/23", [32, 2.207, 33, 2.597, 67, 3.045]], ["description/23", []], ["title/24", [34, 2.694, 35, 2.8, 67, 3.045]], ["description/24", []], ["title/25", [42, 2.508, 67, 3.045, 68, 4.467]], ["description/25", []], ["title/26", [66, 3.191, 69, 3.191, 70, 4.467]], ["description/26", []], ["title/27", [66, 2.095, 69, 2.095, 71, 3.322, 72, 3.322, 73, 3.322, 74, 2.676, 75, 3.322, 76, 2.676]], ["description/27", []], ["title/28", [5, 1.162, 66, 2.095, 67, 2, 74, 2.676, 77, 2.204, 78, 2.332, 79, 2.485, 80, 2.933]], ["description/28", []], ["title/29", [47, 3.401, 74, 4.552]], ["description/29", []], ["title/30", [5, 1.022, 66, 1.842, 67, 1.758, 77, 1.938, 78, 2.05, 79, 2.185, 81, 2.353, 82, 2.05, 83, 2.921, 84, 2.353]], ["description/30", []], ["title/31", [5, 1.022, 66, 1.842, 67, 1.758, 77, 1.938, 78, 2.05, 79, 2.185, 81, 2.353, 82, 2.05, 84, 2.353, 85, 2.921]], ["description/31", []], ["title/32", [5, 1.162, 67, 2, 77, 2.204, 78, 2.332, 79, 2.485, 81, 2.676, 84, 2.676, 86, 2.933]], ["description/32", []], ["title/33", [9, 2.79]], ["description/33", []], ["title/34", [5, 1.463, 9, 1.825, 76, 3.371, 87, 3.694, 88, 4.185]], ["description/34", [9, 0.43, 11, 0.692, 12, 0.871, 27, 0.622, 76, 0.794, 87, 0.871, 89, 1.788, 90, 0.986, 91, 0.737]], ["title/35", [9, 2.207, 34, 2.694, 35, 2.8]], ["description/35", []], ["title/36", [5, 1.463, 9, 1.825, 69, 2.639, 82, 2.937, 92, 4.185]], ["description/36", []], ["title/37", [93, 2.968]], ["description/37", []], ["title/38", [32, 2.207, 33, 2.597, 93, 2.348]], ["description/38", []], ["title/39", [31, 1.68, 42, 1.909, 70, 3.4, 93, 1.787, 94, 2.88, 95, 1.732]], ["description/39", []], ["title/40", [34, 2.694, 35, 2.8, 93, 2.348]], ["description/40", []], ["title/41", [96, 5.648]], ["description/41", []], ["title/42", [34, 2.439, 35, 2.535, 44, 2.757, 97, 3.039]], ["description/42", []], ["title/43", [38, 2.676, 42, 1.647, 43, 1.647, 44, 2.97, 97, 2.204, 98, 3.322, 99, 3.322]], ["description/43", []], ["title/44", [5, 1.347, 24, 2.22, 32, 1.68, 44, 2.318, 97, 2.555, 100, 2.88]], ["description/44", [17, 1.332, 19, 1.216, 32, 0.658, 44, 0.908, 64, 1.332, 97, 1.001]], ["title/45", [30, 2.228, 31, 1.825, 32, 1.825, 33, 2.148, 96, 3.694]], ["description/45", [19, 1.073, 32, 0.581, 33, 0.684, 44, 0.802, 55, 1.176, 97, 0.884, 100, 0.996]], ["title/46", [44, 3.045, 97, 3.357, 100, 3.784]], ["description/46", []], ["title/47", [95, 2.877]], ["description/47", []], ["title/48", [24, 2.412, 32, 1.825, 95, 1.881, 101, 3.371, 102, 4.185]], ["description/48", []], ["title/49", [95, 2.275, 101, 4.076, 103, 3.357]], ["description/49", []], ["title/50", [42, 2.271, 95, 2.06, 101, 3.69, 103, 3.039]], ["description/50", []], ["title/51", [5, 0.963, 9, 1.866, 11, 1.933, 27, 1.737, 69, 1.737, 91, 2.06, 103, 1.828, 104, 2.432, 105, 2.219, 106, 2.219]], ["description/51", []], ["title/52", [9, 1.556, 41, 3.149, 94, 2.668, 95, 1.604, 107, 2.874, 108, 2.874, 109, 2.504]], ["description/52", []], ["title/53", [9, 1.556, 42, 1.768, 94, 2.668, 95, 1.604, 107, 2.874, 108, 2.874, 109, 2.504]], ["description/53", []], ["title/54", [9, 1.68, 39, 2.555, 95, 1.732, 105, 3.102, 107, 3.102, 110, 3.4]], ["description/54", []], ["title/55", [9, 1.425, 11, 1.382, 27, 2.641, 42, 1.62, 91, 2.444, 105, 1.587, 109, 1.382, 111, 1.739, 112, 1.97, 113, 1.97, 114, 1.739, 115, 1.739, 116, 1.739]], ["description/55", [33, 0.28, 42, 0.139, 91, 0.94, 95, 0.358, 111, 0.248, 114, 0.248, 116, 0.248, 117, 0.281, 118, 1.257, 119, 1.032, 120, 1.032, 121, 0.796, 122, 0.546, 123, 1.032, 124, 0.546]], ["title/56", [95, 2.275, 125, 5.06, 126, 4.467]], ["description/56", []], ["title/57", [39, 3.357, 95, 2.275, 126, 4.467]], ["description/57", []], ["title/58", [127, 6.398]], ["description/58", []], ["title/59", [26, 2.535, 32, 1.998, 33, 2.351, 128, 3.215]], ["description/59", []], ["title/60", [5, 1.248, 26, 1.974, 128, 2.504, 129, 3.149, 130, 3.567, 131, 3.567, 132, 2.874]], ["description/60", []], ["title/61", [26, 2.535, 34, 2.439, 35, 2.535, 128, 3.215]], ["description/61", []], ["title/62", [26, 2.8, 42, 2.508, 128, 3.551]], ["description/62", []], ["title/63", [5, 0.823, 9, 1.026, 25, 1.895, 26, 2.091, 27, 1.484, 28, 2.077, 29, 1.76, 77, 1.561, 78, 1.651, 80, 2.077, 128, 1.651, 132, 1.895, 133, 1.416]], ["description/63", []], ["title/64", [134, 6.398]], ["description/64", []], ["title/65", [43, 2.508, 95, 2.275, 135, 3.784]], ["description/65", []], ["title/66", [32, 1.825, 33, 2.148, 43, 2.074, 95, 1.881, 135, 3.129]], ["description/66", []], ["title/67", [34, 2.694, 43, 2.508, 136, 5.06]], ["description/67", []], ["title/68", [42, 2.074, 43, 2.074, 95, 1.881, 135, 3.129, 137, 3.129]], ["description/68", []], ["title/69", [39, 3.357, 43, 2.508, 137, 3.784]], ["description/69", []], ["title/70", [43, 1.541, 48, 2.325, 110, 2.744, 138, 3.109, 139, 4.695, 140, 3.109, 141, 3.109, 142, 3.109]], ["description/70", []], ["title/71", [5, 1.602, 43, 2.271, 143, 3.426, 144, 4.044]], ["description/71", []], ["title/72", [32, 1.998, 33, 2.351, 43, 2.271, 143, 3.426]], ["description/72", []], ["title/73", [42, 2.271, 43, 2.271, 137, 3.426, 143, 3.426]], ["description/73", []], ["title/74", [39, 3.357, 43, 2.508, 143, 3.784]], ["description/74", []], ["title/75", [145, 6.398]], ["description/75", []], ["title/76", [32, 1.68, 93, 1.787, 109, 2.703, 146, 3.851, 147, 3.851, 148, 3.4]], ["description/76", []], ["title/77", [93, 2.125, 149, 4.581, 150, 4.581, 151, 4.581]], ["description/77", []], ["title/78", [5, 1.602, 93, 2.125, 103, 3.039, 104, 4.044]], ["description/78", []], ["title/79", [32, 2.207, 33, 2.597, 93, 2.348]], ["description/79", []], ["title/80", [34, 2.051, 35, 2.131, 93, 2.549, 95, 1.732, 135, 2.88]], ["description/80", []], ["title/81", [42, 2.074, 93, 1.941, 137, 3.129, 152, 3.694, 153, 4.185]], ["description/81", []], ["title/82", [5, 1.347, 35, 2.131, 93, 2.549, 154, 3.4, 155, 3.4]], ["description/82", []], ["title/83", [93, 2.622, 156, 5.651]], ["description/83", []], ["title/84", [39, 3.039, 93, 2.125, 152, 4.044, 157, 4.581]], ["description/84", []], ["title/85", [9, 0.859, 20, 1.739, 25, 1.587, 26, 1.09, 58, 1.739, 68, 1.739, 93, 1.516, 94, 1.473, 108, 1.587, 109, 1.382, 158, 3.268, 159, 1.97, 160, 1.97, 161, 1.97, 162, 1.97, 163, 1.97]], ["description/85", []], ["title/86", [164, 4.785]], ["description/86", []], ["title/87", [24, 2.916, 69, 3.191, 164, 3.784]], ["description/87", []], ["title/88", [24, 2.412, 30, 2.228, 31, 1.825, 42, 2.074, 164, 3.129]], ["description/88", []], ["title/89", [165, 5.154]], ["description/89", []], ["title/90", [5, 1.347, 9, 1.68, 82, 2.703, 103, 2.555, 165, 3.102, 166, 3.851]], ["description/90", [9, 1.153, 11, 0.758, 82, 0.758, 148, 1.713, 165, 0.87, 167, 1.08]], ["title/91", [168, 6.398]], ["description/91", []], ["title/92", [47, 3.851]], ["description/92", []], ["title/93", [169, 5.648]], ["description/93", []], ["title/94", [47, 3.851]], ["description/94", []], ["title/95", [47, 3.851]], ["description/95", []], ["title/96", [47, 3.851]], ["description/96", []], ["title/97", [170, 6.398]], ["description/97", []], ["title/98", [22, 4.044, 34, 2.439, 93, 2.125, 95, 2.06]], ["description/98", []], ["title/99", [171, 6.398]], ["description/99", []], ["title/100", [5, 1.347, 172, 3.4, 173, 3.4, 174, 3.4, 175, 3.4, 176, 3.102]], ["description/100", []], ["title/101", [5, 1.347, 172, 3.4, 173, 3.4, 174, 3.4, 175, 3.4, 176, 3.102]], ["description/101", []], ["title/102", [177, 6.398]], ["description/102", []], ["title/103", [10, 3.102, 27, 2.429, 69, 2.429, 106, 3.102, 154, 3.4, 178, 3.4]], ["description/103", []], ["title/104", [5, 1.087, 24, 1.792, 27, 1.96, 69, 1.96, 106, 2.504, 178, 2.744, 179, 3.109, 180, 2.744, 181, 3.109]], ["description/104", []], ["title/105", [133, 3.851]], ["description/105", []], ["title/106", [5, 1.976, 133, 3.401]], ["description/106", [5, 0.466, 29, 0.996, 32, 0.581, 129, 1.176, 132, 1.073, 133, 0.802, 182, 1.332]], ["title/107", [34, 2.694, 35, 2.8, 133, 3.045]], ["description/107", []], ["title/108", [5, 1.769, 133, 3.045, 155, 4.467]], ["description/108", []], ["title/109", [30, 2.228, 31, 1.825, 37, 3.129, 133, 2.518, 183, 4.185]], ["description/109", []], ["title/110", [9, 0.825, 10, 2.546, 77, 1.256, 86, 1.671, 103, 1.256, 115, 1.671, 133, 1.903, 164, 1.415, 169, 1.671, 176, 1.525, 184, 1.893, 185, 3.161, 186, 1.893, 187, 1.893, 188, 1.893, 189, 1.893]], ["description/110", []], ["title/111", [24, 3.687]], ["description/111", []], ["title/112", [24, 2.844, 144, 2.933, 180, 4.356, 190, 3.322, 191, 3.322, 192, 3.322]], ["description/112", []], ["title/113", [193, 6.398]], ["description/113", []], ["title/114", [5, 1.769, 100, 3.784, 194, 4.467]], ["description/114", []], ["title/115", [194, 4.467, 195, 5.06, 196, 5.06]], ["description/115", []]], "invertedIndex": [["", { "_index": 1, "title": {}, "description": { "0": {} } }], ["0", { "_index": 116, "title": { "55": {} }, "description": { "55": {} } }], ["1", { "_index": 118, "title": {}, "description": { "55": {} } }], ["2", { "_index": 120, "title": {}, "description": { "55": {} } }], ["3", { "_index": 122, "title": {}, "description": { "55": {} } }], ["accept", { "_index": 105, "title": { "51": {}, "54": {}, "55": {} }, "description": {} }], ["access", { "_index": 15, "title": {}, "description": { "3": {} } }], ["account", { "_index": 4, "title": { "1": {}, "2": {}, "3": {}, "4": {}, "5": {}, "7": {}, "9": {}, "10": {}, "11": {}, "13": {}, "14": {}, "15": {}, "19": {}, "20": {} }, "description": { "3": {}, "15": {} } }], ["activ", { "_index": 100, "title": { "44": {}, "46": {}, "114": {} }, "description": { "45": {} } }], ["actual", { "_index": 57, "title": {}, "description": { "15": {} } }], ["add", { "_index": 41, "title": { "11": {}, "52": {} }, "description": {} }], ["address", { "_index": 26, "title": { "4": {}, "5": {}, "6": {}, "8": {}, "59": {}, "60": {}, "61": {}, "62": {}, "63": {}, "85": {} }, "description": {} }], ["administr", { "_index": 54, "title": {}, "description": { "15": {} } }], ["affili", { "_index": 66, "title": { "21": {}, "22": {}, "26": {}, "27": {}, "28": {}, "30": {}, "31": {} }, "description": {} }], ["amount", { "_index": 162, "title": { "85": {} }, "description": {} }], ["api", { "_index": 142, "title": { "70": {} }, "description": {} }], ["approv", { "_index": 51, "title": {}, "description": { "15": {} } }], ["authent", { "_index": 0, "title": { "0": {} }, "description": {} }], ["author", { "_index": 13, "title": {}, "description": { "3": {} } }], ["avail", { "_index": 180, "title": { "104": {}, "112": {} }, "description": {} }], ["balanc", { "_index": 7, "title": { "2": {} }, "description": {} }], ["befor", { "_index": 55, "title": {}, "description": { "15": {}, "45": {} } }], ["belong", { "_index": 135, "title": { "65": {}, "66": {}, "68": {}, "80": {} }, "description": {} }], ["between", { "_index": 166, "title": { "90": {} }, "description": {} }], ["bitcoin", { "_index": 119, "title": {}, "description": { "55": {} } }], ["broadcast", { "_index": 61, "title": { "18": {} }, "description": { "18": {} } }], ["button", { "_index": 146, "title": { "76": {} }, "description": {} }], ["buyer", { "_index": 94, "title": { "39": {}, "52": {}, "53": {}, "85": {} }, "description": {} }], ["callback", { "_index": 128, "title": { "59": {}, "60": {}, "61": {}, "62": {}, "63": {} }, "description": {} }], ["cancel", { "_index": 156, "title": { "83": {} }, "description": {} }], ["capabl", { "_index": 88, "title": { "34": {} }, "description": {} }], ["certain", { "_index": 192, "title": { "112": {} }, "description": {} }], ["chang", { "_index": 37, "title": { "7": {}, "8": {}, "11": {}, "109": {} }, "description": {} }], ["channel", { "_index": 67, "title": { "22": {}, "23": {}, "24": {}, "25": {}, "28": {}, "30": {}, "31": {}, "32": {} }, "description": {} }], ["client", { "_index": 43, "title": { "11": {}, "18": {}, "43": {}, "65": {}, "66": {}, "67": {}, "68": {}, "69": {}, "70": {}, "71": {}, "72": {}, "73": {}, "74": {} }, "description": {} }], ["clientid", { "_index": 136, "title": { "67": {} }, "description": {} }], ["co-sign", { "_index": 63, "title": {}, "description": { "18": {} } }], ["code", { "_index": 147, "title": { "76": {} }, "description": {} }], ["coin", { "_index": 111, "title": { "55": {} }, "description": { "55": {} } }], ["coinpay", { "_index": 75, "title": { "27": {} }, "description": {} }], ["coinpayments.net", { "_index": 89, "title": {}, "description": { "34": {} } }], ["commiss", { "_index": 71, "title": { "27": {} }, "description": {} }], ["commun", { "_index": 141, "title": { "70": {} }, "description": {} }], ["consum", { "_index": 14, "title": {}, "description": { "3": {} } }], ["contract", { "_index": 173, "title": { "100": {}, "101": {} }, "description": {} }], ["convers", { "_index": 82, "title": { "30": {}, "31": {}, "36": {}, "90": {} }, "description": { "90": {} } }], ["convert", { "_index": 167, "title": {}, "description": { "90": {} } }], ["correct", { "_index": 113, "title": { "55": {} }, "description": {} }], ["countri", { "_index": 85, "title": { "31": {} }, "description": {} }], ["creat", { "_index": 32, "title": { "5": {}, "19": {}, "20": {}, "22": {}, "23": {}, "38": {}, "44": {}, "45": {}, "48": {}, "59": {}, "66": {}, "72": {}, "76": {}, "79": {} }, "description": { "44": {}, "45": {}, "106": {} } }], ["creation", { "_index": 131, "title": { "60": {} }, "description": {} }], ["crypto", { "_index": 17, "title": {}, "description": { "3": {}, "44": {} } }], ["currenc", { "_index": 9, "title": { "2": {}, "33": {}, "34": {}, "35": {}, "36": {}, "51": {}, "52": {}, "53": {}, "54": {}, "55": {}, "63": {}, "85": {}, "90": {}, "110": {} }, "description": { "3": {}, "34": {}, "90": {} } }], ["current", { "_index": 103, "title": { "49": {}, "50": {}, "51": {}, "78": {}, "90": {}, "110": {} }, "description": {} }], ["date", { "_index": 132, "title": { "60": {}, "63": {} }, "description": { "106": {} } }], ["day", { "_index": 83, "title": { "30": {} }, "description": {} }], ["default", { "_index": 90, "title": {}, "description": { "34": {} } }], ["delet", { "_index": 39, "title": { "10": {}, "54": {}, "57": {}, "69": {}, "74": {}, "84": {} }, "description": {} }], ["deposit", { "_index": 25, "title": { "4": {}, "63": {}, "85": {} }, "description": {} }], ["descend", { "_index": 130, "title": { "60": {} }, "description": {} }], ["detail", { "_index": 68, "title": { "25": {}, "85": {} }, "description": {} }], ["draft", { "_index": 152, "title": { "81": {}, "84": {} }, "description": {} }], ["earn", { "_index": 74, "title": { "27": {}, "28": {}, "29": {} }, "description": {} }], ["encrypt", { "_index": 98, "title": { "43": {} }, "description": {} }], ["erc20", { "_index": 174, "title": { "100": {}, "101": {} }, "description": {} }], ["ethereum", { "_index": 123, "title": {}, "description": { "55": {} } }], ["event", { "_index": 155, "title": { "82": {}, "108": {} }, "description": {} }], ["exact", { "_index": 161, "title": { "85": {} }, "description": {} }], ["exampl", { "_index": 117, "title": {}, "description": { "55": {} } }], ["exist", { "_index": 137, "title": { "68": {}, "69": {}, "73": {}, "81": {} }, "description": {} }], ["featur", { "_index": 191, "title": { "112": {} }, "description": {} }], ["fee", { "_index": 72, "title": { "27": {} }, "description": {} }], ["fiat", { "_index": 23, "title": {}, "description": { "3": {} } }], ["filter", { "_index": 78, "title": { "28": {}, "30": {}, "31": {}, "32": {}, "63": {} }, "description": {} }], ["financi", { "_index": 6, "title": { "2": {}, "3": {}, "10": {}, "19": {}, "20": {} }, "description": { "3": {} } }], ["find", { "_index": 34, "title": { "6": {}, "9": {}, "24": {}, "35": {}, "40": {}, "42": {}, "61": {}, "67": {}, "80": {}, "98": {}, "107": {} }, "description": {} }], ["first", { "_index": 29, "title": { "4": {}, "63": {} }, "description": { "15": {}, "106": {} } }], ["fulli", { "_index": 159, "title": { "85": {} }, "description": {} }], ["fund", { "_index": 50, "title": { "13": {}, "14": {}, "15": {} }, "description": {} }], ["gener", { "_index": 149, "title": { "77": {} }, "description": {} }], ["get", { "_index": 69, "title": { "26": {}, "27": {}, "36": {}, "51": {}, "87": {}, "103": {}, "104": {} }, "description": {} }], ["group", { "_index": 8, "title": { "2": {} }, "description": {} }], ["happen", { "_index": 45, "title": { "11": {} }, "description": {} }], ["histori", { "_index": 154, "title": { "82": {}, "103": {} }, "description": {} }], ["id", { "_index": 35, "title": { "6": {}, "9": {}, "24": {}, "35": {}, "40": {}, "42": {}, "61": {}, "80": {}, "82": {}, "107": {} }, "description": {} }], ["impress", { "_index": 81, "title": { "30": {}, "31": {}, "32": {} }, "description": {} }], ["includ", { "_index": 20, "title": { "85": {} }, "description": { "3": {} } }], ["incom", { "_index": 187, "title": { "110": {} }, "description": {} }], ["indic", { "_index": 190, "title": { "112": {} }, "description": {} }], ["inform", { "_index": 70, "title": { "26": {}, "39": {} }, "description": {} }], ["invoic", { "_index": 93, "title": { "37": {}, "38": {}, "39": {}, "40": {}, "76": {}, "77": {}, "78": {}, "79": {}, "80": {}, "81": {}, "82": {}, "83": {}, "84": {}, "85": {}, "98": {} }, "description": {} }], ["it'", { "_index": 56, "title": {}, "description": { "15": {} } }], ["key", { "_index": 44, "title": { "11": {}, "42": {}, "43": {}, "44": {}, "46": {} }, "description": { "18": {}, "44": {}, "45": {} } }], ["known", { "_index": 175, "title": { "100": {}, "101": {} }, "description": {} }], ["label", { "_index": 38, "title": { "7": {}, "8": {}, "43": {} }, "description": {} }], ["limit", { "_index": 189, "title": { "110": {} }, "description": {} }], ["list", { "_index": 5, "title": { "2": {}, "3": {}, "4": {}, "22": {}, "28": {}, "30": {}, "31": {}, "32": {}, "34": {}, "36": {}, "44": {}, "51": {}, "60": {}, "63": {}, "71": {}, "78": {}, "82": {}, "90": {}, "100": {}, "101": {}, "104": {}, "106": {}, "108": {}, "114": {} }, "description": { "106": {} } }], ["litecoin", { "_index": 121, "title": {}, "description": { "55": {} } }], ["log", { "_index": 184, "title": { "110": {} }, "description": {} }], ["logo", { "_index": 126, "title": { "56": {}, "57": {} }, "description": {} }], ["longer", { "_index": 110, "title": { "54": {}, "70": {} }, "description": {} }], ["mark", { "_index": 195, "title": { "115": {} }, "description": {} }], ["master", { "_index": 97, "title": { "42": {}, "43": {}, "44": {}, "46": {} }, "description": { "44": {}, "45": {} } }], ["masterkey", { "_index": 96, "title": { "41": {}, "45": {} }, "description": {} }], ["memo", { "_index": 183, "title": { "109": {} }, "description": {} }], ["merchant", { "_index": 95, "title": { "39": {}, "47": {}, "48": {}, "49": {}, "50": {}, "52": {}, "53": {}, "54": {}, "56": {}, "57": {}, "65": {}, "66": {}, "68": {}, "80": {}, "98": {} }, "description": { "55": {} } }], ["merchant'", { "_index": 104, "title": { "51": {}, "78": {} }, "description": {} }], ["merchantcallback", { "_index": 127, "title": { "58": {} }, "description": {} }], ["merchantcli", { "_index": 134, "title": { "64": {} }, "description": {} }], ["merchantinvoic", { "_index": 145, "title": { "75": {} }, "description": {} }], ["multi-signatur", { "_index": 21, "title": {}, "description": { "3": {} } }], ["multisig", { "_index": 65, "title": { "19": {} }, "description": {} }], ["network", { "_index": 36, "title": { "6": {} }, "description": { "18": {} } }], ["new", { "_index": 33, "title": { "5": {}, "19": {}, "20": {}, "23": {}, "38": {}, "45": {}, "59": {}, "66": {}, "72": {}, "79": {} }, "description": { "45": {}, "55": {} } }], ["newest", { "_index": 28, "title": { "4": {}, "63": {} }, "description": {} }], ["next", { "_index": 150, "title": { "77": {} }, "description": {} }], ["notif", { "_index": 194, "title": { "114": {}, "115": {} }, "description": {} }], ["number", { "_index": 151, "title": { "77": {} }, "description": {} }], ["old", { "_index": 140, "title": { "70": {} }, "description": {} }], ["option", { "_index": 77, "title": { "28": {}, "30": {}, "31": {}, "32": {}, "63": {}, "110": {} }, "description": {} }], ["order", { "_index": 27, "title": { "4": {}, "51": {}, "55": {}, "63": {}, "103": {}, "104": {} }, "description": { "34": {} } }], ["organ", { "_index": 102, "title": { "48": {} }, "description": {} }], ["out", { "_index": 58, "title": { "85": {} }, "description": { "15": {} } }], ["outgo", { "_index": 188, "title": { "110": {} }, "description": {} }], ["page", { "_index": 12, "title": {}, "description": { "3": {}, "34": {} } }], ["paid", { "_index": 160, "title": { "85": {} }, "description": {} }], ["particular", { "_index": 144, "title": { "71": {}, "112": {} }, "description": {} }], ["pass", { "_index": 115, "title": { "55": {}, "110": {} }, "description": {} }], ["password", { "_index": 46, "title": { "11": {} }, "description": {} }], ["payment", { "_index": 109, "title": { "52": {}, "53": {}, "55": {}, "76": {}, "85": {} }, "description": {} }], ["payout", { "_index": 158, "title": { "85": {} }, "description": {} }], ["perform", { "_index": 163, "title": { "85": {} }, "description": {} }], ["period", { "_index": 84, "title": { "30": {}, "31": {}, "32": {} }, "description": {} }], ["place", { "_index": 181, "title": { "104": {} }, "description": {} }], ["platform", { "_index": 76, "title": { "27": {}, "34": {} }, "description": { "34": {} } }], ["possibl", { "_index": 92, "title": { "36": {} }, "description": {} }], ["prefer", { "_index": 164, "title": { "86": {}, "87": {}, "88": {}, "110": {} }, "description": {} }], ["privat", { "_index": 99, "title": { "43": {} }, "description": {} }], ["profil", { "_index": 101, "title": { "48": {}, "49": {}, "50": {} }, "description": {} }], ["provid", { "_index": 179, "title": { "104": {} }, "description": {} }], ["rang", { "_index": 80, "title": { "28": {}, "63": {} }, "description": {} }], ["rank", { "_index": 91, "title": { "51": {}, "55": {} }, "description": { "34": {}, "55": {} } }], ["rate", { "_index": 165, "title": { "89": {}, "90": {} }, "description": { "90": {} } }], ["read", { "_index": 196, "title": { "115": {} }, "description": {} }], ["receiv", { "_index": 108, "title": { "52": {}, "53": {}, "85": {} }, "description": {} }], ["recent", { "_index": 182, "title": {}, "description": { "106": {} } }], ["redoc-inject", { "_index": 2, "title": {}, "description": { "0": {} } }], ["regener", { "_index": 138, "title": { "70": {} }, "description": {} }], ["report", { "_index": 168, "title": { "91": {} }, "description": {} }], ["repres", { "_index": 16, "title": {}, "description": { "3": {} } }], ["request", { "_index": 31, "title": { "5": {}, "7": {}, "8": {}, "10": {}, "11": {}, "13": {}, "14": {}, "15": {}, "18": {}, "19": {}, "20": {}, "39": {}, "45": {}, "88": {}, "109": {} }, "description": { "15": {}, "18": {} } }], ["requir", { "_index": 52, "title": {}, "description": { "15": {} } }], ["rest", { "_index": 112, "title": { "55": {} }, "description": {} }], ["return", { "_index": 11, "title": { "51": {}, "55": {} }, "description": { "3": {}, "34": {}, "90": {} } }], ["scenario", { "_index": 124, "title": {}, "description": { "55": {} } }], ["schedul", { "_index": 157, "title": { "84": {} }, "description": {} }], ["secret", { "_index": 139, "title": { "70": {} }, "description": {} }], ["security-definit", { "_index": 3, "title": {}, "description": { "0": {} } }], ["send", { "_index": 30, "title": { "5": {}, "7": {}, "8": {}, "10": {}, "11": {}, "15": {}, "19": {}, "20": {}, "45": {}, "88": {}, "109": {} }, "description": {} }], ["sent", { "_index": 53, "title": {}, "description": { "15": {} } }], ["server", { "_index": 62, "title": {}, "description": { "18": {} } }], ["set", { "_index": 169, "title": { "93": {}, "110": {} }, "description": {} }], ["share", { "_index": 22, "title": { "98": {} }, "description": { "3": {} } }], ["sharedinvoic", { "_index": 170, "title": { "97": {} }, "description": {} }], ["sign", { "_index": 60, "title": { "18": {} }, "description": { "18": {} } }], ["singlesig", { "_index": 40, "title": { "10": {}, "20": {} }, "description": {} }], ["smart", { "_index": 172, "title": { "100": {}, "101": {} }, "description": {} }], ["smartcontract", { "_index": 171, "title": { "99": {} }, "description": {} }], ["sort", { "_index": 129, "title": { "60": {} }, "description": { "106": {} } }], ["specifi", { "_index": 148, "title": { "76": {} }, "description": { "90": {} } }], ["spend", { "_index": 49, "title": { "13": {}, "14": {}, "15": {}, "18": {} }, "description": {} }], ["state", { "_index": 153, "title": { "81": {} }, "description": {} }], ["structur", { "_index": 73, "title": { "27": {} }, "description": {} }], ["submit", { "_index": 59, "title": { "18": {} }, "description": {} }], ["summari", { "_index": 47, "title": { "12": {}, "16": {}, "17": {}, "29": {}, "92": {}, "94": {}, "95": {}, "96": {} }, "description": {} }], ["support", { "_index": 87, "title": { "34": {} }, "description": { "34": {} } }], ["system", { "_index": 176, "title": { "100": {}, "101": {}, "110": {} }, "description": {} }], ["time", { "_index": 79, "title": { "28": {}, "30": {}, "31": {}, "32": {} }, "description": {} }], ["token", { "_index": 18, "title": {}, "description": { "3": {} } }], ["top", { "_index": 106, "title": { "51": {}, "103": {}, "104": {} }, "description": {} }], ["topup", { "_index": 177, "title": { "102": {} }, "description": {} }], ["total", { "_index": 86, "title": { "32": {}, "110": {} }, "description": {} }], ["transact", { "_index": 133, "title": { "63": {}, "105": {}, "106": {}, "107": {}, "108": {}, "109": {}, "110": {} }, "description": { "106": {} } }], ["unassign", { "_index": 114, "title": { "55": {} }, "description": { "55": {} } }], ["up", { "_index": 178, "title": { "103": {}, "104": {} }, "description": {} }], ["updat", { "_index": 42, "title": { "11": {}, "25": {}, "39": {}, "43": {}, "50": {}, "53": {}, "55": {}, "62": {}, "68": {}, "73": {}, "81": {}, "88": {} }, "description": { "55": {} } }], ["upload", { "_index": 125, "title": { "56": {} }, "description": {} }], ["us", { "_index": 64, "title": {}, "description": { "18": {}, "44": {} } }], ["user", { "_index": 24, "title": { "4": {}, "11": {}, "44": {}, "48": {}, "87": {}, "88": {}, "104": {}, "111": {}, "112": {} }, "description": {} }], ["user'", { "_index": 10, "title": { "3": {}, "103": {}, "110": {} }, "description": {} }], ["usernotif", { "_index": 193, "title": { "113": {} }, "description": {} }], ["valid", { "_index": 48, "title": { "13": {}, "14": {}, "70": {} }, "description": { "18": {} } }], ["valu", { "_index": 186, "title": { "110": {} }, "description": {} }], ["volum", { "_index": 185, "title": { "110": {} }, "description": {} }], ["wallet", { "_index": 19, "title": {}, "description": { "3": {}, "44": {}, "45": {} } }], ["webhook", { "_index": 143, "title": { "71": {}, "72": {}, "73": {}, "74": {} }, "description": {} }], ["wish", { "_index": 107, "title": { "52": {}, "53": {}, "54": {} }, "description": {} }]], "pipeline": [] } }, "options": {} };
 
-    var container = document.getElementById('redoc');
-    Redoc.hydrate(__redoc_state, container);;
 
-  </script>
   
   <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/components/prism-core.min.js" integrity="sha256-Y+Budm2wBEjYjbH0qcJRmLuRBFpXd0VKxl6XhdS4hgA=" crossorigin="anonymous"></script>
   <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/plugins/autoloader/prism-autoloader.min.js" integrity="sha256-ht8ay6ZTPZfuixYB99I5oRpCLsCq7Do2LjEYLwbe+X8=" crossorigin="anonymous"></script>