PayAction

Returned from call.pay(). Tracks an active payment collection operation. Terminal states: finished, error.

Inherits all properties and methods from the base Action interface (control_id, is_done, completed, result, wait()).

Properties

No additional properties beyond the base Action interface.

Methods

stop

Stop payment collection.

Example

from signalwire.relay import RelayClient
client = RelayClient(
    project="your-project-id",
    token="your-api-token",
    contexts=["default"],
)
@client.on_call
async def handle_call(call):
    await call.answer()
    action = await call.pay(
        payment_connector_url="https://example.com/payment-connector",
        charge_amount="29.99",
        currency="USD",
    )
    event = await action.wait()
    print(f"Payment state: {event.params.get('state')}")
client.run()