Skip to main content
GET
/
billing
/
payment
/
table
List Payments
curl --request GET \
  --url https://api.decodahealth.com/billing/payment/table \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "items": {
    "data": [
      {
        "id": "<string>",
        "amount": 123,
        "currency": "<string>",
        "status": "<string>",
        "paymentMedium": "<string>",
        "fee": 123,
        "feeToPatient": 123,
        "createdDate": "2023-11-07T05:31:56Z",
        "refunds": [
          {
            "id": "<string>",
            "amount": 123,
            "reason": "DUPLICATE",
            "createdDate": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "creator": {
              "id": "<string>",
              "type": "PROVIDER",
              "firstName": "<string>",
              "lastName": "<string>",
              "phoneNumber": "<string>",
              "email": "<string>",
              "locationId": "<string>"
            }
          }
        ],
        "isPaymentPlan": true,
        "isInsurancePayment": true,
        "firstName": "<string>",
        "lastName": "<string>",
        "patientId": "<string>",
        "externalPatientId": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "comment": "<string>",
        "paymentMethod": {
          "id": "<string>",
          "patientId": "<string>",
          "rainforestPaymentMethodId": "<string>",
          "brand": "<string>",
          "last4": "<string>",
          "expMonth": 123,
          "expYear": 123,
          "accountHolderType": "<string>",
          "accountNumberLast4": 123,
          "bankName": "<string>",
          "routingNumber": 123,
          "description": "<string>",
          "type": "CARD",
          "isDefault": false,
          "isArchived": false
        },
        "creator": {
          "id": "<string>",
          "type": "PROVIDER",
          "firstName": "<string>",
          "lastName": "<string>",
          "phoneNumber": "<string>",
          "email": "<string>",
          "locationId": "<string>"
        },
        "items": [
          {
            "itemName": "<string>",
            "quantity": 123,
            "pricePerItem": 123,
            "description": "<string>",
            "chargeId": "<string>",
            "discountReason": "<string>",
            "discountAmount": 123,
            "discountPercentage": 123,
            "unit": "<string>",
            "itemType": "<string>"
          }
        ],
        "locationId": "<string>"
      }
    ],
    "total": 123
  },
  "hasInsurancePayments": true
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
id
string | null
payer
string | null
external_patient_id
string | null
payer_type
string | null
amount
integer[] | null
last4
string | null
comment
string | null
payment_mediums
string[] | null
status
enum<string>[] | null
Available options:
CANCELED,
CREATED,
FAILED,
IN_REVIEW,
PRESENTING,
PROCESSING,
SUCCEEDED
type
string | null
tags
string[] | null
created_date
tz
string | null
location_ids
string[] | null
creator_name
string | null
merchant_account_ids
string[] | null

Response

Successful Response

items
Page[PaymentTableItem] · object
required
hasInsurancePayments
boolean
required