valitydev · tolkonepiu · Aug 3, 2023 · Aug 3, 2023 · Aug 3, 2023 · Aug 3, 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/schemas/AccountID.yaml b/en/openapi/components/schemas/AccountID.yaml
@@ -0,0 +1,3 @@
+description: Account identifier
+type: string
+example: tZ0jUmlsV0
diff --git a/en/openapi/components/schemas/AccountNumber.yaml b/en/openapi/components/schemas/AccountNumber.yaml
@@ -0,0 +1,4 @@
+description: Account number
+type: integer
+format: int64
+example: 1430000
diff --git a/en/openapi/components/schemas/BankCard.yaml b/en/openapi/components/schemas/BankCard.yaml
@@ -0,0 +1,26 @@
+description: Bank card details
+allOf:
+  - 
+    $ref: "../schemas/DestinationResource.yaml"
+  - 
+    type: object
+    required:
+      - cardNumberMask
+      - paymentSystem
+    properties:
+      cardNumberMask:
+        description: Masked card number
+        type: string
+        pattern: '^\d{6,8}\*+\d{2,4}$'
+      bin:
+        description: Card issuing bank BIN
+        type: string
+        pattern: '^\d{6,8}$'
+      lastDigits:
+        description: Card last digits
+        type: string
+        pattern: '^\d{2,4}$'
+      paymentSystem:
+        $ref: "../schemas/BankCardPaymentSystem.yaml"
+      tokenProvider:
+        $ref: "../schemas/BankCardTokenProvider.yaml"
diff --git a/en/openapi/components/schemas/BankCardPaymentSystem.yaml b/en/openapi/components/schemas/BankCardPaymentSystem.yaml
@@ -0,0 +1,2 @@
+description: Payment system
+type: string
diff --git a/en/openapi/components/schemas/BankCardTokenProvider.yaml b/en/openapi/components/schemas/BankCardTokenProvider.yaml
@@ -0,0 +1,6 @@
+description: Payment token provider
+type: string
+enum:
+  - applepay
+  - googlepay
+  - samsungpay
diff --git a/en/openapi/components/schemas/CryptoCurrency.yaml b/en/openapi/components/schemas/CryptoCurrency.yaml
@@ -0,0 +1,9 @@
+description: Cryptocurrency
+type: string
+enum:
+  - Bitcoin
+  - Litecoin
+  - BitcoinCash
+  - Ripple
+  - Ethereum
+  - Zcash
diff --git a/en/openapi/components/schemas/CryptoWallet.yaml b/en/openapi/components/schemas/CryptoWallet.yaml
@@ -0,0 +1,18 @@
+description: Cryptocurrency wallet details
+allOf:
+  - 
+    $ref: "../schemas/DestinationResource.yaml"
+  - 
+    type: object
+    required:
+      - cryptoWalletId
+      - currency
+    properties:
+      cryptoWalletId:
+        description: Identifier (aka address) of a cryptocurrency wallet
+        type: string
+        minLength: 16
+        maxLength: 256
+        example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQ
+      currency:
+        $ref: "../schemas/CryptoCurrency.yaml"
diff --git a/en/openapi/components/schemas/CurrencyID.yaml b/en/openapi/components/schemas/CurrencyID.yaml
@@ -0,0 +1,5 @@
+description: >
+  Currency, character code according to [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
+type: string
+pattern: "^[A-Z]{3}$"
+example: RUB
diff --git a/en/openapi/components/schemas/Destination.yaml b/en/openapi/components/schemas/Destination.yaml
@@ -0,0 +1,28 @@
+description: Destination data
+type: object
+required:
+  - name
+  - currency
+  - resource
+properties:
+  id:
+    $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
+  party:
+    $ref: "../schemas/PartyID.yaml"
+  currency:
+    $ref: "../schemas/CurrencyID.yaml"
+  resource:
+    $ref: "../schemas/DestinationResource.yaml"
+  metadata:
+    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"
diff --git a/en/openapi/components/schemas/DestinationAuthorized.yaml b/en/openapi/components/schemas/DestinationAuthorized.yaml
@@ -0,0 +1,13 @@
+description: Changing the status of the destination receiver to authorized
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - destinationID
+    properties:
+      destinationID:
+        $ref: "../schemas/DestinationID.yaml"
+      externalID:
+        $ref: "../schemas/ExternalID.yaml"
diff --git a/en/openapi/components/schemas/DestinationCreated.yaml b/en/openapi/components/schemas/DestinationCreated.yaml
@@ -0,0 +1,11 @@
+description: Destination creation event
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - destination
+    properties:
+      destination:
+        $ref: "../schemas/Destination.yaml"
diff --git a/en/openapi/components/schemas/DestinationID.yaml b/en/openapi/components/schemas/DestinationID.yaml
@@ -0,0 +1,3 @@
+description: Destination identifier
+type: string
+example: "10ASF74D98"
diff --git a/en/openapi/components/schemas/DestinationName.yaml b/en/openapi/components/schemas/DestinationName.yaml
@@ -0,0 +1,3 @@
+description: Human-readable name of the destination
+type: string
+example: "Worldwide PHP Awareness Initiative"
diff --git a/en/openapi/components/schemas/DestinationResource.yaml b/en/openapi/components/schemas/DestinationResource.yaml
@@ -0,0 +1,19 @@
+description: Asset receiver resource used to make withdrawals
+type: object
+required:
+  - type
+properties:
+  type:
+    description: |
+      Destination resource type
+    type: string
+    enum:
+      - BankCard
+      - CryptoWallet
+      - DigitalWallet
+discriminator:
+  propertyName: type
+  mapping:
+    "BankCard": "../schemas/BankCard.yaml"
+    "CryptoWallet": "../schemas/CryptoWallet.yaml"
+    "DigitalWallet": "../schemas/DigitalWallet.yaml"
diff --git a/en/openapi/components/schemas/DestinationUnauthorized.yaml b/en/openapi/components/schemas/DestinationUnauthorized.yaml
@@ -0,0 +1,13 @@
+description: Changing the status of the destination receiver to unauthorized
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - destinationID
+    properties:
+      destinationID:
+        $ref: "../schemas/DestinationID.yaml"
+      externalID:
+        $ref: "../schemas/ExternalID.yaml"
diff --git a/en/openapi/components/schemas/DigitalWallet.yaml b/en/openapi/components/schemas/DigitalWallet.yaml
@@ -0,0 +1,20 @@
+description: Cryptocurrency wallet details
+allOf:
+  - 
+    $ref: "../schemas/DestinationResource.yaml"
+  - 
+    type: object
+    required:
+      - digitalWalletId
+      - digitalWalletProvider
+    properties:
+      digitalWalletId:
+        description: E-wallet identifier
+        type: string
+        minLength: 16
+        maxLength: 256
+        example: zu3TcwGI71Bpaaw2XkLWZXlhMdn4zpVzMQ
+      digitalWalletProvider:
+        description: Electronic assets service provider
+        type: string
+        example: Paypal
diff --git a/en/openapi/components/schemas/Event.yaml b/en/openapi/components/schemas/Event.yaml
@@ -0,0 +1,35 @@
+description: Event data
+type: object
+required:
+  - occuredAt
+  - topic
+  - eventType
+properties:
+  eventID:
+    description: Event identifier
+    type: string
+  occuredAt:
+    description: Date and time the event occurrence
+    type: string
+    format: date-time
+  topic:
+    description: Subject of notification
+    type: string
+    enum:
+      - WithdrawalTopic
+      - DestinationTopic
+  eventType:
+    type: string
+    description: Type of event that occurred.
+    enum:
+      - WithdrawalStarted
+      - WithdrawalSucceeded
+      - WithdrawalFailed
+      - DestinationCreated
+discriminator:
+  propertyName: eventType
+  mapping:
+    "WithdrawalStarted": "../schemas/WithdrawalStarted.yaml"
+    "WithdrawalSucceeded": "../schemas/WithdrawalSucceeded.yaml"
+    "WithdrawalFailed": "../schemas/WithdrawalFailed.yaml"
+    "DestinationCreated": "../schemas/DestinationCreated.yaml"
diff --git a/en/openapi/components/schemas/ExternalID.yaml b/en/openapi/components/schemas/ExternalID.yaml
@@ -0,0 +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"
diff --git a/en/openapi/components/schemas/Fee.yaml 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'
diff --git a/en/openapi/components/schemas/GeneralError.yaml b/en/openapi/components/schemas/GeneralError.yaml
@@ -0,0 +1,6 @@
+type: object
+required:
+  - message
+properties:
+  message:
+    type: string
diff --git a/en/openapi/components/schemas/IdentityID.yaml b/en/openapi/components/schemas/IdentityID.yaml
@@ -0,0 +1,3 @@
+description: Identifier of wallet owner
+type: string
+example: tZ0jUmlsV0
diff --git a/en/openapi/components/schemas/PartyID.yaml b/en/openapi/components/schemas/PartyID.yaml
@@ -0,0 +1,3 @@
+description: Identifier of owner
+type: string
+example: tZ0jUmlsV0
diff --git a/en/openapi/components/schemas/WalletID.yaml b/en/openapi/components/schemas/WalletID.yaml
@@ -0,0 +1,3 @@
+description: Identifier of the wallet
+type: string
+example: "10068321"
diff --git a/en/openapi/components/schemas/Withdrawal.yaml b/en/openapi/components/schemas/Withdrawal.yaml
@@ -0,0 +1,24 @@
+description: Funds withdrawal data
+type: object
+required:
+  - wallet
+  - destination
+  - body
+properties:
+  id:
+    $ref: "../schemas/WithdrawalID.yaml"
+  createdAt:
+    description: Date and time the withdrawal started
+    type: string
+    format: date-time
+  destination:
+    $ref: "../schemas/DestinationID.yaml"
+  body:
+    $ref: "../schemas/WithdrawalBody.yaml"
+  metadata:
+    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"
+  externalID:
+    $ref: "../schemas/ExternalID.yaml"
diff --git a/en/openapi/components/schemas/WithdrawalBody.yaml b/en/openapi/components/schemas/WithdrawalBody.yaml
@@ -0,0 +1,15 @@
+description: |
+  Amount of funds to be withdrawn
+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"
diff --git a/en/openapi/components/schemas/WithdrawalFailed.yaml b/en/openapi/components/schemas/WithdrawalFailed.yaml
@@ -0,0 +1,13 @@
+description: Unsuccessful withdrawal event
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - withdrawalID
+    properties:
+      withdrawalID:
+        $ref: "../schemas/WithdrawalID.yaml"
+      externalID:
+        $ref: "../schemas/ExternalID.yaml"
diff --git a/en/openapi/components/schemas/WithdrawalID.yaml b/en/openapi/components/schemas/WithdrawalID.yaml
@@ -0,0 +1,3 @@
+description: Identifier of funds withdrawal
+type: string
+example: tZ0jUmlsV0
diff --git a/en/openapi/components/schemas/WithdrawalStarted.yaml b/en/openapi/components/schemas/WithdrawalStarted.yaml
@@ -0,0 +1,11 @@
+description: Withdrawal start event
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - withdrawal
+    properties:
+      withdrawal:
+        $ref: "../schemas/Withdrawal.yaml"
diff --git a/en/openapi/components/schemas/WithdrawalSucceeded.yaml b/en/openapi/components/schemas/WithdrawalSucceeded.yaml
@@ -0,0 +1,15 @@
+description: Successful withdrawal event
+allOf:
+  - 
+    $ref: "../schemas/Event.yaml"
+  - 
+    type: object
+    required:
+      - withdrawalID
+    properties:
+      withdrawalID:
+        $ref: "../schemas/WithdrawalID.yaml"
+      externalID:
+        $ref: "../schemas/ExternalID.yaml"
+      fee:
+        $ref: "../schemas/Fee.yaml"