HIhint
InvoicePayment

Create Payment

Changed on

Payments can be created only against an issued, sent, retrying, or bad_debt invoice; any other status fails with 422 Invoice is not payable. An invoice can not be overpaid: an amount_in_cents above the invoice's due_in_cents fails with 422 Amount is greater than the amount due on the invoice, and a new payment while an earlier one is still in flight fails with 422 Invoice has a pending payment or 422 Invoice has an unattempted payment. The returned amount_in_cents is the gross amount attempted on the payment method and may include processing fees passed through to the patient, so it can exceed the invoice total. Use the invoice's paid_in_cents for the amount applied to the invoice.

post/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

Request body

amount_in_centsnumber double

When creating a payment you can add an amount_in_cents, if no amount is included, we will set the payment amount = due_in_cents. Must not exceed the invoice's due_in_cents.

externalboolean

When creating a payment, processed payments are required to include process: true, mark-as-paid payments are required to include external: true as an attribute. The request fails if it does not contain only one of these attributes.

memostring
processboolean

When creating a payment, processed payments are required to include process: true, mark-as-paid payments are required to include external: true as an attribute. The request fails if it does not contain only one of these attributes.

paid_atstring date

When creating a payment you can specify the date, if no a date is included, we will set it to the Hint.today date. Date must be formatted as YYYY-MM-DD.

Response

Successful response

idstring
error_messagestring
memostring
statusstring
datestring date-time
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.

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.

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