Create Payment

post

https://api.sandbox.hint.com/api/provider/customer_invoices/{customer_invoice_id}/payments

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.

Path Params

customer_invoice_id

string

required

Unique Customer Invoice ID

Body Params

amount_in_cents

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.

external

boolean

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.

memo

string

process

boolean

paid_at

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.

source

object

A payment source to process the payment can be specified, if empty the patient's default payment source will be used. The request fails if the patient has no default payment source and source is not specified.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response