PayAction | SignalWire

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

1 from signalwire.relay import RelayClient
2 
3 client = RelayClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7     contexts=["default"],
8 )
9 
10 @client.on_call
11 async def handle_call(call):
12     await call.answer()
13     action = await call.pay(
14         payment_connector_url="https://example.com/payment-connector",
15         charge_amount="29.99",
16         currency="USD",
17     )
18 
19     event = await action.wait()
20     print(f"Payment state: {event.params.get('state')}")
21 
22 client.run()