> For the complete documentation index, see [llms.txt](https://docs.calypso.money/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.calypso.money/api-reference/models.md).

# Models

## The Currency object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"Currency":{"type":"string"}}}}
```

## The FiatCurrency object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FiatCurrency":{"type":"string"}}}}
```

## The PublicGatewayErrorResponse object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PublicGatewayErrorResponse":{"required":["errorCode","message","traceId"],"type":"object","properties":{"traceId":{"type":"string"},"errorCode":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The EmptyContainer object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"EmptyContainer":{"required":["timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"}},"description":"Object with request data"}}}}
```

## The PGAccountPermissionGroups object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGAccountPermissionGroups":{"required":["accountId","accountName","permissionGroups"],"type":"object","properties":{"accountId":{"type":"string","description":"Account ID"},"accountName":{"type":"string","description":"Account Name"},"permissionGroups":{"uniqueItems":true,"type":"array","description":"Permission groups","items":{"$ref":"#/components/schemas/PGPermissionGroupDTO"}}},"description":"Account Permission Groups"},"PGPermissionGroupDTO":{"required":["groupId","name","permissionData"],"type":"object","properties":{"groupId":{"type":"integer","description":"Group ID","format":"int64"},"name":{"type":"string","description":"Group Name"},"permissionData":{"type":"object","additionalProperties":{"type":"string","description":"Permission Data"},"description":"Permission Data"}},"description":"Permission group"}}}}
```

## The PGAccountResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGAccountResponseDTO":{"required":["account","name"],"type":"object","properties":{"account":{"type":"string","description":"Account ID"},"name":{"type":"string","description":"Account Name"}},"description":"Account Information"}}}}
```

## The PGCompanyUserFullInfoDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGCompanyUserFullInfoDTO":{"required":["availableAccounts","permissions","userFullInfo"],"type":"object","properties":{"userFullInfo":{"$ref":"#/components/schemas/PGUserFullInfoDTO"},"permissions":{"type":"array","description":"List of permission groups for an account","items":{"$ref":"#/components/schemas/PGAccountPermissionGroups"}},"availableAccounts":{"type":"array","description":"List of available accounts","items":{"$ref":"#/components/schemas/PGAccountResponseDTO"}}},"description":"Full information about the company's user"},"PGUserFullInfoDTO":{"required":["active","blocked","id","roles","username"],"type":"object","properties":{"id":{"type":"string","description":"ID","format":"uuid"},"username":{"type":"string","description":"Username","format":"uuid"},"companyId":{"type":"string","description":"Company ID","format":"uuid"},"companyName":{"type":"string","description":"Company Name"},"active":{"type":"boolean","description":"Is active?"},"blocked":{"type":"boolean","description":"Is blocked?"},"roles":{"uniqueItems":true,"type":"array","description":"List of roles","items":{"type":"string","description":"List of roles","enum":["SYSTEM","CALYPSO_ADMIN","FINANCE_ADMIN","LIQUIDITY_ADMIN","CALYPSO_PERSONAL_MANAGER","ACCOUNT","SUPPORT","COMPANY_ADMIN","COMPANY_AUDITOR"]}}},"description":"Full information about the user"},"PGAccountPermissionGroups":{"required":["accountId","accountName","permissionGroups"],"type":"object","properties":{"accountId":{"type":"string","description":"Account ID"},"accountName":{"type":"string","description":"Account Name"},"permissionGroups":{"uniqueItems":true,"type":"array","description":"Permission groups","items":{"$ref":"#/components/schemas/PGPermissionGroupDTO"}}},"description":"Account Permission Groups"},"PGPermissionGroupDTO":{"required":["groupId","name","permissionData"],"type":"object","properties":{"groupId":{"type":"integer","description":"Group ID","format":"int64"},"name":{"type":"string","description":"Group Name"},"permissionData":{"type":"object","additionalProperties":{"type":"string","description":"Permission Data"},"description":"Permission Data"}},"description":"Permission group"},"PGAccountResponseDTO":{"required":["account","name"],"type":"object","properties":{"account":{"type":"string","description":"Account ID"},"name":{"type":"string","description":"Account Name"}},"description":"Account Information"}}}}
```

## The PGPermissionGroupDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGPermissionGroupDTO":{"required":["groupId","name","permissionData"],"type":"object","properties":{"groupId":{"type":"integer","description":"Group ID","format":"int64"},"name":{"type":"string","description":"Group Name"},"permissionData":{"type":"object","additionalProperties":{"type":"string","description":"Permission Data"},"description":"Permission Data"}},"description":"Permission group"}}}}
```

## The PGUserFullInfoDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGUserFullInfoDTO":{"required":["active","blocked","id","roles","username"],"type":"object","properties":{"id":{"type":"string","description":"ID","format":"uuid"},"username":{"type":"string","description":"Username","format":"uuid"},"companyId":{"type":"string","description":"Company ID","format":"uuid"},"companyName":{"type":"string","description":"Company Name"},"active":{"type":"boolean","description":"Is active?"},"blocked":{"type":"boolean","description":"Is blocked?"},"roles":{"uniqueItems":true,"type":"array","description":"List of roles","items":{"type":"string","description":"List of roles","enum":["SYSTEM","CALYPSO_ADMIN","FINANCE_ADMIN","LIQUIDITY_ADMIN","CALYPSO_PERSONAL_MANAGER","ACCOUNT","SUPPORT","COMPANY_ADMIN","COMPANY_AUDITOR"]}}},"description":"Full information about the user"}}}}
```

## The ContainerFeeExtendedPgRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ContainerFeeExtendedPgRequestDTO":{"required":["payload","timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/FeeExtendedPgRequestDTO"}},"description":"Object with request data"},"FeeExtendedPgRequestDTO":{"required":["items"],"type":"object","properties":{"items":{"minItems":1,"type":"array","description":"Data items for calculating extended fees","items":{"$ref":"#/components/schemas/FeeExtendedItemPgRequestDTO"}}},"description":"Request data for calculating extended fees"},"FeeExtendedItemPgRequestDTO":{"required":["baseAmount","currency","feeType","opType"],"type":"object","properties":{"baseAmount":{"type":"number","description":"Base amount"},"currency":{"type":"string","description":"Currency ticker"},"opType":{"type":"string","description":"Operation type","enum":["INVOICE","WITHDRAWAL"]},"feeType":{"type":"string","description":"Fee type","enum":["SERVICE","FIX","PERCENT"]}},"description":"Request item data for calculating extended fees"}}}}
```

## The FeeExtendedItemPgRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FeeExtendedItemPgRequestDTO":{"required":["baseAmount","currency","feeType","opType"],"type":"object","properties":{"baseAmount":{"type":"number","description":"Base amount"},"currency":{"type":"string","description":"Currency ticker"},"opType":{"type":"string","description":"Operation type","enum":["INVOICE","WITHDRAWAL"]},"feeType":{"type":"string","description":"Fee type","enum":["SERVICE","FIX","PERCENT"]}},"description":"Request item data for calculating extended fees"}}}}
```

## The FeeExtendedPgRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FeeExtendedPgRequestDTO":{"required":["items"],"type":"object","properties":{"items":{"minItems":1,"type":"array","description":"Data items for calculating extended fees","items":{"$ref":"#/components/schemas/FeeExtendedItemPgRequestDTO"}}},"description":"Request data for calculating extended fees"},"FeeExtendedItemPgRequestDTO":{"required":["baseAmount","currency","feeType","opType"],"type":"object","properties":{"baseAmount":{"type":"number","description":"Base amount"},"currency":{"type":"string","description":"Currency ticker"},"opType":{"type":"string","description":"Operation type","enum":["INVOICE","WITHDRAWAL"]},"feeType":{"type":"string","description":"Fee type","enum":["SERVICE","FIX","PERCENT"]}},"description":"Request item data for calculating extended fees"}}}}
```

## The FeeExtendedCalculationResultPgResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FeeExtendedCalculationResultPgResponseDTO":{"required":["amount","fee"],"type":"object","properties":{"amount":{"type":"number","description":"Transaction amount"},"fee":{"type":"number","description":"Calculated fee amount"},"fixedFee":{"type":"number","description":"Calculated fixed fee amount"},"percentFee":{"type":"number","description":"Calculated percent fee amount"}},"description":"Detailed fee calculation result for one party"}}}}
```

## The FeeExtendedItemPgResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FeeExtendedItemPgResponseDTO":{"required":["amount","currency","feeReceiver","feeSender","opType"],"type":"object","properties":{"amount":{"type":"number","description":"Transaction amount"},"currency":{"type":"string","description":"Currency ticker"},"opType":{"type":"string","description":"Operation type","enum":["INVOICE","WITHDRAWAL"]},"feeReceiver":{"$ref":"#/components/schemas/FeeExtendedCalculationResultPgResponseDTO"},"feeSender":{"$ref":"#/components/schemas/FeeExtendedCalculationResultPgResponseDTO"}},"description":"Response item data containing extended fee calculation results"},"FeeExtendedCalculationResultPgResponseDTO":{"required":["amount","fee"],"type":"object","properties":{"amount":{"type":"number","description":"Transaction amount"},"fee":{"type":"number","description":"Calculated fee amount"},"fixedFee":{"type":"number","description":"Calculated fixed fee amount"},"percentFee":{"type":"number","description":"Calculated percent fee amount"}},"description":"Detailed fee calculation result for one party"}}}}
```

## The FeeExtendedPgResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FeeExtendedPgResponseDTO":{"required":["items"],"type":"object","properties":{"items":{"minItems":1,"type":"array","description":"List of items with calculated fee details","items":{"$ref":"#/components/schemas/FeeExtendedItemPgResponseDTO"}}},"description":"Response data containing extended fee calculation results"},"FeeExtendedItemPgResponseDTO":{"required":["amount","currency","feeReceiver","feeSender","opType"],"type":"object","properties":{"amount":{"type":"number","description":"Transaction amount"},"currency":{"type":"string","description":"Currency ticker"},"opType":{"type":"string","description":"Operation type","enum":["INVOICE","WITHDRAWAL"]},"feeReceiver":{"$ref":"#/components/schemas/FeeExtendedCalculationResultPgResponseDTO"},"feeSender":{"$ref":"#/components/schemas/FeeExtendedCalculationResultPgResponseDTO"}},"description":"Response item data containing extended fee calculation results"},"FeeExtendedCalculationResultPgResponseDTO":{"required":["amount","fee"],"type":"object","properties":{"amount":{"type":"number","description":"Transaction amount"},"fee":{"type":"number","description":"Calculated fee amount"},"fixedFee":{"type":"number","description":"Calculated fixed fee amount"},"percentFee":{"type":"number","description":"Calculated percent fee amount"}},"description":"Detailed fee calculation result for one party"}}}}
```

## The EmptyWithAccountContainer object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"EmptyWithAccountContainer":{"required":["account","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"}},"description":"Object with request data"}}}}
```

## The WebhookChannelDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WebhookChannelDTO":{"required":["blockedByErrorCount","createdDate","enabled","errorCount","errorFirstDate","errorLastDate","notificationEventTypes","publicKey","requestId","secretKey","url"],"type":"object","properties":{"requestId":{"type":"string","description":"Id of the request that has created webhook subscription","format":"uuid"},"notificationEventTypes":{"type":"array","description":"Array of event types for webhook subscription. See Event types section for full list of values","items":{"type":"string","description":"Array of event types for webhook subscription. See Event types section for full list of values","enum":["PAYOUT_CHANGE_STATUS","PAYOUT_CONFIRMED","PAYOUT_CREATED_NOT_APPROVED","PAYOUT_CREATED_PARTLY_APPROVED","PAYOUT_IN_PROGRESS_NOT_SENT","PAYOUT_VALIDATION_ERROR","PAYOUT_NO_CONFIRMATION_FOR_PAYOUT_TO_DATE","SETTLEMENT_PAYOUT_CHANGE_STATUS","SETTLEMENT_PAYOUT_CONFIRMED","SETTLEMENT_PAYOUT_CREATED_NOT_APPROVED","SETTLEMENT_PAYOUT_CREATED_PARTLY_APPROVED","SETTLEMENT_PAYOUT_IN_PROGRESS_NOT_SENT","SETTLEMENT_PAYOUT_VALIDATION_ERROR","SETTLEMENT_PAYOUT_WITHDRAWAL_COMPLETED","TOP_UP_PENDING_COMPLIANCE","TOP_UP_COMPLIANCE_DECLINED","WALLET_FUNDS_DELIVERED_ACCOUNT","SYSTEM_NEW_FEATURE","SYSTEM_NEED_FEEDBACK","SYSTEM_SEVERAL_BLOCKS_LAG","SYSTEM_SERVICE_WORK","INVOICE_CREATE_INVOICE","INVOICE_CREATE_UNLIMITED_INVOICE","INVOICE_CREATE_BOUND_INVOICE","INVOICE_CREATE_UNLIMITED_LINKED_INVOICE","INVOICE_FUNDS_RECEIVED_FOR_INVOICE","INVOICE_TRANSLATION_TO_ACCOUNT_COMPLETED","INVOICE_PAID","INVOICE_PENDING_INTERVENTION","INVOICE_FAILED","INVOICE_EXPIRED","INVOICE_MEM_POOL_FOUND","INVOICE_PENDING_COMPLIANCE","INVOICE_COMPLIANCE_DECLINED","CUSTOMER_PURSE_EXPIRED","CUSTOMER_PURSE_MEM_POOL_FOUND","CUSTOMER_PURSE_PENDING_COMPLIANCE","CUSTOMER_PURSE_COMPLIANCE_DECLINED","CUSTOMER_PURSE_FUNDS_RECEIVED_FOR_PURSE","CUSTOMER_PURSE_TRANSLATION_TO_ACCOUNT_COMPLETED","FIAT_APPLIER_FIAT_FUNDS_RECEIVED","FIAT_APPLIER_ORDER_UNPAID","FIAT_APPLIER_PAYMENT_FAILED","FIAT_APPLIER_ADJUSTMENT","FIAT_APPLIER_WITHDRAWAL_SUCCESS","FIAT_APPLIER_WITHDRAWAL_FAILED","FIAT_APPLIER_ORDER_CREATED","FIAT_DEPOSIT_ORDER_CREATED","FIAT_DEPOSIT_ORDER_CONFIRM","FIAT_DEPOSIT_FIAT_FUNDS_RECEIVED","FIAT_DEPOSIT_ORDER_EXPIRED","FIAT_DEPOSIT_ORDER_FAILED","FIAT_DEPOSIT_ADJUSTMENT","FIAT_WITHDRAWAL_ORDER_CREATED","FIAT_WITHDRAWAL_ORDER_CONFIRM","FIAT_WITHDRAWAL_SUCCESS","FIAT_WITHDRAWAL_ORDER_EXPIRED","FIAT_WITHDRAWAL_ORDER_FAILED","C2C_LIQUIDITY_EXCHANGE_CREATED","C2C_LIQUIDITY_EXCHANGE_COMPLETED","C2C_LIQUIDITY_EXCHANGE_FAILED","CRYPTO_TO_CRYPTO_ORDER_CREATED","CRYPTO_TO_CRYPTO_ORDER_COMPLETED","BUSINESS_WALLET_EXCEEDING_LIMIT","LIQUIDITY_RUNNING_OUT_OF_FUNDS","PAYMENT_WIDGET_EXPIRED","SETTLEMENT_ADAPTER_TRANSFER_CREATED","SETTLEMENT_ADAPTER_TRANSFER_COMPLETED","SETTLEMENT_ADAPTER_TRANSFER_FAILED","SETTLEMENT_ADAPTER_TRANSFER_DECLINED","SETTLEMENT_TOP_UP_COMPLETED"]}},"url":{"type":"string","description":"Web address where request with webhook will be send to"},"publicKey":{"type":"string","description":"Public key"},"secretKey":{"type":"string","description":"Secret key"},"createdDate":{"type":"string","description":"Date and time of webhook subscription creation","format":"date-time"},"enabled":{"type":"boolean","description":"Enabled/disabled via API"},"blockedByErrorCount":{"type":"boolean","description":"Automatically disabled due to reaching unsuccessful requests in a row per unit of time"},"errorCount":{"type":"integer","description":"Number of unsuccessful requests in a row","format":"int64"},"errorFirstDate":{"type":"string","description":"Time of the first unsuccessful request in the sequence","format":"date-time"},"errorLastDate":{"type":"string","description":"Time of the last unsuccessful request in the sequence","format":"date-time"}},"description":"Webhook channel information"}}}}
```

## The WebhookChannelsDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WebhookChannelsDTO":{"required":["subscriptions"],"type":"object","properties":{"subscriptions":{"type":"array","description":"Array of webhook channel settings","items":{"$ref":"#/components/schemas/WebhookChannelDTO"}}},"description":"Object with webhooks"},"WebhookChannelDTO":{"required":["blockedByErrorCount","createdDate","enabled","errorCount","errorFirstDate","errorLastDate","notificationEventTypes","publicKey","requestId","secretKey","url"],"type":"object","properties":{"requestId":{"type":"string","description":"Id of the request that has created webhook subscription","format":"uuid"},"notificationEventTypes":{"type":"array","description":"Array of event types for webhook subscription. See Event types section for full list of values","items":{"type":"string","description":"Array of event types for webhook subscription. See Event types section for full list of values","enum":["PAYOUT_CHANGE_STATUS","PAYOUT_CONFIRMED","PAYOUT_CREATED_NOT_APPROVED","PAYOUT_CREATED_PARTLY_APPROVED","PAYOUT_IN_PROGRESS_NOT_SENT","PAYOUT_VALIDATION_ERROR","PAYOUT_NO_CONFIRMATION_FOR_PAYOUT_TO_DATE","SETTLEMENT_PAYOUT_CHANGE_STATUS","SETTLEMENT_PAYOUT_CONFIRMED","SETTLEMENT_PAYOUT_CREATED_NOT_APPROVED","SETTLEMENT_PAYOUT_CREATED_PARTLY_APPROVED","SETTLEMENT_PAYOUT_IN_PROGRESS_NOT_SENT","SETTLEMENT_PAYOUT_VALIDATION_ERROR","SETTLEMENT_PAYOUT_WITHDRAWAL_COMPLETED","TOP_UP_PENDING_COMPLIANCE","TOP_UP_COMPLIANCE_DECLINED","WALLET_FUNDS_DELIVERED_ACCOUNT","SYSTEM_NEW_FEATURE","SYSTEM_NEED_FEEDBACK","SYSTEM_SEVERAL_BLOCKS_LAG","SYSTEM_SERVICE_WORK","INVOICE_CREATE_INVOICE","INVOICE_CREATE_UNLIMITED_INVOICE","INVOICE_CREATE_BOUND_INVOICE","INVOICE_CREATE_UNLIMITED_LINKED_INVOICE","INVOICE_FUNDS_RECEIVED_FOR_INVOICE","INVOICE_TRANSLATION_TO_ACCOUNT_COMPLETED","INVOICE_PAID","INVOICE_PENDING_INTERVENTION","INVOICE_FAILED","INVOICE_EXPIRED","INVOICE_MEM_POOL_FOUND","INVOICE_PENDING_COMPLIANCE","INVOICE_COMPLIANCE_DECLINED","CUSTOMER_PURSE_EXPIRED","CUSTOMER_PURSE_MEM_POOL_FOUND","CUSTOMER_PURSE_PENDING_COMPLIANCE","CUSTOMER_PURSE_COMPLIANCE_DECLINED","CUSTOMER_PURSE_FUNDS_RECEIVED_FOR_PURSE","CUSTOMER_PURSE_TRANSLATION_TO_ACCOUNT_COMPLETED","FIAT_APPLIER_FIAT_FUNDS_RECEIVED","FIAT_APPLIER_ORDER_UNPAID","FIAT_APPLIER_PAYMENT_FAILED","FIAT_APPLIER_ADJUSTMENT","FIAT_APPLIER_WITHDRAWAL_SUCCESS","FIAT_APPLIER_WITHDRAWAL_FAILED","FIAT_APPLIER_ORDER_CREATED","FIAT_DEPOSIT_ORDER_CREATED","FIAT_DEPOSIT_ORDER_CONFIRM","FIAT_DEPOSIT_FIAT_FUNDS_RECEIVED","FIAT_DEPOSIT_ORDER_EXPIRED","FIAT_DEPOSIT_ORDER_FAILED","FIAT_DEPOSIT_ADJUSTMENT","FIAT_WITHDRAWAL_ORDER_CREATED","FIAT_WITHDRAWAL_ORDER_CONFIRM","FIAT_WITHDRAWAL_SUCCESS","FIAT_WITHDRAWAL_ORDER_EXPIRED","FIAT_WITHDRAWAL_ORDER_FAILED","C2C_LIQUIDITY_EXCHANGE_CREATED","C2C_LIQUIDITY_EXCHANGE_COMPLETED","C2C_LIQUIDITY_EXCHANGE_FAILED","CRYPTO_TO_CRYPTO_ORDER_CREATED","CRYPTO_TO_CRYPTO_ORDER_COMPLETED","BUSINESS_WALLET_EXCEEDING_LIMIT","LIQUIDITY_RUNNING_OUT_OF_FUNDS","PAYMENT_WIDGET_EXPIRED","SETTLEMENT_ADAPTER_TRANSFER_CREATED","SETTLEMENT_ADAPTER_TRANSFER_COMPLETED","SETTLEMENT_ADAPTER_TRANSFER_FAILED","SETTLEMENT_ADAPTER_TRANSFER_DECLINED","SETTLEMENT_TOP_UP_COMPLETED"]}},"url":{"type":"string","description":"Web address where request with webhook will be send to"},"publicKey":{"type":"string","description":"Public key"},"secretKey":{"type":"string","description":"Secret key"},"createdDate":{"type":"string","description":"Date and time of webhook subscription creation","format":"date-time"},"enabled":{"type":"boolean","description":"Enabled/disabled via API"},"blockedByErrorCount":{"type":"boolean","description":"Automatically disabled due to reaching unsuccessful requests in a row per unit of time"},"errorCount":{"type":"integer","description":"Number of unsuccessful requests in a row","format":"int64"},"errorFirstDate":{"type":"string","description":"Time of the first unsuccessful request in the sequence","format":"date-time"},"errorLastDate":{"type":"string","description":"Time of the last unsuccessful request in the sequence","format":"date-time"}},"description":"Webhook channel information"}}}}
```

## The WebhookChannelRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WebhookChannelRequestDTO":{"required":["url"],"type":"object","properties":{"requestId":{"type":"string","description":"Id of the request that has created webhook subscription","format":"uuid"},"notificationEventTypes":{"type":"array","description":"Array of event types for webhook subscription. See Event types section for full list of values","items":{"type":"string","description":"Array of event types for webhook subscription. See Event types section for full list of values","enum":["PAYOUT_CHANGE_STATUS","PAYOUT_CONFIRMED","PAYOUT_CREATED_NOT_APPROVED","PAYOUT_CREATED_PARTLY_APPROVED","PAYOUT_IN_PROGRESS_NOT_SENT","PAYOUT_VALIDATION_ERROR","PAYOUT_NO_CONFIRMATION_FOR_PAYOUT_TO_DATE","SETTLEMENT_PAYOUT_CHANGE_STATUS","SETTLEMENT_PAYOUT_CONFIRMED","SETTLEMENT_PAYOUT_CREATED_NOT_APPROVED","SETTLEMENT_PAYOUT_CREATED_PARTLY_APPROVED","SETTLEMENT_PAYOUT_IN_PROGRESS_NOT_SENT","SETTLEMENT_PAYOUT_VALIDATION_ERROR","SETTLEMENT_PAYOUT_WITHDRAWAL_COMPLETED","TOP_UP_PENDING_COMPLIANCE","TOP_UP_COMPLIANCE_DECLINED","WALLET_FUNDS_DELIVERED_ACCOUNT","SYSTEM_NEW_FEATURE","SYSTEM_NEED_FEEDBACK","SYSTEM_SEVERAL_BLOCKS_LAG","SYSTEM_SERVICE_WORK","INVOICE_CREATE_INVOICE","INVOICE_CREATE_UNLIMITED_INVOICE","INVOICE_CREATE_BOUND_INVOICE","INVOICE_CREATE_UNLIMITED_LINKED_INVOICE","INVOICE_FUNDS_RECEIVED_FOR_INVOICE","INVOICE_TRANSLATION_TO_ACCOUNT_COMPLETED","INVOICE_PAID","INVOICE_PENDING_INTERVENTION","INVOICE_FAILED","INVOICE_EXPIRED","INVOICE_MEM_POOL_FOUND","INVOICE_PENDING_COMPLIANCE","INVOICE_COMPLIANCE_DECLINED","CUSTOMER_PURSE_EXPIRED","CUSTOMER_PURSE_MEM_POOL_FOUND","CUSTOMER_PURSE_PENDING_COMPLIANCE","CUSTOMER_PURSE_COMPLIANCE_DECLINED","CUSTOMER_PURSE_FUNDS_RECEIVED_FOR_PURSE","CUSTOMER_PURSE_TRANSLATION_TO_ACCOUNT_COMPLETED","FIAT_APPLIER_FIAT_FUNDS_RECEIVED","FIAT_APPLIER_ORDER_UNPAID","FIAT_APPLIER_PAYMENT_FAILED","FIAT_APPLIER_ADJUSTMENT","FIAT_APPLIER_WITHDRAWAL_SUCCESS","FIAT_APPLIER_WITHDRAWAL_FAILED","FIAT_APPLIER_ORDER_CREATED","FIAT_DEPOSIT_ORDER_CREATED","FIAT_DEPOSIT_ORDER_CONFIRM","FIAT_DEPOSIT_FIAT_FUNDS_RECEIVED","FIAT_DEPOSIT_ORDER_EXPIRED","FIAT_DEPOSIT_ORDER_FAILED","FIAT_DEPOSIT_ADJUSTMENT","FIAT_WITHDRAWAL_ORDER_CREATED","FIAT_WITHDRAWAL_ORDER_CONFIRM","FIAT_WITHDRAWAL_SUCCESS","FIAT_WITHDRAWAL_ORDER_EXPIRED","FIAT_WITHDRAWAL_ORDER_FAILED","C2C_LIQUIDITY_EXCHANGE_CREATED","C2C_LIQUIDITY_EXCHANGE_COMPLETED","C2C_LIQUIDITY_EXCHANGE_FAILED","CRYPTO_TO_CRYPTO_ORDER_CREATED","CRYPTO_TO_CRYPTO_ORDER_COMPLETED","BUSINESS_WALLET_EXCEEDING_LIMIT","LIQUIDITY_RUNNING_OUT_OF_FUNDS","PAYMENT_WIDGET_EXPIRED","SETTLEMENT_ADAPTER_TRANSFER_CREATED","SETTLEMENT_ADAPTER_TRANSFER_COMPLETED","SETTLEMENT_ADAPTER_TRANSFER_FAILED","SETTLEMENT_ADAPTER_TRANSFER_DECLINED","SETTLEMENT_TOP_UP_COMPLETED"]}},"notificationServiceTypes":{"type":"array","description":"Array of groups of the events for webhook subscription. If the value is set, a subscription is created for all types of events in this group","items":{"type":"string","description":"Array of groups of the events for webhook subscription. If the value is set, a subscription is created for all types of events in this group","enum":["PAYOUT","SETTLEMENT_PAYOUT","SETTLEMENT_ADAPTER","SETTLEMENT_WALLET","WALLET","INVOICE","C2C_LIQUIDITY","FIAT_APPLIER","FIAT_DEPOSIT","FIAT_WITHDRAWAL","CRYPTO_TO_CRYPTO","CRYPTO_TO_FIAT","BUSINESS_WALLET","SYSTEM","LIQUIDITY","RECURRENT","PAYMENT_WIDGET","CUSTOMER_PURSE"]}},"url":{"type":"string","description":"Id of the request that has created webhook subscription"}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerWebhookChannelRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerWebhookChannelRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/WebhookChannelRequestDTO"}},"description":"Object with request data"},"WebhookChannelRequestDTO":{"required":["url"],"type":"object","properties":{"requestId":{"type":"string","description":"Id of the request that has created webhook subscription","format":"uuid"},"notificationEventTypes":{"type":"array","description":"Array of event types for webhook subscription. See Event types section for full list of values","items":{"type":"string","description":"Array of event types for webhook subscription. See Event types section for full list of values","enum":["PAYOUT_CHANGE_STATUS","PAYOUT_CONFIRMED","PAYOUT_CREATED_NOT_APPROVED","PAYOUT_CREATED_PARTLY_APPROVED","PAYOUT_IN_PROGRESS_NOT_SENT","PAYOUT_VALIDATION_ERROR","PAYOUT_NO_CONFIRMATION_FOR_PAYOUT_TO_DATE","SETTLEMENT_PAYOUT_CHANGE_STATUS","SETTLEMENT_PAYOUT_CONFIRMED","SETTLEMENT_PAYOUT_CREATED_NOT_APPROVED","SETTLEMENT_PAYOUT_CREATED_PARTLY_APPROVED","SETTLEMENT_PAYOUT_IN_PROGRESS_NOT_SENT","SETTLEMENT_PAYOUT_VALIDATION_ERROR","SETTLEMENT_PAYOUT_WITHDRAWAL_COMPLETED","TOP_UP_PENDING_COMPLIANCE","TOP_UP_COMPLIANCE_DECLINED","WALLET_FUNDS_DELIVERED_ACCOUNT","SYSTEM_NEW_FEATURE","SYSTEM_NEED_FEEDBACK","SYSTEM_SEVERAL_BLOCKS_LAG","SYSTEM_SERVICE_WORK","INVOICE_CREATE_INVOICE","INVOICE_CREATE_UNLIMITED_INVOICE","INVOICE_CREATE_BOUND_INVOICE","INVOICE_CREATE_UNLIMITED_LINKED_INVOICE","INVOICE_FUNDS_RECEIVED_FOR_INVOICE","INVOICE_TRANSLATION_TO_ACCOUNT_COMPLETED","INVOICE_PAID","INVOICE_PENDING_INTERVENTION","INVOICE_FAILED","INVOICE_EXPIRED","INVOICE_MEM_POOL_FOUND","INVOICE_PENDING_COMPLIANCE","INVOICE_COMPLIANCE_DECLINED","CUSTOMER_PURSE_EXPIRED","CUSTOMER_PURSE_MEM_POOL_FOUND","CUSTOMER_PURSE_PENDING_COMPLIANCE","CUSTOMER_PURSE_COMPLIANCE_DECLINED","CUSTOMER_PURSE_FUNDS_RECEIVED_FOR_PURSE","CUSTOMER_PURSE_TRANSLATION_TO_ACCOUNT_COMPLETED","FIAT_APPLIER_FIAT_FUNDS_RECEIVED","FIAT_APPLIER_ORDER_UNPAID","FIAT_APPLIER_PAYMENT_FAILED","FIAT_APPLIER_ADJUSTMENT","FIAT_APPLIER_WITHDRAWAL_SUCCESS","FIAT_APPLIER_WITHDRAWAL_FAILED","FIAT_APPLIER_ORDER_CREATED","FIAT_DEPOSIT_ORDER_CREATED","FIAT_DEPOSIT_ORDER_CONFIRM","FIAT_DEPOSIT_FIAT_FUNDS_RECEIVED","FIAT_DEPOSIT_ORDER_EXPIRED","FIAT_DEPOSIT_ORDER_FAILED","FIAT_DEPOSIT_ADJUSTMENT","FIAT_WITHDRAWAL_ORDER_CREATED","FIAT_WITHDRAWAL_ORDER_CONFIRM","FIAT_WITHDRAWAL_SUCCESS","FIAT_WITHDRAWAL_ORDER_EXPIRED","FIAT_WITHDRAWAL_ORDER_FAILED","C2C_LIQUIDITY_EXCHANGE_CREATED","C2C_LIQUIDITY_EXCHANGE_COMPLETED","C2C_LIQUIDITY_EXCHANGE_FAILED","CRYPTO_TO_CRYPTO_ORDER_CREATED","CRYPTO_TO_CRYPTO_ORDER_COMPLETED","BUSINESS_WALLET_EXCEEDING_LIMIT","LIQUIDITY_RUNNING_OUT_OF_FUNDS","PAYMENT_WIDGET_EXPIRED","SETTLEMENT_ADAPTER_TRANSFER_CREATED","SETTLEMENT_ADAPTER_TRANSFER_COMPLETED","SETTLEMENT_ADAPTER_TRANSFER_FAILED","SETTLEMENT_ADAPTER_TRANSFER_DECLINED","SETTLEMENT_TOP_UP_COMPLETED"]}},"notificationServiceTypes":{"type":"array","description":"Array of groups of the events for webhook subscription. If the value is set, a subscription is created for all types of events in this group","items":{"type":"string","description":"Array of groups of the events for webhook subscription. If the value is set, a subscription is created for all types of events in this group","enum":["PAYOUT","SETTLEMENT_PAYOUT","SETTLEMENT_ADAPTER","SETTLEMENT_WALLET","WALLET","INVOICE","C2C_LIQUIDITY","FIAT_APPLIER","FIAT_DEPOSIT","FIAT_WITHDRAWAL","CRYPTO_TO_CRYPTO","CRYPTO_TO_FIAT","BUSINESS_WALLET","SYSTEM","LIQUIDITY","RECURRENT","PAYMENT_WIDGET","CUSTOMER_PURSE"]}},"url":{"type":"string","description":"Id of the request that has created webhook subscription"}},"description":"Object with request parameters"}}}}
```

## The ByAddressRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByAddressRequestDTO":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"Address"}},"description":"Object with request address parameter"}}}}
```

## The WithAccountContainerByAddressRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByAddressRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByAddressRequestDTO"}},"description":"Object with request data"},"ByAddressRequestDTO":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"Address"}},"description":"Object with request address parameter"}}}}
```

## The PGSettlementBalanceDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGSettlementBalanceDTO":{"required":["amount","currency","token"],"type":"object","properties":{"currency":{"type":"string","description":"Currency ticker"},"amount":{"type":"number","description":"The amount"},"token":{"type":"boolean","description":"Token attribute"}},"description":"Data of the response to the request for information about the wallet balance"}}}}
```

## The PGSettlementWalletResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGSettlementWalletResponseDTO":{"required":["address","balances","blockchain","name"],"type":"object","properties":{"name":{"type":"string","description":"Wallet name"},"address":{"type":"string","description":"Wallet address"},"blockchain":{"type":"string","description":"Wallet blockchain"},"balances":{"type":"array","description":"Wallet balances","items":{"$ref":"#/components/schemas/PGSettlementBalanceDTO"}}},"description":"Data of the response to the action with the wallet"},"PGSettlementBalanceDTO":{"required":["amount","currency","token"],"type":"object","properties":{"currency":{"type":"string","description":"Currency ticker"},"amount":{"type":"number","description":"The amount"},"token":{"type":"boolean","description":"Token attribute"}},"description":"Data of the response to the request for information about the wallet balance"}}}}
```

## The PGSettlementTransactionFilterDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGSettlementTransactionFilterDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"walletAddress":{"type":"string","description":"Filtering by wallet address"},"addressTo":{"type":"string","description":"Filtering by recipient's wallet address"},"opcodes":{"type":"array","description":"Filtering by operation codes","items":{"type":"string","description":"Filtering by operation codes","enum":["WITHDRAWAL","INNER_WITHDRAWAL","SETTLEMENT_SINGLE_WITHDRAWAL","SETTLEMENT_MASS_WITHDRAWAL","SETTLEMENT_INTERNAL_WITHDRAWAL","SETTLEMENT_TO_ASSET_WITHDRAWAL","SETTLEMENT_TO_SETTLEMENT_WITHDRAWAL","ASSET_TO_SETTLEMENT_WITHDRAWAL","CRYPTO_TO_FIAT_WITHDRAWAL","CRYPTO_TO_CRYPTO_WITHDRAWAL","CRYPTO_TO_CRYPTO_DEPOSIT","CRYPTO_TO_CRYPTO_INVOICE_WITHDRAWAL","CRYPTO_TO_CRYPTO_INVOICE_DEPOSIT","CREATION_SINGLE_INVOICE","CREATION_SINGLE_FIAT_INVOICE","CREATION_UNLIMITED_INVOICE","CREATION_UNLIMITED_LINKED_INVOICE","CREATION_BOUND_INVOICE","UNLIMITED_INVOICE_FIRST_PAY_FEE","SINGLE_INVOICE","SINGLE_FIAT_INVOICE","UNLIMITED_INVOICE","UNLIMITED_LINKED_INVOICE","BOUND_INVOICE","TOP_UP","SETTLEMENT_TOP_UP","FIAT_TOP_UP","FEE","ISSUE_LOAN","REPAYMENT_LOAN","UNLIMITED_CUSTOMER_PURSE","UNLIMITED_CUSTOMER_PURSE_FIRST_PAY_FEE","RECOVERY"]}},"currency":{"type":"string","description":"Filtering by currency ticker"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Data of the request to receive a list of transactions by wallets"}}}}
```

## The WithAccountContainerPGSettlementTransactionFilterDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGSettlementTransactionFilterDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGSettlementTransactionFilterDTO"}},"description":"Object with request data"},"PGSettlementTransactionFilterDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"walletAddress":{"type":"string","description":"Filtering by wallet address"},"addressTo":{"type":"string","description":"Filtering by recipient's wallet address"},"opcodes":{"type":"array","description":"Filtering by operation codes","items":{"type":"string","description":"Filtering by operation codes","enum":["WITHDRAWAL","INNER_WITHDRAWAL","SETTLEMENT_SINGLE_WITHDRAWAL","SETTLEMENT_MASS_WITHDRAWAL","SETTLEMENT_INTERNAL_WITHDRAWAL","SETTLEMENT_TO_ASSET_WITHDRAWAL","SETTLEMENT_TO_SETTLEMENT_WITHDRAWAL","ASSET_TO_SETTLEMENT_WITHDRAWAL","CRYPTO_TO_FIAT_WITHDRAWAL","CRYPTO_TO_CRYPTO_WITHDRAWAL","CRYPTO_TO_CRYPTO_DEPOSIT","CRYPTO_TO_CRYPTO_INVOICE_WITHDRAWAL","CRYPTO_TO_CRYPTO_INVOICE_DEPOSIT","CREATION_SINGLE_INVOICE","CREATION_SINGLE_FIAT_INVOICE","CREATION_UNLIMITED_INVOICE","CREATION_UNLIMITED_LINKED_INVOICE","CREATION_BOUND_INVOICE","UNLIMITED_INVOICE_FIRST_PAY_FEE","SINGLE_INVOICE","SINGLE_FIAT_INVOICE","UNLIMITED_INVOICE","UNLIMITED_LINKED_INVOICE","BOUND_INVOICE","TOP_UP","SETTLEMENT_TOP_UP","FIAT_TOP_UP","FEE","ISSUE_LOAN","REPAYMENT_LOAN","UNLIMITED_CUSTOMER_PURSE","UNLIMITED_CUSTOMER_PURSE_FIRST_PAY_FEE","RECOVERY"]}},"currency":{"type":"string","description":"Filtering by currency ticker"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Data of the request to receive a list of transactions by wallets"}}}}
```

## The PGSettlementTransactionResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGSettlementTransactionResponseDTO":{"required":["amount","createdDate","currency","networkFee","networkFeeCurrency","opCode","serviceFee","serviceFeeCurrency","transactionHash"],"type":"object","properties":{"amount":{"type":"number","description":"The amount"},"currency":{"type":"string","description":"Currency ticker"},"opCode":{"type":"string","description":"Operation code","enum":["WITHDRAWAL","INNER_WITHDRAWAL","SETTLEMENT_SINGLE_WITHDRAWAL","SETTLEMENT_MASS_WITHDRAWAL","SETTLEMENT_INTERNAL_WITHDRAWAL","SETTLEMENT_TO_ASSET_WITHDRAWAL","SETTLEMENT_TO_SETTLEMENT_WITHDRAWAL","ASSET_TO_SETTLEMENT_WITHDRAWAL","CRYPTO_TO_FIAT_WITHDRAWAL","CRYPTO_TO_CRYPTO_WITHDRAWAL","CRYPTO_TO_CRYPTO_DEPOSIT","CRYPTO_TO_CRYPTO_INVOICE_WITHDRAWAL","CRYPTO_TO_CRYPTO_INVOICE_DEPOSIT","CREATION_SINGLE_INVOICE","CREATION_SINGLE_FIAT_INVOICE","CREATION_UNLIMITED_INVOICE","CREATION_UNLIMITED_LINKED_INVOICE","CREATION_BOUND_INVOICE","UNLIMITED_INVOICE_FIRST_PAY_FEE","SINGLE_INVOICE","SINGLE_FIAT_INVOICE","UNLIMITED_INVOICE","UNLIMITED_LINKED_INVOICE","BOUND_INVOICE","TOP_UP","SETTLEMENT_TOP_UP","FIAT_TOP_UP","FEE","ISSUE_LOAN","REPAYMENT_LOAN","UNLIMITED_CUSTOMER_PURSE","UNLIMITED_CUSTOMER_PURSE_FIRST_PAY_FEE","RECOVERY"]},"addressTo":{"type":"string","description":"Recipient's wallet address"},"serviceFee":{"type":"number","description":"Service fee"},"serviceFeeCurrency":{"type":"string","description":"Service fee currency ticker"},"networkFee":{"type":"number","description":"Network fee"},"networkFeeCurrency":{"type":"string","description":"Network fee currency ticker"},"transactionHash":{"type":"string","description":"Transaction hash"},"createdDate":{"type":"string","description":"Date of creation","format":"date-time"}},"description":"Data of the response to the transaction receipt request"}}}}
```

## The PageDTOPGSettlementTransactionResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPGSettlementTransactionResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PGSettlementTransactionResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PGSettlementTransactionResponseDTO":{"required":["amount","createdDate","currency","networkFee","networkFeeCurrency","opCode","serviceFee","serviceFeeCurrency","transactionHash"],"type":"object","properties":{"amount":{"type":"number","description":"The amount"},"currency":{"type":"string","description":"Currency ticker"},"opCode":{"type":"string","description":"Operation code","enum":["WITHDRAWAL","INNER_WITHDRAWAL","SETTLEMENT_SINGLE_WITHDRAWAL","SETTLEMENT_MASS_WITHDRAWAL","SETTLEMENT_INTERNAL_WITHDRAWAL","SETTLEMENT_TO_ASSET_WITHDRAWAL","SETTLEMENT_TO_SETTLEMENT_WITHDRAWAL","ASSET_TO_SETTLEMENT_WITHDRAWAL","CRYPTO_TO_FIAT_WITHDRAWAL","CRYPTO_TO_CRYPTO_WITHDRAWAL","CRYPTO_TO_CRYPTO_DEPOSIT","CRYPTO_TO_CRYPTO_INVOICE_WITHDRAWAL","CRYPTO_TO_CRYPTO_INVOICE_DEPOSIT","CREATION_SINGLE_INVOICE","CREATION_SINGLE_FIAT_INVOICE","CREATION_UNLIMITED_INVOICE","CREATION_UNLIMITED_LINKED_INVOICE","CREATION_BOUND_INVOICE","UNLIMITED_INVOICE_FIRST_PAY_FEE","SINGLE_INVOICE","SINGLE_FIAT_INVOICE","UNLIMITED_INVOICE","UNLIMITED_LINKED_INVOICE","BOUND_INVOICE","TOP_UP","SETTLEMENT_TOP_UP","FIAT_TOP_UP","FEE","ISSUE_LOAN","REPAYMENT_LOAN","UNLIMITED_CUSTOMER_PURSE","UNLIMITED_CUSTOMER_PURSE_FIRST_PAY_FEE","RECOVERY"]},"addressTo":{"type":"string","description":"Recipient's wallet address"},"serviceFee":{"type":"number","description":"Service fee"},"serviceFeeCurrency":{"type":"string","description":"Service fee currency ticker"},"networkFee":{"type":"number","description":"Network fee"},"networkFeeCurrency":{"type":"string","description":"Network fee currency ticker"},"transactionHash":{"type":"string","description":"Transaction hash"},"createdDate":{"type":"string","description":"Date of creation","format":"date-time"}},"description":"Data of the response to the transaction receipt request"}}}}
```

## The PGRenameWalletRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGRenameWalletRequestDTO":{"required":["address","name"],"type":"object","properties":{"address":{"type":"string","description":"Wallet address"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"New wallet name"}},"description":"Request data for renaming the wallet"}}}}
```

## The WithAccountContainerPGRenameWalletRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGRenameWalletRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGRenameWalletRequestDTO"}},"description":"Object with request data"},"PGRenameWalletRequestDTO":{"required":["address","name"],"type":"object","properties":{"address":{"type":"string","description":"Wallet address"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"New wallet name"}},"description":"Request data for renaming the wallet"}}}}
```

## The PGSettlementOpCodesResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGSettlementOpCodesResponseDTO":{"required":["opCodes"],"type":"object","properties":{"opCodes":{"type":"array","description":"Operation codes","items":{"type":"string","description":"Operation codes","enum":["WITHDRAWAL","INNER_WITHDRAWAL","SETTLEMENT_SINGLE_WITHDRAWAL","SETTLEMENT_MASS_WITHDRAWAL","SETTLEMENT_INTERNAL_WITHDRAWAL","SETTLEMENT_TO_ASSET_WITHDRAWAL","SETTLEMENT_TO_SETTLEMENT_WITHDRAWAL","ASSET_TO_SETTLEMENT_WITHDRAWAL","CRYPTO_TO_FIAT_WITHDRAWAL","CRYPTO_TO_CRYPTO_WITHDRAWAL","CRYPTO_TO_CRYPTO_DEPOSIT","CRYPTO_TO_CRYPTO_INVOICE_WITHDRAWAL","CRYPTO_TO_CRYPTO_INVOICE_DEPOSIT","CREATION_SINGLE_INVOICE","CREATION_SINGLE_FIAT_INVOICE","CREATION_UNLIMITED_INVOICE","CREATION_UNLIMITED_LINKED_INVOICE","CREATION_BOUND_INVOICE","UNLIMITED_INVOICE_FIRST_PAY_FEE","SINGLE_INVOICE","SINGLE_FIAT_INVOICE","UNLIMITED_INVOICE","UNLIMITED_LINKED_INVOICE","BOUND_INVOICE","TOP_UP","SETTLEMENT_TOP_UP","FIAT_TOP_UP","FEE","ISSUE_LOAN","REPAYMENT_LOAN","UNLIMITED_CUSTOMER_PURSE","UNLIMITED_CUSTOMER_PURSE_FIRST_PAY_FEE","RECOVERY"]}}},"description":"Data of the response to the request to obtain available operation codes"}}}}
```

## The PGCreateWalletRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGCreateWalletRequestDTO":{"required":["blockchain","name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"Wallet name"},"blockchain":{"type":"string","description":"Blockchain"}},"description":"Request data for creating a wallet"}}}}
```

## The WithAccountContainerPGCreateWalletRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGCreateWalletRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGCreateWalletRequestDTO"}},"description":"Object with request data"},"PGCreateWalletRequestDTO":{"required":["blockchain","name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"Wallet name"},"blockchain":{"type":"string","description":"Blockchain"}},"description":"Request data for creating a wallet"}}}}
```

## The PGWalletFilterDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGWalletFilterDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"blockchain":{"type":"string","description":"Filtering by blockchain"},"currency":{"type":"string","description":"Filtering by currency ticker"},"nameOrAddress":{"type":"string","description":"Filtering by wallet name or wallet address"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Data of the request for information about wallets"}}}}
```

## The WithAccountContainerPGWalletFilterDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGWalletFilterDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGWalletFilterDTO"}},"description":"Object with request data"},"PGWalletFilterDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"blockchain":{"type":"string","description":"Filtering by blockchain"},"currency":{"type":"string","description":"Filtering by currency ticker"},"nameOrAddress":{"type":"string","description":"Filtering by wallet name or wallet address"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Data of the request for information about wallets"}}}}
```

## The PageDTOPGSettlementWalletResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPGSettlementWalletResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PGSettlementWalletResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PGSettlementWalletResponseDTO":{"required":["address","balances","blockchain","name"],"type":"object","properties":{"name":{"type":"string","description":"Wallet name"},"address":{"type":"string","description":"Wallet address"},"blockchain":{"type":"string","description":"Wallet blockchain"},"balances":{"type":"array","description":"Wallet balances","items":{"$ref":"#/components/schemas/PGSettlementBalanceDTO"}}},"description":"Data of the response to the action with the wallet"},"PGSettlementBalanceDTO":{"required":["amount","currency","token"],"type":"object","properties":{"currency":{"type":"string","description":"Currency ticker"},"amount":{"type":"number","description":"The amount"},"token":{"type":"boolean","description":"Token attribute"}},"description":"Data of the response to the request for information about the wallet balance"}}}}
```

## The BaseReportRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"BaseReportRequestDTO":{"required":["blockchainList","firstDate","lastDate","zoneOffset"],"type":"object","properties":{"firstDate":{"type":"string","format":"date-time"},"lastDate":{"type":"string","format":"date-time"},"blockchainList":{"type":"string","description":"Blockchain"},"zoneOffset":{"type":"object","properties":{"totalSeconds":{"type":"integer","format":"int32"},"id":{"type":"string"},"rules":{"type":"object","properties":{"fixedOffset":{"type":"boolean"},"transitions":{"type":"array","items":{"type":"object","properties":{"overlap":{"type":"boolean"},"duration":{"type":"object","properties":{"seconds":{"type":"integer","format":"int64"},"zero":{"type":"boolean"},"nano":{"type":"integer","format":"int32"},"negative":{"type":"boolean"},"units":{"type":"array","items":{"type":"object","properties":{"durationEstimated":{"type":"boolean"},"timeBased":{"type":"boolean"},"dateBased":{"type":"boolean"}}}}}},"gap":{"type":"boolean"},"dateTimeAfter":{"type":"string","format":"date-time"},"dateTimeBefore":{"type":"string","format":"date-time"},"instant":{"type":"string","format":"date-time"}}}},"transitionRules":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"]},"timeDefinition":{"type":"string","enum":["UTC","WALL","STANDARD"]},"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"dayOfMonthIndicator":{"type":"integer","format":"int32"},"localTime":{"$ref":"#/components/schemas/LocalTime"},"midnightEndOfDay":{"type":"boolean"}}}}}}}}},"description":"Object with request parameters"},"LocalTime":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"}}}}}}
```

## The LocalTime object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"LocalTime":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"}}}}}}
```

## The WithAccountContainerBaseReportRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerBaseReportRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/BaseReportRequestDTO"}},"description":"Object with request data"},"BaseReportRequestDTO":{"required":["blockchainList","firstDate","lastDate","zoneOffset"],"type":"object","properties":{"firstDate":{"type":"string","format":"date-time"},"lastDate":{"type":"string","format":"date-time"},"blockchainList":{"type":"string","description":"Blockchain"},"zoneOffset":{"type":"object","properties":{"totalSeconds":{"type":"integer","format":"int32"},"id":{"type":"string"},"rules":{"type":"object","properties":{"fixedOffset":{"type":"boolean"},"transitions":{"type":"array","items":{"type":"object","properties":{"overlap":{"type":"boolean"},"duration":{"type":"object","properties":{"seconds":{"type":"integer","format":"int64"},"zero":{"type":"boolean"},"nano":{"type":"integer","format":"int32"},"negative":{"type":"boolean"},"units":{"type":"array","items":{"type":"object","properties":{"durationEstimated":{"type":"boolean"},"timeBased":{"type":"boolean"},"dateBased":{"type":"boolean"}}}}}},"gap":{"type":"boolean"},"dateTimeAfter":{"type":"string","format":"date-time"},"dateTimeBefore":{"type":"string","format":"date-time"},"instant":{"type":"string","format":"date-time"}}}},"transitionRules":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"]},"timeDefinition":{"type":"string","enum":["UTC","WALL","STANDARD"]},"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"dayOfMonthIndicator":{"type":"integer","format":"int32"},"localTime":{"$ref":"#/components/schemas/LocalTime"},"midnightEndOfDay":{"type":"boolean"}}}}}}}}},"description":"Object with request parameters"},"LocalTime":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"}}}}}}
```

## The AnyResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"AnyResponseDTO":{"required":["data"],"type":"object","properties":{"data":{"type":"object"}}}}}}
```

## The ByIdStringOrIdempotencyKeyRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByIdStringOrIdempotencyKeyRequestDTO":{"type":"object","properties":{"id":{"type":"string","description":"System id of the object. Either id or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The unique external id that can be generated by user while creating the object","format":"uuid"}},"description":"Object with request id and idempotencyKey parameters"}}}}
```

## The WithAccountContainerByIdStringOrIdempotencyKeyRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByIdStringOrIdempotencyKeyRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByIdStringOrIdempotencyKeyRequestDTO"}},"description":"Object with request data"},"ByIdStringOrIdempotencyKeyRequestDTO":{"type":"object","properties":{"id":{"type":"string","description":"System id of the object. Either id or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The unique external id that can be generated by user while creating the object","format":"uuid"}},"description":"Object with request id and idempotencyKey parameters"}}}}
```

## The PGDealCancellationDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGDealCancellationDTO":{"required":["cancelMessage","canceledByFirstname","canceledByLastname","canceledByUserId"],"type":"object","properties":{"canceledByUserId":{"type":"string","description":"User id who cancelled the payout"},"canceledByFirstname":{"type":"string","description":"First name of the user who cancelled the payout"},"canceledByLastname":{"type":"string","description":"Last name of the user who cancelled the payout"},"cancelMessage":{"type":"string","description":"Reason of payout cancellation"}},"description":"Payout cancellation details"}}}}
```

## The PGDealResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGDealResponseDTO":{"required":["account","amount","createdDate","currency","depositAddress","fee","feeCurrency","feePercentage","id","state"],"type":"object","properties":{"id":{"type":"string","description":"Payout id"},"account":{"type":"string","description":"Merchant account ID"},"depositAddress":{"type":"string","description":"Crypto address for deposit"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"fee":{"type":"number","description":"Service fee for the payout"},"feePercentage":{"type":"number","description":"Service fee in percentages"},"feeCurrency":{"type":"string","description":"Service fee currency for the payout"},"blockchainFee":{"type":"number","description":"Blockchain fee"},"blockchainFeeCurrency":{"type":"string","description":"Blockchain fee currency"},"state":{"type":"string","description":"Represents status of the payout","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","WAITING_COMPLETION_ERRORS","PARTIAL","COMPLETED","FAILED","CANCELED"]},"createdDate":{"type":"string","description":"Time of payout creation","format":"date-time"},"transactionHash":{"type":"string","description":"Hash of the transaction in blockchain"},"comment":{"type":"string","description":"Comment for the payout"},"idempotencyKey":{"type":"string","description":"The external id that can be generated by user while creating the payout in the uuid format","format":"uuid"},"errors":{"$ref":"#/components/schemas/WithdrawalValidationErrorDTO"},"cancellation":{"$ref":"#/components/schemas/PGDealCancellationDTO"},"externalId":{"type":"string","description":"External ID"}},"description":"Response with payout data"},"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"},"PGDealCancellationDTO":{"required":["cancelMessage","canceledByFirstname","canceledByLastname","canceledByUserId"],"type":"object","properties":{"canceledByUserId":{"type":"string","description":"User id who cancelled the payout"},"canceledByFirstname":{"type":"string","description":"First name of the user who cancelled the payout"},"canceledByLastname":{"type":"string","description":"Last name of the user who cancelled the payout"},"cancelMessage":{"type":"string","description":"Reason of payout cancellation"}},"description":"Payout cancellation details"}}}}
```

## The WithdrawalValidationDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The WithdrawalValidationErrorDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The WithdrawalValidationErrorItemDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The ByStringIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByStringIdRequestDTO":{"required":["requestId"],"type":"object","properties":{"requestId":{"type":"string","description":"The id of the object"}},"description":"Object with request id parameter"}}}}
```

## The WithAccountContainerByStringIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByStringIdRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByStringIdRequestDTO"}},"description":"Object with request data"},"ByStringIdRequestDTO":{"required":["requestId"],"type":"object","properties":{"requestId":{"type":"string","description":"The id of the object"}},"description":"Object with request id parameter"}}}}
```

## The PGDealWithdrawalResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGDealWithdrawalResponseDTO":{"required":["account","amount","createdDate","currency","depositAddress","fee","feeCurrency","id","state","withdrawalErrors"],"type":"object","properties":{"id":{"type":"string","description":"Id of the payout includes this transaction"},"account":{"type":"string","description":"Merchant account ID"},"withdrawalId":{"type":"integer","description":"Transaction id","format":"int64"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"state":{"type":"string","description":"Represents status of the withdrawal","enum":["DRAFT","IN_PROGRESS","COMPLETED","REPLACED","FAILED","CANCELED"]},"fee":{"type":"number","description":"Service fee for the withdrawal"},"feeCurrency":{"type":"string","description":"Service fee currency for the withdrawal"},"blockchainFee":{"type":"number","description":"Blockchain fee"},"blockchainFeeCurrency":{"type":"string","description":"Blockchain fee currency"},"transactionHash":{"type":"string","description":"Transaction hash"},"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"comment":{"type":"string","description":"Comment for the transaction"},"createdDate":{"type":"string","description":"Time of payout creation","format":"date-time"},"withdrawalErrors":{"type":"array","description":"Withdrawal errors details","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Response with withdrawal data"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The PGDealWithdrawalsByStateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGDealWithdrawalsByStateRequestDTO":{"required":["pageNumber","pageSize","stateNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the payout withdrawals to return","items":{"type":"string","description":"Statuses of the payout withdrawals to return","enum":["DRAFT","IN_PROGRESS","COMPLETED","REPLACED","FAILED","CANCELED"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"dealId":{"type":"string","description":"Payout ID for which you need to get withdrawals"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"}},"description":"Request data for getting payout withdrawals by state"}}}}
```

## The WithAccountContainerPGDealWithdrawalsByStateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGDealWithdrawalsByStateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGDealWithdrawalsByStateRequestDTO"}},"description":"Object with request data"},"PGDealWithdrawalsByStateRequestDTO":{"required":["pageNumber","pageSize","stateNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the payout withdrawals to return","items":{"type":"string","description":"Statuses of the payout withdrawals to return","enum":["DRAFT","IN_PROGRESS","COMPLETED","REPLACED","FAILED","CANCELED"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"dealId":{"type":"string","description":"Payout ID for which you need to get withdrawals"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"}},"description":"Request data for getting payout withdrawals by state"}}}}
```

## The PageDTOPGDealWithdrawalResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPGDealWithdrawalResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PGDealWithdrawalResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PGDealWithdrawalResponseDTO":{"required":["account","amount","createdDate","currency","depositAddress","fee","feeCurrency","id","state","withdrawalErrors"],"type":"object","properties":{"id":{"type":"string","description":"Id of the payout includes this transaction"},"account":{"type":"string","description":"Merchant account ID"},"withdrawalId":{"type":"integer","description":"Transaction id","format":"int64"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"state":{"type":"string","description":"Represents status of the withdrawal","enum":["DRAFT","IN_PROGRESS","COMPLETED","REPLACED","FAILED","CANCELED"]},"fee":{"type":"number","description":"Service fee for the withdrawal"},"feeCurrency":{"type":"string","description":"Service fee currency for the withdrawal"},"blockchainFee":{"type":"number","description":"Blockchain fee"},"blockchainFeeCurrency":{"type":"string","description":"Blockchain fee currency"},"transactionHash":{"type":"string","description":"Transaction hash"},"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"comment":{"type":"string","description":"Comment for the transaction"},"createdDate":{"type":"string","description":"Time of payout creation","format":"date-time"},"withdrawalErrors":{"type":"array","description":"Withdrawal errors details","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Response with withdrawal data"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The PGMassDealResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGMassDealResponseDTO":{"required":["account","comment","companyId","id","idempotencyKey","state"],"type":"object","properties":{"id":{"type":"string","description":"Payout id"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"companyId":{"type":"string","description":"Id of the company created mass payout","format":"uuid"},"account":{"type":"string","description":"Merchant account ID"},"state":{"type":"string","description":"Represents status of the payout","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","WAITING_COMPLETION_ERRORS","PARTIAL","COMPLETED","FAILED","CANCELED"]},"comment":{"type":"string","description":"Comment for the payout"},"name":{"type":"string","description":"Name of the payout"},"currency":{"type":"string","description":"Payout currency"},"totalWithdrawalAmount":{"type":"number","description":"Total amount of all transactions in a mass payout"},"totalFee":{"type":"number","description":"Total service fee for the mass payout"},"totalFeePercentage":{"type":"number","description":"Total service fee for the mass payout in percentages"},"feeCurrency":{"type":"string","description":"Service fee currency"},"blockchainFee":{"type":"number","description":"Blockchain fee"},"blockchainFeeCurrency":{"type":"string","description":"Blockchain fee currency"},"errors":{"$ref":"#/components/schemas/WithdrawalValidationErrorDTO"},"externalId":{"type":"string","description":"External ID"}},"description":"Response with mass payout data"},"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The MassPayoutAddressDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"MassPayoutAddressDTO":{"required":["amount","depositAddress"],"type":"object","properties":{"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Transaction amount"},"comment":{"maxLength":140,"minLength":0,"type":"string","description":"Comment for the withdrawal transaction"}},"description":"Object contains transaction details for each address"}}}}
```

## The PGMassDealCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGMassDealCreateRequestDTO":{"required":["currency","idempotencyKey","massAddresses","name","withdrawalAddress"],"type":"object","properties":{"withdrawalAddress":{"type":"string","description":"Адрес кошелька вывода"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Mass payout name"},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment for the mass payout"},"massAddresses":{"type":"array","description":"Object contains transaction details for each address","items":{"$ref":"#/components/schemas/MassPayoutAddressDTO"}},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"The external id that can be generated by user for particular transaction while creating the payout"}},"description":"Request with mass payout creation data"},"MassPayoutAddressDTO":{"required":["amount","depositAddress"],"type":"object","properties":{"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Transaction amount"},"comment":{"maxLength":140,"minLength":0,"type":"string","description":"Comment for the withdrawal transaction"}},"description":"Object contains transaction details for each address"}}}}
```

## The WithAccountContainerPGMassDealCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGMassDealCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGMassDealCreateRequestDTO"}},"description":"Object with request data"},"PGMassDealCreateRequestDTO":{"required":["currency","idempotencyKey","massAddresses","name","withdrawalAddress"],"type":"object","properties":{"withdrawalAddress":{"type":"string","description":"Адрес кошелька вывода"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Mass payout name"},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment for the mass payout"},"massAddresses":{"type":"array","description":"Object contains transaction details for each address","items":{"$ref":"#/components/schemas/MassPayoutAddressDTO"}},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"The external id that can be generated by user for particular transaction while creating the payout"}},"description":"Request with mass payout creation data"},"MassPayoutAddressDTO":{"required":["amount","depositAddress"],"type":"object","properties":{"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Transaction amount"},"comment":{"maxLength":140,"minLength":0,"type":"string","description":"Comment for the withdrawal transaction"}},"description":"Object contains transaction details for each address"}}}}
```

## The PGDealCancelRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGDealCancelRequestDTO":{"required":["message"],"type":"object","properties":{"dealId":{"type":"string","description":"Id of the payout you want to cancel"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"message":{"type":"string","description":"Text with the cancellation reason"}},"description":"Request with payout cancellation data"}}}}
```

## The WithAccountContainerPGDealCancelRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGDealCancelRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGDealCancelRequestDTO"}},"description":"Object with request data"},"PGDealCancelRequestDTO":{"required":["message"],"type":"object","properties":{"dealId":{"type":"string","description":"Id of the payout you want to cancel"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"message":{"type":"string","description":"Text with the cancellation reason"}},"description":"Request with payout cancellation data"}}}}
```

## The PGDealsByStateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGDealsByStateRequestDTO":{"required":["pageNumber","size","stateNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the payouts to return","items":{"type":"string","description":"Statuses of the payouts to return","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","WAITING_COMPLETION_ERRORS","PARTIAL","COMPLETED","FAILED","CANCELED"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10}},"description":"Request data for getting payouts by state"}}}}
```

## The WithAccountContainerPGDealsByStateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGDealsByStateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGDealsByStateRequestDTO"}},"description":"Object with request data"},"PGDealsByStateRequestDTO":{"required":["pageNumber","size","stateNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the payouts to return","items":{"type":"string","description":"Statuses of the payouts to return","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","WAITING_COMPLETION_ERRORS","PARTIAL","COMPLETED","FAILED","CANCELED"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10}},"description":"Request data for getting payouts by state"}}}}
```

## The PageDTOPGMassDealResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPGMassDealResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PGMassDealResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PGMassDealResponseDTO":{"required":["account","comment","companyId","id","idempotencyKey","state"],"type":"object","properties":{"id":{"type":"string","description":"Payout id"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"companyId":{"type":"string","description":"Id of the company created mass payout","format":"uuid"},"account":{"type":"string","description":"Merchant account ID"},"state":{"type":"string","description":"Represents status of the payout","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","WAITING_COMPLETION_ERRORS","PARTIAL","COMPLETED","FAILED","CANCELED"]},"comment":{"type":"string","description":"Comment for the payout"},"name":{"type":"string","description":"Name of the payout"},"currency":{"type":"string","description":"Payout currency"},"totalWithdrawalAmount":{"type":"number","description":"Total amount of all transactions in a mass payout"},"totalFee":{"type":"number","description":"Total service fee for the mass payout"},"totalFeePercentage":{"type":"number","description":"Total service fee for the mass payout in percentages"},"feeCurrency":{"type":"string","description":"Service fee currency"},"blockchainFee":{"type":"number","description":"Blockchain fee"},"blockchainFeeCurrency":{"type":"string","description":"Blockchain fee currency"},"errors":{"$ref":"#/components/schemas/WithdrawalValidationErrorDTO"},"externalId":{"type":"string","description":"External ID"}},"description":"Response with mass payout data"},"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The PGDealCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGDealCreateRequestDTO":{"required":["amount","currency","depositAddress","idempotencyKey","withdrawalAddress"],"type":"object","properties":{"withdrawalAddress":{"type":"string","description":"Sender's crypto-address"},"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment for the payout"},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"The external id that can be generated by user for particular transaction while creating the payout"}},"description":"Request for payout creation"}}}}
```

## The WithAccountContainerPGDealCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGDealCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGDealCreateRequestDTO"}},"description":"Object with request data"},"PGDealCreateRequestDTO":{"required":["amount","currency","depositAddress","idempotencyKey","withdrawalAddress"],"type":"object","properties":{"withdrawalAddress":{"type":"string","description":"Sender's crypto-address"},"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment for the payout"},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"The external id that can be generated by user for particular transaction while creating the payout"}},"description":"Request for payout creation"}}}}
```

## The PageDTOPGDealResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPGDealResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PGDealResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PGDealResponseDTO":{"required":["account","amount","createdDate","currency","depositAddress","fee","feeCurrency","feePercentage","id","state"],"type":"object","properties":{"id":{"type":"string","description":"Payout id"},"account":{"type":"string","description":"Merchant account ID"},"depositAddress":{"type":"string","description":"Crypto address for deposit"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"fee":{"type":"number","description":"Service fee for the payout"},"feePercentage":{"type":"number","description":"Service fee in percentages"},"feeCurrency":{"type":"string","description":"Service fee currency for the payout"},"blockchainFee":{"type":"number","description":"Blockchain fee"},"blockchainFeeCurrency":{"type":"string","description":"Blockchain fee currency"},"state":{"type":"string","description":"Represents status of the payout","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","WAITING_COMPLETION_ERRORS","PARTIAL","COMPLETED","FAILED","CANCELED"]},"createdDate":{"type":"string","description":"Time of payout creation","format":"date-time"},"transactionHash":{"type":"string","description":"Hash of the transaction in blockchain"},"comment":{"type":"string","description":"Comment for the payout"},"idempotencyKey":{"type":"string","description":"The external id that can be generated by user while creating the payout in the uuid format","format":"uuid"},"errors":{"$ref":"#/components/schemas/WithdrawalValidationErrorDTO"},"cancellation":{"$ref":"#/components/schemas/PGDealCancellationDTO"},"externalId":{"type":"string","description":"External ID"}},"description":"Response with payout data"},"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"},"PGDealCancellationDTO":{"required":["cancelMessage","canceledByFirstname","canceledByLastname","canceledByUserId"],"type":"object","properties":{"canceledByUserId":{"type":"string","description":"User id who cancelled the payout"},"canceledByFirstname":{"type":"string","description":"First name of the user who cancelled the payout"},"canceledByLastname":{"type":"string","description":"Last name of the user who cancelled the payout"},"cancelMessage":{"type":"string","description":"Reason of payout cancellation"}},"description":"Payout cancellation details"}}}}
```

## The PgReportRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PgReportRequestDTO":{"required":["currencyList","firstDate","lastDate","zoneOffset"],"type":"object","properties":{"firstDate":{"type":"string","description":"Start date","format":"date-time"},"lastDate":{"type":"string","description":"End date","format":"date-time"},"currencyList":{"type":"array","description":"Currency list","items":{"$ref":"#/components/schemas/Currency"}},"zoneOffset":{"type":"string","description":"Timezone offset","default":"+00:00"}},"description":"Report request data"},"Currency":{"type":"string"}}}}
```

## The WithAccountContainerPgReportRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPgReportRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PgReportRequestDTO"}},"description":"Object with request data"},"PgReportRequestDTO":{"required":["currencyList","firstDate","lastDate","zoneOffset"],"type":"object","properties":{"firstDate":{"type":"string","description":"Start date","format":"date-time"},"lastDate":{"type":"string","description":"End date","format":"date-time"},"currencyList":{"type":"array","description":"Currency list","items":{"$ref":"#/components/schemas/Currency"}},"zoneOffset":{"type":"string","description":"Timezone offset","default":"+00:00"}},"description":"Report request data"},"Currency":{"type":"string"}}}}
```

## The ContainerPGRatesRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ContainerPGRatesRequestDTO":{"required":["payload","timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGRatesRequestDTO"}},"description":"Object with request data"},"PGRatesRequestDTO":{"type":"object","properties":{"fromCurrencies":{"uniqueItems":true,"type":"array","description":"List of source currencies for getting rate","items":{"$ref":"#/components/schemas/Currency"}},"toCurrencies":{"uniqueItems":true,"type":"array","description":"List of target currencies for getting rate","items":{"$ref":"#/components/schemas/Currency"}}},"description":"Request with currencies parameters"},"Currency":{"type":"string"}}}}
```

## The PGRatesRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGRatesRequestDTO":{"type":"object","properties":{"fromCurrencies":{"uniqueItems":true,"type":"array","description":"List of source currencies for getting rate","items":{"$ref":"#/components/schemas/Currency"}},"toCurrencies":{"uniqueItems":true,"type":"array","description":"List of target currencies for getting rate","items":{"$ref":"#/components/schemas/Currency"}}},"description":"Request with currencies parameters"},"Currency":{"type":"string"}}}}
```

## The CurrencyRates object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CurrencyRates":{"required":["fromCurrency","rates","ratesDate","toCurrency"],"type":"object","properties":{"fromCurrency":{"type":"string","description":"Source currency"},"toCurrency":{"type":"string","description":"Target currency"},"rates":{"type":"number","description":"Rates"},"ratesDate":{"type":"string","description":"Rates date-time","format":"date-time"}},"description":"Exchange rates"}}}}
```

## The PGRatesResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGRatesResponseDTO":{"required":["currencyRates"],"type":"object","properties":{"currencyRates":{"type":"array","description":"List of exchange rates","items":{"$ref":"#/components/schemas/CurrencyRates"}}},"description":"Exchange rates"},"CurrencyRates":{"required":["fromCurrency","rates","ratesDate","toCurrency"],"type":"object","properties":{"fromCurrency":{"type":"string","description":"Source currency"},"toCurrency":{"type":"string","description":"Target currency"},"rates":{"type":"number","description":"Rates"},"ratesDate":{"type":"string","description":"Rates date-time","format":"date-time"}},"description":"Exchange rates"}}}}
```

## The ContainerPGFiatRatesInvertRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ContainerPGFiatRatesInvertRequestDTO":{"required":["payload","timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGFiatRatesInvertRequestDTO"}},"description":"Object with request data"},"PGFiatRatesInvertRequestDTO":{"required":["from","to"],"type":"object","properties":{"from":{"type":"array","description":"List of source currencies for getting rate","items":{"$ref":"#/components/schemas/Currency"}},"to":{"type":"array","description":"List of target currencies for getting rate","items":{"$ref":"#/components/schemas/FiatCurrency"}}},"description":"Request with currencies parameters"},"Currency":{"type":"string"},"FiatCurrency":{"type":"string"}}}}
```

## The PGFiatRatesInvertRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGFiatRatesInvertRequestDTO":{"required":["from","to"],"type":"object","properties":{"from":{"type":"array","description":"List of source currencies for getting rate","items":{"$ref":"#/components/schemas/Currency"}},"to":{"type":"array","description":"List of target currencies for getting rate","items":{"$ref":"#/components/schemas/FiatCurrency"}}},"description":"Request with currencies parameters"},"Currency":{"type":"string"},"FiatCurrency":{"type":"string"}}}}
```

## The PGFiatRatesInvertResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGFiatRatesInvertResponseDTO":{"required":["ratesMap"],"type":"object","properties":{"ratesMap":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number"}}}},"description":"Response currency data"}}}}
```

## The ByIdOrIdempotencyKeyRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByIdOrIdempotencyKeyRequestDTO":{"type":"object","properties":{"id":{"type":"string","description":"System id of the object. Either id or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The unique external id that can be generated by user while creating the object","format":"uuid"}},"description":"Object with request id and idempotencyKey parameters"}}}}
```

## The WithAccountContainerByIdOrIdempotencyKeyRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByIdOrIdempotencyKeyRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByIdOrIdempotencyKeyRequestDTO"}},"description":"Object with request data"},"ByIdOrIdempotencyKeyRequestDTO":{"type":"object","properties":{"id":{"type":"string","description":"System id of the object. Either id or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The unique external id that can be generated by user while creating the object","format":"uuid"}},"description":"Object with request id and idempotencyKey parameters"}}}}
```

## The DealCancellationDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"DealCancellationDTO":{"required":["cancelMessage","canceledByFirstname","canceledByLastname","canceledByUserId"],"type":"object","properties":{"canceledByUserId":{"type":"string","description":"User id who cancelled the payout"},"canceledByFirstname":{"type":"string","description":"First name of the user who cancelled the payout"},"canceledByLastname":{"type":"string","description":"Last name of the user who cancelled the payout"},"cancelMessage":{"type":"string","description":"Reason of payout cancellation"}},"description":"Payout cancellation details"}}}}
```

## The PublicDealResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PublicDealResponseDTO":{"required":["account","amount","belongingType","createdDate","currency","depositAddress","fee","feePercentage","id","state"],"type":"object","properties":{"id":{"type":"string","description":"Payout ID"},"account":{"type":"string","description":"Merchant account ID"},"depositAddress":{"type":"string","description":"Crypto address for deposit"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"fee":{"type":"number","description":"Service fee for the payout"},"feePercentage":{"type":"number","description":"Service fee in percentages"},"state":{"type":"string","description":"Represents status of the payout","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","COMPLETED","FAILED","CANCELED","PARTIAL"]},"createdDate":{"type":"string","description":"Time of payout creation","format":"date-time"},"transactionHash":{"type":"string","description":"Hash of the transaction in blockchain"},"comment":{"type":"string","description":"Comment for the payout"},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id that can be generated by user while creating the payout in the uuid format","format":"uuid"},"errors":{"$ref":"#/components/schemas/WithdrawalValidationErrorDTO"},"cancellation":{"$ref":"#/components/schemas/DealCancellationDTO"},"belongingType":{"type":"string","description":"Belonging type","enum":["INTERNAL","EXTERNAL"]},"externalId":{"type":"string","description":"External ID"}},"description":"Response with payout data"},"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"},"DealCancellationDTO":{"required":["cancelMessage","canceledByFirstname","canceledByLastname","canceledByUserId"],"type":"object","properties":{"canceledByUserId":{"type":"string","description":"User id who cancelled the payout"},"canceledByFirstname":{"type":"string","description":"First name of the user who cancelled the payout"},"canceledByLastname":{"type":"string","description":"Last name of the user who cancelled the payout"},"cancelMessage":{"type":"string","description":"Reason of payout cancellation"}},"description":"Payout cancellation details"}}}}
```

## The ByIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByIdRequestDTO":{"required":["requestId"],"type":"object","properties":{"requestId":{"type":"string","description":"The id of the object"}},"description":"Object with request id parameter"}}}}
```

## The WithAccountContainerByIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByIdRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByIdRequestDTO"}},"description":"Object with request data"},"ByIdRequestDTO":{"required":["requestId"],"type":"object","properties":{"requestId":{"type":"string","description":"The id of the object"}},"description":"Object with request id parameter"}}}}
```

## The PublicDealWithdrawalResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PublicDealWithdrawalResponseDTO":{"required":["account","amount","belongingType","createdDate","currency","depositAddress","fee","id","state","withdrawalErrors"],"type":"object","properties":{"id":{"type":"string","description":"Id of the payout includes this transaction"},"account":{"type":"string","description":"Merchant account ID"},"companyName":{"type":"string","description":"Company of the user who created the payout"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"state":{"type":"string","description":"Represents status of the withdrawal","enum":["DRAFT","IN_PROGRESS","COMPLETED","REPLACED","FAILED","CANCELED"]},"fee":{"type":"number","description":"Service fee for the withdrawal"},"transactionHash":{"type":"string","description":"Transaction hash"},"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"comment":{"type":"string","description":"Comment for the transaction"},"createdDate":{"type":"string","description":"Time of payout creation","format":"date-time"},"withdrawalErrors":{"type":"array","description":"Withdrawal errors details","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}},"belongingType":{"type":"string","description":"Belonging type","enum":["INTERNAL","EXTERNAL"]}},"description":"Response with withdrawal data"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The PublicDealWithdrawalsByStateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PublicDealWithdrawalsByStateRequestDTO":{"required":["pageNumber","pageSize","stateNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the payout withdrawals to return","items":{"type":"string","description":"Statuses of the payout withdrawals to return","enum":["DRAFT","IN_PROGRESS","COMPLETED","REPLACED","FAILED","CANCELED"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"dealId":{"type":"string","description":"Payout ID for which you need to get withdrawals"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"}},"description":"Request data for getting payout withdrawals by state"}}}}
```

## The WithAccountContainerPublicDealWithdrawalsByStateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPublicDealWithdrawalsByStateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PublicDealWithdrawalsByStateRequestDTO"}},"description":"Object with request data"},"PublicDealWithdrawalsByStateRequestDTO":{"required":["pageNumber","pageSize","stateNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the payout withdrawals to return","items":{"type":"string","description":"Statuses of the payout withdrawals to return","enum":["DRAFT","IN_PROGRESS","COMPLETED","REPLACED","FAILED","CANCELED"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"dealId":{"type":"string","description":"Payout ID for which you need to get withdrawals"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"}},"description":"Request data for getting payout withdrawals by state"}}}}
```

## The PageDTOPublicDealWithdrawalResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPublicDealWithdrawalResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PublicDealWithdrawalResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PublicDealWithdrawalResponseDTO":{"required":["account","amount","belongingType","createdDate","currency","depositAddress","fee","id","state","withdrawalErrors"],"type":"object","properties":{"id":{"type":"string","description":"Id of the payout includes this transaction"},"account":{"type":"string","description":"Merchant account ID"},"companyName":{"type":"string","description":"Company of the user who created the payout"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"state":{"type":"string","description":"Represents status of the withdrawal","enum":["DRAFT","IN_PROGRESS","COMPLETED","REPLACED","FAILED","CANCELED"]},"fee":{"type":"number","description":"Service fee for the withdrawal"},"transactionHash":{"type":"string","description":"Transaction hash"},"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"comment":{"type":"string","description":"Comment for the transaction"},"createdDate":{"type":"string","description":"Time of payout creation","format":"date-time"},"withdrawalErrors":{"type":"array","description":"Withdrawal errors details","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}},"belongingType":{"type":"string","description":"Belonging type","enum":["INTERNAL","EXTERNAL"]}},"description":"Response with withdrawal data"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The PublicMassDealResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PublicMassDealResponseDTO":{"required":["account","comment","companyId","id","idempotencyKey","state"],"type":"object","properties":{"id":{"type":"string","description":"Payout ID"},"idempotencyKey":{"type":"string","description":"The external ID in the UUID format that can be generated by user while creating the payout","format":"uuid"},"companyId":{"type":"string","description":"ID of the company created mass payout","format":"uuid"},"account":{"type":"string","description":"Merchant account ID"},"state":{"type":"string","description":"Represents status of the payout","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","COMPLETED","FAILED","CANCELED","PARTIAL"]},"comment":{"type":"string","description":"Comment for the payout"},"name":{"type":"string","description":"Name of the payout"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"totalWithdrawalAmount":{"type":"number","description":"Total amount of all transactions in a mass payout"},"totalFee":{"type":"number","description":"Total service fee for the mass payout"},"totalFeePercentage":{"type":"number","description":"Total service fee for the mass payout in percentages"},"executionDate":{"type":"string","description":"Execution date of payout. Time when payout will be executed","format":"date-time"},"errors":{"$ref":"#/components/schemas/WithdrawalValidationErrorDTO"},"externalId":{"type":"string","description":"External ID"}},"description":"Response with mass payout data"},"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The MassDealCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"MassDealCreateRequestDTO":{"required":["currency","massAddresses","name"],"type":"object","properties":{"currency":{"type":"string","description":"This is the currency associated with the amount field"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Mass payout name"},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment for the mass payout"},"massAddresses":{"type":"array","description":"Object contains transaction details for each address","items":{"$ref":"#/components/schemas/MassPayoutAddressDTO"}},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"The external id that can be generated by user for particular transaction while creating the payout"}},"description":"Request with mass payout creation data"},"MassPayoutAddressDTO":{"required":["amount","depositAddress"],"type":"object","properties":{"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Transaction amount"},"comment":{"maxLength":140,"minLength":0,"type":"string","description":"Comment for the withdrawal transaction"}},"description":"Object contains transaction details for each address"}}}}
```

## The WithAccountContainerMassDealCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerMassDealCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/MassDealCreateRequestDTO"}},"description":"Object with request data"},"MassDealCreateRequestDTO":{"required":["currency","massAddresses","name"],"type":"object","properties":{"currency":{"type":"string","description":"This is the currency associated with the amount field"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Mass payout name"},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment for the mass payout"},"massAddresses":{"type":"array","description":"Object contains transaction details for each address","items":{"$ref":"#/components/schemas/MassPayoutAddressDTO"}},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"The external id that can be generated by user for particular transaction while creating the payout"}},"description":"Request with mass payout creation data"},"MassPayoutAddressDTO":{"required":["amount","depositAddress"],"type":"object","properties":{"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Transaction amount"},"comment":{"maxLength":140,"minLength":0,"type":"string","description":"Comment for the withdrawal transaction"}},"description":"Object contains transaction details for each address"}}}}
```

## The PublicCancelDealRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PublicCancelDealRequestDTO":{"required":["message"],"type":"object","properties":{"dealId":{"type":"string","description":"Id of the payout you want to cancel"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"message":{"type":"string","description":"Text with the cancellation reason"}},"description":"Request with payout cancellation data"}}}}
```

## The WithAccountContainerPublicCancelDealRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPublicCancelDealRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PublicCancelDealRequestDTO"}},"description":"Object with request data"},"PublicCancelDealRequestDTO":{"required":["message"],"type":"object","properties":{"dealId":{"type":"string","description":"Id of the payout you want to cancel"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"message":{"type":"string","description":"Text with the cancellation reason"}},"description":"Request with payout cancellation data"}}}}
```

## The DealsByStateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"DealsByStateRequestDTO":{"required":["pageNumber","size","stateNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the payouts to return","items":{"type":"string","description":"Statuses of the payouts to return","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","COMPLETED","FAILED","CANCELED","PARTIAL"]}},"isExecutionDateInFuture":{"type":"boolean","description":"If true, includes all payouts where execution date in future. if false, includes all payouts where execution date in past. if null includes all payouts"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10}},"description":"Request data for getting payouts by state"}}}}
```

## The WithAccountContainerDealsByStateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerDealsByStateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/DealsByStateRequestDTO"}},"description":"Object with request data"},"DealsByStateRequestDTO":{"required":["pageNumber","size","stateNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the payouts to return","items":{"type":"string","description":"Statuses of the payouts to return","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","COMPLETED","FAILED","CANCELED","PARTIAL"]}},"isExecutionDateInFuture":{"type":"boolean","description":"If true, includes all payouts where execution date in future. if false, includes all payouts where execution date in past. if null includes all payouts"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10}},"description":"Request data for getting payouts by state"}}}}
```

## The PageDTOPublicMassDealResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPublicMassDealResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PublicMassDealResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PublicMassDealResponseDTO":{"required":["account","comment","companyId","id","idempotencyKey","state"],"type":"object","properties":{"id":{"type":"string","description":"Payout ID"},"idempotencyKey":{"type":"string","description":"The external ID in the UUID format that can be generated by user while creating the payout","format":"uuid"},"companyId":{"type":"string","description":"ID of the company created mass payout","format":"uuid"},"account":{"type":"string","description":"Merchant account ID"},"state":{"type":"string","description":"Represents status of the payout","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","COMPLETED","FAILED","CANCELED","PARTIAL"]},"comment":{"type":"string","description":"Comment for the payout"},"name":{"type":"string","description":"Name of the payout"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"totalWithdrawalAmount":{"type":"number","description":"Total amount of all transactions in a mass payout"},"totalFee":{"type":"number","description":"Total service fee for the mass payout"},"totalFeePercentage":{"type":"number","description":"Total service fee for the mass payout in percentages"},"executionDate":{"type":"string","description":"Execution date of payout. Time when payout will be executed","format":"date-time"},"errors":{"$ref":"#/components/schemas/WithdrawalValidationErrorDTO"},"externalId":{"type":"string","description":"External ID"}},"description":"Response with mass payout data"},"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"}}}}
```

## The PublicDealCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PublicDealCreateRequestDTO":{"required":["amount","currency","depositAddress"],"type":"object","properties":{"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment for the payout"},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"The external id that can be generated by user for particular transaction while creating the payout"}},"description":"Request for payout creation"}}}}
```

## The WithAccountContainerPublicDealCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPublicDealCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PublicDealCreateRequestDTO"}},"description":"Object with request data"},"PublicDealCreateRequestDTO":{"required":["amount","currency","depositAddress"],"type":"object","properties":{"depositAddress":{"type":"string","description":"Recipient's crypto-address"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"comment":{"maxLength":1000,"minLength":0,"type":"string","description":"Comment for the payout"},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payout","format":"uuid"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"The external id that can be generated by user for particular transaction while creating the payout"}},"description":"Request for payout creation"}}}}
```

## The PageDTOPublicDealResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPublicDealResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PublicDealResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PublicDealResponseDTO":{"required":["account","amount","belongingType","createdDate","currency","depositAddress","fee","feePercentage","id","state"],"type":"object","properties":{"id":{"type":"string","description":"Payout ID"},"account":{"type":"string","description":"Merchant account ID"},"depositAddress":{"type":"string","description":"Crypto address for deposit"},"amount":{"type":"number","description":"Withdrawal amount"},"currency":{"type":"string","description":"This is the currency associated with the amount field"},"fee":{"type":"number","description":"Service fee for the payout"},"feePercentage":{"type":"number","description":"Service fee in percentages"},"state":{"type":"string","description":"Represents status of the payout","enum":["CREATION_IN_PROGRESS","PENDING_CONFIRMATION","CONFIRMED","IN_PROGRESS","COMPLETED","FAILED","CANCELED","PARTIAL"]},"createdDate":{"type":"string","description":"Time of payout creation","format":"date-time"},"transactionHash":{"type":"string","description":"Hash of the transaction in blockchain"},"comment":{"type":"string","description":"Comment for the payout"},"executionDate":{"type":"string","description":"Execution date of payout. Can be used for payouts to date","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id that can be generated by user while creating the payout in the uuid format","format":"uuid"},"errors":{"$ref":"#/components/schemas/WithdrawalValidationErrorDTO"},"cancellation":{"$ref":"#/components/schemas/DealCancellationDTO"},"belongingType":{"type":"string","description":"Belonging type","enum":["INTERNAL","EXTERNAL"]},"externalId":{"type":"string","description":"External ID"}},"description":"Response with payout data"},"WithdrawalValidationErrorDTO":{"required":["withdrawalErrors"],"type":"object","properties":{"withdrawalErrors":{"type":"array","description":"Payout error list","items":{"$ref":"#/components/schemas/WithdrawalValidationErrorItemDTO"}}},"description":"Payout errors details"},"WithdrawalValidationErrorItemDTO":{"required":["errors","withdrawalId"],"type":"object","properties":{"withdrawalId":{"type":"string","description":"Id of the withdrawal where error occurred"},"errors":{"type":"array","description":"Payout error list for the withdrawal","items":{"$ref":"#/components/schemas/WithdrawalValidationDTO"}}},"description":"Payout error list"},"WithdrawalValidationDTO":{"required":["errorResolved","id","status"],"type":"object","properties":{"id":{"type":"integer","description":"Id of the error","format":"int64"},"status":{"type":"string","description":"Validation status of the withdrawal","enum":["SUCCESS","NOT_ENOUGH_FUNDS","NOT_ENOUGH_FUNDS_FOR_COMMISSION","NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSION","EXCEEDING_LIMIT"]},"errorResolved":{"type":"boolean","description":"Represents whether errors were resolved or not"},"errorMessage":{"type":"string","description":"Text of the error message"}},"description":"Payout error list for the withdrawal"},"DealCancellationDTO":{"required":["cancelMessage","canceledByFirstname","canceledByLastname","canceledByUserId"],"type":"object","properties":{"canceledByUserId":{"type":"string","description":"User id who cancelled the payout"},"canceledByFirstname":{"type":"string","description":"First name of the user who cancelled the payout"},"canceledByLastname":{"type":"string","description":"Last name of the user who cancelled the payout"},"cancelMessage":{"type":"string","description":"Reason of payout cancellation"}},"description":"Payout cancellation details"}}}}
```

## The ByUuidRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByUuidRequestDTO":{"required":["requestId"],"type":"object","properties":{"requestId":{"type":"string","description":"The external id of the webhook subscription","format":"uuid"}},"description":"Object with request id parameter"}}}}
```

## The WithAccountContainerByUuidRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByUuidRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByUuidRequestDTO"}},"description":"Object with request data"},"ByUuidRequestDTO":{"required":["requestId"],"type":"object","properties":{"requestId":{"type":"string","description":"The external id of the webhook subscription","format":"uuid"}},"description":"Object with request id parameter"}}}}
```

## The PaymentWidgetPGInvoiceDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentWidgetPGInvoiceDTO":{"required":["cryptoCurrency","invoiceId","invoiceIdempotencyKey"],"type":"object","properties":{"invoiceId":{"type":"string","description":"Id of invoice created from this payment widget"},"cryptoCurrency":{"type":"string","description":"Represents the currency of the invoice"},"invoiceIdempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"invoiceExternalId":{"type":"string","description":"Merchant ID of the invoice"}},"description":"List of invoices created from this payment widget"}}}}
```

## The PaymentWidgetPGUnlimitedLinkedDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentWidgetPGUnlimitedLinkedDTO":{"required":["createdDate","cryptoCurrencies","description","idempotencyKey","invoices","widgetState","widgetType"],"type":"object","properties":{"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"cryptoCurrencies":{"type":"array","description":"Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface","items":{"$ref":"#/components/schemas/Currency"}},"description":{"type":"string","description":"Description of the payment widget"},"widgetType":{"type":"string","description":"Type of the payment widget","enum":["SINGLE_FIAT","UNLIMITED_LINKED"]},"widgetState":{"type":"string","description":"Status of the the payment widget","enum":["IN_PROGRESS","COMPLETED","ARCHIVED"]},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment widget page"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment widget page"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id"},"invoices":{"type":"array","description":"List of invoices created from this payment widget","items":{"$ref":"#/components/schemas/PaymentWidgetPGInvoiceDTO"}},"createdDate":{"type":"string","description":"Time of payment widget creation","format":"date-time"},"expiration":{"type":"string","description":"Represents server timestamp of the invoice of the payment widget expiration moment","format":"date-time"}},"description":"Response with unlimited payment widget data"},"Currency":{"type":"string"},"PaymentWidgetPGInvoiceDTO":{"required":["cryptoCurrency","invoiceId","invoiceIdempotencyKey"],"type":"object","properties":{"invoiceId":{"type":"string","description":"Id of invoice created from this payment widget"},"cryptoCurrency":{"type":"string","description":"Represents the currency of the invoice"},"invoiceIdempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"invoiceExternalId":{"type":"string","description":"Merchant ID of the invoice"}},"description":"List of invoices created from this payment widget"}}}}
```

## The PaymentWidgetPGUnlimitedLinkedCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentWidgetPGUnlimitedLinkedCreateRequestDTO":{"required":["cryptoCurrencies","description"],"type":"object","properties":{"cryptoCurrencies":{"type":"array","description":"Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface","items":{"$ref":"#/components/schemas/Currency"}},"description":{"type":"string","description":"Description of the payment widget"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment widget page"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment widget page"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id"},"expiration":{"type":"string","description":"Represents server timestamp of the invoice of the payment widget expiration moment","format":"date-time"}},"description":"Request with unlimited widget creation data"},"Currency":{"type":"string"}}}}
```

## The WithAccountContainerPaymentWidgetPGUnlimitedLinkedCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPaymentWidgetPGUnlimitedLinkedCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PaymentWidgetPGUnlimitedLinkedCreateRequestDTO"}},"description":"Object with request data"},"PaymentWidgetPGUnlimitedLinkedCreateRequestDTO":{"required":["cryptoCurrencies","description"],"type":"object","properties":{"cryptoCurrencies":{"type":"array","description":"Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface","items":{"$ref":"#/components/schemas/Currency"}},"description":{"type":"string","description":"Description of the payment widget"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment widget page"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment widget page"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id"},"expiration":{"type":"string","description":"Represents server timestamp of the invoice of the payment widget expiration moment","format":"date-time"}},"description":"Request with unlimited widget creation data"},"Currency":{"type":"string"}}}}
```

## The PaymentWidgetPGUnlimitedLinkedFindRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentWidgetPGUnlimitedLinkedFindRequestDTO":{"required":["pageNumber","size"],"type":"object","properties":{"widgetStates":{"type":"array","description":"The status of payment widgets","items":{"type":"string","description":"The status of payment widgets","enum":["IN_PROGRESS","COMPLETED","ARCHIVED"]}},"pageNumber":{"type":"integer","description":"The page of results to return","format":"int32","default":1},"size":{"type":"integer","description":"A numeric value indicating the page size","format":"int32","default":10}},"description":"Request for getting unlimited widget"}}}}
```

## The WithAccountContainerPaymentWidgetPGUnlimitedLinkedFindRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPaymentWidgetPGUnlimitedLinkedFindRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PaymentWidgetPGUnlimitedLinkedFindRequestDTO"}},"description":"Object with request data"},"PaymentWidgetPGUnlimitedLinkedFindRequestDTO":{"required":["pageNumber","size"],"type":"object","properties":{"widgetStates":{"type":"array","description":"The status of payment widgets","items":{"type":"string","description":"The status of payment widgets","enum":["IN_PROGRESS","COMPLETED","ARCHIVED"]}},"pageNumber":{"type":"integer","description":"The page of results to return","format":"int32","default":1},"size":{"type":"integer","description":"A numeric value indicating the page size","format":"int32","default":10}},"description":"Request for getting unlimited widget"}}}}
```

## The PageDTOPaymentWidgetPGUnlimitedLinkedDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPaymentWidgetPGUnlimitedLinkedDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PaymentWidgetPGUnlimitedLinkedDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PaymentWidgetPGUnlimitedLinkedDTO":{"required":["createdDate","cryptoCurrencies","description","idempotencyKey","invoices","widgetState","widgetType"],"type":"object","properties":{"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"cryptoCurrencies":{"type":"array","description":"Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface","items":{"$ref":"#/components/schemas/Currency"}},"description":{"type":"string","description":"Description of the payment widget"},"widgetType":{"type":"string","description":"Type of the payment widget","enum":["SINGLE_FIAT","UNLIMITED_LINKED"]},"widgetState":{"type":"string","description":"Status of the the payment widget","enum":["IN_PROGRESS","COMPLETED","ARCHIVED"]},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment widget page"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment widget page"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id"},"invoices":{"type":"array","description":"List of invoices created from this payment widget","items":{"$ref":"#/components/schemas/PaymentWidgetPGInvoiceDTO"}},"createdDate":{"type":"string","description":"Time of payment widget creation","format":"date-time"},"expiration":{"type":"string","description":"Represents server timestamp of the invoice of the payment widget expiration moment","format":"date-time"}},"description":"Response with unlimited payment widget data"},"Currency":{"type":"string"},"PaymentWidgetPGInvoiceDTO":{"required":["cryptoCurrency","invoiceId","invoiceIdempotencyKey"],"type":"object","properties":{"invoiceId":{"type":"string","description":"Id of invoice created from this payment widget"},"cryptoCurrency":{"type":"string","description":"Represents the currency of the invoice"},"invoiceIdempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"invoiceExternalId":{"type":"string","description":"Merchant ID of the invoice"}},"description":"List of invoices created from this payment widget"}}}}
```

## The PaymentWidgetPGSingleFiatDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentWidgetPGSingleFiatDTO":{"required":["createdDate","cryptoCurrencies","description","expiration","fiatAmount","fiatCurrency","idempotencyKey","invoices","widgetState","widgetType"],"type":"object","properties":{"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"cryptoCurrencies":{"type":"array","description":"Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface","items":{"$ref":"#/components/schemas/Currency"}},"widgetType":{"type":"string","description":"Type of the payment widget","enum":["SINGLE_FIAT","UNLIMITED_LINKED"]},"widgetState":{"type":"string","description":"Status of the payment widget","enum":["IN_PROGRESS","COMPLETED","ARCHIVED"]},"fiatCurrency":{"type":"string","description":"Fiat currency of the widget"},"fiatAmount":{"type":"number","description":"Amount in fiat currency for invoice created from this payment widget"},"description":{"type":"string","description":"Description of the payment widget"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment widget page"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment widget page"},"expiration":{"type":"string","description":"Represents server timestamp of payment widget expiration moment","format":"date-time"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id"},"invoices":{"type":"array","description":"List of invoices created from this payment widget","items":{"$ref":"#/components/schemas/PaymentWidgetPGInvoiceDTO"}},"createdDate":{"type":"string","description":"Time of payment widget creation","format":"date-time"}},"description":"Response with single fiat invoice data"},"Currency":{"type":"string"},"PaymentWidgetPGInvoiceDTO":{"required":["cryptoCurrency","invoiceId","invoiceIdempotencyKey"],"type":"object","properties":{"invoiceId":{"type":"string","description":"Id of invoice created from this payment widget"},"cryptoCurrency":{"type":"string","description":"Represents the currency of the invoice"},"invoiceIdempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"invoiceExternalId":{"type":"string","description":"Merchant ID of the invoice"}},"description":"List of invoices created from this payment widget"}}}}
```

## The PaymentWidgetPGSingleFiatCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentWidgetPGSingleFiatCreateRequestDTO":{"required":["cryptoCurrencies","description","expiration","fiatAmount","fiatCurrency"],"type":"object","properties":{"fiatCurrency":{"type":"string","description":"Fiat currency of the widget"},"fiatAmount":{"type":"number","description":"Amount in fiat currency for invoice created from this payment widget"},"description":{"type":"string","description":"Description of the payment widget"},"cryptoCurrencies":{"type":"array","description":"Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface","items":{"$ref":"#/components/schemas/Currency"}},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment widget page"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment widget page"},"expiration":{"type":"string","description":"Represents server timestamp of the invoice of the payment widget expiration moment","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id"}},"description":"Request with single fiat widget creation data"},"Currency":{"type":"string"}}}}
```

## The WithAccountContainerPaymentWidgetPGSingleFiatCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPaymentWidgetPGSingleFiatCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PaymentWidgetPGSingleFiatCreateRequestDTO"}},"description":"Object with request data"},"PaymentWidgetPGSingleFiatCreateRequestDTO":{"required":["cryptoCurrencies","description","expiration","fiatAmount","fiatCurrency"],"type":"object","properties":{"fiatCurrency":{"type":"string","description":"Fiat currency of the widget"},"fiatAmount":{"type":"number","description":"Amount in fiat currency for invoice created from this payment widget"},"description":{"type":"string","description":"Description of the payment widget"},"cryptoCurrencies":{"type":"array","description":"Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface","items":{"$ref":"#/components/schemas/Currency"}},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment widget page"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment widget page"},"expiration":{"type":"string","description":"Represents server timestamp of the invoice of the payment widget expiration moment","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id"}},"description":"Request with single fiat widget creation data"},"Currency":{"type":"string"}}}}
```

## The PaymentWidgetPGSingleFiatFindRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentWidgetPGSingleFiatFindRequestDTO":{"required":["pageNumber","size"],"type":"object","properties":{"widgetStates":{"type":"array","description":"The status of payment widgets","items":{"type":"string","description":"The status of payment widgets","enum":["IN_PROGRESS","COMPLETED","ARCHIVED"]}},"pageNumber":{"type":"integer","description":"The page of results to return","format":"int32","default":1},"size":{"type":"integer","description":"A numeric value indicating the page size","format":"int32","default":10}},"description":"Request for getting single fiat widget"}}}}
```

## The WithAccountContainerPaymentWidgetPGSingleFiatFindRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPaymentWidgetPGSingleFiatFindRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PaymentWidgetPGSingleFiatFindRequestDTO"}},"description":"Object with request data"},"PaymentWidgetPGSingleFiatFindRequestDTO":{"required":["pageNumber","size"],"type":"object","properties":{"widgetStates":{"type":"array","description":"The status of payment widgets","items":{"type":"string","description":"The status of payment widgets","enum":["IN_PROGRESS","COMPLETED","ARCHIVED"]}},"pageNumber":{"type":"integer","description":"The page of results to return","format":"int32","default":1},"size":{"type":"integer","description":"A numeric value indicating the page size","format":"int32","default":10}},"description":"Request for getting single fiat widget"}}}}
```

## The PageDTOPaymentWidgetPGSingleFiatDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPaymentWidgetPGSingleFiatDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PaymentWidgetPGSingleFiatDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PaymentWidgetPGSingleFiatDTO":{"required":["createdDate","cryptoCurrencies","description","expiration","fiatAmount","fiatCurrency","idempotencyKey","invoices","widgetState","widgetType"],"type":"object","properties":{"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"cryptoCurrencies":{"type":"array","description":"Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface","items":{"$ref":"#/components/schemas/Currency"}},"widgetType":{"type":"string","description":"Type of the payment widget","enum":["SINGLE_FIAT","UNLIMITED_LINKED"]},"widgetState":{"type":"string","description":"Status of the payment widget","enum":["IN_PROGRESS","COMPLETED","ARCHIVED"]},"fiatCurrency":{"type":"string","description":"Fiat currency of the widget"},"fiatAmount":{"type":"number","description":"Amount in fiat currency for invoice created from this payment widget"},"description":{"type":"string","description":"Description of the payment widget"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment widget page"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment widget page"},"expiration":{"type":"string","description":"Represents server timestamp of payment widget expiration moment","format":"date-time"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id"},"invoices":{"type":"array","description":"List of invoices created from this payment widget","items":{"$ref":"#/components/schemas/PaymentWidgetPGInvoiceDTO"}},"createdDate":{"type":"string","description":"Time of payment widget creation","format":"date-time"}},"description":"Response with single fiat invoice data"},"Currency":{"type":"string"},"PaymentWidgetPGInvoiceDTO":{"required":["cryptoCurrency","invoiceId","invoiceIdempotencyKey"],"type":"object","properties":{"invoiceId":{"type":"string","description":"Id of invoice created from this payment widget"},"cryptoCurrency":{"type":"string","description":"Represents the currency of the invoice"},"invoiceIdempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the payment widget","format":"uuid"},"invoiceExternalId":{"type":"string","description":"Merchant ID of the invoice"}},"description":"List of invoices created from this payment widget"}}}}
```

## The AutoconversionDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"AutoconversionDTO":{"required":["targetCurrency"],"type":"object","properties":{"targetCurrency":{"type":"string","description":"Target currency"},"amount":{"type":"number","description":"The pre-calculated amount or the actual amount after the conversion is completed"}},"description":"Response data of the Invoice Autoconversion configuration"}}}}
```

## The InvoiceDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"InvoiceDTO":{"required":["createdDate","creationSource","currency","description","fiatAvailable","id","idempotencyKey","invoiceAddress","isInterventionResolved","state","subscriptionEnabled","totalDebitAmount","type"],"type":"object","properties":{"id":{"type":"string","description":"Invoice id"},"invoiceAddress":{"type":"string","description":"Crypto address for deposit"},"type":{"type":"string","description":"The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters","enum":["SINGLE","SINGLE_FIAT","UNLIMITED","UNLIMITED_LINKED","BOUND"]},"amount":{"type":"number","description":"Amount of the invoice"},"fee":{"type":"number","description":"Service fee for invoice. This amount will be deducted from invoice amount"},"totalDebitAmount":{"type":"number","description":"The total amount of money received on the invoice wallet"},"currency":{"type":"string","description":"Currency of the invoice"},"state":{"type":"string","description":"Status of the invoice","enum":["MEM_POOL_FOUND","PENDING_PAYMENT","PAID","COMPLETED","PENDING_INTERVENTION","CANCEL","ARCHIVED","DECLINED","PENDING_COMPLIANCE_CHECK","REVERSED"]},"lastDepositHash":{"type":"string","description":"Hash of the last deposit transaction to the invoice"},"description":{"type":"string","description":"Short invoice description"},"createdDate":{"type":"string","description":"Time of invoice creation","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"expiration":{"type":"string","description":"Server timestamp of invoice expiration moment","format":"date-time"},"fiatAmount":{"type":"number","description":"Amount of fiat money set for SINGLE_FIAT_INVOICE"},"fiatCurrency":{"type":"string","description":"Currency of featAmount"},"lastFiatUpdated":{"type":"string","description":"Time when the exchange rate was updated last time in SINGLE_FIAT invoices","format":"date-time"},"interventionType":{"type":"string","description":"Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount","enum":["OVERPAY","UNDERPAY"]},"isInterventionResolved":{"type":"boolean","description":"Represents whether the intervention was resolved or not (set by user)"},"subscriptionEnabled":{"type":"boolean","description":"Represents whether client subscribed on email notifications or not"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"lowerBound":{"type":"number","description":"Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored"},"autoconversion":{"$ref":"#/components/schemas/AutoconversionDTO"},"fiatAvailable":{"type":"boolean","description":"Fiat available"},"creationSource":{"type":"string","description":"Creation source","enum":["UI","WIDGET","PUBLIC_GATEWAY","UNKNOWN"]}},"description":"Response with invoice data"},"AutoconversionDTO":{"required":["targetCurrency"],"type":"object","properties":{"targetCurrency":{"type":"string","description":"Target currency"},"amount":{"type":"number","description":"The pre-calculated amount or the actual amount after the conversion is completed"}},"description":"Response data of the Invoice Autoconversion configuration"}}}}
```

## The PGInvoiceUnlimitedCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGInvoiceUnlimitedCreateRequestDTO":{"required":["currency","description","fiatAvailable"],"type":"object","properties":{"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerPGInvoiceUnlimitedCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGInvoiceUnlimitedCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGInvoiceUnlimitedCreateRequestDTO"}},"description":"Object with request data"},"PGInvoiceUnlimitedCreateRequestDTO":{"required":["currency","description","fiatAvailable"],"type":"object","properties":{"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The PGInvoiceUnlimitedLinkedCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGInvoiceUnlimitedLinkedCreateRequestDTO":{"required":["currency","description","fiatAvailable"],"type":"object","properties":{"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerPGInvoiceUnlimitedLinkedCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGInvoiceUnlimitedLinkedCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGInvoiceUnlimitedLinkedCreateRequestDTO"}},"description":"Object with request data"},"PGInvoiceUnlimitedLinkedCreateRequestDTO":{"required":["currency","description","fiatAvailable"],"type":"object","properties":{"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The PGInvoiceSingleCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGInvoiceSingleCreateRequestDTO":{"required":["amount","currency","description","fiatAvailable"],"type":"object","properties":{"expiration":{"type":"string","description":"Server timestamp of invoice expiration moment. 1 days is default value","format":"date-time"},"amount":{"type":"number","description":"Invoice amount. Required for SINGLE invoices"},"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerPGInvoiceSingleCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGInvoiceSingleCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGInvoiceSingleCreateRequestDTO"}},"description":"Object with request data"},"PGInvoiceSingleCreateRequestDTO":{"required":["amount","currency","description","fiatAvailable"],"type":"object","properties":{"expiration":{"type":"string","description":"Server timestamp of invoice expiration moment. 1 days is default value","format":"date-time"},"amount":{"type":"number","description":"Invoice amount. Required for SINGLE invoices"},"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The PGInvoiceSingleFiatCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGInvoiceSingleFiatCreateRequestDTO":{"required":["currency","description","fiatAmount","fiatAvailable","fiatCurrency"],"type":"object","properties":{"fiatAmount":{"type":"number","description":"Invoice amount in fiat currency. Required for SINGLE_FIAT invoices"},"fiatCurrency":{"type":"string","description":"Fiat currency. Required for SINGLE_FIAT invoices"},"expiration":{"type":"string","description":"Server timestamp of invoice expiration moment. 1 days is default value","format":"date-time"},"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerPGInvoiceSingleFiatCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGInvoiceSingleFiatCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGInvoiceSingleFiatCreateRequestDTO"}},"description":"Object with request data"},"PGInvoiceSingleFiatCreateRequestDTO":{"required":["currency","description","fiatAmount","fiatAvailable","fiatCurrency"],"type":"object","properties":{"fiatAmount":{"type":"number","description":"Invoice amount in fiat currency. Required for SINGLE_FIAT invoices"},"fiatCurrency":{"type":"string","description":"Fiat currency. Required for SINGLE_FIAT invoices"},"expiration":{"type":"string","description":"Server timestamp of invoice expiration moment. 1 days is default value","format":"date-time"},"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The PGInvoicePaymentRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGInvoicePaymentRequestDTO":{"required":["paymentId"],"type":"object","properties":{"paymentId":{"type":"string","description":"Invoice payment ID"},"id":{"type":"string","description":"System ID of the invoice. Either ID or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The external ID that can be generated by user while creating the invoice","format":"uuid"}},"description":"Request for getting invoice payment"}}}}
```

## The WithAccountContainerPGInvoicePaymentRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGInvoicePaymentRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGInvoicePaymentRequestDTO"}},"description":"Object with request data"},"PGInvoicePaymentRequestDTO":{"required":["paymentId"],"type":"object","properties":{"paymentId":{"type":"string","description":"Invoice payment ID"},"id":{"type":"string","description":"System ID of the invoice. Either ID or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The external ID that can be generated by user while creating the invoice","format":"uuid"}},"description":"Request for getting invoice payment"}}}}
```

## The PgInvoicePaymentResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PgInvoicePaymentResponseDTO":{"required":["id","state"],"type":"object","properties":{"id":{"type":"string","description":"ID of the payment"},"state":{"type":"string","description":"State of the payment","enum":["IN_PROGRESS","AUTOCONVERSION","COMPLETED","FAILED"]}},"description":"Response with invoice payment data"}}}}
```

## The PGInvoicePaymentHistoryRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGInvoicePaymentHistoryRequestDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"id":{"type":"string","description":"System id of the invoice. Either id or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The external id that can be generated by user while creating the invoice","format":"uuid"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request for getting invoice payments"}}}}
```

## The WithAccountContainerPGInvoicePaymentHistoryRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGInvoicePaymentHistoryRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGInvoicePaymentHistoryRequestDTO"}},"description":"Object with request data"},"PGInvoicePaymentHistoryRequestDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"id":{"type":"string","description":"System id of the invoice. Either id or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The external id that can be generated by user while creating the invoice","format":"uuid"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request for getting invoice payments"}}}}
```

## The PageDTOPgInvoicePaymentResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPgInvoicePaymentResponseDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PgInvoicePaymentResponseDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PgInvoicePaymentResponseDTO":{"required":["id","state"],"type":"object","properties":{"id":{"type":"string","description":"ID of the payment"},"state":{"type":"string","description":"State of the payment","enum":["IN_PROGRESS","AUTOCONVERSION","COMPLETED","FAILED"]}},"description":"Response with invoice payment data"}}}}
```

## The InvoicesByExternalIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"InvoicesByExternalIdRequestDTO":{"required":["externalId","pageNumber","pageSize","properties","sort"],"type":"object","properties":{"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request data for getting invoices by external ID"}}}}
```

## The WithAccountContainerInvoicesByExternalIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerInvoicesByExternalIdRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/InvoicesByExternalIdRequestDTO"}},"description":"Object with request data"},"InvoicesByExternalIdRequestDTO":{"required":["externalId","pageNumber","pageSize","properties","sort"],"type":"object","properties":{"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request data for getting invoices by external ID"}}}}
```

## The PageDTOInvoiceDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOInvoiceDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/InvoiceDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"InvoiceDTO":{"required":["createdDate","creationSource","currency","description","fiatAvailable","id","idempotencyKey","invoiceAddress","isInterventionResolved","state","subscriptionEnabled","totalDebitAmount","type"],"type":"object","properties":{"id":{"type":"string","description":"Invoice id"},"invoiceAddress":{"type":"string","description":"Crypto address for deposit"},"type":{"type":"string","description":"The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters","enum":["SINGLE","SINGLE_FIAT","UNLIMITED","UNLIMITED_LINKED","BOUND"]},"amount":{"type":"number","description":"Amount of the invoice"},"fee":{"type":"number","description":"Service fee for invoice. This amount will be deducted from invoice amount"},"totalDebitAmount":{"type":"number","description":"The total amount of money received on the invoice wallet"},"currency":{"type":"string","description":"Currency of the invoice"},"state":{"type":"string","description":"Status of the invoice","enum":["MEM_POOL_FOUND","PENDING_PAYMENT","PAID","COMPLETED","PENDING_INTERVENTION","CANCEL","ARCHIVED","DECLINED","PENDING_COMPLIANCE_CHECK","REVERSED"]},"lastDepositHash":{"type":"string","description":"Hash of the last deposit transaction to the invoice"},"description":{"type":"string","description":"Short invoice description"},"createdDate":{"type":"string","description":"Time of invoice creation","format":"date-time"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"expiration":{"type":"string","description":"Server timestamp of invoice expiration moment","format":"date-time"},"fiatAmount":{"type":"number","description":"Amount of fiat money set for SINGLE_FIAT_INVOICE"},"fiatCurrency":{"type":"string","description":"Currency of featAmount"},"lastFiatUpdated":{"type":"string","description":"Time when the exchange rate was updated last time in SINGLE_FIAT invoices","format":"date-time"},"interventionType":{"type":"string","description":"Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount","enum":["OVERPAY","UNDERPAY"]},"isInterventionResolved":{"type":"boolean","description":"Represents whether the intervention was resolved or not (set by user)"},"subscriptionEnabled":{"type":"boolean","description":"Represents whether client subscribed on email notifications or not"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"lowerBound":{"type":"number","description":"Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored"},"autoconversion":{"$ref":"#/components/schemas/AutoconversionDTO"},"fiatAvailable":{"type":"boolean","description":"Fiat available"},"creationSource":{"type":"string","description":"Creation source","enum":["UI","WIDGET","PUBLIC_GATEWAY","UNKNOWN"]}},"description":"Response with invoice data"},"AutoconversionDTO":{"required":["targetCurrency"],"type":"object","properties":{"targetCurrency":{"type":"string","description":"Target currency"},"amount":{"type":"number","description":"The pre-calculated amount or the actual amount after the conversion is completed"}},"description":"Response data of the Invoice Autoconversion configuration"}}}}
```

## The PGInvoiceDepositRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGInvoiceDepositRequestDTO":{"required":["transactionId"],"type":"object","properties":{"transactionId":{"type":"string","description":"Invoice transaction ID","format":"uuid"},"id":{"type":"string","description":"System ID of the invoice. Either ID or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The external ID that can be generated by user while creating the invoice","format":"uuid"}},"description":"Request for getting invoice deposit"}}}}
```

## The WithAccountContainerPGInvoiceDepositRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGInvoiceDepositRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGInvoiceDepositRequestDTO"}},"description":"Object with request data"},"PGInvoiceDepositRequestDTO":{"required":["transactionId"],"type":"object","properties":{"transactionId":{"type":"string","description":"Invoice transaction ID","format":"uuid"},"id":{"type":"string","description":"System ID of the invoice. Either ID or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The external ID that can be generated by user while creating the invoice","format":"uuid"}},"description":"Request for getting invoice deposit"}}}}
```

## The PgInvoiceDepositResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PgInvoiceDepositResponseDTO":{"required":["amount","createdDate","currency","id"],"type":"object","properties":{"id":{"type":"string","description":"ID of the deposit","format":"uuid"},"amount":{"type":"number","description":"Amount of the deposit"},"currency":{"type":"string","description":"Currency of the deposit"},"transactionHash":{"type":"string","description":"Hash of the income transaction"},"createdDate":{"type":"string","description":"Date of the deposit","format":"date-time"}},"description":"Response with invoice deposit data"}}}}
```

## The InvoiceDepositHistoryRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"InvoiceDepositHistoryRequestDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"id":{"type":"string","description":"System id of the invoice. Either id or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The external id that can be generated by user while creating the invoice","format":"uuid"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request for getting invoice deposits"}}}}
```

## The WithAccountContainerInvoiceDepositHistoryRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerInvoiceDepositHistoryRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/InvoiceDepositHistoryRequestDTO"}},"description":"Object with request data"},"InvoiceDepositHistoryRequestDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"id":{"type":"string","description":"System id of the invoice. Either id or idempotencyKey must be specified"},"idempotencyKey":{"type":"string","description":"The external id that can be generated by user while creating the invoice","format":"uuid"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request for getting invoice deposits"}}}}
```

## The InvoiceDepositHistoryDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"InvoiceDepositHistoryDTO":{"required":["amount","createdDate","currency","id"],"type":"object","properties":{"id":{"type":"string","description":"ID of the deposit","format":"uuid"},"amount":{"type":"number","description":"Amount of the deposit"},"currency":{"type":"string","description":"Currency of the deposit"},"transactionHash":{"type":"string","description":"Hash of the income transaction"},"createdDate":{"type":"string","description":"Date of the deposit","format":"date-time"}},"description":"Response with invoice deposits data"}}}}
```

## The PageDTOInvoiceDepositHistoryDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOInvoiceDepositHistoryDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/InvoiceDepositHistoryDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"InvoiceDepositHistoryDTO":{"required":["amount","createdDate","currency","id"],"type":"object","properties":{"id":{"type":"string","description":"ID of the deposit","format":"uuid"},"amount":{"type":"number","description":"Amount of the deposit"},"currency":{"type":"string","description":"Currency of the deposit"},"transactionHash":{"type":"string","description":"Hash of the income transaction"},"createdDate":{"type":"string","description":"Date of the deposit","format":"date-time"}},"description":"Response with invoice deposits data"}}}}
```

## The PGInvoiceBoundCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGInvoiceBoundCreateRequestDTO":{"required":["currency","description","fiatAvailable","lowerBound"],"type":"object","properties":{"lowerBound":{"type":"number","description":"Minimal amount for invoice deposit. Deposits with lower amount will be ignored. Required for BOUND invoices"},"expiration":{"type":"string","description":"Server timestamp of invoice expiration moment. 1 days is default value","format":"date-time"},"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerPGInvoiceBoundCreateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGInvoiceBoundCreateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGInvoiceBoundCreateRequestDTO"}},"description":"Object with request data"},"PGInvoiceBoundCreateRequestDTO":{"required":["currency","description","fiatAvailable","lowerBound"],"type":"object","properties":{"lowerBound":{"type":"number","description":"Minimal amount for invoice deposit. Deposits with lower amount will be ignored. Required for BOUND invoices"},"expiration":{"type":"string","description":"Server timestamp of invoice expiration moment. 1 days is default value","format":"date-time"},"currency":{"type":"string","description":"Crypto currency of the invoice"},"description":{"type":"string","description":"Short invoice description"},"idempotencyKey":{"type":"string","description":"The external id in the uuid format that can be generated by user while creating the invoice","format":"uuid"},"returnUrl":{"type":"string","description":"Link to the web page where client can come back to from payment link (page with invoice data for payment)"},"logoUrl":{"type":"string","description":"Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px"},"supportUrl":{"type":"string","description":"Link to the merchant support page where client can go to from payment link (page with invoice data for payment)"},"externalId":{"type":"string","description":"Merchant ID that can be assigned to invoice or several invoices in string format"},"fiatAvailable":{"type":"boolean","description":"Attribute indicates the merchant's ability to process payments in fiat currency."}},"description":"Object with request parameters"}}}}
```

## The InvoicesWithPaginationRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"InvoicesWithPaginationRequestDTO":{"required":["pageNumber","pageSize","properties","sort","stateNames","typeNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the invoices to return","items":{"type":"string","description":"Statuses of the invoices to return","enum":["MEM_POOL_FOUND","PENDING_PAYMENT","PAID","COMPLETED","PENDING_INTERVENTION","CANCEL","ARCHIVED","DECLINED","PENDING_COMPLIANCE_CHECK","REVERSED"]}},"typeNames":{"type":"array","description":"Types of the invoices","items":{"type":"string","description":"Types of the invoices","enum":["SINGLE","SINGLE_FIAT","UNLIMITED","UNLIMITED_LINKED","BOUND"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request data for getting invoices by state and type"}}}}
```

## The WithAccountContainerInvoicesWithPaginationRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerInvoicesWithPaginationRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/InvoicesWithPaginationRequestDTO"}},"description":"Object with request data"},"InvoicesWithPaginationRequestDTO":{"required":["pageNumber","pageSize","properties","sort","stateNames","typeNames"],"type":"object","properties":{"stateNames":{"type":"array","description":"Statuses of the invoices to return","items":{"type":"string","description":"Statuses of the invoices to return","enum":["MEM_POOL_FOUND","PENDING_PAYMENT","PAID","COMPLETED","PENDING_INTERVENTION","CANCEL","ARCHIVED","DECLINED","PENDING_COMPLIANCE_CHECK","REVERSED"]}},"typeNames":{"type":"array","description":"Types of the invoices","items":{"type":"string","description":"Types of the invoices","enum":["SINGLE","SINGLE_FIAT","UNLIMITED","UNLIMITED_LINKED","BOUND"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request data for getting invoices by state and type"}}}}
```

## The UUIDKeyRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"UUIDKeyRequestDTO":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"id","format":"uuid"}},"description":"Object with request id and idempotencyKey parameters"}}}}
```

## The WithAccountContainerUUIDKeyRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerUUIDKeyRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/UUIDKeyRequestDTO"}},"description":"Object with request data"},"UUIDKeyRequestDTO":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"id","format":"uuid"}},"description":"Object with request id and idempotencyKey parameters"}}}}
```

## The OrderResponsePGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"OrderResponsePGDTO":{"required":["currency","fiatCurrency","id","state"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"cryptoAmount":{"type":"number"},"fiatAmount":{"type":"number"},"fiatCurrency":{"type":"string","description":"Тикер валюты"},"currency":{"type":"string","description":"Тикер валюты"},"state":{"type":"string","enum":["CREATED","IN_PROGRESS","WITHDRAWAL_COMPLETED","COMPLETED","FAILED","EXPIRED"]}}}}}}
```

## The PaymentMethodsRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentMethodsRequestPGDTO":{"required":["currency","geoId"],"type":"object","properties":{"itemId":{"type":"string","format":"uuid"},"geoId":{"type":"string","format":"uuid"},"cryptoAmount":{"type":"number"},"fiatAmount":{"type":"number"},"currency":{"type":"string","description":"Тикер валюты"}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerPaymentMethodsRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPaymentMethodsRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PaymentMethodsRequestPGDTO"}},"description":"Object with request data"},"PaymentMethodsRequestPGDTO":{"required":["currency","geoId"],"type":"object","properties":{"itemId":{"type":"string","format":"uuid"},"geoId":{"type":"string","format":"uuid"},"cryptoAmount":{"type":"number"},"fiatAmount":{"type":"number"},"currency":{"type":"string","description":"Тикер валюты"}},"description":"Object with request parameters"}}}}
```

## The PaymentMethodResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentMethodResponseDTO":{"required":["cryptoAmount","currency","fiatAmount","fiatCurrency","itemId","maxLimit","minLimit","withdrawalSettingsType"],"type":"object","properties":{"itemId":{"type":"string","format":"uuid"},"fiatAmount":{"type":"number"},"cryptoAmount":{"type":"number"},"withdrawalSettingsType":{"type":"string","enum":["CARD","SEPA","SWIFT"]},"currency":{"type":"string","description":"Тикер валюты"},"fiatCurrency":{"type":"string","description":"Тикер валюты"},"minLimit":{"type":"number"},"maxLimit":{"type":"number"}}}}}}
```

## The PaymentMethodsResponsePGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentMethodsResponsePGDTO":{"required":["fixedRateId","methods","rateExpiredDate"],"type":"object","properties":{"fixedRateId":{"type":"string","format":"uuid"},"rateExpiredDate":{"type":"string","format":"date-time"},"methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodResponseDTO"}}}},"PaymentMethodResponseDTO":{"required":["cryptoAmount","currency","fiatAmount","fiatCurrency","itemId","maxLimit","minLimit","withdrawalSettingsType"],"type":"object","properties":{"itemId":{"type":"string","format":"uuid"},"fiatAmount":{"type":"number"},"cryptoAmount":{"type":"number"},"withdrawalSettingsType":{"type":"string","enum":["CARD","SEPA","SWIFT"]},"currency":{"type":"string","description":"Тикер валюты"},"fiatCurrency":{"type":"string","description":"Тикер валюты"},"minLimit":{"type":"number"},"maxLimit":{"type":"number"}}}}}}
```

## The GeoListPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"GeoListPGDTO":{"required":["geo"],"type":"object","properties":{"geo":{"type":"array","items":{"$ref":"#/components/schemas/GeoResponseDTO"}}}},"GeoResponseDTO":{"required":["fiatCurrency","geoCode","geoId","geoName"],"type":"object","properties":{"geoId":{"type":"string","format":"uuid"},"geoName":{"type":"string"},"geoCode":{"type":"string"},"fiatCurrency":{"type":"string","description":"Тикер валюты"}}}}}}
```

## The GeoResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"GeoResponseDTO":{"required":["fiatCurrency","geoCode","geoId","geoName"],"type":"object","properties":{"geoId":{"type":"string","format":"uuid"},"geoName":{"type":"string"},"geoCode":{"type":"string"},"fiatCurrency":{"type":"string","description":"Тикер валюты"}}}}}}
```

## The CreateOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CreateOrderRequestPGDTO":{"required":["idempotencyKey","itemId","rateId"],"type":"object","properties":{"rateId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"cryptoAmount":{"type":"number"},"fiatAmount":{"type":"number"},"idempotencyKey":{"type":"string","format":"uuid"},"merchantExternalId":{"type":"string"}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerCreateOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerCreateOrderRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/CreateOrderRequestPGDTO"}},"description":"Object with request data"},"CreateOrderRequestPGDTO":{"required":["idempotencyKey","itemId","rateId"],"type":"object","properties":{"rateId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"cryptoAmount":{"type":"number"},"fiatAmount":{"type":"number"},"idempotencyKey":{"type":"string","format":"uuid"},"merchantExternalId":{"type":"string"}},"description":"Object with request parameters"}}}}
```

## The ConfirmSwiftOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ConfirmSwiftOrderRequestPGDTO":{"required":["accountNumber","bankSwift","card","orderId","requestParams"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"card":{"type":"string"},"accountNumber":{"type":"string"},"bankSwift":{"type":"string"}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerConfirmSwiftOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerConfirmSwiftOrderRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ConfirmSwiftOrderRequestPGDTO"}},"description":"Object with request data"},"ConfirmSwiftOrderRequestPGDTO":{"required":["accountNumber","bankSwift","card","orderId","requestParams"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"card":{"type":"string"},"accountNumber":{"type":"string"},"bankSwift":{"type":"string"}},"description":"Object with request parameters"}}}}
```

## The ConfirmSepaOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ConfirmSepaOrderRequestPGDTO":{"required":["accountEmail","accountName","accountNumber","orderId","requestParams"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"accountNumber":{"type":"string"},"accountName":{"type":"string"},"accountEmail":{"type":"string"}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerConfirmSepaOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerConfirmSepaOrderRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ConfirmSepaOrderRequestPGDTO"}},"description":"Object with request data"},"ConfirmSepaOrderRequestPGDTO":{"required":["accountEmail","accountName","accountNumber","orderId","requestParams"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"accountNumber":{"type":"string"},"accountName":{"type":"string"},"accountEmail":{"type":"string"}},"description":"Object with request parameters"}}}}
```

## The ConfirmCardOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ConfirmCardOrderRequestPGDTO":{"required":["card","orderId","requestParams"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"card":{"type":"string"}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerConfirmCardOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerConfirmCardOrderRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ConfirmCardOrderRequestPGDTO"}},"description":"Object with request data"},"ConfirmCardOrderRequestPGDTO":{"required":["card","orderId","requestParams"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"card":{"type":"string"}},"description":"Object with request parameters"}}}}
```

## The OrderDepositResponsePGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"OrderDepositResponsePGDTO":{"required":["currency","fiatCurrency","id","state"],"type":"object","properties":{"externalAddress":{"type":"string","description":"External address"},"id":{"type":"string","description":"Id","format":"uuid"},"cryptoAmount":{"type":"number","description":"Amount in crypto"},"fiatAmount":{"type":"number","description":"Amount in fiat"},"fiatCurrency":{"type":"string","description":"Fiat Currency"},"currency":{"type":"string","description":"Тикер валюты"},"state":{"type":"string","description":"State","enum":["CREATED","IN_PROGRESS","PAID","DEPOSIT_COMPLETED","EXTERNAL_WITHDRAWAL_IN_PROGRESS","PAUSED","COMPLETED","FAILED","EXPIRED"]},"hash":{"type":"string","description":"Hash"}},"description":"Order response"}}}}
```

## The PaymentMethodsDepositRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentMethodsDepositRequestPGDTO":{"required":["currency","external","fiatCurrency"],"type":"object","properties":{"itemId":{"type":"string","description":"Item id","format":"uuid"},"fiatCurrency":{"type":"string","description":"Fiat currency"},"cryptoAmount":{"type":"number","description":"Amount in crypto"},"fiatAmount":{"type":"number","description":"Amount in fiat"},"currency":{"type":"string","description":"Currency"},"external":{"type":"boolean","description":"External"}},"description":"Payment method request"}}}}
```

## The WithAccountContainerPaymentMethodsDepositRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPaymentMethodsDepositRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PaymentMethodsDepositRequestPGDTO"}},"description":"Object with request data"},"PaymentMethodsDepositRequestPGDTO":{"required":["currency","external","fiatCurrency"],"type":"object","properties":{"itemId":{"type":"string","description":"Item id","format":"uuid"},"fiatCurrency":{"type":"string","description":"Fiat currency"},"cryptoAmount":{"type":"number","description":"Amount in crypto"},"fiatAmount":{"type":"number","description":"Amount in fiat"},"currency":{"type":"string","description":"Currency"},"external":{"type":"boolean","description":"External"}},"description":"Payment method request"}}}}
```

## The PaymentMethodResponseDepositDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentMethodResponseDepositDTO":{"required":["cryptoAmount","currency","fiatAmount","fiatCurrency","itemId","maxLimit","minLimit","paymentMethodCode","paymentMethodName"],"type":"object","properties":{"itemId":{"type":"string","description":"Item id","format":"uuid"},"paymentMethodCode":{"type":"string","description":"Payment method code"},"paymentMethodName":{"type":"string","description":"Payment method name"},"fiatAmount":{"type":"number","description":"Amount in fiat"},"cryptoAmount":{"type":"number","description":"Amount in crypto"},"currency":{"type":"string","description":"Currency"},"fiatCurrency":{"type":"string","description":"Fiat currency"},"minLimit":{"type":"number","description":"Min limit in fiat"},"maxLimit":{"type":"number","description":"Max limit in fiat"}},"description":"Payment methods"}}}}
```

## The PaymentMethodsDepositResponsePGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PaymentMethodsDepositResponsePGDTO":{"required":["fixedRateId","methods","rateExpiredDate"],"type":"object","properties":{"fixedRateId":{"type":"string","description":"Rate id","format":"uuid"},"rateExpiredDate":{"type":"string","description":"Rate expired date","format":"date-time"},"methods":{"type":"array","description":"Payment methods","items":{"$ref":"#/components/schemas/PaymentMethodResponseDepositDTO"}}},"description":"Payment method response"},"PaymentMethodResponseDepositDTO":{"required":["cryptoAmount","currency","fiatAmount","fiatCurrency","itemId","maxLimit","minLimit","paymentMethodCode","paymentMethodName"],"type":"object","properties":{"itemId":{"type":"string","description":"Item id","format":"uuid"},"paymentMethodCode":{"type":"string","description":"Payment method code"},"paymentMethodName":{"type":"string","description":"Payment method name"},"fiatAmount":{"type":"number","description":"Amount in fiat"},"cryptoAmount":{"type":"number","description":"Amount in crypto"},"currency":{"type":"string","description":"Currency"},"fiatCurrency":{"type":"string","description":"Fiat currency"},"minLimit":{"type":"number","description":"Min limit in fiat"},"maxLimit":{"type":"number","description":"Max limit in fiat"}},"description":"Payment methods"}}}}
```

## The CurrencyDataDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CurrencyDataDTO":{"required":["currency"],"type":"object","properties":{"currency":{"type":"string","description":"Currency"},"amount":{"type":"number","description":"Fixed amount"},"externalAddress":{"type":"string","description":"External address"}},"description":"Currency data"}}}}
```

## The KeyDepositRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"KeyDepositRequestPGDTO":{"required":["currencyData","description","idempotencyKey","returnUrl"],"type":"object","properties":{"currencyData":{"type":"array","description":"Currency data","items":{"$ref":"#/components/schemas/CurrencyDataDTO"}},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Description"},"merchantExternalId":{"maxLength":255,"minLength":0,"type":"string","description":"Merchant external id"},"returnUrl":{"type":"string","description":"Merchant return url"},"idempotencyKey":{"type":"string","description":"Idempotency Key","format":"uuid"}},"description":"Request body for generating widget key for deposit"},"CurrencyDataDTO":{"required":["currency"],"type":"object","properties":{"currency":{"type":"string","description":"Currency"},"amount":{"type":"number","description":"Fixed amount"},"externalAddress":{"type":"string","description":"External address"}},"description":"Currency data"}}}}
```

## The WithAccountContainerKeyDepositRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerKeyDepositRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/KeyDepositRequestPGDTO"}},"description":"Object with request data"},"KeyDepositRequestPGDTO":{"required":["currencyData","description","idempotencyKey","returnUrl"],"type":"object","properties":{"currencyData":{"type":"array","description":"Currency data","items":{"$ref":"#/components/schemas/CurrencyDataDTO"}},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Description"},"merchantExternalId":{"maxLength":255,"minLength":0,"type":"string","description":"Merchant external id"},"returnUrl":{"type":"string","description":"Merchant return url"},"idempotencyKey":{"type":"string","description":"Idempotency Key","format":"uuid"}},"description":"Request body for generating widget key for deposit"},"CurrencyDataDTO":{"required":["currency"],"type":"object","properties":{"currency":{"type":"string","description":"Currency"},"amount":{"type":"number","description":"Fixed amount"},"externalAddress":{"type":"string","description":"External address"}},"description":"Currency data"}}}}
```

## The KeyDepositPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"KeyDepositPGDTO":{"required":["expiredAt","key"],"type":"object","properties":{"key":{"type":"string","description":"Access key","format":"uuid"},"expiredAt":{"type":"string","description":"Access key expired date","format":"date-time"}},"description":"Access key response"}}}}
```

## The FiatCurrencyListDepositPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FiatCurrencyListDepositPGDTO":{"required":["fiatCurrencies"],"type":"object","properties":{"fiatCurrencies":{"type":"array","description":"List of available fiat currencies","items":{"$ref":"#/components/schemas/FiatCurrency"}}},"description":"FiatCurrency  list response"},"FiatCurrency":{"type":"string"}}}}
```

## The CreateOnrampDepositOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CreateOnrampDepositOrderRequestPGDTO":{"required":["description","idempotencyKey","itemId","rateId","returnUrl"],"type":"object","properties":{"rateId":{"type":"string","description":"Rate Id","format":"uuid"},"itemId":{"type":"string","description":"Item Id","format":"uuid"},"cryptoAmount":{"type":"number","description":"Amount in crypto"},"fiatAmount":{"type":"number","description":"Amount in fiat"},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Description"},"merchantExternalId":{"maxLength":255,"minLength":0,"type":"string","description":"Merchant external id"},"returnUrl":{"type":"string","description":"Merchant return url"},"idempotencyKey":{"type":"string","description":"Idempotency Key","format":"uuid"},"externalAddress":{"type":"string","description":"External address"}},"description":"Create order request"}}}}
```

## The WithAccountContainerCreateOnrampDepositOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerCreateOnrampDepositOrderRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/CreateOnrampDepositOrderRequestPGDTO"}},"description":"Object with request data"},"CreateOnrampDepositOrderRequestPGDTO":{"required":["description","idempotencyKey","itemId","rateId","returnUrl"],"type":"object","properties":{"rateId":{"type":"string","description":"Rate Id","format":"uuid"},"itemId":{"type":"string","description":"Item Id","format":"uuid"},"cryptoAmount":{"type":"number","description":"Amount in crypto"},"fiatAmount":{"type":"number","description":"Amount in fiat"},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Description"},"merchantExternalId":{"maxLength":255,"minLength":0,"type":"string","description":"Merchant external id"},"returnUrl":{"type":"string","description":"Merchant return url"},"idempotencyKey":{"type":"string","description":"Idempotency Key","format":"uuid"},"externalAddress":{"type":"string","description":"External address"}},"description":"Create order request"}}}}
```

## The ConfirmDepositOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ConfirmDepositOrderRequestPGDTO":{"required":["id","requestParams"],"type":"object","properties":{"id":{"type":"string","description":"Order ID","format":"uuid"},"requestParams":{"type":"object","additionalProperties":{"type":"object","description":"Additional data"},"description":"Additional data"}},"description":"Confirm order request"}}}}
```

## The WithAccountContainerConfirmDepositOrderRequestPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerConfirmDepositOrderRequestPGDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ConfirmDepositOrderRequestPGDTO"}},"description":"Object with request data"},"ConfirmDepositOrderRequestPGDTO":{"required":["id","requestParams"],"type":"object","properties":{"id":{"type":"string","description":"Order ID","format":"uuid"},"requestParams":{"type":"object","additionalProperties":{"type":"object","description":"Additional data"},"description":"Additional data"}},"description":"Confirm order request"}}}}
```

## The RedirectUrlDepositPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"RedirectUrlDepositPGDTO":{"required":["redirectUrl"],"type":"object","properties":{"redirectUrl":{"type":"string","description":"Redirect URL"}},"description":"Redirect URL response"}}}}
```

## The PreCalculateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PreCalculateRequestDTO":{"required":["amount","destinationCurrency","direction","sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Source currency"},"destinationCurrency":{"type":"string","description":"Destination currency"},"amount":{"type":"number","description":"Exchange amount"},"direction":{"type":"string","description":"Exchange direction","default":"SOURCE","enum":["SOURCE","DESTINATION"]}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerPreCalculateRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPreCalculateRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PreCalculateRequestDTO"}},"description":"Object with request data"},"PreCalculateRequestDTO":{"required":["amount","destinationCurrency","direction","sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Source currency"},"destinationCurrency":{"type":"string","description":"Destination currency"},"amount":{"type":"number","description":"Exchange amount"},"direction":{"type":"string","description":"Exchange direction","default":"SOURCE","enum":["SOURCE","DESTINATION"]}},"description":"Object with request parameters"}}}}
```

## The PreCalculateExchangeResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PreCalculateExchangeResponseDTO":{"required":["amount","destinationCurrency","direction","sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Source currency"},"destinationCurrency":{"type":"string","description":"Destination currency"},"amount":{"type":"number","description":"Destination amount"},"direction":{"type":"string","description":"Exchange direction","enum":["SOURCE","DESTINATION"]}},"description":"Response to pre-calculate exchange"}}}}
```

## The CurrencyPairDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CurrencyPairDTO":{"required":["currencyPairs"],"type":"object","properties":{"currencyPairs":{"type":"object","additionalProperties":{"type":"array","description":"currency pairs map","items":{"$ref":"#/components/schemas/Currency"}},"description":"currency pairs map"}},"description":"Currency pairs"},"Currency":{"type":"string"}}}}
```

## The SourceDestinationCurrencyDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"SourceDestinationCurrencyDTO":{"required":["destinationCurrency","sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Source currency"},"destinationCurrency":{"type":"string","description":"Destination currency"}},"description":"Source and destination currency"}}}}
```

## The WithAccountContainerSourceDestinationCurrencyDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerSourceDestinationCurrencyDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/SourceDestinationCurrencyDTO"}},"description":"Object with request data"},"SourceDestinationCurrencyDTO":{"required":["destinationCurrency","sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Source currency"},"destinationCurrency":{"type":"string","description":"Destination currency"}},"description":"Source and destination currency"}}}}
```

## The ExchangeLimitResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ExchangeLimitResponseDTO":{"required":["destinationCurrency","maxLimit","minLimit","sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Exchange currency"},"destinationCurrency":{"$ref":"#/components/schemas/Currency"},"minLimit":{"type":"number","description":"Minimum amount"},"maxLimit":{"type":"number","description":"Maximum amount"}},"description":"Exchange limit by currency"},"Currency":{"type":"string"}}}}
```

## The IdDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"IdDTO":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","format":"int64"}},"description":"Object with request parameters"}}}}
```

## The WithAccountContainerIdDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerIdDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/IdDTO"}},"description":"Object with request data"},"IdDTO":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","format":"int64"}},"description":"Object with request parameters"}}}}
```

## The ExchangeDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ExchangeDTO":{"required":["account","createdDate","destinationCurrency","id","sourceAmount","sourceCurrency","state"],"type":"object","properties":{"id":{"type":"integer","description":"Exchange id","format":"int64"},"account":{"type":"string","description":"Account"},"sourceCurrency":{"type":"string","description":"Source currency"},"sourceAmount":{"type":"number","description":"Source amount"},"destinationCurrency":{"type":"string","description":"Destination currency"},"destinationAmount":{"type":"number","description":"Destination amount"},"state":{"type":"string","description":"Exchange state","enum":["IN_PROGRESS","COMPLETED","FAILED"]},"createdDate":{"type":"string","description":"Exchange creation date","format":"date-time"}},"description":"Exchange"}}}}
```

## The CreatedDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CreatedDTO":{"required":["period"],"type":"object","properties":{"period":{"$ref":"#/components/schemas/PeriodDTO"},"date":{"type":"string","description":"Дата","format":"date-time"}},"description":"Фильтр даты создания"},"PeriodDTO":{"required":["firstDate","secondDate"],"type":"object","properties":{"firstDate":{"type":"string","description":"С даты","format":"date-time"},"secondDate":{"type":"string","description":"По дату","format":"date-time"}},"description":"Фильтр даты"}}}}
```

## The ExchangeFilterDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ExchangeFilterDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"createdDate":{"$ref":"#/components/schemas/CreatedDTO"},"state":{"type":"array","description":"States","items":{"type":"string","description":"States","enum":["IN_PROGRESS","COMPLETED","FAILED"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Find exchanges by filter"},"CreatedDTO":{"required":["period"],"type":"object","properties":{"period":{"$ref":"#/components/schemas/PeriodDTO"},"date":{"type":"string","description":"Дата","format":"date-time"}},"description":"Фильтр даты создания"},"PeriodDTO":{"required":["firstDate","secondDate"],"type":"object","properties":{"firstDate":{"type":"string","description":"С даты","format":"date-time"},"secondDate":{"type":"string","description":"По дату","format":"date-time"}},"description":"Фильтр даты"}}}}
```

## The PeriodDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PeriodDTO":{"required":["firstDate","secondDate"],"type":"object","properties":{"firstDate":{"type":"string","description":"С даты","format":"date-time"},"secondDate":{"type":"string","description":"По дату","format":"date-time"}},"description":"Фильтр даты"}}}}
```

## The WithAccountContainerExchangeFilterDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerExchangeFilterDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ExchangeFilterDTO"}},"description":"Object with request data"},"ExchangeFilterDTO":{"required":["pageNumber","pageSize","properties","sort"],"type":"object","properties":{"createdDate":{"$ref":"#/components/schemas/CreatedDTO"},"state":{"type":"array","description":"States","items":{"type":"string","description":"States","enum":["IN_PROGRESS","COMPLETED","FAILED"]}},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Find exchanges by filter"},"CreatedDTO":{"required":["period"],"type":"object","properties":{"period":{"$ref":"#/components/schemas/PeriodDTO"},"date":{"type":"string","description":"Дата","format":"date-time"}},"description":"Фильтр даты создания"},"PeriodDTO":{"required":["firstDate","secondDate"],"type":"object","properties":{"firstDate":{"type":"string","description":"С даты","format":"date-time"},"secondDate":{"type":"string","description":"По дату","format":"date-time"}},"description":"Фильтр даты"}}}}
```

## The PageDTOExchangeDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOExchangeDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/ExchangeDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"ExchangeDTO":{"required":["account","createdDate","destinationCurrency","id","sourceAmount","sourceCurrency","state"],"type":"object","properties":{"id":{"type":"integer","description":"Exchange id","format":"int64"},"account":{"type":"string","description":"Account"},"sourceCurrency":{"type":"string","description":"Source currency"},"sourceAmount":{"type":"number","description":"Source amount"},"destinationCurrency":{"type":"string","description":"Destination currency"},"destinationAmount":{"type":"number","description":"Destination amount"},"state":{"type":"string","description":"Exchange state","enum":["IN_PROGRESS","COMPLETED","FAILED"]},"createdDate":{"type":"string","description":"Exchange creation date","format":"date-time"}},"description":"Exchange"}}}}
```

## The ExchangeRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ExchangeRequestDTO":{"required":["amount","destinationCurrency","direction","idempotencyKey","sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Source currency"},"destinationCurrency":{"type":"string","description":"Destination currency"},"amount":{"type":"number","description":"Exchange amount"},"direction":{"type":"string","description":"Exchange direction","default":"SOURCE","enum":["SOURCE","DESTINATION"]},"idempotencyKey":{"type":"string","description":"Idempotency key","format":"uuid"}},"description":"Request for exchange"}}}}
```

## The WithAccountContainerExchangeRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerExchangeRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ExchangeRequestDTO"}},"description":"Object with request data"},"ExchangeRequestDTO":{"required":["amount","destinationCurrency","direction","idempotencyKey","sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"type":"string","description":"Source currency"},"destinationCurrency":{"type":"string","description":"Destination currency"},"amount":{"type":"number","description":"Exchange amount"},"direction":{"type":"string","description":"Exchange direction","default":"SOURCE","enum":["SOURCE","DESTINATION"]},"idempotencyKey":{"type":"string","description":"Idempotency key","format":"uuid"}},"description":"Request for exchange"}}}}
```

## The AverageRateDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"AverageRateDTO":{"required":["rate"],"type":"object","properties":{"rate":{"type":"number","description":"Rate"}},"description":"Average rate"}}}}
```

## The ByTransactionIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByTransactionIdRequestDTO":{"required":["transactionId"],"type":"object","properties":{"transactionId":{"type":"string","description":"Transaction ID","format":"uuid"}},"description":"Object with Transaction ID parameter"}}}}
```

## The WithAccountContainerByTransactionIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByTransactionIdRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByTransactionIdRequestDTO"}},"description":"Object with request data"},"ByTransactionIdRequestDTO":{"required":["transactionId"],"type":"object","properties":{"transactionId":{"type":"string","description":"Transaction ID","format":"uuid"}},"description":"Object with Transaction ID parameter"}}}}
```

## The PGTransactionDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGTransactionDTO":{"required":["addressFrom","amount","complianceState","createdDate","currency","id","transactionState","translationToAccountCompleted"],"type":"object","properties":{"id":{"type":"string","description":"Transaction ID","format":"uuid"},"amount":{"type":"number","description":"Amount"},"addressFrom":{"type":"string","description":"Address from"},"currency":{"type":"string","description":"Currency"},"transactionHash":{"type":"string","description":"Hash"},"transactionState":{"type":"string","description":"Transaction State","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]},"complianceState":{"type":"string","description":"Compliance State","enum":["UNCHECKED","IN_PROGRESS","DECLINE","CHECKED"]},"translationToAccountCompleted":{"type":"boolean","description":"Translation to account completed"},"createdDate":{"type":"string","description":"Date","format":"date-time"}},"description":"Transaction data"}}}}
```

## The FilterPurseTransactionState object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FilterPurseTransactionState":{"type":"object","properties":{"equals":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]},"notEquals":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]},"specified":{"type":"boolean"},"in":{"type":"array","items":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]}},"notIn":{"type":"array","items":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]}}},"description":"Transaction State Filter"}}}}
```

## The PGTransactionSearchDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGTransactionSearchDTO":{"required":["customerId","pageNumber","pageSize","properties","sort"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID","format":"uuid"},"currencyFilter":{"$ref":"#/components/schemas/StringFilter"},"transactionStateFilter":{"$ref":"#/components/schemas/FilterPurseTransactionState"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request data to find customer transactions"},"StringFilter":{"type":"object","properties":{"equals":{"type":"string"},"notEquals":{"type":"string"},"specified":{"type":"boolean"},"in":{"type":"array","items":{"type":"string"}},"notIn":{"type":"array","items":{"type":"string"}},"contains":{"type":"string"},"doesNotContain":{"type":"string"}},"description":"Currency Filter"},"FilterPurseTransactionState":{"type":"object","properties":{"equals":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]},"notEquals":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]},"specified":{"type":"boolean"},"in":{"type":"array","items":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]}},"notIn":{"type":"array","items":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]}}},"description":"Transaction State Filter"}}}}
```

## The StringFilter object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"StringFilter":{"type":"object","properties":{"equals":{"type":"string"},"notEquals":{"type":"string"},"specified":{"type":"boolean"},"in":{"type":"array","items":{"type":"string"}},"notIn":{"type":"array","items":{"type":"string"}},"contains":{"type":"string"},"doesNotContain":{"type":"string"}},"description":"Currency Filter"}}}}
```

## The WithAccountContainerPGTransactionSearchDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGTransactionSearchDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGTransactionSearchDTO"}},"description":"Object with request data"},"PGTransactionSearchDTO":{"required":["customerId","pageNumber","pageSize","properties","sort"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID","format":"uuid"},"currencyFilter":{"$ref":"#/components/schemas/StringFilter"},"transactionStateFilter":{"$ref":"#/components/schemas/FilterPurseTransactionState"},"pageNumber":{"type":"integer","description":"Numeric value indicating the page number","format":"int32","default":1},"pageSize":{"type":"integer","description":"Numeric value indicating the page size","format":"int32","default":10},"sort":{"type":"string","description":"Direction of result values which can be asc or desc","default":"ASC","enum":["ASC","DESC"]},"properties":{"type":"string","description":"Attribute by which sorting is performed. Accept the parameter name by which sorting is needed"}},"description":"Request data to find customer transactions"},"StringFilter":{"type":"object","properties":{"equals":{"type":"string"},"notEquals":{"type":"string"},"specified":{"type":"boolean"},"in":{"type":"array","items":{"type":"string"}},"notIn":{"type":"array","items":{"type":"string"}},"contains":{"type":"string"},"doesNotContain":{"type":"string"}},"description":"Currency Filter"},"FilterPurseTransactionState":{"type":"object","properties":{"equals":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]},"notEquals":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]},"specified":{"type":"boolean"},"in":{"type":"array","items":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]}},"notIn":{"type":"array","items":{"type":"string","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]}}},"description":"Transaction State Filter"}}}}
```

## The PageDTOPGTransactionDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PageDTOPGTransactionDTO":{"required":["page","result","size","total","totalElements"],"type":"object","properties":{"result":{"type":"array","description":"Array of requested objects","items":{"$ref":"#/components/schemas/PGTransactionDTO"}},"page":{"type":"integer","description":"Numeric value indicating the page number","format":"int32"},"size":{"type":"integer","description":"Numeric value indicating the page size","format":"int32"},"total":{"type":"integer","description":"Total number of pages matching the query","format":"int32"},"totalElements":{"type":"integer","description":"Total number of objects matching the query","format":"int64"}},"description":"Object with page details"},"PGTransactionDTO":{"required":["addressFrom","amount","complianceState","createdDate","currency","id","transactionState","translationToAccountCompleted"],"type":"object","properties":{"id":{"type":"string","description":"Transaction ID","format":"uuid"},"amount":{"type":"number","description":"Amount"},"addressFrom":{"type":"string","description":"Address from"},"currency":{"type":"string","description":"Currency"},"transactionHash":{"type":"string","description":"Hash"},"transactionState":{"type":"string","description":"Transaction State","enum":["MEM_POOL_FOUND","CONFIRMED","PENDING_COMPLIANCE_CHECK","DECLINED"]},"complianceState":{"type":"string","description":"Compliance State","enum":["UNCHECKED","IN_PROGRESS","DECLINE","CHECKED"]},"translationToAccountCompleted":{"type":"boolean","description":"Translation to account completed"},"createdDate":{"type":"string","description":"Date","format":"date-time"}},"description":"Transaction data"}}}}
```

## The ByCustomerIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByCustomerIdRequestDTO":{"required":["customerId"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID","format":"uuid"}},"description":"Object with Customer ID parameter"}}}}
```

## The WithAccountContainerByCustomerIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByCustomerIdRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByCustomerIdRequestDTO"}},"description":"Object with request data"},"ByCustomerIdRequestDTO":{"required":["customerId"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID","format":"uuid"}},"description":"Object with Customer ID parameter"}}}}
```

## The PGPurseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGPurseDTO":{"required":["address","createdDate","currencies","id"],"type":"object","properties":{"id":{"type":"string","description":"Purse ID","format":"uuid"},"address":{"type":"string","description":"Address"},"currencies":{"uniqueItems":true,"type":"array","description":"Available Currencies","items":{"type":"string","description":"Available Currencies"}},"createdDate":{"type":"string","description":"Created Date","format":"date-time"}},"description":"Purse data"}}}}
```

## The PGPursesDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGPursesDTO":{"required":["purses"],"type":"object","properties":{"purses":{"type":"array","description":"Purses","items":{"$ref":"#/components/schemas/PGPurseDTO"}}}},"PGPurseDTO":{"required":["address","createdDate","currencies","id"],"type":"object","properties":{"id":{"type":"string","description":"Purse ID","format":"uuid"},"address":{"type":"string","description":"Address"},"currencies":{"uniqueItems":true,"type":"array","description":"Available Currencies","items":{"type":"string","description":"Available Currencies"}},"createdDate":{"type":"string","description":"Created Date","format":"date-time"}},"description":"Purse data"}}}}
```

## The PGCustomerUpdateDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGCustomerUpdateDTO":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"ID","format":"uuid"},"email":{"type":"string","description":"Email"},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Description"}},"description":"Request data for changing Customer data"}}}}
```

## The WithAccountContainerPGCustomerUpdateDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGCustomerUpdateDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGCustomerUpdateDTO"}},"description":"Object with request data"},"PGCustomerUpdateDTO":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"ID","format":"uuid"},"email":{"type":"string","description":"Email"},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Description"}},"description":"Request data for changing Customer data"}}}}
```

## The PGCustomerDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGCustomerDTO":{"required":["blocked","id"],"type":"object","properties":{"id":{"type":"string","description":"ID","format":"uuid"},"email":{"type":"string","description":"Email"},"description":{"type":"string","description":"Description"},"externalId":{"type":"string","description":"External Id"},"blocked":{"type":"boolean","description":"The blocking flag"}},"description":"Customer data"}}}}
```

## The ByExternalIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ByExternalIdRequestDTO":{"required":["externalId"],"type":"object","properties":{"externalId":{"type":"string","description":"External ID"}},"description":"Object with external id parameter"}}}}
```

## The WithAccountContainerByExternalIdRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerByExternalIdRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByExternalIdRequestDTO"}},"description":"Object with request data"},"ByExternalIdRequestDTO":{"required":["externalId"],"type":"object","properties":{"externalId":{"type":"string","description":"External ID"}},"description":"Object with external id parameter"}}}}
```

## The PGCustomerListDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGCustomerListDTO":{"required":["customers"],"type":"object","properties":{"customers":{"type":"array","items":{"$ref":"#/components/schemas/PGCustomerDTO"}}}},"PGCustomerDTO":{"required":["blocked","id"],"type":"object","properties":{"id":{"type":"string","description":"ID","format":"uuid"},"email":{"type":"string","description":"Email"},"description":{"type":"string","description":"Description"},"externalId":{"type":"string","description":"External Id"},"blocked":{"type":"boolean","description":"The blocking flag"}},"description":"Customer data"}}}}
```

## The PGCustomerCreateDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"PGCustomerCreateDTO":{"type":"object","properties":{"email":{"type":"string","description":"Email"},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Description"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"External Id"}},"description":"Request data for creating a new Customer"}}}}
```

## The WithAccountContainerPGCustomerCreateDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerPGCustomerCreateDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/PGCustomerCreateDTO"}},"description":"Object with request data"},"PGCustomerCreateDTO":{"type":"object","properties":{"email":{"type":"string","description":"Email"},"description":{"maxLength":1000,"minLength":0,"type":"string","description":"Description"},"externalId":{"maxLength":255,"minLength":0,"type":"string","description":"External Id"}},"description":"Request data for creating a new Customer"}}}}
```

## The GetPurseAddressRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"GetPurseAddressRequestDTO":{"required":["currency","customerId"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID","format":"uuid"},"currency":{"type":"string","description":"Currency Ticker"}},"description":"Object with Customer ID and Currency parameters"}}}}
```

## The WithAccountContainerGetPurseAddressRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"WithAccountContainerGetPurseAddressRequestDTO":{"required":["account","payload","timestamp"],"type":"object","properties":{"account":{"pattern":"^0x[0-9a-fA-F]{40}$","type":"string","description":"Merchant account ID. Request will be sent for this account"},"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/GetPurseAddressRequestDTO"}},"description":"Object with request data"},"GetPurseAddressRequestDTO":{"required":["currency","customerId"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID","format":"uuid"},"currency":{"type":"string","description":"Currency Ticker"}},"description":"Object with Customer ID and Currency parameters"}}}}
```

## The CurrenciesResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CurrenciesResponseDTO":{"required":["cryptoCurrencies","fiatCurrencies"],"type":"object","properties":{"fiatCurrencies":{"type":"array","description":"List of available fiat currencies","items":{"type":"string"}},"cryptoCurrencies":{"type":"array","description":"List of available crypto currencies","items":{"type":"string"}}},"description":"Response with available currencies"}}}}
```

## The FiatCurrencyMetadataDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FiatCurrencyMetadataDTO":{"required":["active","currency","name"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/FiatCurrency"},"name":{"type":"string"},"round":{"type":"integer","format":"int32"},"active":{"type":"boolean"}}},"FiatCurrency":{"type":"string"}}}}
```

## The FiatCurrencyMetadataListPGDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"FiatCurrencyMetadataListPGDTO":{"required":["result"],"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/FiatCurrencyMetadataDTO"}}}},"FiatCurrencyMetadataDTO":{"required":["active","currency","name"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/FiatCurrency"},"name":{"type":"string"},"round":{"type":"integer","format":"int32"},"active":{"type":"boolean"}}},"FiatCurrency":{"type":"string"}}}}
```

## The CryptoCurrenciesFullInfoResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CryptoCurrenciesFullInfoResponseDTO":{"required":["cryptoCurrencies"],"type":"object","properties":{"cryptoCurrencies":{"type":"array","description":"List of available crypto currencies full info","items":{"$ref":"#/components/schemas/CryptoCurrencyFullInfoDTO"}}},"description":"Response with available crypto currencies full info"},"CryptoCurrencyFullInfoDTO":{"required":["baseCurrency","blockchainScale","currency","name","network","recommendedDisplayScale","token"],"type":"object","properties":{"currency":{"type":"string","description":"Crypto currency ticker"},"baseCurrency":{"type":"string","description":"Base crypto currency ticker"},"name":{"type":"string","description":"Crypto currency name"},"token":{"type":"boolean","description":"Crypto currency is token or not"},"network":{"type":"string","description":"Crypto currency network"},"recommendedDisplayScale":{"type":"integer","description":"Recommended scale for display for this cryptocurrency","format":"int32"},"blockchainScale":{"type":"integer","description":"The scale used for the blockchain of this cryptocurrency","format":"int32"}},"description":"Crypto currency full info"}}}}
```

## The CryptoCurrencyFullInfoDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"CryptoCurrencyFullInfoDTO":{"required":["baseCurrency","blockchainScale","currency","name","network","recommendedDisplayScale","token"],"type":"object","properties":{"currency":{"type":"string","description":"Crypto currency ticker"},"baseCurrency":{"type":"string","description":"Base crypto currency ticker"},"name":{"type":"string","description":"Crypto currency name"},"token":{"type":"boolean","description":"Crypto currency is token or not"},"network":{"type":"string","description":"Crypto currency network"},"recommendedDisplayScale":{"type":"integer","description":"Recommended scale for display for this cryptocurrency","format":"int32"},"blockchainScale":{"type":"integer","description":"The scale used for the blockchain of this cryptocurrency","format":"int32"}},"description":"Crypto currency full info"}}}}
```

## The AccountResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"AccountResponseDTO":{"required":["account","balances","ownerId"],"type":"object","properties":{"account":{"type":"string","description":"Merchant account ID"},"name":{"type":"string","description":"Name of the account"},"ownerId":{"type":"string","description":"Company ID of the account","format":"uuid"},"balances":{"type":"array","description":"Balances of the account","items":{"$ref":"#/components/schemas/BalanceResponseDTO"}}},"description":"Object with account data"},"BalanceResponseDTO":{"required":["amount","currency"],"type":"object","properties":{"currency":{"type":"string","description":"Currency of the balance"},"amount":{"type":"number","description":"Balance amount"}},"description":"Object with balance data"}}}}
```

## The BalanceResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"BalanceResponseDTO":{"required":["amount","currency"],"type":"object","properties":{"currency":{"type":"string","description":"Currency of the balance"},"amount":{"type":"number","description":"Balance amount"}},"description":"Object with balance data"}}}}
```

## The ContainerByUuidRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"Public API","version":"dev"},"components":{"schemas":{"ContainerByUuidRequestDTO":{"required":["payload","timestamp"],"type":"object","properties":{"timestamp":{"type":"integer","description":"Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future","format":"int64"},"payload":{"$ref":"#/components/schemas/ByUuidRequestDTO"}},"description":"Object with request data"},"ByUuidRequestDTO":{"required":["requestId"],"type":"object","properties":{"requestId":{"type":"string","description":"The external id of the webhook subscription","format":"uuid"}},"description":"Object with request id parameter"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.calypso.money/api-reference/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.