API reference
WinkPG API version v1. 550 endpoints published by this instance.
The API reference is not available right now
This instance could not load its API specification, so there is nothing to list. The reference returns as soon as the specification is readable again.
This instance publishes no API operations.
Account
- POST
/api/account/confirm-emaildeprecated Confirm email address No permission required. - POST
/api/account/confirm-phone-numberdeprecated Confirm phone number No permission required. - GET
/api/account/confirmation-statedeprecated Get account confirmation state No permission required. - GET
/api/account/my-profiledeprecated Get user profile No permission required. - PUT
/api/account/my-profiledeprecated Update user profile No permission required. - POST
/api/account/my-profile/change-passworddeprecated Change password No permission required. - POST
/api/account/my-profile/set-two-factor-enableddeprecated SetTwoFactorEnabled for Profile No permission required. - GET
/api/account/my-profile/timezonesdeprecated GetTimezones for Profile No permission required. - GET
/api/account/my-profile/two-factor-enableddeprecated GetTwoFactorEnabled for Profile No permission required. - POST
/api/account/profile-picturedeprecated Set profile picture No permission required. - GET
/api/account/profile-picture-file/{id}deprecated GetProfilePictureFile for Account No permission required. - GET
/api/account/profile-picture/{id}deprecated Get profile picture No permission required. - GET
/api/account/recaptcha-validatedeprecated Recaptcha for Account No permission required. - POST
/api/account/registerdeprecated Register new account No permission required. - POST
/api/account/reset-passworddeprecated Reset password No permission required. - GET
/api/account/security-logsdeprecated Get security logs No permission required. - POST
/api/account/send-email-confirmation-tokendeprecated Send email confirmation token No permission required. - POST
/api/account/send-password-reset-codedeprecated Send password reset code No permission required. - POST
/api/account/send-phone-number-confirmation-tokendeprecated Send phone confirmation token No permission required. - POST
/api/account/verify-email-confirmation-tokendeprecated Verify email confirmation token No permission required. - POST
/api/account/verify-password-reset-tokendeprecated Verify password reset token No permission required. - POST
/api/app/account/send-password-reset-code-with-usernamedeprecated SendPasswordResetCodeWithUsername for Account No permission required. - GET
/api/app/wink-pg-profiledeprecated No permission required. - PUT
/api/app/wink-pg-profiledeprecated No permission required. - POST
/api/app/wink-pg-profile/can-enable-two-factordeprecated No permission required. - POST
/api/app/wink-pg-profile/change-passworddeprecated No permission required. - POST
/api/app/wink-pg-profile/set-two-factor-enableddeprecated No permission required. - GET
/api/app/wink-pg-profile/timezonesdeprecated No permission required. - GET
/api/app/wink-pg-profile/two-factor-enableddeprecated No permission required.
AccountingOAuth
- GET
/api/accounting/oauth/callbackdeprecated OAuth redirect target. Validates state, exchanges the code server-side, and redirects to a fixed internal route. No permission required. - POST
/api/accounting/oauth/connectdeprecated Begins a connect flow and returns the provider consent URL for the caller to redirect to. No permission required.
Announcements
- GET
/api/announcementsdeprecated Get a list of Announcements Requires: Announcements.Management, merchant scope. - POST
/api/announcementsdeprecated Create an Announcement Requires: Announcements.Management, Announcements.Management.Create, merchant scope. - POST
/api/announcements/disable-asyncdeprecated Disables an Announcement. Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - POST
/api/announcements/duplicate-asyncdeprecated Duplicates an Announcement. Requires: Announcements.Management, Announcements.Management.Create, merchant scope. - POST
/api/announcements/enable-asyncdeprecated Enables an Announcement. Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - GET
/api/announcements/templatesdeprecated Get a list of AnnouncementTemplates Requires: Announcements.Management, merchant scope. - POST
/api/announcements/templatesdeprecated Create an AnnouncementTemplate Requires: Announcements.Management, Announcements.Management.Create, merchant scope. - GET
/api/announcements/templates/picker-listdeprecated Gets announcement template picker list. Requires: Announcements.Management, merchant scope. - DELETE
/api/announcements/templates/{id}deprecated Delete an AnnouncementTemplate Requires: Announcements.Management, Announcements.Management.Delete, merchant scope. - GET
/api/announcements/templates/{id}deprecated Get an AnnouncementTemplate Requires: Announcements.Management, merchant scope. - PUT
/api/announcements/templates/{id}deprecated Update an AnnouncementTemplate Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - GET
/api/announcements/templates/{id}/accessdeprecated Check AnnouncementTemplate access Requires: Announcements.Management, merchant scope. - GET
/api/announcements/templates/{id}/namedeprecated Get an AnnouncementTemplate name by id Requires: Announcements.Management, merchant scope. - POST
/api/announcements/templates/{id}/restoredeprecated Restore a deleted AnnouncementTemplate Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - GET
/api/announcements/userdeprecated Gets announcements for the current user, ordered by priority and date. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/dismiss-alldeprecated Dismisses all announcements for the current user. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/mark-many-as-readdeprecated Marks multiple announcements as read for the current user. Requires: Announcements.View, merchant scope. - GET
/api/announcements/user/pending-popupsdeprecated Gets announcements that need to display a popup to the current user. These are active announcements with PopupOnLogin or Both display options that have not yet been shown as popups. Requires: Announcements.View, merchant scope. - GET
/api/announcements/user/unread-countdeprecated Gets the count of unread announcements for the current user. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/{announcementId}/dismissdeprecated Dismisses an announcement for the current user. Dismissed announcements won't appear in the notification dropdown. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/{announcementId}/mark-as-readdeprecated Marks an announcement as read for the current user. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/{announcementId}/record-popup-showndeprecated Records that a popup was shown to the current user for the specified announcement. This prevents the popup from being shown again. Requires: Announcements.View, merchant scope. - DELETE
/api/announcements/{id}deprecated Delete an Announcement Requires: Announcements.Management, Announcements.Management.Delete, merchant scope. - GET
/api/announcements/{id}deprecated Get an Announcement Requires: Announcements.Management, merchant scope. - PUT
/api/announcements/{id}deprecated Update an Announcement Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - GET
/api/announcements/{id}/accessdeprecated Check Announcement access Requires: Announcements.Management, merchant scope. - GET
/api/announcements/{id}/engagement-statsdeprecated Gets announcement engagement stats. Requires: Announcements.Management, merchant scope. - GET
/api/announcements/{id}/namedeprecated Get an Announcement name by id Requires: Announcements.Management, merchant scope. - POST
/api/announcements/{id}/restoredeprecated Restore a deleted Announcement Requires: Announcements.Management, Announcements.Management.Update, merchant scope.
API Keys
- GET
/api/api-keysdeprecated List API keys Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keysdeprecated Create API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/approximate-countdeprecated Gets the approximate total count of API keys based on the provided input. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/continuation-listdeprecated Gets a continuation list of API keys based on the provided input. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keys/revealdeprecated CreateAndReveal for ApiKeys Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/{entityId}/has-accessdeprecated Checks if the API key has access to the specified entity. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - DELETE
/api/api-keys/{id}deprecated Delete API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/{id}deprecated Get API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - PUT
/api/api-keys/{id}deprecated Update API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/{id}/detaildeprecated Get an API key's details Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/{id}/namedeprecated Gets the name of the API key by id. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keys/{id}/restoredeprecated Restores a deleted API key item by id. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keys/{id}/revokedeprecated Revoke an API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope.
Apple Pay
- GET
/.well-known/apple-developer-merchantid-domain-associationdeprecated Serve the domain association file. No permission required. - DELETE
/api/payment-tokenization/apple-pay/domain-association-filedeprecated Clear the domain association file (admin). No permission required. - PUT
/api/payment-tokenization/apple-pay/domain-association-filedeprecated Upload the domain association file (admin). No permission required. - GET
/api/payment-tokenization/apple-pay/domain-association-file/downloaddeprecated Download the domain association file (admin). Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - POST
/api/payment-tokenization/apple-pay/paymentdeprecated Receive the encrypted Apple Pay token. No permission required. - POST
/api/payment-tokenization/apple-pay/sessiondeprecated Create an Apple Pay merchant session. No permission required. - DELETE
/api/payment-tokenization/wallet-providers/apple-pay/certificates/api-keydeprecated Remove the App Store Connect API key. Requires: PaymentTokenization.SettingManagement, merchant scope. - PUT
/api/payment-tokenization/wallet-providers/apple-pay/certificates/api-keydeprecated Upload the App Store Connect API key. Requires: PaymentTokenization.SettingManagement, merchant scope. - GET
/api/payment-tokenization/wallet-providers/apple-pay/certificates/api-key/statusdeprecated Check whether the API key is uploaded. Requires: PaymentTokenization.SettingManagement, merchant scope. - POST
/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/completedeprecated Complete a manual certificate request. Requires: PaymentTokenization.SettingManagement, merchant scope. - GET
/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/csrdeprecated Download the pending CSR. Requires: PaymentTokenization.SettingManagement, merchant scope. - POST
/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/generatedeprecated Generate or regenerate a platform certificate. Requires: PaymentTokenization.SettingManagement, merchant scope. - POST
/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/initiatedeprecated Start a manual certificate signing request. Requires: PaymentTokenization.SettingManagement, merchant scope. - DELETE
/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/pendingdeprecated Cancel a pending certificate request. Requires: PaymentTokenization.SettingManagement, merchant scope. - GET
/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/statusdeprecated Get certificate status. Requires: PaymentTokenization.SettingManagement, merchant scope.
Audit Log
- GET
/api/app/audit-log-continuation/approximate-total-countdeprecated Requires: AuditLogging.AuditLogs, merchant scope. - GET
/api/app/audit-log-continuation/continuation-listdeprecated Requires: AuditLogging.AuditLogs, merchant scope. - GET
/api/app/audit-log-continuation/summary-countsdeprecated Requires: AuditLogging.AuditLogs, merchant scope. - POST
/api/app/audit-log-continuation/{id}/ensure-entity-accessdeprecated Requires: AuditLogging.AuditLogs, merchant scope. - POST
/api/app/audit-log-continuation/{id}/try-ensure-entity-accessdeprecated Requires: AuditLogging.AuditLogs, merchant scope.
BatchSequence
- GET
/api/transactions/batch-sequencedeprecated Read the current batch-number state for a merchant + processor without issuing a value. Requires: Transactions.Settlement.ManageBatchNumber, merchant scope. - POST
/api/transactions/batch-sequencedeprecated Override the next batch number for a merchant + processor. Requires: Transactions.Settlement.ManageBatchNumber, merchant scope.
Contracts
- GET
/api/contractsdeprecated List contracts Requires: Customers.Contracts, merchant scope. - POST
/api/contractsdeprecated Create contract Requires: Customers.Contracts, Customers.Contracts.Create, merchant scope. - POST
/api/contracts/list/continuationdeprecated Retrieves a continuation-based page of Contracts. Requires: Customers.Contracts, merchant scope. - POST
/api/contracts/list/continuation/countdeprecated Counts the Contracts that match a filter. Requires: Customers.Contracts, merchant scope. - POST
/api/contracts/list/continuation/summary-countsdeprecated Counts Contracts for several filters at once. Requires: Customers.Contracts, merchant scope. - DELETE
/api/contracts/{id}deprecated Delete contract Requires: Customers.Contracts, Customers.Contracts.Delete, merchant scope. - GET
/api/contracts/{id}deprecated Get contract by ID Requires: Customers.Contracts, merchant scope. - PUT
/api/contracts/{id}deprecated Update contract Requires: Customers.Contracts, Customers.Contracts.Update, merchant scope. - GET
/api/contracts/{id}/accessdeprecated Check contract access Requires: Customers.Contracts, merchant scope. - GET
/api/contracts/{id}/namedeprecated Get contract name Requires: Customers.Contracts, merchant scope. - POST
/api/contracts/{id}/restoredeprecated Restore deleted contract Requires: Customers.Contracts, Customers.Contracts.Delete, merchant scope.
Customers
- GET
/api/customersdeprecated List customers Requires: Customers.Customers, merchant scope. - POST
/api/customersdeprecated Create customer Requires: Customers.Customers, Customers.Customers.Create, merchant scope. - POST
/api/customers/add-stored-payment-method-asyncdeprecated Adds customer stored payment method. Requires: Customers.Customers, Customers.Customers.Create, merchant scope. - POST
/api/customers/delete-stored-payment-method-asyncdeprecated Deletes customer stored payment method. Requires: Customers.Customers, Customers.Customers.Delete, merchant scope. - POST
/api/customers/list/continuationdeprecated Retrieves a continuation-based page of Customers. Requires: Customers.Customers, merchant scope. - POST
/api/customers/list/continuation/countdeprecated Counts the Customers that match a filter. Requires: Customers.Customers, merchant scope. - POST
/api/customers/list/continuation/summary-countsdeprecated Counts Customers for several filters at once. Requires: Customers.Customers, merchant scope. - DELETE
/api/customers/{id}deprecated Delete customer Requires: Customers.Customers, Customers.Customers.Delete, merchant scope. - GET
/api/customers/{id}deprecated Get customer by ID Requires: Customers.Customers, merchant scope. - PUT
/api/customers/{id}deprecated Update customer Requires: Customers.Customers, Customers.Customers.Update, merchant scope. - GET
/api/customers/{id}/accessdeprecated Check customer access Requires: Customers.Customers, merchant scope. - GET
/api/customers/{id}/namedeprecated Get customer name Requires: Customers.Customers, merchant scope. - POST
/api/customers/{id}/restoredeprecated Restore deleted customer Requires: Customers.Customers, merchant scope.
EmailLog
- GET
/api/twilio/email-logdeprecated Lists email-log rows for the caller's scope, newest first, with cursor-based paging. Requires: Twilio.EmailLog.View, merchant scope. - GET
/api/twilio/email-log/by-correlation/{correlationId}deprecated Gets the full event history for a single outbound message by its correlation id. Requires: Twilio.EmailLog.View, merchant scope. - GET
/api/twilio/email-log/{id}deprecated Gets a single email-log row by its id. Requires: Twilio.EmailLog.View, merchant scope.
Health Checks
- GET
/api/healthdeprecated Returns overall health status. Anonymous callers get summary only. Authenticated callers get component-level detail based on permissions. No permission required. - GET
/api/health/category/{category}deprecated Returns health checks for a specific category. Requires authentication. Detail level depends on ViewDetails permission. Requires: HealthChecks.HealthChecks, merchant scope. - GET
/api/health/components/{name}deprecated Returns health status for a specific component by name. Requires authentication. Detail level depends on ViewDetails permission. Requires: HealthChecks.HealthChecks, merchant scope. - GET
/api/health/groupsdeprecated Returns health checks grouped by category with per-group aggregate status. Requires authentication. Detail level depends on ViewDetails permission. Requires: HealthChecks.HealthChecks, merchant scope.
Hosted Payment Pages
- POST
/api/hosted-payment-page/interactionsdeprecated Records a single client interaction beacon. No permission required. - GET
/api/hostedpaymentpagesdeprecated List hosted payment pages Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hostedpaymentpagesdeprecated Create hosted payment page Requires: HostedPaymentPage.HostedPaymentPages, HostedPaymentPage.HostedPaymentPages.Create, merchant scope. - POST
/api/hostedpaymentpages/create-save-card-capture-asyncdeprecated Creates hosted payment page save card capture. Requires: HostedPaymentPage.HostedPaymentPages, HostedPaymentPage.HostedPaymentPages.Create, merchant scope. - POST
/api/hostedpaymentpages/images/uploaddeprecated Uploads a banner or product image and returns the generated blob filename plus its CDN preview URL. Requires: HostedPaymentPage.HostedPaymentPages.Update, merchant scope. - POST
/api/hostedpaymentpages/list/continuationdeprecated Retrieves a continuation-based page of HostedPaymentPages. Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hostedpaymentpages/list/continuation/countdeprecated Counts the HostedPaymentPages that match a filter. Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hostedpaymentpages/list/continuation/summary-countsdeprecated Counts HostedPaymentPages for several filters at once. Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hostedpaymentpages/lock-asyncdeprecated Locks a HostedPaymentPage. Requires: HostedPaymentPage.HostedPaymentPages, HostedPaymentPage.HostedPaymentPages.Lock, merchant scope. - GET
/api/hostedpaymentpages/sessionsdeprecated Lists HPP sessions for a specific hosted payment page. Requires: HostedPaymentPage.HppSessions, merchant scope. - POST
/api/hostedpaymentpages/sessionsdeprecated Creates a new HPP session with pre-populated field data. Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Create, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/clone-datadeprecated Retrieves the full prefilled field data for an existing session for cloning. Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Create, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/level3-datadeprecated Returns the Level 3 commercial-card payload stored on a session. Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Create, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/payment-linkdeprecated Returns the canonical payment-link URL for a session. Requires: HostedPaymentPage.HppSessions, merchant scope. - GET
/api/hostedpaymentpages/sessions/{sessionId}/qrcode.pngdeprecated Serves a QR code PNG image for the session's payment link. Requires: HostedPaymentPage.HppSessions, merchant scope. - POST
/api/hostedpaymentpages/sessions/{sessionId}/revokedeprecated Revokes an active HPP session so it can no longer be used. Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Delete, merchant scope. - POST
/api/hostedpaymentpages/sessions/{sessionId}/send-linkdeprecated Sends an HPP session payment link to a recipient via email. Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Create, merchant scope. - POST
/api/hostedpaymentpages/unlock-asyncdeprecated Unlocks a HostedPaymentPage. Requires: HostedPaymentPage.HostedPaymentPages, HostedPaymentPage.HostedPaymentPages.Unlock, merchant scope. - DELETE
/api/hostedpaymentpages/{id}deprecated Delete hosted payment page Requires: HostedPaymentPage.HostedPaymentPages, HostedPaymentPage.HostedPaymentPages.Delete, merchant scope. - GET
/api/hostedpaymentpages/{id}deprecated Get hosted payment page Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - PUT
/api/hostedpaymentpages/{id}deprecated Update hosted payment page Requires: HostedPaymentPage.HostedPaymentPages, HostedPaymentPage.HostedPaymentPages.Update, merchant scope. - GET
/api/hostedpaymentpages/{id}/accessdeprecated Check page access Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - GET
/api/hostedpaymentpages/{id}/namedeprecated Get page name Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hostedpaymentpages/{id}/restoredeprecated Restore deleted page Requires: HostedPaymentPage.HostedPaymentPages, merchant scope. - POST
/api/hpp/csp-reportdeprecated Accepts a single CSP violation report. No permission required. - GET
/sdk/core/manifest.jsondeprecated Publishes the release this host serves: its version, its fingerprint, and the integrity value for every artifact. This is the machine-readable half of "the SRI hash for every published artifact is available to integrators"; the release notes carry the human half. No permission required. - GET
/sdk/core/{version}/{fingerprint}/{file}deprecated Serves one published artifact. The version and fingerprint segments must match a release this host has verified; anything else is a 404, including a real file name under the wrong fingerprint. No permission required. - GET
/sdk/sample/{product}.zipdeprecated Serves the sample for the given SDK product, preconfigured for this environment and brand. No permission required. - GET
/sdk/v1/{product}.jsdeprecated Serves the shim for the given SDK product (today, only `pay` — see PhoeniXGate.HostedPaymentPage.HppSdkProductCatalog). Returns 404 for an unrecognized product rather than reflecting the route segment into the response. No permission required.
InboundSmsMessage
Invoicing
- GET
/api/invoicing/credit-notesdeprecated Credit Notes: Retrieves a paged list of credit notes. Requires: Invoicing.CreditNotes, merchant scope. - POST
/api/invoicing/credit-notesdeprecated Credit Notes: Creates a new credit note. Requires: Invoicing.CreditNotes, Invoicing.CreditNotes.Create, merchant scope. - DELETE
/api/invoicing/credit-notes/{id}deprecated Credit Notes: Deletes a credit note by id. Requires: Invoicing.CreditNotes, Invoicing.CreditNotes.Delete, merchant scope. - GET
/api/invoicing/credit-notes/{id}deprecated Credit Notes: Retrieves a single credit note by id. Requires: Invoicing.CreditNotes, merchant scope. - PUT
/api/invoicing/credit-notes/{id}deprecated Credit Notes: Updates an existing credit note by id. Requires: Invoicing.CreditNotes, Invoicing.CreditNotes.Update, merchant scope. - GET
/api/invoicing/custom-field-definitionsdeprecated Custom Field Definitions: Retrieves a paged list of invoice custom field definitions. Requires: Invoicing.CustomFieldDefinitions, merchant scope. - POST
/api/invoicing/custom-field-definitionsdeprecated Custom Field Definitions: Creates a new invoice custom field definition. Requires: Invoicing.CustomFieldDefinitions, Invoicing.CustomFieldDefinitions.Create, merchant scope. - DELETE
/api/invoicing/custom-field-definitions/{id}deprecated Custom Field Definitions: Deletes an invoice custom field definition by id. Requires: Invoicing.CustomFieldDefinitions, Invoicing.CustomFieldDefinitions.Delete, merchant scope. - GET
/api/invoicing/custom-field-definitions/{id}deprecated Custom Field Definitions: Retrieves a single invoice custom field definition by id. Requires: Invoicing.CustomFieldDefinitions, merchant scope. - PUT
/api/invoicing/custom-field-definitions/{id}deprecated Custom Field Definitions: Updates an existing invoice custom field definition by id. Requires: Invoicing.CustomFieldDefinitions, Invoicing.CustomFieldDefinitions.Update, merchant scope. - GET
/api/invoicing/exports/invoices/csvdeprecated Invoices: Exports the filtered invoice list as CSV. Requires: Invoicing.Invoices, merchant scope. - GET
/api/invoicing/exports/invoices/exceldeprecated Invoices: Exports the filtered invoice list as an Excel workbook. Requires: Invoicing.Invoices, merchant scope. - GET
/api/invoicing/invoicesdeprecated Invoices: Retrieves a continuation-token paged, filtered list of invoices. Requires: Invoicing.Invoices, merchant scope. - POST
/api/invoicing/invoicesdeprecated Invoices: Creates a new draft invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.Create, merchant scope. - DELETE
/api/invoicing/invoices/{id}deprecated Invoices: Deletes a draft invoice by id. Requires: Invoicing.Invoices, Invoicing.Invoices.Delete, merchant scope. - GET
/api/invoicing/invoices/{id}deprecated Invoices: Retrieves a single invoice by id. Requires: Invoicing.Invoices, merchant scope. - PUT
/api/invoicing/invoices/{id}deprecated Invoices: Updates an existing draft invoice by id. Requires: Invoicing.Invoices, Invoicing.Invoices.Update, merchant scope. - POST
/api/invoicing/invoices/{id}/canceldeprecated Invoices: Cancels a draft invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.Cancel, merchant scope. - POST
/api/invoicing/invoices/{id}/clonedeprecated Invoices: Clones an existing invoice as a new draft. Requires: Invoicing.Invoices, Invoicing.Invoices.Create, merchant scope. - POST
/api/invoicing/invoices/{id}/closedeprecated Invoices: Closes an invoice (write-off). Requires: Invoicing.Invoices, Invoicing.Invoices.Close, merchant scope. - POST
/api/invoicing/invoices/{id}/issuedeprecated Invoices: Issues a draft invoice (locks it, assigns a number, computes the due date). Requires: Invoicing.Invoices, Invoicing.Invoices.Send, merchant scope. - POST
/api/invoicing/invoices/{id}/mark-as-sentdeprecated Invoices: Marks an issued invoice as sent (status only, no notification). Requires: Invoicing.Invoices, Invoicing.Invoices.Send, merchant scope. - POST
/api/invoicing/invoices/{id}/mark-as-vieweddeprecated Invoices: Marks an invoice as viewed by the recipient. Requires: Invoicing.Invoices, merchant scope. - POST
/api/invoicing/invoices/{id}/record-paymentdeprecated Invoices: Records an offline or manual payment against an invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.RecordPayment, merchant scope. - POST
/api/invoicing/invoices/{id}/senddeprecated Invoices: Runs the full send workflow: issue (if still draft), generate the PDF, create the payment/view tokens, send the notification, and mark the invoice as sent. Requires: Invoicing.Invoices, Invoicing.Invoices.Send, merchant scope. - GET
/api/invoicing/invoices/{invoiceId}/payment-plandeprecated Payment Plan: Returns the invoice's payment plan. The body is empty when no plan is set up (an existing invoice with no plan is a valid state, not a missing resource). Requires: Invoicing.Invoices, merchant scope. - POST
/api/invoicing/invoices/{invoiceId}/payment-plandeprecated Payment Plan: Sets up a payment plan against the issued invoice's outstanding balance and returns the updated invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.PaymentPlan, merchant scope. - POST
/api/invoicing/invoices/{invoiceId}/payment-plan/canceldeprecated Payment Plan: Cancels the active payment plan. The balance is unchanged and remains payable normally. Requires: Invoicing.Invoices, Invoicing.Invoices.PaymentPlan, merchant scope. - POST
/api/invoicing/invoices/{invoiceId}/payment-plan/pay-installmentdeprecated Payment Plan: Records a manual (offline) payment for a single pending installment: applies its amount to the invoice balance and marks the installment collected. Returns the updated invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.PaymentPlan, merchant scope. - GET
/api/invoicing/invoices/{invoiceId}/pdfdeprecated Invoices: Downloads an invoice's PDF document. Requires: Invoicing.Invoices, merchant scope. - GET
/api/invoicing/invoices/{invoiceId}/pdf/metadatadeprecated Invoices: Retrieves the metadata of an invoice's PDF document. Requires: Invoicing.Invoices, merchant scope. - GET
/api/invoicing/productsdeprecated Products: Retrieves a paged list of invoice products. Requires: Invoicing.Products, merchant scope. - POST
/api/invoicing/productsdeprecated Products: Creates a new invoice product. Requires: Invoicing.Products, Invoicing.Products.Create, merchant scope. - DELETE
/api/invoicing/products/{id}deprecated Products: Deletes an invoice product by id. Requires: Invoicing.Products, Invoicing.Products.Delete, merchant scope. - GET
/api/invoicing/products/{id}deprecated Products: Retrieves a single invoice product by id. Requires: Invoicing.Products, merchant scope. - PUT
/api/invoicing/products/{id}deprecated Products: Updates an existing invoice product by id. Requires: Invoicing.Products, Invoicing.Products.Update, merchant scope. - GET
/api/invoicing/public/invoice/{invoiceId}deprecated Retrieves an invoice for public viewing using a view token. Returns 400 if the token is missing or blank, and 404 if the token is invalid, expired, or the invoice is not found. No permission required. - GET
/api/invoicing/recurring-schedulesdeprecated Recurring schedules: Retrieves a filtered list of recurring invoice schedules. Requires: Invoicing.RecurringSchedules, merchant scope. - POST
/api/invoicing/recurring-schedulesdeprecated Recurring schedules: Creates a new recurring invoice schedule. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Create, merchant scope. - DELETE
/api/invoicing/recurring-schedules/{id}deprecated Recurring schedules: Deletes a recurring invoice schedule by id. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Delete, merchant scope. - GET
/api/invoicing/recurring-schedules/{id}deprecated Recurring schedules: Retrieves a single recurring invoice schedule by id. Requires: Invoicing.RecurringSchedules, merchant scope. - PUT
/api/invoicing/recurring-schedules/{id}deprecated Recurring schedules: Updates an existing recurring invoice schedule by id. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Update, merchant scope. - POST
/api/invoicing/recurring-schedules/{id}/canceldeprecated Recurring schedules: Cancels a series permanently. Generation stops and the series cannot be resumed. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Cancel, merchant scope. - POST
/api/invoicing/recurring-schedules/{id}/generate-nowdeprecated Recurring schedules: Generates the currently due invoice for a series immediately (manual trigger). Idempotent: repeating the call for the same due cycle returns the invoice that was already generated rather than creating a duplicate, and the result reports whether this call was the one that created it. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.GenerateNow, merchant scope. - POST
/api/invoicing/recurring-schedules/{id}/pausedeprecated Recurring schedules: Pauses an active series. No further invoices are generated until the series is resumed. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Pause, merchant scope. - POST
/api/invoicing/recurring-schedules/{id}/resumedeprecated Recurring schedules: Resumes a paused series, recomputing the next run when the previous one has already elapsed. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Resume, merchant scope. - GET
/api/invoicing/reports/agingdeprecated Reports: Retrieves the accounts-receivable aging report. Requires: Invoicing.Reports, merchant scope. - GET
/api/invoicing/reports/aging/export/csvdeprecated Reports: Exports the accounts-receivable aging report as CSV. Requires: Invoicing.Reports, Invoicing.Reports.Export, merchant scope. - GET
/api/invoicing/reports/aging/export/exceldeprecated Reports: Exports the accounts-receivable aging report as an Excel workbook. Requires: Invoicing.Reports, Invoicing.Reports.Export, merchant scope. - GET
/api/invoicing/tax-ratesdeprecated Tax Rates: Retrieves a paged list of invoice tax rates. Requires: Invoicing.TaxRates, merchant scope. - POST
/api/invoicing/tax-ratesdeprecated Tax Rates: Creates a new invoice tax rate. Requires: Invoicing.TaxRates, Invoicing.TaxRates.Create, merchant scope. - DELETE
/api/invoicing/tax-rates/{id}deprecated Tax Rates: Deletes an invoice tax rate by id. Requires: Invoicing.TaxRates, Invoicing.TaxRates.Delete, merchant scope. - GET
/api/invoicing/tax-rates/{id}deprecated Tax Rates: Retrieves a single invoice tax rate by id. Requires: Invoicing.TaxRates, merchant scope. - PUT
/api/invoicing/tax-rates/{id}deprecated Tax Rates: Updates an existing invoice tax rate by id. Requires: Invoicing.TaxRates, Invoicing.TaxRates.Update, merchant scope. - GET
/api/invoicing/templatesdeprecated Templates: Retrieves a paged list of invoice templates. Requires: Invoicing.Templates, merchant scope. - POST
/api/invoicing/templatesdeprecated Templates: Creates a new invoice template. Requires: Invoicing.Templates, Invoicing.Templates.Create, merchant scope. - DELETE
/api/invoicing/templates/{id}deprecated Templates: Deletes an invoice template by id. Requires: Invoicing.Templates, Invoicing.Templates.Delete, merchant scope. - GET
/api/invoicing/templates/{id}deprecated Templates: Retrieves a single invoice template by id. Requires: Invoicing.Templates, merchant scope. - PUT
/api/invoicing/templates/{id}deprecated Templates: Updates an existing invoice template by id. Requires: Invoicing.Templates, Invoicing.Templates.Update, merchant scope.
Login
- POST
/api/account/checkPassworddeprecated Check password No permission required. - POST
/api/account/linkLogindeprecated Link external login No permission required. - POST
/api/account/logindeprecated User login No permission required. - GET
/api/account/logoutdeprecated User logout No permission required.
Merchant Billing
- GET
/api/billing-runsdeprecated Billing Runs: Gets a continuation-token paged list of billing runs in the caller's reseller scope. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runsdeprecated Billing Runs: Creates and runs a billing run for the caller's reseller scope. Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant scope. - GET
/api/billing-runs/batchdeprecated Billing Runs: Gets the active all-resellers batch, or the most recent batch. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runs/batch/cleardeprecated Billing Runs: Force-clears the current all-resellers fan-out batch. Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Manage, merchant scope. - GET
/api/billing-runs/merchant-historydeprecated Billing Runs: Gets one merchant's billing history across every run that included it. Requires: MerchantBilling.BillingRuns, merchant scope. - GET
/api/billing-runs/price-plan-historydeprecated Billing Runs: Gets the plan-scoped historic billing report. Requires: MerchantBilling.BillingRuns, MerchantBilling.Reports, merchant scope. - GET
/api/billing-runs/price-plan-history/exportdeprecated Billing Runs: Exports the plan-scoped historic billing report as a file. Requires: MerchantBilling.BillingRuns, MerchantBilling.Reports, merchant scope. - POST
/api/billing-runs/trigger-all-resellersdeprecated Billing Runs: Triggers the admin all-resellers billing fan-out as a background process. Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant scope. - GET
/api/billing-runs/{id}deprecated Billing Runs: Gets a single billing run by its identifier. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runs/{id}/canceldeprecated Billing Runs: Cancels a pending or running billing run. Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant scope. - GET
/api/billing-runs/{id}/exportdeprecated Billing Runs: Exports a billing run's merchant results and line items as a file. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runs/{runId}/results/{resultId}/retry-chargedeprecated Billing Runs: Retries a failed recurring charge on a billing run. Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Retry, merchant scope. - GET
/api/merchants/{merchantId}/billing/payment-methoddeprecated Payment Methods: Gets the active stored payment method for the merchant, or null when none is configured. Requires: MerchantBilling.PaymentMethods, merchant scope. - POST
/api/merchants/{merchantId}/billing/payment-method/capture-link/canceldeprecated Payment Methods: Cancels (revokes) the outstanding capture link for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - POST
/api/merchants/{merchantId}/billing/payment-method/capture-link/resenddeprecated Payment Methods: Resends the outstanding capture link for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - POST
/api/merchants/{merchantId}/billing/payment-method/capture-link/senddeprecated Payment Methods: Emails the merchant a secure link to capture a payment method for recurring billing. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - GET
/api/merchants/{merchantId}/billing/payment-method/capture-link/statusdeprecated Payment Methods: Gets the status of the outstanding capture link for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - GET
/api/merchants/{merchantId}/billing/payment-method/capture-readinessdeprecated Payment Methods: Gets whether the reseller-level prerequisites for capturing a stored method are configured. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - POST
/api/merchants/{merchantId}/billing/payment-method/deactivatedeprecated Payment Methods: Soft-deactivates the active stored payment method for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - GET
/api/merchants/{merchantId}/billing/payment-method/historydeprecated Payment Methods: Gets the continuation-token-paged history of stored methods for the merchant. Requires: MerchantBilling.PaymentMethods, merchant scope. - POST
/api/merchants/{merchantId}/billing/payment-method/{paymentMethodId}/activatedeprecated Payment Methods: Re-activates a stored-but-inactive payment method for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope.
Merchants
- GET
/api/merchantsdeprecated List merchants No permission required. - POST
/api/merchantsdeprecated Create merchant Requires: Merchants.Merchants.Create, merchant scope. - GET
/api/merchants/assignable-for-price-plandeprecated Gets assignable merchants. Requires: Merchants.Merchants, merchant scope. - GET
/api/merchants/by-price-plandeprecated Gets merchants by price plan. Requires: Merchants.Merchants, merchant scope. - POST
/api/merchants/get-default-merchant-user-asyncdeprecated Gets default merchant user. No permission required. - POST
/api/merchants/get-merchant-users-asyncdeprecated Gets merchant users. No permission required. - POST
/api/merchants/list/continuationdeprecated Retrieves a continuation-based page of Merchants. No permission required. - POST
/api/merchants/list/continuation/countdeprecated Counts the Merchants that match a filter. No permission required. - POST
/api/merchants/list/continuation/summary-countsdeprecated Counts Merchants for several filters at once. No permission required. - GET
/api/merchants/reseller-scopedeprecated Gets reseller scope merchants. Requires: Merchants.Merchants, merchant scope. - GET
/api/merchants/self/custom-fieldsdeprecated Gets merchant custom fields. No permission required. - PUT
/api/merchants/self/custom-fieldsdeprecated Updates merchant custom fields. No permission required. - GET
/api/merchants/self/order-data-defaultsdeprecated Gets merchant order data defaults. No permission required. - PUT
/api/merchants/self/order-data-defaultsdeprecated Updates merchant order data defaults. No permission required. - POST
/api/merchants/validate-processor-profile-deactivation-asyncdeprecated Validates merchant processor profile deactivation. No permission required. - DELETE
/api/merchants/{id}deprecated Delete merchant Requires: Merchants.Merchants.Delete, merchant scope. - GET
/api/merchants/{id}deprecated Get merchant by ID No permission required. - PUT
/api/merchants/{id}deprecated Update merchant Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/accessdeprecated Check merchant access No permission required. - POST
/api/merchants/{id}/assign-price-plan/{pricePlanId}deprecated Assigns merchant price plan. Requires: MerchantBilling.PricePlans.Assign, merchant scope. - POST
/api/merchants/{id}/lockdeprecated Locks a Merchant. Requires: Merchants.Merchants.Lock, merchant scope. - GET
/api/merchants/{id}/namedeprecated Get merchant name No permission required. - GET
/api/merchants/{id}/registersdeprecated Get merchant registers No permission required. - POST
/api/merchants/{id}/restoredeprecated Restore deleted merchant No permission required. - POST
/api/merchants/{id}/unassign-price-plandeprecated Unassigns merchant price plan. Requires: MerchantBilling.PricePlans.Assign, merchant scope. - POST
/api/merchants/{id}/unlockdeprecated Unlocks a Merchant. Requires: Merchants.Merchants.Unlock, merchant scope. - GET
/api/merchants/{merchantId}/processor-profilesdeprecated Lists the merchant's processor profiles. No permission required. - POST
/api/merchants/{merchantId}/processor-profilesdeprecated Adds a new processor profile to the merchant. Requires: Merchants.Merchants.Create, merchant scope. - DELETE
/api/merchants/{merchantId}/processor-profiles/{profileId}deprecated Removes a processor profile from the merchant. Requires: Merchants.Merchants.Delete, merchant scope. - GET
/api/merchants/{merchantId}/processor-profiles/{profileId}deprecated Gets a single processor profile by id. No permission required. - PUT
/api/merchants/{merchantId}/processor-profiles/{profileId}deprecated Replaces an existing processor profile (full-replace of that single profile). Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{merchantId}/processor-profiles/{profileId}/summarydeprecated Gets a read-only, non-secret summary of a single processor profile. No permission required.
MerchantScreeningProviderProfile
- GET
/api/merchants/{merchantId}/screening-provider-profilesdeprecated Lists the merchant's screening provider profiles. No permission required. - POST
/api/merchants/{merchantId}/screening-provider-profilesdeprecated Adds a screening provider profile to the merchant. Requires: Merchants.Merchants.Create, merchant scope. - DELETE
/api/merchants/{merchantId}/screening-provider-profiles/{profileId}deprecated Removes a screening provider profile from the merchant. Requires: Merchants.Merchants.Delete, merchant scope. - GET
/api/merchants/{merchantId}/screening-provider-profiles/{profileId}deprecated Gets a single screening provider profile by id. No permission required. - PUT
/api/merchants/{merchantId}/screening-provider-profiles/{profileId}deprecated Replaces an existing screening provider profile (full replace of that single profile). Requires: Merchants.Merchants.Update, merchant scope.
MerchantUserApiKeys
MySession
- GET
/api/app/my-session/approximate-total-countdeprecated No permission required. - GET
/api/app/my-session/continuation-listdeprecated No permission required. - GET
/api/app/my-session/summary-countsdeprecated No permission required. - POST
/api/app/my-session/{id}/ensure-entity-accessdeprecated No permission required. - POST
/api/app/my-session/{id}/revokedeprecated No permission required. - POST
/api/app/my-session/{id}/try-ensure-entity-accessdeprecated No permission required.
Notifications
- GET
/api/notifications/channelsdeprecated Get a list of NotificationChannels Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channelsdeprecated Create a NotificationChannel Requires: Notifications.Channels, Notifications.Channels.Create, merchant scope. - POST
/api/notifications/channels/list/continuationdeprecated Retrieves a continuation-based page of NotificationChannels. Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channels/list/continuation/countdeprecated Counts the NotificationChannels that match a filter. Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channels/list/continuation/summary-countsdeprecated Counts NotificationChannels for several filters at once. Requires: Notifications.Channels, merchant scope. - DELETE
/api/notifications/channels/{id}deprecated Delete a NotificationChannel Requires: Notifications.Channels, Notifications.Channels.Delete, merchant scope. - GET
/api/notifications/channels/{id}deprecated Get a NotificationChannel Requires: Notifications.Channels, merchant scope. - PUT
/api/notifications/channels/{id}deprecated Update a NotificationChannel Requires: Notifications.Channels, Notifications.Channels.Update, merchant scope. - GET
/api/notifications/channels/{id}/accessdeprecated Check NotificationChannel access Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channels/{id}/disabledeprecated Disables a channel. Requires: Notifications.Channels, Notifications.Channels.Update, merchant scope. - POST
/api/notifications/channels/{id}/duplicatedeprecated Duplicates a channel. Requires: Notifications.Channels, Notifications.Channels.Create, merchant scope. - POST
/api/notifications/channels/{id}/enabledeprecated Enables a channel. Requires: Notifications.Channels, Notifications.Channels.Update, merchant scope. - GET
/api/notifications/channels/{id}/namedeprecated Get a NotificationChannel name by id Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channels/{id}/restoredeprecated Restore a deleted NotificationChannel Requires: Notifications.Channels, merchant scope. - GET
/api/notifications/destinationsdeprecated Get a list of NotificationDestinations Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinationsdeprecated Create a NotificationDestination Requires: Notifications.Destinations, Notifications.Destinations.Create, merchant scope. - POST
/api/notifications/destinations/list/continuationdeprecated Retrieves a continuation-based page of NotificationDestinations. Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/list/continuation/countdeprecated Counts the NotificationDestinations that match a filter. Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/list/continuation/summary-countsdeprecated Counts NotificationDestinations for several filters at once. Requires: Notifications.Destinations, merchant scope. - GET
/api/notifications/destinations/types/metadatadeprecated Returns metadata (icon, logo) for all supported destination types. Requires: Notifications.Destinations, merchant scope. - DELETE
/api/notifications/destinations/{id}deprecated Delete a NotificationDestination Requires: Notifications.Destinations, Notifications.Destinations.Delete, merchant scope. - GET
/api/notifications/destinations/{id}deprecated Get a NotificationDestination Requires: Notifications.Destinations, merchant scope. - PUT
/api/notifications/destinations/{id}deprecated Update a NotificationDestination Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - GET
/api/notifications/destinations/{id}/accessdeprecated Check NotificationDestination access Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/{id}/disabledeprecated Disables a destination. Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - POST
/api/notifications/destinations/{id}/duplicatedeprecated Duplicates a destination. Requires: Notifications.Destinations, Notifications.Destinations.Create, merchant scope. - POST
/api/notifications/destinations/{id}/enabledeprecated Enables a destination. Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - GET
/api/notifications/destinations/{id}/namedeprecated Get a NotificationDestination name by id Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/{id}/restoredeprecated Restore a deleted NotificationDestination Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/{id}/send-sampledeprecated Sends a realistic sample of one event type to a saved webhook destination. The body is the sample the event catalog publishes for that type, signed exactly as a real delivery is and marked with an additive `X-WinkPG-Sample: true` header. No delivery record is created. Requires: Notifications.Destinations, Notifications.Destinations.Test, merchant scope. - GET
/api/notifications/destinations/{id}/suppressiondeprecated Gets the durable suppression state for a destination's endpoint. Returns `null` when the endpoint has never failed, or when the transport type has no endpoint concept. Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/{id}/suppression/cleardeprecated Clears the suppression on a destination's endpoint so delivery resumes on the next event. Requires: Notifications.Destinations, Notifications.Suppressions.Clear, merchant scope. - POST
/api/notifications/destinations/{id}/testdeprecated Tests a saved destination by sending a test notification. Requires: Notifications.Destinations, Notifications.Destinations.Test, merchant scope. - POST
/api/notifications/destinations/{type}/test-configdeprecated Tests a destination configuration without requiring a saved entity. Requires: Notifications.Destinations, Notifications.Destinations.Create, merchant scope. - POST
/api/notifications/destinations/{type}/validatedeprecated Validates destination configuration for a specific type. Requires: Notifications.Destinations, merchant scope. - GET
/api/notifications/event-typesdeprecated Returns all event types available for the current user's scope. Requires: Notifications.EventTypes, merchant scope. - GET
/api/notifications/event-types/{eventType}/payload-schemadeprecated Describes the webhook payload schema and an illustrative sample for a specific event type. Requires: Notifications.EventTypes, merchant scope. - GET
/api/notifications/event-types/{eventType}/sample-payloaddeprecated Returns a sample payload for a specific event type. Requires: Notifications.EventTypes, merchant scope. - POST
/api/notifications/filters/validatedeprecated Validates a filter expression. Requires: Notifications.Subscriptions, merchant scope. - GET
/api/notifications/subscriptionsdeprecated Get a list of NotificationSubscriptions Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptionsdeprecated Create a NotificationSubscription Requires: Notifications.Subscriptions, Notifications.Subscriptions.Create, merchant scope. - POST
/api/notifications/subscriptions/list/continuationdeprecated Retrieves a continuation-based page of NotificationSubscriptions. Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptions/list/continuation/countdeprecated Counts the NotificationSubscriptions that match a filter. Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptions/list/continuation/summary-countsdeprecated Counts NotificationSubscriptions for several filters at once. Requires: Notifications.Subscriptions, merchant scope. - DELETE
/api/notifications/subscriptions/{id}deprecated Delete a NotificationSubscription Requires: Notifications.Subscriptions, Notifications.Subscriptions.Delete, merchant scope. - GET
/api/notifications/subscriptions/{id}deprecated Get a NotificationSubscription Requires: Notifications.Subscriptions, merchant scope. - PUT
/api/notifications/subscriptions/{id}deprecated Update a NotificationSubscription Requires: Notifications.Subscriptions, Notifications.Subscriptions.Update, merchant scope. - GET
/api/notifications/subscriptions/{id}/accessdeprecated Check NotificationSubscription access Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptions/{id}/disabledeprecated Disables a subscription. Requires: Notifications.Subscriptions, Notifications.Subscriptions.Update, merchant scope. - POST
/api/notifications/subscriptions/{id}/duplicatedeprecated Duplicates a subscription. Requires: Notifications.Subscriptions, Notifications.Subscriptions.Create, merchant scope. - POST
/api/notifications/subscriptions/{id}/enabledeprecated Enables a subscription. Requires: Notifications.Subscriptions, Notifications.Subscriptions.Update, merchant scope. - GET
/api/notifications/subscriptions/{id}/namedeprecated Get a NotificationSubscription name by id Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptions/{id}/restoredeprecated Restore a deleted NotificationSubscription Requires: Notifications.Subscriptions, merchant scope. - GET
/api/notifications/unsubscribedeprecated Handles unsubscribe link clicks from emails. Validates the token and displays a confirmation page. No permission required. - POST
/api/notifications/unsubscribedeprecated Handles RFC 8058 one-click unsubscribe (POST with List-Unsubscribe-Post header). No permission required. - POST
/api/notifications/unsubscribe/confirmdeprecated Confirms the unsubscribe request and disables the subscription. No permission required.
PazeCertificates
- POST
/api/payment-tokenization/wallet-providers/paze/certificates/{environment}/completedeprecated Complete the Production round-trip by merging a CA-signed certificate. Requires: PaymentTokenization.SettingManagement, merchant scope. - GET
/api/payment-tokenization/wallet-providers/paze/certificates/{environment}/csrdeprecated Download the pending CSR (Production). Requires: PaymentTokenization.SettingManagement, merchant scope. - POST
/api/payment-tokenization/wallet-providers/paze/certificates/{environment}/generatedeprecated Generate or regenerate a certificate. Requires: PaymentTokenization.SettingManagement, merchant scope. - DELETE
/api/payment-tokenization/wallet-providers/paze/certificates/{environment}/pendingdeprecated Cancel a pending CSR round-trip. Requires: PaymentTokenization.SettingManagement, merchant scope. - GET
/api/payment-tokenization/wallet-providers/paze/certificates/{environment}/publicdeprecated Download the active public certificate to register with Paze. Requires: PaymentTokenization.SettingManagement, merchant scope. - GET
/api/payment-tokenization/wallet-providers/paze/certificates/{environment}/statusdeprecated Get the live lifecycle status. Requires: PaymentTokenization.SettingManagement, merchant scope.
PazeJwks
- GET
/.well-known/paze/{environment}/jwks.jsondeprecated Public JWKS for an environment. Anonymous and unthrottled: Paze fetches it to verify/encrypt. No permission required. - GET
/api/payment-tokenization/wallet-providers/paze/jwks/{environment}deprecated Admin preview of an environment's JWKS, for verifying it before registering the URL with Paze. Requires: PaymentTokenization.SettingManagement, merchant scope. - GET
/api/payment-tokenization/wallet-providers/paze/jwks/{environment}/downloaddeprecated Download an environment's JWKS as a `.json` file attachment (admin, from the Settings panel). Requires: PaymentTokenization.SettingManagement, merchant scope.
ProcessorMetadata
- GET
/api/processorsdeprecated Lists every supported processor with its identifier, display name, and supported payment types. Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope. - GET
/api/processors/{processorId}/config-schemadeprecated Returns the configuration field schema for a single processor, optionally scoped to the given payment types. Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope. - GET
/api/processors/{processorId}/config-schema/templatedeprecated Returns a ready-to-fill processor profile skeleton for the given processor and payment-type selection, suitable for dropping into `processing.processorProfiles[]` on a merchant create/update. Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope. - POST
/api/processors/{processorId}/validate-configdeprecated Dry-run validates a processor configuration payload without writing a merchant document, so a client can confirm a payload before submitting it. Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope.
RateLimitProfile
- GET
/api/rate-limiting/profilesdeprecated Rate Limit Profiles: retrieves a paged list of profiles. Requires: RateLimiting.Profiles, merchant scope. - POST
/api/rate-limiting/profilesdeprecated Rate Limit Profiles: creates a profile. Requires: RateLimiting.Profiles, RateLimiting.Profiles.Create, merchant scope. - GET
/api/rate-limiting/profiles/continuationdeprecated Rate Limit Profiles: retrieves a continuation-token paged list of profiles. Requires: RateLimiting.Profiles, merchant scope. - GET
/api/rate-limiting/profiles/continuation/countdeprecated Rate Limit Profiles: retrieves the approximate total number of profiles matching the input. Requires: RateLimiting.Profiles, merchant scope. - GET
/api/rate-limiting/profiles/{entityId}/accessdeprecated Rate Limit Profiles: reports whether the caller may access the profile. Requires: RateLimiting.Profiles, merchant scope. - DELETE
/api/rate-limiting/profiles/{id}deprecated Rate Limit Profiles: deletes a profile by id. Requires: RateLimiting.Profiles, RateLimiting.Profiles.Delete, merchant scope. - GET
/api/rate-limiting/profiles/{id}deprecated Rate Limit Profiles: retrieves a single profile by id. Requires: RateLimiting.Profiles, merchant scope. - PUT
/api/rate-limiting/profiles/{id}deprecated Rate Limit Profiles: updates a profile by id. Requires: RateLimiting.Profiles, RateLimiting.Profiles.Update, merchant scope. - GET
/api/rate-limiting/profiles/{id}/namedeprecated Rate Limit Profiles: returns a profile's display name. Requires: RateLimiting.Profiles, merchant scope. - POST
/api/rate-limiting/profiles/{id}/restoredeprecated Rate Limit Profiles: restores a previously deleted profile. Requires: RateLimiting.Profiles, RateLimiting.Profiles.Update, merchant scope.
RateLimitRule
- GET
/api/rate-limiting/rulesdeprecated Rate Limit Rules: retrieves a paged list of rules. Requires: RateLimiting.Rules, merchant scope. - POST
/api/rate-limiting/rulesdeprecated Rate Limit Rules: creates a rule. Requires: RateLimiting.Rules, RateLimiting.Rules.Create, merchant scope. - GET
/api/rate-limiting/rules/continuationdeprecated Rate Limit Rules: retrieves a continuation-token paged list of rules. Requires: RateLimiting.Rules, merchant scope. - GET
/api/rate-limiting/rules/continuation/countdeprecated Rate Limit Rules: retrieves the approximate total number of rules matching the input. Requires: RateLimiting.Rules, merchant scope. - GET
/api/rate-limiting/rules/limitersdeprecated Rate Limit Rules: lists every limiter the running host declares, with its defaults. Requires: RateLimiting.Rules, merchant scope. - GET
/api/rate-limiting/rules/profilesdeprecated Rate Limit Rules: lists every profile as a lightweight picker item. Requires: RateLimiting.Rules, merchant scope. - GET
/api/rate-limiting/rules/{entityId}/accessdeprecated Rate Limit Rules: reports whether the caller may access the rule. Requires: RateLimiting.Rules, merchant scope. - DELETE
/api/rate-limiting/rules/{id}deprecated Rate Limit Rules: deletes a rule by id. Requires: RateLimiting.Rules, RateLimiting.Rules.Delete, merchant scope. - GET
/api/rate-limiting/rules/{id}deprecated Rate Limit Rules: retrieves a single rule by id. Requires: RateLimiting.Rules, merchant scope. - PUT
/api/rate-limiting/rules/{id}deprecated Rate Limit Rules: updates a rule by id. Requires: RateLimiting.Rules, RateLimiting.Rules.Update, merchant scope. - GET
/api/rate-limiting/rules/{id}/namedeprecated Rate Limit Rules: returns a rule's display name. Requires: RateLimiting.Rules, merchant scope. - POST
/api/rate-limiting/rules/{id}/restoredeprecated Rate Limit Rules: restores a previously deleted rule. Requires: RateLimiting.Rules, RateLimiting.Rules.Update, merchant scope.
RecurringBilling
- GET
/api/customers/recurring-billing/contracts/{contractId}/historydeprecated Get billing history filtered by contract. Requires: Customers.RecurringBilling.ViewHistory, merchant scope. - GET
/api/customers/recurring-billing/customers/{customerId}/historydeprecated Get billing history filtered by customer. Requires: Customers.RecurringBilling.ViewHistory, merchant scope. - GET
/api/customers/recurring-billing/historydeprecated Get paginated execution history of recurring billing runs. Requires: Customers.RecurringBilling.ViewHistory, merchant scope. - GET
/api/customers/recurring-billing/runs/{id}deprecated Get the detail of a specific billing run, including per-contract items. Requires: Customers.RecurringBilling.ViewHistory, merchant scope. - POST
/api/customers/recurring-billing/triggerdeprecated Manually trigger a recurring billing workflow execution. Requires: Customers.RecurringBilling.Trigger, merchant scope.
Resellers
- GET
/api/resellersdeprecated List resellers Requires: Resellers.Resellers, reseller scope. - POST
/api/resellersdeprecated Create reseller Requires: Resellers.Resellers, Resellers.Resellers.Create, reseller scope. - POST
/api/resellers/get-billing-preferences-asyncdeprecated Gets reseller billing preferences. Requires: Resellers.Resellers, Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/get-default-reseller-user-asyncdeprecated Gets default reseller user. Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/get-for-billing-self-service-asyncdeprecated Gets reseller for billing self service. Requires: Resellers.Resellers, Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/get-own-billing-preferences-asyncdeprecated Gets reseller own billing preferences. Requires: Resellers.Resellers, Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/list/continuationdeprecated Retrieves a continuation-based page of Resellers. Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/list/continuation/countdeprecated Counts the Resellers that match a filter. Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/list/continuation/summary-countsdeprecated Counts Resellers for several filters at once. Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/update-billing-preferences-asyncdeprecated Updates reseller billing preferences. Requires: Resellers.Resellers, Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/update-own-billing-preferences-asyncdeprecated Updates reseller own billing preferences. Requires: Resellers.Resellers, Resellers.Resellers.Update, reseller scope. - DELETE
/api/resellers/{id}deprecated Delete reseller Requires: Resellers.Resellers, Resellers.Resellers.Delete, reseller scope. - GET
/api/resellers/{id}deprecated Get reseller by ID Requires: Resellers.Resellers, reseller scope. - PUT
/api/resellers/{id}deprecated Update reseller Requires: Resellers.Resellers, Resellers.Resellers.Update, reseller scope. - GET
/api/resellers/{id}/accessdeprecated Check reseller access Requires: Resellers.Resellers, reseller scope. - GET
/api/resellers/{id}/namedeprecated Get reseller name Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/{id}/restoredeprecated Restore deleted reseller Requires: Resellers.Resellers, reseller scope.
Roles
- GET
/api/identity/rolesdeprecated List roles Requires: AbpIdentity.Roles, host scope. - POST
/api/identity/rolesdeprecated Create new role Requires: AbpIdentity.Roles, AbpIdentity.Roles.Create, host scope. - GET
/api/identity/roles/alldeprecated Get all roles Requires: AbpIdentity.Roles, host scope. - GET
/api/identity/roles/all-claim-typesdeprecated GetAllClaimTypes for Role Requires: AbpIdentity.Roles, host scope. - DELETE
/api/identity/roles/{id}deprecated Delete role Requires: AbpIdentity.Roles, AbpIdentity.Roles.Delete, host scope. - GET
/api/identity/roles/{id}deprecated Get role by ID Requires: AbpIdentity.Roles, host scope. - PUT
/api/identity/roles/{id}deprecated Update role Requires: AbpIdentity.Roles, AbpIdentity.Roles.Update, host scope. - GET
/api/identity/roles/{id}/claimsdeprecated GetClaims for Role Requires: AbpIdentity.Roles, host scope. - PUT
/api/identity/roles/{id}/claimsdeprecated Update role claims Requires: AbpIdentity.Roles, AbpIdentity.Roles.Update, host scope. - PUT
/api/identity/roles/{id}/move-all-usersdeprecated Move all users to role Requires: AbpIdentity.Roles, AbpIdentity.Roles.Update, host scope. - DELETE
/api/identity/roles/{id}/users/{userId}deprecated Requires: AbpIdentity.Roles, AbpIdentity.Roles.Update, host scope.
ScreeningProviderMetadata
- GET
/api/screening-providersdeprecated Lists every supported screening provider with its identifier, display name, and declared processor conflicts. Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope. - GET
/api/screening-providers/{providerId}/config-schemadeprecated Returns the configuration field schema for a single screening provider. Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope. - GET
/api/screening-providers/{providerId}/config-schema/templatedeprecated Returns a ready-to-fill screening provider profile skeleton, suitable for dropping into `processing.screeningProviderProfiles[]` on a merchant create/update. Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope. - POST
/api/screening-providers/{providerId}/validate-configdeprecated Dry-run validates a screening provider configuration payload without writing a merchant document. Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope.
Security
- GET
/api/app/my-security-log/approximate-total-countdeprecated No permission required. - GET
/api/app/my-security-log/continuation-listdeprecated No permission required. - GET
/api/app/my-security-log/summary-countsdeprecated No permission required. - POST
/api/app/my-security-log/{id}/ensure-entity-accessdeprecated No permission required. - POST
/api/app/my-security-log/{id}/try-ensure-entity-accessdeprecated No permission required. - GET
/api/security-posture/sbom/buildsdeprecated List archived SBOM builds, most-recent-first, with continuation-token paging. Requires: SecurityPosture.Sbom, merchant scope. - GET
/api/security-posture/sbom/builds/{buildId}deprecated Return the component manifest for a single build. Requires: SecurityPosture.Sbom, merchant scope. - GET
/api/security-posture/sbom/builds/{buildId}/components/{componentName}deprecated Stream the CycloneDX JSON for one component within a build. Each call is audit-logged. Requires: SecurityPosture.Sbom, SecurityPosture.Sbom.Download, merchant scope.
SettlementReporting
- GET
/api/transactions/settlement-reports/batches/{settlementBatchId}deprecated Returns the full detail of one settlement batch, including the per-payment-type breakdown. No permission required. - GET
/api/transactions/settlement-reports/historydeprecated Returns a page of settlement batches matching the supplied filters, newest run first. No permission required.
SmsConsent
- GET
/api/twilio/sms-consentdeprecated Lists SMS consent records for the caller's scope, newest transition first, with cursor-based paging. Requires: Twilio.SmsConsent.View, merchant scope. - POST
/api/twilio/sms-consentdeprecated Records a consent or opt-out transition with its proof-of-consent evidence. Requires: Twilio.SmsConsent.View, Twilio.SmsConsent.Manage, merchant scope. - GET
/api/twilio/sms-consent/checkdeprecated Checks whether SMS may be sent to a phone number for the caller's merchant scope. Requires: Twilio.SmsConsent.View, merchant scope.
SmsLog
- GET
/api/twilio/sms-logdeprecated Lists outbound SMS delivery records for the caller's scope, newest first, with cursor-based paging. Requires: Twilio.SmsLog.View, merchant scope. - GET
/api/twilio/sms-log/by-correlation/{correlationId}deprecated Gets the delivery record for a single outbound message by its correlation id. Requires: Twilio.SmsLog.View, merchant scope.
SurchargeConfiguration
- POST
/api/surcharging/configurationsdeprecated Surcharging: Creates a merchant's initial surcharge configuration. Requires: Surcharging.Configuration.Manage, merchant scope. - PUT
/api/surcharging/configurationsdeprecated Surcharging: Updates a merchant's rate, channel restrictions, and network policies. Requires: Surcharging.Configuration.Manage, merchant scope. - POST
/api/surcharging/configurations/noticesdeprecated Surcharging: Records a filed card-brand notice and starts the waiting period. Requires: Surcharging.Notice.File, merchant scope. - GET
/api/surcharging/configurations/{merchantId}deprecated Surcharging: Returns a merchant's surcharge configuration, or null when none exists. Requires: Surcharging.Configuration.View, merchant scope. - POST
/api/surcharging/configurations/{merchantId}/disabledeprecated Surcharging: Disables surcharging for a merchant. Requires: Surcharging.Configuration.Manage, merchant scope. - POST
/api/surcharging/configurations/{merchantId}/enabledeprecated Surcharging: Enables surcharging for a merchant. Requires: Surcharging.Configuration.Manage, merchant scope. - GET
/api/surcharging/configurations/{merchantId}/state-policiesdeprecated Surcharging: Returns a merchant's per-state restriction table. Requires: Surcharging.Configuration.View, merchant scope. - PUT
/api/surcharging/configurations/{merchantId}/state-policiesdeprecated Surcharging: Replaces a merchant's per-state restriction table (operator action). Requires: Surcharging.Admin.GlobalSettings, merchant scope.
SurchargeQuote
Tokens
- GET
/api/tokensdeprecated List payment tokens No permission required. - POST
/api/tokensdeprecated Create payment token No permission required. - POST
/api/tokens/can-delete-asyncdeprecated Cans payment token delete. No permission required. - POST
/api/tokens/create-from-transaction-asyncdeprecated Creates payment token from transaction. No permission required. - POST
/api/tokens/create-standalone-asyncdeprecated CreateStandalone for Tokens No permission required. - POST
/api/tokens/deactivate-asyncdeprecated Deactivates a PaymentToken. No permission required. - POST
/api/tokens/list/continuationdeprecated Retrieves a continuation-based page of PaymentTokens. No permission required. - POST
/api/tokens/list/continuation/countdeprecated Counts the PaymentTokens that match a filter. No permission required. - POST
/api/tokens/list/continuation/summary-countsdeprecated Counts PaymentTokens for several filters at once. No permission required. - POST
/api/tokens/reactivate-asyncdeprecated Reactivates a PaymentToken. No permission required. - POST
/api/tokens/regenerate-asyncdeprecated Regenerates a PaymentToken. No permission required. - POST
/api/tokens/resolve-payment-token-asyncdeprecated ResolvePaymentToken for Tokens No permission required. - DELETE
/api/tokens/{id}deprecated Delete payment token No permission required. - GET
/api/tokens/{id}deprecated Get payment token No permission required. - PUT
/api/tokens/{id}deprecated Update payment token No permission required.
Transactions
- GET
/api/transactionsdeprecated List transactions No permission required. - POST
/api/transactionsdeprecated Create transaction Requires: Transactions.Reports, merchant scope. - GET
/api/transactions/batch-filedeprecated Gets a filtered, paged list of batch files. No permission required. - POST
/api/transactions/batch-file/uploaddeprecated Uploads a CSV batch file for transaction processing. No permission required. - DELETE
/api/transactions/batch-file/{id}deprecated Deletes a batch file and its associated blob storage content. No permission required. - GET
/api/transactions/batch-file/{id}deprecated Gets a batch file by its unique identifier. No permission required. - POST
/api/transactions/batch-file/{id}/canceldeprecated Cancels a batch file that is pending or in progress. No permission required. - GET
/api/transactions/batch-file/{id}/downloaddeprecated Downloads the original uploaded CSV batch file. No permission required. - GET
/api/transactions/batch-file/{id}/export-resultsdeprecated Exports batch processing results as a CSV file. No permission required. - POST
/api/transactions/batch-file/{id}/trigger-processingdeprecated Triggers asynchronous processing of a batch file. No permission required. - POST
/api/transactions/from-hpp-sessiondeprecated Creates transaction from hpp session. No permission required. - POST
/api/transactions/get-by-idempotency-key-asyncdeprecated Gets transaction by idempotency key. Requires: Transactions.Reports.View, merchant scope. - POST
/api/transactions/get-transaction-by-id-asyncdeprecated Gets transaction by id. No permission required. - POST
/api/transactions/get-unsettled-transaction-summary-by-processor-profile-asyncdeprecated Gets unsettled transaction summary by processor profile. No permission required. - POST
/api/transactions/list/continuationdeprecated Retrieves a continuation-based page of Transactions. No permission required. - POST
/api/transactions/list/continuation/countdeprecated Counts the Transactions that match a filter. No permission required. - POST
/api/transactions/list/continuation/summary-countsdeprecated Counts Transactions for several filters at once. No permission required. - GET
/api/transactions/reports/merchant-summarydeprecated Rolls up the window's transactions by merchant. Requires: Transactions.Reports.Summary, merchant scope. - GET
/api/transactions/reports/paytype-summarydeprecated Rolls up the window's transactions by payment type. Requires: Transactions.Reports.Summary, merchant scope. - POST
/api/transactions/settlement-overridedeprecated Apply a manual settlement-status override to one or more transactions. Requires: Transactions.Settlement.Override, merchant scope. - POST
/api/transactions/settlements/merchants/{merchantId}/triggerdeprecated Trigger settlement for a specific merchant. No permission required. - POST
/api/transactions/settlements/triggerdeprecated Trigger settlement for all eligible merchants. Requires: Transactions.Settlement.Trigger, merchant scope. - GET
/api/transactions/{id}deprecated Get transaction by ID No permission required. - PUT
/api/transactions/{id}/tagsdeprecated Updates transaction tags. Requires: Transactions.Reports, merchant scope. - POST
/api/transactions/{merchantId}/{transactionId}/operationsdeprecated Execute a follow-up operation on an existing transaction. No permission required. - POST
/api/transactions/{transactionId}/operationsdeprecated Legacy single-id route retained for backward compatibility. Resolves `MerchantId` via a cross-partition lookup, then forwards to the merchant-scoped path. New callers should target the merchant-scoped route directly. The `Deprecation` response header lets client telemetry pick up traffic on this route during the migration. No permission required.
Usage
- GET
/api/usage/entitlementsdeprecated List entitlements with optional filters using continuation-token paging. Requires: Usage.PlatformDefaults, merchant scope. - POST
/api/usage/entitlementsdeprecated Create a new entitlement. The application service performs scope-specific manage-permission checks. No permission required. - GET
/api/usage/entitlements/effectivedeprecated Resolve the effective entitlement at a given scope (Merchant → Reseller → Platform → Default). Requires: Usage.PlatformDefaults, merchant scope. - DELETE
/api/usage/entitlements/{id}deprecated Delete an entitlement. The application service performs scope-specific manage-permission checks. No permission required. - GET
/api/usage/entitlements/{id}deprecated Get an entitlement by ID. Requires: Usage.PlatformDefaults, merchant scope. - PUT
/api/usage/entitlements/{id}deprecated Update an existing entitlement. The application service performs scope-specific manage-permission checks. No permission required. - GET
/api/usage/reports/dimensional-summarydeprecated Get a paged dimensional rollup for a SKU. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/ledger/exportdeprecated Export merchant ledger entries. Requires: Usage.Reports.Export, merchant scope. - GET
/api/usage/reports/merchant-ledgerdeprecated Get paginated merchant ledger entries. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/merchant-summarydeprecated Get a merchant's usage summary for a given period. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/reseller-merchant-breakdowndeprecated Get per-merchant usage breakdown for a reseller. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/reseller-summarydeprecated Get a reseller's aggregated usage summary across all their merchants. Requires: Usage.Reports, merchant scope. - GET
/api/usage/reports/skusdeprecated List all registered SKU definitions. Requires: Usage.Skus, merchant scope. - GET
/api/usage/reports/summary/exportdeprecated Export the merchant SKU summary. Requires: Usage.Reports.Export, merchant scope.
UserFavorites
- DELETE
/api/favorites/userdeprecated Remove (unpin) a favorite for the operating user. Requires: Favorites.Manage, merchant scope. - GET
/api/favorites/userdeprecated List the operating user's favorites, bucketed by whether they match the current operating context. Requires: Favorites.Manage, merchant scope. - POST
/api/favorites/userdeprecated Pin an entity as a favorite for the operating user. Requires: Favorites.Manage, merchant scope. - GET
/api/favorites/user/countdeprecated Count the operating user's favorites across every entity type. Requires: Favorites.Manage, merchant scope. - GET
/api/favorites/user/idsdeprecated List the entity ids the operating user has favorited for a single entity type. Requires: Favorites.Manage, merchant scope.
Users
- GET
/api/account/link-userdeprecated GetAllList for User No permission required. - GET
/api/account/sessionsdeprecated List sessions No permission required. - DELETE
/api/account/sessions/{id}deprecated Revoke for Sessions No permission required. - GET
/api/account/sessions/{id}deprecated Get session No permission required. - GET
/api/identity/usersdeprecated List users Requires: AbpIdentity.Users, host scope. - POST
/api/identity/usersdeprecated Create new user Requires: AbpIdentity.Users, AbpIdentity.Users.Create, host scope. - GET
/api/identity/users/all-claim-typesdeprecated GetAllClaimTypes for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/approximate-countdeprecated Gets the approximate total count of users based on the provided input. Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/assignable-rolesdeprecated Get assignable roles Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/available-organization-unitsdeprecated GetAvailableOrganizationUnits for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/by-email/{email}deprecated Find user by email Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/by-id/{id}deprecated FindById for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/by-username/{username}deprecated Find user by username Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/continuation-listdeprecated Retrieves a paged list of users using continuation tokens for efficient pagination. Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/download-tokendeprecated GetDownloadToken for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/export-as-csvdeprecated GetListAsCsvFile for User No permission required. - GET
/api/identity/users/export-as-exceldeprecated GetListAsExcelFile for User No permission required. - GET
/api/identity/users/external-login-Providersdeprecated GetExternalLoginProviders for User Requires: AbpIdentity.Users, AbpIdentity.Users.Import, host scope. - POST
/api/identity/users/import-external-userdeprecated Import external user Requires: AbpIdentity.Users, AbpIdentity.Users.Import, host scope. - POST
/api/identity/users/import-users-from-filedeprecated ImportUsersFromFile for User Requires: AbpIdentity.Users, AbpIdentity.Users.Import, host scope. - GET
/api/identity/users/lookup/organization-unitsdeprecated GetOrganizationUnitLookup for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/lookup/rolesdeprecated GetRoleLookup for User Requires: AbpIdentity.Users, host scope. - DELETE
/api/identity/users/{id}deprecated Delete user Requires: AbpIdentity.Users, AbpIdentity.Users.Delete, host scope. - GET
/api/identity/users/{id}deprecated Get user by ID Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}deprecated Update user Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/identity/users/{id}/accessdeprecated Checks if the user has access to the specified entity. Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}/change-passworddeprecated UpdatePassword for User Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/identity/users/{id}/claimsdeprecated GetClaims for User Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}/claimsdeprecated Update user claims Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - PUT
/api/identity/users/{id}/lock/{lockoutEnd}deprecated Lock user account Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/identity/users/{id}/namedeprecated Gets the display name of a user by ID. Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/{id}/organization-unitsdeprecated Get user organization units Requires: AbpIdentity.Users, host scope. - POST
/api/identity/users/{id}/restoredeprecated Restores a deleted user by ID. Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/{id}/rolesdeprecated Get user roles Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}/rolesdeprecated Update user roles Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/identity/users/{id}/two-factor-enableddeprecated GetTwoFactorEnabled for User Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}/two-factor/{enabled}deprecated SetTwoFactorEnabled for User Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - PUT
/api/identity/users/{id}/unlockdeprecated Unlock user account Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope.
WalletCheckoutSnapshot
WalletProviders
- GET
/api/payment-tokenization/wallet-providersdeprecated Get a list of WalletProviderRegistrations Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - POST
/api/payment-tokenization/wallet-providersdeprecated Create a WalletProviderRegistration Requires: PaymentTokenization.PaymentTokenizations, PaymentTokenization.PaymentTokenizations.Create, merchant scope. - POST
/api/payment-tokenization/wallet-providers/list/continuationdeprecated Retrieves a continuation-based page of WalletProviderRegistrations. Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - POST
/api/payment-tokenization/wallet-providers/list/continuation/countdeprecated Counts the WalletProviderRegistrations that match a filter. Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - POST
/api/payment-tokenization/wallet-providers/list/continuation/summary-countsdeprecated Counts WalletProviderRegistrations for several filters at once. Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - GET
/api/payment-tokenization/wallet-providers/platform/{providerType}deprecated Gets wallet provider registration platform. Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - GET
/api/payment-tokenization/wallet-providers/providersdeprecated Lists wallet provider registrations. Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - DELETE
/api/payment-tokenization/wallet-providers/{id}deprecated Delete a WalletProviderRegistration Requires: PaymentTokenization.PaymentTokenizations, PaymentTokenization.PaymentTokenizations.Delete, merchant scope. - GET
/api/payment-tokenization/wallet-providers/{id}deprecated Get a WalletProviderRegistration Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - PUT
/api/payment-tokenization/wallet-providers/{id}deprecated Update a WalletProviderRegistration Requires: PaymentTokenization.PaymentTokenizations, PaymentTokenization.PaymentTokenizations.Update, merchant scope. - GET
/api/payment-tokenization/wallet-providers/{id}/accessdeprecated Check WalletProviderRegistration access Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - DELETE
/api/payment-tokenization/wallet-providers/{id}/domainsdeprecated Unregisters wallet provider registration domains. Requires: PaymentTokenization.PaymentTokenizations, PaymentTokenization.PaymentTokenizations.Update, merchant scope. - GET
/api/payment-tokenization/wallet-providers/{id}/namedeprecated Get a WalletProviderRegistration name by id Requires: PaymentTokenization.PaymentTokenizations, merchant scope. - POST
/api/payment-tokenization/wallet-providers/{id}/restoredeprecated Restore a deleted WalletProviderRegistration Requires: PaymentTokenization.PaymentTokenizations, PaymentTokenization.PaymentTokenizations.Update, merchant scope. - POST
/api/payment-tokenization/wallet-providers/{id}/syncdeprecated Syncs from wallet provider registration. Requires: PaymentTokenization.PaymentTokenizations, PaymentTokenization.PaymentTokenizations.Update, merchant scope.