GET
/
v1
/
charge
/
get
/
{charge_id}
curl --request GET \
  --url https://api.decodahealth.com/v1/charge/get/{charge_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "adjustments": [
    {
      "adjustmentType": "WRITE_OFF",
      "amount": 123,
      "chargeId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "providerId": "<string>",
      "reason": "<string>"
    }
  ],
  "createdDate": "2023-11-07T05:31:56Z",
  "customAmount": 123,
  "description": "<string>",
  "discountAmount": 123,
  "discountPercentage": 123,
  "explanationOfBenefits": [
    {
      "chargeBalance": 123,
      "chargeId": "<string>",
      "contractualAdjustment": 123,
      "diagnoses": "<string>",
      "diagnosesDescription": "<string>",
      "id": "<string>",
      "insurancePayment": 123,
      "locationName": "<string>",
      "manualAdjustment": 123,
      "originalChargeAmount": 123,
      "patientBalance": 123,
      "patientPayment": 123,
      "procedure": "<string>",
      "procedureDescription": "<string>"
    }
  ],
  "externalCreatedDate": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "id": "<string>",
  "items": [
    {
      "chargeId": "<string>",
      "discountAmount": 123,
      "discountPercentage": 123,
      "item": {
        "description": "<string>",
        "id": "<string>",
        "image": "<string>",
        "meta": {},
        "name": "<string>",
        "price": 123,
        "unit": "<string>"
      },
      "itemId": "<string>",
      "quantity": 123
    }
  ],
  "meta": {},
  "patient": {
    "address": "<string>",
    "addressLineTwo": "<string>",
    "addressValid": true,
    "allergies": [
      "<string>"
    ],
    "city": "<string>",
    "country": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "dateOfBirth": "2023-12-25",
    "email": "<string>",
    "externalUserId": "<string>",
    "familyHistory": [
      "<string>"
    ],
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "medicalHistory": [
      "<string>"
    ],
    "medications": [
      "<string>"
    ],
    "meta": {},
    "optedOutOfSms": false,
    "phoneNumber": "<string>",
    "prescriptions": [
      "<string>"
    ],
    "state": "<string>",
    "type": "<string>",
    "zipCode": "<string>"
  },
  "patientId": "<string>",
  "patientPaysProcessingFee": true,
  "payments": [
    {
      "amount": 123,
      "charge": {
        "externalId": "<string>",
        "id": "<string>",
        "meta": {},
        "total": 123,
        "totalOutstanding": 123
      },
      "chargeId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "payment": {
        "amount": 123,
        "createdDate": "2023-11-07T05:31:56Z",
        "currency": "USD",
        "failedReason": "<string>",
        "fee": 123,
        "id": "<string>",
        "patientId": "<string>",
        "payinConfigId": "<string>",
        "payinId": "<string>",
        "paymentMedium": "POS",
        "paymentMethod": {
          "accountHolderType": "<string>",
          "accountNumberLast4": 123,
          "bankName": "<string>",
          "brand": "<string>",
          "description": "<string>",
          "expMonth": 123,
          "expYear": 123,
          "id": "<string>",
          "last4": "<string>",
          "patientId": "<string>",
          "rainforestPaymentMethodId": "<string>",
          "routingNumber": 123,
          "type": "CARD"
        },
        "paymentMethodId": "<string>",
        "refunds": [
          {
            "amount": 123,
            "createdDate": "2023-11-07T05:31:56Z",
            "fee": 0,
            "id": "<string>",
            "paymentId": "<string>",
            "rainforestRefundId": "<string>",
            "reason": "DUPLICATE",
            "status": "CANCELED"
          }
        ],
        "status": "CANCELED",
        "stripePaymentIntentId": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z"
      },
      "paymentId": "<string>"
    }
  ],
  "ruleSetId": "<string>",
  "status": "OUTSTANDING",
  "total": 123,
  "totalOutstanding": 123
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
charge_id
string
required

Response

200
application/json
Successful Response
​
adjustments
object[]
required
​
createdDate
string
required

The date when the charge was created.

​
customAmount
integer
required

Any un-itemized amount that makes up the charge.

​
discountAmount
integer
required

Amount of discount applied to the charge.

​
discountPercentage
number
required

Percentage of discount applied to the charge.

​
explanationOfBenefits
object[]
required
​
id
string
required

Unique identifier for the charge.

​
items
object[]
required
​
patient
object
required

Summary details of the patient being charged.

​
patientId
string
required

Identifier of the patient being charged.

​
patientPaysProcessingFee
boolean
required

Indicates if the patient is responsible for processing fees.

​
payments
object[]
required
​
status
enum<string>
required

Current status of the charge.

Available options:
OUTSTANDING,
PAID,
EXTERNAL_SETTLEMENT,
VOID,
WRITE_OFF,
REFUNDED,
PAYMENT_PLAN
​
total
integer
required

Total amount of the charge.

​
totalOutstanding
integer
required

Total outstanding amount that is yet to be paid or adjusted away.

​
description
string | null

Description of the charge.

​
externalCreatedDate
string | null

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

​
externalId
string | null

External identifier for the charge, if applicable.

​
meta
object | null

Any additional metadata about the charge relevant to your system.

​
ruleSetId
string | null

Identifier for the rule set applied to this charge, if any.

Charge CreateCharge Get By External Id