For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Compatibility API
    • cXML Specification
  • Guides
    • Compatibility API Webhooks
    • Receive SMS
    • Send SMS
    • Inbound Fax Callback
    • Add mustache template parameters to cXML responses
    • Gathering user input
  • Voice
    • Overview
    • Conference
    • Connect
    • Denoise
    • Dial
    • Echo
    • Enqueue
    • Gather
    • Hangup
    • Leave
    • Number
    • Pause
    • Pay
      • Parameter
      • Prompt
    • Play
    • Queue
    • Record
    • Redirect
    • Refer
    • Reject
    • Room
    • Say
    • Sip
    • Sms
    • Stream
    • Verto
    • VirtualAgent
  • Messaging
    • Overview
    • Message
    • Redirect
  • Fax
    • Overview
    • Receive
    • Reject
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Attributes
  • Examples
  • Adding custom parameters for generic transaction
VoicePay

Parameter

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

Prompt

Next
Built with

The <Parameter> noun within the <Pay> verb enables you to:

  • Pass custom parameters to your payment processor when using a Generic Pay Connector
  • Include additional ACH payment details not covered by the standard <Pay> verb attributes

Attributes

AttributeTypeDefaultDescription
namerequiredstring-The identifier for your custom parameter.
valuerequiredstring-The value associated with the parameter name.

Examples

Adding custom parameters for generic transaction

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3    <Pay chargeAmount="10.00" paymentConnector="https://example/signalwire/parameter/pay" action="https://example/signalwire/parameter/pay/action">
4        <Parameter name="my_custom_parameter_1" value="my_custom_value_1" />
5    </Pay>
6</Response>