API reference

Every operation is an API call. 1121 of them, in 146 groups, rendered from the server's OpenAPI 3.1.1 description on every deploy. That's enough to size an integration, and the full description with schemas comes with the evaluation.

1121

operations

1730

request and response types

146

resource groups, by first path segment

What you're looking at.

The interface you see in the screenshots is built on these same calls: the interface's own types are generated from this description, so a changed endpoint fails the build before it can fail a user. Operations are listed as the server publishes them, by method and path, with the request and response types named. We haven't written prose for each operation yet, so for now the names are the documentation, and they're in the engine's own vocabulary. Endpoints built for one client's integration and the development-only endpoints are left out.

Every call is authenticated through the gateway, checked against a permission per operation, and scoped to the tenant of the session. The largest groups: accounting, accounts, admin, cards, collections, compliance, correspondence, counterparties, external-accounts, operating-entities, settings, virtual-accounts.

Operations by group
access-audit2
MethodPathRequestResponse
POST/api/access-audit/session-endedRecordAccessSessionEndedCommand—
POST/api/access-audit/session-startedRecordAccessSessionStartedRequest—
account-role-types1
MethodPathRequestResponse
GET/api/account-role-types——
account-types13
MethodPathRequestResponse
GET/api/account-typescounterpartyId——
POST/api/account-typesCreateAccountType—
GET/api/account-types/reference—AccountTypeReferenceIndex
POST/api/account-types/yaml——
GET/api/account-types/{id}——
GET/api/account-types/{id}/nomination-directions——
GET/api/account-types/{id}/opening-steps——
GET/api/account-types/{id}/product-definition——
PUT/api/account-types/{name}/instalment-typeInstalmentType—
DELETE/api/account-types/{name}/instalment-type——
GET/api/account-types/{name}/layout——
GET/api/account-types/{name}/reach——
GET/api/account-types/{name}/reference——
account-views3
MethodPathRequestResponse
GET/api/account-views—AccountViewDto[]
POST/api/account-viewsSaveAccountView—
POST/api/account-views/publicPublishAccountView—
accounting30
MethodPathRequestResponse
POST/api/accounting/account-ledgers/openRegisterAccountRequest—
GET/api/accounting/account-ledgers/{accountId}/balances—GetLedgerBalancesForAccountResponse
GET/api/accounting/account-ledgers/{accountId}/entriespageSizeoffsetcursorsortdescendingsearchfromDatetoDatecostCentre—ListSubLedgerEntriesResponse
GET/api/accounting/account-ledgers/{accountId}/entries/exportsearchfromDatetoDatecostCentre——
GET/api/accounting/account-ledgers/{accountId}/movementglAccountfromtopageSizeoffsetcursor—GetAccountGlAccountMovementResponse
GET/api/accounting/account-ledgers/{accountId}/movement/exportglAccountfromto——
GET/api/accounting/account-types/{accountType}/expects-books—AccountTypeBooksExpectation
GET/api/accounting/exportsfromtofileType—ExportArtefactDescriptor[]
GET/api/accounting/exports/{id}/download——
POST/api/accounting/inbound-files/uploadUploadInboundFileCommandUploadInboundFileResponse
GET/api/accounting/operating-entity-ledgers/{counterpartyId}/balancescostCentre—GetLedgerBalancesForOperatingEntityResponse
GET/api/accounting/operating-entity-ledgers/{counterpartyId}/entriespageSizeoffsetcursorsortdescendingsearchfromDatetoDatecostCentre—ListSubLedgerEntriesResponse
GET/api/accounting/operating-entity-ledgers/{counterpartyId}/entries/exportsearchfromDatetoDatecostCentre——
POST/api/accounting/operating-entity-ledgers/{counterpartyId}/exportExportJournalEntriesRequestExportJournalEntriesResponse
GET/api/accounting/operating-entity-ledgers/{counterpartyId}/movementglAccountfromtocostCentrepageSizeoffsetcursor—GetOperatingEntityGlAccountMovementResponse
GET/api/accounting/operating-entity-ledgers/{counterpartyId}/movement/exportglAccountfromtocostCentre——
POST/api/accounting/operating-entity-ledgers/{counterpartyId}/run-fx-revaluationRunDailyFxRevaluationRequest—
GET/api/accounting/posting-groupsaccountType—ListPostingGroupsByAccountTypeResponse
GET/api/accounting/release-facts—LedgerReleaseFacts
GET/api/accounting/settings/fx-revaluations——
GET/api/accounting/settings/fx-revaluations/all——
GET/api/accounting/settings/ledger-accounts——
GET/api/accounting/settings/ledger-accounts/all——
GET/api/accounting/settings/posting-groups——
GET/api/accounting/settings/posting-groups/all——
GET/api/accounting/settings/posting-groups/by-account-type/{accountType}——
GET/api/accounting/settings/posting-rules——
GET/api/accounting/settings/posting-rules/all——
GET/api/accounting/settings/posting-rules/selectable-transaction-types/{postingGroupId}—SelectableTransactionType[]
GET/api/accounting/settings/posting-rules/undeclared—UndeclaredRuleRow[]
accounts88
MethodPathRequestResponse
GET/api/accountscounterpartyIdstructureIdconveyancerIddealerIdawaitingFundingoperatingEntityIdorganisationalUnitIdincludeDescendantscostCentreIdaccountTypesproductsstatusmaturityFrommaturityTobalanceGroupbalanceMinbalanceMaxsearchsortBysortDirnextPaymentFromnextPaymentToscheduledFlowFromscheduledFlowToscheduledFlowCurrencypagepageSize——
POST/api/accountsCreateAccountRequest—
GET/api/accounts/behind—AccountsBehindResult
GET/api/accounts/blocked-collections—BlockedCollectionDto[]
POST/api/accounts/catch-upCatchUpAccountsRequest—
GET/api/accounts/draft-reachaggregateTypeid——
GET/api/accounts/eligible-transfer-targetscounterpartyIdcurrencyIdoperatingEntityIdexcludeAccountIdallowedAccountTypes—EligibleTransferTargetDto[]
GET/api/accounts/exportoperatingEntityIdaccountTypesproductsstatusmaturityFrommaturityTobalanceGroupbalanceMinbalanceMaxsearchsortBysortDirawaitingFundingscheduledFlowFromscheduledFlowToscheduledFlowCurrency——
POST/api/accounts/migration/backfill-rate-pricing—BackfillRatePricingResponse
POST/api/accounts/preview-instalmentCreateAccountRequest—
GET/api/accounts/provisionsoperatingEntityIdaccountTypeId——
GET/api/accounts/regulatory-limit-advisories/{listId}asOf—RegulatoryLimitAdvisoryReport
GET/api/accounts/release-facts—AccountReleaseFacts
GET/api/accounts/settings/term-sets——
GET/api/accounts/settings/term-sets/all——
GET/api/accounts/settings/term-types——
GET/api/accounts/settings/term-types/all——
POST/api/accounts/suspense/allocateAllocateSuspenseItemRequest—
POST/api/accounts/suspense/unallocateUnallocateSuspenseItemCommand—
PUT/api/accounts/{accountId}CreateAccountRequest—
DELETE/api/accounts/{accountId}——
POST/api/accounts/{accountId}/abandon-claimAbandonClaimRequest—
POST/api/accounts/{accountId}/acknowledge-debtAcknowledgeDebtRequest—
POST/api/accounts/{accountId}/activate——
GET/api/accounts/{accountId}/authorisation-history—AuthorisationQueueReadModel[]
POST/api/accounts/{accountId}/booksOpenAccountBooksRequest—
POST/api/accounts/{accountId}/cancel——
POST/api/accounts/{accountId}/change-productChangeAccountProductRequest—
POST/api/accounts/{accountId}/cost-centreMoveAccountToCostCentreRequest—
POST/api/accounts/{accountId}/cost-centre/cancel——
POST/api/accounts/{accountId}/debit-order-replacement-previewDebitOrderReplacementPreviewRequestDebitOrderReplacementPreview
POST/api/accounts/{accountId}/discard-draft——
POST/api/accounts/{accountId}/financial-change/consequencesFinancialConsequencesRequest—
POST/api/accounts/{accountId}/forecastForecastRequest—
GET/api/accounts/{accountId}/in-duplum—InDuplumStandingDto
PUT/api/accounts/{accountId}/instalment-planInstalmentPlanSnapshot—
GET/api/accounts/{accountId}/limit-usagecounterpartyId—AccountLimitUsageDto
GET/api/accounts/{accountId}/notices—NoticeDto[]
GET/api/accounts/{accountId}/operationspermittedOnly——
POST/api/accounts/{accountId}/operations/{operationName}/executeExecuteOperationRequest—
POST/api/accounts/{accountId}/operations/{operationName}/previewOperationPreviewRequest—
GET/api/accounts/{accountId}/product-change-options—ProductChangeOption[]
POST/api/accounts/{accountId}/property-entries/amendAmendScheduledPropertyChangeRequest—
POST/api/accounts/{accountId}/property-entries/cancelCancelScheduledPropertyChangeRequest—
POST/api/accounts/{accountId}/property-entries/correctCorrectPropertyEntryRequest—
PUT/api/accounts/{accountId}/provision/assessmentAssessProvisionRequest—
DELETE/api/accounts/{accountId}/provision/assessmentvalueDate——
PUT/api/accounts/{accountId}/provision/stage-pinPinProvisionStageRequest—
DELETE/api/accounts/{accountId}/provision/stage-pinvalueDate——
GET/api/accounts/{accountId}/rail-fee-quoteexternalAccountIdamount—RailFeeQuoteResponse
POST/api/accounts/{accountId}/restate-schedulesRestateAccountSchedulesRequest—
GET/api/accounts/{accountId}/roles——
POST/api/accounts/{accountId}/rolesJsonElement—
DELETE/api/accounts/{accountId}/roles/{roleId}effectiveTo——
POST/api/accounts/{accountId}/roles/{roleId}/replace-owning-partyReplaceOwningPartyRequest—
POST/api/accounts/{accountId}/rulesInstantiateAccountRuleRequest—
POST/api/accounts/{accountId}/rules/endEndAccountRuleRequest—
POST/api/accounts/{accountId}/rules/properties/amendAmendAccountRulePropertyRequest—
POST/api/accounts/{accountId}/sandbox/draft-forecastDraftForecastRequest—
POST/api/accounts/{accountId}/sandbox/forecastSandboxForecastRequest—
POST/api/accounts/{accountId}/sandbox/instalment-previewSandboxPreviewRequest—
POST/api/accounts/{accountId}/sandbox/previewSandboxPreviewRequest—
GET/api/accounts/{accountId}/settlement-quotes—SettlementQuoteDto[]
GET/api/accounts/{accountId}/statements—StatementDto[]
POST/api/accounts/{accountId}/statements/ad-hocIssueAdHocStatementRequest—
GET/api/accounts/{accountId}/statements/camt053fromto——
POST/api/accounts/{accountId}/studio/stageStageAccountOperationCommand—
POST/api/accounts/{accountId}/studio/stage-planStageRevisedPlanCommandStageAccountOperationResponse
GET/api/accounts/{accountId}/transactionspageSizeoffsetcursorsortdescendingsearchfromto—PageOfTransactionHistoryView
POST/api/accounts/{accountId}/transactionsPostTransactionRequest—
GET/api/accounts/{accountId}/transactions/exportsearchfromto——
POST/api/accounts/{accountId}/transactions/{transactionId}/move-to-suspenseMoveTransactionToSuspenseRequest—
POST/api/accounts/{accountId}/transactions/{transactionId}/reverse——
POST/api/accounts/{accountId}/unwind-settlement——
GET/api/accounts/{accountId}/views—AccountViewsOnOffer
POST/api/accounts/{accountId}/write-offWriteOffAccountRequest—
GET/api/accounts/{id}——
GET/api/accounts/{id}/detail—AccountDetailDto
GET/api/accounts/{id}/financial-summary——
POST/api/accounts/{id}/instrument-redemptionsRecordInstrumentRedemptionCommand—
GET/api/accounts/{id}/projected-cash-flow-schedule——
POST/api/accounts/{id}/projected-cash-flow-schedule/refresh——
GET/api/accounts/{id}/provision——
GET/api/accounts/{id}/salvage——
POST/api/accounts/{id}/servicing-designationMoveServicingDesignationRequest—
POST/api/accounts/{id}/servicing-unitMoveAccountToOrganisationalUnitRequest—
POST/api/accounts/{id}/servicing-unit/cancelCancelAccountTransferRequest—
GET/api/accounts/{id}/write-off-preview——
acquiring15
MethodPathRequestResponse
GET/api/acquiring/feed-batchesfromtoagreement—AcquiringFeedBatch[]
POST/api/acquiring/feed-batches/{batch}/lines/{reference}/holdHoldStrandedFeedLineRequest—
POST/api/acquiring/feed-batches/{batch}/lines/{reference}/releaseReleaseSponsorMismatchLineRequest—
GET/api/acquiring/feed-batches/{id}——
GET/api/acquiring/scheme-settlement—SchemeSettlementSettings
GET/api/acquiring/scheme-settlement/accountsoperatingEntity—SchemeSettlementAccountRow[]
POST/api/acquiring/scheme-settlement/electElectSchemeSettlementCurrencyCommand—
POST/api/acquiring/scheme-settlement/nostroSetSchemeSettlementNostroCommand—
GET/api/acquiring/scheme-settlement/positionoperatingEntitysponsorschemecurrencysettlementDate—SchemeSettlementPosition
POST/api/acquiring/scheme-settlement/sponsor-rulesSetSponsorRulesCommand—
POST/api/acquiring/scheme-settlement/sponsorsAddSponsorCommand—
POST/api/acquiring/scheme-settlement/sponsors/{sponsor}/identifiersSetSchemeAcquirerIdentifiersRequest—
POST/api/acquiring/scheme-settlement/sponsors/{sponsor}/paying-accountsSetSponsorPayingAccountCommand—
POST/api/acquiring/scheme-settlement/sponsors/{sponsor}/remove——
POST/api/acquiring/scheme-settlement/withdrawWithdrawSchemeSettlementCurrencyCommand—
address-search3
MethodPathRequestResponse
GET/api/address-search/detailsplaceIdsessionToken——
GET/api/address-search/status——
GET/api/address-search/suggestqsessionToken——
admin41
MethodPathRequestResponse
GET/api/admin/ceiling-breachesfromto—CeilingBreachRow[]
GET/api/admin/grant-ceilings/ceilablekeys—string[]
POST/api/admin/grant-ceilings/removeRemoveGrantCeilingCommand—
POST/api/admin/grant-ceilings/setSetGrantCeilingCommand—
GET/api/admin/machine-principals—MachinePrincipalRow[]
POST/api/admin/machine-principalsRegisterMachinePrincipalRequestMachinePrincipalRow
POST/api/admin/machine-principals/agentsRegisterAgentPrincipalRequestMachinePrincipalRow
GET/api/admin/machine-principals/attemptsfromtoclientId—MachineResolutionAttempt[]
POST/api/admin/machine-principals/{id}/rate-limitChangeMachinePrincipalRateLimit—
POST/api/admin/machine-principals/{id}/revoke——
GET/api/admin/permissions—ListPermissionsResponse
GET/api/admin/sign-in-attemptsfromtoemail—SignInAttempt[]
GET/api/admin/tenants——
GET/api/admin/tenants/catalog——
POST/api/admin/tenants/composition/previewCompositionRequest—
GET/api/admin/tenants/layers——
POST/api/admin/tenants/provisionProvisionTenantRequest—
DELETE/api/admin/tenants/{slug}purge——
GET/api/admin/tenants/{slug}/export——
GET/api/admin/tenants/{slug}/provision-status——
POST/api/admin/tenants/{slug}/settings/{className}/apply——
POST/api/admin/tenants/{slug}/settings/{className}/reseed——
GET/api/admin/tenants/{slug}/settings/{className}/yaml——
GET/api/admin/user-groups—ListUserGroupsResponse
POST/api/admin/user-groupsCreateUserGroupCommand—
POST/api/admin/user-groups/grant-matchingGrantPermissionsMatchingCommand—
POST/api/admin/user-groups/grant-permissionGrantPermissionToGroupCommand—
POST/api/admin/user-groups/renameRenameUserGroupCommand—
POST/api/admin/user-groups/revoke-permissionRevokePermissionFromGroupCommand—
GET/api/admin/user-groups/{groupId}/ceilings—GroupActionCeiling[]
GET/api/admin/users—ListUsersResponse
POST/api/admin/users/admissibleListAdmissibleUsersQueryListAdmissibleUsersResponse
POST/api/admin/users/admitAdmitUserToTenantCommand—
POST/api/admin/users/assign-to-groupAssignUserToGroupCommand—
POST/api/admin/users/deactivateDeactivateMemberCommand—
POST/api/admin/users/remove-from-groupRemoveUserFromGroupCommand—
GET/api/admin/users/{id}/history——
POST/api/admin/users/{memberId}/photoSetMemberPhotoCommand—
DELETE/api/admin/users/{memberId}/photo——
POST/api/admin/users/{memberId}/profileUpdateMemberProfileCommand—
GET/api/admin/users/{userId}/effective-ceilings—EffectiveCeiling[]
alerts4
MethodPathRequestResponse
GET/api/alertsaggregateIdpageSizeoffsetcursorsortdescendingsearch—PageOfAlertDto
POST/api/alerts/createCreateAlertCommand—
POST/api/alerts/deleteDeleteAlertCommand—
POST/api/alerts/updateUpdateAlertCommand—
approver-credentials5
MethodPathRequestResponse
GET/api/approver-credentials—ApproverCredentialSummary[]
POST/api/approver-credentialsCompleteApproverCredentialEnrolmentRequestApproverCredentialSummary
POST/api/approver-credentials/registration-options—ApproverCredentialRegistrationOptionsResponse
POST/api/approver-credentials/{id}/push-subscriptionRegisterPushSubscriptionRequest—
POST/api/approver-credentials/{id}/revoke——
assistant6
MethodPathRequestResponse
POST/api/assistant/askAskAssistantRequest—
GET/api/assistant/conversations—AssistantConversationSummary[]
GET/api/assistant/conversations/reviewfromtobyUsersource—AssistantConversationSummary[]
GET/api/assistant/conversations/{id}—AssistantConversation
GET/api/assistant/tools—AssistantToolSummary[]
GET/api/assistant/turns/{turn}—AssistantTurnRecord
attachments4
MethodPathRequestResponse
GET/api/attachmentsaggregateIdpageSizeoffsetcursorsortdescendingsearch—PageOfAttachmentDto
POST/api/attachments/createCreateAttachmentCommand—
POST/api/attachments/deleteDeleteAttachmentCommand—
POST/api/attachments/updateUpdateAttachmentCommand—
audit7
MethodPathRequestResponse
POST/api/audit/revaluation-parity/runRunRevaluationParityRequestRevaluationParityRunSummaryDto
GET/api/audit/revaluation-parity/runslimit—RevaluationParityRunSummaryDto[]
GET/api/audit/revaluation-parity/runs/{id}—RevaluationParityRunDetailDto
POST/api/audit/run—AuditRunDetailDto
GET/api/audit/runslimit—AuditRunSummaryDto[]
GET/api/audit/runs/latest——
GET/api/audit/runs/{id}——
auth3
MethodPathRequestResponse
POST/api/auth/resolve——
POST/api/auth/resolve-machine—MachineResolutionResult
POST/api/auth/sign-in-attempt——
authorisation3
MethodPathRequestResponse
GET/api/authorisation/actions/pickable—ListPickableActionsResponse
GET/api/authorisation/approval-rules—ApprovalRule[]
GET/api/authorisation/approval-rules/all—ApprovalRule[]
authorisations13
MethodPathRequestResponse
GET/api/authorisationspageSizeoffsetcursorsortdescendingsearchstatusaggregateTyperequestedByminetargetId—PageOfAuthorisationQueueReadModel
GET/api/authorisations/{id}——
POST/api/authorisations/{id}/approve——
GET/api/authorisations/{id}/decisions/{sequence}/verify—VerifySignedDecisionResponse
GET/api/authorisations/{id}/feasibility——
POST/api/authorisations/{id}/force-resolveForceResolveRequest—
GET/api/authorisations/{id}/quorum-drivers——
POST/api/authorisations/{id}/rejectRejectAuthorisationRequest—
POST/api/authorisations/{id}/retract-approval——
POST/api/authorisations/{id}/signed-challengeSignedChallengeRequestSignedChallengeResponse
POST/api/authorisations/{id}/signed-decisionSubmitSignedDecisionRequest—
GET/api/authorisations/{id}/timeline—AuthorisationTimelineEntry[]
POST/api/authorisations/{id}/withdraw——
balance-groups2
MethodPathRequestResponse
GET/api/balance-groups——
GET/api/balance-groups/ungrouped-positions——
bank-deposits8
MethodPathRequestResponse
GET/api/bank-depositsaccountIdpageSizeoffsetcursorsortdescendingsearch—PageOfBankDepositDto
POST/api/bank-deposits/depositBankDepositCommand—
POST/api/bank-deposits/matchMatchDepositCommand—
GET/api/bank-deposits/matching-rulesaccountId—MatchingRuleDto[]
POST/api/bank-deposits/matching-rules/createCreateMatchingRuleCommand—
POST/api/bank-deposits/matching-rules/deleteDeleteMatchingRuleCommand—
POST/api/bank-deposits/matching-rules/editEditMatchingRuleCommand—
GET/api/bank-deposits/operating-entityoperatingEntityIdpageIndexpageSizeexternalAccountId—ListOperatingEntityBankDepositsResponse
bank-statements17
MethodPathRequestResponse
GET/api/bank-statementsexternalAccountIdpageSizeoffsetcursorsortdescendingsearch—PageOfBankStatementDto
GET/api/bank-statements/daysexternalAccountIdpageSizeoffset—PageOfStatementDayDto
POST/api/bank-statements/deliveriesStatementDeliveryStatementPushResult
GET/api/bank-statements/external-accounts/{externalAccountId}/business-date-exceptions—BusinessDateException[]
GET/api/bank-statements/external-accounts/{externalAccountId}/provisional-position—ProvisionalPosition
GET/api/bank-statements/external-accounts/{externalAccountId}/sequence-gaps—StatementSequenceGap[]
GET/api/bank-statements/external-accounts/{id}/auto-park—ExternalAccountAutoParkPolicyView
GET/api/bank-statements/external-accounts/{id}/intraday-feed—View
POST/api/bank-statements/importImportStatementCommandStatementImportResult
GET/api/bank-statements/journeystatementLineIdopenItemIdaccountTransactionId—ReceiptJourneyNode
GET/api/bank-statements/matchingexternalAccountIdstatuspageSizeoffsetcursorsortdescending—PageOfMatchDto
POST/api/bank-statements/matching/confirmConfirmMatchCommand—
POST/api/bank-statements/matching/match-to-depositMatchLineToDepositCommand—
POST/api/bank-statements/matching/park-to-suspenseParkLineToSuspenseCommand—
POST/api/bank-statements/matching/rejectRejectMatchCommand—
POST/api/bank-statements/matching/runRunMatchingCommand—
GET/api/bank-statements/{id}—GetStatementResponse
banks2
MethodPathRequestResponse
GET/api/banks——
GET/api/banks/all——
batch1
MethodPathRequestResponse
POST/api/batch/day-endProcessDayEndRequest—
batch-ops3
MethodPathRequestResponse
POST/api/batch-ops/data-initDataInitRequest—
GET/api/batch-ops/data-init/available-deals——
GET/api/batch-ops/data-init/available-types——
batches2
MethodPathRequestResponse
GET/api/batchesstatusbatchTypepageSizeoffsetcursorsortdescendinggroupBy—PageOfBatchRecord
GET/api/batches/{id}—BatchDetailResponse
card-disputes6
MethodPathRequestResponse
POST/api/card-disputesRaiseCardDisputeCommand—
GET/api/card-disputes/{id}——
POST/api/card-disputes/{id}/concedeConcedeCardDisputeCommand—
POST/api/card-disputes/{id}/escalateEscalateCardDisputeCommand—
POST/api/card-disputes/{id}/evidenceRecordCardDisputeEvidenceCommand—
POST/api/card-disputes/{id}/withdrawWithdrawCardDisputeCommand—
cards32
MethodPathRequestResponse
POST/api/cardsIssueCardCommand—
POST/api/cards/authorisations/decideJsonElement—
POST/api/cards/authorisations/reverseJsonElementCardReversalReceipt
GET/api/cards/clearingfromto—CardClearingBatchRow[]
POST/api/cards/disputes/updateJsonElementCardDisputeUpdateReceipt
GET/api/cards/receiptsfromto—CardProcessorReceiptRow[]
POST/api/cards/simulation/authoriseSimulateCardAuthorisationCommand—
POST/api/cards/simulation/provision-tokenSimulateCardTokenProvisioningCommand—
POST/api/cards/simulation/refundSimulateCardRefundCommand—
POST/api/cards/simulation/reverseSimulateCardAuthorisationReversalCommand—
POST/api/cards/tokens/decideJsonElement—
GET/api/cards/{id}—CardSummary
POST/api/cards/{id}/activateActivateCardCommand—
GET/api/cards/{id}/authorisationspageSizeoffsetcursorsortdescending——
GET/api/cards/{id}/available-to-spend——
POST/api/cards/{id}/closeCloseCardCommand—
POST/api/cards/{id}/controlsSetCardControlsCommand—
POST/api/cards/{id}/credentials/removeRemoveCardCredentialCommand—
GET/api/cards/{id}/disputes——
POST/api/cards/{id}/funding-ruleSetCardFundingRuleCommand—
GET/api/cards/{id}/holdspageSizeoffsetcursorsortdescending——
GET/api/cards/{id}/limit-use——
GET/api/cards/{id}/operationspermittedOnly——
GET/api/cards/{id}/postingspageSize——
POST/api/cards/{id}/reinstateReinstateCardCommand—
POST/api/cards/{id}/reissueReissueCardCommand—
POST/api/cards/{id}/renameRenameCardCommand—
POST/api/cards/{id}/report-lost-or-stolenReportCardLostOrStolenCommand—
POST/api/cards/{id}/revealRevealCardCommand—
POST/api/cards/{id}/suspendSuspendCardCommand—
POST/api/cards/{id}/travel-windowSetCardTravelWindowCommand—
POST/api/cards/{id}/valid-untilSetCardValidUntilCommand—
cashier16
MethodPathRequestResponse
GET/api/cashier/accountsbranchId—CashierAccountSummary[]
POST/api/cashier/depositDepositCommand—
GET/api/cashier/differencesbranchIdfromto—TellerDifference[]
POST/api/cashier/drawsDrawCashCommandDrawCashResponse
POST/api/cashier/lodgementsLodgeCashCommandLodgeCashResponse
GET/api/cashier/lodgements/{id}—LodgementReadModel
POST/api/cashier/sessions/closeCloseSessionCommandCloseSessionResponse
POST/api/cashier/sessions/correct-countCorrectCountCommand—
GET/api/cashier/sessions/mine—MySession
POST/api/cashier/sessions/openOpenSessionCommandOpenSessionResponse
GET/api/cashier/settings/tills—TillRow[]
GET/api/cashier/settings/tills/all—TillRow[]
GET/api/cashier/transactionsaccountIdpageSizeoffsetcursorsortdescendingsearch—PageOfCashTransactionDto
GET/api/cashier/transactions/exportaccountIdsearch——
POST/api/cashier/transfersTransferCashCommandTransferCashResponse
POST/api/cashier/withdrawWithdrawCommand—
change-sets5
MethodPathRequestResponse
GET/api/change-sets/openaggregateTypeid—OpenChangeSetView
POST/api/change-sets/openOpenChangeSetCommandChangeSetId
POST/api/change-sets/{id}/changes/{position}/unstageUnstageChangeCommand—
POST/api/change-sets/{id}/discard——
POST/api/change-sets/{id}/submit——
channel-participants1
MethodPathRequestResponse
GET/api/channel-participants—ChannelParticipantView[]
channel-service-agreements7
MethodPathRequestResponse
POST/api/channel-service-agreementsRecordChannelServiceAgreementCommandChannelServiceAgreementId
POST/api/channel-service-agreements/amend-accountsAmendChannelServiceAgreementAccountsCommand—
POST/api/channel-service-agreements/officers/recordRecordSigningOfficerCommand—
POST/api/channel-service-agreements/officers/withdrawWithdrawSigningOfficerCommand—
POST/api/channel-service-agreements/renameRenameChannelServiceAgreementCommand—
POST/api/channel-service-agreements/signature-countSetRequiredSignatureCountCommand—
GET/api/channel-service-agreements/{agreement}—ChannelServiceAgreementDetail
channel-users4
MethodPathRequestResponse
POST/api/channel-usersRegisterChannelUserCommandChannelUserId
POST/api/channel-users/person-linkLinkChannelUserToPersonCommand—
POST/api/channel-users/register-by-bankRegisterChannelUserByBankCommandChannelUserId
POST/api/channel-users/restore-accessRestoreChannelAccessCommandChannelUserId
charge-periods2
MethodPathRequestResponse
GET/api/charge-periods/months/{month}pageSizeoffsetcursorsortdescendinggroupBy—PageOfChargePeriodSummary
GET/api/charge-periods/{period}—ChargePeriodDetail
client-identities8
MethodPathRequestResponse
POST/api/client-identities/disableDisableClientIdentityCommand—
POST/api/client-identities/enableEnableClientIdentityCommand—
POST/api/client-identities/inviteInviteClientUserCommandClientIdentityId
POST/api/client-identities/listListClientIdentitiesQueryClientIdentityView[]
POST/api/client-identities/resendResendClientInvitationCommand—
POST/api/client-identities/reset-sign-inResetClientSignInCommand—
POST/api/client-identities/retry-setupRetryClientDirectorySetupCommand—
POST/api/client-identities/withdrawWithdrawClientInvitationCommand—
collateral5
MethodPathRequestResponse
GET/api/collateralownerId—CollateralSummary[]
POST/api/collateral/manual-valuationRecordManualValuationCommand—
POST/api/collateral/market-valuationRecordMarketValuationCommand—
POST/api/collateral/registerRegisterCollateralCommand—
POST/api/collateral/releaseReleaseCollateralCommand—
collect8
MethodPathRequestResponse
GET/api/collect/settings/case-routing-rules——
GET/api/collect/settings/collection-pools——
GET/api/collect/settings/collection-pools/all——
GET/api/collect/settings/default-process-rules——
GET/api/collect/settings/hold-statuses——
GET/api/collect/settings/hold-statuses/all——
GET/api/collect/settings/outcome-codes——
GET/api/collect/settings/outcome-codes/all——
collection-authorities7
MethodPathRequestResponse
GET/api/collection-authoritiesaccountIdexternalAccountIdcounterpartyId—CollectionAuthorityDto[]
POST/api/collection-authoritiesRequestCollectionAuthorityCommand—
PUT/api/collection-authorities/amendAmendCollectionAuthorityCommand—
POST/api/collection-authorities/cancelCancelCollectionAuthorityCommand—
POST/api/collection-authorities/record-outcomeRecordCollectionAuthorityOutcomeCommand—
GET/api/collection-authorities/standingaccountIdexternalAccountId—CollectionAuthorityStandingDto
GET/api/collection-authorities/{id}——
collections20
MethodPathRequestResponse
GET/api/collections/accounts/{accountId}/default-process——
GET/api/collections/aged-debtors/summary—AgedDebtorBandSummaryDto[]
GET/api/collections/aged-debtors/{accountId}——
POST/api/collections/cases/apply-holdApplyHoldStatusToCaseCommand—
POST/api/collections/cases/claimClaimCounterpartyCasesCommand—
POST/api/collections/cases/hand-offHandOffCollectionCaseCommand—
POST/api/collections/cases/lift-holdLiftHoldStatusOnCaseCommand—
POST/api/collections/cases/outcomeRecordCaseOutcomeCommand—
POST/api/collections/cases/reallocateReallocateCollectorCommand—
GET/api/collections/cases/{accountId}——
POST/api/collections/default-process/issue-enforcement-noticeIssueEnforcementNoticeCommand—
GET/api/collections/promisesaccountId——
POST/api/collections/promisesCreatePromiseToPayCommand—
GET/api/collections/queue/collector/{collectorId}——
GET/api/collections/queue/mine——
GET/api/collections/queue/monitored-promises——
GET/api/collections/queue/pool/{poolId}——
POST/api/collections/record-amount-dueRecordAmountDueOnAgedDebtorCommand—
POST/api/collections/record-amount-paidRecordPaymentOnAgedDebtorCommand—
GET/api/collections/work-case/{caseId}——
commands2
MethodPathRequestResponse
GET/api/commandsstatuscommandTypebatchIdsessionIdpageSizeoffsetcursorsortdescendinggroupBy—PageOfCommandRecord
GET/api/commands/{id}—CommandRecord
compliance33
MethodPathRequestResponse
GET/api/compliance/clearance-requirements/{counterpartyTypeName}—ClearanceRequirement
POST/api/compliance/clearances/evidence/recordRecordClearanceEvidenceCommand—
POST/api/compliance/clearances/evidence/withdrawWithdrawClearanceEvidenceCommand—
POST/api/compliance/clearances/freezeFreezeClearanceCommand—
POST/api/compliance/clearances/refuseRefuseClearanceCommand—
POST/api/compliance/clearances/unfreezeUnfreezeClearanceCommand—
POST/api/compliance/clearances/verifyVerifyClearanceCommand—
GET/api/compliance/clearances/{counterpartyId}—ClearanceSummary
GET/api/compliance/clearances/{counterpartyId}/checklist——
GET/api/compliance/clearances/{counterpartyId}/evidence/{itemId}/scan——
POST/api/compliance/clearances/{counterpartyId}/evidence/{itemId}/scan——
GET/api/compliance/declaration-requirements/{counterpartyTypeName}/{roleKey}—string[]
GET/api/compliance/outstanding-due-diligence—OutstandingDueDiligenceRow[]
GET/api/compliance/residency-gaps—ResidencyGapRow[]
GET/api/compliance/settings/clearance-requirement-rules—ClearanceRequirementRuleDto[]
GET/api/compliance/settings/evidence-document-types—EvidenceDocumentTypeDto[]
GET/api/compliance/settings/evidence-requirements—EvidenceRequirementDto[]
GET/api/compliance/settings/regimes—ComplianceRegimeDto[]
GET/api/compliance/settings/reverification-cadence-rules—ReverificationCadenceRuleDto[]
GET/api/compliance/settings/threshold-rules—ThresholdRuleDto[]
GET/api/compliance/settings/withholding-income-classes—WithholdingIncomeClassDto[]
GET/api/compliance/settings/withholding-payer-classes—WithholdingPayerClassDto[]
GET/api/compliance/settings/withholding-payer-exemptions—WithholdingPayerExemptionDto[]
GET/api/compliance/settings/withholding-regime-rules—WithholdingRegimeRuleDto[]
GET/api/compliance/suspicion-reports—SuspicionReportSummary[]
POST/api/compliance/suspicion-reports/dispositionDispositionSuspicionReportCommand—
POST/api/compliance/suspicion-reports/raiseRaiseSuspicionReportCommand—
POST/api/compliance/tax-residencies/ceaseCeaseTaxResidencyCommand—
POST/api/compliance/tax-residencies/correctCorrectTaxResidencyCommand—
POST/api/compliance/tax-residencies/declareDeclareTaxResidencyCommand—
GET/api/compliance/tax-residencies/{counterpartyId}—TaxResidencySummary[]
GET/api/compliance/threshold-reports—ThresholdReportSummary[]
POST/api/compliance/threshold-reports/dispositionDispositionThresholdReportCommand—
connections1
MethodPathRequestResponse
GET/api/connections/whoami—ConnectionIdentity
contacts3
MethodPathRequestResponse
GET/api/contactspageSizeoffsetcursorsortdescendingsearchtypestatusregisteredFromregisteredTo——
GET/api/contacts/exportsortdescendingsearchtypestatusregisteredFromregisteredTo——
GET/api/contacts/searchq——
correspondence20
MethodPathRequestResponse
GET/api/correspondenceaboutdocumentaccountpageSizeoffsetcursorsortdescendingsearch—PageOfCorrespondenceDto
GET/api/correspondence/channelsall—AvailableChannelDto[]
POST/api/correspondence/delivery-addresses/addAddDeliveryAddressCommand—
POST/api/correspondence/delivery-addresses/removeRemoveDeliveryAddressCommand—
POST/api/correspondence/delivery-preferences/clearClearDeliveryPreferenceCommand—
POST/api/correspondence/delivery-preferences/setSetDeliveryPreferenceCommand—
GET/api/correspondence/email/gateways—EmailGatewayDto[]
POST/api/correspondence/email/gateways/retireRetireEmailGatewayCommand—
GET/api/correspondence/email/sender-rules—SenderRulesDto
POST/api/correspondence/forwardForwardCorrespondenceCommand—
GET/api/correspondence/post-queuedocumentstatuspageSizeoffsetcursorsortdescendingsearch—PageOfPostalItemDto
POST/api/correspondence/post-queue/postedRecordPostedDespatchCommand—
POST/api/correspondence/post-queue/returnedRecordPostalReturnCommand—
POST/api/correspondence/resendResendCorrespondenceChannelCommand—
GET/api/correspondence/sms/gateways—SmsGatewayDto[]
POST/api/correspondence/sms/gateways/retireRetireSmsGatewayCommand—
GET/api/correspondence/types—CorrespondenceTypeDto[]
GET/api/correspondence/whatsapp/gateways—WhatsAppGatewayDto[]
POST/api/correspondence/whatsapp/gateways/retireRetireWhatsAppGatewayCommand—
GET/api/correspondence/whatsapp/gateways/{key}/templates—WhatsAppTemplate[]
cost-centres11
MethodPathRequestResponse
POST/api/cost-centresRegisterCostCentre—
GET/api/cost-centres/{id}——
POST/api/cost-centres/{id}UpdateCostCentreRequest—
GET/api/cost-centres/{id}/accountsasOf——
POST/api/cost-centres/{id}/activate——
POST/api/cost-centres/{id}/close——
POST/api/cost-centres/{id}/codeChangeCostCentreCodeRequest—
GET/api/cost-centres/{id}/financial-summary——
POST/api/cost-centres/{id}/gl-referenceChangeCostCentreGLReferenceRequest—
GET/api/cost-centres/{id}/operationspermittedOnly——
GET/api/cost-centres/{id}/scheduled-moves——
counterparties38
MethodPathRequestResponse
POST/api/counterparties/hold/liftLiftHoldCommand—
POST/api/counterparties/hold/placePlaceHoldCommand—
GET/api/counterparties/lookup/{id}——
GET/api/counterparties/potential-duplicatesnameemailAddressmobileNumberexcluding——
GET/api/counterparties/settings/former-value-disclosure—FormerValueDisclosureDto
POST/api/counterparties/settings/former-value-disclosureSetFormerValueDisclosureCommand—
GET/api/counterparties/{counterpartyId}/authorisation-history—AuthorisationQueueReadModel[]
GET/api/counterparties/{counterpartyId}/date-of-death——
GET/api/counterparties/{counterpartyId}/deposit-insuranceasOf—DepositorCoverage
GET/api/counterparties/{counterpartyId}/hold——
GET/api/counterparties/{counterpartyId}/pending-creations—PendingCreationDto[]
POST/api/counterparties/{counterpartyId}/property-entries/amendAmendScheduledCounterpartyPropertyChangeRequest—
POST/api/counterparties/{counterpartyId}/property-entries/cancelCancelScheduledCounterpartyPropertyChangeRequest—
POST/api/counterparties/{counterpartyId}/property-entries/correctCorrectCounterpartyPropertyEntryRequest—
GET/api/counterparties/{counterpartyId}/tax-certificates—TaxCertificateDto[]
GET/api/counterparties/{counterparty}/account-sharing-agreements—AccountSharingAgreementsResponse
GET/api/counterparties/{counterparty}/channel-service-agreements—ChannelServiceAgreementSummary[]
GET/api/counterparties/{counterparty}/charge-periodsfromto—ChargePeriodSummary[]
GET/api/counterparties/{counterparty}/liquidity-structuresasOf—LiquidityStructureRow[]
GET/api/counterparties/{counterparty}/service-enrolments—ServiceEnrolmentSummary[]
GET/api/counterparties/{id}/acknowledged-duplicates——
GET/api/counterparties/{id}/cards—CardSummary[]
GET/api/counterparties/{id}/delivery-preferences—DeliveryPreferencesDto
GET/api/counterparties/{id}/financial-summary——
GET/api/counterparties/{id}/operationspermittedOnly——
POST/api/counterparties/{id}/operations/{operationName}/executeExecuteCounterpartyOperationRequest—
GET/api/counterparties/{id}/roles——
POST/api/counterparties/{id}/rolesJsonElement—
DELETE/api/counterparties/{id}/roles/{roleTypeName}——
POST/api/counterparties/{id}/roles/{roleTypeName}/reassign——
GET/api/counterparties/{slug}pageIndexpageSize——
POST/api/counterparties/{slug}JsonElement—
GET/api/counterparties/{slug}/{id}——
PUT/api/counterparties/{slug}/{id}JsonElement—
POST/api/counterparties/{slug}/{id}/activate——
POST/api/counterparties/{slug}/{id}/discard-draft——
POST/api/counterparties/{slug}/{id}/reinstate——
POST/api/counterparties/{slug}/{id}/suspend——
counterparty-balances1
MethodPathRequestResponse
GET/api/counterparty-balancesids——
counterparty-types1
MethodPathRequestResponse
POST/api/counterparty-types/yaml——
countries2
MethodPathRequestResponse
GET/api/countries——
GET/api/countries/all——
credit-limits7
MethodPathRequestResponse
GET/api/credit-limitscounterpartyId—CreditLimitDto
POST/api/credit-limitsCreateCreditLimitCommand—
GET/api/credit-limits/by-idcreditLimitId—CreditLimitDto
POST/api/credit-limits/decreaseDecreaseCreditLimitCommand—
POST/api/credit-limits/freezeFreezeCreditLimitCommand—
POST/api/credit-limits/increaseIncreaseCreditLimitCommand—
POST/api/credit-limits/unfreezeUnfreezeCreditLimitCommand—
credit-risk3
MethodPathRequestResponse
GET/api/credit-risk/provision-matrices—ProvisionMatrixView[]
GET/api/credit-risk/provision-matrices/{key}——
GET/api/credit-risk/provision-matrices/{key}/products—ProductRef[]
currencies7
MethodPathRequestResponse
GET/api/currencies——
GET/api/currencies/all——
GET/api/currencies/rate-feed—RateFeedPolicyResponse
POST/api/currencies/ratesUpsertExchangeRateCommand—
POST/api/currencies/rates/carry-forwardCarryForwardExchangeRatesCommand—
POST/api/currencies/rates/mark-finalMarkExchangeRatesFinalCommand—
GET/api/currencies/rates/matrixeffectiveDate——
day-count-conventions1
MethodPathRequestResponse
GET/api/day-count-conventions—DayCountConventionRow[]
day-end12
MethodPathRequestResponse
POST/api/day-end/abortAbortDayEndRunCommand—
GET/api/day-end/enquiry/daysfromto——
GET/api/day-end/enquiry/exportviewfromtostepIdstatus——
GET/api/day-end/enquiry/step-logfromtostepIdstatuspage——
GET/api/day-end/enquiry/stepsfromto——
GET/api/day-end/lock——
POST/api/day-end/runRunDayEndRequest—
POST/api/day-end/run-forwardRunForwardRequest—
GET/api/day-end/runslimit—DayEndRun[]
GET/api/day-end/runs/{runId}/dates—string[]
GET/api/day-end/runs/{runId}/stepstradingDate—DayEndDayLog
GET/api/day-end/stories—StoryScorecard
debit-orders9
MethodPathRequestResponse
GET/api/debit-ordersaccountId—DebitOrderDto[]
POST/api/debit-orders/adjust-amountAdjustDebitOrderAmountCommand—
GET/api/debit-orders/allpageSizeoffsetcursorsortdescendingsearch—PageOfAllDebitOrderDto
GET/api/debit-orders/all/exportsortdescendingsearch——
POST/api/debit-orders/cancelCancelDebitOrderCommand—
POST/api/debit-orders/change-external-accountChangeDebitOrderExternalAccountCommand—
GET/api/debit-orders/external-accountexternalAccountId—ExternalAccountInstructionDto[]
POST/api/debit-orders/rescheduleRescheduleDebitOrderCommand—
POST/api/debit-orders/scheduleScheduleDebitOrderRequest—
designer1
MethodPathRequestResponse
POST/api/designer/forecastDesignerForecastRequest—
direct-credits16
MethodPathRequestResponse
GET/api/direct-creditsaccountIdpageIndexpageSize—ListAccountDirectCreditsResponse
GET/api/direct-credits/allpageSizeoffsetcursorsortdescendingsearch—PageOfAllDirectCreditDto
GET/api/direct-credits/all/exportsortdescendingsearch——
POST/api/direct-credits/approveApproveDirectCreditCommand—
POST/api/direct-credits/approve-operating-entityApproveOperatingEntityDirectCreditsCommandApprovedDirectCredits
POST/api/direct-credits/change-external-accountChangeDirectCreditExternalAccountCommand—
GET/api/direct-credits/external-accountexternalAccountId—ExternalAccountInstructionDto[]
GET/api/direct-credits/operating-entityoperatingEntityIdpageSizeoffsetcursorsortdescendingsearchstatusexternalAccountIdtriagesubmissionId—PageOfOperatingEntityDirectCreditDto
POST/api/direct-credits/operating-entity/approve-auto-clearedoperatingEntityId——
GET/api/direct-credits/operating-entity/exportoperatingEntityIdsortdescendingsearchstatusexternalAccountIdtriagesubmissionId——
POST/api/direct-credits/operating-entity/triageoperatingEntityId—TriageDirectCreditsResponse
POST/api/direct-credits/rejectRejectDirectCreditCommand—
POST/api/direct-credits/releaseReleaseDirectCreditCommand—
POST/api/direct-credits/requestInitiateDirectCreditInstructionRequest—
POST/api/direct-credits/submit-operating-entitySubmitOperatingEntityDirectCreditsCommand—
GET/api/direct-credits/{id}/instant-step—InstantDirectCreditStepView
direct-debits14
MethodPathRequestResponse
GET/api/direct-debitsaccountIdpageIndexpageSize—ListAccountDirectDebitsResponse
GET/api/direct-debits/allpageSizeoffsetcursorsortdescendingsearch—PageOfAllDirectDebitDto
GET/api/direct-debits/all/exportsortdescendingsearch——
POST/api/direct-debits/approveApproveDirectDebitCommand—
POST/api/direct-debits/approve-operating-entityApproveOperatingEntityDirectDebitsCommand—
GET/api/direct-debits/external-accountexternalAccountId—ExternalAccountInstructionDto[]
GET/api/direct-debits/operating-entityoperatingEntityIdpageSizeoffsetcursorsortdescendingsearchstatusexternalAccountIdtriagesubmissionId—PageOfOperatingEntityDirectDebitDto
POST/api/direct-debits/operating-entity/approve-auto-clearedoperatingEntityId——
GET/api/direct-debits/operating-entity/exportoperatingEntityIdsortdescendingsearchstatusexternalAccountIdtriagesubmissionId——
POST/api/direct-debits/operating-entity/triageoperatingEntityId—TriageDirectDebitsResponse
POST/api/direct-debits/rejectRejectDirectDebitCommand—
POST/api/direct-debits/requestInitiateDirectDebitInstructionRequest—
POST/api/direct-debits/return-not-authorisedReturnDirectDebitNotAuthorisedCommand—
POST/api/direct-debits/submit-operating-entitySubmitOperatingEntityDirectDebitsCommand—
document-templates17
MethodPathRequestResponse
GET/api/document-templates/assets—TemplateAsset[]
POST/api/document-templates/assets/file—FileRef
GET/api/document-templates/data-sourcestype—DataSourceDto[]
POST/api/document-templates/draftEditDocumentTemplateDraftCommand—
GET/api/document-templates/layout-purposes—[]
GET/api/document-templates/modelsvariant—TemplateModelDto[]
GET/api/document-templates/previewtemplate—TemplateRenderOutcome
POST/api/document-templates/publishPublishDocumentTemplateCommand—
POST/api/document-templates/restoreRestoreDocumentTemplateVersionCommand—
POST/api/document-templates/retireRetireDocumentTemplateCommand—
POST/api/document-templates/send-testSendTemplateTestCommand—
GET/api/document-templates/snippets—[]
POST/api/document-templates/templateGetDocumentTemplateQueryDocumentTemplateDto
GET/api/document-templates/versionstemplate—DocumentTemplatePublished[]
GET/api/document-templates/word-drafttemplate——
POST/api/document-templates/word-draftUploadDocumentTemplateDraftCommand—
POST/api/document-templates/word-file—FileRef
document-types2
MethodPathRequestResponse
GET/api/document-types—DocumentTypeRow[]
GET/api/document-types/{key}/starter——
documents6
MethodPathRequestResponse
GET/api/documentsrecordtype—ProducedDocumentDto[]
POST/api/documents/previewPreviewDocumentQuery—
POST/api/documents/produceProduceDocumentCommand—
GET/api/documents/produciblerecord—ProducibleDocumentDto[]
POST/api/documents/saveSaveProducedDocumentCommand—
POST/api/documents/send-againSendDocumentAgainCommand—
email-messages1
MethodPathRequestResponse
GET/api/email-messagesownerIdpageSizeoffsetcursorsortdescendingsearch—PageOfEmailMessageDto
expected-items4
MethodPathRequestResponse
GET/api/expected-itemsexternalAccountIdoperatingEntityIdstatuspageSizeoffsetcursorsortdescendingsearch—PageOfExpectedItemDto
POST/api/expected-itemsRecordManualExpectedItemCommand—
POST/api/expected-items/invoicesRecordExpectedInvoicesCommand—
POST/api/expected-items/{id}/withdrawWithdrawExpectedInvoiceCommand—
external-accounts22
MethodPathRequestResponse
GET/api/external-accountscounterpartyIdcurrencyId—ExternalAccountDto[]
POST/api/external-accountsRegisterExternalAccountCommand—
POST/api/external-accounts/add-proxyAddExternalAccountProxyCommand—
GET/api/external-accounts/approved-beneficiaries—ApprovedBeneficiaryDto[]
POST/api/external-accounts/approved-beneficiariesAddApprovedBeneficiaryCommand—
GET/api/external-accounts/audit-payable-destinations—AuditPayableDestinationsResult
GET/api/external-accounts/by-idexternalAccountId—GetExternalAccountResponse
POST/api/external-accounts/capture-proxy-beneficiaryCaptureProxyBeneficiaryCommand—
POST/api/external-accounts/change-descriptionChangeExternalAccountDescriptionCommand—
POST/api/external-accounts/change-identifierChangeExternalAccountIdentifierCommand—
POST/api/external-accounts/closeCloseExternalAccountCommand—
POST/api/external-accounts/designate-approved-beneficiaryDesignateApprovedBeneficiaryCommand—
GET/api/external-accounts/last-transactionexternalAccountId—ExternalAccountLastTransactionResponse
GET/api/external-accounts/last-transactionsoperatingEntityId—object
GET/api/external-accounts/operating-entityoperatingEntityIdcurrencyId—ExternalAccountDto[]
POST/api/external-accounts/remove-proxyRemoveExternalAccountProxyCommand—
GET/api/external-accounts/resolve-proxykindvalueexternalAccountId—ResolveProxyResponse
POST/api/external-accounts/revoke-approved-beneficiaryRevokeApprovedBeneficiaryCommand—
POST/api/external-accounts/set-beneficiary-notification-contactsSetBeneficiaryNotificationContactsCommand—
POST/api/external-accounts/set-beneficiary-referencesSetBeneficiaryReferencesCommand—
POST/api/external-accounts/simulation/return-markerMarkExternalAccountForReturnRequest—
POST/api/external-accounts/transferTransferExternalAccountCommand—
facilities7
MethodPathRequestResponse
GET/api/facilitiescounterpartyId—FacilityDto[]
GET/api/facilities/by-idfacilityId—FacilityDto
POST/api/facilities/decreaseDecreaseFacilityCommand—
POST/api/facilities/freezeFreezeFacilityCommand—
POST/api/facilities/grantGrantFacilityCommand—
POST/api/facilities/increaseIncreaseFacilityCommand—
POST/api/facilities/unfreezeUnfreezeFacilityCommand—
facility-types2
MethodPathRequestResponse
GET/api/facility-types——
GET/api/facility-types/all——
features4
MethodPathRequestResponse
GET/api/features—FeatureRow[]
POST/api/features/enableSetFeatureEnabledCommand—
POST/api/features/licenseLicenseFeatureCommand—
GET/api/features/{key}/disable-impact——
files1
MethodPathRequestResponse
GET/files/{id}——
format-profiles3
MethodPathRequestResponse
GET/api/format-profilesbankIdentifierpageIndexpageSize—ListFormatProfilesResponse
POST/api/format-profiles/approveApproveFormatProfileCommand—
POST/api/format-profiles/proposeProposeFormatProfileFromSampleCommand—
fx-transfers8
MethodPathRequestResponse
GET/api/fx-transfersclientpageIndexpageSize—FxTransferRow[]
POST/api/fx-transfers/approveApproveFxTransferCommand—
POST/api/fx-transfers/cancelCancelFxTransferCommand—
POST/api/fx-transfers/declineDeclineFxTransferQuoteCommand—
POST/api/fx-transfers/quoteQuoteFxTransferCommandFxTransferQuoteView
POST/api/fx-transfers/raiseRaiseFxTransferCommand—
POST/api/fx-transfers/releaseReleaseFxTransferCommand—
GET/api/fx-transfers/{id}/quote—FxTransferQuoteView
health1
MethodPathRequestResponse
GET/health——
identifications4
MethodPathRequestResponse
GET/api/identificationsholderId—IdentificationSummary[]
POST/api/identifications/correctCorrectIdentificationCommand—
POST/api/identifications/recordRecordIdentificationCommand—
POST/api/identifications/withdrawWithdrawIdentificationCommand—
import7
MethodPathRequestResponse
GET/api/import—ImportPageView
POST/api/import/abandonAbandonImportRun—
POST/api/import/runsStartImportRun—
POST/api/import/selectionSelectAccounts—
POST/api/import/stepsStartStep—
POST/api/import/steps/rerunRerunStep—
GET/api/import/steps/{step}/history—StepAttemptView[]
iso-countries1
MethodPathRequestResponse
GET/api/iso-countries——
labels1
MethodPathRequestResponse
POST/api/labelsResolveLabelsRequest—
languages2
MethodPathRequestResponse
GET/api/languages——
GET/api/languages/all——
limit8
MethodPathRequestResponse
GET/api/limit/settings/debit-order-currency-minimums——
GET/api/limit/settings/debit-order-currency-minimums/all——
GET/api/limit/settings/direct-credit-currency-minimums——
GET/api/limit/settings/direct-credit-currency-minimums/all——
GET/api/limit/settings/direct-debit-currency-minimums——
GET/api/limit/settings/direct-debit-currency-minimums/all——
GET/api/limit/settings/standing-order-currency-minimums——
GET/api/limit/settings/standing-order-currency-minimums/all——
liquidity-structures15
MethodPathRequestResponse
POST/api/liquidity-structuresDraftLiquidityStructureCommand—
GET/api/liquidity-structures/sweep-breaks—SweepBreakRow[]
GET/api/liquidity-structures/sweep-legs/{leg}—SweepLegView
POST/api/liquidity-structures/sweep-legs/{leg}/cancelCancelSweepLegRequest—
POST/api/liquidity-structures/sweep-legs/{leg}/retryRetrySweepLegRequest—
POST/api/liquidity-structures/sweep-legs/{leg}/settleRecordSweepLegSettlementRequest—
GET/api/liquidity-structures/{structure}asOf—LiquidityStructureDetail
POST/api/liquidity-structures/{structure}/changesProposeLiquidityStructureChangeCommand—
POST/api/liquidity-structures/{structure}/changes/{change}/approveApproveLiquidityStructureChangeCommand—
POST/api/liquidity-structures/{structure}/changes/{change}/cancellationsProposeLiquidityStructureChangeCancellationCommand—
POST/api/liquidity-structures/{structure}/changes/{change}/rejectRejectLiquidityStructureChangeCommand—
POST/api/liquidity-structures/{structure}/changes/{change}/withdrawWithdrawLiquidityStructureChangeCommand—
GET/api/liquidity-structures/{structure}/evaluationonslotshapeDatechange—SweepEvaluation
GET/api/liquidity-structures/{structure}/sweep-legspagepageSize—SweepRunHistory
GET/api/liquidity-structures/{structure}/sweep-schedule—SweepScheduleStatus
loans1
MethodPathRequestResponse
GET/api/loans/{loanAccountId}/cover—LoanCoverSnapshot
lookups2
MethodPathRequestResponse
GET/api/lookups/types—ListLookupTypesResponse
GET/api/lookups/types/{id}——
mcp1
MethodPathRequestResponse
POST/mcp/{tenant}McpRequest—
me10
MethodPathRequestResponse
GET/api/me/capabilities——
GET/api/me/features——
GET/api/me/managed-customers——
GET/api/me/permissions——
GET/api/me/photo——
POST/api/me/photoSetMemberPhotoCommand—
DELETE/api/me/photo——
GET/api/me/platform-authority——
GET/api/me/profile—MemberListItem
POST/api/me/profileUpdateMemberProfileCommand—
members3
MethodPathRequestResponse
GET/api/membersincludeInactive—ListMembersResponse
GET/api/members/{memberId}/photo——
GET/api/members/{userId}——
merchant-agreements15
MethodPathRequestResponse
GET/api/merchant-agreementsstatusmerchant—MerchantAgreementSummary[]
POST/api/merchant-agreementsOpenMerchantAgreementCommand—
GET/api/merchant-agreements/{id}——
POST/api/merchant-agreements/{id}/cancel-scheduled-pricing-changeCancelScheduledMerchantPricingChangeCommand—
POST/api/merchant-agreements/{id}/cancel-scheduled-reserve-changeCancelScheduledMerchantReserveChangeCommand—
POST/api/merchant-agreements/{id}/cancel-scheduled-settlement-changeCancelScheduledMerchantSettlementChangeCommand—
POST/api/merchant-agreements/{id}/change-pricingChangeMerchantPricingCommand—
POST/api/merchant-agreements/{id}/change-reserveChangeMerchantReserveCommand—
POST/api/merchant-agreements/{id}/change-settlementChangeMerchantSettlementCommand—
GET/api/merchant-agreements/{id}/chargebacks—MerchantChargebackSummary[]
GET/api/merchant-agreements/{id}/operationspermittedOnly——
GET/api/merchant-agreements/{id}/reserve——
POST/api/merchant-agreements/{id}/resumeResumeMerchantAgreementCommand—
POST/api/merchant-agreements/{id}/suspendSuspendMerchantAgreementCommand—
POST/api/merchant-agreements/{id}/terminateTerminateMerchantAgreementCommand—
merchant-chargebacks3
MethodPathRequestResponse
GET/api/merchant-chargebacks/{id}——
POST/api/merchant-chargebacks/{id}/acceptAcceptMerchantChargebackCommand—
POST/api/merchant-chargebacks/{id}/representRecordMerchantRepresentmentCommand—
merchant-nodes12
MethodPathRequestResponse
GET/api/merchant-nodesparentrootsOnlycounterpartyoffRuleOnlyincludeBelow—MerchantNodeSummary[]
POST/api/merchant-nodesOpenMerchantNodeCommand—
GET/api/merchant-nodes/{id}——
POST/api/merchant-nodes/{id}/amend-payout-accountAmendMerchantPayoutAccountCommand—
POST/api/merchant-nodes/{id}/assign-identifierAssignMerchantIdentifierCommand—
POST/api/merchant-nodes/{id}/change-categoryChangeMerchantNodeCategoryCommand—
POST/api/merchant-nodes/{id}/change-propertiesChangeMerchantNodePropertiesCommand—
POST/api/merchant-nodes/{id}/change-routingChangeMerchantCurrencyRoutingCommand—
POST/api/merchant-nodes/{id}/closeCloseMerchantNodeCommand—
POST/api/merchant-nodes/{id}/resumeResumeMerchantNodeCommand—
POST/api/merchant-nodes/{id}/settlement-accountsOpenMerchantSettlementAccountCommand—
POST/api/merchant-nodes/{id}/suspendSuspendMerchantNodeCommand—
metering4
MethodPathRequestResponse
GET/api/metering/settings/chargeable-metrics—ChargeableMetric[]
GET/api/metering/settings/chargeable-metrics/all—ChargeableMetric[]
POST/api/metering/settings/chargeable-metrics/removeDeactivateChargeableMetricCommand—
GET/api/metering/unattributed-usagefromtoreasonpageSizeoffsetcursorsortdescendinggroupBy—PageOfUnattributedUsage
monitoring1
MethodPathRequestResponse
GET/api/monitoring/events——
notes4
MethodPathRequestResponse
GET/api/notesaggregateIdpageSizeoffsetcursorsortdescendingsearch—PageOfNoteDto
POST/api/notes/createCreateNoteCommand—
POST/api/notes/deleteDeleteNoteCommand—
POST/api/notes/updateUpdateNoteCommand—
notices1
MethodPathRequestResponse
GET/api/notices/expiringfromto—ExpiringNoticeDto[]
numbering1
MethodPathRequestResponse
POST/api/numbering/nextNextNumbersRequest—
operating-entities22
MethodPathRequestResponse
GET/api/operating-entities—OperatingEntityListItemDto[]
POST/api/operating-entitiesRegisterOperatingEntity—
GET/api/operating-entities/{id}——
POST/api/operating-entities/{id}UpdateOperatingEntityRequest—
GET/api/operating-entities/{id}/cash-flowcurrency——
GET/api/operating-entities/{id}/cash-flow/bandcurrencyband——
GET/api/operating-entities/{id}/closable—OperatingEntityClosability
POST/api/operating-entities/{id}/close——
POST/api/operating-entities/{id}/discard-draft——
GET/api/operating-entities/{id}/financial-summary——
GET/api/operating-entities/{id}/operationspermittedOnly——
POST/api/operating-entities/{id}/operations/{operationName}/executeExecuteOperatingEntityOperationRequest—
POST/api/operating-entities/{id}/property-entries/amendAmendScheduledOperatingEntityPropertyChangeRequest—
POST/api/operating-entities/{id}/property-entries/cancelCancelScheduledOperatingEntityPropertyChangeRequest—
POST/api/operating-entities/{id}/property-entries/correctCorrectOperatingEntityPropertyEntryRequest—
POST/api/operating-entities/{id}/reopen——
GET/api/operating-entities/{id}/submissionspageSizeoffsetcursorsortdescendingexternalAccountId—PageOfSubmissionDto
POST/api/operating-entities/{id}/submissions/retry-failed——
GET/api/operating-entities/{operatingEntityId}/authorisation-history—AuthorisationQueueReadModel[]
GET/api/operating-entities/{operatingEntityId}/cost-centres—CostCentreListRow[]
GET/api/operating-entities/{operatingEntityId}/organisational-units—OrganisationalUnitTreeNode[]
GET/api/operating-entities/{operatingEntityId}/scheduled-transfers—ScheduledAccountTransferReadModel[]
operating-entity-balances1
MethodPathRequestResponse
GET/api/operating-entity-balancesids——
operating-entity-registration-demands1
MethodPathRequestResponse
GET/api/operating-entity-registration-demands——
organisational-units8
MethodPathRequestResponse
POST/api/organisational-unitsRegisterOrganisationalUnit—
GET/api/organisational-units/{id}asOf——
GET/api/organisational-units/{id}/accountsasOfincludeDescendants——
POST/api/organisational-units/{id}/activate——
POST/api/organisational-units/{id}/close——
POST/api/organisational-units/{id}/codeChangeOrganisationalUnitCodeRequest—
GET/api/organisational-units/{id}/operationspermittedOnly——
POST/api/organisational-units/{id}/operations/{operationName}/executeExecuteOrganisationalUnitOperationRequest—
pay4
MethodPathRequestResponse
GET/api/pay/settings/external-account-standards—ExternalAccountStandardsResponse
GET/api/pay/settings/operating-entity-nomination-rules/{operatingEntityId}—OperatingEntityNominationRulesDto
GET/api/pay/settings/settlement-rails——
GET/api/pay/settings/settlement-rails/all——
platform-logins1
MethodPathRequestResponse
POST/api/platform-logins/find-by-emailFindPlatformLoginByEmailQueryPlatformUser
position-type-masters1
MethodPathRequestResponse
GET/api/position-type-masters——
posting-groups1
MethodPathRequestResponse
GET/api/posting-groups/{id}/products—ProductRef[]
price12
MethodPathRequestResponse
GET/api/price/settings/known-rates——
GET/api/price/settings/known-rates/all——
GET/api/price/settings/price-lists——
GET/api/price/settings/price-lists/all——
GET/api/price/settings/price-lists/{listId}/price-matrixpriceTypereferencerateDatecandidate——
GET/api/price/settings/price-types——
GET/api/price/settings/price-types/all——
POST/api/price/settings/price-types/deactivateDeactivatePriceTypeCommand—
GET/api/price/settings/prices——
GET/api/price/settings/prices/all——
GET/api/price/settings/rate-types——
GET/api/price/settings/rate-types/all——
price-lists7
MethodPathRequestResponse
POST/api/price-lists/change-priceChangePriceCommand—
POST/api/price-lists/change-pricesChangePricesCommand—
POST/api/price-lists/copyCopyPriceListCommand—
POST/api/price-lists/remove-priceRemovePriceCommand—
POST/api/price-lists/reschedule-priceReschedulePriceCommand—
GET/api/price-lists/{id}/copy-previewstartDate——
GET/api/price-lists/{id}/products—ProductRef[]
pricing-plans11
MethodPathRequestResponse
POST/api/pricing-plans/adjust-priceAdjustPriceCommand—
POST/api/pricing-plans/cancel-scheduled-changeCancelScheduledPlanChangeCommand—
POST/api/pricing-plans/change-price-listChangePriceListCommand—
POST/api/pricing-plans/clear-price-adjustmentClearPriceAdjustmentCommand—
GET/api/pricing-plans/coverageplancurrencyasOf—PricingPlanCoverage
POST/api/pricing-plans/createCreatePricingPlanCommand—
POST/api/pricing-plans/override-priceOverridePriceCommand—
GET/api/pricing-plans/plan-counts——
POST/api/pricing-plans/reschedule-changeReschedulePlanChangeCommand—
GET/api/pricing-plans/sheet/{planId}candidateList——
GET/api/pricing-plans/{accountId}candidateList——
products16
MethodPathRequestResponse
GET/api/products—ProductView[]
POST/api/productsAddProductCommand—
GET/api/products/{key}——
GET/api/products/{key}/change-set——
POST/api/products/{key}/change-set/discard——
POST/api/products/{key}/change-set/publish——
POST/api/products/{key}/change-set/turns/{turn}/accept——
POST/api/products/{key}/change-set/turns/{turn}/reject——
POST/api/products/{key}/copyCopyProductRequest—
POST/api/products/{key}/linkLinkProductRequest—
GET/api/products/{key}/links——
POST/api/products/{key}/parts/{part}/follow——
POST/api/products/{key}/parts/{part}/hold——
POST/api/products/{key}/reinstate——
POST/api/products/{key}/retire——
POST/api/products/{key}/unlink——
properties1
MethodPathRequestResponse
POST/api/properties/files—FileRef
provisioning-settings1
MethodPathRequestResponse
GET/api/provisioning-settings—AccountTypeProvisioningSettings
public4
MethodPathRequestResponse
GET/public/files/{token}——
GET/public/files/{token}/{name}——
GET/public/sign/{token}——
POST/public/signing/callback/{token}——
rate-structures5
MethodPathRequestResponse
GET/api/rate-structures—RateStructureSettings
POST/api/rate-structures/bands/removeRemoveRateBandCommand—
POST/api/rate-structures/rates/changeRegistryAccountsChangeRateCommand—
GET/api/rate-structures/{name}/blast-radiustermTypeIdfromAmounttoAmount——
GET/api/rate-structures/{name}/quotetermTypeIdamountvalueDate——
rates1
MethodPathRequestResponse
POST/api/rates/changePricingRatesChangeRateCommand—
recurring-tasks7
MethodPathRequestResponse
POST/api/recurring-tasks/amendAmendRecurringTaskCommand—
GET/api/recurring-tasks/by-subjectsubjectTypesubjectId—MyRecurringTaskDto[]
POST/api/recurring-tasks/defineDefineRecurringTaskCommand—
POST/api/recurring-tasks/endEndRecurringTaskCommand—
GET/api/recurring-tasks/mine—MyRecurringTaskDto[]
POST/api/recurring-tasks/pausePauseRecurringTaskCommand—
POST/api/recurring-tasks/resumeResumeRecurringTaskCommand—
reference-data-changes7
MethodPathRequestResponse
GET/api/reference-data-changeschangeSetId——
POST/api/reference-data-changesPublishReferenceDataChangeRequest—
GET/api/reference-data-changes/{id}——
POST/api/reference-data-changes/{id}/apply——
POST/api/reference-data-changes/{id}/approve——
POST/api/reference-data-changes/{id}/notify——
POST/api/reference-data-changes/{id}/rejectRejectReferenceDataChangeRequest—
references1
MethodPathRequestResponse
GET/api/references/{reference}streamIdpage—LookUpReferenceResponse
regulatory13
MethodPathRequestResponse
GET/api/regulatory/readinessoperatingEntityIdasOf—ReportableReadinessItem[]
GET/api/regulatory/settings/depositor-classes——
GET/api/regulatory/submission-runs—SubmissionRunDto[]
POST/api/regulatory/submission-runsProduceSubmissionRunCommand—
POST/api/regulatory/submission-runs/{id}/acknowledge-warningsAcknowledgeWarningsRequest—
POST/api/regulatory/submission-runs/{id}/acknowledgementRecordAcknowledgementRequest—
GET/api/regulatory/submission-runs/{id}/artifact——
GET/api/regulatory/submission-runs/{id}/downloads—SubmissionArtifactDownloadDto[]
POST/api/regulatory/submission-runs/{id}/rejectedMarkRejectedRequest—
POST/api/regulatory/submission-runs/{id}/submittedMarkSubmittedRequest—
POST/api/regulatory/tax-certificatesIssueTaxCertificateCommand—
GET/api/regulatory/tax-certificates/{id}/document——
POST/api/regulatory/tax-certificates/{id}/render——
regulatory-charge-classes1
MethodPathRequestResponse
GET/api/regulatory-charge-classes——
regulatory-limits1
MethodPathRequestResponse
GET/api/regulatory-limits——
relationships7
MethodPathRequestResponse
GET/api/relationshipssubjecttypeactiveOnly——
POST/api/relationshipsJsonElement—
POST/api/relationships/{relationshipId}/endJsonElement—
PATCH/api/relationships/{relationshipId}/properties/{name}JsonElement—
POST/api/relationships/{relationshipId}/property-entries/amendAmendScheduledRelationshipPropertyChangeRequest—
POST/api/relationships/{relationshipId}/property-entries/cancelCancelScheduledRelationshipPropertyChangeRequest—
POST/api/relationships/{relationshipId}/property-entries/correctCorrectRelationshipPropertyEntryRequest—
reports9
MethodPathRequestResponse
GET/api/reports/account-balancesoperatingEntityIdfromDatetoDategrouping—ReportAccountBalancesResponse
GET/api/reports/account-balances/exportoperatingEntityIdfromDatetoDategrouping——
GET/api/reports/account-movementsoperatingEntityIdglAccountIdfromDatetoDatepageSizeoffsetcursorsortdescendingsearch—ReportAccountMovementsResponse
GET/api/reports/account-movements/exportoperatingEntityIdglAccountIdfromDatetoDate——
GET/api/reports/failed-sign-insfromDatetoDatepageIndexpageSize—ReportFailedSignInsResponse
GET/api/reports/journal-entriesoperatingEntityIdglAccountIdfromDatetoDatepageSizeoffsetcursorsortdescendingsearchgroupBy—ReportJournalEntriesResponse
GET/api/reports/journal-entries/exportoperatingEntityIdglAccountIdfromDatetoDatesearch——
GET/api/reports/upcoming-eventsoperatingEntityIdfromDatetoDatepageIndexpageSize—ReportUpcomingEventsResponse
GET/api/reports/user-loginsfromDatetoDateuserGrouppageIndexpageSize—ReportUserLoginsResponse
return-files6
MethodPathRequestResponse
GET/api/return-filesoperatingEntityId—ReturnFileSummary[]
POST/api/return-files/ingestIngestReturnFileCommandReturnFileId
GET/api/return-files/refusedoperatingEntityId—ReturnFileSummary[]
GET/api/return-files/traced-paymentchanneltraceNumber—TracedPayment
GET/api/return-files/{id}—ReturnFileSummary
GET/api/return-files/{id}/lines—ReturnFileLineView[]
role-types1
MethodPathRequestResponse
POST/api/role-types/yaml——
roles1
MethodPathRequestResponse
GET/api/rolestypeincludeRevoked—ListRolesByTypeResponse
scheduling12
MethodPathRequestResponse
GET/api/scheduling/business-centres—BusinessCentreOption[]
POST/api/scheduling/holidays/importImportHolidaysRequest—
POST/api/scheduling/holidays/import-fileImportHolidaysFromFileRequest—
GET/api/scheduling/holidays/import-previewcalendarIdfromYearthroughYearbusinessCentre—HolidayImportPreview
GET/api/scheduling/jobs—ScheduledJob[]
GET/api/scheduling/jobs/alerts/count—UnresolvedFailureCountResponse
GET/api/scheduling/jobs/runslimit—ScheduledRun[]
POST/api/scheduling/schedules/previewPreviewScheduleDatesRequestSchedulePreview
GET/api/scheduling/settings/calendars——
GET/api/scheduling/settings/calendars/all——
GET/api/scheduling/settings/holidays——
GET/api/scheduling/settings/holidays/all——
securities6
MethodPathRequestResponse
POST/api/securities/activateActivateSecurityCommand—
POST/api/securities/advance-rateAdjustAdvanceRateCommand—
GET/api/securities/by-collateralcollateralId—SecuritySummary[]
GET/api/securities/by-loanloanAccountId—SecurityCoverLine[]
POST/api/securities/proposeProposeSecurityCommand—
POST/api/securities/releaseReleaseSecurityCommand—
seeding1
MethodPathRequestResponse
POST/api/seeding/runtenantphaseforce——
service-catalogue3
MethodPathRequestResponse
GET/api/service-catalogue—Service[]
GET/api/service-catalogue/all—Service[]
POST/api/service-catalogue/removeDeactivateServiceCommand—
service-enrolments7
MethodPathRequestResponse
POST/api/service-enrolmentsEnrolServiceCommandServiceEnrolmentId
POST/api/service-enrolments/amendAmendServiceEnrolmentCommand—
POST/api/service-enrolments/resumeResumeServiceEnrolmentCommand—
POST/api/service-enrolments/suspendSuspendServiceEnrolmentCommand—
POST/api/service-enrolments/terminateTerminateServiceEnrolmentCommand—
POST/api/service-enrolments/voidVoidServiceEnrolmentCommand—
GET/api/service-enrolments/{enrolment}—ServiceEnrolmentDetail
settings31
MethodPathRequestResponse
GET/api/settings/ai—AiSettingsView
POST/api/settings/aiSetAiChoiceCommand—
GET/api/settings/assistant—AssistantSettings
GET/api/settings/card-dispute-reason-codes—CardDisputeReasonCodeSettings
GET/api/settings/card-disputes—CardDisputeSettings
GET/api/settings/card-hold-expiry—CardHoldExpirySettings
GET/api/settings/card-processor—CardProcessorView
GET/api/settings/card-types—CardType[]
GET/api/settings/client-self-registration—ClientSelfRegistrationSettingsDto
POST/api/settings/client-self-registrationConfigureClientSelfRegistrationCommand—
GET/api/settings/failed-requests—FailedRequestSettingsDto
POST/api/settings/failed-requestsSetFailedRequestRetentionCommand—
GET/api/settings/institution-connections—InstitutionConnectionRow[]
GET/api/settings/market-data-feeds/deliveriespurposefromto—FeedDeliverySummary[]
GET/api/settings/market-data-feeds/feeds—FeedSummary[]
GET/api/settings/market-data-feeds/layoutspurpose—FeedLayoutRow[]
POST/api/settings/market-data-feeds/layouts/tryTryFeedLayoutQueryFeedLayoutTrial
GET/api/settings/market-data-feeds/observationspurposebusinessDate—FeedDelivery
GET/api/settings/market-data-feeds/well-known-layoutspurpose—WellKnownFeedLayout[]
GET/api/settings/merchant-category-groups—MerchantCategoryGroup[]
GET/api/settings/numbering-schemes——
GET/api/settings/numbering-schemes/all——
GET/api/settings/secrets—TenantSecretSummary[]
POST/api/settings/secrets/{purpose}SetTenantSecretRequest—
DELETE/api/settings/secrets/{purpose}——
GET/api/settings/{settingsType}/change-history—SettingsChangeHistory[]
GET/api/settings/{settingsType}/draft—SettingsDraftView
PATCH/api/settings/{settingsType}/draftSettingsPatchBody—
POST/api/settings/{settingsType}/draft/discard——
POST/api/settings/{settingsType}/publish——
GET/api/settings/{settingsType}/row-sets—RowSetMark[]
signing8
MethodPathRequestResponse
POST/api/signing/cancelCancelSignatureRequestCommand—
GET/api/signing/gateways—SigningGatewayRow[]
POST/api/signing/gateways/retireRetireSigningGatewayCommand—
POST/api/signing/remindSendSignatureReminderCommand—
GET/api/signing/requestsrecorddocumentopenOnlyissuingUnitolderThanDayspageSizeoffsetcursorsortdescendingsearchgroupBy—PageOfSignatureRequestDto
GET/api/signing/requests/{id}—SignatureRequestDto
GET/api/signing/requirements—SigningRequirementRow[]
POST/api/signing/sendSendForSignatureCommand—
simulator-outbox3
MethodPathRequestResponse
GET/api/simulator-outboxpageSizecursor—PageOfSimulatorOutboxRowDto
GET/api/simulator-outbox/email/{id}——
GET/api/simulator-outbox/sms/{id}——
sms-messages3
MethodPathRequestResponse
GET/api/sms-messagesownerIdpageSizeoffsetcursorsortdescendingsearch—PageOfSmsMessageDto
GET/api/sms-messages/exportownerIdsearch——
POST/api/sms-messages/resendResendSmsMessageRequest—
standing-orders11
MethodPathRequestResponse
GET/api/standing-ordersaccountId—StandingOrderDto[]
POST/api/standing-orders/adjust-amountAdjustStandingOrderAmountCommand—
GET/api/standing-orders/allpageSizeoffsetcursorsortdescendingsearch—PageOfAllStandingOrderDto
GET/api/standing-orders/all/exportsortdescendingsearch——
POST/api/standing-orders/cancelCancelStandingOrderCommand—
POST/api/standing-orders/change-external-accountChangeStandingOrderExternalAccountCommand—
GET/api/standing-orders/external-accountexternalAccountId—ExternalAccountInstructionDto[]
POST/api/standing-orders/payoutPayoutDisbursementRequest—
GET/api/standing-orders/payout-amount/{accountId}—PayoutAmountResponse
POST/api/standing-orders/rescheduleRescheduleStandingOrderCommand—
POST/api/standing-orders/scheduleScheduleStandingOrderRequest—
statements2
MethodPathRequestResponse
GET/api/statements/schedules—StatementScheduleView[]
POST/api/statements/{id}/render——
streams1
MethodPathRequestResponse
GET/api/streams/{streamId}/eventsfromtocursorpageSizeoffsetsortdescending——
structure-balances1
MethodPathRequestResponse
GET/api/structure-balancesids——
structures13
MethodPathRequestResponse
GET/api/structurespageIndexpageSize—StructureListResponse
POST/api/structuresJsonElement—
GET/api/structures/{id}——
PUT/api/structures/{id}JsonElement—
POST/api/structures/{id}/activate——
POST/api/structures/{id}/discard-draft——
GET/api/structures/{id}/financial-summary——
GET/api/structures/{id}/operationspermittedOnly——
POST/api/structures/{id}/operations/{operationName}/executeExecuteStructureOperationRequest—
POST/api/structures/{id}/property-entries/amendAmendScheduledStructurePropertyChangeRequest—
POST/api/structures/{id}/property-entries/cancelCancelScheduledStructurePropertyChangeRequest—
POST/api/structures/{id}/property-entries/correctCorrectStructurePropertyEntryRequest—
GET/api/structures/{structureId}/authorisation-history—AuthorisationQueueReadModel[]
submissions4
MethodPathRequestResponse
GET/api/submissions/awaiting-release—SubmissionDto[]
GET/api/submissions/{id}—SubmissionDto
POST/api/submissions/{id}/release——
GET/api/submissions/{id}/returns—SubmissionReturnLine[]
suspense12
MethodPathRequestResponse
GET/api/suspense/casespageSizeoffsetcursorsortdescendingsearchgroupByoperatingEntityIdpurposeIdownerIdunassignedstatusfromDaystoDays—PageOfSuspenseCaseRow
POST/api/suspense/cases/assignAssignSuspenseCasesCommand—
GET/api/suspense/cases/exportsortdescendingsearchoperatingEntityIdpurposeIdownerIdunassignedstatusfromDaystoDays——
GET/api/suspense/cases/{caseId}—SuspenseCaseDetail
POST/api/suspense/cases/{caseId}/statusRecordSuspenseCaseStatusCommand—
GET/api/suspense/dashboard/{operatingEntityId}—SuspenseDashboard
POST/api/suspense/items/refundRefundSuspenseItemCommand—
POST/api/suspense/items/transferTransferSuspenseItemCommand—
POST/api/suspense/items/write-offWriteOffSuspenseItemCommand—
GET/api/suspense/items/{openItemId}/suggestionstake—SuspenseCandidate[]
GET/api/suspense/purposes—SuspensePurposesView
POST/api/suspense/purposes/checkCheckSuspensePurposeConfigurationSuspenseConfigurationWarning[]
tasks13
MethodPathRequestResponse
POST/api/tasks/amendAmendTaskCommand—
POST/api/tasks/assignAssignTaskCommand—
GET/api/tasks/by-personpersonIdpageSizeoffsetcursorsortdescendingsearchgroupBy—PageOfTaskSummaryDto
GET/api/tasks/by-subjectsubjectTypesubjectIdpageSizeoffsetcursorsortdescendingsearchgroupBystatus—PageOfTaskSummaryDto
POST/api/tasks/cancelCancelTaskCommand—
POST/api/tasks/change-statusChangeTaskStatusCommand—
POST/api/tasks/claimClaimTaskCommand—
POST/api/tasks/completeCompleteTaskCommand—
POST/api/tasks/createCreateTaskCommand—
GET/api/tasks/minepageSizeoffsetcursorsortdescendingsearchgroupByclaimable—PageOfMyTaskDto
GET/api/tasks/mine/closedpageSizeoffsetcursorsortdescendingsearchgroupBy—PageOfMyTaskDto
POST/api/tasks/offer-to-groupOfferTaskToGroupCommand—
POST/api/tasks/rescheduleRescheduleTaskCommand—
tax8
MethodPathRequestResponse
GET/api/tax/registertaxTypeoperatingEntityIdcurrencyIddate—TaxRegister
GET/api/tax/register/periodstaxTypeoperatingEntityIdcurrencyId—TaxPeriod[]
GET/api/tax/settings/tax-configurations—TaxConfigurationDto[]
GET/api/tax/settings/tax-configurations/all—TaxConfigurationDto[]
GET/api/tax/settings/tax-rate-differencestaxType—TaxRateDifference[]
GET/api/tax/settings/tax-rules—TaxRuleDto[]
GET/api/tax/settings/tax-types—TaxTypeDto[]
GET/api/tax/splittransactionTypeIdcurrencypayerpayeevalueDateamounttotal—TaxSplit
term-settings1
MethodPathRequestResponse
GET/api/term-settings—TermSettings
trading-date1
MethodPathRequestResponse
GET/api/trading-date——
transaction-type-masters1
MethodPathRequestResponse
GET/api/transaction-type-masters——
treasury1
MethodPathRequestResponse
GET/api/treasury/cash-flowexternalAccountIdoperatingEntityId—CashFlowResponse
tsq6
MethodPathRequestResponse
GET/api/tsqcommandTypebatchIdlimitoffset——
POST/api/tsq/cancelCancelRequest—
POST/api/tsq/completeCompleteRequest—
GET/api/tsq/dead-lettersmessageTypeexceptionTypepagepageSize—DeadLetterListResponse
POST/api/tsq/dead-letters/{id}/replay——
POST/api/tsq/replayReplayRequest—
type-usage1
MethodPathRequestResponse
GET/api/type-usage/instances-missing-propertyvocabularytypepropertyphase——
types14
MethodPathRequestResponse
GET/api/types/account-families——
GET/api/types/collateral——
GET/api/types/counterparties——
GET/api/types/counterparties/{name}/layout——
GET/api/types/identifications—IdentificationTypeSummary[]
GET/api/types/operating-entities——
GET/api/types/operating-entities/{name}/layout——
GET/api/types/organisational-units——
GET/api/types/organisational-units/{name}/layout——
GET/api/types/relationships——
GET/api/types/roles——
GET/api/types/securities——
GET/api/types/structures——
GET/api/types/structures/{name}/layout——
virtual-accounts47
MethodPathRequestResponse
GET/api/virtual-accounts/books/{account}—AllocationBookView
GET/api/virtual-accounts/books/{account}/linesvirtualAccountpageSizeoffset—PageOfVirtualAccountLineView
POST/api/virtual-accounts/books/{account}/nodesOpenVirtualAccountRequest—
POST/api/virtual-accounts/books/{account}/nodes/{id}/closeCloseVirtualAccountRequest—
POST/api/virtual-accounts/books/{account}/nodes/{id}/placePlaceVirtualAccountRequest—
POST/api/virtual-accounts/books/{account}/nodes/{id}/renameRenameVirtualAccountRequest—
GET/api/virtual-accounts/books/{account}/proofspageSizeoffset—PageOfAllocationProofView
GET/api/virtual-accounts/books/{account}/reallocationspagepageSize—PageOfReallocationEntry
GET/api/virtual-accounts/books/{account}/records/{record}/interest-apportionment—InterestApportionmentView
POST/api/virtual-accounts/books/{account}/records/{record}/reallocateReallocateMovementRequest—
POST/api/virtual-accounts/books/{account}/records/{record}/reallocation-previewPreviewReallocationRequestReallocationPreview
GET/api/virtual-accounts/books/{account}/statement-subscriptions—StatementSubscriptionView[]
POST/api/virtual-accounts/books/{account}/statement-subscriptionsCreateStatementSubscriptionRequestStatementSubscriptionId
PUT/api/virtual-accounts/books/{account}/statement-subscriptions/{id}ChangeStatementSubscriptionRequest—
DELETE/api/virtual-accounts/books/{account}/statement-subscriptions/{id}——
GET/api/virtual-accounts/books/{account}/statementsnodeholder—IssuedStatementView[]
POST/api/virtual-accounts/books/{account}/statementsIssueVirtualAccountStatementRequestStatementId
GET/api/virtual-accounts/books/{account}/statements/camt053nodeholderfromto——
GET/api/virtual-accounts/interest-settings—VirtualInterestSettingView[]
PUT/api/virtual-accounts/interest-settings/{accountType}UpsertVirtualInterestRequest—
POST/api/virtual-accounts/nodes/{id}/attributeAttributeVirtualAccountRequest—
GET/api/virtual-accounts/nodes/{id}/availabilitybook—VirtualAccountAvailability
POST/api/virtual-accounts/nodes/{id}/holdsPlaceVirtualAccountHoldRequest—
POST/api/virtual-accounts/nodes/{id}/holds/{claimId}/releaseReleaseVirtualAccountHoldRequest—
GET/api/virtual-accounts/numbers/resolvemarketcodecountrynumber——
GET/api/virtual-accounts/rangespageSizeoffsetcursorsortdescendingholdertransitenrolment—PageOfVirtualAccountRangeRow
GET/api/virtual-accounts/ranges/{id}——
POST/api/virtual-accounts/ranges/{id}/issueIssueVirtualAccountNumbersRequest—
GET/api/virtual-accounts/ranges/{id}/numberspageSizeoffset——
GET/api/virtual-accounts/ranges/{id}/numbers/export——
POST/api/virtual-accounts/ranges/{id}/quarantineQuarantineVirtualAccountNumberRequest—
POST/api/virtual-accounts/ranges/{id}/quarantine-liveQuarantineLiveVirtualAccountNumbersRequest—
POST/api/virtual-accounts/ranges/{id}/repointRepointVirtualAccountRangeRequest—
POST/api/virtual-accounts/ranges/{id}/withdrawWithdrawVirtualAccountRangeRequest—
POST/api/virtual-accounts/statements/{id}/redeliver——
GET/api/virtual-accounts/transitspageSizeoffsetcursorsortdescending—PageOfVirtualTransitRow
POST/api/virtual-accounts/transitsOpenVirtualTransitCommand—
GET/api/virtual-accounts/transits/{id}——
PUT/api/virtual-accounts/transits/{id}AmendVirtualTransitRequest—
PUT/api/virtual-accounts/transits/{id}/permitted-jurisdictionsSetPermittedHolderJurisdictionsRequest—
POST/api/virtual-accounts/transits/{id}/rangesAssignVirtualAccountRangeRequest—
POST/api/virtual-accounts/transits/{id}/releaseReleaseVirtualTransitSerialsRequest—
POST/api/virtual-accounts/transits/{id}/set-asideSetAsideVirtualTransitSerialsRequest—
GET/api/virtual-accounts/unresolved-receiptsbookpagepageSizeoffset—PageOfUnresolvedReceipt
GET/api/virtual-accounts/unresolved-receipts/{id}—InboundResolutionView
POST/api/virtual-accounts/unresolved-receipts/{id}/closeCloseInboundResolutionRequest—
POST/api/virtual-accounts/unresolved-receipts/{id}/confirmConfirmInboundCandidateRequest—
vocabularies1
MethodPathRequestResponse
GET/api/vocabularies/{key}includeRetired——
warehouse4
MethodPathRequestResponse
GET/api/warehouse/reports/managementyearmonthstructureId—ManagementReportDto
GET/api/warehouse/reports/portfolio-movementfromYearfromMonthtoYeartoMonth—PortfolioMovementDto
GET/api/warehouse/runs—WarehouseRunDto[]
POST/api/warehouse/runsCutWarehouseRun—
whatsapp-messages1
MethodPathRequestResponse
GET/api/whatsapp-messagesownerIdpageSizeoffsetcursorsortdescending—PageOfWhatsAppMessageDto

A fintech can put its own app in front of these, and a partner its own interface, while your own integration team can read the groups it needs and size the work before anyone calls us.