Insurance RefundsV1

Create insurance refund

Beta
POST

Creates a new insurance refund record and returns the newly created InsuranceRefund object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

Request

This endpoint expects an object.
payer_identifier
unionRequired
amount_cents
integerRequired
allocations
list of objectsRequired
Allocations are portions of payments that are applied to specific resources, known as targets. Each allocation has and amount, defined in cents, and a target.
refund_timestamp
datetimeOptional
refund_note
stringOptional
refund_reason
enumOptional
Allowed values: OVERCHARGED

Response

This endpoint returns an object
insurance_refund_id
UUID
payer
object
amount_cents
integer
allocations
list of objects
refund_timestamp
datetimeOptional
refund_note
stringOptional
refund_reason
enumOptional
Allowed values: OVERCHARGED

Errors

POST
1curl -X POST https://api.joincandidhealth.com/api/insurance-refunds/v1 \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "payer_identifier": {
6    "type": "payer_info",
7    "payer_id": "string",
8    "payer_name": "string"
9  },
10  "amount_cents": 0,
11  "allocations": [
12    {
13      "amount_cents": 0,
14      "target": {
15        "type": "service_line_by_id",
16        "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
17      }
18    }
19  ]
20}'
1{
2  "insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3  "payer": {
4    "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5    "payer_id": "string",
6    "payer_name": "string"
7  },
8  "amount_cents": 0,
9  "allocations": [
10    {
11      "amount_cents": 0,
12      "target": {
13        "type": "service_line",
14        "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15        "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16        "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
17      }
18    }
19  ],
20  "refund_timestamp": "2023-01-01T00:00:00Z",
21  "refund_note": "string",
22  "refund_reason": "OVERCHARGED"
23}
Built with