Skip to main content
GET
/
dashboard
/
failed-attempts
Get Failed Payments
curl --request GET \
  --url https://api.decodahealth.com/dashboard/failed-attempts \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "id": "<string>",
      "alertId": "<string>",
      "actionRequired": true,
      "patientName": "<string>",
      "patientId": "<string>",
      "failedReason": "<string>",
      "paymentMethod": "<string>",
      "paymentMedium": "<string>",
      "amount": 123,
      "dateOfAttempt": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "perPage": 123
}

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
default:1
​
per_page
integer | null
default:10
​
sort_by
string | null
​
sort_direction
enum<string> | null
Available options:
asc,
desc
​
location_id
string | null
​
start_date
string
required
​
end_date
string
required
​
location_ids
string[] | null
​
payment_mediums
string[] | null
​
tz
string
required
​
limit
integer | null

Response

Successful Response

​
data
FailedPaymentItem · object[]
required
​
total
integer
required
​
page
integer
required
​
perPage
integer
required