[hey-august]

Description

Brings the cXML <Pay> and SWML pay reference pages in line with the platform, verified against the platform and the API spec. Tokenization is the main fix: the pages now say plainly that the connector's token_id comes back as PaymentToken / pay_payment_results.payment_token.

cXML <Pay>

• Tokenization: removed ProfileId (never sent), described PaymentToken and PaymentConfirmationCode precisely, rewrote the broken <Note>, and added a "Tokenize a card end to end" example.
• action parameters: renamed to what's sent (PayResult, PaymentCardExpirationDate, PaymentCardSecurityCode, PaymentErrorCode, PaymentConnectorError), and added PaymentConnectorErrorCode and BankAccountType.
• Connector request: merged the two tabs (charges and tokenization send the same fields), corrected chargeAmount (string, not amount) and parameters (an array of single-key objects), and used an unmasked test card in the example.
• statusCallback: completed the For values, merged the duplicate events table into them, and noted that payment-completed is also sent for declines.
• Attributes: minPostalCodeLength and securityCode are optional (defaults 0 / true), and paymentConnectorUrl must be HTTPS.
• Replaced "Security best practices" with "Securing your payment connector": connector requests aren't signed, so put a secret in the URL.
• Example fixes: a stray </Pay>, <Prompt name= → for=, and garbled characters.

SWML pay

• Same connector request, token variable and security fixes as cXML. parameters was missing from the request body.
• params.for now lists its values, with the same payment-completed caveat.

Spec

• pay/main.tsp: the doc links now point to /docs/swml/reference/calling/pay. The regenerated output changes only those two links.

Notes for reviewers

• The tokenization example and the PaymentToken / payment_token descriptions describe intended behavior. A platform fix that returns token_id there is approved but not yet deployed.
• Left as they were: cXML examples that leave out paymentConnectorUrl, the undocumented bankAccountType / voice attributes and ACH connector fields, and legacy heading styles.

Preview:

• /docs/compatibility-api/cxml/reference/voice/pay
• /docs/swml/reference/calling/pay

Type of Change

• Bug fix
• New feature
• Breaking change
• Documentation update
• Code cleanup / refactor

Related Issues

Closes #832
See also: signalwire/cloud-product#21804

Testing

• Added/updated unit tests
• Tested manually
• Tested with live SignalWire credentials (if applicable)

Checklist

• I have read the CONTRIBUTING guidelines
• My code follows the project's style guidelines
• I have added tests for my changes (if applicable)
• I have updated documentation (if applicable)
• All existing tests pass

[github-actions]

🌿 Preview

https://signalwire-preview-docs-833.docs.buildwithfern.com/docs

---

View workflow run