Documentation for a newer release is available. View Latest

Processing Entity

Processing Entity is the entity for which a payment is processed. Read more about Processing Entity here Processing Entity Explained.

Dynamic Configuration Properties

Name	Description
ProcessingEntity	A unique processing entity Id as assigned by client implementations
ProcessingEntityName	The Name of this Processing Entity. This can be actual name of the entity, Processing Entity Name is not a unique ID.
ProcessingEntityType	Where several different levels and sublevels are required for a client this will be used to determine which level this setting relates to.
LedgerCurrency	The base currency of the processing entity in the country / region of operation. This is the currency that the processing entity normally operates in the region.
EntityIdentifiers	The industry identifiers that the Processing Entity is known by. More than one identifier can be added for the processing entity.
+ Identifier	The Identifier value for the Agent
+ IdentifierType	The type of identifier being specified under identifier value. Please refer Party Identifiers Explained to know more on the identifier types.
+ IdentifierSubType	Conditionally mandatory when identifier type is: BIC or NCC. Please refer to r Party Identifiers Explained to know more on the identifier subtypes.
EntityAddress	The address of the processing entity.
+AddressType	ISO20022 defined address types. Supported values: ADDR, PBOX, HOME, BIZZ, MLTO, DLVY
+ Department	Department name
+ SubDepartment	SubDepartment name.
+ StreetName	Street name
+ BuildingNumber	Building number
+ BuildingName	Building Name
+ Floor	Floor
+ PostBox	Post box
+ Room	Room
+ PostCode	Post code
+ TownName	This can be a Town Name or name of the City.
+ TownLocationName	Town location name
+ DistrictName	District Name
+ CountrySubDivision	country subdivision
+ Country	ISO 3166 Alpha 2 Country Code
+ AddressLines	List of address lines
EntityEmail	Email of Processing Entity
EntityPhoneNumber	Phone number of Processing Entity. Support special characters. Regex: +[0-9]{1,3}-[0-9()+\-]{1,30}

Name

Description

ProcessingEntity

A unique processing entity Id as assigned by client implementations

ProcessingEntityName

The Name of this Processing Entity. This can be actual name of the entity, Processing Entity Name is not a unique ID.

ProcessingEntityType

Where several different levels and sublevels are required for a client this will be used to determine which level this setting relates to.

LedgerCurrency

The base currency of the processing entity in the country / region of operation. This is the currency that the processing entity normally operates in the region.

EntityIdentifiers

The industry identifiers that the Processing Entity is known by. More than one identifier can be added for the processing entity.

+ Identifier

The Identifier value for the Agent

+ IdentifierType

The type of identifier being specified under identifier value. Please refer Party Identifiers Explained to know more on the identifier types.

+ IdentifierSubType

Conditionally mandatory when identifier type is: BIC or NCC. Please refer to r Party Identifiers Explained to know more on the identifier subtypes.

EntityAddress

The address of the processing entity.

+AddressType

ISO20022 defined address types.

Supported values: ADDR, PBOX, HOME, BIZZ, MLTO, DLVY

+ Department

Department name

+ SubDepartment

SubDepartment name.

+ StreetName

Street name

+ BuildingNumber

Building number

+ BuildingName

Building Name

+ Floor

Floor

+ PostBox

Post box

+ Room

Room

+ PostCode

Post code

+ TownName

This can be a Town Name or name of the City.

+ TownLocationName

Town location name

+ DistrictName

District Name

+ CountrySubDivision

country subdivision

+ Country

ISO 3166 Alpha 2 Country Code

+ AddressLines

List of address lines

EntityEmail

Email of Processing Entity

EntityPhoneNumber

Phone number of Processing Entity. Support special characters.

Regex: +[0-9]{1,3}-[0-9()+\-]{1,30}

Setting Type

DPS v2 introduced new attribute of Setting Type. This is used for generation of all API endpoints for a particular setting. It is also used in index-config.<setting type> construct. SETTING_TYPE = "processingentity"

Searchable Fields

Searchable fields for Processing Entity are:

identifier
identifierType
identifierSubType
country

Indexes

DPS v2 provides an option to configure indexes for each setting. Default indexes for Processing Entity are:

ipf.dps.mongodb.index-config.processingentity {
    index-1 = ["status:ASC"]
    index-2 = ["processingEntity:ASC"]
    index-3 = ["values.payload.entityIdentifiers.identifier:ASC"]
    index-4 = ["values.payload.entityIdentifiers.identifierType:ASC"]
    index-5 = ["values.payload.entityAddress.country:ASC"]
}

This can be overridden or updated. Just note that when the field is under payload, you need to provide an index like: index-x = ["values.payload.fieldX:ASC"].

Notifications

DPS v2 can provide notification after certain CRUD operation on a setting is performed. There is an option to enable notifications on setting level. Notifications are disabled by default:

ipf.csm-reachability.should-send-notification.processing-entity-settings = false

History

There is an option to disable history on setting level. History is enabled by default:

ipf.csm-reachability.should-save-history.processing-entity-settings = true

Please refer Dynamic Configuration Management Guidelines for steps to be followed for configuring the dynamic configurations.