The Treasury Mandates API from Lemon Markets — 9 operation(s) for treasury mandates.
openapi: 3.1.0
info:
title: "lemon.markets Brokerage API \uD83C\uDF4B Accounts: General Treasury Mandates API"
version: 0.1.0
servers:
- url: https://sandbox.api.lemon.markets/v1
description: Sandbox
security:
- bearerAuth: []
tags:
- name: Treasury Mandates
paths:
/accounts/{account_id}/treasury_financials:
get:
summary: Get Treasury Financials
operationId: get_treasury_financials
tags:
- Treasury Mandates
parameters:
- name: account_id
required: true
schema:
title: Account Identifier
type: string
in: path
example: cusa_20323d55bb264d42b0b225d293591049
description: 'An account identifier.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerAccountTreasuryFinancialsResponse'
example:
available_balance: '0.00'
currency: EUR
portfolio_balance: '1250.00'
unsettled_deposits: '1250.00'
unsettled_withdrawals: '0.00'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/accounts/{account_id}/treasury_mandates:
post:
summary: Create Treasury Mandate
operationId: create_treasury_mandate
tags:
- Treasury Mandates
parameters:
- name: account_id
required: true
schema:
title: Account Identifier
type: string
in: path
example: cusa_20323d55bb264d42b0b225d293591049
description: 'An account identifier.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTreasuryMandateRequest'
example:
instrument: IE0008643037
widget_styling:
background_color: '#FFFFFF'
text_color: '#000000'
button_background_color: '#007AFF'
button_text_color: '#FFFFFF'
redirect_failure: my-app:/failure
redirect_success: my-app:/success
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TreasuryMandateCreationResponse'
example:
id: trs_mand_bb176dfbabe14c6c9bb35eaf3342d223
instrument: IE0008643037
widget_styling:
background_color: '#FFFFFF'
text_color: '#000000'
button_background_color: '#007AFF'
button_text_color: '#FFFFFF'
button_position_style: sticky
redirect_failure: my-app:/failure
redirect_success: my-app:/success
history:
- status: created
timestamp: '2025-05-08T15:59:20.701735+00:00'
widget_url: https://lemon-markets.example.com/?...
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
get:
summary: List Treasury Mandates
operationId: list_treasury_mandates
tags:
- Treasury Mandates
parameters:
- name: account_id
required: true
schema:
title: Account Identifier
type: string
in: path
example: cusa_20323d55bb264d42b0b225d293591049
description: 'An account identifier.
'
- name: status
in: query
required: false
schema:
$ref: '#/components/schemas/TreasuryMandateStatus'
- name: cursor
required: false
schema:
title: Cursor
type: string
description: 'A pagination cursor. When you receive a paginated response containing the property `pagination.next_cursor`, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is not need to specify both the `cursor` and any other filter parameter.
'
in: query
- name: limit
description: 'In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.
'
required: false
schema:
title: Limit
maximum: 100
minimum: 1
type: integer
default: 100
in: query
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/EncodedPaginatedCollectionResponse_TreasuryMandateResponse_'
example:
data:
- history:
- status: created
timestamp: '2025-05-08T15:59:20.701735+00:00'
id: trs_mand_bb176dfbabe14c6c9bb35eaf3342d223
instrument: IE0008643037
redirect_failure: my-app:/failure
redirect_success: my-app:/success
pagination:
next_cursor: null
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/accounts/{account_id}/treasury_mandates/{mandate_id}:
get:
summary: Get Treasury Mandate
operationId: get_treasury_mandate
tags:
- Treasury Mandates
parameters:
- name: account_id
required: true
schema:
title: Account Identifier
type: string
in: path
example: cusa_20323d55bb264d42b0b225d293591049
description: 'An account identifier.
'
- name: mandate_id
in: path
required: true
schema:
type: string
title: Treasury Mandate Identifier
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TreasuryMandateResponse'
example:
id: trs_mand_bb176dfbabe14c6c9bb35eaf3342d223
instrument: IE0008643037
redirect_failure: my-app:/failure
redirect_success: my-app:/success
history:
- status: created
timestamp: '2025-05-08T15:59:20.701735+00:00'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/accounts/{account_id}/treasury_mandates/{mandate_id}/cancel:
post:
summary: Cancel Treasury Mandate
description: Cancel a treasury mandate
operationId: cancel_treasury_mandate
tags:
- Treasury Mandates
parameters:
- name: account_id
required: true
schema:
title: Account Identifier
type: string
in: path
example: cusa_20323d55bb264d42b0b225d293591049
description: 'An account identifier.
'
- name: mandate_id
in: path
required: true
schema:
type: string
title: Mandate Id
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TreasuryMandateResponse'
example:
id: trs_mand_bb176dfbabe14c6c9bb35eaf3342d223
instrument: IE0008643037
redirect_failure: my-app:/failure
redirect_success: my-app:/success
history:
- status: canceled
timestamp: '2025-05-08T16:10:04.321121+00:00'
- status: created
timestamp: '2025-05-08T15:59:20.701735+00:00'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/accounts/{account_id}/treasury_transfers:
post:
summary: Create Treasury Transfer
operationId: create_treasury_transfer
tags:
- Treasury Mandates
parameters:
- name: account_id
required: true
schema:
title: Account Identifier
type: string
in: path
example: cusa_20323d55bb264d42b0b225d293591049
description: 'An account identifier.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTreasuryTransferRequest'
example:
amount: '1250.00'
currency: EUR
treasury_mandate: trs_mand_a2fb6c7579f14ad4970271bf19416e30
type: deposit
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TreasuryTransferResponse'
example:
id: trs_tfr_20d4e52ec6a74986a31efca9b6a2567d
treasury_mandate: trs_mand_a2fb6c7579f14ad4970271bf19416e30
type: deposit
amount: '1250.00'
currency: EUR
history:
- status: created
timestamp: '2025-05-14T14:18:47.520025+00:00'
order: bord_f5f53afa402a45df9a79b868da2c18b9
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
get:
summary: List Treasury Transfers
operationId: list_treasury_transfers
tags:
- Treasury Mandates
parameters:
- name: account_id
required: true
schema:
title: Account Identifier
type: string
in: path
example: cusa_20323d55bb264d42b0b225d293591049
description: 'An account identifier.
'
- name: cursor
required: false
schema:
title: Cursor
type: string
description: 'A pagination cursor. When you receive a paginated response containing the property `pagination.next_cursor`, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is not need to specify both the `cursor` and any other filter parameter.
'
in: query
- name: limit
description: 'In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.
'
required: false
schema:
title: Limit
maximum: 100
minimum: 1
type: integer
default: 100
in: query
- name: status
in: query
required: false
schema:
$ref: '#/components/schemas/TreasuryTransferStatus'
title: Status
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/EncodedPaginatedCollectionResponse_TreasuryTransferResponse_'
example:
data:
- amount: '1250.00'
currency: EUR
history:
- status: created
timestamp: '2025-05-14T14:18:47.520025+00:00'
id: trs_tfr_20d4e52ec6a74986a31efca9b6a2567d
treasury_mandate: trs_mand_a2fb6c7579f14ad4970271bf19416e30
order: bord_f5f53afa402a45df9a79b868da2c18b9
type: deposit
pagination:
next_cursor: null
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/accounts/{account_id}/treasury_transfers/{treasury_transfer_id}:
get:
summary: Get Treasury Transfer
operationId: get_treasury_transfer
tags:
- Treasury Mandates
parameters:
- name: account_id
required: true
schema:
title: Account Identifier
type: string
in: path
example: cusa_20323d55bb264d42b0b225d293591049
description: 'An account identifier.
'
- name: treasury_transfer_id
in: path
required: true
schema:
type: string
title: Treasury Transfer Identifier
description: 'A treasury transfer identifier.
'
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TreasuryTransferResponse'
example:
amount: '1250.00'
currency: EUR
history:
- status: created
timestamp: '2025-05-14T14:18:47.520025+00:00'
id: trs_tfr_20d4e52ec6a74986a31efca9b6a2567d
treasury_mandate: trs_mand_a2fb6c7579f14ad4970271bf19416e30
order: bord_f5f53afa402a45df9a79b868da2c18b9
type: deposit
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/treasury_fees:
get:
summary: List Treasury Fees
operationId: list_treasury_fees
tags:
- Treasury Mandates
description: Retrieves a paginated list of monthly aggregated treasury fees owned by the requesting partner. Optionally filter by instrument or billing month range.
parameters:
- name: instrument
in: query
required: false
description: An ISIN (International Securities Identification Number) conforming to ISO 6166. This value uniquely identifies the instrument.
schema:
type: string
pattern: ^[A-Z]{2}[0-9A-Z]{9}[0-9]$
title: Instrument
- name: from_month
in: query
required: false
description: Start of the billing period (inclusive), in format YYYY-MM (e.g., 2025-01).
schema:
type: string
pattern: ^\d{4}-(0[1-9]|1[0-2])$
title: From Month
- name: to_month
in: query
required: false
description: End of the billing period (inclusive), in format YYYY-MM (e.g., 2025-06).
schema:
type: string
pattern: ^\d{4}-(0[1-9]|1[0-2])$
title: To Month
- name: cursor
in: query
required: false
schema:
type: string
title: Cursor
description: 'A pagination cursor. When you receive a paginated response containing the property `pagination.next_cursor`, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is no need to specify both the `cursor` and any other filter parameter.
'
- name: limit
in: query
required: false
description: 'In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.
'
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Paginated list of treasury fees
content:
application/json:
schema:
$ref: '#/components/schemas/EncodedPaginatedCollectionResponse_PartnerTreasuryFeesResponse_'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request (e.g., invalid instrument, from_month, or to_month formats)
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/treasury_fees/{fee_id}:
get:
summary: Get Treasury Fee By Id
operationId: get_treasury_fee
tags:
- Treasury Mandates
description: 'Retrieves treasury fee details for the given fee ID belonging to the requesting partner.
'
parameters:
- name: fee_id
in: path
required: true
description: Unique identifier of a treasury fee.
schema:
type: string
title: Fee Identifier
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerTreasuryFeesResponse'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: No treasury fee was found for the given fee_id, owned by the requesting partner.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
/treasury_fees/{fee_id}/customer_fees:
get:
summary: Get Customer Fee Composition for a Treasury Fee
operationId: list_customer_fees
tags:
- Treasury Mandates
description: 'Retrieves a paginated breakdown of individual customer fees that contribute to the given aggregated treasury fee.
'
parameters:
- name: fee_id
in: path
required: true
description: Unique identifier of the partner treasury fee.
schema:
type: string
title: Fee Id
- name: cursor
in: query
required: false
description: 'A pagination cursor. When you receive a paginated response containing the property `pagination.next_cursor`, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is no need to specify both the `cursor` and any other filter parameter.
'
schema:
type: string
title: Cursor
- name: limit
in: query
required: false
description: 'In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.
'
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
- name: LMG-Data-Privacy-Access-Principal
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Principal
- name: LMG-Data-Privacy-Access-Justification
in: header
required: true
schema:
type: string
title: Lmg-Data-Privacy-Access-Justification
responses:
'200':
description: Paginated list of customer fees
content:
application/json:
schema:
$ref: '#/components/schemas/EncodedPaginatedCollectionResponse_CustomerTreasuryFeeResponse_'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Unprocessable Entity
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server Error
components:
schemas:
TreasuryMandateResponse:
properties:
id:
type: string
title: Identifier
description: 'An identifier for the treasury mandate.
'
instrument:
type: string
pattern: ^[A-Z]{2}[0-9A-Z]{9}[0-9]$
title: Instrument
description: 'An ISIN (International Securities Identification Number) according to ISO 6166. This value uniquely identifies the instrument to be bought/sold via the mandate.
'
redirect_success:
type: string
title: Redirect Success
description: 'The redirect target that will be opened after successful acceptance of a mandate.
'
redirect_failure:
type: string
title: Redirect Failure
description: 'The redirect target that will be opened after failure to accept a mandate.
'
history:
items:
$ref: '#/components/schemas/StatusChange_TreasuryMandateStatus_'
type: array
title: History
type: object
required:
- id
- instrument
- redirect_success
- redirect_failure
- history
title: TreasuryMandateResponse
BillingPeriod:
pro
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lemon-markets/refs/heads/main/openapi/lemon-markets-treasury-mandates-api-openapi.yml