What is external-payment-vendor-contact-id?
The external-payment-vendor-contact-id advanced setting in BriteCore is used to specify a single BriteCore contact who acts as the authorized external payment vendor. This contact is permitted to initiate and manage external payment operations through the BriteCore API, including the newly introduced store_external_payment endpoint
How is this setting used?
-
Purpose:
Designates one BriteCore contact as the authorized "external payment vendor" who is allowed to store external payments on behalf of policies and process payment transactions through supported API endpoints. -
API Enforcement:
Thestore_external_paymentAPI and related operations will check the caller's contact ID against this setting. Only the contact whose ID matches external-payment-vendor-contact-id is authorized to perform these actions. -
Security:
This setting is a security measure to prevent unauthorized contacts from initiating or storing external payment transactions.
How to Configure external-payment-vendor-contact-id
-
Obtain the Contact ID:
Retrieve the unique BriteCore contact ID for the contact you intend to authorize as the external payment vendor. -
Access Advanced Settings:
Navigate to Advanced Settings in the BriteCore admin interface. -
Locate
external-payment-vendor-contact-id:
Find the setting under the "payments" section. -
Set the Value:
Enter the contact ID in the setting value field. -
Save Changes:
Save your changes to apply the configuration.
Important Notes
-
Single Contact Only:
Only one contact ID can be specified. Only that contact will be authorized to manage external payment operations via the relevant APIs. -
Integration:
This setting is required for enabling and securing operations through the store_external_payment API