2024.09.25

This release includes documentation updates as well as potential impacting changes related to property updates. There are no breaking changes or new features as part of this release.

📑 Documentation Updates

🆕 Added

⚠️ Warning

---

Accounts

GET accounts/v1/{accountId}

• 📑 Documentation updates
  • corrected the documentation for the response payload, previously was documented incorrectly

Transfers

GET transfers/v1/

• 📑 Documentation updates
  • noted response property 'items/items/accountId' as required
  • noted response property 'items/items/amount' as required
  • noted response property 'items/items/counterPartyAccountId' as required
  • noted response property 'items/items/id' as required
  • noted response property 'items/items/status' as required
  • noted response property 'items/items/transactionType' as required

PUT transfers/v1/AccountEntitlements/{userId}

• 📑 Documentation updates
  • noted request property 'entitlements' as not nullable

GET transfers/v1/purposeCodes

• 📑 Documentation updates
  • added missing response payload documentation

GET transfers/v1/{id}

• 📑 Documentation updates
  • noted response property 'accountId' as required
  • noted response property 'amount' as required
  • noted response property 'counterPartyAccountId' as required
  • noted response property 'id' as required
  • noted response property 'status' as required
  • noted response property 'transactionType' as required

Wires

PUT wires/v1/AccountEntitlements/{userId}

• 📑 Documentation updates
  • noted request property 'entitlements' as not nullable

GET wires/v1/incoming

• 🆕 added optional 'query' request parameter 'accountId'
• 🆕 added optional property 'items/items/beneficiaryAccountId' to the response

GET wires/v1/incoming/{id}

• 🆕 added optional property 'beneficiaryAccountId' to the response

GET wires/v1/outgoing

• 🆕 added optional 'query' request parameter 'accountId'
• 🆕 added optional property 'items/items/originatorAccountId' to the response

GET wires/v1/outgoing/{id}

• 🆕 added optional property 'originatorAccountId' to the response

POST wires/v1/outgoing/{id}/cancel

• 📑 Documentation updates
  • noted request property 'reason' as not nullable

Webhooks

GET webhooks/v1/EventTypes

• 📑 Documentation updates
  • noted response property 'items' as nullable

PUT webhooks/v1/{id}

• ⚠️ deprecated property 'accountId' in the request

GET webhooks/v1/{id}/event-history

• 📑 Documentation updates
  • noted response property 'callbackUrl' as nullable
  • noted response property 'eventTypeName' as nullable
  • noted response property 'jsonPayloadText' as nullable
  • noted response property 'statusText' as nullable

Partners

GET partners/v1/

• 🆕 added property 'isApiCredentialsEnabled' to the response

GET partners/v1/Users

• 🆕 added optional property 'items/items/partnerId' to the response

PUT partners/v1/Users

• 📑 Documentation updates
  • noted request property 'roles' as not nullable

GET partners/v1/Users/email

• 🆕 added optional property 'partnerId' to the response

GET partners/v1/Users/{id}

• 🆕 added optional property 'partnerId' to the response