provider

billing

Create Patient Credit Settled

Create a patient credit payment for charges.

post/billing/payment-terminal/charge/create-patient-credit-settled

Request

Base URL
https://docs.decodahealth.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: TENANT, API-KEY
TypeScript
https://skmtc.dev/decodahealth/apis/decoda-api/docs/billing/payment-terminal/charge/create-patient-credit-settled/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

amountinteger required

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

idstring nullable

A unique identifier for the charge. Auto-generated if not provided.

patientIdstring required

Identifier of the patient being charged.

totalinteger

Total amount of the charge.

totalOutstandinginteger required

Total outstanding amount that is yet to be paid.

descriptionstring nullable

Description of the charge.

discountAmountinteger nullable

Any discount applied to the total outstanding.

discountPercentagenumber nullable

Percentage of discount applied to the charge.

externalIdstring nullable

External identifier for the charge, if applicable.

externalCreatedDatestring date-time nullable

The creation date of the charge in your external system, if applicable.

ruleSetIdstring nullable

Identifier for the RuleSet applied to this Charge, if any.

createdDatestring date-time nullable

The date when the charge was created.

creatorIdstring nullable

Identifier of the Provider who created the charge (i.e. the Clinician, or relevant Biller).

locationIdstring nullable

Identifier of the Location where the charge was created.

eventIdstring nullable

Identifier of the Event this charge is associated with, if any.

memberIdstring nullable

Identifier of the Member this charge is associated with, if any.

commentstring nullable

Any additional comments about the charge.

metaobject nullable

Any additional metadata about the charge relevant to your system.

merchantAccountIdstring nullable

Identifier of the MerchantAccount this charge is associated with.

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.

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 operation across all 2 revisions of this API.