Changelog

All notable changes to the PortX ORCA Account Management API are documented here. Each entry is derived from the published OpenAPI specifications available in the version selector on the API Reference page.

v0.16.3 (Latest)

What's New

Added a customerNumber.eq query filter so parties can be looked up by the customer number assigned by the banking core:

  • GET /persons: filter persons by customerNumber.eq
  • GET /organizations: filter organizations by customerNumber.eq

Documented additional standard error responses on every operation:

  • 405 Method Not Allowed: the HTTP method is not supported for the resource; the Allow response header lists the supported methods
  • 415 Unsupported Media Type: returned by operations that accept a request body when the content is not in a supported media type
  • 501 Not Implemented: the connector or core system does not implement the operation
  • 409 Conflict: returned by idempotent create operations when the idempotencyId was already used with a different payload. Replaying an identical request returns the original result instead of 409, so duplicate postings never occur

Card and posting alignment. Deposit, withdrawal and account hold requests now carry the same posting fields as Transaction:

  • externalId: the caller's end-to-end reference that threads the authorization hold, settlement, completions and reversal of one card transaction. Also exposed on Transaction and AccountHoldResponse
  • card, cash, dispenser, identifiers, codes, postingType, descriptionLines and reversalIndicator on DepositRequest and WithdrawalRequest
  • Card added as a value of the credit and debit transactionType; MemoPosted is deprecated in favour of postingType
  • PaymentCardTransactionDetail gains cardTransactionType, acceptorId, acquirerId, terminalId and entryMode
  • AccountHoldResponse now returns accountId, status, statusReason and statusReasonDescription
  • GET /accounts/{accountId}/transactions: new externalId.eq filter

Cards

  • New CardToken schema: the external card identifier minted by the card provider or processor, returned on card responses and accepted by the new token.eq filter on GET /cards
  • Card identifiers now allow up to 36 characters

Loans

  • GET /loans: new loanId.eq filter; accountId.eq remains as a deprecated alias
  • New CommunityReinvestmentData schema (CRA, Regulation BB reporting attributes) on Loan and LoanRequest, with a CensusTractCode schema in the FFIEC NNNN.NN format
  • Loan responses now include balances
  • Loan fee vocabulary added to ChargeType: LateFee, ExtensionFee, PassThroughCost, PrepaymentPenalty, MiscellaneousFee
  • Guarantee roles added to AccountRelationType: Guarantor, Guaranteed, Endorser, Endorsed, Cosigner, Cosigned, Comaker

Status values

  • AccountStatus: Inactive and Escheat, computed by the banking core and read-only
  • LoanStatus: Closed, Inactive, Dormant and Escheat; only Closed and Active can be requested by a client

Fixed

  • Corrected the regular expression patterns of the Percentage and PositivePercentage schemas. The previous patterns rejected valid values such as 100.5 or multi-digit integer parts; percentages are no longer capped at 100.

Notes

  • No breaking changes. Existing requests continue to work unchanged.

v0.16.2

What's New

Credit Transfers

  • POST /credit-transfers: Credit Transfer Initiation
  • GET /credit-transfers: list credit transfers matching the query parameters
  • GET /credit-transfers/{paymentId}: Credit Transfer Status
  • POST /credit-transfers/{paymentId}/cancellation: Credit Transfer Cancellation

Calendar and Core

  • GET /calendar: business days, hours, and holidays
  • GET /core: status of the banking core that ORCA is connected to

Organizations

  • GET /organizations/{organizationId}/loans: organization loan exposure

Removed

Documents

  • POST /documents, GET /documents, GET /documents/{documentId}, PATCH /documents/{documentId}

Reward Programs

  • POST /reward-programs, GET /reward-programs, GET /reward-programs/{programId}, PATCH /reward-programs/{programId}
  • GET /persons/{personId}/reward-programs

The Address Book tag was also removed.

Breaking Changes

  • Clients relying on the Documents or Reward Programs endpoints must migrate, as they were removed in this release.

v0.13.4

What's New

Credit Transfers

  • POST /credit-transfers: Credit Transfer Initiation
  • GET /credit-transfers: list credit transfers matching the query parameters
  • GET /credit-transfers/{paymentId}: Credit Transfer Status
  • POST /credit-transfers/{paymentId}/cancellation: Credit Transfer Cancellation

Standing Orders (account-scoped)

  • GET /accounts/{accountId}/standing-orders: Account Standing Orders
  • POST /accounts/{accountId}/standing-orders: create a Standing Order
  • GET /accounts/{accountId}/standing-orders/{standingOrderId}: Standing Order Status
  • PATCH /accounts/{accountId}/standing-orders/{standingOrderId}: update a Standing Order

Calendar and Core

  • GET /calendar: business days, hours, and holidays
  • GET /core: status of the banking core that ORCA is connected to

Comments and Servicer Alerts

  • The Comment schema gained commentId and creationDateTime, and ServicerAlert gained alertId, for cores that persist them as standalone records.
  • comments and servicerAlerts arrays were added to the Account, Person, Organization, and Loan models and their request/profile variants.

New schemas include Calendar, Core, CreditTransfer, CreditTransferInitiation, AccountStandingOrderResponse, PaymentStatus, and related models.

Changes

  • The specification was upgraded from OpenAPI 3.0.1 to 3.1.0 and now documents the connector deployment host in a servers block.
  • All PATCH request bodies are now typed against the corresponding request schemas (previously documented as an untyped object).
  • AlternativeTerm.name: corrected an invalid maximum constraint to maxLength.

Notes

  • No endpoints or schemas were removed; no breaking changes.
  • The credit transfer, calendar, and core endpoints listed as new in v0.16.2 are also present in this release for the 0.13.x line.

v0.13.3

Changes

  • Version bump only. The specification is identical to v0.13.2 apart from the version number.

v0.13.2

What's New

  • No endpoints were added or removed. New schemas were introduced for loan and reporting models: AccountPaymentRenewal, AccountReporting, Insurance, LoanSaleDetails, MortgageLoanProgramDetail, RoundingOption, and TransactionType.

Breaking Changes

  • Includes breaking changes to fields on existing schemas. Validate your models against the updated specification.

v0.13.1

What's New

  • No endpoints were added or removed. Added the TransactionAccount schema.

Breaking Changes

  • Includes breaking changes to fields on existing schemas. Validate your models against the updated specification.

v0.12.6

What's New

Address Book (new tag)

  • POST /addresses: create an Address
  • GET /addresses: list addresses matching the query parameters
  • GET /addresses/{addressId}: retrieve an Address
  • PATCH /addresses/{addressId}: update an Address

Reward Programs

  • POST /reward-programs: create a Reward Program
  • GET /reward-programs: list reward programs matching the query parameters
  • GET /reward-programs/{programId}: Reward Program Status
  • PATCH /reward-programs/{programId}: update a Reward Program
  • GET /persons/{personId}/reward-programs: reward programs of a member

Documents

  • POST /documents: create a Document or Agreement
  • GET /documents: list documents matching the query parameters
  • GET /documents/{documentId}: retrieve a Document
  • PATCH /documents/{documentId}: update a Document

Statements and Holds

  • GET /persons/{personId}/statements: Person Statements
  • GET /organizations/{organizationId}/statements: Organization Statements
  • DELETE /holds/{holdId}: Account Hold Removal

New schemas include Address, RewardProgram, MortgageLoan, and related models.

Breaking Changes

  • Alongside the additions, this release includes breaking changes to existing schemas. Validate your models against the updated specification.

v0.8.0 ⚠️ Deprecated

Warning: This version is deprecated. Please upgrade to the latest version.

What's New

  • GET /loans: list loan accounts matching the query parameters

Removed

This was a consolidation release. The 30 endpoints added in v0.6.4 were removed:

Payments

  • POST /credit-transfers, GET /credit-transfers, GET /credit-transfers/{paymentId}, POST /credit-transfers/{paymentId}/cancellation
  • POST /direct-debits, GET /direct-debits, GET /direct-debits/{paymentId}, POST /direct-debits/{paymentId}/cancellation
  • POST /creditor-payments, GET /creditor-payments, GET /creditor-payments/{paymentId}
  • POST /cards/{cardId}/right-time-payments, POST /right-time-payments/{paymentId}/cancellation
  • GET /accounts/{accountId}/payments

Standing Orders

  • GET /accounts/{accountId}/standing-orders, POST /accounts/{accountId}/standing-orders
  • GET /standing-orders/{standingOrderId}, PATCH /standing-orders/{standingOrderId}

Documents

  • POST /documents, GET /documents, GET /documents/{documentId}, PATCH /documents/{documentId}

External Provider Accounts

  • POST /accounts/{accountId}/external-provider-accounts, GET /accounts/{accountId}/external-provider-accounts
  • GET /external-provider-accounts/{externalAccountId}, PATCH /external-provider-accounts/{externalAccountId}, DELETE /external-provider-accounts/{externalAccountId}

Organizations and Holds

  • GET /organizations/{organizationId}/loans, GET /organizations/{organizationId}/statements
  • DELETE /holds/{holdId}

Breaking Changes

  • This is a heavily breaking release. The payments, standing orders, documents, and external provider features were removed. Do not target this version for those workflows.

Deprecation Notice

  • This version will be removed in a future release. Migrate to the latest version for continued support.

v0.6.4 ⚠️ Deprecated

Warning: This version is deprecated. Please upgrade to the latest version.

What's New

A large expansion adding 30 endpoints.

Payments

  • POST /credit-transfers: Credit Transfer Initiation
  • GET /credit-transfers: list credit transfers matching the query parameters
  • GET /credit-transfers/{paymentId}: Credit Transfer Status
  • POST /credit-transfers/{paymentId}/cancellation: Credit Transfer Cancellation
  • POST /direct-debits: Direct Debit Initiation
  • GET /direct-debits: list direct debits matching the query parameters
  • GET /direct-debits/{paymentId}: Direct Debit Status
  • POST /direct-debits/{paymentId}/cancellation: Direct Debit Cancellation
  • POST /creditor-payments: Creditor Payment Activation Request
  • GET /creditor-payments: list creditor payments matching the query parameters
  • GET /creditor-payments/{paymentId}: Creditor Payment Activation Status
  • POST /cards/{cardId}/right-time-payments: create a right-time payment for a card account
  • POST /right-time-payments/{paymentId}/cancellation: Right Time Payment Cancellation
  • GET /accounts/{accountId}/payments: payments made to an account

Standing Orders

  • GET /accounts/{accountId}/standing-orders: Account Standing Orders
  • POST /accounts/{accountId}/standing-orders: request Standing Order Cancellation
  • GET /standing-orders/{standingOrderId}: Standing Order Status
  • PATCH /standing-orders/{standingOrderId}: update a standing order

Documents

  • POST /documents: create a Document or Agreement
  • GET /documents: list documents matching the query parameters
  • GET /documents/{documentId}: retrieve a Document
  • PATCH /documents/{documentId}: update a Document

External Provider Accounts

  • POST /accounts/{accountId}/external-provider-accounts: link an external provider account to an account
  • GET /accounts/{accountId}/external-provider-accounts: external provider accounts linked to an account
  • GET /external-provider-accounts/{externalAccountId}: External Provider Account Status
  • PATCH /external-provider-accounts/{externalAccountId}: update an external provider account
  • DELETE /external-provider-accounts/{externalAccountId}: External Provider Removal

Organizations and Holds

  • GET /organizations/{organizationId}/loans: organization loan exposure
  • GET /organizations/{organizationId}/statements: Organization Statements
  • DELETE /holds/{holdId}: Account Hold Removal

Deprecation Notice

  • This version will be removed in a future release.

v0.6.2 ⚠️ Deprecated

Warning: This version is deprecated. Please upgrade to the latest version.

Changes

  • No endpoints were added or removed. Monetary types were reworked: Amount and PositiveAmount replaced AmountInCents and PositiveAmountInCents.
  • Added the User, Title, DetailedRelatedParty, and MonthDay schemas.

Breaking Changes

  • The monetary type rename is breaking for clients that used AmountInCents or PositiveAmountInCents.

Deprecation Notice

  • This version will be removed in a future release.

v0.6.1 ⚠️ Deprecated

Warning: This version is deprecated. Please upgrade to the latest version.

Changes

  • Initial published baseline of the Account Management API (67 endpoints across accounts, parties, transactions, cards, products, and loans).

Deprecation Notice

  • This version will be removed in a future release.

Versioning Policy

The PortX ORCA API follows Semantic Versioning:

  • Major version (x.0.0) - Breaking changes
  • Minor version (0.x.0) - New features, backwards compatible
  • Patch version (0.0.x) - Bug fixes, backwards compatible

Deprecation Policy

  • Deprecated versions are supported for 6 months after deprecation
  • Breaking changes are announced at least 3 months in advance
  • Subscribe to our changelog for update notifications