Sign in
provider
billing

Move Payment

Move a payment and all related objects from one patient to another.

This function updates:

  1. The payment itself (patient_id)
  2. Payment method used for the payment (patient_id) if it exists
  3. All charges associated with this payment (patient_id)
  4. All alerts related to the payment (patient_id)
  5. All alerts related to the charges (patient_id)
  6. All alerts related to adjustments of the charges (patient_id)
  7. All alerts related to refunds of the payment (patient_id)
post/billing/payment/move

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

paymentIdstring required

The ID of the payment to move.

newPatientIdstring required

The ID of the patient to move the payment to.

Response

Successful Response

idstring required

The unique identifier for the payment.

patientIdstring nullable

The ID of the patient associated with the payment.

payinIdstring nullable

The ID of the payin associated with the payment.

amountinteger required

The total amount of the payment.

status'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED' required
currencystring

The currency in which the payment was made.

payinConfigIdstring nullable

The configuration ID for the payin.

paymentMediumstring required

The name of the payment medium.

paymentMethodIdstring nullable

The ID of the payment method used.

stripePaymentIntentIdstring nullable

Stripe's payment intent ID if used.

failedReasonstring nullable

Reason for payment failure if applicable.

updatedDatestring date-time nullable

The date and time the payment was last updated.

createdDatestring date-time required

The date and time the payment was created.

feeinteger

The fee charged by the payment processor.

feeToPatientinteger required

The fee charged to the patient for the transaction.

Changes

No recorded changes to this endpoint across all 1 revision of this API.