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.
access-audit2
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/access-audit/session-ended | RecordAccessSessionEndedCommand | — |
POST | /api/access-audit/session-started | RecordAccessSessionStartedRequest | — |
account-role-types1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/account-role-types | — | — |
account-types13
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/account-typescounterpartyId | — | — |
POST | /api/account-types | CreateAccountType | — |
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-type | InstalmentType | — |
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/account-views | — | AccountViewDto[] |
POST | /api/account-views | SaveAccountView | — |
POST | /api/account-views/public | PublishAccountView | — |
accounting30
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/accounting/account-ledgers/open | RegisterAccountRequest | — |
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/upload | UploadInboundFileCommand | UploadInboundFileResponse |
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}/export | ExportJournalEntriesRequest | ExportJournalEntriesResponse |
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-revaluation | RunDailyFxRevaluationRequest | — |
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/accountscounterpartyIdstructureIdconveyancerIddealerIdawaitingFundingoperatingEntityIdorganisationalUnitIdincludeDescendantscostCentreIdaccountTypesproductsstatusmaturityFrommaturityTobalanceGroupbalanceMinbalanceMaxsearchsortBysortDirnextPaymentFromnextPaymentToscheduledFlowFromscheduledFlowToscheduledFlowCurrencypagepageSize | — | — |
POST | /api/accounts | CreateAccountRequest | — |
GET | /api/accounts/behind | — | AccountsBehindResult |
GET | /api/accounts/blocked-collections | — | BlockedCollectionDto[] |
POST | /api/accounts/catch-up | CatchUpAccountsRequest | — |
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-instalment | CreateAccountRequest | — |
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/allocate | AllocateSuspenseItemRequest | — |
POST | /api/accounts/suspense/unallocate | UnallocateSuspenseItemCommand | — |
PUT | /api/accounts/{accountId} | CreateAccountRequest | — |
DELETE | /api/accounts/{accountId} | — | — |
POST | /api/accounts/{accountId}/abandon-claim | AbandonClaimRequest | — |
POST | /api/accounts/{accountId}/acknowledge-debt | AcknowledgeDebtRequest | — |
POST | /api/accounts/{accountId}/activate | — | — |
GET | /api/accounts/{accountId}/authorisation-history | — | AuthorisationQueueReadModel[] |
POST | /api/accounts/{accountId}/books | OpenAccountBooksRequest | — |
POST | /api/accounts/{accountId}/cancel | — | — |
POST | /api/accounts/{accountId}/change-product | ChangeAccountProductRequest | — |
POST | /api/accounts/{accountId}/cost-centre | MoveAccountToCostCentreRequest | — |
POST | /api/accounts/{accountId}/cost-centre/cancel | — | — |
POST | /api/accounts/{accountId}/debit-order-replacement-preview | DebitOrderReplacementPreviewRequest | DebitOrderReplacementPreview |
POST | /api/accounts/{accountId}/discard-draft | — | — |
POST | /api/accounts/{accountId}/financial-change/consequences | FinancialConsequencesRequest | — |
POST | /api/accounts/{accountId}/forecast | ForecastRequest | — |
GET | /api/accounts/{accountId}/in-duplum | — | InDuplumStandingDto |
PUT | /api/accounts/{accountId}/instalment-plan | InstalmentPlanSnapshot | — |
GET | /api/accounts/{accountId}/limit-usagecounterpartyId | — | AccountLimitUsageDto |
GET | /api/accounts/{accountId}/notices | — | NoticeDto[] |
GET | /api/accounts/{accountId}/operationspermittedOnly | — | — |
POST | /api/accounts/{accountId}/operations/{operationName}/execute | ExecuteOperationRequest | — |
POST | /api/accounts/{accountId}/operations/{operationName}/preview | OperationPreviewRequest | — |
GET | /api/accounts/{accountId}/product-change-options | — | ProductChangeOption[] |
POST | /api/accounts/{accountId}/property-entries/amend | AmendScheduledPropertyChangeRequest | — |
POST | /api/accounts/{accountId}/property-entries/cancel | CancelScheduledPropertyChangeRequest | — |
POST | /api/accounts/{accountId}/property-entries/correct | CorrectPropertyEntryRequest | — |
PUT | /api/accounts/{accountId}/provision/assessment | AssessProvisionRequest | — |
DELETE | /api/accounts/{accountId}/provision/assessmentvalueDate | — | — |
PUT | /api/accounts/{accountId}/provision/stage-pin | PinProvisionStageRequest | — |
DELETE | /api/accounts/{accountId}/provision/stage-pinvalueDate | — | — |
GET | /api/accounts/{accountId}/rail-fee-quoteexternalAccountIdamount | — | RailFeeQuoteResponse |
POST | /api/accounts/{accountId}/restate-schedules | RestateAccountSchedulesRequest | — |
GET | /api/accounts/{accountId}/roles | — | — |
POST | /api/accounts/{accountId}/roles | JsonElement | — |
DELETE | /api/accounts/{accountId}/roles/{roleId}effectiveTo | — | — |
POST | /api/accounts/{accountId}/roles/{roleId}/replace-owning-party | ReplaceOwningPartyRequest | — |
POST | /api/accounts/{accountId}/rules | InstantiateAccountRuleRequest | — |
POST | /api/accounts/{accountId}/rules/end | EndAccountRuleRequest | — |
POST | /api/accounts/{accountId}/rules/properties/amend | AmendAccountRulePropertyRequest | — |
POST | /api/accounts/{accountId}/sandbox/draft-forecast | DraftForecastRequest | — |
POST | /api/accounts/{accountId}/sandbox/forecast | SandboxForecastRequest | — |
POST | /api/accounts/{accountId}/sandbox/instalment-preview | SandboxPreviewRequest | — |
POST | /api/accounts/{accountId}/sandbox/preview | SandboxPreviewRequest | — |
GET | /api/accounts/{accountId}/settlement-quotes | — | SettlementQuoteDto[] |
GET | /api/accounts/{accountId}/statements | — | StatementDto[] |
POST | /api/accounts/{accountId}/statements/ad-hoc | IssueAdHocStatementRequest | — |
GET | /api/accounts/{accountId}/statements/camt053fromto | — | — |
POST | /api/accounts/{accountId}/studio/stage | StageAccountOperationCommand | — |
POST | /api/accounts/{accountId}/studio/stage-plan | StageRevisedPlanCommand | StageAccountOperationResponse |
GET | /api/accounts/{accountId}/transactionspageSizeoffsetcursorsortdescendingsearchfromto | — | PageOfTransactionHistoryView |
POST | /api/accounts/{accountId}/transactions | PostTransactionRequest | — |
GET | /api/accounts/{accountId}/transactions/exportsearchfromto | — | — |
POST | /api/accounts/{accountId}/transactions/{transactionId}/move-to-suspense | MoveTransactionToSuspenseRequest | — |
POST | /api/accounts/{accountId}/transactions/{transactionId}/reverse | — | — |
POST | /api/accounts/{accountId}/unwind-settlement | — | — |
GET | /api/accounts/{accountId}/views | — | AccountViewsOnOffer |
POST | /api/accounts/{accountId}/write-off | WriteOffAccountRequest | — |
GET | /api/accounts/{id} | — | — |
GET | /api/accounts/{id}/detail | — | AccountDetailDto |
GET | /api/accounts/{id}/financial-summary | — | — |
POST | /api/accounts/{id}/instrument-redemptions | RecordInstrumentRedemptionCommand | — |
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-designation | MoveServicingDesignationRequest | — |
POST | /api/accounts/{id}/servicing-unit | MoveAccountToOrganisationalUnitRequest | — |
POST | /api/accounts/{id}/servicing-unit/cancel | CancelAccountTransferRequest | — |
GET | /api/accounts/{id}/write-off-preview | — | — |
acquiring15
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/acquiring/feed-batchesfromtoagreement | — | AcquiringFeedBatch[] |
POST | /api/acquiring/feed-batches/{batch}/lines/{reference}/hold | HoldStrandedFeedLineRequest | — |
POST | /api/acquiring/feed-batches/{batch}/lines/{reference}/release | ReleaseSponsorMismatchLineRequest | — |
GET | /api/acquiring/feed-batches/{id} | — | — |
GET | /api/acquiring/scheme-settlement | — | SchemeSettlementSettings |
GET | /api/acquiring/scheme-settlement/accountsoperatingEntity | — | SchemeSettlementAccountRow[] |
POST | /api/acquiring/scheme-settlement/elect | ElectSchemeSettlementCurrencyCommand | — |
POST | /api/acquiring/scheme-settlement/nostro | SetSchemeSettlementNostroCommand | — |
GET | /api/acquiring/scheme-settlement/positionoperatingEntitysponsorschemecurrencysettlementDate | — | SchemeSettlementPosition |
POST | /api/acquiring/scheme-settlement/sponsor-rules | SetSponsorRulesCommand | — |
POST | /api/acquiring/scheme-settlement/sponsors | AddSponsorCommand | — |
POST | /api/acquiring/scheme-settlement/sponsors/{sponsor}/identifiers | SetSchemeAcquirerIdentifiersRequest | — |
POST | /api/acquiring/scheme-settlement/sponsors/{sponsor}/paying-accounts | SetSponsorPayingAccountCommand | — |
POST | /api/acquiring/scheme-settlement/sponsors/{sponsor}/remove | — | — |
POST | /api/acquiring/scheme-settlement/withdraw | WithdrawSchemeSettlementCurrencyCommand | — |
address-search3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/address-search/detailsplaceIdsessionToken | — | — |
GET | /api/address-search/status | — | — |
GET | /api/address-search/suggestqsessionToken | — | — |
admin41
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/admin/ceiling-breachesfromto | — | CeilingBreachRow[] |
GET | /api/admin/grant-ceilings/ceilablekeys | — | string[] |
POST | /api/admin/grant-ceilings/remove | RemoveGrantCeilingCommand | — |
POST | /api/admin/grant-ceilings/set | SetGrantCeilingCommand | — |
GET | /api/admin/machine-principals | — | MachinePrincipalRow[] |
POST | /api/admin/machine-principals | RegisterMachinePrincipalRequest | MachinePrincipalRow |
POST | /api/admin/machine-principals/agents | RegisterAgentPrincipalRequest | MachinePrincipalRow |
GET | /api/admin/machine-principals/attemptsfromtoclientId | — | MachineResolutionAttempt[] |
POST | /api/admin/machine-principals/{id}/rate-limit | ChangeMachinePrincipalRateLimit | — |
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/preview | CompositionRequest | — |
GET | /api/admin/tenants/layers | — | — |
POST | /api/admin/tenants/provision | ProvisionTenantRequest | — |
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-groups | CreateUserGroupCommand | — |
POST | /api/admin/user-groups/grant-matching | GrantPermissionsMatchingCommand | — |
POST | /api/admin/user-groups/grant-permission | GrantPermissionToGroupCommand | — |
POST | /api/admin/user-groups/rename | RenameUserGroupCommand | — |
POST | /api/admin/user-groups/revoke-permission | RevokePermissionFromGroupCommand | — |
GET | /api/admin/user-groups/{groupId}/ceilings | — | GroupActionCeiling[] |
GET | /api/admin/users | — | ListUsersResponse |
POST | /api/admin/users/admissible | ListAdmissibleUsersQuery | ListAdmissibleUsersResponse |
POST | /api/admin/users/admit | AdmitUserToTenantCommand | — |
POST | /api/admin/users/assign-to-group | AssignUserToGroupCommand | — |
POST | /api/admin/users/deactivate | DeactivateMemberCommand | — |
POST | /api/admin/users/remove-from-group | RemoveUserFromGroupCommand | — |
GET | /api/admin/users/{id}/history | — | — |
POST | /api/admin/users/{memberId}/photo | SetMemberPhotoCommand | — |
DELETE | /api/admin/users/{memberId}/photo | — | — |
POST | /api/admin/users/{memberId}/profile | UpdateMemberProfileCommand | — |
GET | /api/admin/users/{userId}/effective-ceilings | — | EffectiveCeiling[] |
alerts4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/alertsaggregateIdpageSizeoffsetcursorsortdescendingsearch | — | PageOfAlertDto |
POST | /api/alerts/create | CreateAlertCommand | — |
POST | /api/alerts/delete | DeleteAlertCommand | — |
POST | /api/alerts/update | UpdateAlertCommand | — |
approver-credentials5
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/approver-credentials | — | ApproverCredentialSummary[] |
POST | /api/approver-credentials | CompleteApproverCredentialEnrolmentRequest | ApproverCredentialSummary |
POST | /api/approver-credentials/registration-options | — | ApproverCredentialRegistrationOptionsResponse |
POST | /api/approver-credentials/{id}/push-subscription | RegisterPushSubscriptionRequest | — |
POST | /api/approver-credentials/{id}/revoke | — | — |
assistant6
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/assistant/ask | AskAssistantRequest | — |
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/attachmentsaggregateIdpageSizeoffsetcursorsortdescendingsearch | — | PageOfAttachmentDto |
POST | /api/attachments/create | CreateAttachmentCommand | — |
POST | /api/attachments/delete | DeleteAttachmentCommand | — |
POST | /api/attachments/update | UpdateAttachmentCommand | — |
audit7
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/audit/revaluation-parity/run | RunRevaluationParityRequest | RevaluationParityRunSummaryDto |
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
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/auth/resolve | — | — |
POST | /api/auth/resolve-machine | — | MachineResolutionResult |
POST | /api/auth/sign-in-attempt | — | — |
authorisation3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/authorisation/actions/pickable | — | ListPickableActionsResponse |
GET | /api/authorisation/approval-rules | — | ApprovalRule[] |
GET | /api/authorisation/approval-rules/all | — | ApprovalRule[] |
authorisations13
| Method | Path | Request | Response |
|---|---|---|---|
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-resolve | ForceResolveRequest | — |
GET | /api/authorisations/{id}/quorum-drivers | — | — |
POST | /api/authorisations/{id}/reject | RejectAuthorisationRequest | — |
POST | /api/authorisations/{id}/retract-approval | — | — |
POST | /api/authorisations/{id}/signed-challenge | SignedChallengeRequest | SignedChallengeResponse |
POST | /api/authorisations/{id}/signed-decision | SubmitSignedDecisionRequest | — |
GET | /api/authorisations/{id}/timeline | — | AuthorisationTimelineEntry[] |
POST | /api/authorisations/{id}/withdraw | — | — |
balance-groups2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/balance-groups | — | — |
GET | /api/balance-groups/ungrouped-positions | — | — |
bank-deposits8
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/bank-depositsaccountIdpageSizeoffsetcursorsortdescendingsearch | — | PageOfBankDepositDto |
POST | /api/bank-deposits/deposit | BankDepositCommand | — |
POST | /api/bank-deposits/match | MatchDepositCommand | — |
GET | /api/bank-deposits/matching-rulesaccountId | — | MatchingRuleDto[] |
POST | /api/bank-deposits/matching-rules/create | CreateMatchingRuleCommand | — |
POST | /api/bank-deposits/matching-rules/delete | DeleteMatchingRuleCommand | — |
POST | /api/bank-deposits/matching-rules/edit | EditMatchingRuleCommand | — |
GET | /api/bank-deposits/operating-entityoperatingEntityIdpageIndexpageSizeexternalAccountId | — | ListOperatingEntityBankDepositsResponse |
bank-statements17
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/bank-statementsexternalAccountIdpageSizeoffsetcursorsortdescendingsearch | — | PageOfBankStatementDto |
GET | /api/bank-statements/daysexternalAccountIdpageSizeoffset | — | PageOfStatementDayDto |
POST | /api/bank-statements/deliveries | StatementDelivery | StatementPushResult |
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/import | ImportStatementCommand | StatementImportResult |
GET | /api/bank-statements/journeystatementLineIdopenItemIdaccountTransactionId | — | ReceiptJourneyNode |
GET | /api/bank-statements/matchingexternalAccountIdstatuspageSizeoffsetcursorsortdescending | — | PageOfMatchDto |
POST | /api/bank-statements/matching/confirm | ConfirmMatchCommand | — |
POST | /api/bank-statements/matching/match-to-deposit | MatchLineToDepositCommand | — |
POST | /api/bank-statements/matching/park-to-suspense | ParkLineToSuspenseCommand | — |
POST | /api/bank-statements/matching/reject | RejectMatchCommand | — |
POST | /api/bank-statements/matching/run | RunMatchingCommand | — |
GET | /api/bank-statements/{id} | — | GetStatementResponse |
banks2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/banks | — | — |
GET | /api/banks/all | — | — |
batch1
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/batch/day-end | ProcessDayEndRequest | — |
batch-ops3
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/batch-ops/data-init | DataInitRequest | — |
GET | /api/batch-ops/data-init/available-deals | — | — |
GET | /api/batch-ops/data-init/available-types | — | — |
batches2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/batchesstatusbatchTypepageSizeoffsetcursorsortdescendinggroupBy | — | PageOfBatchRecord |
GET | /api/batches/{id} | — | BatchDetailResponse |
card-disputes6
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/card-disputes | RaiseCardDisputeCommand | — |
GET | /api/card-disputes/{id} | — | — |
POST | /api/card-disputes/{id}/concede | ConcedeCardDisputeCommand | — |
POST | /api/card-disputes/{id}/escalate | EscalateCardDisputeCommand | — |
POST | /api/card-disputes/{id}/evidence | RecordCardDisputeEvidenceCommand | — |
POST | /api/card-disputes/{id}/withdraw | WithdrawCardDisputeCommand | — |
cards32
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/cards | IssueCardCommand | — |
POST | /api/cards/authorisations/decide | JsonElement | — |
POST | /api/cards/authorisations/reverse | JsonElement | CardReversalReceipt |
GET | /api/cards/clearingfromto | — | CardClearingBatchRow[] |
POST | /api/cards/disputes/update | JsonElement | CardDisputeUpdateReceipt |
GET | /api/cards/receiptsfromto | — | CardProcessorReceiptRow[] |
POST | /api/cards/simulation/authorise | SimulateCardAuthorisationCommand | — |
POST | /api/cards/simulation/provision-token | SimulateCardTokenProvisioningCommand | — |
POST | /api/cards/simulation/refund | SimulateCardRefundCommand | — |
POST | /api/cards/simulation/reverse | SimulateCardAuthorisationReversalCommand | — |
POST | /api/cards/tokens/decide | JsonElement | — |
GET | /api/cards/{id} | — | CardSummary |
POST | /api/cards/{id}/activate | ActivateCardCommand | — |
GET | /api/cards/{id}/authorisationspageSizeoffsetcursorsortdescending | — | — |
GET | /api/cards/{id}/available-to-spend | — | — |
POST | /api/cards/{id}/close | CloseCardCommand | — |
POST | /api/cards/{id}/controls | SetCardControlsCommand | — |
POST | /api/cards/{id}/credentials/remove | RemoveCardCredentialCommand | — |
GET | /api/cards/{id}/disputes | — | — |
POST | /api/cards/{id}/funding-rule | SetCardFundingRuleCommand | — |
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}/reinstate | ReinstateCardCommand | — |
POST | /api/cards/{id}/reissue | ReissueCardCommand | — |
POST | /api/cards/{id}/rename | RenameCardCommand | — |
POST | /api/cards/{id}/report-lost-or-stolen | ReportCardLostOrStolenCommand | — |
POST | /api/cards/{id}/reveal | RevealCardCommand | — |
POST | /api/cards/{id}/suspend | SuspendCardCommand | — |
POST | /api/cards/{id}/travel-window | SetCardTravelWindowCommand | — |
POST | /api/cards/{id}/valid-until | SetCardValidUntilCommand | — |
cashier16
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/cashier/accountsbranchId | — | CashierAccountSummary[] |
POST | /api/cashier/deposit | DepositCommand | — |
GET | /api/cashier/differencesbranchIdfromto | — | TellerDifference[] |
POST | /api/cashier/draws | DrawCashCommand | DrawCashResponse |
POST | /api/cashier/lodgements | LodgeCashCommand | LodgeCashResponse |
GET | /api/cashier/lodgements/{id} | — | LodgementReadModel |
POST | /api/cashier/sessions/close | CloseSessionCommand | CloseSessionResponse |
POST | /api/cashier/sessions/correct-count | CorrectCountCommand | — |
GET | /api/cashier/sessions/mine | — | MySession |
POST | /api/cashier/sessions/open | OpenSessionCommand | OpenSessionResponse |
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/transfers | TransferCashCommand | TransferCashResponse |
POST | /api/cashier/withdraw | WithdrawCommand | — |
change-sets5
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/change-sets/openaggregateTypeid | — | OpenChangeSetView |
POST | /api/change-sets/open | OpenChangeSetCommand | ChangeSetId |
POST | /api/change-sets/{id}/changes/{position}/unstage | UnstageChangeCommand | — |
POST | /api/change-sets/{id}/discard | — | — |
POST | /api/change-sets/{id}/submit | — | — |
channel-participants1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/channel-participants | — | ChannelParticipantView[] |
channel-service-agreements7
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/channel-service-agreements | RecordChannelServiceAgreementCommand | ChannelServiceAgreementId |
POST | /api/channel-service-agreements/amend-accounts | AmendChannelServiceAgreementAccountsCommand | — |
POST | /api/channel-service-agreements/officers/record | RecordSigningOfficerCommand | — |
POST | /api/channel-service-agreements/officers/withdraw | WithdrawSigningOfficerCommand | — |
POST | /api/channel-service-agreements/rename | RenameChannelServiceAgreementCommand | — |
POST | /api/channel-service-agreements/signature-count | SetRequiredSignatureCountCommand | — |
GET | /api/channel-service-agreements/{agreement} | — | ChannelServiceAgreementDetail |
channel-users4
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/channel-users | RegisterChannelUserCommand | ChannelUserId |
POST | /api/channel-users/person-link | LinkChannelUserToPersonCommand | — |
POST | /api/channel-users/register-by-bank | RegisterChannelUserByBankCommand | ChannelUserId |
POST | /api/channel-users/restore-access | RestoreChannelAccessCommand | ChannelUserId |
charge-periods2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/charge-periods/months/{month}pageSizeoffsetcursorsortdescendinggroupBy | — | PageOfChargePeriodSummary |
GET | /api/charge-periods/{period} | — | ChargePeriodDetail |
client-identities8
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/client-identities/disable | DisableClientIdentityCommand | — |
POST | /api/client-identities/enable | EnableClientIdentityCommand | — |
POST | /api/client-identities/invite | InviteClientUserCommand | ClientIdentityId |
POST | /api/client-identities/list | ListClientIdentitiesQuery | ClientIdentityView[] |
POST | /api/client-identities/resend | ResendClientInvitationCommand | — |
POST | /api/client-identities/reset-sign-in | ResetClientSignInCommand | — |
POST | /api/client-identities/retry-setup | RetryClientDirectorySetupCommand | — |
POST | /api/client-identities/withdraw | WithdrawClientInvitationCommand | — |
collateral5
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/collateralownerId | — | CollateralSummary[] |
POST | /api/collateral/manual-valuation | RecordManualValuationCommand | — |
POST | /api/collateral/market-valuation | RecordMarketValuationCommand | — |
POST | /api/collateral/register | RegisterCollateralCommand | — |
POST | /api/collateral/release | ReleaseCollateralCommand | — |
collect8
| Method | Path | Request | Response |
|---|---|---|---|
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/collection-authoritiesaccountIdexternalAccountIdcounterpartyId | — | CollectionAuthorityDto[] |
POST | /api/collection-authorities | RequestCollectionAuthorityCommand | — |
PUT | /api/collection-authorities/amend | AmendCollectionAuthorityCommand | — |
POST | /api/collection-authorities/cancel | CancelCollectionAuthorityCommand | — |
POST | /api/collection-authorities/record-outcome | RecordCollectionAuthorityOutcomeCommand | — |
GET | /api/collection-authorities/standingaccountIdexternalAccountId | — | CollectionAuthorityStandingDto |
GET | /api/collection-authorities/{id} | — | — |
collections20
| Method | Path | Request | Response |
|---|---|---|---|
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-hold | ApplyHoldStatusToCaseCommand | — |
POST | /api/collections/cases/claim | ClaimCounterpartyCasesCommand | — |
POST | /api/collections/cases/hand-off | HandOffCollectionCaseCommand | — |
POST | /api/collections/cases/lift-hold | LiftHoldStatusOnCaseCommand | — |
POST | /api/collections/cases/outcome | RecordCaseOutcomeCommand | — |
POST | /api/collections/cases/reallocate | ReallocateCollectorCommand | — |
GET | /api/collections/cases/{accountId} | — | — |
POST | /api/collections/default-process/issue-enforcement-notice | IssueEnforcementNoticeCommand | — |
GET | /api/collections/promisesaccountId | — | — |
POST | /api/collections/promises | CreatePromiseToPayCommand | — |
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-due | RecordAmountDueOnAgedDebtorCommand | — |
POST | /api/collections/record-amount-paid | RecordPaymentOnAgedDebtorCommand | — |
GET | /api/collections/work-case/{caseId} | — | — |
commands2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/commandsstatuscommandTypebatchIdsessionIdpageSizeoffsetcursorsortdescendinggroupBy | — | PageOfCommandRecord |
GET | /api/commands/{id} | — | CommandRecord |
compliance33
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/compliance/clearance-requirements/{counterpartyTypeName} | — | ClearanceRequirement |
POST | /api/compliance/clearances/evidence/record | RecordClearanceEvidenceCommand | — |
POST | /api/compliance/clearances/evidence/withdraw | WithdrawClearanceEvidenceCommand | — |
POST | /api/compliance/clearances/freeze | FreezeClearanceCommand | — |
POST | /api/compliance/clearances/refuse | RefuseClearanceCommand | — |
POST | /api/compliance/clearances/unfreeze | UnfreezeClearanceCommand | — |
POST | /api/compliance/clearances/verify | VerifyClearanceCommand | — |
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/disposition | DispositionSuspicionReportCommand | — |
POST | /api/compliance/suspicion-reports/raise | RaiseSuspicionReportCommand | — |
POST | /api/compliance/tax-residencies/cease | CeaseTaxResidencyCommand | — |
POST | /api/compliance/tax-residencies/correct | CorrectTaxResidencyCommand | — |
POST | /api/compliance/tax-residencies/declare | DeclareTaxResidencyCommand | — |
GET | /api/compliance/tax-residencies/{counterpartyId} | — | TaxResidencySummary[] |
GET | /api/compliance/threshold-reports | — | ThresholdReportSummary[] |
POST | /api/compliance/threshold-reports/disposition | DispositionThresholdReportCommand | — |
connections1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/connections/whoami | — | ConnectionIdentity |
contacts3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/contactspageSizeoffsetcursorsortdescendingsearchtypestatusregisteredFromregisteredTo | — | — |
GET | /api/contacts/exportsortdescendingsearchtypestatusregisteredFromregisteredTo | — | — |
GET | /api/contacts/searchq | — | — |
correspondence20
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/correspondenceaboutdocumentaccountpageSizeoffsetcursorsortdescendingsearch | — | PageOfCorrespondenceDto |
GET | /api/correspondence/channelsall | — | AvailableChannelDto[] |
POST | /api/correspondence/delivery-addresses/add | AddDeliveryAddressCommand | — |
POST | /api/correspondence/delivery-addresses/remove | RemoveDeliveryAddressCommand | — |
POST | /api/correspondence/delivery-preferences/clear | ClearDeliveryPreferenceCommand | — |
POST | /api/correspondence/delivery-preferences/set | SetDeliveryPreferenceCommand | — |
GET | /api/correspondence/email/gateways | — | EmailGatewayDto[] |
POST | /api/correspondence/email/gateways/retire | RetireEmailGatewayCommand | — |
GET | /api/correspondence/email/sender-rules | — | SenderRulesDto |
POST | /api/correspondence/forward | ForwardCorrespondenceCommand | — |
GET | /api/correspondence/post-queuedocumentstatuspageSizeoffsetcursorsortdescendingsearch | — | PageOfPostalItemDto |
POST | /api/correspondence/post-queue/posted | RecordPostedDespatchCommand | — |
POST | /api/correspondence/post-queue/returned | RecordPostalReturnCommand | — |
POST | /api/correspondence/resend | ResendCorrespondenceChannelCommand | — |
GET | /api/correspondence/sms/gateways | — | SmsGatewayDto[] |
POST | /api/correspondence/sms/gateways/retire | RetireSmsGatewayCommand | — |
GET | /api/correspondence/types | — | CorrespondenceTypeDto[] |
GET | /api/correspondence/whatsapp/gateways | — | WhatsAppGatewayDto[] |
POST | /api/correspondence/whatsapp/gateways/retire | RetireWhatsAppGatewayCommand | — |
GET | /api/correspondence/whatsapp/gateways/{key}/templates | — | WhatsAppTemplate[] |
cost-centres11
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/cost-centres | RegisterCostCentre | — |
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}/code | ChangeCostCentreCodeRequest | — |
GET | /api/cost-centres/{id}/financial-summary | — | — |
POST | /api/cost-centres/{id}/gl-reference | ChangeCostCentreGLReferenceRequest | — |
GET | /api/cost-centres/{id}/operationspermittedOnly | — | — |
GET | /api/cost-centres/{id}/scheduled-moves | — | — |
counterparties38
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/counterparties/hold/lift | LiftHoldCommand | — |
POST | /api/counterparties/hold/place | PlaceHoldCommand | — |
GET | /api/counterparties/lookup/{id} | — | — |
GET | /api/counterparties/potential-duplicatesnameemailAddressmobileNumberexcluding | — | — |
GET | /api/counterparties/settings/former-value-disclosure | — | FormerValueDisclosureDto |
POST | /api/counterparties/settings/former-value-disclosure | SetFormerValueDisclosureCommand | — |
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/amend | AmendScheduledCounterpartyPropertyChangeRequest | — |
POST | /api/counterparties/{counterpartyId}/property-entries/cancel | CancelScheduledCounterpartyPropertyChangeRequest | — |
POST | /api/counterparties/{counterpartyId}/property-entries/correct | CorrectCounterpartyPropertyEntryRequest | — |
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}/execute | ExecuteCounterpartyOperationRequest | — |
GET | /api/counterparties/{id}/roles | — | — |
POST | /api/counterparties/{id}/roles | JsonElement | — |
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/counterparty-balancesids | — | — |
counterparty-types1
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/counterparty-types/yaml | — | — |
countries2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/countries | — | — |
GET | /api/countries/all | — | — |
credit-limits7
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/credit-limitscounterpartyId | — | CreditLimitDto |
POST | /api/credit-limits | CreateCreditLimitCommand | — |
GET | /api/credit-limits/by-idcreditLimitId | — | CreditLimitDto |
POST | /api/credit-limits/decrease | DecreaseCreditLimitCommand | — |
POST | /api/credit-limits/freeze | FreezeCreditLimitCommand | — |
POST | /api/credit-limits/increase | IncreaseCreditLimitCommand | — |
POST | /api/credit-limits/unfreeze | UnfreezeCreditLimitCommand | — |
credit-risk3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/credit-risk/provision-matrices | — | ProvisionMatrixView[] |
GET | /api/credit-risk/provision-matrices/{key} | — | — |
GET | /api/credit-risk/provision-matrices/{key}/products | — | ProductRef[] |
currencies7
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/currencies | — | — |
GET | /api/currencies/all | — | — |
GET | /api/currencies/rate-feed | — | RateFeedPolicyResponse |
POST | /api/currencies/rates | UpsertExchangeRateCommand | — |
POST | /api/currencies/rates/carry-forward | CarryForwardExchangeRatesCommand | — |
POST | /api/currencies/rates/mark-final | MarkExchangeRatesFinalCommand | — |
GET | /api/currencies/rates/matrixeffectiveDate | — | — |
day-count-conventions1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/day-count-conventions | — | DayCountConventionRow[] |
day-end12
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/day-end/abort | AbortDayEndRunCommand | — |
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/run | RunDayEndRequest | — |
POST | /api/day-end/run-forward | RunForwardRequest | — |
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/debit-ordersaccountId | — | DebitOrderDto[] |
POST | /api/debit-orders/adjust-amount | AdjustDebitOrderAmountCommand | — |
GET | /api/debit-orders/allpageSizeoffsetcursorsortdescendingsearch | — | PageOfAllDebitOrderDto |
GET | /api/debit-orders/all/exportsortdescendingsearch | — | — |
POST | /api/debit-orders/cancel | CancelDebitOrderCommand | — |
POST | /api/debit-orders/change-external-account | ChangeDebitOrderExternalAccountCommand | — |
GET | /api/debit-orders/external-accountexternalAccountId | — | ExternalAccountInstructionDto[] |
POST | /api/debit-orders/reschedule | RescheduleDebitOrderCommand | — |
POST | /api/debit-orders/schedule | ScheduleDebitOrderRequest | — |
designer1
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/designer/forecast | DesignerForecastRequest | — |
direct-credits16
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/direct-creditsaccountIdpageIndexpageSize | — | ListAccountDirectCreditsResponse |
GET | /api/direct-credits/allpageSizeoffsetcursorsortdescendingsearch | — | PageOfAllDirectCreditDto |
GET | /api/direct-credits/all/exportsortdescendingsearch | — | — |
POST | /api/direct-credits/approve | ApproveDirectCreditCommand | — |
POST | /api/direct-credits/approve-operating-entity | ApproveOperatingEntityDirectCreditsCommand | ApprovedDirectCredits |
POST | /api/direct-credits/change-external-account | ChangeDirectCreditExternalAccountCommand | — |
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/reject | RejectDirectCreditCommand | — |
POST | /api/direct-credits/release | ReleaseDirectCreditCommand | — |
POST | /api/direct-credits/request | InitiateDirectCreditInstructionRequest | — |
POST | /api/direct-credits/submit-operating-entity | SubmitOperatingEntityDirectCreditsCommand | — |
GET | /api/direct-credits/{id}/instant-step | — | InstantDirectCreditStepView |
direct-debits14
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/direct-debitsaccountIdpageIndexpageSize | — | ListAccountDirectDebitsResponse |
GET | /api/direct-debits/allpageSizeoffsetcursorsortdescendingsearch | — | PageOfAllDirectDebitDto |
GET | /api/direct-debits/all/exportsortdescendingsearch | — | — |
POST | /api/direct-debits/approve | ApproveDirectDebitCommand | — |
POST | /api/direct-debits/approve-operating-entity | ApproveOperatingEntityDirectDebitsCommand | — |
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/reject | RejectDirectDebitCommand | — |
POST | /api/direct-debits/request | InitiateDirectDebitInstructionRequest | — |
POST | /api/direct-debits/return-not-authorised | ReturnDirectDebitNotAuthorisedCommand | — |
POST | /api/direct-debits/submit-operating-entity | SubmitOperatingEntityDirectDebitsCommand | — |
document-templates17
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/document-templates/assets | — | TemplateAsset[] |
POST | /api/document-templates/assets/file | — | FileRef |
GET | /api/document-templates/data-sourcestype | — | DataSourceDto[] |
POST | /api/document-templates/draft | EditDocumentTemplateDraftCommand | — |
GET | /api/document-templates/layout-purposes | — | [] |
GET | /api/document-templates/modelsvariant | — | TemplateModelDto[] |
GET | /api/document-templates/previewtemplate | — | TemplateRenderOutcome |
POST | /api/document-templates/publish | PublishDocumentTemplateCommand | — |
POST | /api/document-templates/restore | RestoreDocumentTemplateVersionCommand | — |
POST | /api/document-templates/retire | RetireDocumentTemplateCommand | — |
POST | /api/document-templates/send-test | SendTemplateTestCommand | — |
GET | /api/document-templates/snippets | — | [] |
POST | /api/document-templates/template | GetDocumentTemplateQuery | DocumentTemplateDto |
GET | /api/document-templates/versionstemplate | — | DocumentTemplatePublished[] |
GET | /api/document-templates/word-drafttemplate | — | — |
POST | /api/document-templates/word-draft | UploadDocumentTemplateDraftCommand | — |
POST | /api/document-templates/word-file | — | FileRef |
document-types2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/document-types | — | DocumentTypeRow[] |
GET | /api/document-types/{key}/starter | — | — |
documents6
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/documentsrecordtype | — | ProducedDocumentDto[] |
POST | /api/documents/preview | PreviewDocumentQuery | — |
POST | /api/documents/produce | ProduceDocumentCommand | — |
GET | /api/documents/produciblerecord | — | ProducibleDocumentDto[] |
POST | /api/documents/save | SaveProducedDocumentCommand | — |
POST | /api/documents/send-again | SendDocumentAgainCommand | — |
email-messages1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/email-messagesownerIdpageSizeoffsetcursorsortdescendingsearch | — | PageOfEmailMessageDto |
expected-items4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/expected-itemsexternalAccountIdoperatingEntityIdstatuspageSizeoffsetcursorsortdescendingsearch | — | PageOfExpectedItemDto |
POST | /api/expected-items | RecordManualExpectedItemCommand | — |
POST | /api/expected-items/invoices | RecordExpectedInvoicesCommand | — |
POST | /api/expected-items/{id}/withdraw | WithdrawExpectedInvoiceCommand | — |
external-accounts22
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/external-accountscounterpartyIdcurrencyId | — | ExternalAccountDto[] |
POST | /api/external-accounts | RegisterExternalAccountCommand | — |
POST | /api/external-accounts/add-proxy | AddExternalAccountProxyCommand | — |
GET | /api/external-accounts/approved-beneficiaries | — | ApprovedBeneficiaryDto[] |
POST | /api/external-accounts/approved-beneficiaries | AddApprovedBeneficiaryCommand | — |
GET | /api/external-accounts/audit-payable-destinations | — | AuditPayableDestinationsResult |
GET | /api/external-accounts/by-idexternalAccountId | — | GetExternalAccountResponse |
POST | /api/external-accounts/capture-proxy-beneficiary | CaptureProxyBeneficiaryCommand | — |
POST | /api/external-accounts/change-description | ChangeExternalAccountDescriptionCommand | — |
POST | /api/external-accounts/change-identifier | ChangeExternalAccountIdentifierCommand | — |
POST | /api/external-accounts/close | CloseExternalAccountCommand | — |
POST | /api/external-accounts/designate-approved-beneficiary | DesignateApprovedBeneficiaryCommand | — |
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-proxy | RemoveExternalAccountProxyCommand | — |
GET | /api/external-accounts/resolve-proxykindvalueexternalAccountId | — | ResolveProxyResponse |
POST | /api/external-accounts/revoke-approved-beneficiary | RevokeApprovedBeneficiaryCommand | — |
POST | /api/external-accounts/set-beneficiary-notification-contacts | SetBeneficiaryNotificationContactsCommand | — |
POST | /api/external-accounts/set-beneficiary-references | SetBeneficiaryReferencesCommand | — |
POST | /api/external-accounts/simulation/return-marker | MarkExternalAccountForReturnRequest | — |
POST | /api/external-accounts/transfer | TransferExternalAccountCommand | — |
facilities7
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/facilitiescounterpartyId | — | FacilityDto[] |
GET | /api/facilities/by-idfacilityId | — | FacilityDto |
POST | /api/facilities/decrease | DecreaseFacilityCommand | — |
POST | /api/facilities/freeze | FreezeFacilityCommand | — |
POST | /api/facilities/grant | GrantFacilityCommand | — |
POST | /api/facilities/increase | IncreaseFacilityCommand | — |
POST | /api/facilities/unfreeze | UnfreezeFacilityCommand | — |
facility-types2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/facility-types | — | — |
GET | /api/facility-types/all | — | — |
features4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/features | — | FeatureRow[] |
POST | /api/features/enable | SetFeatureEnabledCommand | — |
POST | /api/features/license | LicenseFeatureCommand | — |
GET | /api/features/{key}/disable-impact | — | — |
files1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /files/{id} | — | — |
format-profiles3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/format-profilesbankIdentifierpageIndexpageSize | — | ListFormatProfilesResponse |
POST | /api/format-profiles/approve | ApproveFormatProfileCommand | — |
POST | /api/format-profiles/propose | ProposeFormatProfileFromSampleCommand | — |
fx-transfers8
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/fx-transfersclientpageIndexpageSize | — | FxTransferRow[] |
POST | /api/fx-transfers/approve | ApproveFxTransferCommand | — |
POST | /api/fx-transfers/cancel | CancelFxTransferCommand | — |
POST | /api/fx-transfers/decline | DeclineFxTransferQuoteCommand | — |
POST | /api/fx-transfers/quote | QuoteFxTransferCommand | FxTransferQuoteView |
POST | /api/fx-transfers/raise | RaiseFxTransferCommand | — |
POST | /api/fx-transfers/release | ReleaseFxTransferCommand | — |
GET | /api/fx-transfers/{id}/quote | — | FxTransferQuoteView |
health1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /health | — | — |
identifications4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/identificationsholderId | — | IdentificationSummary[] |
POST | /api/identifications/correct | CorrectIdentificationCommand | — |
POST | /api/identifications/record | RecordIdentificationCommand | — |
POST | /api/identifications/withdraw | WithdrawIdentificationCommand | — |
import7
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/import | — | ImportPageView |
POST | /api/import/abandon | AbandonImportRun | — |
POST | /api/import/runs | StartImportRun | — |
POST | /api/import/selection | SelectAccounts | — |
POST | /api/import/steps | StartStep | — |
POST | /api/import/steps/rerun | RerunStep | — |
GET | /api/import/steps/{step}/history | — | StepAttemptView[] |
iso-countries1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/iso-countries | — | — |
labels1
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/labels | ResolveLabelsRequest | — |
languages2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/languages | — | — |
GET | /api/languages/all | — | — |
limit8
| Method | Path | Request | Response |
|---|---|---|---|
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
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/liquidity-structures | DraftLiquidityStructureCommand | — |
GET | /api/liquidity-structures/sweep-breaks | — | SweepBreakRow[] |
GET | /api/liquidity-structures/sweep-legs/{leg} | — | SweepLegView |
POST | /api/liquidity-structures/sweep-legs/{leg}/cancel | CancelSweepLegRequest | — |
POST | /api/liquidity-structures/sweep-legs/{leg}/retry | RetrySweepLegRequest | — |
POST | /api/liquidity-structures/sweep-legs/{leg}/settle | RecordSweepLegSettlementRequest | — |
GET | /api/liquidity-structures/{structure}asOf | — | LiquidityStructureDetail |
POST | /api/liquidity-structures/{structure}/changes | ProposeLiquidityStructureChangeCommand | — |
POST | /api/liquidity-structures/{structure}/changes/{change}/approve | ApproveLiquidityStructureChangeCommand | — |
POST | /api/liquidity-structures/{structure}/changes/{change}/cancellations | ProposeLiquidityStructureChangeCancellationCommand | — |
POST | /api/liquidity-structures/{structure}/changes/{change}/reject | RejectLiquidityStructureChangeCommand | — |
POST | /api/liquidity-structures/{structure}/changes/{change}/withdraw | WithdrawLiquidityStructureChangeCommand | — |
GET | /api/liquidity-structures/{structure}/evaluationonslotshapeDatechange | — | SweepEvaluation |
GET | /api/liquidity-structures/{structure}/sweep-legspagepageSize | — | SweepRunHistory |
GET | /api/liquidity-structures/{structure}/sweep-schedule | — | SweepScheduleStatus |
loans1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/loans/{loanAccountId}/cover | — | LoanCoverSnapshot |
lookups2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/lookups/types | — | ListLookupTypesResponse |
GET | /api/lookups/types/{id} | — | — |
mcp1
| Method | Path | Request | Response |
|---|---|---|---|
POST | /mcp/{tenant} | McpRequest | — |
me10
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/me/capabilities | — | — |
GET | /api/me/features | — | — |
GET | /api/me/managed-customers | — | — |
GET | /api/me/permissions | — | — |
GET | /api/me/photo | — | — |
POST | /api/me/photo | SetMemberPhotoCommand | — |
DELETE | /api/me/photo | — | — |
GET | /api/me/platform-authority | — | — |
GET | /api/me/profile | — | MemberListItem |
POST | /api/me/profile | UpdateMemberProfileCommand | — |
members3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/membersincludeInactive | — | ListMembersResponse |
GET | /api/members/{memberId}/photo | — | — |
GET | /api/members/{userId} | — | — |
merchant-agreements15
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/merchant-agreementsstatusmerchant | — | MerchantAgreementSummary[] |
POST | /api/merchant-agreements | OpenMerchantAgreementCommand | — |
GET | /api/merchant-agreements/{id} | — | — |
POST | /api/merchant-agreements/{id}/cancel-scheduled-pricing-change | CancelScheduledMerchantPricingChangeCommand | — |
POST | /api/merchant-agreements/{id}/cancel-scheduled-reserve-change | CancelScheduledMerchantReserveChangeCommand | — |
POST | /api/merchant-agreements/{id}/cancel-scheduled-settlement-change | CancelScheduledMerchantSettlementChangeCommand | — |
POST | /api/merchant-agreements/{id}/change-pricing | ChangeMerchantPricingCommand | — |
POST | /api/merchant-agreements/{id}/change-reserve | ChangeMerchantReserveCommand | — |
POST | /api/merchant-agreements/{id}/change-settlement | ChangeMerchantSettlementCommand | — |
GET | /api/merchant-agreements/{id}/chargebacks | — | MerchantChargebackSummary[] |
GET | /api/merchant-agreements/{id}/operationspermittedOnly | — | — |
GET | /api/merchant-agreements/{id}/reserve | — | — |
POST | /api/merchant-agreements/{id}/resume | ResumeMerchantAgreementCommand | — |
POST | /api/merchant-agreements/{id}/suspend | SuspendMerchantAgreementCommand | — |
POST | /api/merchant-agreements/{id}/terminate | TerminateMerchantAgreementCommand | — |
merchant-chargebacks3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/merchant-chargebacks/{id} | — | — |
POST | /api/merchant-chargebacks/{id}/accept | AcceptMerchantChargebackCommand | — |
POST | /api/merchant-chargebacks/{id}/represent | RecordMerchantRepresentmentCommand | — |
merchant-nodes12
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/merchant-nodesparentrootsOnlycounterpartyoffRuleOnlyincludeBelow | — | MerchantNodeSummary[] |
POST | /api/merchant-nodes | OpenMerchantNodeCommand | — |
GET | /api/merchant-nodes/{id} | — | — |
POST | /api/merchant-nodes/{id}/amend-payout-account | AmendMerchantPayoutAccountCommand | — |
POST | /api/merchant-nodes/{id}/assign-identifier | AssignMerchantIdentifierCommand | — |
POST | /api/merchant-nodes/{id}/change-category | ChangeMerchantNodeCategoryCommand | — |
POST | /api/merchant-nodes/{id}/change-properties | ChangeMerchantNodePropertiesCommand | — |
POST | /api/merchant-nodes/{id}/change-routing | ChangeMerchantCurrencyRoutingCommand | — |
POST | /api/merchant-nodes/{id}/close | CloseMerchantNodeCommand | — |
POST | /api/merchant-nodes/{id}/resume | ResumeMerchantNodeCommand | — |
POST | /api/merchant-nodes/{id}/settlement-accounts | OpenMerchantSettlementAccountCommand | — |
POST | /api/merchant-nodes/{id}/suspend | SuspendMerchantNodeCommand | — |
metering4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/metering/settings/chargeable-metrics | — | ChargeableMetric[] |
GET | /api/metering/settings/chargeable-metrics/all | — | ChargeableMetric[] |
POST | /api/metering/settings/chargeable-metrics/remove | DeactivateChargeableMetricCommand | — |
GET | /api/metering/unattributed-usagefromtoreasonpageSizeoffsetcursorsortdescendinggroupBy | — | PageOfUnattributedUsage |
monitoring1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/monitoring/events | — | — |
notes4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/notesaggregateIdpageSizeoffsetcursorsortdescendingsearch | — | PageOfNoteDto |
POST | /api/notes/create | CreateNoteCommand | — |
POST | /api/notes/delete | DeleteNoteCommand | — |
POST | /api/notes/update | UpdateNoteCommand | — |
notices1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/notices/expiringfromto | — | ExpiringNoticeDto[] |
numbering1
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/numbering/next | NextNumbersRequest | — |
operating-entities22
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/operating-entities | — | OperatingEntityListItemDto[] |
POST | /api/operating-entities | RegisterOperatingEntity | — |
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}/execute | ExecuteOperatingEntityOperationRequest | — |
POST | /api/operating-entities/{id}/property-entries/amend | AmendScheduledOperatingEntityPropertyChangeRequest | — |
POST | /api/operating-entities/{id}/property-entries/cancel | CancelScheduledOperatingEntityPropertyChangeRequest | — |
POST | /api/operating-entities/{id}/property-entries/correct | CorrectOperatingEntityPropertyEntryRequest | — |
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/operating-entity-balancesids | — | — |
operating-entity-registration-demands1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/operating-entity-registration-demands | — | — |
organisational-units8
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/organisational-units | RegisterOrganisationalUnit | — |
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}/code | ChangeOrganisationalUnitCodeRequest | — |
GET | /api/organisational-units/{id}/operationspermittedOnly | — | — |
POST | /api/organisational-units/{id}/operations/{operationName}/execute | ExecuteOrganisationalUnitOperationRequest | — |
pay4
| Method | Path | Request | Response |
|---|---|---|---|
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
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/platform-logins/find-by-email | FindPlatformLoginByEmailQuery | PlatformUser |
position-type-masters1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/position-type-masters | — | — |
posting-groups1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/posting-groups/{id}/products | — | ProductRef[] |
price12
| Method | Path | Request | Response |
|---|---|---|---|
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/deactivate | DeactivatePriceTypeCommand | — |
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
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/price-lists/change-price | ChangePriceCommand | — |
POST | /api/price-lists/change-prices | ChangePricesCommand | — |
POST | /api/price-lists/copy | CopyPriceListCommand | — |
POST | /api/price-lists/remove-price | RemovePriceCommand | — |
POST | /api/price-lists/reschedule-price | ReschedulePriceCommand | — |
GET | /api/price-lists/{id}/copy-previewstartDate | — | — |
GET | /api/price-lists/{id}/products | — | ProductRef[] |
pricing-plans11
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/pricing-plans/adjust-price | AdjustPriceCommand | — |
POST | /api/pricing-plans/cancel-scheduled-change | CancelScheduledPlanChangeCommand | — |
POST | /api/pricing-plans/change-price-list | ChangePriceListCommand | — |
POST | /api/pricing-plans/clear-price-adjustment | ClearPriceAdjustmentCommand | — |
GET | /api/pricing-plans/coverageplancurrencyasOf | — | PricingPlanCoverage |
POST | /api/pricing-plans/create | CreatePricingPlanCommand | — |
POST | /api/pricing-plans/override-price | OverridePriceCommand | — |
GET | /api/pricing-plans/plan-counts | — | — |
POST | /api/pricing-plans/reschedule-change | ReschedulePlanChangeCommand | — |
GET | /api/pricing-plans/sheet/{planId}candidateList | — | — |
GET | /api/pricing-plans/{accountId}candidateList | — | — |
products16
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/products | — | ProductView[] |
POST | /api/products | AddProductCommand | — |
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}/copy | CopyProductRequest | — |
POST | /api/products/{key}/link | LinkProductRequest | — |
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
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/properties/files | — | FileRef |
provisioning-settings1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/provisioning-settings | — | AccountTypeProvisioningSettings |
public4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /public/files/{token} | — | — |
GET | /public/files/{token}/{name} | — | — |
GET | /public/sign/{token} | — | — |
POST | /public/signing/callback/{token} | — | — |
rate-structures5
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/rate-structures | — | RateStructureSettings |
POST | /api/rate-structures/bands/remove | RemoveRateBandCommand | — |
POST | /api/rate-structures/rates/change | RegistryAccountsChangeRateCommand | — |
GET | /api/rate-structures/{name}/blast-radiustermTypeIdfromAmounttoAmount | — | — |
GET | /api/rate-structures/{name}/quotetermTypeIdamountvalueDate | — | — |
rates1
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/rates/change | PricingRatesChangeRateCommand | — |
recurring-tasks7
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/recurring-tasks/amend | AmendRecurringTaskCommand | — |
GET | /api/recurring-tasks/by-subjectsubjectTypesubjectId | — | MyRecurringTaskDto[] |
POST | /api/recurring-tasks/define | DefineRecurringTaskCommand | — |
POST | /api/recurring-tasks/end | EndRecurringTaskCommand | — |
GET | /api/recurring-tasks/mine | — | MyRecurringTaskDto[] |
POST | /api/recurring-tasks/pause | PauseRecurringTaskCommand | — |
POST | /api/recurring-tasks/resume | ResumeRecurringTaskCommand | — |
reference-data-changes7
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/reference-data-changeschangeSetId | — | — |
POST | /api/reference-data-changes | PublishReferenceDataChangeRequest | — |
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}/reject | RejectReferenceDataChangeRequest | — |
references1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/references/{reference}streamIdpage | — | LookUpReferenceResponse |
regulatory13
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/regulatory/readinessoperatingEntityIdasOf | — | ReportableReadinessItem[] |
GET | /api/regulatory/settings/depositor-classes | — | — |
GET | /api/regulatory/submission-runs | — | SubmissionRunDto[] |
POST | /api/regulatory/submission-runs | ProduceSubmissionRunCommand | — |
POST | /api/regulatory/submission-runs/{id}/acknowledge-warnings | AcknowledgeWarningsRequest | — |
POST | /api/regulatory/submission-runs/{id}/acknowledgement | RecordAcknowledgementRequest | — |
GET | /api/regulatory/submission-runs/{id}/artifact | — | — |
GET | /api/regulatory/submission-runs/{id}/downloads | — | SubmissionArtifactDownloadDto[] |
POST | /api/regulatory/submission-runs/{id}/rejected | MarkRejectedRequest | — |
POST | /api/regulatory/submission-runs/{id}/submitted | MarkSubmittedRequest | — |
POST | /api/regulatory/tax-certificates | IssueTaxCertificateCommand | — |
GET | /api/regulatory/tax-certificates/{id}/document | — | — |
POST | /api/regulatory/tax-certificates/{id}/render | — | — |
regulatory-charge-classes1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/regulatory-charge-classes | — | — |
regulatory-limits1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/regulatory-limits | — | — |
relationships7
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/relationshipssubjecttypeactiveOnly | — | — |
POST | /api/relationships | JsonElement | — |
POST | /api/relationships/{relationshipId}/end | JsonElement | — |
PATCH | /api/relationships/{relationshipId}/properties/{name} | JsonElement | — |
POST | /api/relationships/{relationshipId}/property-entries/amend | AmendScheduledRelationshipPropertyChangeRequest | — |
POST | /api/relationships/{relationshipId}/property-entries/cancel | CancelScheduledRelationshipPropertyChangeRequest | — |
POST | /api/relationships/{relationshipId}/property-entries/correct | CorrectRelationshipPropertyEntryRequest | — |
reports9
| Method | Path | Request | Response |
|---|---|---|---|
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/return-filesoperatingEntityId | — | ReturnFileSummary[] |
POST | /api/return-files/ingest | IngestReturnFileCommand | ReturnFileId |
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
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/role-types/yaml | — | — |
roles1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/rolestypeincludeRevoked | — | ListRolesByTypeResponse |
scheduling12
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/scheduling/business-centres | — | BusinessCentreOption[] |
POST | /api/scheduling/holidays/import | ImportHolidaysRequest | — |
POST | /api/scheduling/holidays/import-file | ImportHolidaysFromFileRequest | — |
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/preview | PreviewScheduleDatesRequest | SchedulePreview |
GET | /api/scheduling/settings/calendars | — | — |
GET | /api/scheduling/settings/calendars/all | — | — |
GET | /api/scheduling/settings/holidays | — | — |
GET | /api/scheduling/settings/holidays/all | — | — |
securities6
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/securities/activate | ActivateSecurityCommand | — |
POST | /api/securities/advance-rate | AdjustAdvanceRateCommand | — |
GET | /api/securities/by-collateralcollateralId | — | SecuritySummary[] |
GET | /api/securities/by-loanloanAccountId | — | SecurityCoverLine[] |
POST | /api/securities/propose | ProposeSecurityCommand | — |
POST | /api/securities/release | ReleaseSecurityCommand | — |
seeding1
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/seeding/runtenantphaseforce | — | — |
service-catalogue3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/service-catalogue | — | Service[] |
GET | /api/service-catalogue/all | — | Service[] |
POST | /api/service-catalogue/remove | DeactivateServiceCommand | — |
service-enrolments7
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/service-enrolments | EnrolServiceCommand | ServiceEnrolmentId |
POST | /api/service-enrolments/amend | AmendServiceEnrolmentCommand | — |
POST | /api/service-enrolments/resume | ResumeServiceEnrolmentCommand | — |
POST | /api/service-enrolments/suspend | SuspendServiceEnrolmentCommand | — |
POST | /api/service-enrolments/terminate | TerminateServiceEnrolmentCommand | — |
POST | /api/service-enrolments/void | VoidServiceEnrolmentCommand | — |
GET | /api/service-enrolments/{enrolment} | — | ServiceEnrolmentDetail |
settings31
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/settings/ai | — | AiSettingsView |
POST | /api/settings/ai | SetAiChoiceCommand | — |
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-registration | ConfigureClientSelfRegistrationCommand | — |
GET | /api/settings/failed-requests | — | FailedRequestSettingsDto |
POST | /api/settings/failed-requests | SetFailedRequestRetentionCommand | — |
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/try | TryFeedLayoutQuery | FeedLayoutTrial |
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}/draft | SettingsPatchBody | — |
POST | /api/settings/{settingsType}/draft/discard | — | — |
POST | /api/settings/{settingsType}/publish | — | — |
GET | /api/settings/{settingsType}/row-sets | — | RowSetMark[] |
signing8
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/signing/cancel | CancelSignatureRequestCommand | — |
GET | /api/signing/gateways | — | SigningGatewayRow[] |
POST | /api/signing/gateways/retire | RetireSigningGatewayCommand | — |
POST | /api/signing/remind | SendSignatureReminderCommand | — |
GET | /api/signing/requestsrecorddocumentopenOnlyissuingUnitolderThanDayspageSizeoffsetcursorsortdescendingsearchgroupBy | — | PageOfSignatureRequestDto |
GET | /api/signing/requests/{id} | — | SignatureRequestDto |
GET | /api/signing/requirements | — | SigningRequirementRow[] |
POST | /api/signing/send | SendForSignatureCommand | — |
simulator-outbox3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/simulator-outboxpageSizecursor | — | PageOfSimulatorOutboxRowDto |
GET | /api/simulator-outbox/email/{id} | — | — |
GET | /api/simulator-outbox/sms/{id} | — | — |
sms-messages3
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/sms-messagesownerIdpageSizeoffsetcursorsortdescendingsearch | — | PageOfSmsMessageDto |
GET | /api/sms-messages/exportownerIdsearch | — | — |
POST | /api/sms-messages/resend | ResendSmsMessageRequest | — |
standing-orders11
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/standing-ordersaccountId | — | StandingOrderDto[] |
POST | /api/standing-orders/adjust-amount | AdjustStandingOrderAmountCommand | — |
GET | /api/standing-orders/allpageSizeoffsetcursorsortdescendingsearch | — | PageOfAllStandingOrderDto |
GET | /api/standing-orders/all/exportsortdescendingsearch | — | — |
POST | /api/standing-orders/cancel | CancelStandingOrderCommand | — |
POST | /api/standing-orders/change-external-account | ChangeStandingOrderExternalAccountCommand | — |
GET | /api/standing-orders/external-accountexternalAccountId | — | ExternalAccountInstructionDto[] |
POST | /api/standing-orders/payout | PayoutDisbursementRequest | — |
GET | /api/standing-orders/payout-amount/{accountId} | — | PayoutAmountResponse |
POST | /api/standing-orders/reschedule | RescheduleStandingOrderCommand | — |
POST | /api/standing-orders/schedule | ScheduleStandingOrderRequest | — |
statements2
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/statements/schedules | — | StatementScheduleView[] |
POST | /api/statements/{id}/render | — | — |
streams1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/streams/{streamId}/eventsfromtocursorpageSizeoffsetsortdescending | — | — |
structure-balances1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/structure-balancesids | — | — |
structures13
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/structurespageIndexpageSize | — | StructureListResponse |
POST | /api/structures | JsonElement | — |
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}/execute | ExecuteStructureOperationRequest | — |
POST | /api/structures/{id}/property-entries/amend | AmendScheduledStructurePropertyChangeRequest | — |
POST | /api/structures/{id}/property-entries/cancel | CancelScheduledStructurePropertyChangeRequest | — |
POST | /api/structures/{id}/property-entries/correct | CorrectStructurePropertyEntryRequest | — |
GET | /api/structures/{structureId}/authorisation-history | — | AuthorisationQueueReadModel[] |
submissions4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/submissions/awaiting-release | — | SubmissionDto[] |
GET | /api/submissions/{id} | — | SubmissionDto |
POST | /api/submissions/{id}/release | — | — |
GET | /api/submissions/{id}/returns | — | SubmissionReturnLine[] |
suspense12
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/suspense/casespageSizeoffsetcursorsortdescendingsearchgroupByoperatingEntityIdpurposeIdownerIdunassignedstatusfromDaystoDays | — | PageOfSuspenseCaseRow |
POST | /api/suspense/cases/assign | AssignSuspenseCasesCommand | — |
GET | /api/suspense/cases/exportsortdescendingsearchoperatingEntityIdpurposeIdownerIdunassignedstatusfromDaystoDays | — | — |
GET | /api/suspense/cases/{caseId} | — | SuspenseCaseDetail |
POST | /api/suspense/cases/{caseId}/status | RecordSuspenseCaseStatusCommand | — |
GET | /api/suspense/dashboard/{operatingEntityId} | — | SuspenseDashboard |
POST | /api/suspense/items/refund | RefundSuspenseItemCommand | — |
POST | /api/suspense/items/transfer | TransferSuspenseItemCommand | — |
POST | /api/suspense/items/write-off | WriteOffSuspenseItemCommand | — |
GET | /api/suspense/items/{openItemId}/suggestionstake | — | SuspenseCandidate[] |
GET | /api/suspense/purposes | — | SuspensePurposesView |
POST | /api/suspense/purposes/check | CheckSuspensePurposeConfiguration | SuspenseConfigurationWarning[] |
tasks13
| Method | Path | Request | Response |
|---|---|---|---|
POST | /api/tasks/amend | AmendTaskCommand | — |
POST | /api/tasks/assign | AssignTaskCommand | — |
GET | /api/tasks/by-personpersonIdpageSizeoffsetcursorsortdescendingsearchgroupBy | — | PageOfTaskSummaryDto |
GET | /api/tasks/by-subjectsubjectTypesubjectIdpageSizeoffsetcursorsortdescendingsearchgroupBystatus | — | PageOfTaskSummaryDto |
POST | /api/tasks/cancel | CancelTaskCommand | — |
POST | /api/tasks/change-status | ChangeTaskStatusCommand | — |
POST | /api/tasks/claim | ClaimTaskCommand | — |
POST | /api/tasks/complete | CompleteTaskCommand | — |
POST | /api/tasks/create | CreateTaskCommand | — |
GET | /api/tasks/minepageSizeoffsetcursorsortdescendingsearchgroupByclaimable | — | PageOfMyTaskDto |
GET | /api/tasks/mine/closedpageSizeoffsetcursorsortdescendingsearchgroupBy | — | PageOfMyTaskDto |
POST | /api/tasks/offer-to-group | OfferTaskToGroupCommand | — |
POST | /api/tasks/reschedule | RescheduleTaskCommand | — |
tax8
| Method | Path | Request | Response |
|---|---|---|---|
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/term-settings | — | TermSettings |
trading-date1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/trading-date | — | — |
transaction-type-masters1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/transaction-type-masters | — | — |
treasury1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/treasury/cash-flowexternalAccountIdoperatingEntityId | — | CashFlowResponse |
tsq6
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/tsqcommandTypebatchIdlimitoffset | — | — |
POST | /api/tsq/cancel | CancelRequest | — |
POST | /api/tsq/complete | CompleteRequest | — |
GET | /api/tsq/dead-lettersmessageTypeexceptionTypepagepageSize | — | DeadLetterListResponse |
POST | /api/tsq/dead-letters/{id}/replay | — | — |
POST | /api/tsq/replay | ReplayRequest | — |
type-usage1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/type-usage/instances-missing-propertyvocabularytypepropertyphase | — | — |
types14
| Method | Path | Request | Response |
|---|---|---|---|
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
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/virtual-accounts/books/{account} | — | AllocationBookView |
GET | /api/virtual-accounts/books/{account}/linesvirtualAccountpageSizeoffset | — | PageOfVirtualAccountLineView |
POST | /api/virtual-accounts/books/{account}/nodes | OpenVirtualAccountRequest | — |
POST | /api/virtual-accounts/books/{account}/nodes/{id}/close | CloseVirtualAccountRequest | — |
POST | /api/virtual-accounts/books/{account}/nodes/{id}/place | PlaceVirtualAccountRequest | — |
POST | /api/virtual-accounts/books/{account}/nodes/{id}/rename | RenameVirtualAccountRequest | — |
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}/reallocate | ReallocateMovementRequest | — |
POST | /api/virtual-accounts/books/{account}/records/{record}/reallocation-preview | PreviewReallocationRequest | ReallocationPreview |
GET | /api/virtual-accounts/books/{account}/statement-subscriptions | — | StatementSubscriptionView[] |
POST | /api/virtual-accounts/books/{account}/statement-subscriptions | CreateStatementSubscriptionRequest | StatementSubscriptionId |
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}/statements | IssueVirtualAccountStatementRequest | StatementId |
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}/attribute | AttributeVirtualAccountRequest | — |
GET | /api/virtual-accounts/nodes/{id}/availabilitybook | — | VirtualAccountAvailability |
POST | /api/virtual-accounts/nodes/{id}/holds | PlaceVirtualAccountHoldRequest | — |
POST | /api/virtual-accounts/nodes/{id}/holds/{claimId}/release | ReleaseVirtualAccountHoldRequest | — |
GET | /api/virtual-accounts/numbers/resolvemarketcodecountrynumber | — | — |
GET | /api/virtual-accounts/rangespageSizeoffsetcursorsortdescendingholdertransitenrolment | — | PageOfVirtualAccountRangeRow |
GET | /api/virtual-accounts/ranges/{id} | — | — |
POST | /api/virtual-accounts/ranges/{id}/issue | IssueVirtualAccountNumbersRequest | — |
GET | /api/virtual-accounts/ranges/{id}/numberspageSizeoffset | — | — |
GET | /api/virtual-accounts/ranges/{id}/numbers/export | — | — |
POST | /api/virtual-accounts/ranges/{id}/quarantine | QuarantineVirtualAccountNumberRequest | — |
POST | /api/virtual-accounts/ranges/{id}/quarantine-live | QuarantineLiveVirtualAccountNumbersRequest | — |
POST | /api/virtual-accounts/ranges/{id}/repoint | RepointVirtualAccountRangeRequest | — |
POST | /api/virtual-accounts/ranges/{id}/withdraw | WithdrawVirtualAccountRangeRequest | — |
POST | /api/virtual-accounts/statements/{id}/redeliver | — | — |
GET | /api/virtual-accounts/transitspageSizeoffsetcursorsortdescending | — | PageOfVirtualTransitRow |
POST | /api/virtual-accounts/transits | OpenVirtualTransitCommand | — |
GET | /api/virtual-accounts/transits/{id} | — | — |
PUT | /api/virtual-accounts/transits/{id} | AmendVirtualTransitRequest | — |
PUT | /api/virtual-accounts/transits/{id}/permitted-jurisdictions | SetPermittedHolderJurisdictionsRequest | — |
POST | /api/virtual-accounts/transits/{id}/ranges | AssignVirtualAccountRangeRequest | — |
POST | /api/virtual-accounts/transits/{id}/release | ReleaseVirtualTransitSerialsRequest | — |
POST | /api/virtual-accounts/transits/{id}/set-aside | SetAsideVirtualTransitSerialsRequest | — |
GET | /api/virtual-accounts/unresolved-receiptsbookpagepageSizeoffset | — | PageOfUnresolvedReceipt |
GET | /api/virtual-accounts/unresolved-receipts/{id} | — | InboundResolutionView |
POST | /api/virtual-accounts/unresolved-receipts/{id}/close | CloseInboundResolutionRequest | — |
POST | /api/virtual-accounts/unresolved-receipts/{id}/confirm | ConfirmInboundCandidateRequest | — |
vocabularies1
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/vocabularies/{key}includeRetired | — | — |
warehouse4
| Method | Path | Request | Response |
|---|---|---|---|
GET | /api/warehouse/reports/managementyearmonthstructureId | — | ManagementReportDto |
GET | /api/warehouse/reports/portfolio-movementfromYearfromMonthtoYeartoMonth | — | PortfolioMovementDto |
GET | /api/warehouse/runs | — | WarehouseRunDto[] |
POST | /api/warehouse/runs | CutWarehouseRun | — |
whatsapp-messages1
| Method | Path | Request | Response |
|---|---|---|---|
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.