Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support custom TITLE and COM parameters in Ogone payment plugin #4932

Merged
merged 2 commits into from
Dec 17, 2024
Merged

Support custom TITLE and COM parameters in Ogone payment plugin #4932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a45e537
:sparkles: [#3457] Support custom templates for Ogone COM and TITLE p…
sergei-maertens Dec 16, 2024
0343550
:sparkles: [#3457] Expose new fields in Ogone payment options
sergei-maertens Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/openforms/forms/tests/test_import_export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,12 @@ def test_import(self):
self.assertEqual(imported_form.authentication_backends, ["digid"])
self.assertEqual(imported_form.payment_backend, "ogone-legacy")
self.assertEqual(
imported_form.payment_backend_options, {"merchant_id": merchant.id}
imported_form.payment_backend_options,
{
"merchant_id": merchant.id,
"com_template": "",
"title_template": "",
},
)

form_definitions = FormDefinition.objects.order_by("pk")
Expand Down
96 changes: 96 additions & 0 deletions src/openforms/js/compiled-lang/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2293,6 +2293,60 @@
"value": "The data entered in this component will be removed in accordance with the privacy settings."
}
],
"JHQfjZ": [
{
"type": 0,
"value": "Optional custom template for the the description, included in the payment overviews for the backoffice. Use this to link the payment back to a particular process or form."
},
{
"children": [
],
"type": 8,
"value": "br"
},
{
"type": 0,
"value": " You can use all form variables (using their keys) and the "
},
{
"children": [
{
"type": 0,
"value": "public_reference"
}
],
"type": 8,
"value": "code"
},
{
"type": 0,
"value": " template variable. If unspecified, a default description is used."
},
{
"children": [
],
"type": 8,
"value": "br"
},
{
"type": 0,
"value": " "
},
{
"children": [
{
"type": 0,
"value": "Note"
}
],
"type": 8,
"value": "strong"
},
{
"type": 0,
"value": ": the length of the result is capped to 100 characters."
}
],
"JKq3TC": [
{
"type": 0,
Expand Down Expand Up @@ -3887,6 +3941,12 @@
"value": "The processing (\"verwerking\") for queries to the BRP Persoon API."
}
],
"ZSvQcR": [
{
"type": 0,
"value": "TITLE parameter"
}
],
"ZdZ2Mb": [
{
"type": 0,
Expand Down Expand Up @@ -4445,6 +4505,12 @@
"value": "'Save row' text"
}
],
"eZJFP7": [
{
"type": 0,
"value": "COM parameter"
}
],
"ee4oWr": [
{
"type": 0,
Expand Down Expand Up @@ -6243,6 +6309,36 @@
"value": "The content of the submission confirmation page. It can contain variables that will be templated from the submitted form data. If not specified, the global template will be used."
}
],
"vikURf": [
{
"type": 0,
"value": "Optional custom template for the title displayed on the payment page."
},
{
"children": [
],
"type": 8,
"value": "br"
},
{
"type": 0,
"value": " You can use all form variables (using their keys) and the "
},
{
"children": [
{
"type": 0,
"value": "public_reference"
}
],
"type": 8,
"value": "code"
},
{
"type": 0,
"value": " template variable. If unspecified, a default description is used."
}
],
"vlY36U": [
{
"type": 0,
Expand Down
96 changes: 96 additions & 0 deletions src/openforms/js/compiled-lang/nl.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2314,6 +2314,60 @@
"value": "Gegevens opgevoerd in dit component worden geschoond volgens de privacy-instellingen."
}
],
"JHQfjZ": [
{
"type": 0,
"value": "Optional custom template for the the description, included in the payment overviews for the backoffice. Use this to link the payment back to a particular process or form."
},
{
"children": [
],
"type": 8,
"value": "br"
},
{
"type": 0,
"value": " You can use all form variables (using their keys) and the "
},
{
"children": [
{
"type": 0,
"value": "public_reference"
}
],
"type": 8,
"value": "code"
},
{
"type": 0,
"value": " template variable. If unspecified, a default description is used."
},
{
"children": [
],
"type": 8,
"value": "br"
},
{
"type": 0,
"value": " "
},
{
"children": [
{
"type": 0,
"value": "Note"
}
],
"type": 8,
"value": "strong"
},
{
"type": 0,
"value": ": the length of the result is capped to 100 characters."
}
],
"JKq3TC": [
{
"type": 0,
Expand Down Expand Up @@ -3905,6 +3959,12 @@
"value": "De waarde voor \"verwerking\" die meegestuurd wordt bij het bevragen van de BRP Personen API. Mogelijke waarden hiervoor zijn afhankelijk van je gateway-leverancier."
}
],
"ZSvQcR": [
{
"type": 0,
"value": "TITLE parameter"
}
],
"ZdZ2Mb": [
{
"type": 0,
Expand Down Expand Up @@ -4467,6 +4527,12 @@
"value": "'Groep bewaren'-tekst"
}
],
"eZJFP7": [
{
"type": 0,
"value": "COM parameter"
}
],
"ee4oWr": [
{
"type": 0,
Expand Down Expand Up @@ -6265,6 +6331,36 @@
"value": "De inhoud van bevestigingspagina na het versturen van de inzending. Dit sjabloon mag variabelen bevatten met inzendings-gegevens. Laat dit veld leeg om de standaardinstelling te gebruiken."
}
],
"vikURf": [
{
"type": 0,
"value": "Optional custom template for the title displayed on the payment page."
},
{
"children": [
],
"type": 8,
"value": "br"
},
{
"type": 0,
"value": " You can use all form variables (using their keys) and the "
},
{
"children": [
{
"type": 0,
"value": "public_reference"
}
],
"type": 8,
"value": "code"
},
{
"type": 0,
"value": " template variable. If unspecified, a default description is used."
}
],
"vlY36U": [
{
"type": 0,
Expand Down
4 changes: 3 additions & 1 deletion ...openforms/js/components/admin/form_design/payments/ogone_legacy/OgoneLegacyOptionsForm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
import {getChoicesFromSchema} from 'utils/json-schema';

import OptionsConfiguration from '../OptionsConfiguration';
import {MerchantID} from './fields';
import {ComTemplate, MerchantID, TitleTemplate} from './fields';

const OgoneLegacyOptionsForm = ({schema, formData, onSubmit}) => {
const validationErrors = useContext(ValidationErrorContext);
Expand Down Expand Up @@ -41,6 +41,8 @@ const OgoneLegacyOptionsForm = ({schema, formData, onSubmit}) => {
<ValidationErrorsProvider errors={relevantErrors}>
<Fieldset>
<MerchantID options={merchantChoices} />
<TitleTemplate />
<ComTemplate />
</Fieldset>
</ValidationErrorsProvider>
</OptionsConfiguration>
Expand Down
73 changes: 73 additions & 0 deletions src/openforms/js/components/admin/form_design/payments/ogone_legacy/fields.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import {useField} from 'formik';
import PropTypes from 'prop-types';
import {FormattedMessage} from 'react-intl';

import Field from 'components/admin/forms/Field';
import FormRow from 'components/admin/forms/FormRow';
import {TextInput} from 'components/admin/forms/Inputs';
import ReactSelect from 'components/admin/forms/ReactSelect';

export const MerchantID = ({options}) => (
Expand All @@ -21,6 +23,7 @@ export const MerchantID = ({options}) => (
defaultMessage="Which merchant should be used for payments related to this form."
/>
}
required
>
<ReactSelect name="merchantId" options={options} required />
</Field>
Expand All @@ -35,3 +38,73 @@ MerchantID.propTypes = {
})
).isRequired,
};

export const TitleTemplate = () => {
const [fieldProps] = useField('titleTemplate');
return (
<FormRow>
<Field
name="titleTemplate"
label={
<FormattedMessage
description="Ogone legacy payment options 'titleTemplate' label"
defaultMessage="TITLE parameter"
/>
}
helpText={
<FormattedMessage
description="Ogone legacy payment options 'titleTemplate' help text"
defaultMessage={`Optional custom template for the title displayed on the payment page.<br></br>
You can use all form variables (using their keys) and the <code>public_reference</code>
template variable. If unspecified, a default description is used.`}
values={{
br: () => <br />,
code: chunks => <code>{chunks}</code>,
}}
/>
}
>
<TextInput {...fieldProps} />
</Field>
</FormRow>
);
};

TitleTemplate.propTypes = {};

export const ComTemplate = () => {
const [fieldProps] = useField('comTemplate');
return (
<FormRow>
<Field
name="comTemplate"
label={
<FormattedMessage
description="Ogone legacy payment options 'comTemplate' label"
defaultMessage="COM parameter"
/>
}
helpText={
<FormattedMessage
description="Ogone legacy payment options 'comTemplate' help text"
defaultMessage={`Optional custom template for the the description, included in the
payment overviews for the backoffice. Use this to link the payment back to a particular
process or form.<br></br>
You can use all form variables (using their keys) and the <code>public_reference</code>
template variable. If unspecified, a default description is used.<br></br>
<strong>Note</strong>: the length of the result is capped to 100 characters.`}
values={{
br: () => <br />,
code: chunks => <code>{chunks}</code>,
strong: chunks => <strong>{chunks}</strong>,
}}
/>
}
>
<TextInput {...fieldProps} />
</Field>
</FormRow>
);
};

ComTemplate.propTypes = {};
Loading
Loading