Create Patient Credit Settled

curl --request POST \
  --url https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
[
  {
    "patientId": "<string>",
    "totalOutstanding": 123,
    "id": "<string>",
    "patient": {
      "id": "<string>",
      "type": "PROVIDER",
      "createdDate": "2023-11-07T05:31:56Z",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "locationId": "<string>",
      "externalId": "<string>",
      "address": "<string>",
      "addressLineTwo": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "addressValid": true,
      "meta": {},
      "isArchived": true,
      "primaryLocationId": "<string>",
      "gender": "<string>",
      "dateOfBirth": "2023-12-25",
      "patientMedications": [
        "<string>"
      ],
      "onSchedulingBlacklist": true,
      "surchargeDisabled": true,
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "isActive": true,
          "createdDate": "2023-11-07T05:31:56Z",
          "emoji": "<string>",
          "color": "<string>",
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      ],
      "creditBalance": 123,
      "preferredProviderId": "<string>"
    },
    "total": 0,
    "description": "<string>",
    "status": "OUTSTANDING",
    "discountAmount": 0,
    "discountPercentage": 0,
    "externalId": "<string>",
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "ruleSetId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "creatorId": "<string>",
    "items": [],
    "tips": [],
    "locationId": "<string>",
    "eventId": "<string>",
    "memberId": "<string>",
    "comment": "<string>",
    "meta": {},
    "merchantAccountId": "<string>",
    "payments": [],
    "adjustments": []
  }
]
'

{
  "id": "<string>",
  "amount": 123,
  "status": "CANCELED",
  "paymentMedium": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "feeToPatient": 123,
  "patientId": "<string>",
  "payinId": "<string>",
  "currency": "USD",
  "payinConfigId": "<string>",
  "paymentMethodId": "<string>",
  "stripePaymentIntentId": "<string>",
  "failedReason": "<string>",
  "updatedDate": "2023-11-07T05:31:56Z",
  "fee": 0
}

POST

billing

payment-terminal

charge

create-patient-credit-settled

Create Patient Credit Settled

curl --request POST \
  --url https://api.decodahealth.com/billing/payment-terminal/charge/create-patient-credit-settled \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
[
  {
    "patientId": "<string>",
    "totalOutstanding": 123,
    "id": "<string>",
    "patient": {
      "id": "<string>",
      "type": "PROVIDER",
      "createdDate": "2023-11-07T05:31:56Z",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "locationId": "<string>",
      "externalId": "<string>",
      "address": "<string>",
      "addressLineTwo": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "addressValid": true,
      "meta": {},
      "isArchived": true,
      "primaryLocationId": "<string>",
      "gender": "<string>",
      "dateOfBirth": "2023-12-25",
      "patientMedications": [
        "<string>"
      ],
      "onSchedulingBlacklist": true,
      "surchargeDisabled": true,
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "isActive": true,
          "createdDate": "2023-11-07T05:31:56Z",
          "emoji": "<string>",
          "color": "<string>",
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      ],
      "creditBalance": 123,
      "preferredProviderId": "<string>"
    },
    "total": 0,
    "description": "<string>",
    "status": "OUTSTANDING",
    "discountAmount": 0,
    "discountPercentage": 0,
    "externalId": "<string>",
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "ruleSetId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "creatorId": "<string>",
    "items": [],
    "tips": [],
    "locationId": "<string>",
    "eventId": "<string>",
    "memberId": "<string>",
    "comment": "<string>",
    "meta": {},
    "merchantAccountId": "<string>",
    "payments": [],
    "adjustments": []
  }
]
'

{
  "id": "<string>",
  "amount": 123,
  "status": "CANCELED",
  "paymentMedium": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "feeToPatient": 123,
  "patientId": "<string>",
  "payinId": "<string>",
  "currency": "USD",
  "payinConfigId": "<string>",
  "paymentMethodId": "<string>",
  "stripePaymentIntentId": "<string>",
  "failedReason": "<string>",
  "updatedDate": "2023-11-07T05:31:56Z",
  "fee": 0
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

amount

integer

required

Body

application/json

patientId

string

required

Identifier of the patient being charged.

totalOutstanding

integer

required

Total outstanding amount that is yet to be paid.

string | null

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

patient

PatientSummary · object

Summary details of the patient being charged.

Show child attributes

patient.id

string

required

The unique identifier for the user.

patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

patient.createdDate

string<date-time>

required

The date and time when the user was created.

patient.firstName

string | null

The user's first name.

patient.lastName

string | null

The user's last name.

patient.phoneNumber

string | null

The user's phone number.

patient.email

string | null

The user's email address.

patient.locationId

string | null

The location of the user.

patient.externalId

string | null

The user's external identifier if available.

patient.address

string | null

The user's primary address.

patient.addressLineTwo

string | null

Additional address information.

patient.city

string | null

The city of the user's address.

patient.state

string | null

The state of the user's address.

patient.zipCode

string | null

The postal code of the user's address.

patient.country

string | null

The country of the user's address.

patient.addressValid

boolean | null

Whether the user's address is valid.

patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

patient.isArchived

boolean | null

Whether the user is archived.

patient.primaryLocationId

string | null

The primary location of the user.

patient.gender

string | null

The gender of the patient.

patient.dateOfBirth

string<date> | null

The date of birth of the patient.

patient.patientMedications

string[] | null

List of patient's self-reported medications.

patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

patient.tags.id

string

required

Unique identifier for the patient tag

patient.tags.name

string

required

Name of the patient tag

patient.tags.isActive

boolean

required

Whether the tag is active

patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

patient.tags.emoji

string | null

Emoji associated with the tag

patient.tags.color

string | null

Color code for the tag (hex format)

patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

patient.creditBalance

integer | null

Patient's credit balance in cents.

patient.preferredProviderId

string | null

The preferred provider ID for this patient.

total

integer

default:0

Total amount of the charge.

description

string | null

Description of the charge.

status

enum<string>

default:OUTSTANDING

Current status of the charge.

Available options:

OUTSTANDING,

PAID,

EXTERNAL_SETTLEMENT,

VOID,

WRITE_OFF,

REFUNDED,

CHARGEBACK,

PAYMENT_PLAN,

COLLECTIONS

discountAmount

integer | null

default:0

Any discount applied to the total outstanding.

discountPercentage

number | null

default:0

Percentage of discount applied to the charge.

externalId

string | null

External identifier for the charge, if applicable.

externalCreatedDate

string<date-time> | null

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

ruleSetId

string | null

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

createdDate

string<date-time> | null

The date when the charge was created.

creatorId

string | null

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

items

ChargeItem · object[]

List of Items in the Charge.

Show child attributes

items.chargeId

string

required

Identifier of the charge this item is associated with

items.quantity

integer

required

Quantity of the item being charged

items.price

integer

required

Price of the item in cents

items.id

string | null

Unique identifier for the charge item

items.itemId

string | null

Optional unique identifier for the item

items.name

string | null

Name of the item (None for items with associated inventory item)

items.description

string | null

Description of the item

items.discountAmount

integer | null

Discount amount for the item

items.discountPercentage

number | null

Discount percentage for the item

items.discountReason

string | null

Reason for discount

items.soldPackageId

string | null

Unique identifier for the sold package usage

items.bankedQuantity

integer | null

Quantity to bank for later use

items.bankedItemId

string | null

ID of banked item being used (for tracking usage)

items.issuedDiscountId

string | null

Unique identifier for the specific issued discount instance used

items.soldByProviderId

string | null

Unique identifier for the provider who sold the item

items.taxAmount

integer | null

Tax amount for the item in cents

items.pricingId

string | null

Unique identifier for the pricing for the item

items.shipmentIds

string[] | null

Optional list of shipment IDs to reduce the stock quantity of

tips

TipDetail · object[]

List of Tips in the Charge.

Show child attributes

tips.chargeId

string

required

Charge ID this tip belongs to

tips.amount

integer

required

Tip amount in cents

tips.providerId

string

required

Provider ID receiving the tip

tips.id

string

Unique identifier for the tip

tips.provider

ProviderTiny · object

Provider receiving the tip

Show child attributes

tips.provider.id

string

required

tips.provider.firstName

string

required

tips.provider.lastName

string | null

tips.provider.email

string | null

tips.provider.createdDate

string<date-time> | null

locationId

string | null

Identifier of the Location where the charge was created.

eventId

string | null

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

memberId

string | null

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

comment

string | null

Any additional comments about the charge.

Response

Successful Response

string

required

The unique identifier for the payment.

amount

integer

required

The total amount of the payment.

status

enum<string>

required

The current status of the payment.

Available options:

CANCELED,

CREATED,

FAILED,

IN_REVIEW,

PRESENTING,

PROCESSING,

SUCCEEDED

paymentMedium

string

required

The name of the payment medium.

createdDate

string<date-time>

required

The date and time the payment was created.

feeToPatient

integer

required

The fee charged to the patient for the transaction.

patientId

string | null

The ID of the patient associated with the payment.

payinId

string | null

The ID of the payin associated with the payment.

currency

string

default:USD

The currency in which the payment was made.

payinConfigId

string | null

The configuration ID for the payin.

paymentMethodId

string | null

The ID of the payment method used.

stripePaymentIntentId

string | null

Stripe's payment intent ID if used.

failedReason

string | null

Reason for payment failure if applicable.

updatedDate

string<date-time> | null

The date and time the payment was last updated.

fee

integer

default:0

The fee charged by the payment processor.

Create Patient Credit Payment Create Payin Config

⌘I

Getting Started

API

Tenant

Webhook

Create Patient Credit Settled

Headers

Query Parameters

Body

Response