valitydev · tolkonepiu · Jan 18, 2023 · Jan 18, 2023 · Jan 18, 2023 · Jan 18, 2023
diff --git a/en/openapi/components/parameters/signature.yaml b/en/openapi/components/parameters/signature.yaml
@@ -0,0 +1,7 @@
+name: Content-Signature
+in: header
+description: >
+  Message signature formed according to the above rules
+required: true
+schema:
+  type: string
diff --git a/en/openapi/components/responses/NotFound.yaml b/en/openapi/components/responses/NotFound.yaml
@@ -0,0 +1,5 @@
+description: Target resource not found
+content:
+  application/json; charset=utf-8:
+    schema:
+      $ref: "../schemas/GeneralError.yaml"
diff --git a/en/openapi/components/schemas/ApiExtensionInfo.yaml b/en/openapi/components/schemas/ApiExtensionInfo.yaml
@@ -0,0 +1,8 @@
+description: Api extension request
+type: object
+required:
+  - apiType
+properties:
+  apiType:
+    description: Api type
+    type: string
diff --git a/en/openapi/components/schemas/ApiExtensionRequest.yaml b/en/openapi/components/schemas/ApiExtensionRequest.yaml
@@ -0,0 +1,10 @@
+description: Browser http request
+type: object
+required:
+  - apiExtensionInfo
+allOf:
+  - 
+    $ref: "../schemas/UserInteractionDetails.yaml"
+properties:
+  apiExtensionInfo:
+    $ref: "../schemas/ApiExtensionInfo.yaml"
diff --git a/en/openapi/components/schemas/BankCardDetails.yaml b/en/openapi/components/schemas/BankCardDetails.yaml
@@ -0,0 +1,49 @@
+required:
+  - bin
+  - lastDigits
+  - cardNumberMask
+  - paymentSystem
+properties:
+  bin:
+    description: Card issuing bank BIN
+    type: string
+    pattern: '^\d{6,8}$'
+  lastDigits:
+    description: Card last digits
+    type: string
+    pattern: '^\d{2,4}$'
+  cardNumberMask:
+    description: Masked card number
+    type: string
+    pattern: '^\d{6,8}\*+\d{2,4}$'
+  paymentSystem:
+    description: Payment system
+    type: string
+    maxLength: 100
+  tokenProvider:
+    description: Payment token provider
+    type: string
+    enum:
+      - applepay
+      - googlepay
+      - samsungpay
+      - yandexpay
+      - unknown
+    deprecated: true
+  tokenProviderName:
+    description: Payment token provider
+    type: string
+  issuerCountry:
+    description: Issuing country (alpha-3 code according to ISO_3166-1)
+    type: string
+    example:
+      - "RUS"
+      - "POL"
+      - "USA"
+  bankName:
+    description: Bank name
+    type: string
+    example:
+      - "SBERBANK OF RUSSIA"
+      - "JOINT STOCK COMPANY ALFA-BANK"
+      - "VTB BANK OJSC"
diff --git a/en/openapi/components/schemas/BrowserHTTPInfo.yaml b/en/openapi/components/schemas/BrowserHTTPInfo.yaml
@@ -0,0 +1,21 @@
+description: Browser http request
+type: object
+required:
+  - requestType
+  - url
+properties:
+  requestType:
+    description: Type of http request
+    type: string
+    enum:
+      - get
+      - post
+  url:
+    description: Uniform Resource Locator
+    type: string
+    maxLength: 1000
+  form:
+    type: object
+    additionalProperties:
+      type: string
+      maxLength: 1000
diff --git a/en/openapi/components/schemas/BrowserHTTPRequest.yaml b/en/openapi/components/schemas/BrowserHTTPRequest.yaml
@@ -0,0 +1,10 @@
+description: Browser http request
+type: object
+required:
+  - browserHTTPInfo
+allOf:
+  - 
+    $ref: "../schemas/UserInteractionDetails.yaml"
+properties:
+  browserHTTPInfo:
+    $ref: "../schemas/BrowserHTTPInfo.yaml"
diff --git a/en/openapi/components/schemas/ClientInfo.yaml b/en/openapi/components/schemas/ClientInfo.yaml
@@ -0,0 +1,14 @@
+description: Payer's client device data
+type: object
+required:
+  - fingerprint
+properties:
+  ip:
+    description: Payer IP-address
+    type: string
+    format: ip-address
+    maxLength: 45
+  fingerprint:
+    description: Payer's user agent unique fingerprint
+    type: string
+    maxLength: 1000
diff --git a/en/openapi/components/schemas/ContactInfo.yaml b/en/openapi/components/schemas/ContactInfo.yaml
@@ -0,0 +1,13 @@
+description: Payer's contact information
+type: object
+properties:
+  email:
+    description: Email address
+    type: string
+    format: email
+    maxLength: 100
+  phoneNumber:
+    description: >
+      Mobile phone number with international prefix according to [E.164](https://en.wikipedia.org/wiki/E.164).
+    type: string
+    format: '^\+\d{4,15}$'
diff --git a/en/openapi/components/schemas/CryptoCash.yaml b/en/openapi/components/schemas/CryptoCash.yaml
@@ -0,0 +1,10 @@
+description: Crypto cash
+type: object
+required:
+  - cryptoAmount
+  - cryptoCurrency
+properties:
+  cryptoAmount:
+    $ref: "../schemas/Rational.yaml"
+  cryptoCurrency:
+    $ref: "../schemas/CryptoCurrency.yaml"
diff --git a/en/openapi/components/schemas/CryptoCurrency.yaml b/en/openapi/components/schemas/CryptoCurrency.yaml
@@ -0,0 +1,11 @@
+description: Cryptocurrency type
+type: string
+enum:
+  - bitcoin
+  - litecoin
+  - bitcoinCash
+  - ripple
+  - ethereum
+  - zcash
+  - unknown
+deprecated: true
diff --git a/en/openapi/components/schemas/CryptoCurrencyTransferInfo.yaml b/en/openapi/components/schemas/CryptoCurrencyTransferInfo.yaml
@@ -0,0 +1,11 @@
+description: Crypto currency transfer request
+type: object
+required:
+  - cryptoAddress
+  - cryptoCash
+properties:
+  cryptoAddress:
+    description: Crypto address
+    type: string
+  cryptoCash:
+    $ref: "../schemas/CryptoCurrencyType.yaml"
diff --git a/en/openapi/components/schemas/CryptoCurrencyTransferRequest.yaml b/en/openapi/components/schemas/CryptoCurrencyTransferRequest.yaml
@@ -0,0 +1,10 @@
+description: Crypto currency transfer request
+type: object
+required:
+  - cryptoCurrencyTransferInfo
+allOf:
+  - 
+    $ref: "../schemas/UserInteractionDetails.yaml"
+properties:
+  cryptoCurrencyTransferInfo:
+    $ref: "../schemas/CryptoCurrencyTransferInfo.yaml"
diff --git a/en/openapi/components/schemas/CryptoCurrencyType.yaml b/en/openapi/components/schemas/CryptoCurrencyType.yaml
@@ -0,0 +1,2 @@
+description: Cryptocurrency type
+type: string
diff --git a/en/openapi/components/schemas/CryptoWalletDetails.yaml b/en/openapi/components/schemas/CryptoWalletDetails.yaml
@@ -0,0 +1,7 @@
+required:
+  - cryptoCurrency
+properties:
+  cryptoCurrency:
+    $ref: "../schemas/CryptoCurrency.yaml"
+  cryptoCurrencyType:
+    $ref: "../schemas/CryptoCurrencyType.yaml"
diff --git a/en/openapi/components/schemas/Customer.yaml b/en/openapi/components/schemas/Customer.yaml
@@ -0,0 +1,26 @@
+description: Customer details
+type: object
+required:
+  - id
+  - shopID
+  - status
+  - contactInfo
+  - metadata
+properties:
+  id:
+    description: Customer ID
+    type: string
+  shopID:
+    description: Shop ID
+    type: string
+  status:
+    description: Customer status
+    type: string
+    enum:
+      - ready
+      - unready
+  contactInfo:
+    $ref: "../schemas/ContactInfo.yaml"
+  metadata:
+    description: Customer metadata
+    type: object
diff --git a/en/openapi/components/schemas/CustomerBinding.yaml b/en/openapi/components/schemas/CustomerBinding.yaml
@@ -0,0 +1,16 @@
+description: Binding of the customer to the payment tool
+type: object
+allOf:
+  - 
+    $ref: "../schemas/CustomerBindingStatus.yaml"
+  - 
+    type: object
+    required:
+      - id
+      - paymentResource
+    properties:
+      id:
+        description: Customer binding identifier
+        type: string
+      paymentResource:
+        $ref: "../schemas/PaymentResource.yaml"
diff --git a/en/openapi/components/schemas/CustomerBindingError.yaml b/en/openapi/components/schemas/CustomerBindingError.yaml
@@ -0,0 +1,10 @@
+description: Description of the error that occurred during the binding process
+type: object
+required:
+  - code
+  - message
+properties:
+  code:
+    type: string
+  message:
+    type: string
diff --git a/en/openapi/components/schemas/CustomerBindingFailed.yaml b/en/openapi/components/schemas/CustomerBindingFailed.yaml
@@ -0,0 +1,14 @@
+description: Event about unsuccessful binding of the customer to the payment tool
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - customer
+      - binding
+    properties:
+      customer:
+        $ref: "../schemas/Customer.yaml"
+      binding:
+        $ref: "../schemas/CustomerBinding.yaml"
diff --git a/en/openapi/components/schemas/CustomerBindingStarted.yaml b/en/openapi/components/schemas/CustomerBindingStarted.yaml
@@ -0,0 +1,14 @@
+description: Customer binding creation event
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - customer
+      - binding
+    properties:
+      customer:
+        $ref: "../schemas/Customer.yaml"
+      binding:
+        $ref: "../schemas/CustomerBinding.yaml"
diff --git a/en/openapi/components/schemas/CustomerBindingStatus.yaml b/en/openapi/components/schemas/CustomerBindingStatus.yaml
@@ -0,0 +1,14 @@
+description: Status of binding the customer to the payment tool
+type: object
+required:
+  - status
+properties:
+  status:
+    description: Binding status
+    type: string
+    enum:
+      - pending
+      - succeeded
+      - failed
+  error:
+    $ref: "../schemas/CustomerBindingError.yaml"
diff --git a/en/openapi/components/schemas/CustomerBindingSucceeded.yaml b/en/openapi/components/schemas/CustomerBindingSucceeded.yaml
@@ -0,0 +1,14 @@
+description: Event about successful binding of the customer to the payment tool
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - customer
+      - binding
+    properties:
+      customer:
+        $ref: "../schemas/Customer.yaml"
+      binding:
+        $ref: "../schemas/CustomerBinding.yaml"
diff --git a/en/openapi/components/schemas/CustomerCreated.yaml b/en/openapi/components/schemas/CustomerCreated.yaml
@@ -0,0 +1,11 @@
+description: Customer creation event
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - customer
+    properties:
+      customer:
+        $ref: "../schemas/Customer.yaml"
diff --git a/en/openapi/components/schemas/CustomerDeleted.yaml b/en/openapi/components/schemas/CustomerDeleted.yaml
@@ -0,0 +1,11 @@
+description: Customer deletion event
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - customer
+    properties:
+      customer:
+        $ref: "../schemas/Customer.yaml"
diff --git a/en/openapi/components/schemas/CustomerPayer.yaml b/en/openapi/components/schemas/CustomerPayer.yaml
@@ -0,0 +1,12 @@
+type: object
+allOf:
+  - 
+    $ref: "../schemas/Payer.yaml"
+  - 
+    type: object
+    required:
+      - customerID
+    properties:
+      customerID:
+        description: Customer ID
+        type: string
diff --git a/en/openapi/components/schemas/CustomerReady.yaml b/en/openapi/components/schemas/CustomerReady.yaml
@@ -0,0 +1,11 @@
+description: Event on the occurrence of the customer's readiness to make payment
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - customer
+    properties:
+      customer:
+        $ref: "../schemas/Customer.yaml"
diff --git a/en/openapi/components/schemas/DigitalWalletDetails.yaml b/en/openapi/components/schemas/DigitalWalletDetails.yaml
@@ -0,0 +1,11 @@
+required:
+  - digitalWalletDetailsType
+properties:
+  digitalWalletDetailsType:
+    type: string
+    enum:
+      - DigitalWalletDetailsQIWI
+discriminator:
+  propertyName: digitalWalletDetailsType
+  mapping:
+    "DigitalWalletDetailsQIWI": "../schemas/DigitalWalletDetailsQIWI.yaml"
diff --git a/en/openapi/components/schemas/DigitalWalletDetailsQIWI.yaml b/en/openapi/components/schemas/DigitalWalletDetailsQIWI.yaml
@@ -0,0 +1,14 @@
+allOf:
+  - 
+    $ref: "../schemas/DigitalWalletDetails.yaml"
+  - 
+    type: object
+    required:
+      - phoneNumberMask
+    properties:
+      phoneNumberMask:
+        type: string
+        description: |
+          Masked phone number of the payer in international format
+        pattern: '^\+\d\*{1,10}\d{2,4}$'
+        example: "+7******3210"