diff --git a/.gitignore b/.gitignore index 880fbe8..a132833 100644 --- a/.gitignore +++ b/.gitignore @@ -33,8 +33,8 @@ node_modules # Optional REPL history .node_repl_history -# CI -.wercker - # Frontend -/lib \ No newline at end of file +/lib + +# Other +.DS_Store \ No newline at end of file diff --git a/api/payres/spec/definitions/AuthData.yaml b/api/payres/spec/definitions/AuthData.yaml index 37837d6..5233506 100644 --- a/api/payres/spec/definitions/AuthData.yaml +++ b/api/payres/spec/definitions/AuthData.yaml @@ -1,7 +1,8 @@ +--- type: object properties: authData: - description: Данные для авторизации платежа по карте + description: Data for card withdrawal authorization type: string minLength: 1 maxLength: 1000 diff --git a/api/payres/spec/definitions/BankCard.yaml b/api/payres/spec/definitions/BankCard.yaml index ac7f616..2ded515 100644 --- a/api/payres/spec/definitions/BankCard.yaml +++ b/api/payres/spec/definitions/BankCard.yaml @@ -1,31 +1,33 @@ -description: Данные банковской карты +--- +description: Bank card details type: object required: - cardNumber properties: type: - description: Банковская карта + description: Card type: string - enum: [BankCard] + enum: + - BankCard cardNumber: - description: Номер банковской карты + description: Card number type: string pattern: '^\d{12,19}$' example: "4242424242424242" expDate: - description: Срок действия банковской карты + description: Сard expiration date type: string pattern: '^\d{2}\/(\d{2}|\d{4})$' example: "12/21" cardHolder: - description: Имя держателя карты + description: Cardholder name type: string - pattern: '^[[:alpha:][:space:][:punct:]]+$' + pattern: "^[[:alpha:][:space:][:punct:]]+$" minLength: 1 maxLength: 100 - example: "LEXA SVOTIN" + example: "LEEROY JENKINS" cvv: - description: Код верификации + description: Verification code type: string pattern: '^\d{3,4}$' example: "321" diff --git a/api/payres/spec/definitions/BankCardPaymentSystem.yaml b/api/payres/spec/definitions/BankCardPaymentSystem.yaml index 383f5d9..9217ea6 100644 --- a/api/payres/spec/definitions/BankCardPaymentSystem.yaml +++ b/api/payres/spec/definitions/BankCardPaymentSystem.yaml @@ -1,14 +1,6 @@ +--- description: | - Платежная система. + Payment system. - Набор систем, доступных для проведения выплат, можно узнать, вызвав соответствующую [операцию](#operation/getWithdrawalMethods). + The set of systems available for making withdrawals can be found by calling the corresponding [operation](#operation/getWithdrawalMethods). type: string -# enum: -# - visa -# - mastercard -# - amex -# - dinersclub -# - discover -# - unionpay -# - jcb -# - nspkmir diff --git a/api/payres/spec/definitions/SecuredBankCard.yaml b/api/payres/spec/definitions/SecuredBankCard.yaml index 52fc9a0..9b01360 100644 --- a/api/payres/spec/definitions/SecuredBankCard.yaml +++ b/api/payres/spec/definitions/SecuredBankCard.yaml @@ -1,17 +1,18 @@ -description: Безопасные данные банковской карты +--- +description: Secure bank card details type: object required: - token properties: token: - description: Токен, идентифицирующий исходные данные карты + description: Token identifying the original card data type: string minLength: 1 maxLength: 1000 example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQg9xMkh bin: description: | - [Идентификационный номер][1] банка-эмитента карты + [Identification number][1] of the card issuing bank [1]: https://en.wikipedia.org/wiki/Payment_card_number#Issuer_identification_number_(IIN) type: string @@ -19,7 +20,7 @@ properties: example: "424242" readOnly: true lastDigits: - description: Последние цифры номера карты + description: Card last digits type: string pattern: '^\d{2,4}$' example: "4242" diff --git a/api/payres/spec/definitions/StoreBankCardResponse.yaml b/api/payres/spec/definitions/StoreBankCardResponse.yaml index fbca88e..b4555e5 100644 --- a/api/payres/spec/definitions/StoreBankCardResponse.yaml +++ b/api/payres/spec/definitions/StoreBankCardResponse.yaml @@ -1,4 +1,5 @@ +--- type: object allOf: - - $ref: '#/definitions/SecuredBankCard' - - $ref: '#/definitions/AuthData' + - $ref: "#/definitions/SecuredBankCard" + - $ref: "#/definitions/AuthData" diff --git a/api/payres/spec/definitions/ValidUntil.yaml b/api/payres/spec/definitions/ValidUntil.yaml index 987af97..056bdfa 100644 --- a/api/payres/spec/definitions/ValidUntil.yaml +++ b/api/payres/spec/definitions/ValidUntil.yaml @@ -1,7 +1,8 @@ +--- type: object properties: validUntil: - description: Дата и время, до наступления которых токен платёжного ресурса остается действительным + description: The date and time by which the withdrawal resource token remains valid type: string format: date-time readOnly: true diff --git a/api/payres/spec/definitions/errors/InvalidBankCard.yaml b/api/payres/spec/definitions/errors/InvalidBankCard.yaml index d4adc11..062b46f 100644 --- a/api/payres/spec/definitions/errors/InvalidBankCard.yaml +++ b/api/payres/spec/definitions/errors/InvalidBankCard.yaml @@ -1,3 +1,4 @@ +--- type: object properties: message: diff --git a/api/payres/spec/paths/bank-cards.yaml b/api/payres/spec/paths/bank-cards.yaml index 1ec474a..c4957fa 100644 --- a/api/payres/spec/paths/bank-cards.yaml +++ b/api/payres/spec/paths/bank-cards.yaml @@ -1,26 +1,27 @@ +--- post: operationId: storeBankCard - summary: Сохранить банковскую карту + summary: Save card tags: - - Payment Resources + - Withdrawal Resources parameters: - - $ref: '#/parameters/requestID' + - $ref: "#/parameters/requestID" - name: bankCard - description: Данные банковской карты + description: Сard details in: body required: true schema: - $ref: '#/definitions/BankCard' + $ref: "#/definitions/BankCard" responses: - '201': - description: Карта сохранена + "201": + description: Card saved schema: - $ref: '#/definitions/StoreBankCardResponse' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '422': - description: Непригодные данные банковской карты + $ref: "#/definitions/StoreBankCardResponse" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "422": + description: Invalid сard details schema: - $ref: '#/definitions/InvalidBankCard' + $ref: "#/definitions/InvalidBankCard" diff --git a/api/payres/spec/paths/bank-cards@{token}.yaml b/api/payres/spec/paths/bank-cards@{token}.yaml index d93d643..fdfd18a 100644 --- a/api/payres/spec/paths/bank-cards@{token}.yaml +++ b/api/payres/spec/paths/bank-cards@{token}.yaml @@ -1,25 +1,26 @@ +--- get: operationId: getBankCard - summary: Получить данные банковской карты + summary: Receive bank card details tags: - - Payment Resources + - Withdrawal Resources parameters: - - $ref: '#/parameters/requestID' + - $ref: "#/parameters/requestID" - name: token - description: Данные банковской карты + description: Bank card details in: path required: true type: string minLength: 1 maxLength: 1000 responses: - '200': - description: Данные карты найдены + "200": + description: Card data found schema: - $ref: '#/definitions/SecuredBankCard' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' + $ref: "#/definitions/SecuredBankCard" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" diff --git a/api/payres/spec/swagger.yaml b/api/payres/spec/swagger.yaml index eaf5118..14f4824 100644 --- a/api/payres/spec/swagger.yaml +++ b/api/payres/spec/swagger.yaml @@ -1,14 +1,14 @@ -swagger: '2.0' +--- +swagger: "2.0" info: - version: '0.1.0' + version: "0.1.0" title: Vality Payment Resource API description: > - Vality Payment Resource API служит для токенизации чувствительных данных платёжных ресурсов пользователей. - + The Vality Payment Resource API is used to tokenize sensitive data of users' payment resources. termsOfService: https://vality.dev/ contact: - name: Команда техподдержки + name: Support Team email: support@vality.dev url: https://vality.dev/ host: api.vality.dev @@ -25,8 +25,8 @@ securityDefinitions: name: Authorization in: header description: > - Для аутентификации вызовов мы используем [JWT](https://jwt.io). - Cоответствующий ключ передается в заголовке. + Use [JWT](https://jwt.io) for call authentication. + The corresponding key is passed in the header. ```shell Authorization: Bearer {TOKENIZATION|PRIVATE_JWT} @@ -34,33 +34,25 @@ securityDefinitions: security: - bearer: [] - responses: - NotFound: - description: Искомая сущность не найдена - + description: The content you are looking for was not found BadRequest: - description: Недопустимые для операции входные данные + description: Invalid input data for operation schema: - $ref: '#/definitions/BadRequest' - + $ref: "#/definitions/BadRequest" Unauthorized: - description: Ошибка авторизации - + description: Authorization Error parameters: - requestID: name: X-Request-ID in: header - description: Уникальный идентификатор запроса к системе + description: Unique identifier of the request to the system required: true type: string maxLength: 32 minLength: 1 - tags: - - name: Payment Resources - x-displayName: Платёжные ресурсы + x-displayName: Payment resources description: "" diff --git a/api/wallet/internal/CompactResource.yaml b/api/wallet/internal/CompactResource.yaml index 9a94706..41ae59f 100644 --- a/api/wallet/internal/CompactResource.yaml +++ b/api/wallet/internal/CompactResource.yaml @@ -1,3 +1,4 @@ +--- type: object properties: type: @@ -6,4 +7,4 @@ properties: token: type: string binDataID: - type: string \ No newline at end of file + type: string diff --git a/api/wallet/spec/definitions/Asset.yaml b/api/wallet/spec/definitions/Asset.yaml index 87c40e1..a6b18bb 100644 --- a/api/wallet/spec/definitions/Asset.yaml +++ b/api/wallet/spec/definitions/Asset.yaml @@ -1,5 +1,6 @@ +--- description: | - Объём денежных средств + The amount of money type: object required: - amount @@ -7,10 +8,10 @@ required: properties: amount: description: | - Сумма денежных средств в минорных единицах, например, в копейках + The amount of money in minor units, for example, in cents type: integer format: int64 example: 1430000 currency: x-rebillyMerge: - - $ref: '#/definitions/CurrencyID' + - $ref: "#/definitions/CurrencyID" diff --git a/api/wallet/spec/definitions/BankCardDestinationResource.yaml b/api/wallet/spec/definitions/BankCardDestinationResource.yaml index f17c158..588b80a 100644 --- a/api/wallet/spec/definitions/BankCardDestinationResource.yaml +++ b/api/wallet/spec/definitions/BankCardDestinationResource.yaml @@ -1,4 +1,5 @@ -description: Банковская карта +--- +description: Card allOf: - - $ref: '#/definitions/DestinationResource' - - $ref: '#/definitions/SecuredBankCard' + - $ref: "#/definitions/DestinationResource" + - $ref: "#/definitions/SecuredBankCard" diff --git a/api/wallet/spec/definitions/BankCardReceiverResource.yaml b/api/wallet/spec/definitions/BankCardReceiverResource.yaml index 2d6be1e..1145151 100644 --- a/api/wallet/spec/definitions/BankCardReceiverResource.yaml +++ b/api/wallet/spec/definitions/BankCardReceiverResource.yaml @@ -1,10 +1,11 @@ -description: Банковская карта +--- +description: Card allOf: - - $ref: '#/definitions/ReceiverResource' - - $ref: '#/definitions/SecuredBankCard' + - $ref: "#/definitions/ReceiverResource" + - $ref: "#/definitions/SecuredBankCard" - type: object properties: paymentSystem: x-rebillyMerge: - - $ref: '#/definitions/BankCardPaymentSystem' + - $ref: "#/definitions/BankCardPaymentSystem" - readOnly: true diff --git a/api/wallet/spec/definitions/BankCardReceiverResourceParams.yaml b/api/wallet/spec/definitions/BankCardReceiverResourceParams.yaml index f68cba6..3b568db 100644 --- a/api/wallet/spec/definitions/BankCardReceiverResourceParams.yaml +++ b/api/wallet/spec/definitions/BankCardReceiverResourceParams.yaml @@ -1,4 +1,5 @@ +--- description: Банковская карта allOf: - - $ref: '#/definitions/ReceiverResourceParams' - - $ref: '#/definitions/SecuredBankCard' + - $ref: "#/definitions/ReceiverResourceParams" + - $ref: "#/definitions/SecuredBankCard" diff --git a/api/wallet/spec/definitions/BankCardSenderResource.yaml b/api/wallet/spec/definitions/BankCardSenderResource.yaml index 46220bd..89c7b1a 100644 --- a/api/wallet/spec/definitions/BankCardSenderResource.yaml +++ b/api/wallet/spec/definitions/BankCardSenderResource.yaml @@ -1,10 +1,11 @@ +--- description: Банковская карта allOf: - - $ref: '#/definitions/SenderResource' - - $ref: '#/definitions/SecuredBankCard' + - $ref: "#/definitions/SenderResource" + - $ref: "#/definitions/SecuredBankCard" - type: object properties: paymentSystem: x-rebillyMerge: - - $ref: '#/definitions/BankCardPaymentSystem' + - $ref: "#/definitions/BankCardPaymentSystem" - readOnly: true diff --git a/api/wallet/spec/definitions/BankCardSenderResourceParams.yaml b/api/wallet/spec/definitions/BankCardSenderResourceParams.yaml index 56cd1b7..fca9047 100644 --- a/api/wallet/spec/definitions/BankCardSenderResourceParams.yaml +++ b/api/wallet/spec/definitions/BankCardSenderResourceParams.yaml @@ -1,12 +1,13 @@ -description: Банковская карта +--- +description: Card allOf: - - $ref: '#/definitions/SenderResourceParams' - - $ref: '#/definitions/SecuredBankCard' + - $ref: "#/definitions/SenderResourceParams" + - $ref: "#/definitions/SecuredBankCard" - type: object required: - authData properties: authData: - description: Данные авторизации, полученные при сохранении карты + description: Authorization data received when saving the card type: string maxLength: 1000 diff --git a/api/wallet/spec/definitions/BrowserGetRequest.yaml b/api/wallet/spec/definitions/BrowserGetRequest.yaml index 5c78e0d..22a1566 100644 --- a/api/wallet/spec/definitions/BrowserGetRequest.yaml +++ b/api/wallet/spec/definitions/BrowserGetRequest.yaml @@ -1,14 +1,15 @@ +--- type: object allOf: - - $ref: '#/definitions/BrowserRequest' + - $ref: "#/definitions/BrowserRequest" - type: object required: - uriTemplate properties: uriTemplate: description: | - Шаблон значения URL для перехода в браузере + URL value template for browser navigation - Шаблон представлен согласно стандарту + The template is represented according to the standard [RFC6570](https://tools.ietf.org/html/rfc6570). type: string diff --git a/api/wallet/spec/definitions/BrowserPostRequest.yaml b/api/wallet/spec/definitions/BrowserPostRequest.yaml index 3e670d6..50047c2 100644 --- a/api/wallet/spec/definitions/BrowserPostRequest.yaml +++ b/api/wallet/spec/definitions/BrowserPostRequest.yaml @@ -1,6 +1,7 @@ +--- type: object allOf: - - $ref: '#/definitions/BrowserRequest' + - $ref: "#/definitions/BrowserRequest" - type: object required: - uriTemplate @@ -8,10 +9,10 @@ allOf: properties: uriTemplate: description: | - Шаблон значения URL для отправки формы + URL value template for form submission - Шаблон представлен согласно стандарту + The template is represented according to the standard [RFC6570](https://tools.ietf.org/html/rfc6570). type: string form: - $ref: '#/definitions/UserInteractionForm' + $ref: "#/definitions/UserInteractionForm" diff --git a/api/wallet/spec/definitions/BrowserRequest.yaml b/api/wallet/spec/definitions/BrowserRequest.yaml index 7ce7249..dd3fdd0 100644 --- a/api/wallet/spec/definitions/BrowserRequest.yaml +++ b/api/wallet/spec/definitions/BrowserRequest.yaml @@ -1,8 +1,9 @@ +--- type: object discriminator: requestType required: - requestType properties: requestType: - description: Тип браузерной операции + description: Type of browser operation type: string diff --git a/api/wallet/spec/definitions/ContactInfo.yaml b/api/wallet/spec/definitions/ContactInfo.yaml index 8631cbb..81199d8 100644 --- a/api/wallet/spec/definitions/ContactInfo.yaml +++ b/api/wallet/spec/definitions/ContactInfo.yaml @@ -1,14 +1,15 @@ -description: Контактные данные +--- +description: Contact details type: object properties: email: - description: Адрес электронной почты + description: Email address type: string format: email maxLength: 100 phoneNumber: description: | - Номер мобильного телефона с международным префиксом согласно - [E.164](https://en.wikipedia.org/wiki/E.164). + Mobile phone number with international prefix according to + [E.164](https://en.wikipedia.org/wiki/E.164). type: string format: '^\+\d{4,15}$' diff --git a/api/wallet/spec/definitions/ContinuationToken.yaml b/api/wallet/spec/definitions/ContinuationToken.yaml index e7561f9..47ec462 100644 --- a/api/wallet/spec/definitions/ContinuationToken.yaml +++ b/api/wallet/spec/definitions/ContinuationToken.yaml @@ -1,5 +1,6 @@ +--- description: | - Токен, сигнализирующий о том, что в ответе передана только часть данных. - Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен. - Если токена нет, получена последняя часть данных. + A token signalling that only part of the data has been transmitted in the response. + To retrieve the next part, you need repeat the request to the service again, specifying the same set of conditions and the received token. + If there is no token, the last piece of data is received. type: string diff --git a/api/wallet/spec/definitions/CryptoCurrency.yaml b/api/wallet/spec/definitions/CryptoCurrency.yaml index 06c1ca9..7baeb8a 100644 --- a/api/wallet/spec/definitions/CryptoCurrency.yaml +++ b/api/wallet/spec/definitions/CryptoCurrency.yaml @@ -1,10 +1,7 @@ +--- description: | - Криптовалюта. + Cryptocurrency. - Набор криптовалют, доступных для проведения выплат, можно узнать, вызвав соответствующую [операцию](#operation/getWithdrawalMethods). + The set of cryptocurrencies available for withdrawals can be found out by calling the appropriate [operation](#operation/getWithdrawalMethods). type: string example: BTC -# enum: -# - BTC -# - LTC -# - ETH diff --git a/api/wallet/spec/definitions/CryptoWallet.yaml b/api/wallet/spec/definitions/CryptoWallet.yaml index def9ee2..01784d1 100644 --- a/api/wallet/spec/definitions/CryptoWallet.yaml +++ b/api/wallet/spec/definitions/CryptoWallet.yaml @@ -1,15 +1,16 @@ -description: Данные криптовалютного кошелька +--- +description: Cryptocurrency wallet details type: object required: - id - currency properties: id: - description: Идентификатор (он же адрес) криптовалютного кошелька + description: Identifier (aka address) of a cryptocurrency wallet type: string minLength: 16 maxLength: 256 example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQ currency: x-rebillyMerge: - - $ref: '#/definitions/CryptoCurrency' + - $ref: "#/definitions/CryptoCurrency" diff --git a/api/wallet/spec/definitions/CryptoWalletDestinationResource.yaml b/api/wallet/spec/definitions/CryptoWalletDestinationResource.yaml index 0650f40..85c19e3 100644 --- a/api/wallet/spec/definitions/CryptoWalletDestinationResource.yaml +++ b/api/wallet/spec/definitions/CryptoWalletDestinationResource.yaml @@ -1,4 +1,5 @@ -description: Криптовалютные денежные средства +--- +description: Cryptocurrency funds allOf: - - $ref: '#/definitions/DestinationResource' - - $ref: '#/definitions/CryptoWallet' + - $ref: "#/definitions/DestinationResource" + - $ref: "#/definitions/CryptoWallet" diff --git a/api/wallet/spec/definitions/Currency.yaml b/api/wallet/spec/definitions/Currency.yaml index 57fa80f..773d50b 100644 --- a/api/wallet/spec/definitions/Currency.yaml +++ b/api/wallet/spec/definitions/Currency.yaml @@ -1,4 +1,5 @@ -description: Описание валюты +--- +description: Currency description type: object required: - id @@ -8,28 +9,28 @@ required: properties: id: x-rebillyMerge: - - $ref: '#/definitions/CurrencyID' + - $ref: "#/definitions/CurrencyID" numericCode: description: | - Цифровой код валюты согласно + Digital currency code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm) type: string - pattern: '^[0-9]{3}$' - example: '643' + pattern: "^[0-9]{3}$" + example: "840" name: description: | - Человекочитаемое название валюты + Human readable currency name type: string - example: Российский рубль + example: United States Dollar sign: description: | - Знак единицы валюты + Currency unit sign type: string - example: '₽' + example: "$" exponent: description: | - Количество допустимых знаков после запятой в сумме средств, в которых может - указываться количество минорных денежных единиц + The number of acceptable decimal places in the amount of funds, + in which the number of minor monetary units can be indicated type: integer minimum: 0 example: 2 diff --git a/api/wallet/spec/definitions/CurrencyID.yaml b/api/wallet/spec/definitions/CurrencyID.yaml index b0d2873..9de5ed4 100644 --- a/api/wallet/spec/definitions/CurrencyID.yaml +++ b/api/wallet/spec/definitions/CurrencyID.yaml @@ -1,6 +1,7 @@ +--- description: | - Валюта, символьный код согласно [ISO - 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). + Currency character code according to + [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). type: string pattern: '^[A-Z]{3}$' -example: RUB +example: USD diff --git a/api/wallet/spec/definitions/Deposit.yaml b/api/wallet/spec/definitions/Deposit.yaml index 951baea..bc98ac7 100644 --- a/api/wallet/spec/definitions/Deposit.yaml +++ b/api/wallet/spec/definitions/Deposit.yaml @@ -1,4 +1,5 @@ -description: Данные поступления денежных средств +--- +description: Deposit data allOf: - type: object required: @@ -9,28 +10,28 @@ allOf: properties: id: x-rebillyMerge: - - $ref: '#/definitions/DepositID' + - $ref: "#/definitions/DepositID" - readOnly: true createdAt: - description: Дата и время запуска пополнения + description: Deposit start date and time type: string format: date-time readOnly: true wallet: x-rebillyMerge: - - $ref: '#/definitions/WalletID' + - $ref: "#/definitions/WalletID" source: x-rebillyMerge: - - $ref: '#/definitions/SourceID' + - $ref: "#/definitions/SourceID" body: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Объём поступивших средств + - $ref: "#/definitions/Asset" + - description: The amount of funds received fee: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Сумма коммисии + - $ref: "#/definitions/Asset" + - description: Fee amount externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' - - $ref: '#/definitions/DepositStatus' + - $ref: "#/definitions/ExternalID" + - $ref: "#/definitions/DepositStatus" diff --git a/api/wallet/spec/definitions/DepositAdjustment.yaml b/api/wallet/spec/definitions/DepositAdjustment.yaml index 0e972b8..5bb2d73 100644 --- a/api/wallet/spec/definitions/DepositAdjustment.yaml +++ b/api/wallet/spec/definitions/DepositAdjustment.yaml @@ -1,17 +1,18 @@ -description: Данные корректировки поступления денежных средств +--- +description: Deposit adjustment data allOf: - type: object properties: id: x-rebillyMerge: - - $ref: '#/definitions/DepositAdjustmentID' + - $ref: "#/definitions/DepositAdjustmentID" - readOnly: true createdAt: - description: Дата и время запуска корректировки + description: Date and time the adjustment was started type: string format: date-time readOnly: true externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' - - $ref: '#/definitions/DepositAdjustmentStatus' + - $ref: "#/definitions/ExternalID" + - $ref: "#/definitions/DepositAdjustmentStatus" diff --git a/api/wallet/spec/definitions/DepositAdjustmentFailure.yaml b/api/wallet/spec/definitions/DepositAdjustmentFailure.yaml index 7fc62b3..b177c1c 100644 --- a/api/wallet/spec/definitions/DepositAdjustmentFailure.yaml +++ b/api/wallet/spec/definitions/DepositAdjustmentFailure.yaml @@ -1,9 +1,10 @@ +--- type: object required: - code properties: code: - description: Код ошибки коррекции + description: Adjustment error code type: string subError: - $ref: '#/definitions/SubFailure' + $ref: "#/definitions/SubFailure" diff --git a/api/wallet/spec/definitions/DepositAdjustmentID.yaml b/api/wallet/spec/definitions/DepositAdjustmentID.yaml index a0a6308..64cb169 100644 --- a/api/wallet/spec/definitions/DepositAdjustmentID.yaml +++ b/api/wallet/spec/definitions/DepositAdjustmentID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор корректировки поступления денежных средств +--- +description: Deposit adjustment identifier type: string example: tZ0jUmlsV0 diff --git a/api/wallet/spec/definitions/DepositAdjustmentStatus.yaml b/api/wallet/spec/definitions/DepositAdjustmentStatus.yaml index 46334df..8a03fd8 100644 --- a/api/wallet/spec/definitions/DepositAdjustmentStatus.yaml +++ b/api/wallet/spec/definitions/DepositAdjustmentStatus.yaml @@ -1,14 +1,15 @@ +--- type: object properties: status: description: | - Статус корректировки поступления денежных средств. + Deposit adjustment status. - | Значение | Пояснение | + | Meaning | Explanation | | ----------- | ------------------------------------------------------- | - | `Pending` | Корректировка в процессе выполнения | - | `Succeeded` | Корректировка произведёна успешно | - | `Failed` | Корректировка завершилась неудачей | + | `Pending` | Adjustment in progress | + | `Succeeded` | Adjustment completed successfully | + | `Failed` | Adjustment failed | type: string enum: @@ -19,8 +20,8 @@ properties: failure: x-rebillyMerge: - description: | - > Если `status` == `Failed` + > If `status` == `Failed` - Пояснение причины неудачи + Explanation of the reason for failure readOnly: true - - $ref: '#/definitions/DepositAdjustmentFailure' + - $ref: "#/definitions/DepositAdjustmentFailure" diff --git a/api/wallet/spec/definitions/DepositFailure.yaml b/api/wallet/spec/definitions/DepositFailure.yaml index acbdf59..0fca470 100644 --- a/api/wallet/spec/definitions/DepositFailure.yaml +++ b/api/wallet/spec/definitions/DepositFailure.yaml @@ -1,9 +1,10 @@ +--- type: object required: - code properties: code: - description: Код ошибки поступления + description: Deposit error code type: string subError: - $ref: '#/definitions/SubFailure' + $ref: "#/definitions/SubFailure" diff --git a/api/wallet/spec/definitions/DepositID.yaml b/api/wallet/spec/definitions/DepositID.yaml index 7ef87c5..bdb1a6f 100644 --- a/api/wallet/spec/definitions/DepositID.yaml +++ b/api/wallet/spec/definitions/DepositID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор поступления денежных средств +--- +description: Deposit identifier type: string example: tZ0jUmlsV0 diff --git a/api/wallet/spec/definitions/DepositRevert.yaml b/api/wallet/spec/definitions/DepositRevert.yaml index ff3b5fd..9f7d618 100644 --- a/api/wallet/spec/definitions/DepositRevert.yaml +++ b/api/wallet/spec/definitions/DepositRevert.yaml @@ -1,4 +1,5 @@ -description: Данные отмены поступления денежных средств +--- +description: Deposit revert data allOf: - type: object required: @@ -8,26 +9,26 @@ allOf: properties: id: x-rebillyMerge: - - $ref: '#/definitions/DepositRevertID' + - $ref: "#/definitions/DepositRevertID" - readOnly: true createdAt: - description: Дата и время запуска отмены + description: Date and time of revert start type: string format: date-time readOnly: true wallet: x-rebillyMerge: - - $ref: '#/definitions/WalletID' + - $ref: "#/definitions/WalletID" source: x-rebillyMerge: - - $ref: '#/definitions/SourceID' + - $ref: "#/definitions/SourceID" body: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Объем денежных средств + - $ref: "#/definitions/Asset" + - description: Amount of funds reason: type: string externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' - - $ref: '#/definitions/DepositRevertStatus' + - $ref: "#/definitions/ExternalID" + - $ref: "#/definitions/DepositRevertStatus" diff --git a/api/wallet/spec/definitions/DepositRevertFailure.yaml b/api/wallet/spec/definitions/DepositRevertFailure.yaml index f90efca..744fd02 100644 --- a/api/wallet/spec/definitions/DepositRevertFailure.yaml +++ b/api/wallet/spec/definitions/DepositRevertFailure.yaml @@ -1,9 +1,10 @@ +--- type: object required: - code properties: code: - description: Код ошибки отмены + description: Deposit revert error code type: string subError: - $ref: '#/definitions/SubFailure' + $ref: "#/definitions/SubFailure" diff --git a/api/wallet/spec/definitions/DepositRevertID.yaml b/api/wallet/spec/definitions/DepositRevertID.yaml index 4e827b7..b994593 100644 --- a/api/wallet/spec/definitions/DepositRevertID.yaml +++ b/api/wallet/spec/definitions/DepositRevertID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор отмены поступления денежных средств  +--- +description: Deposit revert identifier type: string example: "10068321" diff --git a/api/wallet/spec/definitions/DepositRevertStatus.yaml b/api/wallet/spec/definitions/DepositRevertStatus.yaml index 01b6ed2..979b2b4 100644 --- a/api/wallet/spec/definitions/DepositRevertStatus.yaml +++ b/api/wallet/spec/definitions/DepositRevertStatus.yaml @@ -1,14 +1,15 @@ +--- type: object properties: status: description: | - Статус отмены поступления денежных средств. + Deposit revert status. - | Значение | Пояснение | + | Meaning | Explanation | | ----------- | ------------------------------------------------------- | - | `Pending` | Отмена в процессе выполнения | - | `Succeeded` | Отмена поступления средств произведёна успешно | - | `Failed` | Отмена поступления средств завершилась неудачей | + | `Pending` | Deposit revert in progress | + | `Succeeded` | Deposit revert completed successfully | + | `Failed` | Deposit revert failed | type: string enum: @@ -19,8 +20,8 @@ properties: failure: x-rebillyMerge: - description: | - > Если `status` == `Failed` + > If `status` == `Failed` - Пояснение причины неудачи + Explanation of the reason for failure readOnly: true - - $ref: '#/definitions/DepositRevertFailure' + - $ref: "#/definitions/DepositRevertFailure" diff --git a/api/wallet/spec/definitions/DepositStatus.yaml b/api/wallet/spec/definitions/DepositStatus.yaml index 5cc0b62..97ef3bb 100644 --- a/api/wallet/spec/definitions/DepositStatus.yaml +++ b/api/wallet/spec/definitions/DepositStatus.yaml @@ -1,14 +1,15 @@ +--- type: object properties: status: description: | - Статус поступления денежных средств. + Status of deposit. - | Значение | Пояснение | + | Meaning | Explanation | | ----------- | ------------------------------------------------ | - | `Pending` | Поступление в процессе выполнения | - | `Succeeded` | Поступление средств произведён успешно | - | `Failed` | Поступление средств завершился неудачей | + | `Pending` | Deposit in progress | + | `Succeeded` | Deposit of funds made successfully | + | `Failed` | Deposit of funds ended in failure | type: string enum: @@ -19,8 +20,8 @@ properties: failure: x-rebillyMerge: - description: | - > Если `status` == `Failed` + > If `status` == `Failed` - Пояснение причины неудачи + Explanation of the reason for failure readOnly: true - - $ref: '#/definitions/DepositFailure' + - $ref: "#/definitions/DepositFailure" diff --git a/api/wallet/spec/definitions/Destination.yaml b/api/wallet/spec/definitions/Destination.yaml index 525d4a3..d0082e3 100644 --- a/api/wallet/spec/definitions/Destination.yaml +++ b/api/wallet/spec/definitions/Destination.yaml @@ -1,4 +1,5 @@ -description: Данные приёмника денежных средств +--- +description: Destination data allOf: - type: object required: @@ -9,39 +10,38 @@ allOf: properties: id: x-rebillyMerge: - - $ref: '#/definitions/DestinationID' + - $ref: "#/definitions/DestinationID" - readOnly: true name: description: | - Человекочитаемое название приёмника средств, по которому его легко узнать + A human-readable name for the destination by which it is easily recognizable type: string example: Squarey plastic thingy createdAt: - description: Дата и время создания приёмника средств + description: Date and time of creation of the destination of the funds type: string format: date-time readOnly: true isBlocked: - description: Заблокирован ли приёмник средств? + description: Is the destination blocked? type: boolean readOnly: true example: false identity: x-rebillyMerge: - - $ref: '#/definitions/IdentityID' + - $ref: "#/definitions/IdentityID" currency: x-rebillyMerge: - - $ref: '#/definitions/CurrencyID' + - $ref: "#/definitions/CurrencyID" resource: - $ref: '#/definitions/DestinationResource' + $ref: "#/definitions/DestinationResource" metadata: description: | - Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с - данным приёмником + Some non-transparent for system set of data associated with this destination type: object example: color_hint: olive-green externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' - - $ref: '#/definitions/DestinationStatus' + - $ref: "#/definitions/ExternalID" + - $ref: "#/definitions/DestinationStatus" diff --git a/api/wallet/spec/definitions/DestinationGrantRequest.yaml b/api/wallet/spec/definitions/DestinationGrantRequest.yaml index 5669387..a47302b 100644 --- a/api/wallet/spec/definitions/DestinationGrantRequest.yaml +++ b/api/wallet/spec/definitions/DestinationGrantRequest.yaml @@ -1,15 +1,16 @@ -description: Запрос на право управления выводами на приёмник средств +--- +description: Request for the permission to control the withdrawals to the destination type: object required: - validUntil properties: token: x-rebillyMerge: - - description: Токен, дающий право управления выводами - - $ref: '#/definitions/GrantToken' + - description: Token granting the permission to control the withdrawals + - $ref: "#/definitions/GrantToken" - readOnly: true validUntil: description: | - Дата и время, до наступления которых выданное право действительно + The date and time by which the granted right is valid type: string format: date-time diff --git a/api/wallet/spec/definitions/DestinationID.yaml b/api/wallet/spec/definitions/DestinationID.yaml index 8f7e9e9..411188e 100644 --- a/api/wallet/spec/definitions/DestinationID.yaml +++ b/api/wallet/spec/definitions/DestinationID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор приёмника денежных средств +--- +description: Destination identifier type: string example: "107498" diff --git a/api/wallet/spec/definitions/DestinationResource.yaml b/api/wallet/spec/definitions/DestinationResource.yaml index 856482b..90438d0 100644 --- a/api/wallet/spec/definitions/DestinationResource.yaml +++ b/api/wallet/spec/definitions/DestinationResource.yaml @@ -1,4 +1,5 @@ -description: Ресурс приёмника денежных средств, используемый для осуществления выводов +--- +description: Destination resource used to make withdrawals type: object discriminator: type required: @@ -6,9 +7,9 @@ required: properties: type: description: | - Тип ресурса приёмника средств. + The resource type of the destination. - См. [Vality Payment Resource API](?api/payres/swagger.yaml). + See [Vality Withdrawal Resource API](?api/payres/swagger.yaml). type: string enum: - BankCardDestinationResource diff --git a/api/wallet/spec/definitions/DestinationStatus.yaml b/api/wallet/spec/definitions/DestinationStatus.yaml index 7bd4096..e48c7a2 100644 --- a/api/wallet/spec/definitions/DestinationStatus.yaml +++ b/api/wallet/spec/definitions/DestinationStatus.yaml @@ -1,13 +1,14 @@ +--- type: object properties: status: description: | - Статус приёмника денежных средств. + The status of the destination. - | Значение | Пояснение | - | -------------- | ------------------------------------------ | - | `Unauthorized` | Не авторизован владельцем на вывод средств | - | `Authorized` | Авторизован владельцем на вывод средств | + | Meaning | Explanation | + | -------------- | --------------------------------------------- | + | `Unauthorized` | Not authorized by the owner to withdraw funds | + | `Authorized` | Authorized by the owner to withdraw funds | type: string enum: @@ -17,9 +18,9 @@ properties: example: Authorized validUntil: description: | - > Если `status` == `Authorized` + > If `status` == `Authorized` - Дата и время, до наступления которых авторизация действительна + Date and time until which authorization is valid type: string format: date-time readOnly: true diff --git a/api/wallet/spec/definitions/DestinationsTopic.yaml b/api/wallet/spec/definitions/DestinationsTopic.yaml index e77c955..2a22ac3 100644 --- a/api/wallet/spec/definitions/DestinationsTopic.yaml +++ b/api/wallet/spec/definitions/DestinationsTopic.yaml @@ -1,14 +1,14 @@ +--- description: | - Область охвата, включающая события по приёмникам денежных средств - в рамках определённого кошелька + A coverage area that includes events by asset destinations within a particular wallet allOf: - - $ref: '#/definitions/WebhookScope' + - $ref: "#/definitions/WebhookScope" - type: object required: - eventTypes properties: eventTypes: - description: Набор типов событий приёмника денежных средств, о которых следует оповещать + description: Set of event types of the destination, which should be notified type: array items: type: string diff --git a/api/wallet/spec/definitions/DigitalWallet.yaml b/api/wallet/spec/definitions/DigitalWallet.yaml index 17321de..644c847 100644 --- a/api/wallet/spec/definitions/DigitalWallet.yaml +++ b/api/wallet/spec/definitions/DigitalWallet.yaml @@ -1,21 +1,22 @@ -description: Данные цифрового кошелька +--- +description: Digital wallet data type: object required: - id - provider properties: id: - description: Идентификатор цифрового кошелька + description: Digital wallet ID type: string minLength: 1 maxLength: 100 example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQ provider: - description: Провайдер электронных денежных средств + description: Digital wallet service provider x-rebillyMerge: - - $ref: '#/definitions/DigitalWalletProvider' + - $ref: "#/definitions/DigitalWalletProvider" token: - description: Строка, содержащая данные для авторизации операций над этим кошельком + description: A string containing authorization data for transactions on this digital wallet type: string minLength: 1 maxLength: 4000 diff --git a/api/wallet/spec/definitions/DigitalWalletDestinationResource.yaml b/api/wallet/spec/definitions/DigitalWalletDestinationResource.yaml index 17d86d0..9c0757b 100644 --- a/api/wallet/spec/definitions/DigitalWalletDestinationResource.yaml +++ b/api/wallet/spec/definitions/DigitalWalletDestinationResource.yaml @@ -1,4 +1,5 @@ -description: Цифровой кошелек +--- +description: Digital wallet allOf: - - $ref: '#/definitions/DestinationResource' - - $ref: '#/definitions/DigitalWallet' + - $ref: "#/definitions/DestinationResource" + - $ref: "#/definitions/DigitalWallet" diff --git a/api/wallet/spec/definitions/DigitalWalletProvider.yaml b/api/wallet/spec/definitions/DigitalWalletProvider.yaml index 2817515..693f8a7 100644 --- a/api/wallet/spec/definitions/DigitalWalletProvider.yaml +++ b/api/wallet/spec/definitions/DigitalWalletProvider.yaml @@ -1,7 +1,8 @@ +--- description: | - Провайдер электронных денежных средств. + Digital wallet provider. - Набор провайдеров, доступных для проведения выплат, можно узнать, вызвав - соответствующую [операцию](#operation/getWithdrawalMethods). + The set of providers available for making withdrawals can be found by calling + corresponding [operation](#operation/getWithdrawalMethods). type: string example: Paypal diff --git a/api/wallet/spec/definitions/ExternalID.yaml b/api/wallet/spec/definitions/ExternalID.yaml index 6c8fcaa..92ae098 100644 --- a/api/wallet/spec/definitions/ExternalID.yaml +++ b/api/wallet/spec/definitions/ExternalID.yaml @@ -1,6 +1,7 @@ +--- description: | - Уникальный идентификатор сущности на вашей стороне. - - При указании будет использован для того, чтобы гарантировать идемпотентную обработку операции. + The unique identifier of the entity on your side. + + When specified, will be used to ensure idempotent processing of the operation. type: string example: "10036274" diff --git a/api/wallet/spec/definitions/FileDownload.yaml b/api/wallet/spec/definitions/FileDownload.yaml index 2386883..ca456ac 100644 --- a/api/wallet/spec/definitions/FileDownload.yaml +++ b/api/wallet/spec/definitions/FileDownload.yaml @@ -1,12 +1,13 @@ +--- type: object required: - url - expiresAt properties: url: - description: URL файла + description: URL of the file type: string expiresAt: - description: Время до которого ссылка будет считаться действительной + description: The date and time by which the link will be valid type: string format: date-time diff --git a/api/wallet/spec/definitions/GenericProvider.yaml b/api/wallet/spec/definitions/GenericProvider.yaml index aa0d5f4..9a89e52 100644 --- a/api/wallet/spec/definitions/GenericProvider.yaml +++ b/api/wallet/spec/definitions/GenericProvider.yaml @@ -1,7 +1,8 @@ +--- description: | - Провайдер сервисов выплат. + Withdrawal service provider. - Набор провайдеров, доступных для проведения выплат, можно узнать, вызвав - соответствующую [операцию](#operation/getWithdrawalMethods). + The set of providers available for making withdrawals can be found by calling + corresponding [operation](#operation/getWithdrawalMethods). type: string example: YourBankName diff --git a/api/wallet/spec/definitions/GrantToken.yaml b/api/wallet/spec/definitions/GrantToken.yaml index 3090caf..220f1b6 100644 --- a/api/wallet/spec/definitions/GrantToken.yaml +++ b/api/wallet/spec/definitions/GrantToken.yaml @@ -1,3 +1,4 @@ +--- type: string minLength: 1 maxLength: 4000 diff --git a/api/wallet/spec/definitions/Identity.yaml b/api/wallet/spec/definitions/Identity.yaml index 29ab10a..ad01e07 100644 --- a/api/wallet/spec/definitions/Identity.yaml +++ b/api/wallet/spec/definitions/Identity.yaml @@ -1,4 +1,5 @@ -description: Данные личности владельца кошельков +--- +description: Data of the wallet owner type: object required: - name @@ -6,36 +7,35 @@ required: properties: id: x-rebillyMerge: - - $ref: '#/definitions/IdentityID' + - $ref: "#/definitions/IdentityID" - readOnly: true name: description: | - Человекочитаемое имя личности владельца, по которому его легко опознать + Human-readable name of the owner's identity, by which he can be easily identified type: string example: Keyn Fawkes createdAt: - description: Дата и время создания личности владельца + description: Date and time the owner identity was created type: string format: date-time readOnly: true provider: x-rebillyMerge: - - $ref: '#/definitions/ProviderID' + - $ref: "#/definitions/ProviderID" isBlocked: - description: Заблокирована ли личность владельца? + description: Is the owner's identity blocked? type: boolean readOnly: true example: false metadata: description: | - Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с - данной личностью владельца + Some non-transparent for system set of data associated with this identity type: object example: - lkDisplayName: Сергей Иванович + lkDisplayName: James Smith externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' + - $ref: "#/definitions/ExternalID" partyID: x-rebillyMerge: - - $ref: '#/definitions/PartyID' + - $ref: "#/definitions/PartyID" diff --git a/api/wallet/spec/definitions/IdentityID.yaml b/api/wallet/spec/definitions/IdentityID.yaml index 208b98e..e627f55 100644 --- a/api/wallet/spec/definitions/IdentityID.yaml +++ b/api/wallet/spec/definitions/IdentityID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор личности владельца кошелька +--- +description: Identifier of wallet owner type: string example: "10036274" diff --git a/api/wallet/spec/definitions/PartyID.yaml b/api/wallet/spec/definitions/PartyID.yaml index b91c338..7f8949e 100644 --- a/api/wallet/spec/definitions/PartyID.yaml +++ b/api/wallet/spec/definitions/PartyID.yaml @@ -1,4 +1,5 @@ -description: Уникальный в рамках системы идентификатор участника. +--- +description: The participant's unique identifier within the system. type: string minLength: 1 maxLength: 40 diff --git a/api/wallet/spec/definitions/Provider.yaml b/api/wallet/spec/definitions/Provider.yaml index e7b5ced..ba5d381 100644 --- a/api/wallet/spec/definitions/Provider.yaml +++ b/api/wallet/spec/definitions/Provider.yaml @@ -1,4 +1,5 @@ -description: Данные провайдера услуг +--- +description: Service provider data type: object required: - id @@ -7,16 +8,16 @@ required: properties: id: x-rebillyMerge: - - $ref: '#/definitions/ProviderID' + - $ref: "#/definitions/ProviderID" name: description: | - Человекочитаемое наименование провайдера услуг + Human-readable name of the service provider type: string - example: ООО «СЕРВИС ПРОВАЙДЕР» + example: SERVICE PROVIDER LLC residences: type: array description: | - Резиденции, в которых провайдер предоставляет услуги + Residences in which the provider can service items: x-rebillyMerge: - - $ref: '#/definitions/ResidenceID' + - $ref: "#/definitions/ResidenceID" diff --git a/api/wallet/spec/definitions/ProviderID.yaml b/api/wallet/spec/definitions/ProviderID.yaml index 8c269b7..550205c 100644 --- a/api/wallet/spec/definitions/ProviderID.yaml +++ b/api/wallet/spec/definitions/ProviderID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор провайдера услуг +--- +description: Identifier of the service provider type: string example: serviceprovider diff --git a/api/wallet/spec/definitions/QuoteParameters.yaml b/api/wallet/spec/definitions/QuoteParameters.yaml index b4d0369..325f2c2 100644 --- a/api/wallet/spec/definitions/QuoteParameters.yaml +++ b/api/wallet/spec/definitions/QuoteParameters.yaml @@ -1,4 +1,5 @@ -description: Параметры запроса комиссий +--- +description: Quote request parameters type: object required: - sender @@ -7,13 +8,13 @@ required: - body properties: sender: - $ref: '#/definitions/SenderResource' + $ref: "#/definitions/SenderResource" receiver: - $ref: '#/definitions/ReceiverResource' + $ref: "#/definitions/ReceiverResource" identityID: x-rebillyMerge: - - $ref: '#/definitions/IdentityID' + - $ref: "#/definitions/IdentityID" body: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Сумма операции + - $ref: "#/definitions/Asset" + - description: Transaction amount diff --git a/api/wallet/spec/definitions/ReceiverResource.yaml b/api/wallet/spec/definitions/ReceiverResource.yaml index 5dcb7ca..f6e8af4 100644 --- a/api/wallet/spec/definitions/ReceiverResource.yaml +++ b/api/wallet/spec/definitions/ReceiverResource.yaml @@ -1,4 +1,5 @@ -description: Ресурс получателя денежных средств, используемый для осуществления переводов +--- +description: The beneficiary's resource used to make the transfers type: object discriminator: type required: @@ -6,9 +7,9 @@ required: properties: type: description: | - Тип ресурса получателя средств. + The resource type of the receiver of the funds. - См. [Vality Payment Resource API](?api/payres/swagger.yaml). + See [Vality Withdrawal Resource API](?api/payres/swagger.yaml). type: string enum: - BankCardReceiverResource diff --git a/api/wallet/spec/definitions/ReceiverResourceParams.yaml b/api/wallet/spec/definitions/ReceiverResourceParams.yaml index 69d807c..86eacc7 100644 --- a/api/wallet/spec/definitions/ReceiverResourceParams.yaml +++ b/api/wallet/spec/definitions/ReceiverResourceParams.yaml @@ -1,4 +1,5 @@ -description: Параметры ресурса получателя денежных средств +--- +description: Recipient resource parameters type: object discriminator: type required: @@ -6,9 +7,9 @@ required: properties: type: description: | - Тип ресурса получателя средств. + The resource type of the payee. - См. [Vality Payment Resource API](?api/payres/swagger.yaml). + See [Vality Withdrawal Resource API](?api/payres/swagger.yaml). type: string enum: - BankCardReceiverResourceParams diff --git a/api/wallet/spec/definitions/Redirect.yaml b/api/wallet/spec/definitions/Redirect.yaml index 2676ab4..88b28ef 100644 --- a/api/wallet/spec/definitions/Redirect.yaml +++ b/api/wallet/spec/definitions/Redirect.yaml @@ -1,9 +1,10 @@ +--- type: object allOf: - - $ref: '#/definitions/UserInteraction' + - $ref: "#/definitions/UserInteraction" - type: object required: - request properties: request: - $ref: '#/definitions/BrowserRequest' + $ref: "#/definitions/BrowserRequest" diff --git a/api/wallet/spec/definitions/Report.yaml b/api/wallet/spec/definitions/Report.yaml index 833b47c..f404f88 100644 --- a/api/wallet/spec/definitions/Report.yaml +++ b/api/wallet/spec/definitions/Report.yaml @@ -1,3 +1,4 @@ +--- type: object required: - id @@ -9,30 +10,30 @@ required: - files properties: id: - description: Идентификатор отчета + description: Report identifier type: integer format: int64 createdAt: - description: Дата и время создания + description: Date and time of creation type: string format: date-time fromTime: - description: Дата и время начала периода + description: Date and time of the start of the period type: string format: date-time toTime: - description: Дата и время конца периода + description: Date and time of the end of period type: string format: date-time status: - description: Статус формирования отчета + description: Report generation status type: string enum: - pending - created - canceled type: - description: Тип отчета + description: Report type type: string enum: - withdrawalRegistry @@ -44,7 +45,7 @@ properties: - id properties: id: - description: Идентификатор файла + description: File identifier type: string maxLength: 40 minLength: 1 diff --git a/api/wallet/spec/definitions/ReportParams.yaml b/api/wallet/spec/definitions/ReportParams.yaml index ad94a65..b8f4970 100644 --- a/api/wallet/spec/definitions/ReportParams.yaml +++ b/api/wallet/spec/definitions/ReportParams.yaml @@ -1,3 +1,4 @@ +--- type: object required: - reportType @@ -5,15 +6,15 @@ required: - toTime properties: reportType: - description: Тип отчета + description: Type of report type: string enum: - withdrawalRegistry fromTime: - description: Начало временного отрезка + description: Start of the time period type: string format: date-time toTime: - description: Конец временного отрезка + description: End of the time period type: string format: date-time diff --git a/api/wallet/spec/definitions/Residence.yaml b/api/wallet/spec/definitions/Residence.yaml index f8fbdd6..0bbc477 100644 --- a/api/wallet/spec/definitions/Residence.yaml +++ b/api/wallet/spec/definitions/Residence.yaml @@ -1,4 +1,5 @@ -description: Описание региона резиденции +--- +description: Description of the region of residence type: object required: - id @@ -6,14 +7,14 @@ required: properties: id: x-rebillyMerge: - - $ref: '#/definitions/ResidenceID' + - $ref: "#/definitions/ResidenceID" name: description: | - Человекочитаемое название региона резиденции + Human-readable name of the region of residence type: string - example: Российская федерация + example: The United States of America flag: description: | - Флаг региона резиденции + Residence region flag type: string - example: '🇷🇺' + example: "🇺🇸" diff --git a/api/wallet/spec/definitions/ResidenceID.yaml b/api/wallet/spec/definitions/ResidenceID.yaml index 2c6041a..2986700 100644 --- a/api/wallet/spec/definitions/ResidenceID.yaml +++ b/api/wallet/spec/definitions/ResidenceID.yaml @@ -1,5 +1,6 @@ +--- description: | - Резиденция, символьный код по стандарту [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) + Residence symbol code by standard [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) type: string -pattern: '^[A-Z]{3}$' +pattern: "^[A-Z]{3}$" example: RUS diff --git a/api/wallet/spec/definitions/SenderResource.yaml b/api/wallet/spec/definitions/SenderResource.yaml index 061d18f..f3b7da0 100644 --- a/api/wallet/spec/definitions/SenderResource.yaml +++ b/api/wallet/spec/definitions/SenderResource.yaml @@ -1,4 +1,5 @@ -description: Ресурс отправителя денежных средств, используемый для осуществления переводов +--- +description: The sender resource used to make transfers type: object discriminator: type required: @@ -6,9 +7,9 @@ required: properties: type: description: | - Тип ресурса отправителя средств. + The resource type of the sender of the funds. - См. [Vality Payment Resource API](?api/payres/swagger.yaml). + See [Vality Withdrawal Resource API](?api/payres/swagger.yaml). type: string enum: - BankCardSenderResource diff --git a/api/wallet/spec/definitions/SenderResourceParams.yaml b/api/wallet/spec/definitions/SenderResourceParams.yaml index 8c71e8b..9ec37b5 100644 --- a/api/wallet/spec/definitions/SenderResourceParams.yaml +++ b/api/wallet/spec/definitions/SenderResourceParams.yaml @@ -1,4 +1,5 @@ -description: Параметры ресурса отправителя денежных средств +--- +description: Fund sender resource settings type: object discriminator: type required: @@ -6,9 +7,9 @@ required: properties: type: description: | - Тип ресурса отправителя средств. + The resource type of the sender of the funds. - См. [Vality Payment Resource API](?api/payres/swagger.yaml). + See [Vality Withdrawal Resource API](?api/payres/swagger.yaml). type: string enum: - BankCardSenderResourceParams diff --git a/api/wallet/spec/definitions/SourceID.yaml b/api/wallet/spec/definitions/SourceID.yaml index 2821230..9b15a12 100644 --- a/api/wallet/spec/definitions/SourceID.yaml +++ b/api/wallet/spec/definitions/SourceID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор источника денежных средств +--- +description: Funds source identifier type: string example: "107498" diff --git a/api/wallet/spec/definitions/SubFailure.yaml b/api/wallet/spec/definitions/SubFailure.yaml index 1cefdbb..04ef822 100644 --- a/api/wallet/spec/definitions/SubFailure.yaml +++ b/api/wallet/spec/definitions/SubFailure.yaml @@ -1,11 +1,12 @@ +--- description: | - Детализация описания ошибки + Detailed description of the error type: object required: - code properties: code: - description: Детализация кода ошибки + description: Details of the error code type: string subError: - $ref: '#/definitions/SubFailure' \ No newline at end of file + $ref: "#/definitions/SubFailure" diff --git a/api/wallet/spec/definitions/USDT.yaml b/api/wallet/spec/definitions/USDT.yaml deleted file mode 100644 index 671770d..0000000 --- a/api/wallet/spec/definitions/USDT.yaml +++ /dev/null @@ -1,2 +0,0 @@ -allOf: - - $ref: '#/definitions/CryptoWallet' diff --git a/api/wallet/spec/definitions/UserInteraction.yaml b/api/wallet/spec/definitions/UserInteraction.yaml index 6dd286d..aae47bb 100644 --- a/api/wallet/spec/definitions/UserInteraction.yaml +++ b/api/wallet/spec/definitions/UserInteraction.yaml @@ -1,8 +1,9 @@ +--- type: object discriminator: interactionType required: - interactionType properties: interactionType: - description: Тип взаимодействия с пользователем + description: Type of interaction with the user type: string diff --git a/api/wallet/spec/definitions/UserInteractionChange.yaml b/api/wallet/spec/definitions/UserInteractionChange.yaml index cc38120..a9c9f4f 100644 --- a/api/wallet/spec/definitions/UserInteractionChange.yaml +++ b/api/wallet/spec/definitions/UserInteractionChange.yaml @@ -1,10 +1,11 @@ +--- type: object discriminator: changeType required: - changeType properties: changeType: - description: Вид изменения взаимодействию с пользователем. + description: Type of change in user interaction. type: string enum: - UserInteractionCreated diff --git a/api/wallet/spec/definitions/UserInteractionCreated.yaml b/api/wallet/spec/definitions/UserInteractionCreated.yaml index 0942f8a..f91f700 100644 --- a/api/wallet/spec/definitions/UserInteractionCreated.yaml +++ b/api/wallet/spec/definitions/UserInteractionCreated.yaml @@ -1,9 +1,10 @@ +--- type: object allOf: - - $ref: '#/definitions/UserInteractionChange' + - $ref: "#/definitions/UserInteractionChange" - type: object required: - userInteraction properties: userInteraction: - $ref: '#/definitions/UserInteraction' + $ref: "#/definitions/UserInteraction" diff --git a/api/wallet/spec/definitions/UserInteractionFinished.yaml b/api/wallet/spec/definitions/UserInteractionFinished.yaml index f81b236..38e78d1 100644 --- a/api/wallet/spec/definitions/UserInteractionFinished.yaml +++ b/api/wallet/spec/definitions/UserInteractionFinished.yaml @@ -1,3 +1,4 @@ +--- type: object allOf: - - $ref: '#/definitions/UserInteractionChange' + - $ref: "#/definitions/UserInteractionChange" diff --git a/api/wallet/spec/definitions/UserInteractionForm.yaml b/api/wallet/spec/definitions/UserInteractionForm.yaml index 9a190df..768ce97 100644 --- a/api/wallet/spec/definitions/UserInteractionForm.yaml +++ b/api/wallet/spec/definitions/UserInteractionForm.yaml @@ -1,4 +1,5 @@ -description: Форма для отправки средствами браузера +--- +description: Browser submission form type: array items: type: object @@ -8,12 +9,11 @@ items: properties: key: description: | - Значение ключа элемента формы, которую необходимо отправить средствами - браузера + The value of the key of the form element to be send by means of browser type: string template: description: | - Шаблон значения элемента формы - Шаблон представлен согласно стандарту + The template for the form element value + The template is presented according to the standard [RFC6570](https://tools.ietf.org/html/rfc6570). type: string diff --git a/api/wallet/spec/definitions/W2WTransfer.yaml b/api/wallet/spec/definitions/W2WTransfer.yaml index d2966ff..46a6fc4 100644 --- a/api/wallet/spec/definitions/W2WTransfer.yaml +++ b/api/wallet/spec/definitions/W2WTransfer.yaml @@ -1,4 +1,5 @@ -description: Данные перевода +--- +description: Transfer data type: object required: - id @@ -10,21 +11,21 @@ required: properties: id: x-rebillyMerge: - - $ref: '#/definitions/W2WTransferID' + - $ref: "#/definitions/W2WTransferID" createdAt: - description: Дата и время создания + description: Date and time of creation type: string format: date-time body: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Сумма операции + - $ref: "#/definitions/Asset" + - description: Transaction amount sender: - $ref: '#/definitions/WalletID' + $ref: "#/definitions/WalletID" receiver: - $ref: '#/definitions/WalletID' + $ref: "#/definitions/WalletID" status: - $ref: '#/definitions/W2WTransferStatus' + $ref: "#/definitions/W2WTransferStatus" externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' + - $ref: "#/definitions/ExternalID" diff --git a/api/wallet/spec/definitions/W2WTransferFailure.yaml b/api/wallet/spec/definitions/W2WTransferFailure.yaml index a3217bf..f15b9e7 100644 --- a/api/wallet/spec/definitions/W2WTransferFailure.yaml +++ b/api/wallet/spec/definitions/W2WTransferFailure.yaml @@ -1,11 +1,12 @@ +--- description: | - [Ошибка, возникшая в процессе проведения перевода](#tag/Error-Codes) + [Error occurred during the transfer process](#tag/Error-Codes) type: object required: - code properties: code: - description: Основной код ошибки + description: Main error code type: string subError: - $ref: '#/definitions/SubFailure' + $ref: "#/definitions/SubFailure" diff --git a/api/wallet/spec/definitions/W2WTransferID.yaml b/api/wallet/spec/definitions/W2WTransferID.yaml index ffc6462..2907e2b 100644 --- a/api/wallet/spec/definitions/W2WTransferID.yaml +++ b/api/wallet/spec/definitions/W2WTransferID.yaml @@ -1,4 +1,5 @@ -description: Идентификатор перевода +--- +description: Transfer identifier type: string example: "10a0b68D3E21" maxLength: 40 diff --git a/api/wallet/spec/definitions/W2WTransferParameters.yaml b/api/wallet/spec/definitions/W2WTransferParameters.yaml index b6189ca..479d2e8 100644 --- a/api/wallet/spec/definitions/W2WTransferParameters.yaml +++ b/api/wallet/spec/definitions/W2WTransferParameters.yaml @@ -1,4 +1,5 @@ -description: Параметры создания перевода +--- +description: Transfer creation options type: object required: - sender @@ -6,13 +7,13 @@ required: - body properties: sender: - $ref: '#/definitions/WalletID' + $ref: "#/definitions/WalletID" receiver: - $ref: '#/definitions/WalletID' + $ref: "#/definitions/WalletID" body: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Сумма перевода + - $ref: "#/definitions/Asset" + - description: Transfer amount externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' + - $ref: "#/definitions/ExternalID" diff --git a/api/wallet/spec/definitions/W2WTransferStatus.yaml b/api/wallet/spec/definitions/W2WTransferStatus.yaml index e226dab..f9cec24 100644 --- a/api/wallet/spec/definitions/W2WTransferStatus.yaml +++ b/api/wallet/spec/definitions/W2WTransferStatus.yaml @@ -1,17 +1,17 @@ +--- type: object required: - status properties: status: description: | - Статус перевода денежных средств. - - | Значение | Пояснение | - | ----------- | ------------------------------------------ | - | `Pending` | Перевод в процессе выполнения | - | `Succeeded` | Перевод средств произведён успешно | - | `Failed` | Перевод средств завершился неудачей | + The status of the money transfer. + | Meaning | Explanation | + | ----------- | ------------------------------------ | + | `Pending` | Transfer in progress | + | `Succeeded` | Fund transfer completed successfully | + | `Failed` | Fund transfer failed | type: string enum: - Pending @@ -20,7 +20,7 @@ properties: failure: x-rebillyMerge: - description: | - > Если `status` == `Failed` + > If `status` == `Failed` - Пояснение причины неудачи - - $ref: '#/definitions/W2WTransferFailure' + Explanation of the reason for failure + - $ref: "#/definitions/W2WTransferFailure" diff --git a/api/wallet/spec/definitions/Wallet.yaml b/api/wallet/spec/definitions/Wallet.yaml index eaca409..b4568d5 100644 --- a/api/wallet/spec/definitions/Wallet.yaml +++ b/api/wallet/spec/definitions/Wallet.yaml @@ -1,4 +1,5 @@ -description: Данные кошелька +--- +description: Wallet details type: object required: - name @@ -7,34 +8,33 @@ required: properties: id: x-rebillyMerge: - - $ref: '#/definitions/WalletID' + - $ref: "#/definitions/WalletID" - readOnly: true name: x-rebillyMerge: - - $ref: '#/definitions/WalletName' + - $ref: "#/definitions/WalletName" createdAt: - description: Дата и время создания кошелька + description: Date and time of wallet creation type: string format: date-time readOnly: true isBlocked: - description: Заблокирован ли кошелёк? + description: Is the wallet blocked? type: boolean readOnly: true example: false identity: x-rebillyMerge: - - $ref: '#/definitions/IdentityID' + - $ref: "#/definitions/IdentityID" currency: x-rebillyMerge: - - $ref: '#/definitions/CurrencyID' + - $ref: "#/definitions/CurrencyID" metadata: description: | - Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с - данным кошельком + Some non-transparent for system set of data associated with this wallet type: object example: - client_locale: RU_ru + client_locale: en_US externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' + - $ref: "#/definitions/ExternalID" diff --git a/api/wallet/spec/definitions/WalletAccount.yaml b/api/wallet/spec/definitions/WalletAccount.yaml index 1b51b1d..760a7f4 100644 --- a/api/wallet/spec/definitions/WalletAccount.yaml +++ b/api/wallet/spec/definitions/WalletAccount.yaml @@ -1,4 +1,5 @@ -description: Состояние счёта кошелька +--- +description: Wallet account status type: object required: - own @@ -6,15 +7,15 @@ required: properties: own: x-rebillyMerge: - - $ref: '#/definitions/Asset' + - $ref: "#/definitions/Asset" - description: | - Собственные средства + Own funds available: x-rebillyMerge: - - $ref: '#/definitions/Asset' + - $ref: "#/definitions/Asset" - description: | - Доступные к использованию средства, обычно равны собственным средствам - за вычетом сумм всех незавершённых операций + Funds available for use. Usually equal to own funds + minus the sum of all pending transactions example: amount: 1200000 - currency: RUB + currency: USD diff --git a/api/wallet/spec/definitions/WalletGrantRequest.yaml b/api/wallet/spec/definitions/WalletGrantRequest.yaml index ae04cfc..21c084a 100644 --- a/api/wallet/spec/definitions/WalletGrantRequest.yaml +++ b/api/wallet/spec/definitions/WalletGrantRequest.yaml @@ -1,4 +1,5 @@ -description: Запрос на единоразовое право управления средствами на кошельке +--- +description: Request for a one-time permission to manage funds on the wallet type: object required: - asset @@ -6,15 +7,15 @@ required: properties: token: x-rebillyMerge: - - description: Токен, дающий право единоразового управления средствами на кошельке - - $ref: '#/definitions/GrantToken' + - description: A token that gives the permission to one-time management of funds on the wallet + - $ref: "#/definitions/GrantToken" - readOnly: true asset: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Допустимый к использованию объём средств + - $ref: "#/definitions/Asset" + - description: Amount of funds allowed for use validUntil: description: | - Дата и время, до наступления которых выданное право действительно + Date and time until which the granted right is valid type: string format: date-time diff --git a/api/wallet/spec/definitions/WalletID.yaml b/api/wallet/spec/definitions/WalletID.yaml index 148b2ab..c749e88 100644 --- a/api/wallet/spec/definitions/WalletID.yaml +++ b/api/wallet/spec/definitions/WalletID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор кошелька +--- +description: Identifier of the wallet type: string example: "10068321" diff --git a/api/wallet/spec/definitions/WalletName.yaml b/api/wallet/spec/definitions/WalletName.yaml index a96590e..deb2396 100644 --- a/api/wallet/spec/definitions/WalletName.yaml +++ b/api/wallet/spec/definitions/WalletName.yaml @@ -1,3 +1,4 @@ -description: Человекочитаемое название кошелька, по которому его легко узнать +--- +description: Human-readable name of the wallet, by which it is easy to recognize type: string example: Worldwide PHP Awareness Initiative diff --git a/api/wallet/spec/definitions/Webhook.yaml b/api/wallet/spec/definitions/Webhook.yaml index c15c5e3..1ea55cb 100644 --- a/api/wallet/spec/definitions/Webhook.yaml +++ b/api/wallet/spec/definitions/Webhook.yaml @@ -1,3 +1,4 @@ +--- type: object required: - identityID @@ -6,29 +7,29 @@ required: properties: id: description: | - Идентификатор webhook'а + Identifier of the webhook type: string readOnly: true identityID: x-rebillyMerge: - - $ref: '#/definitions/IdentityID' + - $ref: "#/definitions/IdentityID" active: description: | - Включена ли в данный момент доставка оповещений? + Is notification delivery currently enabled? type: boolean readOnly: true scope: - $ref: '#/definitions/WebhookScope' + $ref: "#/definitions/WebhookScope" url: description: | - URL, на который будут поступать оповещения о произошедших событиях + The URL that will receive notifications of events that have occurred type: string format: uri maxLength: 1000 publicKey: description: | - Содержимое публичного ключа, служащего для проверки авторитативности - приходящих на `url` оповещений + The content of the public key used to check the authoritativeness of + notifications coming to `url` type: string format: hexadecimal readOnly: true diff --git a/api/wallet/spec/definitions/WebhookScope.yaml b/api/wallet/spec/definitions/WebhookScope.yaml index 31de853..3c8a7ff 100644 --- a/api/wallet/spec/definitions/WebhookScope.yaml +++ b/api/wallet/spec/definitions/WebhookScope.yaml @@ -1,13 +1,14 @@ +--- description: | - Область охвата webhook'а, ограничивающая набор типов событий, по которым - следует отправлять оповещения + The scope of a webhook, limiting the set of event types, + for which the notifications should be sent type: object discriminator: topic required: - topic properties: topic: - description: Предмет оповещений + description: Subject of notifications type: string enum: - WithdrawalsTopic diff --git a/api/wallet/spec/definitions/Withdrawal.yaml b/api/wallet/spec/definitions/Withdrawal.yaml index 47f48e3..0cc55c0 100644 --- a/api/wallet/spec/definitions/Withdrawal.yaml +++ b/api/wallet/spec/definitions/Withdrawal.yaml @@ -1,4 +1,5 @@ -description: Данные вывода денежных средств +--- +description: Funds withdrawal data allOf: - type: object required: @@ -8,35 +9,34 @@ allOf: properties: id: x-rebillyMerge: - - $ref: '#/definitions/WithdrawalID' + - $ref: "#/definitions/WithdrawalID" - readOnly: true createdAt: - description: Дата и время запуска вывода + description: Date and time the withdrawal started type: string format: date-time readOnly: true wallet: x-rebillyMerge: - - $ref: '#/definitions/WalletID' + - $ref: "#/definitions/WalletID" destination: x-rebillyMerge: - - $ref: '#/definitions/DestinationID' + - $ref: "#/definitions/DestinationID" body: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Объём средств, которые необходимо вывести + - $ref: "#/definitions/Asset" + - description: Amount of funds to be withdrawn fee: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Сумма коммисии + - $ref: "#/definitions/Asset" + - description: Fee amount metadata: description: | - Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с - данным выводом + Some non-transparent for system set of data associated with this withdrawal type: object example: notify_email: iliketrains@example.com externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' - - $ref: '#/definitions/WithdrawalStatus' + - $ref: "#/definitions/ExternalID" + - $ref: "#/definitions/WithdrawalStatus" diff --git a/api/wallet/spec/definitions/WithdrawalEvent.yaml b/api/wallet/spec/definitions/WithdrawalEvent.yaml index 32867cb..c93e5ea 100644 --- a/api/wallet/spec/definitions/WithdrawalEvent.yaml +++ b/api/wallet/spec/definitions/WithdrawalEvent.yaml @@ -1,5 +1,6 @@ +--- description: | - Событие, возникшее в процессе вывода средств + An event that occurred during the funds withdrawal process type: object required: - eventID @@ -7,15 +8,15 @@ required: - changes properties: eventID: - description: Идентификатор события вывода средств + description: Identifier of the funds withdrawal event type: integer format: int32 example: 42 occuredAt: - description: Дата и время возникновения события + description: Date and time the event occurrence type: string format: date-time changes: type: array items: - $ref: '#/definitions/WithdrawalEventChange' + $ref: "#/definitions/WithdrawalEventChange" diff --git a/api/wallet/spec/definitions/WithdrawalEventChange.yaml b/api/wallet/spec/definitions/WithdrawalEventChange.yaml index ed2ecb0..ae17575 100644 --- a/api/wallet/spec/definitions/WithdrawalEventChange.yaml +++ b/api/wallet/spec/definitions/WithdrawalEventChange.yaml @@ -1,12 +1,13 @@ +--- description: | - Изменение, возникшее в процессе вывода средств + Change that occurred in the funds withdrawal process type: object discriminator: type required: - type properties: type: - description: Тип произошедшего изменения + description: The type of change that occurred type: string enum: - WithdrawalStatusChanged diff --git a/api/wallet/spec/definitions/WithdrawalFailure.yaml b/api/wallet/spec/definitions/WithdrawalFailure.yaml index 2d3aa9d..d780890 100644 --- a/api/wallet/spec/definitions/WithdrawalFailure.yaml +++ b/api/wallet/spec/definitions/WithdrawalFailure.yaml @@ -1,9 +1,10 @@ +--- type: object required: - code properties: code: - description: Код ошибки вывода + description: Withdrawal error code type: string subError: - $ref: '#/definitions/SubFailure' + $ref: "#/definitions/SubFailure" diff --git a/api/wallet/spec/definitions/WithdrawalID.yaml b/api/wallet/spec/definitions/WithdrawalID.yaml index 8c69e20..28fb445 100644 --- a/api/wallet/spec/definitions/WithdrawalID.yaml +++ b/api/wallet/spec/definitions/WithdrawalID.yaml @@ -1,3 +1,4 @@ -description: Идентификатор вывода денежных средств +--- +description: Identifier of funds withdrawal type: string example: tZ0jUmlsV0 diff --git a/api/wallet/spec/definitions/WithdrawalMethod.yaml b/api/wallet/spec/definitions/WithdrawalMethod.yaml index 113022c..c4353ba 100644 --- a/api/wallet/spec/definitions/WithdrawalMethod.yaml +++ b/api/wallet/spec/definitions/WithdrawalMethod.yaml @@ -1,12 +1,13 @@ +--- type: object discriminator: method required: - method properties: method: - description: Метод для проведения выплаты + description: Withdrawal method type: string enum: - WithdrawalMethodBankCard - WithdrawalMethodDigitalWallet - - WithdrawalMethodGeneric \ No newline at end of file + - WithdrawalMethodGeneric diff --git a/api/wallet/spec/definitions/WithdrawalMethodBankCard.yaml b/api/wallet/spec/definitions/WithdrawalMethodBankCard.yaml index c71a4fc..b6b0b3a 100644 --- a/api/wallet/spec/definitions/WithdrawalMethodBankCard.yaml +++ b/api/wallet/spec/definitions/WithdrawalMethodBankCard.yaml @@ -1,13 +1,14 @@ +--- type: object allOf: - - $ref: '#/definitions/WithdrawalMethod' + - $ref: "#/definitions/WithdrawalMethod" - type: object required: - paymentSystems properties: paymentSystems: - description: Список платежных систем + description: List of payment systems type: array items: x-rebillyMerge: - - $ref: '#/definitions/BankCardPaymentSystem' \ No newline at end of file + - $ref: "#/definitions/BankCardPaymentSystem" diff --git a/api/wallet/spec/definitions/WithdrawalMethodDigitalWallet.yaml b/api/wallet/spec/definitions/WithdrawalMethodDigitalWallet.yaml index 460cdd7..62bac02 100644 --- a/api/wallet/spec/definitions/WithdrawalMethodDigitalWallet.yaml +++ b/api/wallet/spec/definitions/WithdrawalMethodDigitalWallet.yaml @@ -1,13 +1,14 @@ +--- type: object allOf: - - $ref: '#/definitions/WithdrawalMethod' + - $ref: "#/definitions/WithdrawalMethod" - type: object required: - providers properties: providers: - description: Список провайдеров электронных денежных средств + description: List of digital wallet providers type: array items: x-rebillyMerge: - - $ref: '#/definitions/DigitalWalletProvider' \ No newline at end of file + - $ref: "#/definitions/DigitalWalletProvider" diff --git a/api/wallet/spec/definitions/WithdrawalMethodGeneric.yaml b/api/wallet/spec/definitions/WithdrawalMethodGeneric.yaml index 83f7c57..d39d81b 100644 --- a/api/wallet/spec/definitions/WithdrawalMethodGeneric.yaml +++ b/api/wallet/spec/definitions/WithdrawalMethodGeneric.yaml @@ -1,13 +1,14 @@ +--- type: object allOf: - - $ref: '#/definitions/WithdrawalMethod' + - $ref: "#/definitions/WithdrawalMethod" - type: object required: - providers properties: providers: - description: Список провайдеров сервисов выплат + description: List of withdrawal service providers type: array items: x-rebillyMerge: - - $ref: '#/definitions/GenericProvider' \ No newline at end of file + - $ref: "#/definitions/GenericProvider" diff --git a/api/wallet/spec/definitions/WithdrawalParameters.yaml b/api/wallet/spec/definitions/WithdrawalParameters.yaml index 53a8882..a9a4051 100644 --- a/api/wallet/spec/definitions/WithdrawalParameters.yaml +++ b/api/wallet/spec/definitions/WithdrawalParameters.yaml @@ -1,31 +1,32 @@ -description: Параметры создаваемого вывода +--- +description: Options of generated withdrawal allOf: - - $ref: '#/definitions/Withdrawal' + - $ref: "#/definitions/Withdrawal" - type: object properties: walletGrant: x-rebillyMerge: - - $ref: '#/definitions/GrantToken' + - $ref: "#/definitions/GrantToken" - description: | - Токен, дающий право на списание с кошелька для оплаты вывода. + A token that gives the right to withdraw from the wallet to pay for the withdrawal. - Необходимо предоставить в том случае, если оплата производится засчёт средств _чужого_ - кошелька. Владелец указанного кошелька может - [выдать на это право](#operation/issueWalletGrant). + Must be provided if withdrawal is made at the expense of _foreign_ + wallet. The owner of said wallet can + [issue this right](#operation/issueWalletGrant). destinationGrant: x-rebillyMerge: - - $ref: '#/definitions/GrantToken' + - $ref: "#/definitions/GrantToken" - description: | - Токен, дающий право вывода. + A token that gives the right to withdraw. - Необходимо предоставить в том случае, если вывод производится посредством _чужого_ приёмника - средств. Владелец указанного приёмника может - [выдать на это право](#operation/issueDestinationGrant). + Must be provided if the withdrawal is made through a _foreign_ recipient of + funds. The owner of the specified recipient can + [issue this right](#operation/issueDestinationGrant). quoteToken: x-rebillyMerge: - - $ref: '#/definitions/GrantToken' + - $ref: "#/definitions/GrantToken" - description: | - Котировка, по которой следует проводить вывод средств. + Quote at which funds should be withdrawn. - Должна быть [получена](#operation/createQuote) - заранее для каждой отдельной операции вывода с конвертацией. + Must be [obtained](#operation/createQuote) + in advance for each individual withdrawal operation with conversion. diff --git a/api/wallet/spec/definitions/WithdrawalQuote.yaml b/api/wallet/spec/definitions/WithdrawalQuote.yaml index 14b9591..ebfeda5 100644 --- a/api/wallet/spec/definitions/WithdrawalQuote.yaml +++ b/api/wallet/spec/definitions/WithdrawalQuote.yaml @@ -1,4 +1,5 @@ -description: Данные котировки для вывода +--- +description: Quote data for withdrawal type: object required: - cashFrom @@ -9,28 +10,27 @@ required: properties: cashFrom: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Объём средств в исходной валюте + - $ref: "#/definitions/Asset" + - description: Amount of funds in source currency - readOnly: true cashTo: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Объём средств в конечной валюте + - $ref: "#/definitions/Asset" + - description: Amount of funds in target currency - readOnly: true createdAt: - description: Дата и время получения котировки + description: Date and time the quote was received type: string format: date-time readOnly: true expiresOn: - description: Дата и время окончания действия котировки + description: Quote expiration date and time type: string format: date-time readOnly: true quoteToken: x-rebillyMerge: - - $ref: '#/definitions/GrantToken' + - $ref: "#/definitions/GrantToken" - description: > - Котировка, по которой следует проводить вывод средств. - - Необходимо предоставить при создании вывода с конвертацией + Quote at which funds should be withdrawn. + Must be provided when creating withdrawal with conversion diff --git a/api/wallet/spec/definitions/WithdrawalQuoteParams.yaml b/api/wallet/spec/definitions/WithdrawalQuoteParams.yaml index 0856738..bc85818 100644 --- a/api/wallet/spec/definitions/WithdrawalQuoteParams.yaml +++ b/api/wallet/spec/definitions/WithdrawalQuoteParams.yaml @@ -1,4 +1,5 @@ -description: Параметры котировки для вывода +--- +description: Quote parameters for withdrawal type: object required: - walletID @@ -8,40 +9,34 @@ required: properties: externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' + - $ref: "#/definitions/ExternalID" walletID: x-rebillyMerge: - - $ref: '#/definitions/WalletID' + - $ref: "#/definitions/WalletID" destinationID: x-rebillyMerge: - - $ref: '#/definitions/DestinationID' + - $ref: "#/definitions/DestinationID" currencyFrom: x-rebillyMerge: - - $ref: '#/definitions/CurrencyID' - - description: Код исходной валюты + - $ref: "#/definitions/CurrencyID" + - description: Source currency code currencyTo: x-rebillyMerge: - - $ref: '#/definitions/CurrencyID' - - description: Код конечной валюты + - $ref: "#/definitions/CurrencyID" + - description: Target currency code cash: x-rebillyMerge: - - $ref: '#/definitions/Asset' - - description: Объём средств для получения котировки в одной из валют обмена + - $ref: "#/definitions/Asset" + - description: The amount of funds for receiving a quote in one of the exchange currencies walletGrant: x-rebillyMerge: - - $ref: '#/definitions/GrantToken' + - $ref: "#/definitions/GrantToken" - description: > - Токен, дающий право на списание с кошелька для оплаты вывода. - - Необходимо предоставить в том случае, если оплата производится - засчёт средств _чужого_ кошелька. Владелец указанного кошелька - может [выдать на это право](#operation/issueWalletGrant) + A token that gives the right to withdraw from the wallet to pay for the withdrawal. + It is necessary to provide if the withdrawal is made at the expense of the funds of a _foreign_ wallet. The owner of the specified wallet can [issue this right](#operation/issueWalletGrant) destinationGrant: x-rebillyMerge: - - $ref: '#/definitions/GrantToken' + - $ref: "#/definitions/GrantToken" - description: > - Токен, дающий право вывода. - - Необходимо предоставить в том случае, если вывод производится - посредством _чужого_ приёмника средств. Владелец указанного - приёмника может [выдать на это право](#operation/issueDestinationGrant) + A token that gives the right to withdraw. + Must be provided if the withdrawal is made through a _foreign_ fund recipient. The owner of the specified recipient can [grant this right](#operation/issueDestinationGrant) diff --git a/api/wallet/spec/definitions/WithdrawalStatus.yaml b/api/wallet/spec/definitions/WithdrawalStatus.yaml index d79c5cb..9605992 100644 --- a/api/wallet/spec/definitions/WithdrawalStatus.yaml +++ b/api/wallet/spec/definitions/WithdrawalStatus.yaml @@ -1,15 +1,15 @@ +--- type: object properties: status: description: | - Статус вывода денежных средств. - - | Значение | Пояснение | - | ----------- | ------------------------------------------ | - | `Pending` | Вывод в процессе выполнения | - | `Succeeded` | Вывод средств произведён успешно | - | `Failed` | Вывод средств завершился неудачей | + Withdrawal status. + | Meaning | Explanation | + | ----------- | ------------------------------------ | + | `Pending` | Withdrawal in progress | + | `Succeeded` | Withdrawal completed successfully | + | `Failed` | Withdrawal failed | type: string enum: - Pending @@ -19,8 +19,8 @@ properties: failure: x-rebillyMerge: - description: | - > Если `status` == `Failed` + > If `status` == `Failed` - Пояснение причины неудачи + Explaining the reason for failure readOnly: true - - $ref: '#/definitions/WithdrawalFailure' + - $ref: "#/definitions/WithdrawalFailure" diff --git a/api/wallet/spec/definitions/WithdrawalStatusChanged.yaml b/api/wallet/spec/definitions/WithdrawalStatusChanged.yaml index 6008dd0..09c5e2a 100644 --- a/api/wallet/spec/definitions/WithdrawalStatusChanged.yaml +++ b/api/wallet/spec/definitions/WithdrawalStatusChanged.yaml @@ -1,4 +1,5 @@ -description: Изменение статуса вывода средств +--- +description: Change of withdrawal status allOf: - - $ref: '#/definitions/WithdrawalEventChange' - - $ref: '#/definitions/WithdrawalStatus' + - $ref: "#/definitions/WithdrawalEventChange" + - $ref: "#/definitions/WithdrawalStatus" diff --git a/api/wallet/spec/definitions/WithdrawalsTopic.yaml b/api/wallet/spec/definitions/WithdrawalsTopic.yaml index 948ff5b..24457aa 100644 --- a/api/wallet/spec/definitions/WithdrawalsTopic.yaml +++ b/api/wallet/spec/definitions/WithdrawalsTopic.yaml @@ -1,16 +1,17 @@ +--- description: | - Область охвата, включающая события по выплатам в рамках определённого кошелька + Scope that includes withdrawal events within a specific wallet allOf: - - $ref: '#/definitions/WebhookScope' + - $ref: "#/definitions/WebhookScope" - type: object required: - eventTypes properties: walletID: x-rebillyMerge: - - $ref: '#/definitions/WalletID' + - $ref: "#/definitions/WalletID" eventTypes: - description: Набор типов событий выплаты, о которых следует оповещать + description: Set of withdrawal event types to be notified about type: array items: type: string diff --git a/api/wallet/spec/definitions/Zcash.yaml b/api/wallet/spec/definitions/Zcash.yaml deleted file mode 100644 index 671770d..0000000 --- a/api/wallet/spec/definitions/Zcash.yaml +++ /dev/null @@ -1,2 +0,0 @@ -allOf: - - $ref: '#/definitions/CryptoWallet' diff --git a/api/wallet/spec/definitions/errors/InvalidOperationParameters.yaml b/api/wallet/spec/definitions/errors/InvalidOperationParameters.yaml index 9a5d055..cb6c5b7 100644 --- a/api/wallet/spec/definitions/errors/InvalidOperationParameters.yaml +++ b/api/wallet/spec/definitions/errors/InvalidOperationParameters.yaml @@ -1,4 +1,5 @@ -description: Неверные входные данные для операции +--- +description: Invalid input data for operation type: object properties: message: diff --git a/api/wallet/spec/definitions/imports/ConflictRequest.yaml b/api/wallet/spec/definitions/imports/ConflictRequest.yaml index bda1dbd..c72c591 100644 --- a/api/wallet/spec/definitions/imports/ConflictRequest.yaml +++ b/api/wallet/spec/definitions/imports/ConflictRequest.yaml @@ -1,12 +1,13 @@ +--- type: object properties: externalID: x-rebillyMerge: - - $ref: '#/definitions/ExternalID' - - description: Переданное значение `externalID`, для которого обнаружен конфликт параметров запроса + - $ref: "#/definitions/ExternalID" + - description: The passed value of `externalID` for which a request parameter conflict was detected id: - description: Идентификатор сущности, созданной предыдущим запросом с указанным `externalID` + description: Identifier of the entity, created by a previous query with the specified `externalID' type: string message: - description: Человекочитаемое описание ошибки + description: Human-readable description of the error type: string diff --git a/api/wallet/spec/paths/currencies@{currencyID}.yaml b/api/wallet/spec/paths/currencies@{currencyID}.yaml index 695e113..d91aa67 100644 --- a/api/wallet/spec/paths/currencies@{currencyID}.yaml +++ b/api/wallet/spec/paths/currencies@{currencyID}.yaml @@ -1,27 +1,28 @@ +--- get: operationId: getCurrency - summary: Получить описание валюты + summary: Get currency description tags: - Currencies parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: currencyID in: path description: | - Валюта, символьный код согласно [ISO + Currency, character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). type: string required: true - pattern: '^[A-Za-z]{3}$' + pattern: "^[A-Za-z]{3}$" responses: - '200': - description: Валюта найдена + "200": + description: Currency found schema: - $ref: '#/definitions/Currency' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Currency" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/deposit-adjustments.yaml b/api/wallet/spec/paths/deposit-adjustments.yaml index ce75111..fd37c23 100644 --- a/api/wallet/spec/paths/deposit-adjustments.yaml +++ b/api/wallet/spec/paths/deposit-adjustments.yaml @@ -1,35 +1,36 @@ +--- get: operationId: listDepositAdjustments - summary: Поиск корректировок + summary: Finding adjustments tags: - Deposits parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: walletID in: query - description: Идентификатор кошелька + description: Wallet identifier type: string maxLength: 40 minLength: 1 required: false - name: identityID in: query - description: Идентификатор личности владельца + description: Identifier of the owner's identity type: string maxLength: 40 minLength: 1 required: false - name: depositID in: query - description: Идентификатор ввода денежных средств + description: Identifier of the input of funds type: string required: false maxLength: 50 minLength: 1 - name: sourceID in: query - description: Идентификатор источника средств + description: Identifier of the fund source type: string maxLength: 40 minLength: 1 @@ -44,40 +45,40 @@ get: required: false - name: createdAtFrom in: query - description: Дата создания с + description: Creation date from type: string format: date-time required: false - name: createdAtTo in: query - description: Дата создания до + description: Creation date to type: string format: date-time required: false - - $ref: '#/parameters/amountFrom' - - $ref: '#/parameters/amountTo' - - $ref: '#/parameters/currencyID' - - $ref: '#/parameters/limit' + - $ref: "#/parameters/amountFrom" + - $ref: "#/parameters/amountTo" + - $ref: "#/parameters/currencyID" + - $ref: "#/parameters/limit" - x-rebillyMerge: - - name: continuationToken - in: query - required: false - - $ref: '#/definitions/ContinuationToken' + - name: continuationToken + in: query + required: false + - $ref: "#/definitions/ContinuationToken" responses: - '200': - description: Результат поиска + "200": + description: Search results schema: type: object properties: continuationToken: x-rebillyMerge: - - $ref: '#/definitions/ContinuationToken' + - $ref: "#/definitions/ContinuationToken" result: - description: Найденные корректировки + description: Found adjustments type: array items: - $ref: '#/definitions/DepositAdjustment' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/DepositAdjustment" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/deposit-reverts.yaml b/api/wallet/spec/paths/deposit-reverts.yaml index b07bbc2..0edf3c9 100644 --- a/api/wallet/spec/paths/deposit-reverts.yaml +++ b/api/wallet/spec/paths/deposit-reverts.yaml @@ -1,35 +1,36 @@ +--- get: operationId: listDepositReverts - summary: Поиск отмен + summary: Search for reverts tags: - Deposits parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: walletID in: query - description: Идентификатор кошелька + description: Identifier of the wallet type: string maxLength: 40 minLength: 1 required: false - name: identityID in: query - description: Идентификатор личности владельца + description: Identifier of the owner's identity type: string maxLength: 40 minLength: 1 required: false - name: depositID in: query - description: Идентификатор ввода денежных средств + description: Identifier of the input of funds type: string required: false maxLength: 50 minLength: 1 - name: sourceID in: query - description: Идентификатор источника средств + description: Identifier of the source of funds type: string maxLength: 40 minLength: 1 @@ -44,40 +45,40 @@ get: required: false - name: createdAtFrom in: query - description: Дата создания с + description: Creation date from type: string format: date-time required: false - name: createdAtTo in: query - description: Дата создания до + description: Creation date to type: string format: date-time required: false - - $ref: '#/parameters/amountFrom' - - $ref: '#/parameters/amountTo' - - $ref: '#/parameters/currencyID' - - $ref: '#/parameters/limit' + - $ref: "#/parameters/amountFrom" + - $ref: "#/parameters/amountTo" + - $ref: "#/parameters/currencyID" + - $ref: "#/parameters/limit" - x-rebillyMerge: - - name: continuationToken - in: query - required: false - - $ref: '#/definitions/ContinuationToken' + - name: continuationToken + in: query + required: false + - $ref: "#/definitions/ContinuationToken" responses: - '200': - description: Результат поиска + "200": + description: Search result schema: type: object properties: continuationToken: x-rebillyMerge: - - $ref: '#/definitions/ContinuationToken' + - $ref: "#/definitions/ContinuationToken" result: - description: Найденные отмены + description: Found reverts type: array items: - $ref: '#/definitions/DepositRevert' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/DepositRevert" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/deposits.yaml b/api/wallet/spec/paths/deposits.yaml index a3aba05..5752f2a 100644 --- a/api/wallet/spec/paths/deposits.yaml +++ b/api/wallet/spec/paths/deposits.yaml @@ -1,35 +1,36 @@ +--- get: operationId: listDeposits - summary: Поиск пополнений + summary: Search for deposits tags: - Deposits parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: walletID in: query - description: Идентификатор кошелька + description: Identifier of the wallet type: string maxLength: 40 minLength: 1 required: false - name: identityID in: query - description: Идентификатор личности владельца + description: Identifier of the owner's identity type: string maxLength: 40 minLength: 1 required: false - name: depositID in: query - description: Идентификатор ввода денежных средств + description: Identifier of the deposit type: string required: false maxLength: 50 minLength: 1 - name: sourceID in: query - description: Идентификатор источника средств + description: Identifier of the funds source type: string maxLength: 40 minLength: 1 @@ -44,13 +45,13 @@ get: required: false - name: createdAtFrom in: query - description: Дата создания с + description: Creation date from type: string format: date-time required: false - name: createdAtTo in: query - description: Дата создания до + description: Creation date to type: string format: date-time required: false @@ -62,30 +63,30 @@ get: - Partial - Full required: false - - $ref: '#/parameters/amountFrom' - - $ref: '#/parameters/amountTo' - - $ref: '#/parameters/currencyID' - - $ref: '#/parameters/limit' + - $ref: "#/parameters/amountFrom" + - $ref: "#/parameters/amountTo" + - $ref: "#/parameters/currencyID" + - $ref: "#/parameters/limit" - x-rebillyMerge: - - name: continuationToken - in: query - required: false - - $ref: '#/definitions/ContinuationToken' + - name: continuationToken + in: query + required: false + - $ref: "#/definitions/ContinuationToken" responses: - '200': - description: Результат поиска + "200": + description: Search results schema: type: object properties: continuationToken: x-rebillyMerge: - - $ref: '#/definitions/ContinuationToken' + - $ref: "#/definitions/ContinuationToken" result: - description: Найденные пополнения + description: Found deposits type: array items: - $ref: '#/definitions/Deposit' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Deposit" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/destinations.yaml b/api/wallet/spec/paths/destinations.yaml index f68f3a8..f750ae6 100644 --- a/api/wallet/spec/paths/destinations.yaml +++ b/api/wallet/spec/paths/destinations.yaml @@ -1,75 +1,75 @@ +--- get: operationId: listDestinations - summary: Перечислить приёмники средств + summary: List of destinations tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: identityID - description: Идентификатор личности владельца + description: Identifier of the owner's idenity in: query required: false type: string maxLength: 40 minLength: 1 - - $ref: '#/parameters/currencyID' - - $ref: '#/parameters/limit' + - $ref: "#/parameters/currencyID" + - $ref: "#/parameters/limit" - x-rebillyMerge: - - name: continuationToken - in: query - required: false - - $ref: '#/definitions/ContinuationToken' + - name: continuationToken + in: query + required: false + - $ref: "#/definitions/ContinuationToken" responses: - '200': - description: Результат поиска + "200": + description: Search result schema: type: object properties: continuationToken: x-rebillyMerge: - - $ref: '#/definitions/ContinuationToken' + - $ref: "#/definitions/ContinuationToken" result: - description: Найденные приёмники средств + description: Destinations found type: array items: - $ref: '#/definitions/Destination' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - + $ref: "#/definitions/Destination" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" post: operationId: createDestination - summary: Завести приёмник средств + summary: Start a destination creation tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: destination - description: Данные приёмника средств + description: Destination data in: body required: true schema: - $ref: '#/definitions/Destination' + $ref: "#/definitions/Destination" responses: - '201': - description: Приёмник средств создан + "201": + description: Destination created headers: Location: - description: URI созданного приёмника средств + description: The URI of the created destination type: string format: uri schema: - $ref: '#/definitions/Destination' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '409': - $ref: '#/responses/ConflictRequest' - '422': - description: Неверные данные приёмника средств + $ref: "#/definitions/Destination" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "409": + $ref: "#/responses/ConflictRequest" + "422": + description: Incorrect destination data schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/destinations@{destinationID}.yaml b/api/wallet/spec/paths/destinations@{destinationID}.yaml index 6489e3c..54be7d7 100644 --- a/api/wallet/spec/paths/destinations@{destinationID}.yaml +++ b/api/wallet/spec/paths/destinations@{destinationID}.yaml @@ -1,20 +1,21 @@ +--- get: operationId: getDestination - summary: Получить приёмник средств + summary: Get a specific destination tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/destinationID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/destinationID" responses: - '200': - description: Приёмник средств найден + "200": + description: Destination found schema: - $ref: '#/definitions/Destination' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' + $ref: "#/definitions/Destination" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" diff --git a/api/wallet/spec/paths/destinations@{destinationID}@grants.yaml b/api/wallet/spec/paths/destinations@{destinationID}@grants.yaml index 234774d..1cdacd1 100644 --- a/api/wallet/spec/paths/destinations@{destinationID}@grants.yaml +++ b/api/wallet/spec/paths/destinations@{destinationID}@grants.yaml @@ -1,30 +1,31 @@ +--- post: operationId: issueDestinationGrant - summary: Выдать право управления приёмником средств + summary: Grant the right to manage the destinations tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/destinationID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/destinationID" - name: request - description: Запрос на право управления приёмником средств + description: Request for the right to manage the destinations in: body required: true schema: - $ref: '#/definitions/DestinationGrantRequest' + $ref: "#/definitions/DestinationGrantRequest" responses: - '201': - description: Право выдано + "201": + description: The right is granted schema: - $ref: '#/definitions/DestinationGrantRequest' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '422': - description: Неверные данные для выдачи + $ref: "#/definitions/DestinationGrantRequest" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "422": + description: Invalid data for issuance schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/external-ids@destinations@{externalID}.yaml b/api/wallet/spec/paths/external-ids@destinations@{externalID}.yaml index e1acc1e..59a2dcc 100644 --- a/api/wallet/spec/paths/external-ids@destinations@{externalID}.yaml +++ b/api/wallet/spec/paths/external-ids@destinations@{externalID}.yaml @@ -1,20 +1,21 @@ +--- get: operationId: getDestinationByExternalID - summary: Получить приёмник средств по внешнему идентификатору + summary: Get a fund recipient by external identifier tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/externalID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/externalID" responses: - '200': - description: Приёмник средств найден + "200": + description: Fund recipient found schema: - $ref: '#/definitions/Destination' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' + $ref: "#/definitions/Destination" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" diff --git a/api/wallet/spec/paths/external-ids@withdrawals@{externalID}.yaml b/api/wallet/spec/paths/external-ids@withdrawals@{externalID}.yaml index 9cfeac9..054bf74 100644 --- a/api/wallet/spec/paths/external-ids@withdrawals@{externalID}.yaml +++ b/api/wallet/spec/paths/external-ids@withdrawals@{externalID}.yaml @@ -1,20 +1,21 @@ +--- get: operationId: getWithdrawalByExternalID - summary: Получить состояние вывода средств по внешнему идентификатору + summary: Get withdrawal status by external identifier tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/externalID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/externalID" responses: - '200': - description: Вывод найден + "200": + description: Withdrawal found schema: - $ref: '#/definitions/Withdrawal' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' + $ref: "#/definitions/Withdrawal" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" diff --git a/api/wallet/spec/paths/external@wallets.yaml b/api/wallet/spec/paths/external@wallets.yaml index afd1a56..5383f87 100644 --- a/api/wallet/spec/paths/external@wallets.yaml +++ b/api/wallet/spec/paths/external@wallets.yaml @@ -1,26 +1,27 @@ +--- get: - summary: Получить кошелёк по указанному внешнему идентификатору + summary: Get wallet by specified external identifier operationId: getWalletByExternalID tags: - Wallets parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: externalID - description: Внешний идентификатор кошелька + description: External wallet identifier in: query required: true type: string maxLength: 40 minLength: 1 responses: - '200': - description: Данные кошелька + "200": + description: Wallet details schema: - $ref: '#/definitions/Wallet' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Wallet" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/files@{fileID}@download.yaml b/api/wallet/spec/paths/files@{fileID}@download.yaml index ebb16ef..0bf9570 100644 --- a/api/wallet/spec/paths/files@{fileID}@download.yaml +++ b/api/wallet/spec/paths/files@{fileID}@download.yaml @@ -1,20 +1,21 @@ +--- post: - description: Получить ссылку для скачивания файла + description: Get a link to download a file tags: - Downloads operationId: downloadFile parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/fileID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/fileID" responses: - '201': - description: Данные для получения файла + "201": + description: Data to get file schema: - $ref: '#/definitions/FileDownload' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/FileDownload" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/identities.yaml b/api/wallet/spec/paths/identities.yaml index ad15f66..7e64832 100644 --- a/api/wallet/spec/paths/identities.yaml +++ b/api/wallet/spec/paths/identities.yaml @@ -1,73 +1,73 @@ +--- get: operationId: listIdentities - summary: Перечислить личности владельцев + summary: List the identities of the owners tags: - Identities parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: providerID - description: Идентификатор провайдера услуг + description: Service provider's identifier in: query required: false type: string maxLength: 40 minLength: 1 - x-rebillyMerge: - - name: continuationToken - in: query - required: false - - $ref: '#/definitions/ContinuationToken' + - name: continuationToken + in: query + required: false + - $ref: "#/definitions/ContinuationToken" responses: - '200': - description: Результат поиска + "200": + description: Search result schema: type: object properties: continuationToken: x-rebillyMerge: - - $ref: '#/definitions/ContinuationToken' + - $ref: "#/definitions/ContinuationToken" result: - description: Найденные личности + description: Identities found type: array items: - $ref: '#/definitions/Identity' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - + $ref: "#/definitions/Identity" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" post: operationId: createIdentity - summary: Создать личность владельца + summary: Create owner identity tags: - Identities parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: identity - description: Данные создаваемой личности + description: Data of the identity created in: body required: true schema: - $ref: '#/definitions/Identity' + $ref: "#/definitions/Identity" responses: - '201': - description: Личность владельца создана + "201": + description: Owner identity created headers: Location: - description: URI созданной личности + description: Created identity URI type: string format: uri schema: - $ref: '#/definitions/Identity' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '409': - $ref: '#/responses/ConflictRequest' - '422': - description: Неверные данные личности владельца + $ref: "#/definitions/Identity" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "409": + $ref: "#/responses/ConflictRequest" + "422": + description: Invalid owner identity data schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/identities@{identityID}.yaml b/api/wallet/spec/paths/identities@{identityID}.yaml index fae89db..66ae53c 100644 --- a/api/wallet/spec/paths/identities@{identityID}.yaml +++ b/api/wallet/spec/paths/identities@{identityID}.yaml @@ -1,20 +1,21 @@ +--- get: operationId: getIdentity - summary: Получить данные личности владельца + summary: Get the owner's identity tags: - Identities parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/identityID" responses: - '200': - description: Личность владельца найдена + "200": + description: Owner's identity found schema: - $ref: '#/definitions/Identity' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Identity" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/identities@{identityID}@reports.yaml b/api/wallet/spec/paths/identities@{identityID}@reports.yaml index 8c6298e..03c3d3c 100644 --- a/api/wallet/spec/paths/identities@{identityID}@reports.yaml +++ b/api/wallet/spec/paths/identities@{identityID}@reports.yaml @@ -1,54 +1,54 @@ +--- post: - description: Сгенерировать отчет с указанным типом по личности владельца за указанный промежуток времени + description: Generate a report with the specified type on the identity of the owner for the specified period of time tags: - Reports operationId: createReport parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/identityID" - name: ReportParams in: body - description: Параметры генерации отчета + description: Report generation options required: true schema: - $ref: '#/definitions/ReportParams' + $ref: "#/definitions/ReportParams" responses: - '201': - description: Отчет создан + "201": + description: Report created schema: - $ref: '#/definitions/Report' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - + $ref: "#/definitions/Report" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" get: - description: Получить список отчетов по личности владельца за период + description: Get a list of owner identity reports for a period tags: - Reports operationId: getReports parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' - - $ref: '#/parameters/fromTime' - - $ref: '#/parameters/toTime' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/identityID" + - $ref: "#/parameters/fromTime" + - $ref: "#/parameters/toTime" - name: type in: query - description: Тип получаемых отчетов + description: Type of reports received required: false type: string enum: - withdrawalRegistry responses: - '200': - description: Найденные отчеты + "200": + description: Reports found schema: type: array items: - $ref: '#/definitions/Report' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Report" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/identities@{identityID}@reports@{reportID}.yaml b/api/wallet/spec/paths/identities@{identityID}@reports@{reportID}.yaml index 99b4940..f6d1055 100644 --- a/api/wallet/spec/paths/identities@{identityID}@reports@{reportID}.yaml +++ b/api/wallet/spec/paths/identities@{identityID}@reports@{reportID}.yaml @@ -1,21 +1,22 @@ +--- get: - description: Получить отчет по данному идентификатору + description: Get a report for a given identifier tags: - Reports operationId: getReport parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' - - $ref: '#/parameters/reportID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/identityID" + - $ref: "#/parameters/reportID" responses: - '200': - description: Найденный отчет + "200": + description: Report found schema: - $ref: '#/definitions/Report' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Report" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/identities@{identityID}@withdrawal-methods.yaml b/api/wallet/spec/paths/identities@{identityID}@withdrawal-methods.yaml index f0777e2..d84eddc 100644 --- a/api/wallet/spec/paths/identities@{identityID}@withdrawal-methods.yaml +++ b/api/wallet/spec/paths/identities@{identityID}@withdrawal-methods.yaml @@ -1,23 +1,24 @@ +--- get: - summary: Получить выплатные методы доступные по личности владельца + summary: Get withdrawal methods available by owner identity tags: - Identities operationId: getWithdrawalMethods parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/identityID" responses: - '200': - description: Найденные методы + "200": + description: Methods found schema: type: object properties: methods: type: array items: - $ref: '#/definitions/WithdrawalMethod' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/WithdrawalMethod" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/providers.yaml b/api/wallet/spec/paths/providers.yaml index 46e3f51..d51018b 100644 --- a/api/wallet/spec/paths/providers.yaml +++ b/api/wallet/spec/paths/providers.yaml @@ -1,20 +1,21 @@ +--- get: operationId: listProviders - summary: Перечислить доступных провайдеров + summary: List available providers tags: - Providers parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/residence' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/residence" responses: - '200': - description: Провайдеры найдены + "200": + description: Providers found schema: type: array items: - $ref: '#/definitions/Provider' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Provider" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/providers@{providerID}.yaml b/api/wallet/spec/paths/providers@{providerID}.yaml index d78a75f..c6cc3c1 100644 --- a/api/wallet/spec/paths/providers@{providerID}.yaml +++ b/api/wallet/spec/paths/providers@{providerID}.yaml @@ -1,20 +1,21 @@ +--- get: operationId: getProvider - summary: Получить данные провайдера + summary: Get provider details tags: - Providers parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/providerID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/providerID" responses: - '200': - description: Провайдер найден + "200": + description: Provider found schema: - $ref: '#/definitions/Provider' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Provider" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/residences@{residence}.yaml b/api/wallet/spec/paths/residences@{residence}.yaml index 897a0ec..4597cef 100644 --- a/api/wallet/spec/paths/residences@{residence}.yaml +++ b/api/wallet/spec/paths/residences@{residence}.yaml @@ -1,27 +1,28 @@ +--- get: operationId: getResidence - summary: Получить описание региона резиденции + summary: Get a description of the residence region tags: - Residences parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: residence in: path description: | - Резиденция, в рамках которой производится оказание услуг, - код страны или региона по стандарту [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) + The residence within which the services are provided, + [ISO 3166-1] country or region code (https://en.wikipedia.org/wiki/ISO_3166-1) type: string - pattern: '^[A-Za-z]{3}$' + pattern: "^[A-Za-z]{3}$" required: true responses: - '200': - description: Регион резиденции найден + "200": + description: Residence region found schema: - $ref: '#/definitions/Residence' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Residence" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/w2w@transfers.yaml b/api/wallet/spec/paths/w2w@transfers.yaml index 64af03b..06cdf93 100644 --- a/api/wallet/spec/paths/w2w@transfers.yaml +++ b/api/wallet/spec/paths/w2w@transfers.yaml @@ -1,33 +1,34 @@ +--- post: - description: Создать перевод + description: Create a transfer tags: - W2W operationId: createW2WTransfer parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: transferParams in: body - description: 'Параметры создания перевода' + description: "Transfer creation options" schema: - $ref: '#/definitions/W2WTransferParameters' + $ref: "#/definitions/W2WTransferParameters" responses: - '202': - description: Перевод запущен + "202": + description: Transfer started headers: Location: - description: URI запущенного перевода + description: URI of the transfer started type: string format: uri schema: - $ref: '#/definitions/W2WTransfer' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '409': - $ref: '#/responses/ConflictRequest' - '422': - description: Неверные входные данные для перевода + $ref: "#/definitions/W2WTransfer" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "409": + $ref: "#/responses/ConflictRequest" + "422": + description: Invalid transfer input data schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/w2w@transfers@{w2wTransferID}.yaml b/api/wallet/spec/paths/w2w@transfers@{w2wTransferID}.yaml index d4a48af..7328f36 100644 --- a/api/wallet/spec/paths/w2w@transfers@{w2wTransferID}.yaml +++ b/api/wallet/spec/paths/w2w@transfers@{w2wTransferID}.yaml @@ -1,20 +1,21 @@ +--- get: - description: Получить состояние перевода. + description: Get the transfer status. tags: - W2W operationId: getW2WTransfer parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/w2wTransferID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/w2wTransferID" responses: - '200': - description: Найденный перевод + "200": + description: Transfer found schema: - $ref: '#/definitions/W2WTransfer' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' + $ref: "#/definitions/W2WTransfer" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" diff --git a/api/wallet/spec/paths/wallets.yaml b/api/wallet/spec/paths/wallets.yaml index bc3f546..4f75f00 100644 --- a/api/wallet/spec/paths/wallets.yaml +++ b/api/wallet/spec/paths/wallets.yaml @@ -1,75 +1,75 @@ +--- get: operationId: listWallets - summary: Перечислить кошельки + summary: List the wallets tags: - Wallets parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: identityID - description: Идентификатор личности владельца + description: Identifier of owner's identity in: query required: false type: string maxLength: 40 minLength: 1 - - $ref: '#/parameters/currencyID' - - $ref: '#/parameters/limit' + - $ref: "#/parameters/currencyID" + - $ref: "#/parameters/limit" - x-rebillyMerge: - - name: continuationToken - in: query - required: false - - $ref: '#/definitions/ContinuationToken' + - name: continuationToken + in: query + required: false + - $ref: "#/definitions/ContinuationToken" responses: - '200': - description: Результат поиска + "200": + description: Search result schema: type: object properties: continuationToken: x-rebillyMerge: - - $ref: '#/definitions/ContinuationToken' + - $ref: "#/definitions/ContinuationToken" result: - description: Найденные кошельки + description: Wallets found type: array items: - $ref: '#/definitions/Wallet' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - + $ref: "#/definitions/Wallet" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" post: operationId: createWallet - summary: Завести новый кошелёк + summary: Create a new wallet tags: - Wallets parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: wallet - description: Данные создаваемого кошелька + description: Data of the created wallet in: body required: true schema: - $ref: '#/definitions/Wallet' + $ref: "#/definitions/Wallet" responses: - '201': - description: Кошелёк создан + "201": + description: Wallet created headers: Location: - description: URI созданного кошелька + description: URI of the wallet created type: string format: uri schema: - $ref: '#/definitions/Wallet' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '409': - $ref: '#/responses/ConflictRequest' - '422': - description: Неверные данные кошелька + $ref: "#/definitions/Wallet" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "409": + $ref: "#/responses/ConflictRequest" + "422": + description: Invalid data of the wallet schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/wallets@{walletID}.yaml b/api/wallet/spec/paths/wallets@{walletID}.yaml index fa32973..cdf6d93 100644 --- a/api/wallet/spec/paths/wallets@{walletID}.yaml +++ b/api/wallet/spec/paths/wallets@{walletID}.yaml @@ -1,20 +1,21 @@ +--- get: operationId: getWallet - summary: Получить данные кошелька + summary: Get wallet data tags: - Wallets parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/walletID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/walletID" responses: - '200': - description: Кошелёк найден + "200": + description: Wallet found schema: - $ref: '#/definitions/Wallet' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/Wallet" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/wallets@{walletID}@account.yaml b/api/wallet/spec/paths/wallets@{walletID}@account.yaml index 0aa5444..890bb6f 100644 --- a/api/wallet/spec/paths/wallets@{walletID}@account.yaml +++ b/api/wallet/spec/paths/wallets@{walletID}@account.yaml @@ -1,20 +1,21 @@ +--- get: operationId: getWalletAccount - summary: Получить состояние счёта + summary: Get account status tags: - Wallets parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/walletID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/walletID" responses: - '200': - description: Счёт кошелька получен + "200": + description: Wallet account received schema: - $ref: '#/definitions/WalletAccount' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' + $ref: "#/definitions/WalletAccount" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" diff --git a/api/wallet/spec/paths/wallets@{walletID}@grants.yaml b/api/wallet/spec/paths/wallets@{walletID}@grants.yaml index efd5e6f..26fad8e 100644 --- a/api/wallet/spec/paths/wallets@{walletID}@grants.yaml +++ b/api/wallet/spec/paths/wallets@{walletID}@grants.yaml @@ -1,30 +1,31 @@ +--- post: operationId: issueWalletGrant - summary: Выдать право управления средствами + summary: Grant the right to manage funds tags: - Wallets parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/walletID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/walletID" - name: request - description: Запрос на право управления средствами на кошельке + description: Request for the right to manage funds on the wallet in: body required: true schema: - $ref: '#/definitions/WalletGrantRequest' + $ref: "#/definitions/WalletGrantRequest" responses: - '201': - description: Единоразовое право выдано + "201": + description: Single right granted schema: - $ref: '#/definitions/WalletGrantRequest' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '422': - description: Неверные данные для выдачи + $ref: "#/definitions/WalletGrantRequest" + "404": + $ref: "#/responses/NotFound" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "422": + description: Invalid data for issuance schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/webhooks.yaml b/api/wallet/spec/paths/webhooks.yaml index b390369..d29a9a3 100644 --- a/api/wallet/spec/paths/webhooks.yaml +++ b/api/wallet/spec/paths/webhooks.yaml @@ -1,52 +1,52 @@ +--- post: - description: Установить новый webhook. + description: Create a new webhook. tags: - Webhooks operationId: createWebhook parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: webhookParams - description: Параметры устанавливаемого webhook'а + description: Parameters of the created webhook in: body required: true schema: - $ref: '#/definitions/Webhook' + $ref: "#/definitions/Webhook" responses: - '201': - description: Webhook установлен + "201": + description: Webhook created schema: - $ref: '#/definitions/Webhook' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '422': - description: Неверные данные для создания webhook'а + $ref: "#/definitions/Webhook" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "422": + description: Invalid data for webhook creation schema: - $ref: '#/definitions/InvalidOperationParameters' - + $ref: "#/definitions/InvalidOperationParameters" get: - description: Получить набор установленных webhook'ов. + description: Get list of existing webhooks. tags: - Webhooks operationId: getWebhooks parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/queryIdentityID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/queryIdentityID" responses: - '200': - description: Набор webhook'ов + "200": + description: A list of webhooks schema: type: array items: - $ref: '#/definitions/Webhook' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '422': - description: Неверные данные для получения webhook'ов + $ref: "#/definitions/Webhook" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "422": + description: Invalid data for obtaining webhooks schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/webhooks@{webhookID}.yaml b/api/wallet/spec/paths/webhooks@{webhookID}.yaml index e8a29ad..f31abdb 100644 --- a/api/wallet/spec/paths/webhooks@{webhookID}.yaml +++ b/api/wallet/spec/paths/webhooks@{webhookID}.yaml @@ -1,49 +1,49 @@ +--- get: - description: Получить webhook по его идентификатору. + description: Get a webhook by its identifier. tags: - Webhooks operationId: getWebhookByID parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/webhookID' - - $ref: '#/parameters/queryIdentityID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/webhookID" + - $ref: "#/parameters/queryIdentityID" responses: - '200': - description: Данные webhook'а + "200": + description: Webhook's data schema: - $ref: '#/definitions/Webhook' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' - '422': - description: Неверные данные для получения webhook'а + $ref: "#/definitions/Webhook" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" + "422": + description: Invalid data for obtaining a webhook schema: - $ref: '#/definitions/InvalidOperationParameters' - + $ref: "#/definitions/InvalidOperationParameters" delete: - description: Снять указанный webhook. + description: Remove the specified webhook. tags: - Webhooks operationId: deleteWebhookByID parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/webhookID' - - $ref: '#/parameters/queryIdentityID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/webhookID" + - $ref: "#/parameters/queryIdentityID" responses: - '204': - description: Webhook успешно снят - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' - '422': - description: Неверные данные для снятия webhook'а + "204": + description: Webhook successfully removed + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" + "422": + description: Invalid data for removing webhook schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/withdrawal-quotes.yaml b/api/wallet/spec/paths/withdrawal-quotes.yaml index b70c5f0..76a7cd2 100644 --- a/api/wallet/spec/paths/withdrawal-quotes.yaml +++ b/api/wallet/spec/paths/withdrawal-quotes.yaml @@ -1,30 +1,31 @@ +--- post: operationId: createQuote - summary: Подготовка котировки - description: Фиксация курса обмена валют для проведения выплаты с конвертацией + summary: Quote preparation + description: Fixing the exchange rate for making withdrawals with conversion tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: withdrawalQuoteParams - description: Данные котировки для вывода + description: Quote data for withdrawal in: body required: true schema: - $ref: '#/definitions/WithdrawalQuoteParams' + $ref: "#/definitions/WithdrawalQuoteParams" responses: - '202': - description: Полученная котировка + "202": + description: Received quote schema: - $ref: '#/definitions/WithdrawalQuote' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '409': - $ref: '#/responses/ConflictRequest' - '422': - description: Неверные данные для получения котировки + $ref: "#/definitions/WithdrawalQuote" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "409": + $ref: "#/responses/ConflictRequest" + "422": + description: Invalid data for getting a quote schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/withdrawals.yaml b/api/wallet/spec/paths/withdrawals.yaml index 79c2a8c..368e11e 100644 --- a/api/wallet/spec/paths/withdrawals.yaml +++ b/api/wallet/spec/paths/withdrawals.yaml @@ -1,35 +1,36 @@ +--- get: operationId: listWithdrawals - summary: Поиск выводов + summary: Search of withdrawals tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: walletID in: query - description: Идентификатор кошелька + description: Identifier of the wallet type: string maxLength: 40 minLength: 1 required: false - name: identityID in: query - description: Идентификатор личности владельца + description: Identifier of the owner's identity type: string maxLength: 40 minLength: 1 required: false - name: withdrawalID in: query - description: Идентификатор вывода денежных средств + description: Identifier of the funds withdrawal type: string required: false maxLength: 40 minLength: 1 - name: destinationID in: query - description: Идентификатор приёмника средств + description: Identifier of the destination type: string maxLength: 40 minLength: 1 @@ -44,75 +45,74 @@ get: required: false - name: createdAtFrom in: query - description: Дата создания с + description: Creation date range start type: string format: date-time required: false - name: createdAtTo in: query - description: Дата создания до + description: Creation date range end type: string format: date-time required: false - - $ref: '#/parameters/amountFrom' - - $ref: '#/parameters/amountTo' - - $ref: '#/parameters/currencyID' - - $ref: '#/parameters/limit' + - $ref: "#/parameters/amountFrom" + - $ref: "#/parameters/amountTo" + - $ref: "#/parameters/currencyID" + - $ref: "#/parameters/limit" - x-rebillyMerge: - - name: continuationToken - in: query - required: false - - $ref: '#/definitions/ContinuationToken' + - name: continuationToken + in: query + required: false + - $ref: "#/definitions/ContinuationToken" responses: - '200': - description: Результат поиска + "200": + description: Search result schema: type: object properties: continuationToken: x-rebillyMerge: - - $ref: '#/definitions/ContinuationToken' + - $ref: "#/definitions/ContinuationToken" result: - description: Найденные выводы + description: Withdrawals found type: array items: - $ref: '#/definitions/Withdrawal' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - + $ref: "#/definitions/Withdrawal" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" post: operationId: createWithdrawal - summary: Запустить вывод средств + summary: Create withdrawal tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" - name: withdrawal - description: Данные вывода + description: Withdrawal data in: body required: true schema: - $ref: '#/definitions/WithdrawalParameters' + $ref: "#/definitions/WithdrawalParameters" responses: - '202': - description: Вывод запущен + "202": + description: Withdrawal started headers: Location: - description: URI запущенного вывода + description: URI of started withdrawal type: string format: uri schema: - $ref: '#/definitions/Withdrawal' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '409': - $ref: '#/responses/ConflictRequest' - '422': - description: Неверные данные для осуществления вывода + $ref: "#/definitions/Withdrawal" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "409": + $ref: "#/responses/ConflictRequest" + "422": + description: Invalid data for withdrawal schema: - $ref: '#/definitions/InvalidOperationParameters' + $ref: "#/definitions/InvalidOperationParameters" diff --git a/api/wallet/spec/paths/withdrawals@{withdrawalID}.yaml b/api/wallet/spec/paths/withdrawals@{withdrawalID}.yaml index 9d6cfc0..fa5ad2b 100644 --- a/api/wallet/spec/paths/withdrawals@{withdrawalID}.yaml +++ b/api/wallet/spec/paths/withdrawals@{withdrawalID}.yaml @@ -1,20 +1,21 @@ +--- get: operationId: getWithdrawal - summary: Получить состояние вывода средств + summary: Get withdrawal status tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/withdrawalID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/withdrawalID" responses: - '200': - description: Вывод найден + "200": + description: Withdrawal found schema: - $ref: '#/definitions/Withdrawal' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' + $ref: "#/definitions/Withdrawal" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" diff --git a/api/wallet/spec/paths/withdrawals@{withdrawalID}@events.yaml b/api/wallet/spec/paths/withdrawals@{withdrawalID}@events.yaml index 9d30865..f987e39 100644 --- a/api/wallet/spec/paths/withdrawals@{withdrawalID}@events.yaml +++ b/api/wallet/spec/paths/withdrawals@{withdrawalID}@events.yaml @@ -1,24 +1,25 @@ +--- get: operationId: pollWithdrawalEvents - summary: Запросить события вывода средств + summary: Request withdrawal events tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/withdrawalID' - - $ref: '#/parameters/limit' - - $ref: '#/parameters/eventCursor' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/withdrawalID" + - $ref: "#/parameters/limit" + - $ref: "#/parameters/eventCursor" responses: - '200': - description: События найдены + "200": + description: Events found schema: type: array items: - $ref: '#/definitions/WithdrawalEvent' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' + $ref: "#/definitions/WithdrawalEvent" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" diff --git a/api/wallet/spec/paths/withdrawals@{withdrawalID}@events@{eventID}.yaml b/api/wallet/spec/paths/withdrawals@{withdrawalID}@events@{eventID}.yaml index 2384b1e..cf92705 100644 --- a/api/wallet/spec/paths/withdrawals@{withdrawalID}@events@{eventID}.yaml +++ b/api/wallet/spec/paths/withdrawals@{withdrawalID}@events@{eventID}.yaml @@ -1,21 +1,22 @@ +--- get: operationId: getWithdrawalEvents - summary: Получить событие вывода средств + summary: Get an event of withdrawal tags: - Withdrawals parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/withdrawalID' - - $ref: '#/parameters/eventID' + - $ref: "#/parameters/requestID" + - $ref: "#/parameters/deadline" + - $ref: "#/parameters/withdrawalID" + - $ref: "#/parameters/eventID" responses: - '200': - description: Событие найдено + "200": + description: Event found schema: - $ref: '#/definitions/WithdrawalEvent' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - '404': - $ref: '#/responses/NotFound' + $ref: "#/definitions/WithdrawalEvent" + "400": + $ref: "#/responses/BadRequest" + "401": + $ref: "#/responses/Unauthorized" + "404": + $ref: "#/responses/NotFound" diff --git a/api/wallet/spec/swagger.yaml b/api/wallet/spec/swagger.yaml index ca130d6..ee8574d 100644 --- a/api/wallet/spec/swagger.yaml +++ b/api/wallet/spec/swagger.yaml @@ -1,62 +1,62 @@ -swagger: '2.0' +--- +swagger: "2.0" info: - version: '0.1.0' + version: "0.1.0" title: Vality Wallet API description: > - Vality Wallet API является базовой и единственной точкой взаимодействия с системой кошельков. Все изменения состояний системы осуществляются с помощью вызовов соответствующих методов API. Любые сторонние приложения, включая наши веб-сайты и другие UI-интерфейсы, являются внешними приложениями-клиентами. + The Vality Wallet API is the base and only point of interaction with the wallet system. All system state changes are carried out by calling the corresponding API methods. Any third party applications, including our websites and other UIs, are external client applications. - Vality API работает поверх HTTP-протокола. Мы используем REST архитектуру, схема описывается в соответствии с [OpenAPI 2.0](https://spec.openapis.org/oas/v2.0). Коды возврата описываются соответствующими HTTP-статусами. Система принимает и возвращает значения JSON в теле запросов и ответов. + The Vality API works on top of the HTTP protocol. We use REST architecture, the scheme is described according to [OpenAPI 2.0](https://spec.openapis.org/oas/v2.0). Return codes are described by the corresponding HTTP statuses. The system accepts and returns JSON values in the body of requests and responses. - ## Формат содержимого + ## Content Format - Любой запрос к API должен выполняться в кодировке UTF-8 и с указанием содержимого в формате JSON. + Any API request must be encoded in UTF-8 and must contain JSON content. ``` Content-Type: application/json; charset=utf-8 ``` - ## Формат дат + ## Date format - Система принимает и возвращает значения отметок времени в формате `date-time`, описанном в [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339): + The system accepts and returns timestamp values in the `date-time` format described in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339): ``` 2017-01-01T00:00:00Z 2017-01-01T00:00:01+00:00 ``` - ## Максимальное время обработки запроса + ## Maximum request processing time - При любом обращении к API в заголовке `X-Request-Deadline` соответствующего запроса можно передать параметр отсечки по времени, определяющий максимальное время ожидания завершения операции по запросу: + In any API call, you can pass a timeout parameter in the `X-Request-Deadline` header of the corresponding request, which determines the maximum time to wait for the operation to complete on the request: ``` X-Request-Deadline: 10s ``` - По истечении указанного времени система прекращает обработку запроса. Рекомендуется указывать значение не более одной минуты, но не менее трёх секунд. + After the specified time has elapsed, the system stops processing the request. It is recommended to specify a value of no more than one minute, but no less than three seconds. - `X-Request-Deadline` может: + `X-Request-Deadline` can: - * задаваться в формате `date-time` согласно [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339); - * задаваться в относительных величинах: в миллисекундах (`150000ms`), секундах (`540s`) или минутах (`3.5m`). + * set in `date-time` format according to [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339); + * specified in relative terms: in milliseconds (`150000ms`), seconds (`540s`) or minutes (`3.5m`). - ## Ошибки обработки запросов + ## Request processing errors - В процессе обработки запросов силами нашей системы могут происходить различные непредвиденные ситуации. Об их появлении система сигнализирует по протоколу HTTP соответствующими [статусами][5xx], обозначающими ошибки сервера. + During the processing of requests by our system, various unforeseen situations may occur. The system signals about their appearance via the HTTP protocol with the corresponding [statuses][5xx], indicating server errors. - | Код | Описание | - | ------- | ---------- | - | **500** | В процессе обработки системой запроса возникла непредвиденная ситуация. При получении подобного кода ответа мы рекомендуем обратиться в техническую поддержку. | - | **503** | Система временно недоступна и не готова обслуживать данный запрос. Запрос гарантированно не выполнен, при получении подобного кода ответа попробуйте выполнить его позднее, когда доступность системы будет восстановлена. | - | **504** | Система превысила допустимое время обработки запроса, результат запроса не определён. Попробуйте отправить запрос повторно или выяснить результат выполнения исходного запроса, если повторное исполнение запроса нежелательно. | + | Code | Description | + | ------- | -------------- | + | **500** | An unexpected situation occurred while the system was processing the request. If you receive such a response code, we recommend that you contact technical support. | + | **503** | The system is temporarily unavailable and not ready to serve this request. The request is guaranteed to fail, if you receive a response code like this, try to implement it later when the system is restored to availability. | + | **504** | The system has exceeded the allowable request processing time, the result of the request is undefined. Try to resubmit the request or find out the result of the original request, if you do not want to re-execute the request. | [5xx]: https://tools.ietf.org/html/rfc7231#section-6.6 - - termsOfService: 'https://vality.dev/' + termsOfService: "https://vality.dev/" contact: - name: Команда техподдержки + name: Technical support team email: support@vality.dev - url: 'https://api.vality.dev' + url: "https://api.vality.dev" host: api.vality.dev basePath: /wallet/v0 schemes: @@ -71,7 +71,7 @@ securityDefinitions: name: Authorization in: header description: > - Для аутентификации вызовов мы используем [JWT](https://jwt.io). Соответствующий ключ передается в заголовке. + We use [JWT](https://jwt.io) for call authentication. The corresponding key is passed in the header. ```shell Authorization: Bearer {YOUR_API_KEY_JWT} @@ -79,286 +79,245 @@ securityDefinitions: security: - bearer: [] - responses: - BadRequest: - description: Недопустимые для операции входные данные + description: Invalid input data for operation schema: - $ref: '#/definitions/BadRequest' - + $ref: "#/definitions/BadRequest" ConflictRequest: - description: Переданное значение `externalID` уже использовалось вами ранее с другими параметрами запроса + description: The passed value `externalID` has already been used by you with other query parameters schema: - $ref: '#/definitions/ConflictRequest' - + $ref: "#/definitions/ConflictRequest" NotFound: - description: Искомая сущность не найдена - + description: The content you are looking for was not found Unauthorized: - description: Ошибка авторизации - + description: Authorization error parameters: - requestID: name: X-Request-ID in: header - description: Уникальный идентификатор запроса к системе + description: Unique identifier of the request to the system required: true type: string maxLength: 32 minLength: 1 - providerID: name: providerID in: path - description: Идентификатор провайдера + description: Identifier of the provider required: true type: string maxLength: 40 minLength: 1 - identityID: name: identityID in: path - description: Идентификатор личности владельца + description: Identifier of the owner's identity required: true type: string maxLength: 40 minLength: 1 - walletID: name: walletID in: path - description: Идентификатор кошелька + description: Identifier of the wallet required: true type: string maxLength: 40 minLength: 1 - destinationID: name: destinationID in: path - description: Идентификатор приёмника средств + description: Identifier of the destination required: true type: string maxLength: 40 minLength: 1 - withdrawalID: name: withdrawalID in: path - description: Идентификатор вывода денежных средств + description: Identifier of the withdrawal required: true type: string maxLength: 40 minLength: 1 - externalID: name: externalID in: path - description: Внешний идентификатор + description: External identifier required: true type: string - residence: name: residence in: query description: | - Резиденция, в рамках которой производится оказание услуг, - код страны или региона по стандарту [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) + The residence within which the services are provided, + [ISO 3166-1] country or region code (https://en.wikipedia.org/wiki/ISO_3166-1) type: string - pattern: '^[A-Za-z]{3}$' + pattern: "^[A-Za-z]{3}$" required: false - amountFrom: name: amountFrom in: query - description: Сумма денежных средств в минорных единицах + description: Amount of monetary funds in minor units type: integer format: int64 required: false - amountTo: name: amountTo in: query - description: Сумма денежных средств в минорных единицах + description: Amount of monetary funds in minor units type: integer format: int64 required: false - currencyID: name: currencyID in: query description: | - Валюта, символьный код согласно [ISO + Currency, character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). type: string - pattern: '^[A-Z]{3}$' - + pattern: "^[A-Z]{3}$" limit: name: limit in: query - description: Лимит выборки + description: Selection limit required: true type: integer format: int32 minimum: 1 maximum: 1000 - eventCursor: name: eventCursor in: query description: | - Идентификатор последнего известного события. + The identifier of the last known event. - Все события, произошедшие _после_ указанного, попадут в выборку. - Если этот параметр не указан, в выборку попадут события, начиная с самого первого. + All events that occurred _after_ the specified one will be included in the selection. + If this parameter is not specified, the selection will include events starting from the very first one. required: false type: integer format: int32 - eventID: name: eventID in: path description: | - Идентификатор события процедуры идентификации. + Identifier of the identification procedure event. required: true type: integer format: int32 - reportID: name: reportID in: path - description: Идентификатор отчета + description: The report identifier required: true type: integer format: int64 - fileID: name: fileID in: path - description: Идентификатор файла + description: The file identifier required: true type: string maxLength: 40 minLength: 1 - fromTime: name: fromTime in: query - description: Начало временного отрезка + description: Start of the time period required: true type: string format: date-time - toTime: name: toTime in: query - description: Конец временного отрезка + description: End of the time period required: true type: string format: date-time - deadline: name: X-Request-Deadline in: header - description: Максимальное время обработки запроса + description: Maximum request processing time required: false type: string maxLength: 40 minLength: 1 - webhookID: name: webhookID in: path - description: Идентификатор webhook'а + description: Webhook identifier required: true type: string maxLength: 40 minLength: 1 - queryIdentityID: name: identityID in: query - description: Идентификатор личности владельца + description: Identifier of the owner's identity required: true type: string maxLength: 40 minLength: 1 - w2wTransferID: name: w2wTransferID in: path - description: Идентификатор перевода + description: Identifier of transfer required: true type: string maxLength: 40 minLength: 1 - tags: - - name: Providers - x-displayName: Провайдеры услуг + x-displayName: Service providers description: "" - - name: Identities - x-displayName: Владельцы + x-displayName: Identities description: "" - - name: Wallets - x-displayName: Кошельки + x-displayName: Wallets description: "" - - name: Deposits - x-displayName: Пополнения + x-displayName: Deposits description: "" - - name: Withdrawals - x-displayName: Выводы + x-displayName: Withdrawals description: "" - - name: Residences - x-displayName: Резиденции + x-displayName: Residences description: "" - - name: Currencies - x-displayName: Валюты + x-displayName: Currencies description: "" - - name: Reports - x-displayName: Отчеты + x-displayName: Reports description: "" - - name: Downloads - x-displayName: Загрузка файлов + x-displayName: File upload description: "" - - name: W2W - x-displayName: Переводы внутри системы - description: "Переводы средств между кошельками внутри системы" - + x-displayName: Transfers within the system + description: "Transfers of funds between wallets within the system" - name: Webhooks x-displayName: Webhooks description: > ## Vality Webhooks Management API - В данном разделе описаны методы, позволяющие управлять Webhook'ами, или инструментами для получения асинхронных оповещений посредством HTTP-запросов при наступлении одного или группы интересующих вас событий, например, о том, что выплата в рамках созданного кошелька была успешно проведена. + This section describes methods that allow you to manage Webhooks, or tools for receiving asynchronous notifications via HTTP requests when one or a group of events of interest to you occurs, for example, that a withdrawal within the created wallet was successfully completed. ## Vality Webhooks Events API - Внимание! Только Webhooks Management API является частью системы Vality, а следовательно и данной спецификации. Для реализации обработчика присылаемых уведомлений вам необходимо будет ознакомиться с OpenAPI-спецификацией [Vality Wallets Webhook Events API](https://vality.github.io/swag-wallets-webhook-events/). - + Attention! Only the Webhooks Management API is part of the Vality system and hence this specification. To implement the notification handler, you will need to read the OpenAPI specification [Vality Wallets Webhook Events API](https://vality.github.io/swag-wallets-webhook-events/). - name: Error Codes - x-displayName: Коды ошибок + x-displayName: Error codes description: > - ## Ошибки перевода + ## Withdrawal errors - | Код | Описание | - | --- | -------- | - | InvalidSenderResource | Неверный источник перевода (введен номер несуществующей карты, отсутствующего аккаунта и т.п.) | - | InvalidReceiverResource| Неверный получатель перевода (введен номер несуществующей карты и т.п.) | - | InsufficientFunds | Недостаточно средств на счете банковской карты | - | PreauthorizationFailed | Предварительная авторизация отклонена (введен неверный код 3D-Secure, на форме 3D-Secure нажата ссылка отмены) | - | RejectedByIssuer | Перевод отклонён эмитентом (установлены запреты по стране списания, запрет на покупки в интернете, платеж отклонен антифродом эмитента и т.п.) | + | Code | Description | + | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | InvalidSenderResource | Invalid transfer source (entered the number of a non-existent card, missing account, etc.) | + | InvalidReceiverResource| Wrong transfer receiver (invalid card number entered, etc.) | + | InsufficientFunds | Insufficient funds on the bank card account | + | PreauthorizationFailed | Pre-Authorization Rejected (Wrong 3D-Secure Code Entered, Cancel Link Clicked on 3D-Secure Form) | + | RejectedByIssuer | The transfer was rejected by the issuer (prohibitions were established by the country of debiting, a ban on purchases on the Internet, the withdrawal was rejected by the issuer's antifraud, etc.) | diff --git a/crowdin.yml b/crowdin.yml deleted file mode 100644 index d6b40b4..0000000 --- a/crowdin.yml +++ /dev/null @@ -1,3 +0,0 @@ -files: - - source: /api/**/*.yaml - translation: '%original_path%/%original_file_name%' diff --git a/spec/definitions/responses/BadRequest.yaml b/spec/definitions/responses/BadRequest.yaml index c364596..6d9cf92 100644 --- a/spec/definitions/responses/BadRequest.yaml +++ b/spec/definitions/responses/BadRequest.yaml @@ -3,7 +3,7 @@ required: - errorType properties: errorType: - description: Тип ошибки в данных + description: Error type type: string enum: - SchemaViolated @@ -18,10 +18,10 @@ properties: - InvalidToken example: NotFound name: - description: Имя или идентификатор элемента сообщения, содержащего недопустимые данные + description: Name or identifier of message element containing invalid data type: string example: X-Request-ID description: - description: Пояснение, почему данные считаются недопустимыми + description: Explanation of why the data is invalid type: string example: Required parameter was not sent