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 (controlId, isDone, completed, result, wait()).

Properties

No additional properties beyond the base Action interface.

Methods

stop

Stop payment collection.

Example

1 import { RelayClient } from '@signalwire/sdk';
2 
3 const client = new RelayClient({
4   project: process.env.SIGNALWIRE_PROJECT_ID!,
5   token: process.env.SIGNALWIRE_TOKEN!,
6   contexts: ['default']
7 });
8 
9 client.onCall(async (call) => {
10   await call.answer();
11   const action = await call.pay('https://example.com/payment-connector', {
12     chargeAmount: '29.99',
13     currency: 'USD',
14   });
15 
16   const event = await action.wait();
17   console.log(`Payment state: ${event.params.state}`);
18 });
19 
20 await client.run();