Skip to main content

<Parameter>

The <Parameter> noun allows the user to send additional parameters to a payment connector using the <Pay> verb.

<Parameter> Attributes

<Parameter> supports the following attributes that change its behavior:

AttributeAllowed ValuesDefault Value
namestringnone
valuestringnone
historydisable, compact, fulldisable

name

The name attribute is the name of the parameter to send to the payment connector.

value

The value attribute is the value of the parameter to send to the payment connector.

history

The history attribute determines if the <Parameter> noun should be logged in the history array of the CDR. The default is to not log.

For <Parameter>, both compact and full have the same effect of logging an empty payload to the history array.

{
"payload": {}
}

<Parameter> Examples

Simple Usage

Send the customer's phone number to the payment connector.

<Response>
<Pay action="/next" chargeAmount="10.00" paymentConnector="test">
<Parameter name="CustomerPhone" value="888-8888-888/>
</Pay>
</Response>