API Reference Third Party Payer Refunds V1

Update

Deprecated

PATCH

Updates the third party payer refund record matching the provided third_party_payer_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.

Path parameters

third_party_payer_refund_idUUIDRequired

Request

This endpoint expects an object.

refund_timestampdatetimeOptional

refund_noteobjectOptional

refund_reasonobjectOptional

invoice_idobjectOptional

Response

This endpoint returns an object.

third_party_payer_refund_idUUID

third_party_payerobject

amount_centsinteger

allocationslist of objects

refund_timestampdatetimeOptional

refund_notestringOptional

refund_reason"OVERCHARGED"Optional

Allowed values: OVERCHARGED

invoice_idUUIDOptional

Errors

PATCH

1 curl -X PATCH https://api.joincandidhealth.com/api/third-party-payer-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "third_party_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "third_party_payer": {
4     "third_party_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5     "name": "string",
6     "description": "string",
7     "category": "string",
8     "enabled": true
9   },
10   "amount_cents": 0,
11   "refund_timestamp": "2023-01-01T00:00:00Z",
12   "refund_note": "string",
13   "allocations": [
14     {
15       "amount_cents": 0,
16       "target": {
17         "type": "service_line",
18         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
19         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
21       }
22     }
23   ],
24   "refund_reason": "OVERCHARGED",
25   "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
26 }

Built with

1	curl -X PATCH https://api.joincandidhealth.com/api/third-party-payer-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"third_party_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3	"third_party_payer": {
4	"third_party_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"name": "string",
6	"description": "string",
7	"category": "string",
8	"enabled": true
9	},
10	"amount_cents": 0,
11	"refund_timestamp": "2023-01-01T00:00:00Z",
12	"refund_note": "string",
13	"allocations": [
14	{
15	"amount_cents": 0,
16	"target": {
17	"type": "service_line",
18	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
19	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
21	}
22	}
23	],
24	"refund_reason": "OVERCHARGED",
25	"invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
26	}