API Reference Third Party Payer Payments V1

Get third party payer payment

Deprecated

GET

Retrieves a previously created third party payer payment by its third_party_payer_payment_id.

Path parameters

third_party_payer_payment_idUUIDRequired

Response

This endpoint returns an object.

third_party_payer_payment_idUUID

third_party_payerobject

amount_centsinteger

allocationslist of objects

check_numberstringOptional

payment_timestampdatetimeOptional

payment_notestringOptional

invoice_idUUIDOptional

Errors

GET

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

1 {
2   "third_party_payer_payment_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   "check_number": "string",
12   "payment_timestamp": "2023-01-01T00:00:00Z",
13   "payment_note": "string",
14   "allocations": [
15     {
16       "amount_cents": 0,
17       "target": {
18         "type": "service_line",
19         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
21         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
22       }
23     }
24   ],
25   "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
26 }

Built with

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

1	{
2	"third_party_payer_payment_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	"check_number": "string",
12	"payment_timestamp": "2023-01-01T00:00:00Z",
13	"payment_note": "string",
14	"allocations": [
15	{
16	"amount_cents": 0,
17	"target": {
18	"type": "service_line",
19	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
21	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
22	}
23	}
24	],
25	"invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
26	}