Skip to main content
POST
/
billing
/
payment-link
/
verify-patient
Verify Patient
curl --request POST \
  --url https://api.decodahealth.com/billing/payment-link/verify-patient \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "patientId": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "dateOfBirth": "<string>"
}
'
{
  "charges": [
    {
      "patientId": "<string>",
      "totalOutstanding": 123,
      "items": [
        {
          "chargeId": "<string>",
          "quantity": 123,
          "price": 123,
          "id": "<string>",
          "itemId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "discountAmount": 123,
          "discountPercentage": 123,
          "discountReason": "<string>",
          "soldPackageId": "<string>",
          "bankedQuantity": 123,
          "bankedItemId": "<string>",
          "issuedDiscountId": "<string>",
          "soldByProviderId": "<string>",
          "taxAmount": 123,
          "pricingId": "<string>",
          "shipmentIds": [
            "<string>"
          ],
          "item": {
            "name": "<string>",
            "price": 123,
            "id": "<string>",
            "brandName": "<string>",
            "description": "<string>",
            "category": "<string>",
            "unit": "AMPOULES",
            "isPhysical": true,
            "isArchived": false,
            "internalNotes": "<string>",
            "taxable": false,
            "sortOrder": 123,
            "allowCustomPricing": false,
            "type": "PRODUCT"
          },
          "locationId": "<string>",
          "locationName": "<string>",
          "saleDate": "2023-11-07T05:31:56Z"
        }
      ],
      "adjustments": [
        {
          "chargeId": "<string>",
          "id": "<string>",
          "amount": 123,
          "createdDate": "2023-11-07T05:31:56Z",
          "adjustmentType": "WRITE_OFF",
          "providerId": "<string>",
          "locationId": "<string>",
          "reason": "<string>"
        }
      ],
      "payments": [
        {
          "paymentId": "<string>",
          "amount": 123,
          "chargeId": "<string>",
          "payment": {
            "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,
            "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
            },
            "refunds": []
          },
          "createdDate": "2023-11-07T05:31:56Z"
        }
      ],
      "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>",
      "tips": [],
      "locationId": "<string>",
      "eventId": "<string>",
      "memberId": "<string>",
      "comment": "<string>",
      "meta": {},
      "merchantAccountId": "<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>"
  },
  "paymentLink": "<string>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
patientId
string
required
lastName
string
required
phoneNumber
string
required
dateOfBirth
string
required

Response

Successful Response

charges
ChargeDetailWithItems · object[]
required
patient
PatientSummary · object
required