Get non-insurance payer refund

Beta

GET

/api/non-insurance-payer-refunds/v1/:non_insurance_payer_refund_id

Retrieves a previously created non-insurance payer refund by its non_insurance_payer_refund_id.

Path parameters

non_insurance_payer_refund_idUUIDRequired

Response

This endpoint returns an object.

non_insurance_payer_refund_idUUID

non_insurance_payerobject

amount_centsinteger

allocationslist of objects

refund_timestampdatetimeOptional

refund_notestringOptional

check_numberstringOptional

refund_reason"OVERCHARGED"Optional

Allowed values: OVERCHARGED

invoice_idUUIDOptional

Errors

GET

1 curl https://api.joincandidhealth.com/api/non-insurance-payer-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>"

1 {
2   "non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "non_insurance_payer": {
4     "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5     "name": "string",
6     "enabled": true,
7     "description": "string",
8     "category": "string",
9     "address": {
10       "address1": "string",
11       "city": "string",
12       "state": "AA",
13       "zip_code": "string",
14       "address2": "string",
15       "zip_plus_four_code": "string"
16     }
17   },
18   "amount_cents": 0,
19   "allocations": [
20     {
21       "amount_cents": 0,
22       "target": {
23         "type": "service_line",
24         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
25         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
26         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
27       }
28     }
29   ],
30   "refund_timestamp": "2023-01-01T00:00:00Z",
31   "refund_note": "string",
32   "check_number": "string",
33   "refund_reason": "OVERCHARGED",
34   "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
35 }

Built with

1	curl https://api.joincandidhealth.com/api/non-insurance-payer-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2	-H "Authorization: Bearer <token>"

1	{
2	"non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3	"non_insurance_payer": {
4	"non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"name": "string",
6	"enabled": true,
7	"description": "string",
8	"category": "string",
9	"address": {
10	"address1": "string",
11	"city": "string",
12	"state": "AA",
13	"zip_code": "string",
14	"address2": "string",
15	"zip_plus_four_code": "string"
16	}
17	},
18	"amount_cents": 0,
19	"allocations": [
20	{
21	"amount_cents": 0,
22	"target": {
23	"type": "service_line",
24	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
25	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
26	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
27	}
28	}
29	],
30	"refund_timestamp": "2023-01-01T00:00:00Z",
31	"refund_note": "string",
32	"check_number": "string",
33	"refund_reason": "OVERCHARGED",
34	"invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
35	}