HIhint
InvoicePayment

List All Payments

Changed on
get/provider/companies/{company_id}/invoices/{invoice_id}/payments

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/companies/{company_id}/invoices/{invoice_id}/payments
  • Auth
    API key in header AUTHORIZATION

Path parameters

company_idstring required

Unique Company ID

invoice_idstring required

Unique Invoice ID

Response

Successful response

idstring
amount_in_centsinteger

Gross amount attempted on the payment method. May include processing fees passed through to the patient, so it can exceed the invoice total; see the invoice's paid_in_cents for the amount applied to the invoice.

datestring date-time
error_messagestring
externalboolean
external_type'cash' | 'check' | 'card' | 'ach' | 'eft' | 'other'

Present only on external (mark-as-paid) payments. Currently always reported as "card", regardless of how the payment was recorded.

memostring
statusstring

Changes

  • c9bda0d2dd87Revision changes
    • warning

      added the new ach enum value to the / response property for the response status

    • warning

      added the new card enum value to the / response property for the response status

    • warning

      added the new cash enum value to the / response property for the response status

    • warning

      added the new check enum value to the / response property for the response status

    • warning

      added the new eft enum value to the / response property for the response status

    • warning

      added the new other enum value to the / response property for the response status