> ## Documentation Index > Fetch the complete documentation index at: https://docs.usecobalt.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Payments > Returns paginated patient payments for a date range, with the claims each payment is applied to. ### Example Request ```bash theme={null} curl -X GET https://api.usecobalt.com/v1/payments \ -H 'Content-Type: application/json' \ -H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \ -H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \ -H 'access_token: 493JKLHIU98789hLKH9HHJH' \ -G \ --data-urlencode "start_date=2025-08-01" \ --data-urlencode "end_date=2025-08-31" ``` ### Example Response ```json theme={null} { "success": true, "payments": [ { "id": "f6a1b2c3d4e5478899aabbccddeeff00", "emr_transaction_id": "200145", "status": "synced", "patient_mrn": "MRN123456", "emr_patient_id": "48210", "payer_type": "patient", "payment_method": "Credit Card (VISA)", "amount": 75, "unapplied_amount": 25, "reference_number": null, "deposit_date": "2025-08-14", "batch_id": null, "location_id": "2", "location_name": "Main Office", "posted_by_emr_id": "51007", "posted_by_name": "Smith, Jane", "epay_transaction_id": "000000071234", "notes": null, "voided": false, "synced_at": "2025-08-15T03:00:00.000Z", "created_at": "2025-08-15T03:00:00.000Z", "updated_at": "2025-08-15T03:00:00.000Z", "allocations": [ { "claim_id": "a1b2c3d4e5f6789012345678abcdef90", "emr_claim_id": "275001", "emr_appointment_id": "690012", "emr_payment_detail_id": "530120", "service_date": "2025-07-24", "amount": 50 } ] } ], "pagination": { "page": 1, "page_size": 100, "total_count": 1, "total_pages": 1 } } ``` ## OpenAPI ````yaml GET /payments openapi: 3.1.0 info: title: Cobalt API version: 1.0.1 description: API for interacting with Cobalt's EHR integration services servers: - url: https://api.usecobalt.com/v1 description: Production security: - ClientCredentials: [] ClientSecret: [] AccessToken: [] paths: /payments: get: tags: - Payments summary: List payments description: >- Returns the patient payments Cobalt has synced for the account, with the claims each payment is applied to. operationId: getPayments parameters: - name: start_date in: query description: >- Start of the payment date range (ISO 8601, YYYY-MM-DD), matched against deposit_date. schema: type: string example: '2026-03-15' required: true x-supported-emrs: - eClinicalWorks - name: end_date in: query description: >- End of the payment date range (ISO 8601, YYYY-MM-DD), matched against deposit_date. schema: type: string example: '2026-03-20' required: true x-supported-emrs: - eClinicalWorks - name: patient_mrn in: query description: Filter by patient Medical Record Number. schema: type: string example: '12345' required: false x-supported-emrs: - eClinicalWorks - name: page in: query description: Page number. schema: type: integer minimum: 1 default: 1 example: 1 required: false x-supported-emrs: - eClinicalWorks - name: page_size in: query description: Items per page (max 1000). schema: type: integer minimum: 1 maximum: 1000 default: 100 example: 100 required: false x-supported-emrs: - eClinicalWorks responses: '200': description: Payments for the account content: application/json: schema: type: object properties: success: type: boolean example: true payments: type: array items: type: object properties: id: type: string description: Cobalt payment ID. emr_transaction_id: type: - string - 'null' description: EMR payment ID. status: type: string description: >- `created` for a payment posted through Cobalt, `synced` for a payment read from the EMR. patient_mrn: type: - string - 'null' description: Medical Record Number of the patient. emr_patient_id: type: - string - 'null' description: EMR patient ID of the payer. payer_type: type: - string - 'null' description: Who made the payment, e.g. `patient`. payment_method: type: - string - 'null' description: >- Payment type as recorded in the EMR, e.g. "Credit Card (VISA)", "Cash", "Check". amount: type: - number - 'null' description: Payment amount. unapplied_amount: type: - number - 'null' description: >- Part of the amount not applied to a claim (amount minus the sum of allocations). reference_number: type: - string - 'null' description: Check or reference number. deposit_date: type: - string - 'null' description: Date the payment was received (YYYY-MM-DD). batch_id: type: - string - 'null' description: EMR payment batch ID. location_id: type: - string - 'null' description: EMR location (facility) ID. location_name: type: - string - 'null' description: EMR location (facility) name. posted_by_emr_id: type: - string - 'null' description: EMR user ID of the user who posted the payment. posted_by_name: type: - string - 'null' description: Name of the user who posted the payment. epay_transaction_id: type: - string - 'null' description: >- Card processor transaction ID for an electronic payment (eCW "ePay trx Id"). notes: type: - string - 'null' description: Payment memo. voided: type: - boolean - 'null' description: True when the payment is voided in the EMR. allocations: type: array items: type: object properties: claim_id: type: - string - 'null' description: >- Cobalt claim ID, when Cobalt has synced the claim; otherwise null. emr_claim_id: type: - string - 'null' description: EMR claim number the payment is applied to. emr_appointment_id: type: - string - 'null' description: EMR appointment (encounter) ID of the claim. emr_payment_detail_id: type: - string - 'null' description: >- EMR ID of this application of the payment to the claim. service_date: type: - string - 'null' description: Claim service date (YYYY-MM-DD). amount: type: - number - 'null' description: Amount of the payment applied to this claim. required: - claim_id - emr_claim_id - emr_appointment_id - emr_payment_detail_id - service_date - amount example: claim_id: c1a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 emr_claim_id: '275001' emr_appointment_id: '690012' emr_payment_detail_id: '530120' service_date: '2026-08-24' amount: 75 description: Claims the payment is applied to. synced_at: type: - string - 'null' description: When the payment was last read from the EMR. created_at: type: string description: When the payment record was created. updated_at: type: string description: When the payment record was updated. required: - id - emr_transaction_id - status - patient_mrn - emr_patient_id - payer_type - payment_method - amount - unapplied_amount - reference_number - deposit_date - batch_id - location_id - location_name - posted_by_emr_id - posted_by_name - epay_transaction_id - notes - voided - allocations - synced_at - created_at - updated_at example: id: f6a1b2c3d4e5478899aabbccddeeff00 emr_transaction_id: '200145' status: synced patient_mrn: '12345' emr_patient_id: '48210' payer_type: patient payment_method: Credit Card (VISA) amount: 75 unapplied_amount: 0 reference_number: null deposit_date: '2026-10-22' batch_id: null location_id: '2' location_name: Main Office posted_by_emr_id: '51007' posted_by_name: Smith, Jane epay_transaction_id: '000000071234' notes: null voided: false allocations: - claim_id: c1a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 emr_claim_id: '275001' emr_appointment_id: '690012' emr_payment_detail_id: '530120' service_date: '2026-08-24' amount: 75 synced_at: '2026-10-23T09:00:00.000Z' created_at: '2026-10-23T09:00:00.000Z' updated_at: '2026-10-23T09:00:00.000Z' example: - id: f6a1b2c3d4e5478899aabbccddeeff00 emr_transaction_id: '200145' status: synced patient_mrn: '12345' emr_patient_id: '48210' payer_type: patient payment_method: Credit Card (VISA) amount: 75 unapplied_amount: 0 reference_number: null deposit_date: '2026-10-22' batch_id: null location_id: '2' location_name: Main Office posted_by_emr_id: '51007' posted_by_name: Smith, Jane epay_transaction_id: '000000071234' notes: null voided: false allocations: - claim_id: c1a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 emr_claim_id: '275001' emr_appointment_id: '690012' emr_payment_detail_id: '530120' service_date: '2026-08-24' amount: 75 synced_at: '2026-10-23T09:00:00.000Z' created_at: '2026-10-23T09:00:00.000Z' updated_at: '2026-10-23T09:00:00.000Z' pagination: type: object properties: page: type: integer example: 1 page_size: type: integer example: 100 total_count: type: integer example: 1 total_pages: type: integer example: 1 required: - page - page_size - total_count - total_pages required: - success - payments - pagination '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' components: responses: BadRequest: description: Bad request — missing or invalid parameters content: application/json: schema: type: object properties: success: type: boolean enum: - false example: false message: type: string example: Request could not be completed. required: - success - message example: success: false message: Bad request — missing or invalid parameters Unauthorized: description: Unauthorized — missing or invalid credentials content: application/json: schema: type: object properties: success: type: boolean enum: - false example: false message: type: string example: Request could not be completed. required: - success - message example: success: false message: Unauthorized — missing or invalid credentials NotFound: description: Resource not found content: application/json: schema: type: object properties: success: type: boolean enum: - false example: false message: type: string example: Request could not be completed. required: - success - message example: success: false message: Resource not found InternalServerError: description: Internal server error content: application/json: schema: type: object properties: success: type: boolean enum: - false example: false message: type: string example: Request could not be completed. required: - success - message example: success: false message: Internal server error securitySchemes: ClientCredentials: type: apiKey in: header name: client_id ClientSecret: type: apiKey in: header name: client_secret AccessToken: type: apiKey in: header name: access_token ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.