Payment link
evictions_get_payment_linkUse this when the person wants to pay a due charge on a case, or after evictions_submit_case answered payment_required. Input: the case id and the chargeId from that answer or from evictions_list_case_charges. Opens a hosted checkout for one due charge and returns its URL; asked again while that checkout is open, it returns the same URL. Give the URL to the person: paying is theirs to do, and no tool takes card details. Paying a draft’s platform fee submits the case: it moves to submitted when the payment arrives. Refused when the charge is not due or online payment is off, and, with authorization_required, until the person has signed the case’s authorization for us to act as their agent: then give the person the case page link in the error’s details (signAt), where they read and sign it themselves, and ask again. Do not use this to see whether a charge is paid (use evictions_list_case_charges). Needs the person’s account: sign-in or an API key.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"id": "<id>",
"chargeId": "<chargeId>"
},
"name": "evictions_get_payment_link"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The case id (case_...), as returned by evictions_create_case or evictions_list_cases. | |
| chargeId | Yes | The id of a due charge on that case, from evictions_list_case_charges. |