Skip to main content

Domain object mapping creation endpoint. Creates or updates a domain object instance in the Ark platform.

PUT 
/v1/admin/mapping/:type/:arkId

Required User Role: ADMIN

This endpoint creates a domain object instance in the Ark platform along with the associated mapping against external system identifier via the configured connector. It accepts data values such as the following to establish the relevant Ark platform and connector data stores:

  • Ark identifier
  • Ark domain object type
  • External system identifier
  • Supplementary data values specific to the domain object type

The domain object types supported by this endpoint are:

  • Customer - This element is to be populated when the domain object is a customer.
  • Account - This element is to be populated when the domain object is an account.
  • Card - This element is to be populated when the domain object is a card.

In the instance of a customer domain object, the following data values are available (DPID not mandated):

  • Customer number - externally presented customer number. Some core systems use differing formats for customer numbers. This is the number presented to the customer.
  • Delivery point identifier (DPID) - a unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier.

In the instance of an account domain object, the following data values are required:

  • Product key - the type of the account (e.g. TRANSACTION, SAVINGS)
  • Product version - the version of the product (e.g. 1.0.0)

In the instance of a card domain object, the following data values are required:

  • Card type - the type of the card (e.g. PHYSICAL, VIRTUAL, PHYSICAL_AND_VIRTUAL)
  • Customer number - the core banking system customer identifier. It is used to retrieve and verify the link between the card and customer instance.

Request​

Responses​

The requested domain object mapping was created successfully.

Last updated on