COcollectly
payments

Refund payment.

Changed on

Refund payment. Payment can be refunded both fully and partially.

post/practices/{practice_id}/payments/{payment_id}/refund

Request

  • Base URL
    sandbox.collectly.co/api/api/partners/v1 (relative, and the document’s source URL is not known)
  • URL
    sandbox.collectly.co/api/api/partners/v1/practices/{practice_id}/payments/{payment_id}/refund
  • Auth
    API key in header Authorization

Path parameters

practice_idstring required

Practice ID in which the requested resource exists

payment_idstring required

Payment ID (Collectly ID)

Request body

amountnumber nullable
collectly_idstring

Unique Collectly resource ID

collectly_payment_plan_idstring

Collectly payment plan ID. It is NOT null in case the payment was charged as a part of the payment plan

collectly_source_payment_idstring

Collectly source payment ID. Used only for refunds.

copay_amountnumber
created_atunknown
idstring required

Unique resource ID from your integration

modified_atunknown
patient_idstring required

Patient ID from your integration who owns the resource

payment_type'payment' | 'copay' | 'refund' | 'part_ref' | 'autodeb' | 'collect'
post_datestring date nullable
statusstring
transaction_idstring nullable

Response

OK

amountnumber nullable
collectly_idstring

Unique Collectly resource ID

collectly_payment_plan_idstring

Collectly payment plan ID. It is NOT null in case the payment was charged as a part of the payment plan

collectly_source_payment_idstring

Collectly source payment ID. Used only for refunds.

copay_amountnumber
created_atunknown
idstring required

Unique resource ID from your integration

modified_atunknown
patient_idstring required

Patient ID from your integration who owns the resource

payment_type'payment' | 'copay' | 'refund' | 'part_ref' | 'autodeb' | 'collect'
post_datestring date nullable
statusstring
transaction_idstring nullable

Changes