Open a hosted checkout for one due charge. 409 `payments_unavailable` when online payment is off; 409 `charge_not_due` when the charge is paid, void or refunded; 409 `automatic_charge` for a charge taken from the saved card

post/v1/cases/{id}/charges/{chargeId}/checkout

Request

  • Base URL: https://api.evictionsapi.com
  • URL: https://api.evictionsapi.com/v1/cases/{id}/charges/{chargeId}/checkout
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required
chargeIdstring required

Response

The checkout URL to send the customer to. They return to the case page on the website.

urlstring uri required

Changes

No recorded changes to this operation across all 1 revision of this API.