Brokerage payment orders

Варианты

• Public

Операции API

{
  "description": "Метод возвращает платёжные поручения организаций, доступных пользователю",
  "operationId": "getPaymentOrders",
  "parameters": [
    {
      "$ref": "#/components/parameters/PageNumberParam"
    },
    {
      "$ref": "#/components/parameters/PageSizeParam"
    },
    {
      "$ref": "#/components/parameters/AuthorizationHeader"
    },
    {
      "$ref": "#/components/parameters/IdTokenHeader_1"
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "examples": {
            "simple": {
              "$ref": "#/components/examples/PaymentOrderListResponseExample"
            }
          },
          "schema": {
            "$ref": "#/components/schemas/PaymentOrderListResponse"
          }
        }
      },
      "description": "Список платёжных поручений"
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "security": [
    {
      "accessToken": []
    },
    {
      "idToken": []
    },
    {
      "RaifApiAuthorization": [],
      "RaifApiIdToken": []
    }
  ],
  "servers": [
    {
      "url": "https://api.raiffeisen.ru/brokerage"
    }
  ],
  "summary": "Get payment orders",
  "tags": [
    "brokerage-payment-orders"
  ]
}

{
  "description": "Метод создаёт подписанное брокерское платёжное поручение",
  "operationId": "createPaymentOrder",
  "parameters": [
    {
      "$ref": "#/components/parameters/SignatureHeader"
    },
    {
      "$ref": "#/components/parameters/CryptoProfileIdHeader"
    },
    {
      "$ref": "#/components/parameters/SkipSecurityCacheHeader"
    },
    {
      "$ref": "#/components/parameters/AuthorizationHeader"
    },
    {
      "$ref": "#/components/parameters/IdTokenHeader_1"
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "examples": {
          "simple": {
            "$ref": "#/components/examples/PaymentOrderCreateRequestExample"
          }
        },
        "schema": {
          "$ref": "#/components/schemas/PaymentOrderCreateRequest"
        }
      }
    },
    "description": "Данные платёжного поручения",
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "examples": {
            "simple": {
              "$ref": "#/components/examples/PaymentOrderResponseExample"
            }
          },
          "schema": {
            "$ref": "#/components/schemas/PaymentOrder"
          }
        }
      },
      "description": "Созданное платёжное поручение"
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "security": [
    {
      "accessToken": []
    },
    {
      "idToken": []
    },
    {
      "RaifApiAuthorization": [],
      "RaifApiIdToken": []
    }
  ],
  "servers": [
    {
      "url": "https://api.raiffeisen.ru/brokerage"
    }
  ],
  "summary": "Create a payment order",
  "tags": [
    "brokerage-payment-orders"
  ]
}

{
  "description": "Метод возвращает платёжное поручение по идентификатору",
  "operationId": "getPaymentOrder",
  "parameters": [
    {
      "$ref": "#/components/parameters/PaymentOrderIdPathParam"
    },
    {
      "$ref": "#/components/parameters/AuthorizationHeader"
    },
    {
      "$ref": "#/components/parameters/IdTokenHeader_1"
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "examples": {
            "simple": {
              "$ref": "#/components/examples/PaymentOrderResponseExample"
            }
          },
          "schema": {
            "$ref": "#/components/schemas/PaymentOrder"
          }
        }
      },
      "description": "Платёжное поручение"
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "security": [
    {
      "accessToken": []
    },
    {
      "idToken": []
    },
    {
      "RaifApiAuthorization": [],
      "RaifApiIdToken": []
    }
  ],
  "servers": [
    {
      "url": "https://api.raiffeisen.ru/brokerage"
    }
  ],
  "summary": "Get a payment order by ID",
  "tags": [
    "brokerage-payment-orders"
  ]
}

Схемы и примеры

{
  "examples": {
    "ErrorResponseExample": {
      "description": "ErrorResponse",
      "summary": "Пример ошибки",
      "value": {
        "code": "VALIDATION_ERROR",
        "errors": null,
        "message": "Параметры запроса не прошли проверку",
        "traceId": "4bf92f3577b34da6a3ce929d0e0e4736"
      }
    },
    "PaymentOrderCreateRequestExample": {
      "description": "PaymentOrderCreateRequest",
      "summary": "Пример создания платёжного поручения",
      "value": {
        "accountFrom": "40702810900000000001",
        "accountTo": "40702810900000000002",
        "agreementNumber": "35463",
        "amount": 150000.5,
        "description": "Пополнение брокерского счёта"
      }
    },
    "PaymentOrderListResponseExample": {
      "description": "PaymentOrderList",
      "summary": "Пример списка платёжных поручений",
      "value": [
        {
          "accountFrom": "40702810900000000001",
          "accountTo": "40702810900000000002",
          "agreementNumber": "35463",
          "amount": 150000.5,
          "description": "Пополнение брокерского счёта",
          "errorDescription": null,
          "id": 128745,
          "status": "SUCCESS"
        },
        {
          "accountFrom": "40702810900000000001",
          "accountTo": "40702810900000000002",
          "agreementNumber": "35463",
          "amount": 25000,
          "description": "Пополнение брокерского счёта",
          "errorDescription": null,
          "id": 128746,
          "status": "IN_PROGRESS"
        }
      ]
    },
    "PaymentOrderResponseExample": {
      "description": "PaymentOrder",
      "summary": "Пример платёжного поручения",
      "value": {
        "accountFrom": "40702810900000000001",
        "accountTo": "40702810900000000002",
        "agreementNumber": "35463",
        "amount": 150000.5,
        "description": "Пополнение брокерского счёта",
        "errorDescription": null,
        "id": 128745,
        "status": "SUCCESS"
      }
    }
  },
  "parameters": {
    "AuthorizationHeader": {
      "description": "Токен доступа",
      "in": "header",
      "name": "Authorization",
      "required": true,
      "schema": {
        "example": "Bearer QXV0aG9yaXphdGlvbiBIZWFkZXIgRm9yIFRlc3Rpbmc=",
        "format": "byte",
        "type": "string"
      }
    },
    "CryptoProfileIdHeader": {
      "description": "Идентификатор криптографического профиля подписанта",
      "example": "6a9b8c7d-1234-4567-890a-bcdef1234567",
      "in": "header",
      "name": "X-Signature-Crypto-Profile-Id",
      "required": true,
      "schema": {
        "example": "6a9b8c7d-1234-4567-890a-bcdef1234567",
        "type": "string"
      }
    },
    "IdTokenHeader_1": {
      "description": "Идентификационный токен пользователя",
      "in": "header",
      "name": "Id-Token",
      "required": true,
      "schema": {
        "example": "SUQgVE9LRU4gRk9SIFRFU1RJTkc=",
        "format": "byte",
        "type": "string"
      }
    },
    "PageNumberParam": {
      "description": "Номер страницы, начиная с нуля",
      "example": 0,
      "in": "query",
      "name": "page",
      "required": false,
      "schema": {
        "default": 0,
        "example": 0,
        "minimum": 0,
        "type": "integer"
      }
    },
    "PageSizeParam": {
      "description": "Количество элементов на странице",
      "example": 20,
      "in": "query",
      "name": "size",
      "required": false,
      "schema": {
        "default": 20,
        "example": 20,
        "minimum": 1,
        "type": "integer"
      }
    },
    "PaymentOrderIdPathParam": {
      "description": "Идентификатор платёжного поручения",
      "example": 128745,
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "$ref": "#/components/schemas/PaymentOrderId"
      }
    },
    "SignatureHeader": {
      "description": "Электронная подпись канонического JSON-тела запроса",
      "example": "MEUCIQDxExampleSignature",
      "in": "header",
      "name": "X-Signature-Sign",
      "required": true,
      "schema": {
        "example": "MEUCIQDxExampleSignature",
        "type": "string"
      }
    },
    "SkipSecurityCacheHeader": {
      "description": "Признак принудительного обновления полномочий пользователя",
      "example": false,
      "in": "header",
      "name": "X-Skip-Security-Cache",
      "required": false,
      "schema": {
        "default": false,
        "example": false,
        "type": "boolean"
      }
    }
  },
  "responses": {
    "BadRequest": {
      "content": {
        "application/json": {
          "examples": {
            "simple": {
              "$ref": "#/components/examples/ErrorResponseExample"
            }
          },
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Некорректный запрос"
    },
    "Forbidden": {
      "content": {
        "application/json": {
          "examples": {
            "simple": {
              "$ref": "#/components/examples/ErrorResponseExample"
            }
          },
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Недостаточно прав для выполнения операции"
    },
    "InternalError": {
      "description": "Внутренняя ошибка"
    },
    "NotFound": {
      "content": {
        "application/json": {
          "examples": {
            "simple": {
              "$ref": "#/components/examples/ErrorResponseExample"
            }
          },
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Платёжное поручение не найдено"
    },
    "Unauthorized": {
      "description": "Аутентификация не пройдена"
    }
  },
  "schemas": {
    "ErrorResponse": {
      "properties": {
        "code": {
          "description": "Error code",
          "example": "VALIDATION_ERROR",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Error details by fields",
          "example": null,
          "nullable": true,
          "type": "object"
        },
        "message": {
          "description": "Error description",
          "example": "Параметры запроса не прошли проверку",
          "type": "string"
        },
        "traceId": {
          "description": "Request trace ID",
          "example": "4bf92f3577b34da6a3ce929d0e0e4736",
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "PaymentOrder": {
      "properties": {
        "accountFrom": {
          "description": "Debit account",
          "example": "40702810900000000001",
          "type": "string"
        },
        "accountTo": {
          "description": "Credit account",
          "example": "40702810900000000002",
          "type": "string"
        },
        "agreementNumber": {
          "description": "Brokerage agreement number",
          "example": "35463",
          "type": "string"
        },
        "amount": {
          "description": "Payment amount",
          "example": 150000.5,
          "type": "number"
        },
        "description": {
          "description": "Payment purpose",
          "example": "Пополнение брокерского счёта",
          "type": "string"
        },
        "errorDescription": {
          "description": "Payment order processing error description",
          "example": null,
          "nullable": true,
          "type": "string"
        },
        "id": {
          "$ref": "#/components/schemas/PaymentOrderId"
        },
        "status": {
          "$ref": "#/components/schemas/PaymentOrderStatus"
        }
      },
      "type": "object"
    },
    "PaymentOrderCreateRequest": {
      "properties": {
        "accountFrom": {
          "description": "Debit account",
          "example": "40702810900000000001",
          "type": "string"
        },
        "accountTo": {
          "description": "Credit account",
          "example": "40702810900000000002",
          "type": "string"
        },
        "agreementNumber": {
          "description": "Brokerage agreement number",
          "example": "35463",
          "type": "string"
        },
        "amount": {
          "description": "Payment amount",
          "example": 150000.5,
          "type": "number"
        },
        "description": {
          "description": "Payment purpose",
          "example": "Пополнение брокерского счёта",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PaymentOrderId": {
      "description": "Payment order ID",
      "example": 128745,
      "format": "int64",
      "type": "integer"
    },
    "PaymentOrderListResponse": {
      "description": "Список платёжных поручений",
      "example": [
        {
          "accountFrom": "40702810900000000001",
          "accountTo": "40702810900000000002",
          "agreementNumber": "35463",
          "amount": 150000.5,
          "description": "Пополнение брокерского счёта",
          "errorDescription": null,
          "id": 128745,
          "status": "SUCCESS"
        },
        {
          "accountFrom": "40702810900000000001",
          "accountTo": "40702810900000000002",
          "agreementNumber": "35463",
          "amount": 25000,
          "description": "Пополнение брокерского счёта",
          "errorDescription": null,
          "id": 128746,
          "status": "IN_PROGRESS"
        }
      ],
      "items": {
        "$ref": "#/components/schemas/PaymentOrder"
      },
      "type": "array"
    },
    "PaymentOrderStatus": {
      "description": "Payment order processing status",
      "enum": [
        "IN_PROGRESS",
        "SUCCESS",
        "ERROR"
      ],
      "example": "SUCCESS",
      "type": "string"
    }
  },
  "securitySchemes": {
    "RaifApiAuthorization": {
      "scheme": "bearer",
      "type": "http"
    },
    "RaifApiIdToken": {
      "in": "header",
      "name": "Id-Token",
      "type": "apiKey"
    },
    "accessToken": {
      "bearerFormat": "JWT",
      "scheme": "bearer",
      "type": "http"
    },
    "idToken": {
      "in": "header",
      "name": "Id-Token",
      "type": "apiKey"
    }
  }
}