valitydev/wallets-api
14
0
Fork 0
mirror of https://github.com/valitydev/wallets-api.git synced 2024-11-06 10:55:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[ci skip] deploy from yuri-bukhalenkov

Browse Source
This commit is contained in:
werckerbot 2021-03-04 10:43:03 +00:00
parent 08af94b1aa
commit e0b611d1d8
2 changed files with 849 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

478
v0/api/wallet/swagger.json
View File

@ -349,6 +349,132 @@
}
],
"paths": {
"/adjustments": {
"get": {
"operationId": "listAdjustments",
"summary": "Поиск корректировок",
"tags": [
"Adjustments"
],
"parameters": [
{
"$ref": "#/parameters/requestID"
},
{
"$ref": "#/parameters/deadline"
},
{
"name": "walletID",
"in": "query",
"description": "Идентификатор кошелька",
"type": "string",
"maxLength": 40,
"minLength": 1,
"required": false
},
{
"name": "identityID",
"in": "query",
"description": "Идентификатор личности владельца",
"type": "string",
"maxLength": 40,
"minLength": 1,
"required": false
},
{
"name": "depositID",
"in": "query",
"description": "Идентификатор ввода денежных средств",
"type": "string",
"required": false,
"maxLength": 50,
"minLength": 1
},
{
"name": "sourceID",
"in": "query",
"description": "Идентификатор источника средств",
"type": "string",
"maxLength": 40,
"minLength": 1,
"required": false
},
{
"name": "status",
"in": "query",
"type": "string",
"enum": [
"Pending",
"Succeeded",
"Failed"
],
"required": false
},
{
"name": "createdAtFrom",
"in": "query",
"description": "Дата создания с",
"type": "string",
"format": "date-time",
"required": false
},
{
"name": "createdAtTo",
"in": "query",
"description": "Дата создания до",
"type": "string",
"format": "date-time",
"required": false
},
{
"$ref": "#/parameters/amountFrom"
},
{
"$ref": "#/parameters/amountTo"
},
{
"$ref": "#/parameters/currencyID"
},
{
"$ref": "#/parameters/limit"
},
{
"name": "continuationToken",
"in": "query",
"required": false,
"description": "Токен, сигнализирующий о том, что в ответе передана только часть данных.\nДля получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен.\nЕсли токена нет, получена последняя часть данных.\n",
"type": "string"
}
],
"responses": {
"200": {
"description": "Результат поиска",
"schema": {
"type": "object",
"properties": {
"continuationToken": {
"description": "Токен, сигнализирующий о том, что в ответе передана только часть данных.\nДля получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен.\nЕсли токена нет, получена последняя часть данных.\n",
"type": "string"
},
"result": {
"description": "Найденные корректировки",
"type": "array",
"items": {
"$ref": "#/definitions/Adjustment"
}
}
}
}
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
}
}
}
},
"/currencies/{currencyID}": {
"get": {
"operationId": "getCurrency",
@ -2267,6 +2393,132 @@
}
}
},
"/reverts": {
"get": {
"operationId": "listReverts",
"summary": "Поиск отмен",
"tags": [
"Reverts"
],
"parameters": [
{
"$ref": "#/parameters/requestID"
},
{
"$ref": "#/parameters/deadline"
},
{
"name": "walletID",
"in": "query",
"description": "Идентификатор кошелька",
"type": "string",
"maxLength": 40,
"minLength": 1,
"required": false
},
{
"name": "identityID",
"in": "query",
"description": "Идентификатор личности владельца",
"type": "string",
"maxLength": 40,
"minLength": 1,
"required": false
},
{
"name": "depositID",
"in": "query",
"description": "Идентификатор ввода денежных средств",
"type": "string",
"required": false,
"maxLength": 50,
"minLength": 1
},
{
"name": "sourceID",
"in": "query",
"description": "Идентификатор источника средств",
"type": "string",
"maxLength": 40,
"minLength": 1,
"required": false
},
{
"name": "status",
"in": "query",
"type": "string",
"enum": [
"Pending",
"Succeeded",
"Failed"
],
"required": false
},
{
"name": "createdAtFrom",
"in": "query",
"description": "Дата создания с",
"type": "string",
"format": "date-time",
"required": false
},
{
"name": "createdAtTo",
"in": "query",
"description": "Дата создания до",
"type": "string",
"format": "date-time",
"required": false
},
{
"$ref": "#/parameters/amountFrom"
},
{
"$ref": "#/parameters/amountTo"
},
{
"$ref": "#/parameters/currencyID"
},
{
"$ref": "#/parameters/limit"
},
{
"name": "continuationToken",
"in": "query",
"required": false,
"description": "Токен, сигнализирующий о том, что в ответе передана только часть данных.\nДля получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен.\nЕсли токена нет, получена последняя часть данных.\n",
"type": "string"
}
],
"responses": {
"200": {
"description": "Результат поиска",
"schema": {
"type": "object",
"properties": {
"continuationToken": {
"description": "Токен, сигнализирующий о том, что в ответе передана только часть данных.\nДля получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен.\nЕсли токена нет, получена последняя часть данных.\n",
"type": "string"
},
"result": {
"description": "Найденные отмены",
"type": "array",
"items": {
"$ref": "#/definitions/Revert"
}
}
}
}
},
"400": {
"$ref": "#/responses/BadRequest"
},
"401": {
"$ref": "#/responses/Unauthorized"
}
}
}
},
"/w2w/transfers": {
"post": {
"description": "Создать перевод",
@ -3134,6 +3386,102 @@
}
},
"definitions": {
"Adjustment": {
"description": "Данные корректировки поступления денежных средств",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"description": "Идентификатор корректировки поступления денежных средств",
"type": "string",
"example": "tZ0jUmlsV0",
"readOnly": true
},
"createdAt": {
"description": "Дата и время запуска корректировки",
"type": "string",
"format": "date-time",
"readOnly": true
},
"operation_timestamp": {
"description": "Дата и время запуска корректировки",
"type": "string",
"format": "date-time",
"readOnly": true
},
"domainRevision": {
"type": "integer",
"format": "int64"
},
"partyRevision": {
"type": "integer",
"format": "int64"
},
"externalID": {
"description": "Уникальный идентификатор сущности на вашей стороне.\n\nПри указании будет использован для того, чтобы гарантировать идемпотентную обработку операции.\n",
"type": "string",
"example": "10036274"
}
}
},
{
"$ref": "#/definitions/AdjustmentStatus"
}
]
},
"AdjustmentFailure": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"description": "Код ошибки отмены",
"type": "string"
},
"subError": {
"$ref": "#/definitions/SubFailure"
}
}
},
"AdjustmentID": {
"description": "Идентификатор корректировки поступления денежных средств",
"type": "string",
"example": "tZ0jUmlsV0"
},
"AdjustmentStatus": {
"type": "object",
"properties": {
"status": {
"description": "Статус корректировки поступления денежных средств.\n\n| Значение | Пояснение |\n| ----------- | ------------------------------------------------------- |\n| `Pending` | Корректировка в процессе выполнения |\n| `Succeeded` | Корректировка произведёна успешно |\n| `Failed` | Корректировка завершилась неудачей |\n",
"type": "string",
"enum": [
"Pending",
"Succeeded",
"Failed"
],
"readOnly": true
},
"failure": {
"description": "> Если `status` == `Failed`\n\nПояснение причины неудачи\n",
"readOnly": true,
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"description": "Код ошибки отмены",
"type": "string"
},
"subError": {
"$ref": "#/definitions/SubFailure"
}
}
}
}
},
"Asset": {
"description": "Объём денежных средств\n",
"type": "object",
@ -5204,6 +5552,136 @@
"pattern": "^[A-Z]{3}$",
"example": "RUS"
},
"Revert": {
"description": "Данные отмены поступления денежных средств",
"allOf": [
{
"type": "object",
"required": [
"wallet",
"source",
"body"
],
"properties": {
"id": {
"description": "Идентификатор отмены поступления денежных средств ",
"type": "string",
"example": "10068321",
"readOnly": true
},
"createdAt": {
"description": "Дата и время запуска отмены",
"type": "string",
"format": "date-time",
"readOnly": true
},
"wallet": {
"description": "Идентификатор кошелька",
"type": "string",
"example": "10068321"
},
"source": {
"description": "Идентификатор источника денежных средств",
"type": "string",
"example": "107498"
},
"body": {
"description": "Объём поступивших средств",
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"description": "Сумма денежных средств в минорных единицах, например, в копейках\n",
"type": "integer",
"format": "int64",
"example": 1430000
},
"currency": {
"description": "Валюта, символьный код согласно [ISO\n4217](http://www.iso.org/iso/home/standards/currency_codes.htm).\n",
"type": "string",
"pattern": "^[A-Z]{3}$",
"example": "RUB"
}
}
},
"reason": {
"type": "string"
},
"domainRevision": {
"type": "integer",
"format": "int64"
},
"partyRevision": {
"type": "integer",
"format": "int64"
},
"externalID": {
"description": "Уникальный идентификатор сущности на вашей стороне.\n\nПри указании будет использован для того, чтобы гарантировать идемпотентную обработку операции.\n",
"type": "string",
"example": "10036274"
}
}
},
{
"$ref": "#/definitions/RevertStatus"
}
]
},
"RevertFailure": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"description": "Код ошибки отмены",
"type": "string"
},
"subError": {
"$ref": "#/definitions/SubFailure"
}
}
},
"RevertID": {
"description": "Идентификатор отмены поступления денежных средств ",
"type": "string",
"example": "10068321"
},
"RevertStatus": {
"type": "object",
"properties": {
"status": {
"description": "Статус отмены поступления денежных средств.\n\n| Значение | Пояснение |\n| ----------- | ------------------------------------------------------- |\n| `Pending` | Отмена в процессе выполнения |\n| `Succeeded` | Отмена поступления средств произведёна успешно |\n| `Failed` | Отмена поступления средств завершилась неудачей |\n",
"type": "string",
"enum": [
"Pending",
"Succeeded",
"Failed"
],
"readOnly": true
},
"failure": {
"description": "> Если `status` == `Failed`\n\nПояснение причины неудачи\n",
"readOnly": true,
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"description": "Код ошибки отмены",
"type": "string"
},
"subError": {
"$ref": "#/definitions/SubFailure"
}
}
}
}
},
"Ripple": {
"allOf": [
{

371
v0/api/wallet/swagger.yaml
View File

@ -356,6 +356,96 @@ tags:
| RejectedByIssuer | Перевод отклонён эмитентом (установлены запреты по стране списания, запрет на покупки в интернете, платёж отклонен антифродом эмитента и т.п.) |
| P2PTransferRejected | Перевод отклонён по иным причинам |
paths:
/adjustments:
get:
operationId: listAdjustments
summary: Поиск корректировок
tags:
- Adjustments
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- name: walletID
in: query
description: Идентификатор кошелька
type: string
maxLength: 40
minLength: 1
required: false
- name: identityID
in: query
description: Идентификатор личности владельца
type: string
maxLength: 40
minLength: 1
required: false
- name: depositID
in: query
description: Идентификатор ввода денежных средств
type: string
required: false
maxLength: 50
minLength: 1
- name: sourceID
in: query
description: Идентификатор источника средств
type: string
maxLength: 40
minLength: 1
required: false
- name: status
in: query
type: string
enum:
- Pending
- Succeeded
- Failed
required: false
- name: createdAtFrom
in: query
description: Дата создания с
type: string
format: date-time
required: false
- name: createdAtTo
in: query
description: Дата создания до
type: string
format: date-time
required: false
- $ref: '#/parameters/amountFrom'
- $ref: '#/parameters/amountTo'
- $ref: '#/parameters/currencyID'
- $ref: '#/parameters/limit'
- name: continuationToken
in: query
required: false
description: |
Токен, сигнализирующий о том, что в ответе передана только часть данных.
Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен.
Если токена нет, получена последняя часть данных.
type: string
responses:
'200':
description: Результат поиска
schema:
type: object
properties:
continuationToken:
description: |
Токен, сигнализирующий о том, что в ответе передана только часть данных.
Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен.
Если токена нет, получена последняя часть данных.
type: string
result:
description: Найденные корректировки
type: array
items:
$ref: '#/definitions/Adjustment'
'400':
$ref: '#/responses/BadRequest'
'401':
$ref: '#/responses/Unauthorized'
'/currencies/{currencyID}':
get:
operationId: getCurrency
@ -1547,6 +1637,96 @@ paths:
$ref: '#/responses/Unauthorized'
'404':
$ref: '#/responses/NotFound'
/reverts:
get:
operationId: listReverts
summary: Поиск отмен
tags:
- Reverts
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- name: walletID
in: query
description: Идентификатор кошелька
type: string
maxLength: 40
minLength: 1
required: false
- name: identityID
in: query
description: Идентификатор личности владельца
type: string
maxLength: 40
minLength: 1
required: false
- name: depositID
in: query
description: Идентификатор ввода денежных средств
type: string
required: false
maxLength: 50
minLength: 1
- name: sourceID
in: query
description: Идентификатор источника средств
type: string
maxLength: 40
minLength: 1
required: false
- name: status
in: query
type: string
enum:
- Pending
- Succeeded
- Failed
required: false
- name: createdAtFrom
in: query
description: Дата создания с
type: string
format: date-time
required: false
- name: createdAtTo
in: query
description: Дата создания до
type: string
format: date-time
required: false
- $ref: '#/parameters/amountFrom'
- $ref: '#/parameters/amountTo'
- $ref: '#/parameters/currencyID'
- $ref: '#/parameters/limit'
- name: continuationToken
in: query
required: false
description: |
Токен, сигнализирующий о том, что в ответе передана только часть данных.
Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен.
Если токена нет, получена последняя часть данных.
type: string
responses:
'200':
description: Результат поиска
schema:
type: object
properties:
continuationToken:
description: |
Токен, сигнализирующий о том, что в ответе передана только часть данных.
Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен.
Если токена нет, получена последняя часть данных.
type: string
result:
description: Найденные отмены
type: array
items:
$ref: '#/definitions/Revert'
'400':
$ref: '#/responses/BadRequest'
'401':
$ref: '#/responses/Unauthorized'
/w2w/transfers:
post:
description: Создать перевод
@ -2081,6 +2261,87 @@ paths:
'404':
$ref: '#/responses/NotFound'
definitions:
Adjustment:
description: Данные корректировки поступления денежных средств
allOf:
- type: object
properties:
id:
description: Идентификатор корректировки поступления денежных средств
type: string
example: tZ0jUmlsV0
readOnly: true
createdAt:
description: Дата и время запуска корректировки
type: string
format: date-time
readOnly: true
operation_timestamp:
description: Дата и время запуска корректировки
type: string
format: date-time
readOnly: true
domainRevision:
type: integer
format: int64
partyRevision:
type: integer
format: int64
externalID:
description: |
Уникальный идентификатор сущности на вашей стороне.
При указании будет использован для того, чтобы гарантировать идемпотентную обработку операции.
type: string
example: '10036274'
- $ref: '#/definitions/AdjustmentStatus'
AdjustmentFailure:
type: object
required:
- code
properties:
code:
description: Код ошибки отмены
type: string
subError:
$ref: '#/definitions/SubFailure'
AdjustmentID:
description: Идентификатор корректировки поступления денежных средств
type: string
example: tZ0jUmlsV0
AdjustmentStatus:
type: object
properties:
status:
description: |
Статус корректировки поступления денежных средств.
| Значение | Пояснение |
| ----------- | ------------------------------------------------------- |
| `Pending` | Корректировка в процессе выполнения |
| `Succeeded` | Корректировка произведёна успешно |
| `Failed` | Корректировка завершилась неудачей |
type: string
enum:
- Pending
- Succeeded
- Failed
readOnly: true
failure:
description: |
> Если `status` == `Failed`
Пояснение причины неудачи
readOnly: true
type: object
required:
- code
properties:
code:
description: Код ошибки отмены
type: string
subError:
$ref: '#/definitions/SubFailure'
Asset:
description: |
Объём денежных средств
@ -3790,6 +4051,116 @@ definitions:
type: string
pattern: '^[A-Z]{3}$'
example: RUS
Revert:
description: Данные отмены поступления денежных средств
allOf:
- type: object
required:
- wallet
- source
- body
properties:
id:
description: "Идентификатор отмены поступления денежных средств\_"
type: string
example: '10068321'
readOnly: true
createdAt:
description: Дата и время запуска отмены
type: string
format: date-time
readOnly: true
wallet:
description: Идентификатор кошелька
type: string
example: '10068321'
source:
description: Идентификатор источника денежных средств
type: string
example: '107498'
body:
description: Объём поступивших средств
type: object
required:
- amount
- currency
properties:
amount:
description: |
Сумма денежных средств в минорных единицах, например, в копейках
type: integer
format: int64
example: 1430000
currency:
description: |
Валюта, символьный код согласно [ISO
4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
type: string
pattern: '^[A-Z]{3}$'
example: RUB
reason:
type: string
domainRevision:
type: integer
format: int64
partyRevision:
type: integer
format: int64
externalID:
description: |
Уникальный идентификатор сущности на вашей стороне.
При указании будет использован для того, чтобы гарантировать идемпотентную обработку операции.
type: string
example: '10036274'
- $ref: '#/definitions/RevertStatus'
RevertFailure:
type: object
required:
- code
properties:
code:
description: Код ошибки отмены
type: string
subError:
$ref: '#/definitions/SubFailure'
RevertID:
description: "Идентификатор отмены поступления денежных средств\_"
type: string
example: '10068321'
RevertStatus:
type: object
properties:
status:
description: |
Статус отмены поступления денежных средств.
| Значение | Пояснение |
| ----------- | ------------------------------------------------------- |
| `Pending` | Отмена в процессе выполнения |
| `Succeeded` | Отмена поступления средств произведёна успешно |
| `Failed` | Отмена поступления средств завершилась неудачей |
type: string
enum:
- Pending
- Succeeded
- Failed
readOnly: true
failure:
description: |
> Если `status` == `Failed`
Пояснение причины неудачи
readOnly: true
type: object
required:
- code
properties:
code:
description: Код ошибки отмены
type: string
subError:
$ref: '#/definitions/SubFailure'
Ripple:
allOf:
- $ref: '#/definitions/CryptoWallet'