List Service Payments

GET

/api/services/:id/payments

GET

/api/services/:id/payments

1 import requests
2 
3 url = "https://app.usebridge.com/api/services/id/payments"
4 
5 payload = {}
6 headers = {
7     "X-API-Key": "<apiKey>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.get(url, json=payload, headers=headers)
12 
13 print(response.json())

Try it

200Retrieved

1 {
2   "items": [
3     {
4       "id": "pay_8f3a2b7c9d1e4f6a",
5       "createdAt": "2024-01-15T09:30:00Z",
6       "serviceId": "svc_4b7d9e2f1a3c5d6e",
7       "paidAt": "2024-01-15T09:30:00Z",
8       "transactionId": "txn_9c8b7a6d5e4f3a2b",
9       "type": "PATIENT",
10       "amount": 150.75,
11       "externalId": "ext_20240115_001",
12       "memo": "Payment for consultation and lab tests"
13     },
14     {
15       "id": "pay_7d6e5f4a3b2c1d0e",
16       "createdAt": "2024-01-15T10:45:00Z",
17       "serviceId": "svc_4b7d9e2f1a3c5d6e",
18       "paidAt": "2024-01-15T10:45:00Z",
19       "transactionId": "txn_1a2b3c4d5e6f7g8h",
20       "type": "PATIENT",
21       "amount": 200,
22       "externalId": "ext_20240115_002",
23       "memo": "Payment for follow-up visit"
24     }
25   ],
26   "count": 2
27 }

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

idstringRequired

Query parameters

pageintegerOptional

limitintegerOptional

Response

This endpoint returns an object.

itemslist of objects

List results

countinteger or null

Total count (if available)