curl --request GET \
--url https://{your-subdomain}.neetocal.com/api/external/v2/payments \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};
fetch('https://{your-subdomain}.neetocal.com/api/external/v2/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetocal.com/api/external/v2/payments"
headers = {"X-Api-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"payments": [
{
"id": "2f4e6a8c-1b3d-4f5a-9c7e-0d2b4a6c8e1f",
"identifier": "pi_3Q8x2LKs9d",
"type": "booking",
"provider": "stripe",
"status": "successful",
"amount": "100.0",
"currency": "USD",
"payment_at": "2026-11-04T09:30:00Z",
"refunded_amount": "40.0",
"client": {
"name": "Oliver Smith",
"email": "oliver@example.com"
},
"booking": {
"id": "8b1d6f0e-2c4a-4e6b-9f3a-1d2c3b4a5f6e",
"sid": "x7k2m9p",
"meeting_sid": "abc123x",
"meeting_name": "Consultation",
"starts_at": "2026-11-05T10:00:00Z",
"host_email": "host@example.com"
},
"package_purchase": {
"id": "5c2e7a1b-3d4f-4a6b-8c9d-0e1f2a3b4c5d",
"purchase_code": "PKG-4F7K2",
"package_id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
"package_name": "10-session pack"
},
"refunds": [
{
"id": "7e5c3a1f-9d2b-4c6e-8a0f-1b3d5f7a9c2e",
"identifier": "re_3Q8x2LKs9d",
"status": "successful",
"amount": "40.0",
"currency": "USD",
"reason": "Cancelled by client",
"refunded_at": "2026-11-06T12:00:00Z"
}
]
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"current_page_number": 123,
"page_size": 123
}
}{
"error": "The type argument must be one of booking, package_purchase, but 'refund' was given"
}List payments
List the workspace’s payments for bookings and package purchases, newest first. Use it with a date range for payment reports. Returns successful payments unless status is set. Each payment includes its refunds and refunded_amount.
Split-payment host shares and placeholder payments for free bookings are not listed.
curl --request GET \
--url https://{your-subdomain}.neetocal.com/api/external/v2/payments \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};
fetch('https://{your-subdomain}.neetocal.com/api/external/v2/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetocal.com/api/external/v2/payments"
headers = {"X-Api-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"payments": [
{
"id": "2f4e6a8c-1b3d-4f5a-9c7e-0d2b4a6c8e1f",
"identifier": "pi_3Q8x2LKs9d",
"type": "booking",
"provider": "stripe",
"status": "successful",
"amount": "100.0",
"currency": "USD",
"payment_at": "2026-11-04T09:30:00Z",
"refunded_amount": "40.0",
"client": {
"name": "Oliver Smith",
"email": "oliver@example.com"
},
"booking": {
"id": "8b1d6f0e-2c4a-4e6b-9f3a-1d2c3b4a5f6e",
"sid": "x7k2m9p",
"meeting_sid": "abc123x",
"meeting_name": "Consultation",
"starts_at": "2026-11-05T10:00:00Z",
"host_email": "host@example.com"
},
"package_purchase": {
"id": "5c2e7a1b-3d4f-4a6b-8c9d-0e1f2a3b4c5d",
"purchase_code": "PKG-4F7K2",
"package_id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
"package_name": "10-session pack"
},
"refunds": [
{
"id": "7e5c3a1f-9d2b-4c6e-8a0f-1b3d5f7a9c2e",
"identifier": "re_3Q8x2LKs9d",
"status": "successful",
"amount": "40.0",
"currency": "USD",
"reason": "Cancelled by client",
"refunded_at": "2026-11-06T12:00:00Z"
}
]
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"current_page_number": 123,
"page_size": 123
}
}{
"error": "The type argument must be one of booking, package_purchase, but 'refund' was given"
}{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Query Parameters
Only payments made at or after this moment. ISO 8601 date such as 2026-10-01 (midnight UTC) or date-time such as 2026-10-01T00:00:00+05:30.
"2026-10-01"
Only payments made before this moment. ISO 8601 date such as 2026-10-01 (midnight UTC) or date-time such as 2026-10-01T00:00:00+05:30.
"2026-11-01"
Payment status.
successful, authorized, declined, pending, requires_action, requires_confirmation, requires_payment_method, confirmation_pending, initiated, cancelled, rejected What was paid for.
booking, package_purchase Only payments of bookings for this scheduling link, by SID or slug. Package purchase payments are left out when this is set. You can get sid from the response of the List scheduling links endpoint, or by visiting the scheduling link page and clicking "Settings" > "Show SID".
Page of results to retrieve, starting from 1. Defaults to 1 when omitted.
Number of results per page. Defaults to 30 when omitted.
Response
OK - Request succeeded
Payments on the requested page, newest first.
Hide child attributes
Hide child attributes
"2f4e6a8c-1b3d-4f5a-9c7e-0d2b4a6c8e1f"
The payment provider's identifier for the payment.
"pi_3Q8x2LKs9d"
What was paid for.
booking, package_purchase Payment provider, such as stripe, razorpay, paypal, upi, cash or manual.
"stripe"
"successful"
Amount paid, as a decimal string.
"100.0"
ISO 4217 currency code.
"USD"
When the payment reached its status. For UPI and cash payments, this is when the client submitted the payment.
"2026-11-04T09:30:00Z"
Total of the payment's successful refunds, as a decimal string.
"40.0"
The booking that was paid for. null for package purchases.
Hide child attributes
Hide child attributes
"8b1d6f0e-2c4a-4e6b-9f3a-1d2c3b4a5f6e"
"x7k2m9p"
"abc123x"
"Consultation"
"2026-11-05T10:00:00Z"
"host@example.com"
The package purchase that was paid for. null for bookings.
Hide child attributes
Hide child attributes
"5c2e7a1b-3d4f-4a6b-8c9d-0e1f2a3b4c5d"
"PKG-4F7K2"
"9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d"
"10-session pack"
Refunds of this payment, in any status.
Hide child attributes
Hide child attributes
"7e5c3a1f-9d2b-4c6e-8a0f-1b3d5f7a9c2e"
The payment provider's identifier for the refund.
"re_3Q8x2LKs9d"
"successful"
Amount refunded, as a decimal string.
"40.0"
"USD"
"Cancelled by client"
When the refund succeeded. null until it does.
"2026-11-06T12:00:00Z"