Schemas
Copy Page
Jokoor API Documentation
Getting started
Authentication
Pagination
Quick Start
Error Handling
Response Format
Payments
Payment Links
Checkouts
Payment Status
SMS
SMS Templates
Resending SMS Messages
Message Segments
SMS Contact Groups
SMS Contacts
SMS Campaigns
Sending SMS Messages
Billing
Invoices
Invoice Payments (Offline/Manual Recording)
Receipts
Subscriptions
Resources
Donations
Customers
Products
Transactions
Refunds
Payouts
Payout Requests
Bank Accounts
Recipient Payouts
Payout Recipients
Payout Reversals
Payout Balance
Webhooks
Webhook Events
Webhook Endpoints
APIs
Health
Health check
SMS
Send SMS message
List SMS messages
Get SMS message details
Send a draft SMS message
Resend failed SMS
Batch resend failed messages
SMS Templates
Create SMS template
List SMS templates
Get SMS template
Update SMS template
Delete SMS template
SMS Contacts
Create contact
List contacts
Get contact
Update contact
Delete contact
SMS Contact Groups
Create contact group
List contact groups
Get contact group
Update contact group
Delete contact group
Add contacts to group
Remove contacts from group
SMS Campaigns
Create SMS campaign
List SMS campaigns
Get SMS campaign
Update SMS campaign
Delete SMS campaign
Send SMS campaign
Send draft SMS campaign
Send campaign asynchronously
Get campaign messages
Get campaign statistics
Resend failed campaign messages
SMS Analytics
Get segment analytics
Preview message segments
Checkouts
Create checkout session
Get checkout session
Cancel checkout
Payment Links
Create payment link
List payment links
Get payment link
Update payment link
Delete payment link
Invoices
Create invoice
List invoices
Get invoice
Update invoice
Cancel invoice
Finalize draft invoice
Send invoice via email
Download invoice PDF
Record invoice payment
List invoice payments
Get invoice receipts
Receipts
List receipts
Get receipt by ID
Get receipt by number
Download receipt PDF
Transactions
List transactions
Get transaction
Refunds
Refund transaction
List refunds
Get refund
Customers
Create or retrieve customer
List customers
Get customer
Update customer
Delete customer
Products
Create product
List products
Get product
Update product
Delete product
Donations
Create donation campaign
List donation campaigns
Get donation campaign
Update donation campaign
Delete donation campaign
Subscriptions
Create subscription
List subscriptions
Get subscription
Update subscription
Cancel subscription
List subscription invoices
Trigger subscription processing
Payouts
Get payout balance
List bank accounts
Create payout request
List payout requests
Get payout request
Cancel payout request
Payout Recipients
Create payout recipient
List payout recipients
Get payout recipient
Update payout recipient
Delete payout recipient
Send payout to recipient
List recipient payouts
Get recipient payout
Reverse or cancel recipient payout
Webhooks
Create webhook endpoint
List webhook endpoints
Get webhook endpoint
Update webhook endpoint
Delete webhook endpoint
Test webhook endpoint
Webhook Events
List webhook events
Get webhook event
Retry webhook event
Schemas
Schemas
ErrorResponse
HealthResponse
SendSMSRequest
SMSMessageResponse
SMSMessageListResponse
BatchResendResponse
SMSDashboardResponse
SMSPlansListResponse
CreateSMSTemplateRequest
UpdateSMSTemplateRequest
SMSTemplateResponse
SMSTemplateListResponse
CreateSMSContactRequest
UpdateSMSContactRequest
SMSContactResponse
SMSContactListResponse
CreateSMSContactGroupRequest
UpdateSMSContactGroupRequest
SMSContactGroupResponse
SMSContactGroupListResponse
CreateSenderIDRequest
UpdateSenderIDRequest
SenderIDResponse
SenderIDListResponse
CreateSMSCampaignRequest
UpdateSMSCampaignRequest
SMSCampaignResponse
SMSCampaignListResponse
CreateCheckoutRequest
CheckoutResponse
InitializePaymentRequest
InitializePaymentResponse
PaymentStatusResponse
PaymentSessionResponse
CreatePaymentLinkRequest
UpdatePaymentLinkRequest
PaymentLinkResponse
PaymentLinkListResponse
CreateInvoiceRequest
UpdateInvoiceRequest
RecordInvoicePaymentRequest
InvoiceResponse
InvoiceListResponse
InvoicePaymentListResponse
InvoiceReceiptInfo
Receipt
ListReceiptsResponse
CreateSubscriptionRequest
SubscriptionResponse
SubscriptionListResponse
UpdateSubscriptionRequest
TransactionResponse
TransactionListResponse
RefundResponse
RefundListResponse
CreateCustomerRequest
UpdateCustomerRequest
CustomerResponse
CustomerListResponse
CreateProductRequest
UpdateProductRequest
ProductResponse
ProductListResponse
CreateDonationCampaignRequest
UpdateDonationCampaignRequest
DonationCampaignResponse
DonationCampaignListResponse
PayoutBalanceResponse
CreateBankAccountRequest
BankAccountResponse
CreatePayoutRequest
PayoutRequestResponse
PayoutRequestListResponse
CreatePayoutRecipientRequest
UpdatePayoutRecipientRequest
PayoutRecipientResponse
PayoutRecipientListResponse
SendRecipientPayoutRequest
RecipientPayoutResponse
RecipientPayoutListResponse
CreateWebhookEndpointRequest
UpdateWebhookEndpointRequest
WebhookEndpointResponse
WebhookEndpointListResponse
WebhookEventResponse
WebhookEventListResponse
Schemas
Copy Page
WebhookEventListResponse
{
"data"
:
{
"items"
:
[
{
}
]
,
"count"
:
0
,
"offset"
:
0
,
"limit"
:
0
}
}