Translate into english (#38)

* Translate into english

* Update api/payres/spec/swagger.yaml

* Update api/wallet/spec/definitions/DepositRevertStatus.yaml

* Revert webhook public key example

* Apply suggestions from code review

Co-authored-by: vilorij <vilorij@ya.ru>
Co-authored-by: Rinat Arsaev <11846445+A77AY@users.noreply.github.com>

* Update api/wallet/spec/definitions/WithdrawalsTopic.yaml

* Update api/wallet/spec/paths/identities@{identityID}@withdrawal-methods.yaml

* Update api/wallet/spec/paths/destinations@{destinationID}@grants.yaml

* Format MD parts

* Update api/wallet/spec/definitions/CurrencyID.yaml

* Update api/wallet/spec/definitions/Deposit.yaml

* Apply suggestions from code review

Co-authored-by: vilorij <vilorij@ya.ru>
Co-authored-by: Артем <WWW_cool@inbox.ru>

* Update api/wallet/spec/definitions/Deposit.yaml

* Update api/wallet/spec/definitions/Identity.yaml

Co-authored-by: Артем <WWW_cool@inbox.ru>

* Update api/wallet/spec/definitions/DestinationGrantRequest.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/wallet/spec/definitions/DestinationGrantRequest.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/wallet/spec/definitions/DestinationGrantRequest.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/wallet/spec/definitions/FileDownload.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/wallet/spec/definitions/W2WTransfer.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/payres/spec/swagger.yaml

Co-authored-by: Артем <WWW_cool@inbox.ru>

* Update api/wallet/spec/definitions/Destination.yaml

Co-authored-by: Артем <WWW_cool@inbox.ru>

* Update api/wallet/spec/definitions/Provider.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/wallet/spec/definitions/Report.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/wallet/spec/definitions/Identity.yaml

Co-authored-by: Артем <WWW_cool@inbox.ru>

* Update api/wallet/spec/definitions/Provider.yaml

Co-authored-by: Артем <WWW_cool@inbox.ru>

* Update api/wallet/spec/definitions/Report.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/wallet/spec/definitions/QuoteParameters.yaml

* Update api/wallet/spec/definitions/SourceID.yaml

Co-authored-by: vilorij <vilorij@ya.ru>

* Update api/wallet/spec/definitions/ReceiverResource.yaml

Co-authored-by: Артем <WWW_cool@inbox.ru>

* Fixes

* Remove crowdin configuration

Co-authored-by: vilorij <vilorij@ya.ru>
Co-authored-by: Rinat Arsaev <11846445+A77AY@users.noreply.github.com>
Co-authored-by: Артем <WWW_cool@inbox.ru>
This commit is contained in:
Pavel Popov 2023-01-16 15:38:24 +07:00 committed by GitHub
parent cd91884a06
commit c9461e1782
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
141 changed files with 1303 additions and 1259 deletions

6
.gitignore vendored
View File

@ -33,8 +33,8 @@ node_modules
# Optional REPL history
.node_repl_history
# CI
.wercker
# Frontend
/lib
# Other
.DS_Store

View File

@ -1,7 +1,8 @@
---
type: object
properties:
authData:
description: Данные для авторизации платежа по карте
description: Data for card withdrawal authorization
type: string
minLength: 1
maxLength: 1000

View File

@ -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"

View File

@ -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

View File

@ -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"

View File

@ -1,4 +1,5 @@
---
type: object
allOf:
- $ref: '#/definitions/SecuredBankCard'
- $ref: '#/definitions/AuthData'
- $ref: "#/definitions/SecuredBankCard"
- $ref: "#/definitions/AuthData"

View File

@ -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

View File

@ -1,3 +1,4 @@
---
type: object
properties:
message:

View File

@ -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"

View File

@ -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"

View File

@ -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: ""

View File

@ -1,3 +1,4 @@
---
type: object
properties:
type:

View File

@ -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"

View File

@ -1,4 +1,5 @@
description: Банковская карта
---
description: Card
allOf:
- $ref: '#/definitions/DestinationResource'
- $ref: '#/definitions/SecuredBankCard'
- $ref: "#/definitions/DestinationResource"
- $ref: "#/definitions/SecuredBankCard"

View File

@ -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

View File

@ -1,4 +1,5 @@
---
description: Банковская карта
allOf:
- $ref: '#/definitions/ReceiverResourceParams'
- $ref: '#/definitions/SecuredBankCard'
- $ref: "#/definitions/ReceiverResourceParams"
- $ref: "#/definitions/SecuredBankCard"

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -1,8 +1,9 @@
---
type: object
discriminator: requestType
required:
- requestType
properties:
requestType:
description: Тип браузерной операции
description: Type of browser operation
type: string

View File

@ -1,14 +1,15 @@
description: Контактные данные
---
description: Contact details
type: object
properties:
email:
description: Адрес электронной почты
description: Email address
type: string
format: email
maxLength: 100
phoneNumber:
description: |
Номер мобильного телефона с международным префиксом согласно
Mobile phone number with international prefix according to
[E.164](https://en.wikipedia.org/wiki/E.164).
type: string
format: '^\+\d{4,15}$'

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -1,4 +1,5 @@
description: Криптовалютные денежные средства
---
description: Cryptocurrency funds
allOf:
- $ref: '#/definitions/DestinationResource'
- $ref: '#/definitions/CryptoWallet'
- $ref: "#/definitions/DestinationResource"
- $ref: "#/definitions/CryptoWallet"

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -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"

View File

@ -1,9 +1,10 @@
---
type: object
required:
- code
properties:
code:
description: Код ошибки коррекции
description: Adjustment error code
type: string
subError:
$ref: '#/definitions/SubFailure'
$ref: "#/definitions/SubFailure"

View File

@ -1,3 +1,4 @@
description: Идентификатор корректировки поступления денежных средств
---
description: Deposit adjustment identifier
type: string
example: tZ0jUmlsV0

View File

@ -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"

View File

@ -1,9 +1,10 @@
---
type: object
required:
- code
properties:
code:
description: Код ошибки поступления
description: Deposit error code
type: string
subError:
$ref: '#/definitions/SubFailure'
$ref: "#/definitions/SubFailure"

View File

@ -1,3 +1,4 @@
description: Идентификатор поступления денежных средств
---
description: Deposit identifier
type: string
example: tZ0jUmlsV0

View File

@ -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"

View File

@ -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"

View File

@ -1,3 +1,4 @@
description: Идентификатор отмены поступления денежных средств 
---
description: Deposit revert identifier
type: string
example: "10068321"

View File

@ -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"

View File

@ -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"

View File

@ -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"

View File

@ -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

View File

@ -1,3 +1,4 @@
description: Идентификатор приёмника денежных средств
---
description: Destination identifier
type: string
example: "107498"

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -1,4 +1,5 @@
description: Цифровой кошелек
---
description: Digital wallet
allOf:
- $ref: '#/definitions/DestinationResource'
- $ref: '#/definitions/DigitalWallet'
- $ref: "#/definitions/DestinationResource"
- $ref: "#/definitions/DigitalWallet"

View File

@ -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

View File

@ -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"

View File

@ -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

View File

@ -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

View File

@ -1,3 +1,4 @@
---
type: string
minLength: 1
maxLength: 4000

View File

@ -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"

View File

@ -1,3 +1,4 @@
description: Идентификатор личности владельца кошелька
---
description: Identifier of wallet owner
type: string
example: "10036274"

View File

@ -1,4 +1,5 @@
description: Уникальный в рамках системы идентификатор участника.
---
description: The participant's unique identifier within the system.
type: string
minLength: 1
maxLength: 40

View File

@ -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"

View File

@ -1,3 +1,4 @@
description: Идентификатор провайдера услуг
---
description: Identifier of the service provider
type: string
example: serviceprovider

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -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

View File

@ -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

View File

@ -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: "🇺🇸"

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -1,3 +1,4 @@
description: Идентификатор источника денежных средств
---
description: Funds source identifier
type: string
example: "107498"

View File

@ -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'
$ref: "#/definitions/SubFailure"

View File

@ -1,2 +0,0 @@
allOf:
- $ref: '#/definitions/CryptoWallet'

View File

@ -1,8 +1,9 @@
---
type: object
discriminator: interactionType
required:
- interactionType
properties:
interactionType:
description: Тип взаимодействия с пользователем
description: Type of interaction with the user
type: string

View File

@ -1,10 +1,11 @@
---
type: object
discriminator: changeType
required:
- changeType
properties:
changeType:
description: Вид изменения взаимодействию с пользователем.
description: Type of change in user interaction.
type: string
enum:
- UserInteractionCreated

View File

@ -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"

View File

@ -1,3 +1,4 @@
---
type: object
allOf:
- $ref: '#/definitions/UserInteractionChange'
- $ref: "#/definitions/UserInteractionChange"

View File

@ -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

View File

@ -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"

View File

@ -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"

View File

@ -1,4 +1,5 @@
description: Идентификатор перевода
---
description: Transfer identifier
type: string
example: "10a0b68D3E21"
maxLength: 40

View File

@ -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"

View File

@ -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"

View File

@ -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"

View File

@ -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

View File

@ -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

View File

@ -1,3 +1,4 @@
description: Идентификатор кошелька
---
description: Identifier of the wallet
type: string
example: "10068321"

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -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"

View File

@ -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

View File

@ -1,9 +1,10 @@
---
type: object
required:
- code
properties:
code:
description: Код ошибки вывода
description: Withdrawal error code
type: string
subError:
$ref: '#/definitions/SubFailure'
$ref: "#/definitions/SubFailure"

View File

@ -1,3 +1,4 @@
description: Идентификатор вывода денежных средств
---
description: Identifier of funds withdrawal
type: string
example: tZ0jUmlsV0

View File

@ -1,10 +1,11 @@
---
type: object
discriminator: method
required:
- method
properties:
method:
description: Метод для проведения выплаты
description: Withdrawal method
type: string
enum:
- WithdrawalMethodBankCard

View File

@ -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'
- $ref: "#/definitions/BankCardPaymentSystem"

View File

@ -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'
- $ref: "#/definitions/DigitalWalletProvider"

View File

@ -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'
- $ref: "#/definitions/GenericProvider"

View File

@ -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.

View File

@ -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

View File

@ -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)

Some files were not shown because too many files have changed in this diff Show More