# Payment Handles

## Connect a customer handle

`payment_handles.connect(strhandle)  -> PaymentHandleConnection`

**post** `/v3/payments/handles/{handle}/connect`

Starts connecting a customer (by phone/email) so an agent can pay on
their behalf. Linq drives the OTP + consent ceremony through the
messaging channel; this returns `pending` and a `connection.created`
webhook fires once the customer completes it.

### Parameters

- `handle: str`

### Returns

- `class PaymentHandleConnection: …`

  - `connect_id: Optional[str]`

    Returned only by `connect`, and only while the ceremony is pending.
    Nothing on our side persists it — it comes back from the provider and
    is required again to verify — so hold it until you submit the code.

  - `handle: Optional[str]`

  - `status: Optional[Literal["not_connected", "pending", "connected", "revoked"]]`

    - `"not_connected"`

    - `"pending"`

    - `"connected"`

    - `"revoked"`

### Example

```python
import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
payment_handle_connection = client.payment_handles.connect(
    "handle",
)
print(payment_handle_connection.connect_id)
```

#### Response

```json
{
  "connect_id": "cs_01HZY8",
  "handle": "+14155550123",
  "status": "connected"
}
```

## Submit a customer's one-time code

`payment_handles.verify(strhandle, PaymentHandleVerifyParams**kwargs)  -> PaymentHandleConnection`

**post** `/v3/payments/handles/{handle}/verify`

Completes the ceremony `connect` started: verifies the code, records the
customer's consent, and stores the connection. Returns `connected` on
success, after which payments for this handle no longer need the
customer present.

The code reaches you however your channel works — typically the customer
replies with it in the thread. Codes are single-use and short-lived; if
one has expired, call `connect` again for a fresh `connect_id`.

### Parameters

- `handle: str`

- `code: str`

  The one-time code the customer received.

- `connect_id: str`

  The id returned by `connect`.

### Returns

- `class PaymentHandleConnection: …`

  - `connect_id: Optional[str]`

    Returned only by `connect`, and only while the ceremony is pending.
    Nothing on our side persists it — it comes back from the provider and
    is required again to verify — so hold it until you submit the code.

  - `handle: Optional[str]`

  - `status: Optional[Literal["not_connected", "pending", "connected", "revoked"]]`

    - `"not_connected"`

    - `"pending"`

    - `"connected"`

    - `"revoked"`

### Example

```python
import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
payment_handle_connection = client.payment_handles.verify(
    handle="handle",
    code="482913",
    connect_id="cs_01HZY8",
)
print(payment_handle_connection.connect_id)
```

#### Response

```json
{
  "connect_id": "cs_01HZY8",
  "handle": "+14155550123",
  "status": "connected"
}
```

## Get a handle's connection status

`payment_handles.connection(strhandle)  -> PaymentHandleConnection`

**get** `/v3/payments/handles/{handle}/connection`

Get a handle's connection status

### Parameters

- `handle: str`

### Returns

- `class PaymentHandleConnection: …`

  - `connect_id: Optional[str]`

    Returned only by `connect`, and only while the ceremony is pending.
    Nothing on our side persists it — it comes back from the provider and
    is required again to verify — so hold it until you submit the code.

  - `handle: Optional[str]`

  - `status: Optional[Literal["not_connected", "pending", "connected", "revoked"]]`

    - `"not_connected"`

    - `"pending"`

    - `"connected"`

    - `"revoked"`

### Example

```python
import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
payment_handle_connection = client.payment_handles.connection(
    "handle",
)
print(payment_handle_connection.connect_id)
```

#### Response

```json
{
  "connect_id": "cs_01HZY8",
  "handle": "+14155550123",
  "status": "connected"
}
```

## Revoke a handle's connection

`payment_handles.revoke(strhandle)  -> PaymentHandleConnection`

**delete** `/v3/payments/handles/{handle}/connection`

Revokes this partner's grant for the customer. Only your grant is
removed; the customer's wallet at the provider is untouched.

### Parameters

- `handle: str`

### Returns

- `class PaymentHandleConnection: …`

  - `connect_id: Optional[str]`

    Returned only by `connect`, and only while the ceremony is pending.
    Nothing on our side persists it — it comes back from the provider and
    is required again to verify — so hold it until you submit the code.

  - `handle: Optional[str]`

  - `status: Optional[Literal["not_connected", "pending", "connected", "revoked"]]`

    - `"not_connected"`

    - `"pending"`

    - `"connected"`

    - `"revoked"`

### Example

```python
import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
payment_handle_connection = client.payment_handles.revoke(
    "handle",
)
print(payment_handle_connection.connect_id)
```

#### Response

```json
{
  "connect_id": "cs_01HZY8",
  "handle": "+14155550123",
  "status": "connected"
}
```

## Domain Types

### Payment Handle Connection

- `class PaymentHandleConnection: …`

  - `connect_id: Optional[str]`

    Returned only by `connect`, and only while the ceremony is pending.
    Nothing on our side persists it — it comes back from the provider and
    is required again to verify — so hold it until you submit the code.

  - `handle: Optional[str]`

  - `status: Optional[Literal["not_connected", "pending", "connected", "revoked"]]`

    - `"not_connected"`

    - `"pending"`

    - `"connected"`

    - `"revoked"`