Get insurance payment | Candid

1 import uuid 2 3 from candid import CandidApiClient 4 5 client = CandidApiClient( 6 client_id="YOUR_CLIENT_ID", 7 client_secret="YOUR_CLIENT_SECRET", 8 ) 9 client.insurance_payments.v_1.get( 10 insurance_payment_id=uuid.UUID( 11 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 12 ), 13 )

1 { 2 "insurance_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 3 "payer": { 4 "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 5 "payer_id": "payer_id", 6 "payer_name": "payer_name", 7 "availity_payer_name": "availity_payer_name", 8 "availity_claims_payer_id": "availity_claims_payer_id", 9 "availity_eligibility_id": "availity_eligibility_id", 10 "availity_remittance_payer_id": "availity_remittance_payer_id", 11 "street_address": { 12 "address1": "address1", 13 "city": "city", 14 "state": "AA", 15 "zip_code": "zip_code", 16 "zip_plus_four_code": "zip_plus_four_code", 17 "address2": "address2" 18 } 19 }, 20 "amount_cents": 1, 21 "allocations": [ 22 { 23 "amount_cents": 1, 24 "target": { 25 "type": "service_line", 26 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 27 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 28 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 29 } 30 }, 31 { 32 "amount_cents": 1, 33 "target": { 34 "type": "service_line", 35 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 36 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 37 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 38 } 39 } 40 ], 41 "payment_timestamp": "2024-01-15T09:30:00Z", 42 "payment_note": "payment_note" 43 }

Retrieves a previously created insurance payment by its insurance_payment_id. If the payment does not exist, a 403 will be thrown.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path Parameters

insurance_payment_idUUIDRequired

Response

This endpoint returns an object.

insurance_payment_idUUID

payerobject

amount_centsinteger

allocationslist of objects

payment_timestampdatetime or null

payment_notestring or null

Authentication

Path Parameters

Response

Errors