Changes in the API Specification

Back to the summary

Info

  • Version: 1.16.01.17.0

Added endpoints

DELETE /savings_plans/{savings_plan_id}

See updated API reference

Modified endpoints


GET /account_groups/{account_group_id}/payments/cash_balance

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /account_groups/{account_group_id}/payments/direct_debits

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


GET /account_groups/{account_group_id}/payments/withdrawals

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


GET /accounts/{account_id}/liquidations

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


POST /accounts/{account_id}/liquidations

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "202":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /accounts/{account_id}/liquidations/{account_liquidation_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /accounts/{account_id}/orders

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    currency:
                                                        allOf:
                                                            (modified):
                                                                '#1':
                                                                    format:
                                                                        from: ISO4217
                                                                        to: ""
                                                    executions:
                                                        items:
                                                            required:
                                                                stringsdiff:
                                                                    (added):
                                                                        - venue_id
                                                            properties:
                                                                (added):
                                                                    - venue_id
                                                                (modified):
                                                                    currency:
                                                                        format:
                                                                            from: ISO4217
                                                                            to: ""

See updated API reference


GET /accounts/{account_id}/valuations

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    security_positions:
                                                        items:
                                                            properties:
                                                                (modified):
                                                                    value:
                                                                        allOf:
                                                                            (modified):
                                                                                '#1':
                                                                                    properties:
                                                                                        (modified):
                                                                                            currency:
                                                                                                format:
                                                                                                    from: ISO4217
                                                                                                    to: ""
                                                    total_security_value:
                                                        properties:
                                                            (modified):
                                                                currency:
                                                                    format:
                                                                        from: ISO4217
                                                                        to: ""

See updated API reference


GET /accounts/{account_id}/valuations/current

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    security_positions:
                                        items:
                                            properties:
                                                (modified):
                                                    value:
                                                        allOf:
                                                            (modified):
                                                                '#1':
                                                                    properties:
                                                                        (modified):
                                                                            currency:
                                                                                format:
                                                                                    from: ISO4217
                                                                                    to: ""
                                    total_security_value:
                                        properties:
                                            (modified):
                                                currency:
                                                    format:
                                                        from: ISO4217
                                                        to: ""

See updated API reference


GET /fees/collections

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


POST /fees/collections

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            currency:
                                format:
                                    from: ISO4217
                                    to: ""
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /fees/collections/{fee_collection_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /instruments/{instrument_id}/venues/{venue_id}/prices/latest

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /instruments/{instrument_id}/venues/{venue_id}/prices/ohlc

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


POST /orders

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            currency:
                                allOf:
                                    (modified):
                                        '#1':
                                            format:
                                                from: ISO4217
                                                to: ""
responses:
    (modified):
        "202":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        allOf:
                                            (modified):
                                                '#1':
                                                    format:
                                                        from: ISO4217
                                                        to: ""
                                    executions:
                                        items:
                                            required:
                                                stringsdiff:
                                                    (added):
                                                        - venue_id
                                            properties:
                                                (added):
                                                    - venue_id
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


GET /orders/{order_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        allOf:
                                            (modified):
                                                '#1':
                                                    format:
                                                        from: ISO4217
                                                        to: ""
                                    executions:
                                        items:
                                            required:
                                                stringsdiff:
                                                    (added):
                                                        - venue_id
                                            properties:
                                                (added):
                                                    - venue_id
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


GET /orders/{order_id}/executions/{execution_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            required:
                                stringsdiff:
                                    (added):
                                        - venue_id
                            properties:
                                (added):
                                    - venue_id
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


POST /payments/direct_debits

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /payments/direct_debits/{direct_debit_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


POST /payments/withdrawals

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /payments/withdrawals/{withdrawal_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /portfolios/orders

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


POST /portfolios/orders

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            currency:
                                format:
                                    from: ISO4217
                                    to: ""
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /portfolios/orders/{portfolio_order_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


POST /reports

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    oneOf:
                        (modified):
                            '#1':
                                properties:
                                    (modified):
                                        fees:
                                            items:
                                                oneOf:
                                                    (modified):
                                                        '#1':
                                                            properties:
                                                                (modified):
                                                                    currency:
                                                                        format:
                                                                            from: ISO4217
                                                                            to: ""
                                        order:
                                            properties:
                                                (modified):
                                                    currency:
                                                        allOf:
                                                            (modified):
                                                                '#1':
                                                                    format:
                                                                        from: ISO4217
                                                                        to: ""
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            oneOf:
                                (modified):
                                    '#1':
                                        properties:
                                            (modified):
                                                data:
                                                    properties:
                                                        (modified):
                                                            order:
                                                                properties:
                                                                    (modified):
                                                                        currency:
                                                                            allOf:
                                                                                (modified):
                                                                                    '#1':
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            product_cost:
                                                                properties:
                                                                    (modified):
                                                                        incidental:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        one_off:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        ongoing:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        total:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        transaction:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            return_impact:
                                                                properties:
                                                                    (modified):
                                                                        year_one:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        year_three:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        year_two:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            service_cost:
                                                                properties:
                                                                    (modified):
                                                                        ancillary:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        incidental:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        one_off:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        ongoing:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        total:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        transaction:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            third_party_payments:
                                                                properties:
                                                                    (modified):
                                                                        total:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            total_cost:
                                                                properties:
                                                                    (modified):
                                                                        product:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        service:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        third_party:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        total:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""

See updated API reference


GET /reports/{report_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            oneOf:
                                (modified):
                                    '#2':
                                        properties:
                                            (modified):
                                                data:
                                                    properties:
                                                        (modified):
                                                            order:
                                                                properties:
                                                                    (modified):
                                                                        currency:
                                                                            allOf:
                                                                                (modified):
                                                                                    '#1':
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            product_cost:
                                                                properties:
                                                                    (modified):
                                                                        incidental:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        one_off:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        ongoing:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        total:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        transaction:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            return_impact:
                                                                properties:
                                                                    (modified):
                                                                        year_one:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        year_three:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        year_two:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            service_cost:
                                                                properties:
                                                                    (modified):
                                                                        ancillary:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        incidental:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        one_off:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        ongoing:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        total:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        transaction:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            third_party_payments:
                                                                properties:
                                                                    (modified):
                                                                        total:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                            total_cost:
                                                                properties:
                                                                    (modified):
                                                                        product:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        service:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        third_party:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""
                                                                        total:
                                                                            properties:
                                                                                (modified):
                                                                                    currency:
                                                                                        format:
                                                                                            from: ISO4217
                                                                                            to: ""

See updated API reference


GET /savings_plans

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (added):
                                                    - status
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""

See updated API reference


POST /savings_plans

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            currency:
                                format:
                                    from: ISO4217
                                    to: ""
responses:
    (modified):
        "202":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (added):
                                    - status
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /savings_plans/{savings_plan_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (added):
                                    - status
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


GET /savings_plans/{savings_plan_id}/executions

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    currency:
                                                        format:
                                                            from: ISO4217
                                                            to: ""
                                                    order_id:
                                                        oneOf:
                                                            (modified):
                                                                '#2':
                                                                    properties:
                                                                        (modified):
                                                                            currency:
                                                                                allOf:
                                                                                    (modified):
                                                                                        '#1':
                                                                                            format:
                                                                                                from: ISO4217
                                                                                                to: ""
                                                                            executions:
                                                                                items:
                                                                                    required:
                                                                                        stringsdiff:
                                                                                            (added):
                                                                                                - venue_id
                                                                                    properties:
                                                                                        (added):
                                                                                            - venue_id
                                                                                        (modified):
                                                                                            currency:
                                                                                                format:
                                                                                                    from: ISO4217
                                                                                                    to: ""

See updated API reference


GET /savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""
                                    order_id:
                                        oneOf:
                                            (modified):
                                                '#2':
                                                    properties:
                                                        (modified):
                                                            currency:
                                                                allOf:
                                                                    (modified):
                                                                        '#1':
                                                                            format:
                                                                                from: ISO4217
                                                                                to: ""
                                                            executions:
                                                                items:
                                                                    required:
                                                                        stringsdiff:
                                                                            (added):
                                                                                - venue_id
                                                                    properties:
                                                                        (added):
                                                                            - venue_id
                                                                        (modified):
                                                                            currency:
                                                                                format:
                                                                                    from: ISO4217
                                                                                    to: ""

See updated API reference


POST /tests/payments/transactions

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            currency:
                                format:
                                    from: ISO4217
                                    to: ""

See updated API reference


GET /transactions/cash

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            properties:
                                                (modified):
                                                    delta:
                                                        properties:
                                                            (modified):
                                                                currency:
                                                                    format:
                                                                        from: ISO4217
                                                                        to: ""
                                                    references:
                                                        items:
                                                            properties:
                                                                (modified):
                                                                    type:
                                                                        enum:
                                                                            (deleted):
                                                                                - TREASURY_PAYMENT
                                                    taxes:
                                                        items:
                                                            properties:
                                                                (modified):
                                                                    currency:
                                                                        format:
                                                                            from: ISO4217
                                                                            to: ""
                                                    type:
                                                        enum:
                                                            (added):
                                                                - TAX_OPTIMISATION

See updated API reference


GET /users/{user_id}/reports

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

parameters:
    (modified):
        query:
            type:
                schema:
                    enum:
                        (added):
                            - QUARTERLY_ACCOUNT_STATEMENT
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    data:
                                        items:
                                            oneOf:
                                                (modified):
                                                    '#2':
                                                        properties:
                                                            (modified):
                                                                data:
                                                                    properties:
                                                                        (modified):
                                                                            order:
                                                                                properties:
                                                                                    (modified):
                                                                                        currency:
                                                                                            allOf:
                                                                                                (modified):
                                                                                                    '#1':
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                            product_cost:
                                                                                properties:
                                                                                    (modified):
                                                                                        incidental:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        one_off:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        ongoing:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        total:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        transaction:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                            return_impact:
                                                                                properties:
                                                                                    (modified):
                                                                                        year_one:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        year_three:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        year_two:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                            service_cost:
                                                                                properties:
                                                                                    (modified):
                                                                                        ancillary:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        incidental:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        one_off:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        ongoing:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        total:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        transaction:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                            third_party_payments:
                                                                                properties:
                                                                                    (modified):
                                                                                        total:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                            total_cost:
                                                                                properties:
                                                                                    (modified):
                                                                                        product:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        service:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        third_party:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""
                                                                                        total:
                                                                                            properties:
                                                                                                (modified):
                                                                                                    currency:
                                                                                                        format:
                                                                                                            from: ISO4217
                                                                                                            to: ""

See updated API reference


POST /virtual_cash_balances/decreases

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            currency:
                                format:
                                    from: ISO4217
                                    to: ""
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


POST /virtual_cash_balances/increases

Details

Fields in parentheses, such as (modified): or (added):, mark what has changed and are not part of the API Specification or the OpenAPI standard:

requestBody:
    content:
        (mediaTypeModified):
            application/json:
                schema:
                    properties:
                        (modified):
                            currency:
                                format:
                                    from: ISO4217
                                    to: ""
responses:
    (modified):
        "200":
            content:
                (mediaTypeModified):
                    application/json:
                        schema:
                            properties:
                                (modified):
                                    currency:
                                        format:
                                            from: ISO4217
                                            to: ""

See updated API reference


Was this page helpful?