getneo
  1. Technical topics
getneo
  • Introduction
  • API examples
  • Technical topics
    • API structure
    • HTTP headers
    • Decoupled responses
    • Validation failures (418)
  • Endpoints
    • Auth
      • Get service bearer token (password)
        GET
      • Change tenant
        GET
      • Close session
        GET
    • Counterparties
      • Get all counterparties
        GET
      • Get counterparty by ID
        GET
      • Get draft counterparty by ID
        GET
      • Submit counterparty draft
        POST
      • Update counterparty draft
        POST
      • Delete a counterparty draft
        DELETE
      • Add account to counterparty
        POST
      • Update counterparty account
        PATCH
      • Export counterparty data
        POST
    • Payments
      • Get all payments
        GET
      • Get a payment by ID
        GET
      • Make a payment (deposit, withdrawal or internal)
        POST
    • Trading
      • Quote order
      • Submit order
    • Wallets
      • Get all wallets
      • Get a wallet by ID
  • Schemas
    • Schemas
      • Components
        • AmountModel
        • AmountModelWithRate
        • BaseableAmountModel
        • CorpModel
        • IbanModel
        • TenantInfo
        • WalletModel
        • WalletLedgerModelV5
        • OrderLegAccount
      • Enums
        • OrderTypes
      • Reference
        • actions
        • bic_swift
        • country
        • currency
        • entity_key
      • Responses
        • CorpWalletModelV2
        • FullIdentityResponse
        • IdentityResponse
      • Forms
        • OrderQuoteForm
      • counterpartyAccountModelV3
      • ibanSlim
      • accountInfo
      • counterpartyAttachmentsResponseModel
      • accountOwnerModel
      • counterpartyModelV3
      • accountSlim
      • intermediaryBankAccountModel
      • addressModel
      • amountSlim
      • commissionResponseModel
      • confirmationDocumentResponseModel
      • counterpartyAccountModelV2
      • counterpartyModelV2
      • forwardRateModel
      • invoiceableAmountModel
      • leg
      • marginResponseModel
      • marketInfoResponseModel
      • markToMarketResponseModel
      • orderPaymentResponseModel
      • orderQuoteResponse
      • orderSettlementResponseModel
      • paymentAccountModel
      • paymentAttachmentsResponseModel
      • paymentBlotterItemModelV2
      • paymentCounterpartyAccountModel
      • paymentCounterpartyModel
      • paymentDestinationModel
      • paymentFeesChargeModel
      • paymentFeeSlim
      • paymentForm
      • paymentItemSlimModel
      • paymentSourceForm
      • paymentSourceModel
      • paymentTrackingSource
      • personModel
      • quotePriceModel
      • rateModel
      • rejectForm
      • reversableRateModel
      • settlementInstructionsModel
      • specifiedPaymentFee
      • swapInfoModel
      • tickPriceModel
      • tickRateModel
      • tradeLimitsModel
    • Response
      • standard-Validation-Failure
  1. Technical topics

API structure

API structure#

The platform uses multiple services, for segregating business purpose as well as distribution of requests.

Endpoint versioning#

All API requests are made to endpoints in the format VERB /v#/(controller)/(action+args), where the version number is used to control breaking changes to the request or response structure.
For simplicity, unless a specific endpoint version is required, the documentation refers only to VERB controller/action.
Example
The endpoints GET /v1/user/corps and GET /v2/user/corps would be referred to as GET user/corps, unless the version change was significant to the functionality.

Deprecation#

Deprecated endpoints will be marked as Deprecated with a solution (such as, "use version X instead"). Responses from deprecated endpoints will include a Warning header with value 299.
Example
Request: GET /example
Response:
200 OK
...
Warning: 299 - "Deprecated API action (use v2)"
Modified at 2025-11-28 09:24:49
Previous
API examples
Next
HTTP headers
Built with