Get patient payment

Retrieves a previously created patient payment by its patient_payment_id.

get/api/patient-payments/v4/{patient_payment_id}

Request

Base URL
https://pre-api.joincandidhealth.com
URL
https://pre-api.joincandidhealth.com/api/patient-payments/v4/{patient_payment_id}
Auth
HTTP bearer

patient_payment_idstring uuid required

Response with status 200

patient_payment_idstring uuid required

organization_idstring uuid required

source_internal_idstring

amount_centsinteger required

patient_external_idstring required

payment_timestampstring date-time

payment_notestring

invoicestring uuid

Sep 17, 202624b2d80d577a Revision changes
- breaking
  the response's body type changed from no type to object for status
- warning
  deleted the header request parameter Authorization
- info
  the endpoint scheme security OAuthScheme was added to the API
- info
  for the path request parameter patient_payment_id, the type was generalized from no type to string, and format from no format to uuid
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Sep 12, 20263a81ee81d4ed Revision changes
- info
  api operation id get removed and replaced with v4_get