API Reference Third Party Payer Payments V1

Get third party payer payments

Deprecated

GET

Returns all third party payer payments

Query parameters

limitintegerOptional

Defaults to 100. The value must be greater than 0 and less than 1000.

third_party_payer_idUUIDOptional

check_numberstringOptional

invoice_idUUIDOptional

sort"amount_cents" or "payment_timestamp"Optional

Defaults to refund_timestamp

Allowed values: amount_centspayment_timestamp

sort_direction"asc" or "desc"Optional

Sort direction. Defaults to descending order if not provided.

Allowed values: ascdesc

page_tokenstringOptional

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Errors

GET

1 curl -G https://api.joincandidhealth.com/api/third-party-payer-payments/v1 \
2      -H "Authorization: Bearer <token>" \
3      -d limit=0 \
4      -d third_party_payer_id=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32

1 {
2   "items": [
3     {
4       "third_party_payer_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5       "third_party_payer": {
6         "third_party_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7         "name": "string",
8         "description": "string",
9         "category": "string",
10         "enabled": true
11       },
12       "amount_cents": 0,
13       "check_number": "string",
14       "payment_timestamp": "2023-01-01T00:00:00Z",
15       "payment_note": "string",
16       "allocations": [
17         {
18           "amount_cents": 0,
19           "target": {
20             "type": "service_line",
21             "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22             "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
23             "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
24           }
25         }
26       ],
27       "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
28     }
29   ],
30   "prev_page_token": "string",
31   "next_page_token": "string"
32 }

Built with

1	curl -G https://api.joincandidhealth.com/api/third-party-payer-payments/v1 \
2	-H "Authorization: Bearer <token>" \
3	-d limit=0 \
4	-d third_party_payer_id=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32

1	{
2	"items": [
3	{
4	"third_party_payer_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"third_party_payer": {
6	"third_party_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7	"name": "string",
8	"description": "string",
9	"category": "string",
10	"enabled": true
11	},
12	"amount_cents": 0,
13	"check_number": "string",
14	"payment_timestamp": "2023-01-01T00:00:00Z",
15	"payment_note": "string",
16	"allocations": [
17	{
18	"amount_cents": 0,
19	"target": {
20	"type": "service_line",
21	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
23	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
24	}
25	}
26	],
27	"invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
28	}
29	],
30	"prev_page_token": "string",
31	"next_page_token": "string"
32	}