Counterparty is replaced by Account holder. The Counterparty object is deprecated and will be removed on January 24, 2025. In the meantime, Counterparty and Account holder objects are fully interoperable. All your existing Counterparty objects have already been replicated as Account holders in Numeral and will share the same UUIDs.
Object changes
Counterparty properties
Changes
Account holder properties
Notes
object = counterparty
Updated
object = account_holder
name
N/A
name
counterparty_accounts
Removed
-
Use the new GET /external_accounts?account_holder_id=xxx endpoint and filter to retrieve the external accounts related to a given account holder.
virtual_accounts
Removed
-
Use the new GET /internal_accounts?account_holder_id=xxx endpoint and filter to retrieve the internal accounts related to a given account holder.
API endpoints changes
Former endpoint
Changes
New endpoint
GET /counterparties
Deprecated
GET /account_holders
GET /counterparties/:id
Deprecated
GET /account_holders/:id
POST /counterparties
Deprecated
POST /account_holders
POST /counterparties/:id/disable
Deprecated
POST /account_holders/:id/disable
POST /counterparties/:id
Deprecated
POST /account_holders/:id
-
New filter
GET /external_accounts?account_holder=:id
GET /virtual_accounts?counterparty_id=:id
Deprecated
GET /internal_accounts?account_holder=:id
GET /payment_orders?counterparty_id=:id
Deprecated
GET /payment_orders?account_holder_id=:id
GET /expected_payments?counterparty_id=:id
Deprecated
GET /expected_payments?account_holder_id=:id
Counterparty account → external account
Counterparty account is replaced by External account. The Counterparty account therefore deprecated and will be removed on January 24, 2025. In the meantime, Counterparty account and External account objects are fully interoperable. All your existing Counterparty accounts objects have already been replicated as External accounts in Numeral and will share the same UUIDs.
Object changes
Counterparty account properties
Changes
External account properties
object = counterparty_account
Updated
object = external_account
counterparty_id
Updated
account_holder_id
Other properties
N/A
Same properties
API endpoints changes
Former endpoint
Changes
New endpoint
GET /counterparty_accounts
Deprecated
GET /external_accounts
GET /counterparty_accounts/:id
Deprecated
GET /external_accounts/:id
POST /counterparty_accounts
Deprecated
POST /external_accounts
POST /counterparty_accounts/:id/disable
Deprecated
POST /external_accounts/:id/disable
POST /counterparty_accounts/:id/approve
Deprecated
POST /external_accounts/:id/approve
POST /counterparty_accounts/:id/deny
Deprecated
POST /external_accounts/:id/deny
POST /counterparty_accounts/:id
Deprecated
POST /external_accounts/:id
POST /counterparty_accounts/:id/verify
Deprecated
POST /external_accounts/:id/verify
GET /counterparties?counterparty_account_id=:id
Deprecated
GET /account_holders?external_account_id=:id
GET /payment_orders?counterparty_account_id=:id
Deprecated
GET /payment_orders?external_account_id=:id
GET /expected_payments?counterparty_account_id=:id
Deprecated
GET /expected_payments?external_account_id=:id
Virtual account → internal account
Virtual account is replaced by Internal account. The Virtual account object is deprecated and will be removed on January 24, 2025. In the meantime, Virtual account and Internal account objects are fully interoperable. All your existing Virtual accounts objects have already been replicated as Internal accounts in Numeral and will share the same UUIDs.
Object changes
Virtual account properties
Changes
Internal account properties
object = virtual_account
Updated
object = internal_account
counterparty_id
Updated
account_holder_id
virtual_account_number
Updated
account_number, required
N/A
New property
type, required. Existing Virtual accounts will be migrated as Internal accounts with type = “virtual”. Can also take “own”, but only applicable to indirect participants
N/A
New property
holder_name, required
N/A
New property
bank_code, optional
N/A
New property
holder_address, optional
N/A
New property
creditor_identifier, optional
Other properties
N/A
Same properties
API endpoints changes
Former endpoint
Changes
New endpoint
GET /virtual_accounts
Deprecated
GET /internal_accounts
GET /virtual_accounts/:id
Deprecated
GET /internal_accounts/:id
POST /virtual_accounts
Deprecated
POST /internal_accounts
POST /virtual_accounts/:id/disable
Deprecated
POST /internal_accounts/:id/disable
POST /virtual_accounts/:id/assign
Replaced
POST /internal_accounts/:id
POST /virtual_accounts/:id/unassign
Replaced
POST /internal_accounts/:id
POST /virtual_accounts/:id
Deprecated
POST /internal_accounts/:id
GET /counterparties?virtual_account_id=:id
Deprecated
GET /account_holders?internal_account_id=:id
GET /expected_payments?virtual_account_number=:account_number
Replaced
GET /expected_payments?internal_account_id=:id
GET /transactions?virtual_account_number=:account_number
