Check with the payment provider whether the charge's checkout was paid, and record it if so. Safe to repeat. 409 `payments_unavailable` when online payment is off; 409 `automatic_charge` for a charge taken from the saved card

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

Request

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

Path parameters

idstring required
chargeIdstring required

Response

The charge as it now is.

idstring required
kind'platform_fee' | 'court_costs' | 'service_costs' | 'other' required
descriptionstring required
amountCentsinteger required

US cents.

status'due' | 'paid' | 'void' | 'refunded' required
collection'checkout' | 'automatic' required

How the charge is paid. checkout: on the payment page (POST /v1/cases/{id}/charges/{chargeId}/checkout). automatic: a cost of a full-service case, taken from a saved card (/v1/payment-methods); it is never paid by checkout.

paidAtstring date-time nullable required
receiptUrlstring uri nullable required

The payment provider's public receipt page for a paid charge, kept shortly after the payment is recorded. Null until then, when it could not be read, and for charges paid before receipt links were kept (their receipt was sent by email).

createdAtstring date-time required

Changes

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