pay.parameters

The parameters object within the pay method enables you to:

• Pass custom parameters to your payment processor
• Include additional payment details not covered by the standard pay attributes

Name	Type	Description
parametersOptional	object[]	-	Array of parameter objects to pass to your payment processor.

Parameter object

Name	Type	Description
nameRequired	string	The identifier for your custom parameter. This will be the key in the parameters object.
valueRequired	string	The value associated with the parameter. This will be the value in the parameters object.

Examples

Adding custom parameters for generic transaction

YAML

version: 1.0.0
sections:
  main:
    - pay:
        charge_amount: "10.00"
        payment_connector_url: "https://example/signalwire/parameter/pay"
        parameters:
          - name: "my_custom_parameter_1"
            value: "my_custom_value_1"

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "pay": {
          "charge_amount": "10.00",
          "payment_connector_url": "https://example/signalwire/parameter/pay",
          "parameters": [
            {
              "name": "my_custom_parameter_1",
              "value": "my_custom_value_1"
            }
          ]
        }
      }
    ]
  }
}