You can use the payments endpoint to get information about payments in your bookings
Payments Object
| Attribute | Description |
|---|---|
| id | integer The ID of the payment, generated automatically |
| uid | string Unique identifier for the payment |
| appId | string The ID of the app associated with the payment |
| app | App Object The app associated with the payment |
| bookingId | integer The ID of the booking associated with the payment |
| booking | Booking Object The booking associated with the payment |
| amount | integer The amount of the payment |
| fee | integer The fee associated with the payment |
| currency | string The currency of the payment |
| success | boolean Indicates whether the payment was successful |
| refunded | boolean Indicates whether the payment was refunded |
| data | json Additional data related to the payment |
| externalId | string External ID associated with the payment, usually from a payment gateway |
| paymentOption | PaymentOption The payment option used |
Example Payments Object
{
"id": 12345,
"uid": "pay_9876543210abcdef",
"appId": "app_123abc",
"app": "[App Object]",
"bookingId": 54321,
"booking": "[Booking Object]",
"amount": 10000,
"fee": 250,
"currency": "USD",
"success": true,
"refunded": false,
"data": [Payment Data Object],
"externalId": "ext_abcdefghijklmno",
"paymentOption": "ON_BOOKING"
}
Find all payments
Get a list of all payments made to your cal.com bookings
GET
/payments
Find a payment
Get details of a specific payment
GET
/payments/{id}