payments

Create Payment

post/api/payments

Headers

X-API-Keystring required

Request body

serviceIdstring required
paidAtstring date-time required
transactionIdstring required

Unique transaction ID associated with this payment, this must be unique. Use for deduplication, a 409 will be returned if trying to create another Payment with same transactionId.

type'PATIENT' | 'ADJUSTMENT' required
amountinteger required

Payment amount, in USD cents. Positive values are payments paid by the Patient, negative values are refunds given back to the Patient.

externalIdstring

Associate with any External ID value, should also be unique

memostring

Response

Response with status 200

idstring required
createdAtstring date-time required
serviceIdstring required
paidAtstring date-time required
transactionIdstring required
type'PATIENT' | 'ADJUSTMENT' required
amountinteger required
externalIdstring
memostring

Changes