Create Payment

post

https://api.sandbox.hint.com/api/provider/companies/{company_id}/invoices/{invoice_id}/payments

Path Params

company_id

string

required

Unique Company ID

invoice_id

string

required

Unique 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.

external

boolean

When creating a payment, stripe 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

Response

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

application/json

200Successful response