1. Endpoints
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
      • Documents
        • Upload document for a counterparty
        • Retrieve all document info attached to a specific counterparty
      • List 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
      • Verify payee details
        POST
    • MSB
      • List subclients
      • Get a subclient by ID
      • Create a new subclient
      • Update a subclient
    • Payments
      • Documents
        • Upload document for a payment
        • Retrieve all document info attached to a specific payment
      • List payments
        GET
      • Make a payment (payout, transfer, or deposit)
        POST
      • Get a payment by ID
        GET
    • Trading
      • Subscribe to quotes
      • Quote order
      • Submit order
    • Wallets
      • List wallets
      • Get a wallet by ID
  • Schemas
    • Reference
      • actions
      • bic_swift
      • country
      • currency
      • entity_key
    • Enums
      • OrderTypes
    • Subclients
      • subclientAddressesModel
      • subclientDetailsModel
      • subclientParentModel
      • subclientAdditionalInformationModel
      • subclientResponseModel
      • subclientRequestModel
      • subclientRegulatorsModel
      • subclientInternalInformationModel
      • subclientRegulatorModel
      • subclientKycModel
      • subclientKycDetailsModel
    • Components
      • AmountModel
      • AmountModelWithRate
      • BaseableAmountModel
      • CorpModel
      • IbanModel
      • TenantInfo
      • WalletModel
      • WalletLedgerModelV5
      • OrderLegAccount
      • PersonModel
    • Response
      • standard-Validation-Failure
    • Payments
      • VoP
        • VopResponseModel
        • VopRequestModel
        • VopForm
      • PaymentForm
      • paymentSourceForm
      • addressModel
      • paymentUpdateForm
    • Responses
      • CorpWalletModelV2
      • FullIdentityResponse
      • IdentityResponse
    • Schemas
    • Trading
      • OrderQuoteForm
    • Documents
    • corpExternalBicModel
    • corpModel
    • corpTagModel
    • ibanModel
    • idDocModel
    • identityModel
    • identityModel-2
    • idServiceModel
    • inviteAcceptForm
    • inviteModel
    • loginFormModel
    • passwordChangeForm
    • passwordResetForm
    • passwordResetRequestForm
    • passwordValidation
    • permissionModel
    • positionsModel
    • roleModel
    • rolesModel
    • statusCodeResult
    • sumsubReviewResultModel
    • sumsubWebhookPayloadModel
    • twofaChallengeStatusModel
    • twoFactorMethod
    • twoFactorMethodForm
    • twoFactorResponseForm
    • twoFactorVerifyModel
    • userCorpModel
    • userCreateForm
    • userEditForm
    • userIdentityDocumentModel
    • userIssueReport
    • userModel
    • userPermissionsModel
    • usersModel
    • validationRule
    • accountInfo
    • accountOwnerModel
    • accountSlim
    • amountModel
    • amountModelWithRate
    • amountSlim
    • baseableAmountModel
    • blotterOptionsBatchModel
    • blotterOptionsModel
    • clientCorpAddressModel
    • commissionChange
    • commissionResponseModel
    • commissionResponseModel-2
    • confirmationDocumentResponseModel
    • contextualIbanModel
    • corpFeesModel
    • corpIdentificationModel
    • corpProfileModel
    • counterpartyAccountControlModel
    • counterpartyAccountModelV2
    • counterpartyAccountOnEntityModelV3
    • counterpartyAddressModel
    • counterpartyModelV2
    • counterpartyOnEntityModelV3
    • counterpartyParentModel
    • currentAccountControlValues
    • currentAccountValuesExtended
    • currentCounterpartyValuesExtended
    • forwardRateModel
    • ibanSlim
    • intermediaryBankAccountModel
    • invoiceableAmountModel
    • leg
    • leg-2
    • leg-3
    • legacyAddressModel
    • marginResponseModel
    • marginResponseModel-2
    • marketInfoResponseModel
    • marketInfoResponseModel-2
    • markToMarketResponseModel
    • markToMarketResponseModel-2
    • orderBookingRequestModel
    • orderPaymentRequestModel
    • orderPaymentResponseModel
    • orderPaymentResponseModel-2
    • orderQuoteForm
    • orderQuoteResponse
    • orderQuoteResponse-2
    • orderRejectForm
    • orderSettlementRequestModel
    • orderSettlementResponseModel
    • orderSettlementResponseModel-2
    • paymentAccountModel
    • paymentAttachmentsResponseModel
    • paymentBlotterItemModelV2
    • paymentCounterpartyAccountModel
    • paymentCounterpartyModel
    • paymentDestinationModel
    • paymentFeesChargeModel
    • paymentFeeSlim
    • paymentFeesModel
    • paymentFeesRequestModel
    • paymentForm
    • paymentItemListModel
    • paymentItemSlimModel
    • paymentListApprovalResponse
    • paymentReferenceModel
    • paymentSouceForm
    • paymentSourceModel
    • paymentTrackingSource
    • paymentVopResponseModel
    • personModel
    • quotePriceModel
    • quotePriceModel-2
    • rateModel
    • rejectForm
    • reversableRateModel
    • settlementInstructionsModel
    • specifiedPaymentFee
    • subscriptionFeesModel
    • swapInfoModel
    • swapInfoModel-2
    • tickPriceModel
    • tickPriceModel-2
    • tickRateModel
    • tradeLimitsModel
    • tradeLimitsModel-2
    • tradingFeesModel
    • ultimateSourceModel
    • vopForm
    • walletModel
    • accountModel
    • chargesInfoModel
    • clientCorpModelV1
    • clientCorpModelV3
    • commissionDetailModel
    • corpAdditionalInformationModel
    • corpAddressesModel
    • corpContractModel
    • corpContractsModel
    • corpDetailsModel
    • corpInternalInformationModel
    • corpIntroducerModel
    • corpKycModel
    • corpLegacyAddressesModel
    • corpLeiModel
    • corpReconciliationModel
    • corpRef
    • corpRegulatorModel
    • corpRegulatorsModel
    • corpWalletModel
    • derivedAccountModel
    • derivedFieldModel
    • document
    • documentModel
    • documentVisibility
    • docVisibility
    • editableVisibility
    • executeResult
    • ledgerOperationAccountModel
    • ledgerOperationCorpModel
    • ledgerOperationModel
    • lEIModel
    • linkedRecordModel
    • marginDetailModel
    • matchedModel
    • minimumCommissionModel
    • mtfRecordApprovalForm
    • mtfRecordDefaultValues
    • mtfRecordModelV4
    • mtfRequirementModel
    • mtfValidationForm
    • namedEntityModel
    • operationModel
    • orderKeyListModel
    • orderModel
    • orderPayment
    • overriddenByModel
    • paymentKeyListModel
    • productStatusModel
    • reconcileFromWalletRequest
    • reconcileLedgerTransactionMatchRequest
    • reconcileUnexpectedCreditRequest
    • regReportModel
    • settlementBatchModelV4
    • settlementBatchModelV5
    • settlementCurrencyModel
    • systemStateModel
    • transaction
    • transactionInfoModelV4
    • walletIbanModel1__CorpWalletModel
    • accountLedgerItemModel
    • accountModel-2
    • accountNetworks
    • approvePreviewLogoForm
    • approvePreviewLogoForm-2
    • archiveReasonModel
    • contactModel
    • corpFrameworkAgreementModel
    • corpIbanModel
    • corpMarginDetailModel
    • corpMarginDetailModel-2
    • corpStateModel
    • corpTag
    • corpWalletModelV2
    • counterpartyAccountModelV3
    • counterpartyAttachmentsResponseModel
    • counterpartyModelV3
    • countryIdentityDocument
    • countryModel
    • createCorpWalletForm
    • currencyModel
    • currentAccountValues
    • currentCounterpartyValues
    • detailsModel
    • detailsModel-2
    • documentArchiveModel
    • editNoteModel
    • externalAccountModel
    • externalAccountUpdateForm
    • ibanCountryDetailModel
    • ibanDefinitionModel
    • ibanLookupForm
    • ibanLookupResult
    • intermediaryBankAccountModel-2
    • latestModificationModel
    • marginLineModel
    • networkAvailability
    • noteModel
    • notificationListModel
    • notificationModel
    • orderInfoV2
    • ownerModel
    • priceAlertModel
    • rejectReasonModel
    • reviewerUserModel
    • reviewInfoModel
    • subClientAdditonalAdditionalInformationModel
    • subClientAdditonalAdditionalInformationModel-2
    • subClientAddressesModel
    • subClientAddressesModel-2
    • subClientCorpModel
    • subClientDetailsModel
    • subClientDetailsModel-2
    • subClientInternalInformationModel
    • subClientInternalInformationModel-2
    • subClientKycModel
    • subClientKycModel-2
    • subClientParentModel
    • subClientParentModel-2
    • subClientRegulatorModel
    • subClientRegulatorModel-2
    • subClientRegulatorsModel
    • subClientRegulatorsModel-2
    • subClientRequestModel
    • subClientResponseModel
    • subClientReviewRequestModel
    • suspendReasonModel
    • symbolModel
    • tempPaymentBlotterItemModelV2
    • totalModel
    • vopRequestModel
    • vopResponseModel
    • walletIbanModel1__CorpWalletModelV2
    • walletLedgerCounterpartyModel
    • walletLedgerLimitedCounterparty
    • walletLedgerModelV5
    • symbolTenor
    • uploadRestrictionReferenceModel
  1. Endpoints

Payments

Overview#

Payout (debit), internal transfer, planned deposit (credit) use the same endpoint.
The difference between each payment type is determined by the types of the accounts on each side:
Origin \ BeneficiaryWalletCounterparty account
WalletTransferPayout
Counterparty accountPlanned depositNot possible
This document covers the simplest way to achieve each, with some optional properties covered at the end.

Pre-requisites#

You must already have at least 1 wallet in the payment currency, for sending or receiving the payment
You will need the 22-character "account keys" for the origin (sender) and the beneficiary (receiver) accounts
Wallet account keys are shown as id on the wallets endpoints
Counterparty account keys are shown as bankAccountId on each account on a counterparty

Examples#

Payout#

{
  "currencyCode": "AAA", // The payment currency (ISO 3-character code)
  "amount": 0.00, // The withdrawal amount; must be >0
  "originAccountKey": "abcdefghijkl0123456789", // Source wallet (for debit)
  "beneficiaryAccountKey": "abcdefghijkl0123456789" // Destination counterparty account
}
If currencyCode is EUR and the beneficiary is in the "SEPA zone", the payment verification process must be completed and the verification result included in the payout request:
{
  ...
  "verification": {
    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
    "acceptWarning": true // Only include if the request was not a full match
  }
}

Internal transfer#

{
  "currencyCode": "AAA", // The payment currency (ISO 3-character code)
  "amount": 0.00, // The transfer amount; must be >0
  "originAccountKey": "abcdefghijkl0123456789", // Source wallet (for debit)
  "beneficiaryAccountKey": "abcdefghijkl0123456789" // Destination wallet (for credit)
}

Planned deposit#

{
  "currencyCode": "AAA", // The payment currency (ISO 3-character code)
  "amount": 0.00, // The expected deposit amount; must be >0
  "originAccountKey": "abcdefghijkl0123456789", // Expected 
  "beneficiaryAccountKey": "abcdefghijkl0123456789" // Destination wallet (for credit)
}

Additional properties#

This is an incomplete list of optional properties that are often valuable.

correlationId#

A unique ID for correlating with internal systems. Must be unique for the tenant or a 409 Conflict response will be given.
Example:
{
  ...
  "correlationId": "our-system-id"
}

paymentNetwork#

Generally should not be provided as the platform will choose the best network for your payout, including direct "Neo" transfers.
If you wish to force SWIFT payment where an undesirable SEPA is possible, specify the property as swift.
Example:
{
  ...
  "paymentNetwork": "swift"
}

paymentReference#

Optional reference to apply to the payment, as sent to the beneficiary.
If not used, the automatic "vanity ID" will be used as the reference.
Example:
{
  ...
  "paymentReference": "our reference"
}

type#

For additional validation on each request, the type can be set to payout, deposit, or internalTransfer, to enforce that the correct types of accounts are provided.
Example:
{
  ...
  "type": "payout"
}
Modified at 2026-08-27 09:34:52
Previous
Update a subclient
Next
Upload document for a payment
Built with