Documentation for a newer release is available. View Latest

Scheme Membership

Overview

Scheme Membership is a key component of the Verification of Payee (VoP) Requester Service that enables the service to interact with different payment schemes. Each payment scheme requires specific membership identifiers to authenticate and route verification requests.

How It Works

The Scheme Membership functionality allows the VoP Requester Service to:

  1. Map scheme names to membership IDs

  2. Support different membership IDs for different processing entities within the same scheme

  3. Route verification requests to the appropriate scheme with the correct membership ID

Default Processing Entity

Each scheme must have a default processing entity with an empty processing-entity-code. This default is used when a request does not specify a processing entity or when the specified processing entity is not found in the configuration.

Configuration

This component loads scheme membership IDs from the configuration file under the ipf.verification-of-payee.requester path. It creates a mapping between scheme names, processing entity codes, and scheme membership IDs.

Validation

Scheme membership does some startup validations to check the validity of the configuration:

  • Validates that each scheme has at least one processing entity

  • Ensures that each scheme has a default processing entity (with empty code)

  • Prevents duplicate schemes and processing entities

Sample Configuration

Scheme membership IDs are configured as follows:

ipf.verification-of-payee.requester {
    scheme-membership-ids {
        schemes = [
            {
                name: "FPAD" (1)
                processing-entities = [  (2)
                    {
                        processing-entity-code: "" , (3)
                        scheme-membership-id: "fpad-default-id"(4)
                    },
                    {
                        processing-entity-code: "001" ,
                        scheme-membership-id: "fpad-001-id"
                    }
                ]
            }
        ]
    }
}
1 name: The name of the supported scheme
2 processing-entities: A list of processing entities for the scheme
3 processing-entity-code: The code of the processing entity, empty string represents the default value
4 scheme-membership-id: The membership ID to use for the scheme and processing entity. In the message out to the scheme this represents the sender/requesting agent BIC