---
canonical_url: "https://docs.composio.dev/toolkits/paychasers"
markdown_url: "https://docs.composio.dev/toolkits/paychasers.md"
product: "platform"
version: null
last_updated: null
---

# PayChasers

PayChasers automates payment reminders, client management, payment chases, and follow-ups for overdue accounts.

- **Category:** payment processing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `PAYCHASERS`
- **Version:** 00000000_00

## Tools

### Create Chase

**Slug:** `PAYCHASERS_CREATE_CHASE`

Create a payment chase and potentially send its initial reminder immediately. Using client_email may also create a persistent client. Neither the chase nor the client can be deleted through the API, and FREE accounts allow at most five active chases.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | number | Yes | Payment amount in the specified currency. |
| `currency` | string | Yes | Currency string for the payment, such as the connected account's currency returned by GET_CURRENT_USER. |
| `due_date` | string | No | Payment due date in YYYY-MM-DD format. |
| `client_id` | string | No | Existing PayChasers client ID. Provide exactly one of client_id or client_email. |
| `auto_chase` | boolean | No | Whether PayChasers should continue automated follow-ups after creation. Defaults to false for safer calls. |
| `chase_type` | string ("INVOICE" | "CLIENT_PAYMENT" | "CONTRACT_MILESTONE" | "PERSONAL_DEBT" | "BUSINESS_PAYMENT" | "SUBSCRIPTION" | "CUSTOM") | No | Category of payment chase. |
| `client_name` | string | No | Client name to use when client_email causes a new client to be created. |
| `client_email` | string | No | Client email to find or create automatically. Provide exactly one of client_email or client_id; a newly created client cannot be deleted through the API. |
| `payment_name` | string | Yes | Name of the payment being chased. |
| `delivery_channel` | string ("EMAIL" | "WHATSAPP" | "BOTH") | No | Initial reminder channel. Creating a chase may send this reminder immediately. WHATSAPP and BOTH require Pro+ or Enterprise and fall back to EMAIL on the FREE plan. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Client

**Slug:** `PAYCHASERS_CREATE_CLIENT`

Create a persistent PayChasers client from a name, billing email, and notes. PayChasers provides no API endpoint to delete the client afterward.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Client name. |
| `email` | string | Yes | Client billing email address. |
| `notes` | string | Yes | Notes to store with the client. PayChasers accepts notes but does not return them in the verified create response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `PAYCHASERS_GET_CURRENT_USER`

Return the connected PayChasers account profile, plan, and default currency; use this to identify the account or check its tier.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Chases

**Slug:** `PAYCHASERS_LIST_CHASES`

Return chases, optionally filtered by exact status and capped by a truncating limit; the API provides no continuation mechanism.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum chases returned in this response. Results are truncated and cannot be continued; omit this to use the provider's default behavior. |
| `status` | string ("SENT" | "PROMISED" | "OVERDUE" | "PAID") | No | Exact chase status to return. PayChasers silently ignores invalid values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Clients

**Slug:** `PAYCHASERS_LIST_CLIENTS`

Return all clients visible to the connected PayChasers account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Chase Paid

**Slug:** `PAYCHASERS_MARK_CHASE_PAID`

Irreversibly mark a chase as paid and stop its automated follow-ups. Warning: PayChasers provides no API operation to reverse this change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chase_id` | string | Yes | Internal chase ID returned by CREATE_CHASE or LIST_CHASES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Follow-Up

**Slug:** `PAYCHASERS_SEND_FOLLOW_UP`

Immediately send one manual follow-up for a chase in the selected tone. Warning: this sends a message to an external recipient and is limited to 10 sends per hour.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tone` | string ("friendly" | "due_today" | "overdue" | "firm") | Yes | Tone of the follow-up message. |
| `chase_id` | string | Yes | Internal chase ID whose recipient should receive the follow-up. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |