PaymentProfiles

This component runs the Payment Profiles (PYP) function.

It allows user to query the details of specific payment profile(s).

Methods

Closed: Driver Type: SASI; Use this method to amend the status of one or more payment profiles to Closed.
CreateAsDraft: Driver Type: SASI; Use this method to create one or more draft payment profiles.
CreateOrAmend: Driver Type: SASI; Use this method to create or amend one or more payment profiles. A payment profile is created if it does not exist and amended if it does.
Delete: Driver Type: SASI; Use this method to delete one or more payment profiles.
Hidden: Driver Type: SASI; Use this method to change the status of one or more payment profiles to Hidden.
Open: Driver Type: SASI; Use this method to change the status of one or more payment profiles to Open.
Query: Driver Type: Export; Use this method to extract the details of specific payment profile(s).
Suspended/Held: Driver Type: SASI; Use this method to change the status of one or more payment profiles to Suspended/Held.

Mandatory fields

A value must be supplied for Payment Profile Code - payload element <VSsrfmscPpf_PpfCode> except for the Query method where it is optional.
When specifying a Currency Rate Type, you must enter an existing rate type code:
```
<RateType>
    <ShortHeading>.</ShortHeading>
  </RateType>
```
If no rate type is specified, the currency period rate is used as the DEFAULT rate type.

Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

None.