From faf1c999dcbaf4dcfeafc8bd63b3423acb499f5d Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:03 +0700 Subject: [PATCH 01/89] New translations signature.yaml (English) --- en/openapi/components/parameters/signature.yaml | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 en/openapi/components/parameters/signature.yaml diff --git a/en/openapi/components/parameters/signature.yaml b/en/openapi/components/parameters/signature.yaml new file mode 100644 index 00000000..f78bf0f4 --- /dev/null +++ b/en/openapi/components/parameters/signature.yaml @@ -0,0 +1,7 @@ +name: Content-Signature +in: header +description: > + Подпись сообщения, сформированная согласно указанным выше правилам +required: true +schema: + type: string From 234ff0569a15620248b620ce2c106e6b6ff9ab48 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:04 +0700 Subject: [PATCH 02/89] New translations AccountID.yaml (English) --- en/openapi/components/schemas/AccountID.yaml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 en/openapi/components/schemas/AccountID.yaml diff --git a/en/openapi/components/schemas/AccountID.yaml b/en/openapi/components/schemas/AccountID.yaml new file mode 100644 index 00000000..ee2f909a --- /dev/null +++ b/en/openapi/components/schemas/AccountID.yaml @@ -0,0 +1,3 @@ +description: Идентификатор счета +type: string +example: tZ0jUmlsV0 From 7f9ef9526b1e0cff20fe5b035974c7343f0cf331 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:04 +0700 Subject: [PATCH 03/89] New translations AccountNumber.yaml (English) --- en/openapi/components/schemas/AccountNumber.yaml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 en/openapi/components/schemas/AccountNumber.yaml diff --git a/en/openapi/components/schemas/AccountNumber.yaml b/en/openapi/components/schemas/AccountNumber.yaml new file mode 100644 index 00000000..5ab6dd8b --- /dev/null +++ b/en/openapi/components/schemas/AccountNumber.yaml @@ -0,0 +1,4 @@ +description: Номер счета +type: integer +format: int64 +example: 1430000 From 2d64495a9d0a8c8edc2b253f0a8517d8d0bc95c4 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:05 +0700 Subject: [PATCH 04/89] New translations BankCard.yaml (English) --- en/openapi/components/schemas/BankCard.yaml | 26 +++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 en/openapi/components/schemas/BankCard.yaml diff --git a/en/openapi/components/schemas/BankCard.yaml b/en/openapi/components/schemas/BankCard.yaml new file mode 100644 index 00000000..0abcf526 --- /dev/null +++ b/en/openapi/components/schemas/BankCard.yaml @@ -0,0 +1,26 @@ +description: Данные банковской карты +allOf: + - + $ref: '../schemas/DestinationResource.yaml' + - + type: object + required: + - cardNumberMask + - paymentSystem + properties: + cardNumberMask: + description: Маскированый номер карты + type: string + pattern: '^\d{6,8}\*+\d{2,4}$' + bin: + description: BIN банка-эмитента карты + type: string + pattern: '^\d{6,8}$' + lastDigits: + description: Последние цифры номера карты + type: string + pattern: '^\d{2,4}$' + paymentSystem: + $ref: '../schemas/BankCardPaymentSystem.yaml' + tokenProvider: + $ref: '../schemas/BankCardTokenProvider.yaml' From 47caace21e8ca32ce7f35cf97fc681296357799b Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:06 +0700 Subject: [PATCH 05/89] New translations BankCardPaymentSystem.yaml (English) --- .../components/schemas/BankCardPaymentSystem.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 en/openapi/components/schemas/BankCardPaymentSystem.yaml diff --git a/en/openapi/components/schemas/BankCardPaymentSystem.yaml b/en/openapi/components/schemas/BankCardPaymentSystem.yaml new file mode 100644 index 00000000..089465a7 --- /dev/null +++ b/en/openapi/components/schemas/BankCardPaymentSystem.yaml @@ -0,0 +1,12 @@ +description: Платежная система +type: string +#enum: +#- visa +#- mastercard +#- dankort +#- amex +#- dinersclub +#- discover +#- unionpay +#- jcb +#- nspkmir \ No newline at end of file From 209e2cf26214c0cad0422ce22b0b06654440ab47 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:06 +0700 Subject: [PATCH 06/89] New translations BankCardTokenProvider.yaml (English) --- en/openapi/components/schemas/BankCardTokenProvider.yaml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 en/openapi/components/schemas/BankCardTokenProvider.yaml diff --git a/en/openapi/components/schemas/BankCardTokenProvider.yaml b/en/openapi/components/schemas/BankCardTokenProvider.yaml new file mode 100644 index 00000000..9e4ce430 --- /dev/null +++ b/en/openapi/components/schemas/BankCardTokenProvider.yaml @@ -0,0 +1,6 @@ +description: Провайдер платежных токенов +type: string +enum: + - applepay + - googlepay + - samsungpay From 35a8947806ed5159d3d8a75243a369514a2450a3 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:07 +0700 Subject: [PATCH 07/89] New translations CryptoCurrency.yaml (English) --- en/openapi/components/schemas/CryptoCurrency.yaml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 en/openapi/components/schemas/CryptoCurrency.yaml diff --git a/en/openapi/components/schemas/CryptoCurrency.yaml b/en/openapi/components/schemas/CryptoCurrency.yaml new file mode 100644 index 00000000..654cd016 --- /dev/null +++ b/en/openapi/components/schemas/CryptoCurrency.yaml @@ -0,0 +1,9 @@ +description: Криптовалюта +type: string +enum: + - Bitcoin + - Litecoin + - BitcoinCash + - Ripple + - Ethereum + - Zcash From 422f53e71e68696b839aa477dace38cb223e93d4 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:08 +0700 Subject: [PATCH 08/89] New translations CryptoWallet.yaml (English) --- .../components/schemas/CryptoWallet.yaml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 en/openapi/components/schemas/CryptoWallet.yaml diff --git a/en/openapi/components/schemas/CryptoWallet.yaml b/en/openapi/components/schemas/CryptoWallet.yaml new file mode 100644 index 00000000..800a4377 --- /dev/null +++ b/en/openapi/components/schemas/CryptoWallet.yaml @@ -0,0 +1,18 @@ +description: Данные криптовалютного кошелька +allOf: + - + $ref: '../schemas/DestinationResource.yaml' + - + type: object + required: + - cryptoWalletId + - currency + properties: + cryptoWalletId: + description: Идентификатор (он же адрес) криптовалютного кошелька + type: string + minLength: 16 + maxLength: 256 + example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQ + currency: + $ref: '../schemas/CryptoCurrency.yaml' From e4d12ecf696f68a53e7689b964f88beac38fdacc Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:09 +0700 Subject: [PATCH 09/89] New translations CurrencyID.yaml (English) --- en/openapi/components/schemas/CurrencyID.yaml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 en/openapi/components/schemas/CurrencyID.yaml diff --git a/en/openapi/components/schemas/CurrencyID.yaml b/en/openapi/components/schemas/CurrencyID.yaml new file mode 100644 index 00000000..b0d28739 --- /dev/null +++ b/en/openapi/components/schemas/CurrencyID.yaml @@ -0,0 +1,6 @@ +description: | + Валюта, символьный код согласно [ISO + 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). +type: string +pattern: '^[A-Z]{3}$' +example: RUB From a8d91ea956589b927fd1ee9ff38a1d929c99ab95 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:10 +0700 Subject: [PATCH 10/89] New translations Destination.yaml (English) --- .../components/schemas/Destination.yaml | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 en/openapi/components/schemas/Destination.yaml diff --git a/en/openapi/components/schemas/Destination.yaml b/en/openapi/components/schemas/Destination.yaml new file mode 100644 index 00000000..c96006b1 --- /dev/null +++ b/en/openapi/components/schemas/Destination.yaml @@ -0,0 +1,30 @@ +description: Данные приемника денежных средств +type: object +required: + - name + - identity + - currency + - resource +properties: + id: + $ref: '../schemas/DestinationID.yaml' + name: + description: | + Человекочитаемое название приёмника средств, по которому его легко узнать + type: string + example: Squarey plastic thingy + identity: + $ref: '../schemas/IdentityID.yaml' + currency: + $ref: '../schemas/CurrencyID.yaml' + resource: + $ref: '../schemas/DestinationResource.yaml' + metadata: + description: | + Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с + данным приёмником + type: object + example: + color_hint: olive-green + externalID: + $ref: '../schemas/ExternalID.yaml' From 0e9c8b6bba9985d4e7cc12a744b6ee38d092bb10 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:10 +0700 Subject: [PATCH 11/89] New translations DestinationAuthorized.yaml (English) --- .../components/schemas/DestinationAuthorized.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 en/openapi/components/schemas/DestinationAuthorized.yaml diff --git a/en/openapi/components/schemas/DestinationAuthorized.yaml b/en/openapi/components/schemas/DestinationAuthorized.yaml new file mode 100644 index 00000000..6eecf0bd --- /dev/null +++ b/en/openapi/components/schemas/DestinationAuthorized.yaml @@ -0,0 +1,13 @@ +description: Смена статуса приемника на авторизованный +allOf: + - + $ref: '../schemas/Event.yaml' + - + type: object + required: + - destinationID + properties: + destinationID: + $ref: '../schemas/DestinationID.yaml' + externalID: + $ref: '../schemas/ExternalID.yaml' From 368905188bdfa18d5620c4503dbc14e214179979 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:11 +0700 Subject: [PATCH 12/89] New translations DestinationCreated.yaml (English) --- en/openapi/components/schemas/DestinationCreated.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 en/openapi/components/schemas/DestinationCreated.yaml diff --git a/en/openapi/components/schemas/DestinationCreated.yaml b/en/openapi/components/schemas/DestinationCreated.yaml new file mode 100644 index 00000000..790c58fc --- /dev/null +++ b/en/openapi/components/schemas/DestinationCreated.yaml @@ -0,0 +1,11 @@ +description: Событие создания приемника денежных средств +allOf: + - + $ref: '../schemas/Event.yaml' + - + type: object + required: + - destination + properties: + destination: + $ref: '../schemas/Destination.yaml' From bd55f1452c0b3d2b292d730fb02e507026f5ef1e Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:12 +0700 Subject: [PATCH 13/89] New translations DestinationID.yaml (English) --- en/openapi/components/schemas/DestinationID.yaml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 en/openapi/components/schemas/DestinationID.yaml diff --git a/en/openapi/components/schemas/DestinationID.yaml b/en/openapi/components/schemas/DestinationID.yaml new file mode 100644 index 00000000..c0f01044 --- /dev/null +++ b/en/openapi/components/schemas/DestinationID.yaml @@ -0,0 +1,3 @@ +description: Идентификатор места назначения денежных средств +type: string +example: "10ASF74D98" From f455fe6cdb6f818f5ce4d4137304e6f0aaf8de12 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:12 +0700 Subject: [PATCH 14/89] New translations DestinationName.yaml (English) --- en/openapi/components/schemas/DestinationName.yaml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 en/openapi/components/schemas/DestinationName.yaml diff --git a/en/openapi/components/schemas/DestinationName.yaml b/en/openapi/components/schemas/DestinationName.yaml new file mode 100644 index 00000000..679ceeb6 --- /dev/null +++ b/en/openapi/components/schemas/DestinationName.yaml @@ -0,0 +1,3 @@ +description: Человекочитаемое название места назначения, по которому его легко узнать +type: string +example: "Worldwide PHP Awareness Initiative" From 7dad69c2ab9a066b12e52c1f4295bd6205234fa0 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:13 +0700 Subject: [PATCH 15/89] New translations DestinationResource.yaml (English) --- .../schemas/DestinationResource.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 en/openapi/components/schemas/DestinationResource.yaml diff --git a/en/openapi/components/schemas/DestinationResource.yaml b/en/openapi/components/schemas/DestinationResource.yaml new file mode 100644 index 00000000..f6a5dbfc --- /dev/null +++ b/en/openapi/components/schemas/DestinationResource.yaml @@ -0,0 +1,19 @@ +description: Ресурс приёмника денежных средств, используемый для осуществления выводов +type: object +required: + - type +properties: + type: + description: | + Тип ресурса приёмника средств. + type: string + enum: + - BankCard + - CryptoWallet + - DigitalWallet +discriminator: + propertyName: type + mapping: + 'BankCard': '../schemas/BankCard.yaml' + 'CryptoWallet': '../schemas/CryptoWallet.yaml' + 'DigitalWallet': '../schemas/DigitalWallet.yaml' From e3bf815c79f27179506806366fbab86e851ad767 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:14 +0700 Subject: [PATCH 16/89] New translations DestinationUnauthorized.yaml (English) --- .../components/schemas/DestinationUnauthorized.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 en/openapi/components/schemas/DestinationUnauthorized.yaml diff --git a/en/openapi/components/schemas/DestinationUnauthorized.yaml b/en/openapi/components/schemas/DestinationUnauthorized.yaml new file mode 100644 index 00000000..a3a533fb --- /dev/null +++ b/en/openapi/components/schemas/DestinationUnauthorized.yaml @@ -0,0 +1,13 @@ +description: Смена статуса приемника на не авторизованный +allOf: + - + $ref: '../schemas/Event.yaml' + - + type: object + required: + - destinationID + properties: + destinationID: + $ref: '../schemas/DestinationID.yaml' + externalID: + $ref: '../schemas/ExternalID.yaml' From ab5955ea569b0c6bbbc48b1bca29cb5f4d9bffb1 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:15 +0700 Subject: [PATCH 17/89] New translations DigitalWallet.yaml (English) --- .../components/schemas/DigitalWallet.yaml | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 en/openapi/components/schemas/DigitalWallet.yaml diff --git a/en/openapi/components/schemas/DigitalWallet.yaml b/en/openapi/components/schemas/DigitalWallet.yaml new file mode 100644 index 00000000..710e63ad --- /dev/null +++ b/en/openapi/components/schemas/DigitalWallet.yaml @@ -0,0 +1,21 @@ +description: Данные криптовалютного кошелька +allOf: + - + $ref: '../schemas/DestinationResource.yaml' + - + type: object + required: + - digitalWalletId + - digitalWalletProvider + properties: + digitalWalletId: + description: Идентификатор кошелька + type: string + minLength: 16 + maxLength: 256 + example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQ + digitalWalletProvider: + description: Провайдер электронных денежных средств + type: string + example: Paypal + From 5fa77edc62fdd0fcd4c175b0f537d03ba66958fd Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:16 +0700 Subject: [PATCH 18/89] New translations Event.yaml (English) --- en/openapi/components/schemas/Event.yaml | 39 ++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 en/openapi/components/schemas/Event.yaml diff --git a/en/openapi/components/schemas/Event.yaml b/en/openapi/components/schemas/Event.yaml new file mode 100644 index 00000000..5925d245 --- /dev/null +++ b/en/openapi/components/schemas/Event.yaml @@ -0,0 +1,39 @@ +description: Данные события +type: object +required: + - occuredAt + - topic + - eventType +properties: + eventID: + description: Идентификатор события в системе + type: string + occuredAt: + description: Дата и время возникновения события + type: string + format: date-time + topic: + description: Предмет оповещения + type: string + enum: + - WithdrawalTopic + - DestinationTopic + eventType: + type: string + description: Тип произошедшего с предметом оповещения события + enum: + - WithdrawalStarted + - WithdrawalSucceeded + - WithdrawalFailed + - DestinationCreated + - DestinationAuthorized + - DestinationUnauthorized +discriminator: + propertyName: eventType + mapping: + 'WithdrawalStarted': '../schemas/WithdrawalStarted.yaml' + 'WithdrawalSucceeded': '../schemas/WithdrawalSucceeded.yaml' + 'WithdrawalFailed': '../schemas/WithdrawalFailed.yaml' + 'DestinationCreated': '../schemas/DestinationCreated.yaml' + 'DestinationAuthorized': '../schemas/DestinationAuthorized.yaml' + 'DestinationUnauthorized': '../schemas/DestinationUnauthorized.yaml' From 4795fd6c8093ce4eebdbac7ed3b691b688d99821 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:16 +0700 Subject: [PATCH 19/89] New translations ExternalID.yaml (English) --- en/openapi/components/schemas/ExternalID.yaml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 en/openapi/components/schemas/ExternalID.yaml diff --git a/en/openapi/components/schemas/ExternalID.yaml b/en/openapi/components/schemas/ExternalID.yaml new file mode 100644 index 00000000..9aef5e9f --- /dev/null +++ b/en/openapi/components/schemas/ExternalID.yaml @@ -0,0 +1,6 @@ +description: | + Уникальный идентификатор сущности на вашей стороне. + + При указании будет использован для того, чтобы гарантировать идемпотентную обработку операции. +type: string +example: "10036274" From 51c3ab8d154e049a42e852ff2605aa6dda576536 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:17 +0700 Subject: [PATCH 20/89] New translations GeneralError.yaml (English) --- en/openapi/components/schemas/GeneralError.yaml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 en/openapi/components/schemas/GeneralError.yaml diff --git a/en/openapi/components/schemas/GeneralError.yaml b/en/openapi/components/schemas/GeneralError.yaml new file mode 100644 index 00000000..aa3e7ae7 --- /dev/null +++ b/en/openapi/components/schemas/GeneralError.yaml @@ -0,0 +1,6 @@ +type: object +required: + - message +properties: + message: + type: string From 50df4652d698d3e261da1c1a53179d377c42e574 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:18 +0700 Subject: [PATCH 21/89] New translations IdentityID.yaml (English) --- en/openapi/components/schemas/IdentityID.yaml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 en/openapi/components/schemas/IdentityID.yaml diff --git a/en/openapi/components/schemas/IdentityID.yaml b/en/openapi/components/schemas/IdentityID.yaml new file mode 100644 index 00000000..e28dbba7 --- /dev/null +++ b/en/openapi/components/schemas/IdentityID.yaml @@ -0,0 +1,3 @@ +description: Идентификатор личности владельца кошелька +type: string +example: tZ0jUmlsV0 From 06baa7f7af9d985309726d284cb1b2ee2314de80 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:19 +0700 Subject: [PATCH 22/89] New translations WalletID.yaml (English) --- en/openapi/components/schemas/WalletID.yaml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 en/openapi/components/schemas/WalletID.yaml diff --git a/en/openapi/components/schemas/WalletID.yaml b/en/openapi/components/schemas/WalletID.yaml new file mode 100644 index 00000000..148b2ab4 --- /dev/null +++ b/en/openapi/components/schemas/WalletID.yaml @@ -0,0 +1,3 @@ +description: Идентификатор кошелька +type: string +example: "10068321" From 3c332698842d999ee116308a9ff42e2847a92b12 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:19 +0700 Subject: [PATCH 23/89] New translations Withdrawal.yaml (English) --- en/openapi/components/schemas/Withdrawal.yaml | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 en/openapi/components/schemas/Withdrawal.yaml diff --git a/en/openapi/components/schemas/Withdrawal.yaml b/en/openapi/components/schemas/Withdrawal.yaml new file mode 100644 index 00000000..e01c4f52 --- /dev/null +++ b/en/openapi/components/schemas/Withdrawal.yaml @@ -0,0 +1,25 @@ +description: Данные вывода денежных средств +type: object +required: + - wallet + - destination + - body +properties: + id: + $ref: '../schemas/WithdrawalID.yaml' + createdAt: + description: Дата и время запуска вывода + type: string + format: date-time + destination: + $ref: '../schemas/DestinationID.yaml' + body: + $ref: '../schemas/WithdrawalBody.yaml' + metadata: + description: | + Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с + данным выводом + wallet: + $ref: '../schemas/WalletID.yaml' + externalID: + $ref: '../schemas/ExternalID.yaml' From 82a177f007f663f4f04ba83db62aab8bfcf21fe9 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:20 +0700 Subject: [PATCH 24/89] New translations WithdrawalBody.yaml (English) --- en/openapi/components/schemas/WithdrawalBody.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 en/openapi/components/schemas/WithdrawalBody.yaml diff --git a/en/openapi/components/schemas/WithdrawalBody.yaml b/en/openapi/components/schemas/WithdrawalBody.yaml new file mode 100644 index 00000000..6688240e --- /dev/null +++ b/en/openapi/components/schemas/WithdrawalBody.yaml @@ -0,0 +1,15 @@ +description: | + Объём средств, которые необходимо вывести +type: object +required: + - amount + - currency +properties: + amount: + description: | + Сумма денежных средств в минорных единицах, например, в копейках + type: integer + format: int64 + example: 1430000 + currency: + $ref: '../schemas/CurrencyID.yaml' From 75d4ad4c5e055aa43f03a20431d9d759076cf4a9 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:21 +0700 Subject: [PATCH 25/89] New translations WithdrawalFailed.yaml (English) --- en/openapi/components/schemas/WithdrawalFailed.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 en/openapi/components/schemas/WithdrawalFailed.yaml diff --git a/en/openapi/components/schemas/WithdrawalFailed.yaml b/en/openapi/components/schemas/WithdrawalFailed.yaml new file mode 100644 index 00000000..c2e5712c --- /dev/null +++ b/en/openapi/components/schemas/WithdrawalFailed.yaml @@ -0,0 +1,13 @@ +description: Событие о неуспешном осуществлении вывода средств +allOf: + - + $ref: '../schemas/Event.yaml' + - + type: object + required: + - withdrawalID + properties: + withdrawalID: + $ref: '../schemas/WithdrawalID.yaml' + externalID: + $ref: '../schemas/ExternalID.yaml' From 5f62067db55d53305849a88b96804618b7d8f9e8 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:22 +0700 Subject: [PATCH 26/89] New translations WithdrawalID.yaml (English) --- en/openapi/components/schemas/WithdrawalID.yaml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 en/openapi/components/schemas/WithdrawalID.yaml diff --git a/en/openapi/components/schemas/WithdrawalID.yaml b/en/openapi/components/schemas/WithdrawalID.yaml new file mode 100644 index 00000000..8c69e206 --- /dev/null +++ b/en/openapi/components/schemas/WithdrawalID.yaml @@ -0,0 +1,3 @@ +description: Идентификатор вывода денежных средств +type: string +example: tZ0jUmlsV0 From 3b1b5ff6372a310d8771ff2f15b79f822ed70a1c Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:23 +0700 Subject: [PATCH 27/89] New translations WithdrawalStarted.yaml (English) --- en/openapi/components/schemas/WithdrawalStarted.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 en/openapi/components/schemas/WithdrawalStarted.yaml diff --git a/en/openapi/components/schemas/WithdrawalStarted.yaml b/en/openapi/components/schemas/WithdrawalStarted.yaml new file mode 100644 index 00000000..19a380c9 --- /dev/null +++ b/en/openapi/components/schemas/WithdrawalStarted.yaml @@ -0,0 +1,11 @@ +description: Событие о начале осуществления вывода средств +allOf: + - + $ref: '../schemas/Event.yaml' + - + type: object + required: + - withdrawal + properties: + withdrawal: + $ref: '../schemas/Withdrawal.yaml' From 9212e6f752859d221427e99b93f9d41f4258666f Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:23 +0700 Subject: [PATCH 28/89] New translations WithdrawalSucceeded.yaml (English) --- .../components/schemas/WithdrawalSucceeded.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 en/openapi/components/schemas/WithdrawalSucceeded.yaml diff --git a/en/openapi/components/schemas/WithdrawalSucceeded.yaml b/en/openapi/components/schemas/WithdrawalSucceeded.yaml new file mode 100644 index 00000000..c1adfa30 --- /dev/null +++ b/en/openapi/components/schemas/WithdrawalSucceeded.yaml @@ -0,0 +1,13 @@ +description: Событие об успешном осуществлении вывода средств +allOf: + - + $ref: '../schemas/Event.yaml' + - + type: object + required: + - withdrawalID + properties: + withdrawalID: + $ref: '../schemas/WithdrawalID.yaml' + externalID: + $ref: '../schemas/ExternalID.yaml' From bff08de694b849846ac4773d6ccb072216ec39b7 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:24 +0700 Subject: [PATCH 29/89] New translations openapi.yaml (English) --- en/openapi/openapi.yaml | 91 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 en/openapi/openapi.yaml diff --git a/en/openapi/openapi.yaml b/en/openapi/openapi.yaml new file mode 100644 index 00000000..24cc6b0d --- /dev/null +++ b/en/openapi/openapi.yaml @@ -0,0 +1,91 @@ +openapi: 3.0.0 +info: + version: 0.1.0 + title: Vality Wallets. Webhooks Events API + termsOfService: https://vality.dev/ + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + description: | + + ## Wallet Webhook Events API + + Данная спецификация определяет протокол доставки оповещений о возникновении + новых событий по кошелькам в рамках вашей организации, которые система доставляет в + виде HTTP-запросов на URL-адреса созданных вами webhook'ов. Обработчики для + подобного рода запросов необходимо реализовать на стороне вашего серверного + кода согласно данной спецификации. + + Webhook — это подписка на определенный тип события либо их группу, + касающихся различных объектов в рамках вашей организации. Для управления + webhook'ами используются методы API, описанные в спецификации + [Vality Webhook Management API](https://github.com/valitydev/swag-wallets). + Когда наступает одно из событий в рамках определенного кошелька (например, + изменение статуса кошелька), система выбирает + webhook, подходящий под этот тип события, и отправляет HTTP-запрос, + содержащий сообщение в формате JSON на указанный в этом webhook'е URL. Если + вы создали несколько webhook'ов, подходящих под этот тип события, то событие + доставляется одновременно на все заданные в них URL в неопределённом + порядке. + + ## Стратегия доставки + + Система гарантирует порядок доставки событий в рамках определенного предмета оповещения + (кошелек, пополнение, выплата и т.п.). Система поддерживает очередь сообщений для каждого + предмета оповещения, чтобы соблюсти очередность и гарантированную доставку. + + Запрос на доставку считается успешным только при получении ответа со + статусом `200`. Система будет ожидать успешного ответа на отправленный + запрос в течение 10 секунд. В случае ответа любым другим статусом или по + истечении указанного времени, отведённого на обработку оповещения, система + будет пытаться повторно доставить оповещения до получения успешного ответа, + либо до принятия решения о невозможности доставить информацию. Попытки + доставки будут производиться со следующими временными интервалами между + запросами: + + - 30 секунд, + - 5 минут, + - 15 минут, + - 1 час. + - каждый час в течение суток (24 часа) + + Если последняя попытка доставить оповещение оканчивается неудачей, все события, которые + накопились в очереди этого кошелька, отбрасываются. + + ## Авторизация полученных сообщений + + Система подтверждает подлинность оповещений, подписывая сообщения + приватным ключом, уникальным для каждого webhook'а, парный публичный ключ к + которому содержится в данных этого webhook'а. Подпись передается в + HTTP-заголовке `Content-Signature`. В заголовке в виде различных атрибутов + содержится информация об использованном при формировании подписи алгоритме и + значение подписи в формате + [URL-safe base-64](https://tools.ietf.org/html/rfc4648). + + ``` + Content-Signature: alg=RS256; digest=zFuf7bRH4RHwyktaqHQwmX5rn3LfSb4dKo... + ``` + + На данный момент возможно использование единственного алоритма формирования + подписи. + + ### [RS256](https://tools.ietf.org/html/rfc7518#section-3.3) + + Подпись формируется согласно алгоритму + [RSASSA-PKCS1-v1_5](https://tools.ietf.org/html/rfc3447#section-8.2), на + вход которому подаётся результат вычисления хэша сообщения по алгоритму + [SHA-256](https://tools.ietf.org/html/rfc6234). + + Набор атрибутов заголовка и список возможных алгоритмов формирования подписи + в дальнейшем могут быть расширены. +servers: + - + url: 'https://merchant.site' +tags: + - + name: Event Notifications + x-displayName: Оповещения + description: Доставка оповещений о событиях системы. +paths: + '/webhook': + $ref: './paths/webhook-url.yaml' From ac13b3ae7a4a6904ae4acbdb20b8a4da19eb2f51 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 12:08:25 +0700 Subject: [PATCH 30/89] New translations webhook-url.yaml (English) --- en/openapi/paths/webhook-url.yaml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 en/openapi/paths/webhook-url.yaml diff --git a/en/openapi/paths/webhook-url.yaml b/en/openapi/paths/webhook-url.yaml new file mode 100644 index 00000000..9061bab1 --- /dev/null +++ b/en/openapi/paths/webhook-url.yaml @@ -0,0 +1,18 @@ +post: + tags: + - Event Notifications + summary: Оповестить о событии + operationId: notifyWebhookEvent + parameters: + - + $ref: '../components/parameters/signature.yaml' + requestBody: + description: Данные произошедшего в платформе события + required: true + content: + application/json: + schema: + $ref: '../components/schemas/Event.yaml' + responses: + '200': + description: Оповещение обработано From 55361b2af9cf527d48ae1226fc7289591a896a80 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:46 +0700 Subject: [PATCH 31/89] New translations AccountNumber.yaml (English) --- en/openapi/components/schemas/AccountNumber.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/AccountNumber.yaml b/en/openapi/components/schemas/AccountNumber.yaml index 5ab6dd8b..11e7f62d 100644 --- a/en/openapi/components/schemas/AccountNumber.yaml +++ b/en/openapi/components/schemas/AccountNumber.yaml @@ -1,4 +1,4 @@ -description: Номер счета +description: Account number type: integer format: int64 example: 1430000 From fd4b4002d40c7dc08f2c04a055061f18f4a63191 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:47 +0700 Subject: [PATCH 32/89] New translations BankCard.yaml (English) --- en/openapi/components/schemas/BankCard.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/en/openapi/components/schemas/BankCard.yaml b/en/openapi/components/schemas/BankCard.yaml index 0abcf526..bf47a6e7 100644 --- a/en/openapi/components/schemas/BankCard.yaml +++ b/en/openapi/components/schemas/BankCard.yaml @@ -1,4 +1,4 @@ -description: Данные банковской карты +description: Bank card details allOf: - $ref: '../schemas/DestinationResource.yaml' @@ -9,15 +9,15 @@ allOf: - paymentSystem properties: cardNumberMask: - description: Маскированый номер карты + description: Masked card number type: string pattern: '^\d{6,8}\*+\d{2,4}$' bin: - description: BIN банка-эмитента карты + description: Card issuing bank BIN type: string pattern: '^\d{6,8}$' lastDigits: - description: Последние цифры номера карты + description: Card last digits type: string pattern: '^\d{2,4}$' paymentSystem: From abcae4e63b021bbfddabbf468bf73cc604eeaf66 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:48 +0700 Subject: [PATCH 33/89] New translations BankCardPaymentSystem.yaml (English) --- en/openapi/components/schemas/BankCardPaymentSystem.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/BankCardPaymentSystem.yaml b/en/openapi/components/schemas/BankCardPaymentSystem.yaml index 089465a7..70c6f7c5 100644 --- a/en/openapi/components/schemas/BankCardPaymentSystem.yaml +++ b/en/openapi/components/schemas/BankCardPaymentSystem.yaml @@ -1,4 +1,4 @@ -description: Платежная система +description: Payment system type: string #enum: #- visa From 757d2401692b96c5e29a7f9856bd64eb7a175ac1 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:49 +0700 Subject: [PATCH 34/89] New translations BankCardTokenProvider.yaml (English) --- en/openapi/components/schemas/BankCardTokenProvider.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/BankCardTokenProvider.yaml b/en/openapi/components/schemas/BankCardTokenProvider.yaml index 9e4ce430..cfa8786d 100644 --- a/en/openapi/components/schemas/BankCardTokenProvider.yaml +++ b/en/openapi/components/schemas/BankCardTokenProvider.yaml @@ -1,4 +1,4 @@ -description: Провайдер платежных токенов +description: Payment token provider type: string enum: - applepay From 412dba5ea787772c811e674da8b601fb11a1e85d Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:50 +0700 Subject: [PATCH 35/89] New translations CryptoWallet.yaml (English) --- en/openapi/components/schemas/CryptoWallet.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/CryptoWallet.yaml b/en/openapi/components/schemas/CryptoWallet.yaml index 800a4377..eed3b322 100644 --- a/en/openapi/components/schemas/CryptoWallet.yaml +++ b/en/openapi/components/schemas/CryptoWallet.yaml @@ -1,4 +1,4 @@ -description: Данные криптовалютного кошелька +description: Cryptocurrency wallet details allOf: - $ref: '../schemas/DestinationResource.yaml' @@ -9,7 +9,7 @@ allOf: - currency properties: cryptoWalletId: - description: Идентификатор (он же адрес) криптовалютного кошелька + description: Identifier (aka address) of a cryptocurrency wallet type: string minLength: 16 maxLength: 256 From 67efa48d8e96bbbcf13419e164e08e76888a705e Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:51 +0700 Subject: [PATCH 36/89] New translations CurrencyID.yaml (English) --- en/openapi/components/schemas/CurrencyID.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/CurrencyID.yaml b/en/openapi/components/schemas/CurrencyID.yaml index b0d28739..586a9827 100644 --- a/en/openapi/components/schemas/CurrencyID.yaml +++ b/en/openapi/components/schemas/CurrencyID.yaml @@ -1,5 +1,5 @@ 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}$' From 5644477e6697f1d6c0c75fc27e4e605ea44839c6 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:51 +0700 Subject: [PATCH 37/89] New translations Destination.yaml (English) --- en/openapi/components/schemas/Destination.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/Destination.yaml b/en/openapi/components/schemas/Destination.yaml index c96006b1..f71496c4 100644 --- a/en/openapi/components/schemas/Destination.yaml +++ b/en/openapi/components/schemas/Destination.yaml @@ -10,7 +10,7 @@ properties: $ref: '../schemas/DestinationID.yaml' name: description: | - Человекочитаемое название приёмника средств, по которому его легко узнать + A human-readable name for the receiver by which it is easily recognizable type: string example: Squarey plastic thingy identity: @@ -21,8 +21,8 @@ properties: $ref: '../schemas/DestinationResource.yaml' metadata: description: | - Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с - данным приёмником + An arbitrary, client-specific API and non-transparent set of data associated with + given receiver type: object example: color_hint: olive-green From 2e3b3dfe58187e1c50bd1bd9b717f1c2b1821856 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:54 +0700 Subject: [PATCH 38/89] New translations DestinationResource.yaml (English) --- en/openapi/components/schemas/DestinationResource.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/DestinationResource.yaml b/en/openapi/components/schemas/DestinationResource.yaml index f6a5dbfc..ced7a76e 100644 --- a/en/openapi/components/schemas/DestinationResource.yaml +++ b/en/openapi/components/schemas/DestinationResource.yaml @@ -1,4 +1,4 @@ -description: Ресурс приёмника денежных средств, используемый для осуществления выводов +description: Asset receiver resource used to make withdrawals type: object required: - type From 1c8b1df9b846d545a4864e59e06ca2d10ac14ed6 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:56 +0700 Subject: [PATCH 39/89] New translations DigitalWallet.yaml (English) --- en/openapi/components/schemas/DigitalWallet.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/DigitalWallet.yaml b/en/openapi/components/schemas/DigitalWallet.yaml index 710e63ad..d33952f9 100644 --- a/en/openapi/components/schemas/DigitalWallet.yaml +++ b/en/openapi/components/schemas/DigitalWallet.yaml @@ -1,4 +1,4 @@ -description: Данные криптовалютного кошелька +description: Cryptocurrency wallet details allOf: - $ref: '../schemas/DestinationResource.yaml' @@ -9,13 +9,13 @@ allOf: - digitalWalletProvider properties: digitalWalletId: - description: Идентификатор кошелька + description: E-wallet identifier type: string minLength: 16 maxLength: 256 example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQ digitalWalletProvider: - description: Провайдер электронных денежных средств + description: Electronic assets service provider type: string example: Paypal From 447bd6e64ac18d463824acf6c09d8264c87ada59 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:57 +0700 Subject: [PATCH 40/89] New translations Event.yaml (English) --- en/openapi/components/schemas/Event.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/Event.yaml b/en/openapi/components/schemas/Event.yaml index 5925d245..341f6aca 100644 --- a/en/openapi/components/schemas/Event.yaml +++ b/en/openapi/components/schemas/Event.yaml @@ -9,7 +9,7 @@ properties: description: Идентификатор события в системе type: string occuredAt: - description: Дата и время возникновения события + description: Date and time the event occurrence type: string format: date-time topic: From 835191cc689775413929ad090021ed759a7ff129 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:58 +0700 Subject: [PATCH 41/89] New translations ExternalID.yaml (English) --- en/openapi/components/schemas/ExternalID.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/ExternalID.yaml b/en/openapi/components/schemas/ExternalID.yaml index 9aef5e9f..c898d999 100644 --- a/en/openapi/components/schemas/ExternalID.yaml +++ b/en/openapi/components/schemas/ExternalID.yaml @@ -1,6 +1,6 @@ description: | - Уникальный идентификатор сущности на вашей стороне. + The unique identifier of the content on your side. - При указании будет использован для того, чтобы гарантировать идемпотентную обработку операции. + When specified, will be used to ensure idempotent processing of the operation. type: string example: "10036274" From caa96dcd67ff3806a5513b6f6ea327c5fcc810be Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:27:59 +0700 Subject: [PATCH 42/89] New translations IdentityID.yaml (English) --- en/openapi/components/schemas/IdentityID.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/IdentityID.yaml b/en/openapi/components/schemas/IdentityID.yaml index e28dbba7..146d825f 100644 --- a/en/openapi/components/schemas/IdentityID.yaml +++ b/en/openapi/components/schemas/IdentityID.yaml @@ -1,3 +1,3 @@ -description: Идентификатор личности владельца кошелька +description: Identifier of wallet owner type: string example: tZ0jUmlsV0 From f17b46e964a7032618848f73e0ffb7e96a0c8d18 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:28:00 +0700 Subject: [PATCH 43/89] New translations WalletID.yaml (English) --- en/openapi/components/schemas/WalletID.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/WalletID.yaml b/en/openapi/components/schemas/WalletID.yaml index 148b2ab4..5fea2d5a 100644 --- a/en/openapi/components/schemas/WalletID.yaml +++ b/en/openapi/components/schemas/WalletID.yaml @@ -1,3 +1,3 @@ -description: Идентификатор кошелька +description: Identifier of the wallet type: string example: "10068321" From 81a37fa905c37a2843031f75f64421de87b77237 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:28:01 +0700 Subject: [PATCH 44/89] New translations Withdrawal.yaml (English) --- en/openapi/components/schemas/Withdrawal.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/en/openapi/components/schemas/Withdrawal.yaml b/en/openapi/components/schemas/Withdrawal.yaml index e01c4f52..28193f6f 100644 --- a/en/openapi/components/schemas/Withdrawal.yaml +++ b/en/openapi/components/schemas/Withdrawal.yaml @@ -1,4 +1,4 @@ -description: Данные вывода денежных средств +description: Funds withdrawal data type: object required: - wallet @@ -8,7 +8,7 @@ properties: id: $ref: '../schemas/WithdrawalID.yaml' createdAt: - description: Дата и время запуска вывода + description: Date and time the withdrawal started type: string format: date-time destination: @@ -17,8 +17,8 @@ properties: $ref: '../schemas/WithdrawalBody.yaml' metadata: description: | - Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с - данным выводом + A random, client-specific API and a data set that is not transparent to the system, associated with + this withdrawal wallet: $ref: '../schemas/WalletID.yaml' externalID: From fece9181c4db282e2909ac2df5b89d7157091b04 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:28:01 +0700 Subject: [PATCH 45/89] New translations WithdrawalBody.yaml (English) --- en/openapi/components/schemas/WithdrawalBody.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/WithdrawalBody.yaml b/en/openapi/components/schemas/WithdrawalBody.yaml index 6688240e..9d5973dd 100644 --- a/en/openapi/components/schemas/WithdrawalBody.yaml +++ b/en/openapi/components/schemas/WithdrawalBody.yaml @@ -1,5 +1,5 @@ description: | - Объём средств, которые необходимо вывести + Amount of funds to be withdrawn type: object required: - amount @@ -7,7 +7,7 @@ required: properties: amount: description: | - Сумма денежных средств в минорных единицах, например, в копейках + The amount of money in minor units, for example, in cents type: integer format: int64 example: 1430000 From e7fc6917ac7233d05af1deedccea1012d298de4e Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 13:28:03 +0700 Subject: [PATCH 46/89] New translations WithdrawalID.yaml (English) --- en/openapi/components/schemas/WithdrawalID.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/WithdrawalID.yaml b/en/openapi/components/schemas/WithdrawalID.yaml index 8c69e206..e0394dc4 100644 --- a/en/openapi/components/schemas/WithdrawalID.yaml +++ b/en/openapi/components/schemas/WithdrawalID.yaml @@ -1,3 +1,3 @@ -description: Идентификатор вывода денежных средств +description: Identifier of funds withdrawal type: string example: tZ0jUmlsV0 From 5d7382d34d14ecc121d67c0815478261add4c335 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 15:21:28 +0700 Subject: [PATCH 47/89] New translations AccountID.yaml (English) --- en/openapi/components/schemas/AccountID.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/AccountID.yaml b/en/openapi/components/schemas/AccountID.yaml index ee2f909a..2ce9f5cc 100644 --- a/en/openapi/components/schemas/AccountID.yaml +++ b/en/openapi/components/schemas/AccountID.yaml @@ -1,3 +1,3 @@ -description: Идентификатор счета +description: Account identifier type: string example: tZ0jUmlsV0 From b266abf283522629a81b2ee311cab3014b520636 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 15:21:29 +0700 Subject: [PATCH 48/89] New translations CryptoCurrency.yaml (English) --- en/openapi/components/schemas/CryptoCurrency.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/CryptoCurrency.yaml b/en/openapi/components/schemas/CryptoCurrency.yaml index 654cd016..f22f8c15 100644 --- a/en/openapi/components/schemas/CryptoCurrency.yaml +++ b/en/openapi/components/schemas/CryptoCurrency.yaml @@ -1,4 +1,4 @@ -description: Криптовалюта +description: Cryptocurrency type: string enum: - Bitcoin From 627e56da28546c1e18d884a6e25865925d81e2bc Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 15:21:31 +0700 Subject: [PATCH 49/89] New translations Destination.yaml (English) --- en/openapi/components/schemas/Destination.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/Destination.yaml b/en/openapi/components/schemas/Destination.yaml index f71496c4..f0a0606c 100644 --- a/en/openapi/components/schemas/Destination.yaml +++ b/en/openapi/components/schemas/Destination.yaml @@ -1,4 +1,4 @@ -description: Данные приемника денежных средств +description: Destination data type: object required: - name From 30cc315edec3b7dc6400d7cf36424d5117a89ab4 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 3 Aug 2023 15:21:35 +0700 Subject: [PATCH 50/89] New translations Event.yaml (English) --- en/openapi/components/schemas/Event.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/Event.yaml b/en/openapi/components/schemas/Event.yaml index 341f6aca..b7170eb9 100644 --- a/en/openapi/components/schemas/Event.yaml +++ b/en/openapi/components/schemas/Event.yaml @@ -1,4 +1,4 @@ -description: Данные события +description: Event data type: object required: - occuredAt @@ -6,7 +6,7 @@ required: - eventType properties: eventID: - description: Идентификатор события в системе + description: Event identifier type: string occuredAt: description: Date and time the event occurrence From 1e5a10a47facf0dd1b2c5299450fda49926f53e1 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 00:30:22 +0700 Subject: [PATCH 51/89] New translations openapi.yaml (English) --- en/openapi/openapi.yaml | 89 ++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 60 deletions(-) diff --git a/en/openapi/openapi.yaml b/en/openapi/openapi.yaml index 24cc6b0d..c6316202 100644 --- a/en/openapi/openapi.yaml +++ b/en/openapi/openapi.yaml @@ -10,81 +10,50 @@ info: ## Wallet Webhook Events API - Данная спецификация определяет протокол доставки оповещений о возникновении - новых событий по кошелькам в рамках вашей организации, которые система доставляет в - виде HTTP-запросов на URL-адреса созданных вами webhook'ов. Обработчики для - подобного рода запросов необходимо реализовать на стороне вашего серверного - кода согласно данной спецификации. - - Webhook — это подписка на определенный тип события либо их группу, - касающихся различных объектов в рамках вашей организации. Для управления - webhook'ами используются методы API, описанные в спецификации - [Vality Webhook Management API](https://github.com/valitydev/swag-wallets). - Когда наступает одно из событий в рамках определенного кошелька (например, - изменение статуса кошелька), система выбирает - webhook, подходящий под этот тип события, и отправляет HTTP-запрос, - содержащий сообщение в формате JSON на указанный в этом webhook'е URL. Если - вы создали несколько webhook'ов, подходящих под этот тип события, то событие - доставляется одновременно на все заданные в них URL в неопределённом - порядке. - - ## Стратегия доставки - - Система гарантирует порядок доставки событий в рамках определенного предмета оповещения - (кошелек, пополнение, выплата и т.п.). Система поддерживает очередь сообщений для каждого - предмета оповещения, чтобы соблюсти очередность и гарантированную доставку. - - Запрос на доставку считается успешным только при получении ответа со - статусом `200`. Система будет ожидать успешного ответа на отправленный - запрос в течение 10 секунд. В случае ответа любым другим статусом или по - истечении указанного времени, отведённого на обработку оповещения, система - будет пытаться повторно доставить оповещения до получения успешного ответа, - либо до принятия решения о невозможности доставить информацию. Попытки - доставки будут производиться со следующими временными интервалами между - запросами: - - - 30 секунд, - - 5 минут, - - 15 минут, - - 1 час. - - каждый час в течение суток (24 часа) - - Если последняя попытка доставить оповещение оканчивается неудачей, все события, которые - накопились в очереди этого кошелька, отбрасываются. - - ## Авторизация полученных сообщений - - Система подтверждает подлинность оповещений, подписывая сообщения - приватным ключом, уникальным для каждого webhook'а, парный публичный ключ к - которому содержится в данных этого webhook'а. Подпись передается в - HTTP-заголовке `Content-Signature`. В заголовке в виде различных атрибутов - содержится информация об использованном при формировании подписи алгоритме и - значение подписи в формате - [URL-safe base-64](https://tools.ietf.org/html/rfc4648). + The specification defines a protocol for delivering notifications about new wallet events within your organisation. The notifications are deliveried by the system as HTTP requests to the URL of webhooks you created. Handlers for such kind of queries should be implemented on the side of your server code according to the specification. + + Webhook is a subscription to a specific type of event or group of events relating to different objects within your organisation. API methods described in the specification [Vality Webhook Management API](https://github.com/valitydev/swag-wallets) are used to manage webhooks. + + When within the wallet one of the events occurs (e.g. a wallet status change), the system selects a webhook matching that event type and sends an HTTP request containing a JSON message to the URL specified in the webhook. If several webhooks matching this event type were created, the event is simultaneously delivered to all URLs specified in those webhooks in an undefined order. + + ## Delivery strategy + + The system guarantees events delivery order within a specific notification subject (wallet, deposit, withdrawal, etc.). The system maintains a message queue for each notification item to keep the sequence and ensure the guaranteed delivery. + + A delivery request is considered to be successful only when a response with status `200` is received. The system will wait for a successful response to the sent a request during 10 seconds. In case of a response with any other status or after expiration of the specified time which was reserved to process the notification, the system will try to re-deliver notifications until a successful response is received, or until a decision is made that it is impossible to deliver information. Delivery attempts will be made at the following time intervals between requests: + + - 30 seconds, + - 5 minutes, + - 15 minutes, + - 1 hour. + - every hour within 24 hours + + If the last attempt of notification delivery fails, all the events that have been accumulated in this wallet queue are discarded. + + ## Received messages authorization + + The system confirms notifications authenticity by signing messages with a private key that is unique to each webhook, the paired public key of which is contained in the data of that webhook. The signature is transmitted in the HTTP header Content-Signature. Represented in various atributes the header contains the information about the algorithm used to create a signature and content of the signature in the format [URL-safe base-64](https://tools.ietf.org/html/rfc4648). ``` Content-Signature: alg=RS256; digest=zFuf7bRH4RHwyktaqHQwmX5rn3LfSb4dKo... ``` - На данный момент возможно использование единственного алоритма формирования - подписи. + At the moment the only one signature generation alorithm is possible to use. ### [RS256](https://tools.ietf.org/html/rfc7518#section-3.3) - Подпись формируется согласно алгоритму - [RSASSA-PKCS1-v1_5](https://tools.ietf.org/html/rfc3447#section-8.2), на - вход которому подаётся результат вычисления хэша сообщения по алгоритму - [SHA-256](https://tools.ietf.org/html/rfc6234). + The signature is generated according to + [RSASSA-PKCS1-v1_5](https://tools.ietf.org/html/rfc3447#section-8.2) algorithm , which itself uses result of message + [SHA-256](https://tools.ietf.org/html/rfc6234) calculation. - Набор атрибутов заголовка и список возможных алгоритмов формирования подписи - в дальнейшем могут быть расширены. + The set of header attributes and the list of possible signature generation algorithms can be expanded later. servers: - url: 'https://merchant.site' tags: - name: Event Notifications - x-displayName: Оповещения + x-displayName: Notifications description: Доставка оповещений о событиях системы. paths: '/webhook': From de7b93ba195904db5c13f00bc802b473140de781 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:49:54 +0700 Subject: [PATCH 52/89] New translations signature.yaml (English) --- en/openapi/components/parameters/signature.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/parameters/signature.yaml b/en/openapi/components/parameters/signature.yaml index f78bf0f4..8edac483 100644 --- a/en/openapi/components/parameters/signature.yaml +++ b/en/openapi/components/parameters/signature.yaml @@ -1,7 +1,7 @@ name: Content-Signature in: header description: > - Подпись сообщения, сформированная согласно указанным выше правилам + Message signature formed according to the above rules required: true schema: type: string From 74d5115db092ee4804882bc1436a791b721fe1a1 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:00 +0700 Subject: [PATCH 53/89] New translations DestinationAuthorized.yaml (English) --- en/openapi/components/schemas/DestinationAuthorized.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/DestinationAuthorized.yaml b/en/openapi/components/schemas/DestinationAuthorized.yaml index 6eecf0bd..2cd54cba 100644 --- a/en/openapi/components/schemas/DestinationAuthorized.yaml +++ b/en/openapi/components/schemas/DestinationAuthorized.yaml @@ -1,4 +1,4 @@ -description: Смена статуса приемника на авторизованный +description: Changing the status of the destination receiver to authorized allOf: - $ref: '../schemas/Event.yaml' From da76b580791ad59e93059685990e2ac23f589263 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:01 +0700 Subject: [PATCH 54/89] New translations DestinationCreated.yaml (English) --- en/openapi/components/schemas/DestinationCreated.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/DestinationCreated.yaml b/en/openapi/components/schemas/DestinationCreated.yaml index 790c58fc..000fccd2 100644 --- a/en/openapi/components/schemas/DestinationCreated.yaml +++ b/en/openapi/components/schemas/DestinationCreated.yaml @@ -1,4 +1,4 @@ -description: Событие создания приемника денежных средств +description: Destination creation event allOf: - $ref: '../schemas/Event.yaml' From 565a453d069da39da04a62356a9273b8ae0e1106 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:02 +0700 Subject: [PATCH 55/89] New translations DestinationID.yaml (English) --- en/openapi/components/schemas/DestinationID.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/DestinationID.yaml b/en/openapi/components/schemas/DestinationID.yaml index c0f01044..9d02aea1 100644 --- a/en/openapi/components/schemas/DestinationID.yaml +++ b/en/openapi/components/schemas/DestinationID.yaml @@ -1,3 +1,3 @@ -description: Идентификатор места назначения денежных средств +description: Destination identifier type: string example: "10ASF74D98" From cfe7ed372542164bc82e8a6e4f75cbedee0e907f Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:03 +0700 Subject: [PATCH 56/89] New translations DestinationName.yaml (English) --- en/openapi/components/schemas/DestinationName.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/DestinationName.yaml b/en/openapi/components/schemas/DestinationName.yaml index 679ceeb6..1162c082 100644 --- a/en/openapi/components/schemas/DestinationName.yaml +++ b/en/openapi/components/schemas/DestinationName.yaml @@ -1,3 +1,3 @@ -description: Человекочитаемое название места назначения, по которому его легко узнать +description: Human-readable name of the destination type: string example: "Worldwide PHP Awareness Initiative" From b85f32e8eeaeff4464f850dd94c4e23b8a69f419 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:04 +0700 Subject: [PATCH 57/89] New translations DestinationResource.yaml (English) --- en/openapi/components/schemas/DestinationResource.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/DestinationResource.yaml b/en/openapi/components/schemas/DestinationResource.yaml index ced7a76e..da15bcac 100644 --- a/en/openapi/components/schemas/DestinationResource.yaml +++ b/en/openapi/components/schemas/DestinationResource.yaml @@ -5,7 +5,7 @@ required: properties: type: description: | - Тип ресурса приёмника средств. + Destination resource type type: string enum: - BankCard From d54660b5921bd23fe591c65b5aa8a8f29c224039 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:05 +0700 Subject: [PATCH 58/89] New translations DestinationUnauthorized.yaml (English) --- en/openapi/components/schemas/DestinationUnauthorized.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/DestinationUnauthorized.yaml b/en/openapi/components/schemas/DestinationUnauthorized.yaml index a3a533fb..0cfa87fa 100644 --- a/en/openapi/components/schemas/DestinationUnauthorized.yaml +++ b/en/openapi/components/schemas/DestinationUnauthorized.yaml @@ -1,4 +1,4 @@ -description: Смена статуса приемника на не авторизованный +description: Changing the status of the destination receiver to unauthorized allOf: - $ref: '../schemas/Event.yaml' From a1407593f7d4a0456e473dd304498db4fc3e7f1f Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:07 +0700 Subject: [PATCH 59/89] New translations Event.yaml (English) --- en/openapi/components/schemas/Event.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/Event.yaml b/en/openapi/components/schemas/Event.yaml index b7170eb9..97dbbe70 100644 --- a/en/openapi/components/schemas/Event.yaml +++ b/en/openapi/components/schemas/Event.yaml @@ -13,14 +13,14 @@ properties: type: string format: date-time topic: - description: Предмет оповещения + description: Subject of notification type: string enum: - WithdrawalTopic - DestinationTopic eventType: type: string - description: Тип произошедшего с предметом оповещения события + description: Type of event that occurred enum: - WithdrawalStarted - WithdrawalSucceeded From bdc321e517f568929291f46d81a49ad80266531a Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:11 +0700 Subject: [PATCH 60/89] New translations WithdrawalFailed.yaml (English) --- en/openapi/components/schemas/WithdrawalFailed.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/WithdrawalFailed.yaml b/en/openapi/components/schemas/WithdrawalFailed.yaml index c2e5712c..d4350f2f 100644 --- a/en/openapi/components/schemas/WithdrawalFailed.yaml +++ b/en/openapi/components/schemas/WithdrawalFailed.yaml @@ -1,4 +1,4 @@ -description: Событие о неуспешном осуществлении вывода средств +description: Unsuccessful withdrawal event allOf: - $ref: '../schemas/Event.yaml' From a56f9e218fe0f4d4ad4b6d7362980ea695fdc7b7 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:12 +0700 Subject: [PATCH 61/89] New translations WithdrawalStarted.yaml (English) --- en/openapi/components/schemas/WithdrawalStarted.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/WithdrawalStarted.yaml b/en/openapi/components/schemas/WithdrawalStarted.yaml index 19a380c9..96804111 100644 --- a/en/openapi/components/schemas/WithdrawalStarted.yaml +++ b/en/openapi/components/schemas/WithdrawalStarted.yaml @@ -1,4 +1,4 @@ -description: Событие о начале осуществления вывода средств +description: Withdrawal start event allOf: - $ref: '../schemas/Event.yaml' From 1b2416f00328b0f6c88f0147a26f661d7aa67900 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:13 +0700 Subject: [PATCH 62/89] New translations WithdrawalSucceeded.yaml (English) --- en/openapi/components/schemas/WithdrawalSucceeded.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/WithdrawalSucceeded.yaml b/en/openapi/components/schemas/WithdrawalSucceeded.yaml index c1adfa30..e02d3390 100644 --- a/en/openapi/components/schemas/WithdrawalSucceeded.yaml +++ b/en/openapi/components/schemas/WithdrawalSucceeded.yaml @@ -1,4 +1,4 @@ -description: Событие об успешном осуществлении вывода средств +description: Successful withdrawal event allOf: - $ref: '../schemas/Event.yaml' From 767ae9f831a38cd5a7622f0bd9a55e21f5c41450 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:14 +0700 Subject: [PATCH 63/89] New translations openapi.yaml (English) --- en/openapi/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/openapi.yaml b/en/openapi/openapi.yaml index c6316202..a1111582 100644 --- a/en/openapi/openapi.yaml +++ b/en/openapi/openapi.yaml @@ -54,7 +54,7 @@ tags: - name: Event Notifications x-displayName: Notifications - description: Доставка оповещений о событиях системы. + description: Delivery of platform event notifications. paths: '/webhook': $ref: './paths/webhook-url.yaml' From d3abc363e0a215bc53d2c8eeca8efc9a2a443403 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 15:50:15 +0700 Subject: [PATCH 64/89] New translations webhook-url.yaml (English) --- en/openapi/paths/webhook-url.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/paths/webhook-url.yaml b/en/openapi/paths/webhook-url.yaml index 9061bab1..4f5c6fa1 100644 --- a/en/openapi/paths/webhook-url.yaml +++ b/en/openapi/paths/webhook-url.yaml @@ -1,13 +1,13 @@ post: tags: - Event Notifications - summary: Оповестить о событии + summary: Notify of an event operationId: notifyWebhookEvent parameters: - $ref: '../components/parameters/signature.yaml' requestBody: - description: Данные произошедшего в платформе события + description: Data from an event that occurred in the platform required: true content: application/json: @@ -15,4 +15,4 @@ post: $ref: '../components/schemas/Event.yaml' responses: '200': - description: Оповещение обработано + description: Notification processed From 0ef1ccf24d444f592e8c351a2d79a6487639e16f Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:14 +0700 Subject: [PATCH 65/89] New translations BankCard.yaml (English) --- en/openapi/components/schemas/BankCard.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/BankCard.yaml b/en/openapi/components/schemas/BankCard.yaml index bf47a6e7..b40970b0 100644 --- a/en/openapi/components/schemas/BankCard.yaml +++ b/en/openapi/components/schemas/BankCard.yaml @@ -1,7 +1,7 @@ description: Bank card details allOf: - - $ref: '../schemas/DestinationResource.yaml' + $ref: "../schemas/DestinationResource.yaml" - type: object required: @@ -21,6 +21,6 @@ allOf: type: string pattern: '^\d{2,4}$' paymentSystem: - $ref: '../schemas/BankCardPaymentSystem.yaml' + $ref: "../schemas/BankCardPaymentSystem.yaml" tokenProvider: - $ref: '../schemas/BankCardTokenProvider.yaml' + $ref: "../schemas/BankCardTokenProvider.yaml" From b9dba3d64b2d28cd2d06f6d9b0ea6aec3dd19283 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:15 +0700 Subject: [PATCH 66/89] New translations BankCardPaymentSystem.yaml (English) --- .../components/schemas/BankCardPaymentSystem.yaml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/en/openapi/components/schemas/BankCardPaymentSystem.yaml b/en/openapi/components/schemas/BankCardPaymentSystem.yaml index 70c6f7c5..2f8ebf07 100644 --- a/en/openapi/components/schemas/BankCardPaymentSystem.yaml +++ b/en/openapi/components/schemas/BankCardPaymentSystem.yaml @@ -1,12 +1,2 @@ description: Payment system type: string -#enum: -#- visa -#- mastercard -#- dankort -#- amex -#- dinersclub -#- discover -#- unionpay -#- jcb -#- nspkmir \ No newline at end of file From 7c7c8b4d600ce7873bab7f1e8e00196fd9867131 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:17 +0700 Subject: [PATCH 67/89] New translations CryptoWallet.yaml (English) --- en/openapi/components/schemas/CryptoWallet.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/CryptoWallet.yaml b/en/openapi/components/schemas/CryptoWallet.yaml index eed3b322..3ede8734 100644 --- a/en/openapi/components/schemas/CryptoWallet.yaml +++ b/en/openapi/components/schemas/CryptoWallet.yaml @@ -1,7 +1,7 @@ description: Cryptocurrency wallet details allOf: - - $ref: '../schemas/DestinationResource.yaml' + $ref: "../schemas/DestinationResource.yaml" - type: object required: @@ -15,4 +15,4 @@ allOf: maxLength: 256 example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQ currency: - $ref: '../schemas/CryptoCurrency.yaml' + $ref: "../schemas/CryptoCurrency.yaml" From 1b4d4ea72fa2751cf8447719e0da282a8dd4a4d4 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:17 +0700 Subject: [PATCH 68/89] New translations CurrencyID.yaml (English) --- en/openapi/components/schemas/CurrencyID.yaml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/en/openapi/components/schemas/CurrencyID.yaml b/en/openapi/components/schemas/CurrencyID.yaml index 586a9827..9755969e 100644 --- a/en/openapi/components/schemas/CurrencyID.yaml +++ b/en/openapi/components/schemas/CurrencyID.yaml @@ -1,6 +1,5 @@ -description: | - Currency, character code according to [ISO - 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). +description: > + 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}$" example: RUB From e26b842459b30dca6966ea93437e1a96c7b255dd Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:18 +0700 Subject: [PATCH 69/89] New translations Destination.yaml (English) --- en/openapi/components/schemas/Destination.yaml | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/en/openapi/components/schemas/Destination.yaml b/en/openapi/components/schemas/Destination.yaml index f0a0606c..7a73965b 100644 --- a/en/openapi/components/schemas/Destination.yaml +++ b/en/openapi/components/schemas/Destination.yaml @@ -7,24 +7,23 @@ required: - resource properties: id: - $ref: '../schemas/DestinationID.yaml' + $ref: "../schemas/DestinationID.yaml" name: description: | A human-readable name for the receiver by which it is easily recognizable type: string example: Squarey plastic thingy identity: - $ref: '../schemas/IdentityID.yaml' + $ref: "../schemas/IdentityID.yaml" currency: - $ref: '../schemas/CurrencyID.yaml' + $ref: "../schemas/CurrencyID.yaml" resource: - $ref: '../schemas/DestinationResource.yaml' + $ref: "../schemas/DestinationResource.yaml" metadata: - description: | - An arbitrary, client-specific API and non-transparent set of data associated with - given receiver + description: > + An arbitrary, client-specific API and non-transparent set of data associated with given receiver type: object example: color_hint: olive-green externalID: - $ref: '../schemas/ExternalID.yaml' + $ref: "../schemas/ExternalID.yaml" From b280b09d2c00e33ff2cf6b55dbc19f08509649c0 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:19 +0700 Subject: [PATCH 70/89] New translations DestinationAuthorized.yaml (English) --- en/openapi/components/schemas/DestinationAuthorized.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/DestinationAuthorized.yaml b/en/openapi/components/schemas/DestinationAuthorized.yaml index 2cd54cba..20cd7a6a 100644 --- a/en/openapi/components/schemas/DestinationAuthorized.yaml +++ b/en/openapi/components/schemas/DestinationAuthorized.yaml @@ -1,13 +1,13 @@ description: Changing the status of the destination receiver to authorized allOf: - - $ref: '../schemas/Event.yaml' + $ref: "../schemas/Event.yaml" - type: object required: - destinationID properties: destinationID: - $ref: '../schemas/DestinationID.yaml' + $ref: "../schemas/DestinationID.yaml" externalID: - $ref: '../schemas/ExternalID.yaml' + $ref: "../schemas/ExternalID.yaml" From 52827cfb1a7696931e460e86bcc46d0294176286 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:20 +0700 Subject: [PATCH 71/89] New translations DestinationCreated.yaml (English) --- en/openapi/components/schemas/DestinationCreated.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/DestinationCreated.yaml b/en/openapi/components/schemas/DestinationCreated.yaml index 000fccd2..ad855c4b 100644 --- a/en/openapi/components/schemas/DestinationCreated.yaml +++ b/en/openapi/components/schemas/DestinationCreated.yaml @@ -1,11 +1,11 @@ description: Destination creation event allOf: - - $ref: '../schemas/Event.yaml' + $ref: "../schemas/Event.yaml" - type: object required: - destination properties: destination: - $ref: '../schemas/Destination.yaml' + $ref: "../schemas/Destination.yaml" From 2be2e2a8da3e31c84623746a9e3db7f6ab619ed5 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:22 +0700 Subject: [PATCH 72/89] New translations DestinationResource.yaml (English) --- en/openapi/components/schemas/DestinationResource.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/DestinationResource.yaml b/en/openapi/components/schemas/DestinationResource.yaml index da15bcac..3d083984 100644 --- a/en/openapi/components/schemas/DestinationResource.yaml +++ b/en/openapi/components/schemas/DestinationResource.yaml @@ -14,6 +14,6 @@ properties: discriminator: propertyName: type mapping: - 'BankCard': '../schemas/BankCard.yaml' - 'CryptoWallet': '../schemas/CryptoWallet.yaml' - 'DigitalWallet': '../schemas/DigitalWallet.yaml' + "BankCard": "../schemas/BankCard.yaml" + "CryptoWallet": "../schemas/CryptoWallet.yaml" + "DigitalWallet": "../schemas/DigitalWallet.yaml" From 42eca86cb780432845f7be09703b15cf4a3a75d8 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:23 +0700 Subject: [PATCH 73/89] New translations DestinationUnauthorized.yaml (English) --- en/openapi/components/schemas/DestinationUnauthorized.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/DestinationUnauthorized.yaml b/en/openapi/components/schemas/DestinationUnauthorized.yaml index 0cfa87fa..01956cc8 100644 --- a/en/openapi/components/schemas/DestinationUnauthorized.yaml +++ b/en/openapi/components/schemas/DestinationUnauthorized.yaml @@ -1,13 +1,13 @@ description: Changing the status of the destination receiver to unauthorized allOf: - - $ref: '../schemas/Event.yaml' + $ref: "../schemas/Event.yaml" - type: object required: - destinationID properties: destinationID: - $ref: '../schemas/DestinationID.yaml' + $ref: "../schemas/DestinationID.yaml" externalID: - $ref: '../schemas/ExternalID.yaml' + $ref: "../schemas/ExternalID.yaml" From af7bae884644733fdef7d11e4f9debd6379e07e1 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:24 +0700 Subject: [PATCH 74/89] New translations DigitalWallet.yaml (English) --- en/openapi/components/schemas/DigitalWallet.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/DigitalWallet.yaml b/en/openapi/components/schemas/DigitalWallet.yaml index d33952f9..b14eeca4 100644 --- a/en/openapi/components/schemas/DigitalWallet.yaml +++ b/en/openapi/components/schemas/DigitalWallet.yaml @@ -1,7 +1,7 @@ description: Cryptocurrency wallet details allOf: - - $ref: '../schemas/DestinationResource.yaml' + $ref: "../schemas/DestinationResource.yaml" - type: object required: @@ -18,4 +18,3 @@ allOf: description: Electronic assets service provider type: string example: Paypal - From df1492068b077413043dc46832760a5e3f339846 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:25 +0700 Subject: [PATCH 75/89] New translations Event.yaml (English) --- en/openapi/components/schemas/Event.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/en/openapi/components/schemas/Event.yaml b/en/openapi/components/schemas/Event.yaml index 97dbbe70..40479b3e 100644 --- a/en/openapi/components/schemas/Event.yaml +++ b/en/openapi/components/schemas/Event.yaml @@ -31,9 +31,9 @@ properties: discriminator: propertyName: eventType mapping: - 'WithdrawalStarted': '../schemas/WithdrawalStarted.yaml' - 'WithdrawalSucceeded': '../schemas/WithdrawalSucceeded.yaml' - 'WithdrawalFailed': '../schemas/WithdrawalFailed.yaml' - 'DestinationCreated': '../schemas/DestinationCreated.yaml' - 'DestinationAuthorized': '../schemas/DestinationAuthorized.yaml' - 'DestinationUnauthorized': '../schemas/DestinationUnauthorized.yaml' + "WithdrawalStarted": "../schemas/WithdrawalStarted.yaml" + "WithdrawalSucceeded": "../schemas/WithdrawalSucceeded.yaml" + "WithdrawalFailed": "../schemas/WithdrawalFailed.yaml" + "DestinationCreated": "../schemas/DestinationCreated.yaml" + "DestinationAuthorized": "../schemas/DestinationAuthorized.yaml" + "DestinationUnauthorized": "../schemas/DestinationUnauthorized.yaml" From cad889e9d4d274016aa28852e48be7b2373fdb00 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:27 +0700 Subject: [PATCH 76/89] New translations Withdrawal.yaml (English) --- en/openapi/components/schemas/Withdrawal.yaml | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/en/openapi/components/schemas/Withdrawal.yaml b/en/openapi/components/schemas/Withdrawal.yaml index 28193f6f..6079d428 100644 --- a/en/openapi/components/schemas/Withdrawal.yaml +++ b/en/openapi/components/schemas/Withdrawal.yaml @@ -6,20 +6,19 @@ required: - body properties: id: - $ref: '../schemas/WithdrawalID.yaml' + $ref: "../schemas/WithdrawalID.yaml" createdAt: description: Date and time the withdrawal started type: string format: date-time destination: - $ref: '../schemas/DestinationID.yaml' + $ref: "../schemas/DestinationID.yaml" body: - $ref: '../schemas/WithdrawalBody.yaml' + $ref: "../schemas/WithdrawalBody.yaml" metadata: - description: | - A random, client-specific API and a data set that is not transparent to the system, associated with - this withdrawal + description: > + A custom client-specific API and a data set that is not transparent to the system, associated with this withdrawal wallet: - $ref: '../schemas/WalletID.yaml' + $ref: "../schemas/WalletID.yaml" externalID: - $ref: '../schemas/ExternalID.yaml' + $ref: "../schemas/ExternalID.yaml" From 639bd4af8505d23909e5c167fac046acb7e60766 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:28 +0700 Subject: [PATCH 77/89] New translations WithdrawalBody.yaml (English) --- en/openapi/components/schemas/WithdrawalBody.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/openapi/components/schemas/WithdrawalBody.yaml b/en/openapi/components/schemas/WithdrawalBody.yaml index 9d5973dd..62288c33 100644 --- a/en/openapi/components/schemas/WithdrawalBody.yaml +++ b/en/openapi/components/schemas/WithdrawalBody.yaml @@ -12,4 +12,4 @@ properties: format: int64 example: 1430000 currency: - $ref: '../schemas/CurrencyID.yaml' + $ref: "../schemas/CurrencyID.yaml" From 51179a97794b330ceb7f23bfd18aef31f4acf1e3 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:29 +0700 Subject: [PATCH 78/89] New translations WithdrawalFailed.yaml (English) --- en/openapi/components/schemas/WithdrawalFailed.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/WithdrawalFailed.yaml b/en/openapi/components/schemas/WithdrawalFailed.yaml index d4350f2f..3bd24a0d 100644 --- a/en/openapi/components/schemas/WithdrawalFailed.yaml +++ b/en/openapi/components/schemas/WithdrawalFailed.yaml @@ -1,13 +1,13 @@ description: Unsuccessful withdrawal event allOf: - - $ref: '../schemas/Event.yaml' + $ref: "../schemas/Event.yaml" - type: object required: - withdrawalID properties: withdrawalID: - $ref: '../schemas/WithdrawalID.yaml' + $ref: "../schemas/WithdrawalID.yaml" externalID: - $ref: '../schemas/ExternalID.yaml' + $ref: "../schemas/ExternalID.yaml" From a1d66a05ad1abfeeb32d683482402eaadbf6e0e8 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:30 +0700 Subject: [PATCH 79/89] New translations WithdrawalStarted.yaml (English) --- en/openapi/components/schemas/WithdrawalStarted.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/components/schemas/WithdrawalStarted.yaml b/en/openapi/components/schemas/WithdrawalStarted.yaml index 96804111..0b9442b4 100644 --- a/en/openapi/components/schemas/WithdrawalStarted.yaml +++ b/en/openapi/components/schemas/WithdrawalStarted.yaml @@ -1,11 +1,11 @@ description: Withdrawal start event allOf: - - $ref: '../schemas/Event.yaml' + $ref: "../schemas/Event.yaml" - type: object required: - withdrawal properties: withdrawal: - $ref: '../schemas/Withdrawal.yaml' + $ref: "../schemas/Withdrawal.yaml" From 133dfa31fc2eb61c9509d9533e58275ce7561549 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:31 +0700 Subject: [PATCH 80/89] New translations WithdrawalSucceeded.yaml (English) --- en/openapi/components/schemas/WithdrawalSucceeded.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/WithdrawalSucceeded.yaml b/en/openapi/components/schemas/WithdrawalSucceeded.yaml index e02d3390..92793c32 100644 --- a/en/openapi/components/schemas/WithdrawalSucceeded.yaml +++ b/en/openapi/components/schemas/WithdrawalSucceeded.yaml @@ -1,13 +1,13 @@ description: Successful withdrawal event allOf: - - $ref: '../schemas/Event.yaml' + $ref: "../schemas/Event.yaml" - type: object required: - withdrawalID properties: withdrawalID: - $ref: '../schemas/WithdrawalID.yaml' + $ref: "../schemas/WithdrawalID.yaml" externalID: - $ref: '../schemas/ExternalID.yaml' + $ref: "../schemas/ExternalID.yaml" From 64d933b97026ac903f4e032e49e6a443f099b644 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:32 +0700 Subject: [PATCH 81/89] New translations openapi.yaml (English) --- en/openapi/openapi.yaml | 35 +++++++++-------------------------- 1 file changed, 9 insertions(+), 26 deletions(-) diff --git a/en/openapi/openapi.yaml b/en/openapi/openapi.yaml index a1111582..2424cd7d 100644 --- a/en/openapi/openapi.yaml +++ b/en/openapi/openapi.yaml @@ -6,55 +6,38 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - description: | + description: > ## Wallet Webhook Events API - The specification defines a protocol for delivering notifications about new wallet events within your organisation. The notifications are deliveried by the system as HTTP requests to the URL of webhooks you created. Handlers for such kind of queries should be implemented on the side of your server code according to the specification. - Webhook is a subscription to a specific type of event or group of events relating to different objects within your organisation. API methods described in the specification [Vality Webhook Management API](https://github.com/valitydev/swag-wallets) are used to manage webhooks. + Webhook is a subscription to a specific type of event or group of events relating to different objects within your organisation. API methods described in the specification [Vality Webhook Management API](https:/github.com/valitydev/swag-wallets) are used to manage webhooks. When within the wallet one of the events occurs (e.g. a wallet status change), the system selects a webhook matching that event type and sends an HTTP request containing a JSON message to the URL specified in the webhook. If several webhooks matching this event type were created, the event is simultaneously delivered to all URLs specified in those webhooks in an undefined order. - ## Delivery strategy - The system guarantees events delivery order within a specific notification subject (wallet, deposit, withdrawal, etc.). The system maintains a message queue for each notification item to keep the sequence and ensure the guaranteed delivery. A delivery request is considered to be successful only when a response with status `200` is received. The system will wait for a successful response to the sent a request during 10 seconds. In case of a response with any other status or after expiration of the specified time which was reserved to process the notification, the system will try to re-deliver notifications until a successful response is received, or until a decision is made that it is impossible to deliver information. Delivery attempts will be made at the following time intervals between requests: - - - 30 seconds, - - 5 minutes, - - 15 minutes, - - 1 hour. - - every hour within 24 hours - + - 30 seconds, - 5 minutes, - 15 minutes, - 1 hour. - every hour within 24 hours If the last attempt of notification delivery fails, all the events that have been accumulated in this wallet queue are discarded. - ## Received messages authorization - The system confirms notifications authenticity by signing messages with a private key that is unique to each webhook, the paired public key of which is contained in the data of that webhook. The signature is transmitted in the HTTP header Content-Signature. Represented in various atributes the header contains the information about the algorithm used to create a signature and content of the signature in the format [URL-safe base-64](https://tools.ietf.org/html/rfc4648). - ``` - Content-Signature: alg=RS256; digest=zFuf7bRH4RHwyktaqHQwmX5rn3LfSb4dKo... - ``` - - At the moment the only one signature generation alorithm is possible to use. + ``` Content-Signature: alg=RS256; digest=zFuf7bRH4RHwyktaqHQwmX5rn3LfSb4dKo... ``` + At the moment the only one signature generation algorithm is possible to use. ### [RS256](https://tools.ietf.org/html/rfc7518#section-3.3) - - The signature is generated according to - [RSASSA-PKCS1-v1_5](https://tools.ietf.org/html/rfc3447#section-8.2) algorithm , which itself uses result of message - [SHA-256](https://tools.ietf.org/html/rfc6234) calculation. + The signature is generated according to [RSASSA-PKCS1-v1_5](https://tools.ietf.org/html/rfc3447#section-8.2) algorithm , which itself uses result of message [SHA-256](https://tools.ietf.org/html/rfc6234) calculation. The set of header attributes and the list of possible signature generation algorithms can be expanded later. servers: - - url: 'https://merchant.site' + url: "https://merchant.site" tags: - name: Event Notifications x-displayName: Notifications description: Delivery of platform event notifications. paths: - '/webhook': - $ref: './paths/webhook-url.yaml' + "/webhook": + $ref: "./paths/webhook-url.yaml" From 548eb442cfe5e0958d7d86a65ed223c92c7d6742 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Tue, 8 Aug 2023 21:59:33 +0700 Subject: [PATCH 82/89] New translations webhook-url.yaml (English) --- en/openapi/paths/webhook-url.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/en/openapi/paths/webhook-url.yaml b/en/openapi/paths/webhook-url.yaml index 4f5c6fa1..8e460136 100644 --- a/en/openapi/paths/webhook-url.yaml +++ b/en/openapi/paths/webhook-url.yaml @@ -5,14 +5,14 @@ post: operationId: notifyWebhookEvent parameters: - - $ref: '../components/parameters/signature.yaml' + $ref: "../components/parameters/signature.yaml" requestBody: description: Data from an event that occurred in the platform required: true content: application/json: schema: - $ref: '../components/schemas/Event.yaml' + $ref: "../components/schemas/Event.yaml" responses: - '200': + "200": description: Notification processed From 998e56e7dc0e8a58b327f5841813adc9105a07eb Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Mon, 21 Jul 2025 20:25:02 +0800 Subject: [PATCH 83/89] New translations destination.yaml (English) --- en/openapi/components/schemas/Destination.yaml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/en/openapi/components/schemas/Destination.yaml b/en/openapi/components/schemas/Destination.yaml index 7a73965b..365dd0aa 100644 --- a/en/openapi/components/schemas/Destination.yaml +++ b/en/openapi/components/schemas/Destination.yaml @@ -2,7 +2,6 @@ description: Destination data type: object required: - name - - identity - currency - resource properties: @@ -13,8 +12,8 @@ properties: A human-readable name for the receiver by which it is easily recognizable type: string example: Squarey plastic thingy - identity: - $ref: "../schemas/IdentityID.yaml" + party: + $ref: "../schemas/PartyID.yaml" currency: $ref: "../schemas/CurrencyID.yaml" resource: From 01a3cbfcf4a70082368b8b173b7c1383b7513de2 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Mon, 21 Jul 2025 20:25:07 +0800 Subject: [PATCH 84/89] New translations event.yaml (English) --- en/openapi/components/schemas/Event.yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/en/openapi/components/schemas/Event.yaml b/en/openapi/components/schemas/Event.yaml index 40479b3e..0aa4610f 100644 --- a/en/openapi/components/schemas/Event.yaml +++ b/en/openapi/components/schemas/Event.yaml @@ -20,14 +20,12 @@ properties: - DestinationTopic eventType: type: string - description: Type of event that occurred + description: Type of event that occurred. enum: - WithdrawalStarted - WithdrawalSucceeded - WithdrawalFailed - DestinationCreated - - DestinationAuthorized - - DestinationUnauthorized discriminator: propertyName: eventType mapping: @@ -35,5 +33,3 @@ discriminator: "WithdrawalSucceeded": "../schemas/WithdrawalSucceeded.yaml" "WithdrawalFailed": "../schemas/WithdrawalFailed.yaml" "DestinationCreated": "../schemas/DestinationCreated.yaml" - "DestinationAuthorized": "../schemas/DestinationAuthorized.yaml" - "DestinationUnauthorized": "../schemas/DestinationUnauthorized.yaml" From 2e201ab28267e8d24c8d4b0367a010c2929c4390 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Mon, 21 Jul 2025 20:25:14 +0800 Subject: [PATCH 85/89] New translations openapi.yaml (English) --- en/openapi/openapi.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/en/openapi/openapi.yaml b/en/openapi/openapi.yaml index 2424cd7d..c4903d63 100644 --- a/en/openapi/openapi.yaml +++ b/en/openapi/openapi.yaml @@ -41,3 +41,11 @@ tags: paths: "/webhook": $ref: "./paths/webhook-url.yaml" +components: + securitySchemes: + signature: + description: | + Message signature formed according to the above rules. + name: Content-Signature + type: apiKey + in: header From 5fe928f6f3cf3c0447abb6c4557fc137a24453eb Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Mon, 21 Jul 2025 20:25:15 +0800 Subject: [PATCH 86/89] New translations webhook-url.yaml (English) --- en/openapi/paths/webhook-url.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/openapi/paths/webhook-url.yaml b/en/openapi/paths/webhook-url.yaml index 8e460136..4cf8073b 100644 --- a/en/openapi/paths/webhook-url.yaml +++ b/en/openapi/paths/webhook-url.yaml @@ -3,9 +3,9 @@ post: - Event Notifications summary: Notify of an event operationId: notifyWebhookEvent - parameters: + security: - - $ref: "../components/parameters/signature.yaml" + signature: [ ] requestBody: description: Data from an event that occurred in the platform required: true From 12a58fcd0d86b7fc26356cdcb1dcbb9fd39978d6 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Mon, 21 Jul 2025 20:25:18 +0800 Subject: [PATCH 87/89] New translations partyid.yaml (English) --- en/openapi/components/schemas/PartyID.yaml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 en/openapi/components/schemas/PartyID.yaml diff --git a/en/openapi/components/schemas/PartyID.yaml b/en/openapi/components/schemas/PartyID.yaml new file mode 100644 index 00000000..48469e2e --- /dev/null +++ b/en/openapi/components/schemas/PartyID.yaml @@ -0,0 +1,3 @@ +description: Identifier of owner +type: string +example: tZ0jUmlsV0 From ad88377edee7fc48d55d8731dc518b14f3b1f08e Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 29 Jan 2026 21:14:17 +0800 Subject: [PATCH 88/89] New translations withdrawalsucceeded.yaml (English) --- en/openapi/components/schemas/WithdrawalSucceeded.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/en/openapi/components/schemas/WithdrawalSucceeded.yaml b/en/openapi/components/schemas/WithdrawalSucceeded.yaml index 92793c32..6c81e1c1 100644 --- a/en/openapi/components/schemas/WithdrawalSucceeded.yaml +++ b/en/openapi/components/schemas/WithdrawalSucceeded.yaml @@ -11,3 +11,5 @@ allOf: $ref: "../schemas/WithdrawalID.yaml" externalID: $ref: "../schemas/ExternalID.yaml" + fee: + $ref: "../schemas/Fee.yaml" From e0e36acc637e45415a9f1dbe5286eafad5329f93 Mon Sep 17 00:00:00 2001 From: Pavel Popov Date: Thu, 29 Jan 2026 21:14:19 +0800 Subject: [PATCH 89/89] New translations fee.yaml (English) --- en/openapi/components/schemas/Fee.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 en/openapi/components/schemas/Fee.yaml diff --git a/en/openapi/components/schemas/Fee.yaml b/en/openapi/components/schemas/Fee.yaml new file mode 100644 index 00000000..340ffc3b --- /dev/null +++ b/en/openapi/components/schemas/Fee.yaml @@ -0,0 +1,13 @@ +description: Fee charged for the withdrawal +type: object +required: + - amount + - currency +properties: + amount: + description: The amount of money in minor units, for example, in cents + type: integer + format: int64 + example: 1430000 + currency: + $ref: '../schemas/CurrencyID.yaml'