create_benefit_program_configuration

API Attributes

Direction

Inward

Invoked by

PBMS

Mode

Synchronous

Tables

benefit_program_configuration

This API accepts the benefit program configuration and creates a new benefit program configuration by supplying the program details, funding org, sponsor bank details, etc.

Object design

benefit_program_configuration

Attribute
Datatype

benefit_program_mnemonic

String – Unique code that identifies this benefit program. (Unique Constraint)

benefit_program_name

String – Full name of the benefit program. (Not nullable)

funding_org_code

String – Code of the organization providing funding. (Not nullable)

funding_org_name

String – Full name of the organization providing funding. (Not nullable)

sponsor_bank_code

String – Bank code of the sponsoring bank. (Not nullable)

sponsor_bank_account_number

String – Account number at the sponsoring bank. (Not nullable)

sponsor_bank_branch_code

String – Branch code of the sponsoring bank. (Not nullable)

sponsor_bank_account_currency

String – Currency of the sponsoring bank account (e.g., USD, EUR). (Not nullable)

id_mapper_resolution_required

Boolean – Flag indicating whether ID‐mapping resolution is required. (Defaults to True)

Validations & exceptions

  1. Configuration must be unique (no existing config for the same mnemonic)

  2. All required fields are present and non‐empty

  3. Sponsor-bank account currency matches the program’s disbursement currency

Last updated

Was this helpful?