API reference
WinkPG API version v1. 683 endpoints published by this instance.
The API reference isn't available right now
This instance couldn't load its API specification, so this page lists nothing. The reference returns as soon as the specification is readable again.
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
438 endpoints are in reach of the admin scope. Scopes only restrict a key, so the account that owns it still needs the permissions each endpoint lists.
This instance publishes no API operations.
No endpoint this instance publishes is in reach of that scope. Choose All scopes to see the whole reference.
Identity & Access
Account
Sign-in account self-service: registration, password reset, email and phone confirmation, and profile management.
- POST
/api/account/confirm-emaildeprecated admin Confirm email address No permission required. - POST
/api/account/confirm-phone-numberdeprecated admin Confirm phone number No permission required. - GET
/api/account/confirmation-statedeprecated admin Get account confirmation state No permission required. - POST
/api/account/profile-picturedeprecated admin Set profile picture No permission required. - GET
/api/account/profile-picture-file/{id}deprecated admin GetProfilePictureFile for Account No permission required. - GET
/api/account/profile-picture/{id}deprecated admin Get profile picture No permission required. - GET
/api/account/recaptcha-validatedeprecated admin Recaptcha for Account No permission required. - POST
/api/account/registerdeprecated admin Register new account No permission required. - POST
/api/account/reset-passworddeprecated admin Reset password No permission required. - GET
/api/account/security-logsdeprecated admin Get security logs No permission required. - POST
/api/account/send-email-confirmation-tokendeprecated admin Send email confirmation token No permission required. - POST
/api/account/send-password-reset-codedeprecated admin Send password reset code No permission required. - POST
/api/account/send-phone-number-confirmation-tokendeprecated admin Send phone confirmation token No permission required. - POST
/api/account/verify-email-confirmation-tokendeprecated admin Verify email confirmation token No permission required. - POST
/api/account/verify-password-reset-tokendeprecated admin Verify password reset token No permission required. - POST
/api/app/account/send-password-reset-code-with-usernamedeprecated admin SendPasswordResetCodeWithUsername for Account No permission required. - GET
/api/account/my-profiledeprecated admin Get user profile No permission required. - PUT
/api/account/my-profiledeprecated admin Update user profile No permission required. - POST
/api/account/my-profile/change-passworddeprecated admin Change password No permission required. - POST
/api/account/my-profile/set-two-factor-enableddeprecated admin SetTwoFactorEnabled for Profile No permission required. - GET
/api/account/my-profile/timezonesdeprecated admin GetTimezones for Profile No permission required. - GET
/api/account/my-profile/two-factor-enableddeprecated admin GetTwoFactorEnabled for Profile No permission required. - GET
/api/app/wink-pg-profiledeprecated admin No permission required. - PUT
/api/app/wink-pg-profiledeprecated admin No permission required. - POST
/api/app/wink-pg-profile/can-enable-two-factordeprecated admin No permission required. - POST
/api/app/wink-pg-profile/change-passworddeprecated admin No permission required. - POST
/api/app/wink-pg-profile/set-two-factor-enableddeprecated admin No permission required. - GET
/api/app/wink-pg-profile/timezonesdeprecated admin No permission required. - GET
/api/app/wink-pg-profile/two-factor-enableddeprecated admin No permission required.
Platform Configuration
Accounting OAuth
Connecting a merchant to an accounting provider over OAuth, and completing the provider's callback.
Messaging & Notifications
Announcements
System announcements and banner management.
- GET
/api/announcementsdeprecated admin Get a list of Announcements Requires: Announcements.Management, merchant scope. - POST
/api/announcementsdeprecated admin Create an Announcement Requires: Announcements.Management, Announcements.Management.Create, merchant scope. - POST
/api/announcements/disable-asyncdeprecated admin Disables an announcement. Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - POST
/api/announcements/duplicate-asyncdeprecated admin Duplicates an existing announcement with a new title. Requires: Announcements.Management, Announcements.Management.Create, merchant scope. - POST
/api/announcements/enable-asyncdeprecated admin Enables an announcement. Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - GET
/api/announcements/templatesdeprecated admin Get a list of AnnouncementTemplates Requires: Announcements.Management, merchant scope. - POST
/api/announcements/templatesdeprecated admin Create an AnnouncementTemplate Requires: Announcements.Management, Announcements.Management.Create, merchant scope. - GET
/api/announcements/templates/picker-listdeprecated admin Lists every template as an id and a name. Requires: Announcements.Management, merchant scope. - DELETE
/api/announcements/templates/{id}deprecated admin Delete an AnnouncementTemplate Requires: Announcements.Management, Announcements.Management.Delete, merchant scope. - GET
/api/announcements/templates/{id}deprecated admin Get an AnnouncementTemplate Requires: Announcements.Management, merchant scope. - PUT
/api/announcements/templates/{id}deprecated admin Update an AnnouncementTemplate Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - GET
/api/announcements/templates/{id}/accessdeprecated admin Check AnnouncementTemplate access Requires: Announcements.Management, merchant scope. - GET
/api/announcements/templates/{id}/namedeprecated admin Get an AnnouncementTemplate name by id Requires: Announcements.Management, merchant scope. - POST
/api/announcements/templates/{id}/restoredeprecated admin Restore a deleted AnnouncementTemplate Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - DELETE
/api/announcements/{id}deprecated admin Delete an Announcement Requires: Announcements.Management, Announcements.Management.Delete, merchant scope. - GET
/api/announcements/{id}deprecated admin Get an Announcement Requires: Announcements.Management, merchant scope. - PATCH
/api/announcements/{id}deprecated admin Partially update an Announcement Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - PUT
/api/announcements/{id}deprecated admin Update an Announcement Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - GET
/api/announcements/{id}/accessdeprecated admin Check Announcement access Requires: Announcements.Management, merchant scope. - GET
/api/announcements/{id}/engagement-statsdeprecated admin Gets engagement statistics for a specific announcement. Requires: Announcements.Management, merchant scope. - GET
/api/announcements/{id}/namedeprecated admin Get an Announcement name by id Requires: Announcements.Management, merchant scope. - POST
/api/announcements/{id}/restoredeprecated admin Restore a deleted Announcement Requires: Announcements.Management, Announcements.Management.Update, merchant scope. - GET
/api/announcements/userdeprecated admin Gets announcements for the current user, ordered by priority and date. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/dismiss-alldeprecated admin Dismisses all announcements for the current user. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/mark-many-as-readdeprecated admin Marks multiple announcements as read for the current user. Requires: Announcements.View, merchant scope. - GET
/api/announcements/user/pending-popupsdeprecated admin Gets announcements that need to display a popup to the current user. Requires: Announcements.View, merchant scope. - GET
/api/announcements/user/unread-countdeprecated admin Gets the count of unread announcements for the current user. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/{announcementId}/dismissdeprecated admin Dismisses an announcement for the current user. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/{announcementId}/mark-as-readdeprecated admin Marks an announcement as read for the current user. Requires: Announcements.View, merchant scope. - POST
/api/announcements/user/{announcementId}/record-popup-showndeprecated admin Records that a popup was shown to the current user for the specified announcement. Requires: Announcements.View, merchant scope.
Identity & Access
API Keys
API key lifecycle for programmatic access: issuing a key, revealing it once, rotating it, and deactivating or deleting it.
- GET
/api/api-keysdeprecated admin List API keys Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keysdeprecated admin Create API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/approximate-countdeprecated admin Gets the approximate total count of API keys based on the provided input. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/continuation-listdeprecated admin Gets a continuation list of API keys based on the provided input. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keys/revealdeprecated admin CreateAndReveal for ApiKeys Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - DELETE
/api/api-keys/{id}deprecated admin Delete API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/{id}deprecated admin Get API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - PUT
/api/api-keys/{id}deprecated admin Update API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/{id}/detaildeprecated admin Get an API key's details Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/{id}/has-accessdeprecated admin Checks if the caller may access the API key. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - GET
/api/api-keys/{id}/namedeprecated admin Gets the name of the API key by id. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keys/{id}/reinstatedeprecated admin Reinstate a suspended API key Requires: ApiKeyAuthorization.ApiKeys, ApiKeyAuthorization.ApiKeys.Suspend, merchant scope. - POST
/api/api-keys/{id}/restoredeprecated admin Restores a deleted API key item by id. Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keys/{id}/revokedeprecated admin Revoke an API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keys/{id}/rotatedeprecated admin Rotate an API key Requires: ApiKeyAuthorization.ApiKeys, merchant scope. - POST
/api/api-keys/{id}/suspenddeprecated admin Suspend an API key Requires: ApiKeyAuthorization.ApiKeys, ApiKeyAuthorization.ApiKeys.Suspend, merchant scope. - POST
/api/api-keys/for-userdeprecated admin Create and reveal an API key for a merchant user. Requires: ApiKeyAuthorization.ApiKeys.CreateForUser, merchant scope.
Reporting & Operations
Audit Log
The platform audit trail: who changed what, when, and from where, paged with continuation tokens.
- GET
/api/app/audit-log-continuation/approximate-total-countdeprecated admin Counts the entities matching `input`. Requires: AuditLogging.AuditLogs, merchant scope. - GET
/api/app/audit-log-continuation/continuation-listdeprecated admin Requires: AuditLogging.AuditLogs, merchant scope. - GET
/api/app/audit-log-continuation/summary-countsdeprecated admin Requires: AuditLogging.AuditLogs, merchant scope. - POST
/api/app/audit-log-continuation/{id}/ensure-entity-accessdeprecated admin Requires: AuditLogging.AuditLogs, merchant scope. - POST
/api/app/audit-log-continuation/{id}/try-ensure-entity-accessdeprecated admin Requires: AuditLogging.AuditLogs, merchant scope.
Customers & Contracts
Contract Plans
Reusable plans that recurring contracts subscribe to for their price.
- GET
/api/contract-plansdeprecated admin Get a list of ContractPlans Requires: Customers.ContractPlans, merchant scope. - POST
/api/contract-plansdeprecated admin Create a ContractPlan Requires: Customers.ContractPlans, Customers.ContractPlans.Create, merchant scope. - POST
/api/contract-plans/list/continuationdeprecated admin Retrieves a continuation-based page of ContractPlans. Requires: Customers.ContractPlans, merchant scope. - POST
/api/contract-plans/list/continuation/countdeprecated admin Counts the ContractPlans that match a filter. Requires: Customers.ContractPlans, merchant scope. - POST
/api/contract-plans/list/continuation/summary-countsdeprecated admin Counts ContractPlans for several filters at once. Requires: Customers.ContractPlans, merchant scope. - GET
/api/contract-plans/lookupdeprecated admin Lists the active plans the caller may subscribe a contract to, with today's price on each. Requires: Customers.ContractPlans, merchant scope. - DELETE
/api/contract-plans/{id}deprecated admin Delete a ContractPlan Requires: Customers.ContractPlans, Customers.ContractPlans.Delete, merchant scope. - GET
/api/contract-plans/{id}deprecated admin Get a ContractPlan Requires: Customers.ContractPlans, merchant scope. - PUT
/api/contract-plans/{id}deprecated admin Update a ContractPlan Requires: Customers.ContractPlans, Customers.ContractPlans.Update, merchant scope. - GET
/api/contract-plans/{id}/accessdeprecated admin Check ContractPlan access Requires: Customers.ContractPlans, merchant scope. - GET
/api/contract-plans/{id}/namedeprecated admin Get a ContractPlan name by id Requires: Customers.ContractPlans, merchant scope. - POST
/api/contract-plans/{id}/pricesdeprecated admin Records a new price on a plan and states when it starts applying to existing subscribers. Requires: Customers.ContractPlans, Customers.ContractPlans.ChangePrice, merchant scope. - POST
/api/contract-plans/{id}/restoredeprecated admin Restore a deleted ContractPlan Requires: Customers.ContractPlans, Customers.ContractPlans.Delete, merchant scope.
Customers & Contracts
Contracts
Customer contract and billing agreement management.
- GET
/api/contractsdeprecated admin List contracts Requires: Customers.Contracts, merchant scope. - POST
/api/contractsdeprecated admin Create contract Requires: Customers.Contracts, Customers.Contracts.Create, merchant scope. - POST
/api/contracts/list/continuationdeprecated admin Retrieves a continuation-based page of Contracts. Requires: Customers.Contracts, merchant scope. - POST
/api/contracts/list/continuation/countdeprecated admin Counts the Contracts that match a filter. Requires: Customers.Contracts, merchant scope. - POST
/api/contracts/list/continuation/summary-countsdeprecated admin Counts Contracts for several filters at once. Requires: Customers.Contracts, merchant scope. - DELETE
/api/contracts/{id}deprecated admin Delete contract Requires: Customers.Contracts, Customers.Contracts.Delete, merchant scope. - GET
/api/contracts/{id}deprecated admin Get contract by ID Requires: Customers.Contracts, merchant scope. - PUT
/api/contracts/{id}deprecated admin Update contract Requires: Customers.Contracts, Customers.Contracts.Update, merchant scope. - GET
/api/contracts/{id}/accessdeprecated admin Check contract access Requires: Customers.Contracts, merchant scope. - GET
/api/contracts/{id}/namedeprecated admin Get contract name Requires: Customers.Contracts, merchant scope. - POST
/api/contracts/{id}/pausedeprecated admin Pauses an active contract. Requires: Customers.Contracts, Customers.Contracts.Update, merchant scope. - POST
/api/contracts/{id}/restoredeprecated admin Restore deleted contract Requires: Customers.Contracts, Customers.Contracts.Delete, merchant scope. - POST
/api/contracts/{id}/resumedeprecated admin Resumes a paused contract. Requires: Customers.Contracts, Customers.Contracts.Update, merchant scope.
Identity & Access
Developer Portal
Back-office management of Developer Portal access: the accounts that grant it and the invitations that offer it. Every operation is scoped to the acting merchant.
- POST
/api/developer-portal/accountsdeprecated admin Create a DeveloperAccount Requires: DeveloperPortal.Accounts, DeveloperPortal.Accounts.Create, merchant scope. - GET
/api/developer-portal/accounts/assignable-usersdeprecated admin Lists the users who can be granted portal access for the current merchant. Requires: DeveloperPortal.Accounts, DeveloperPortal.Accounts.Create, merchant scope. - POST
/api/developer-portal/accounts/list/continuationdeprecated admin Retrieves a continuation-based page of DeveloperAccounts. Requires: DeveloperPortal.Accounts, merchant scope. - POST
/api/developer-portal/accounts/list/continuation/countdeprecated admin Counts the DeveloperAccounts that match a filter. Requires: DeveloperPortal.Accounts, merchant scope. - POST
/api/developer-portal/accounts/list/continuation/summary-countsdeprecated admin Counts DeveloperAccounts for several filters at once. Requires: DeveloperPortal.Accounts, merchant scope. - DELETE
/api/developer-portal/accounts/{id}deprecated admin Delete a DeveloperAccount Requires: DeveloperPortal.Accounts, DeveloperPortal.Accounts.Delete, merchant scope. - GET
/api/developer-portal/accounts/{id}deprecated admin Get a DeveloperAccount Requires: DeveloperPortal.Accounts, merchant scope. - PUT
/api/developer-portal/accounts/{id}deprecated admin Update a DeveloperAccount Requires: DeveloperPortal.Accounts, DeveloperPortal.Accounts.Update, merchant scope. - GET
/api/developer-portal/accounts/{id}/accessdeprecated admin Check DeveloperAccount access Requires: DeveloperPortal.Accounts, merchant scope. - GET
/api/developer-portal/accounts/{id}/namedeprecated admin Get a DeveloperAccount name by id Requires: DeveloperPortal.Accounts, merchant scope. - POST
/api/developer-portal/accounts/{id}/restoredeprecated admin Restore a deleted DeveloperAccount Requires: DeveloperPortal.Accounts, DeveloperPortal.Accounts.Create, merchant scope. - POST
/api/developer-portal/invitationsdeprecated admin Issues an invitation and emails its redemption link to the invited party. Requires: DeveloperPortal.Invitations, DeveloperPortal.Invitations.Create, merchant scope. - GET
/api/developer-portal/invitations/invitable-usersdeprecated admin Lists the users the caller may invite for the acting merchant. Requires: DeveloperPortal.Invitations, DeveloperPortal.Invitations.Create, merchant scope. - POST
/api/developer-portal/invitations/list/continuationdeprecated admin Retrieves a continuation-based page of the acting merchant's invitations. Requires: DeveloperPortal.Invitations, merchant scope. - POST
/api/developer-portal/invitations/list/continuation/countdeprecated admin Counts the invitations that match a filter. Requires: DeveloperPortal.Invitations, merchant scope. - POST
/api/developer-portal/invitations/list/continuation/summary-countsdeprecated admin Counts invitations for several filters at once. Requires: DeveloperPortal.Invitations, merchant scope. - GET
/api/developer-portal/invitations/{id}deprecated admin Reads one of the acting merchant's invitations. Requires: DeveloperPortal.Invitations, merchant scope. - POST
/api/developer-portal/invitations/{id}/revokedeprecated admin Withdraws a pending invitation, so its link stops working. Requires: DeveloperPortal.Invitations, DeveloperPortal.Invitations.Delete, merchant scope.
Reporting & Operations
Health Checks
Platform health: the overall status, and the state of the individual components behind it.
- GET
/api/healthdeprecated admin Returns overall health status. No permission required. - GET
/api/health/category/{category}deprecated admin Returns health checks for a specific category. Requires: HealthChecks.HealthChecks, merchant scope. - GET
/api/health/components/{name}deprecated admin Returns health status for a specific component by name. Requires: HealthChecks.HealthChecks, merchant scope. - GET
/api/health/groupsdeprecated admin Returns health checks grouped by category with per-group aggregate status. Requires: HealthChecks.HealthChecks, merchant scope.
Messaging & Notifications
Inbound Sms Message
Operator access to the inbound SMS log: what recipients replied, and honoring a free-text opt-out that no automated keyword rule interprets.
Billing & Invoicing
Invoicing
Invoice generation, tracking, and payment reconciliation.
- GET
/api/invoicing/exports/invoices/csvdeprecated admin Invoices: Exports the filtered invoice list as CSV. Requires: Invoicing.Invoices, merchant scope. - GET
/api/invoicing/exports/invoices/exceldeprecated admin Invoices: Exports the filtered invoice list as an Excel workbook. Requires: Invoicing.Invoices, merchant scope. - GET
/api/invoicing/invoicesdeprecated admin Invoices: Retrieves a continuation-token paged, filtered list of invoices. Requires: Invoicing.Invoices, merchant scope. - POST
/api/invoicing/invoicesdeprecated admin Invoices: Creates a new draft invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.Create, merchant scope. - POST
/api/invoicing/invoices/tax-rate-lookupdeprecated admin Invoices: Looks up a line's sales-tax rate from the merchant biller's tax provider. Requires: Invoicing.Invoices, merchant scope. - DELETE
/api/invoicing/invoices/{id}deprecated admin Invoices: Deletes a draft invoice by id. Requires: Invoicing.Invoices, Invoicing.Invoices.Delete, merchant scope. - GET
/api/invoicing/invoices/{id}deprecated admin Invoices: Retrieves a single invoice by id. Requires: Invoicing.Invoices, merchant scope. - PUT
/api/invoicing/invoices/{id}deprecated admin Invoices: Updates an existing draft invoice by id. Requires: Invoicing.Invoices, Invoicing.Invoices.Update, merchant scope. - POST
/api/invoicing/invoices/{id}/canceldeprecated admin Invoices: Cancels a draft invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.Cancel, merchant scope. - POST
/api/invoicing/invoices/{id}/clonedeprecated admin Invoices: Clones an existing invoice as a new draft. Requires: Invoicing.Invoices, Invoicing.Invoices.Create, merchant scope. - POST
/api/invoicing/invoices/{id}/closedeprecated admin Invoices: Closes an invoice (write-off). Requires: Invoicing.Invoices, Invoicing.Invoices.Close, merchant scope. - POST
/api/invoicing/invoices/{id}/issuedeprecated admin 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 admin 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 admin Invoices: Marks an invoice as viewed by the recipient. Requires: Invoicing.Invoices, merchant scope. - POST
/api/invoicing/invoices/{id}/notesdeprecated admin Invoices: Appends an internal note to an invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.Update, merchant scope. - GET
/api/invoicing/invoices/{id}/payment-linkdeprecated admin Invoices: Reads the invoice's pay-by-link state. Requires: Invoicing.Invoices, merchant scope. - POST
/api/invoicing/invoices/{id}/payment-link/reissuedeprecated admin Invoices: Reissues the payment link without emailing the recipient. Requires: Invoicing.Invoices, Invoicing.Invoices.Send, merchant scope. - GET
/api/invoicing/invoices/{id}/pdfdeprecated admin Invoices: Downloads an invoice's PDF document. Requires: Invoicing.Invoices, merchant scope. - GET
/api/invoicing/invoices/{id}/pdf/metadatadeprecated admin Invoices: Retrieves the metadata of an invoice's PDF document. Requires: Invoicing.Invoices, merchant scope. - POST
/api/invoicing/invoices/{id}/record-paymentdeprecated admin Invoices: Records an offline or manual payment against an invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.RecordPayment, merchant scope. - POST
/api/invoicing/invoices/{id}/refunddeprecated admin Invoices: Refunds the payments collected against an invoice. Requires: Invoicing.Invoices, Invoicing.Invoices.Refund, merchant scope. - POST
/api/invoicing/invoices/{id}/senddeprecated admin Invoices: Runs the full send workflow. Requires: Invoicing.Invoices, Invoicing.Invoices.Send, merchant scope. - GET
/api/invoicing/credit-notesdeprecated admin Credit Notes: Retrieves a paged list of credit notes. Requires: Invoicing.CreditNotes, merchant scope. - POST
/api/invoicing/credit-notesdeprecated admin Credit Notes: Creates a new credit note. Requires: Invoicing.CreditNotes, Invoicing.CreditNotes.Create, merchant scope. - DELETE
/api/invoicing/credit-notes/{id}deprecated admin Credit Notes: Deletes a credit note by id. Requires: Invoicing.CreditNotes, Invoicing.CreditNotes.Delete, merchant scope. - GET
/api/invoicing/credit-notes/{id}deprecated admin Credit Notes: Retrieves a single credit note by id. Requires: Invoicing.CreditNotes, merchant scope. - PUT
/api/invoicing/credit-notes/{id}deprecated admin Credit Notes: Updates an existing credit note by id. Requires: Invoicing.CreditNotes, Invoicing.CreditNotes.Update, merchant scope. - GET
/api/invoicing/custom-field-definitionsdeprecated admin Custom Field Definitions: Retrieves a paged list of invoice custom field definitions. Requires: Invoicing.CustomFieldDefinitions, merchant scope. - POST
/api/invoicing/custom-field-definitionsdeprecated admin 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 admin 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 admin 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 admin Custom Field Definitions: Updates an existing invoice custom field definition by id. Requires: Invoicing.CustomFieldDefinitions, Invoicing.CustomFieldDefinitions.Update, merchant scope. - GET
/api/invoicing/invoices/{id}/payment-plandeprecated admin Payment Plan: Returns the invoice's payment plan. Requires: Invoicing.Invoices, merchant scope. - POST
/api/invoicing/invoices/{id}/payment-plandeprecated admin Payment Plan: Sets up a plan against the outstanding balance. Requires: Invoicing.Invoices, Invoicing.Invoices.PaymentPlan, merchant scope. - POST
/api/invoicing/invoices/{id}/payment-plan/canceldeprecated admin Payment Plan: Cancels the active payment plan. Requires: Invoicing.Invoices, Invoicing.Invoices.PaymentPlan, merchant scope. - POST
/api/invoicing/invoices/{id}/payment-plan/pay-installmentdeprecated admin Payment Plan: Records a manual payment for one pending installment. Requires: Invoicing.Invoices, Invoicing.Invoices.PaymentPlan, merchant scope. - GET
/api/invoicing/productsdeprecated admin Products: Retrieves a skip/take paged list of invoice products. Deprecated. Requires: Invoicing.Products, merchant scope. - POST
/api/invoicing/productsdeprecated admin Products: Creates a new invoice product. Requires: Invoicing.Products, Invoicing.Products.Create, merchant scope. - GET
/api/invoicing/products/continuation-listdeprecated admin Products: Retrieves a continuation-token paged, filtered list of invoice products. Requires: Invoicing.Products, merchant scope. - DELETE
/api/invoicing/products/{id}deprecated admin Products: Deletes an invoice product by id. Requires: Invoicing.Products, Invoicing.Products.Delete, merchant scope. - GET
/api/invoicing/products/{id}deprecated admin Products: Retrieves a single invoice product by id. Requires: Invoicing.Products, merchant scope. - PUT
/api/invoicing/products/{id}deprecated admin Products: Updates an existing invoice product by id. Requires: Invoicing.Products, Invoicing.Products.Update, merchant scope. - GET
/api/invoicing/public/invoice/{invoiceId}deprecated admin Public: Retrieves an invoice for public viewing using a view token. No permission required. - GET
/api/invoicing/public/invoice/{invoiceId}/pdfdeprecated admin Public: Downloads an invoice's PDF document using a view token. No permission required. - GET
/api/invoicing/recurring-schedulesdeprecated admin Recurring schedules: Retrieves a filtered list of recurring invoice schedules. Requires: Invoicing.RecurringSchedules, merchant scope. - POST
/api/invoicing/recurring-schedulesdeprecated admin Recurring schedules: Creates a new recurring invoice schedule. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Create, merchant scope. - DELETE
/api/invoicing/recurring-schedules/{id}deprecated admin Recurring schedules: Deletes a recurring invoice schedule by id. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Delete, merchant scope. - GET
/api/invoicing/recurring-schedules/{id}deprecated admin Recurring schedules: Retrieves a single recurring invoice schedule by id. Requires: Invoicing.RecurringSchedules, merchant scope. - PUT
/api/invoicing/recurring-schedules/{id}deprecated admin 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 admin Recurring schedules: Cancels a series permanently. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Cancel, merchant scope. - POST
/api/invoicing/recurring-schedules/{id}/generate-nowdeprecated admin Recurring schedules: Generates the currently due invoice immediately. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.GenerateNow, merchant scope. - POST
/api/invoicing/recurring-schedules/{id}/pausedeprecated admin Recurring schedules: Pauses an active series. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Pause, merchant scope. - POST
/api/invoicing/recurring-schedules/{id}/resumedeprecated admin Recurring schedules: Resumes a paused series. Requires: Invoicing.RecurringSchedules, Invoicing.RecurringSchedules.Resume, merchant scope. - GET
/api/invoicing/reports/agingdeprecated admin Reports: Retrieves the accounts-receivable aging report. Requires: Invoicing.Reports, merchant scope. - GET
/api/invoicing/reports/aging/export/csvdeprecated admin Reports: Exports the accounts-receivable aging report as CSV. Requires: Invoicing.Reports, Invoicing.Reports.Export, merchant scope. - GET
/api/invoicing/reports/aging/export/exceldeprecated admin Reports: Exports the accounts-receivable aging report as an Excel workbook. Requires: Invoicing.Reports, Invoicing.Reports.Export, merchant scope. - GET
/api/invoicing/tax-ratesdeprecated admin Tax Rates: Retrieves a paged list of invoice tax rates. Requires: Invoicing.TaxRates, merchant scope. - POST
/api/invoicing/tax-ratesdeprecated admin Tax Rates: Creates a new invoice tax rate. Requires: Invoicing.TaxRates, Invoicing.TaxRates.Create, merchant scope. - DELETE
/api/invoicing/tax-rates/{id}deprecated admin Tax Rates: Deletes an invoice tax rate by id. Requires: Invoicing.TaxRates, Invoicing.TaxRates.Delete, merchant scope. - GET
/api/invoicing/tax-rates/{id}deprecated admin Tax Rates: Retrieves a single invoice tax rate by id. Requires: Invoicing.TaxRates, merchant scope. - PUT
/api/invoicing/tax-rates/{id}deprecated admin Tax Rates: Updates an existing invoice tax rate by id. Requires: Invoicing.TaxRates, Invoicing.TaxRates.Update, merchant scope. - GET
/api/invoicing/templatesdeprecated admin Templates: Retrieves a paged list of invoice templates. Requires: Invoicing.Templates, merchant scope. - POST
/api/invoicing/templatesdeprecated admin Templates: Creates a new invoice template. Requires: Invoicing.Templates, Invoicing.Templates.Create, merchant scope. - DELETE
/api/invoicing/templates/{id}deprecated admin Templates: Deletes an invoice template by id. Requires: Invoicing.Templates, Invoicing.Templates.Delete, merchant scope. - GET
/api/invoicing/templates/{id}deprecated admin Templates: Retrieves a single invoice template by id. Requires: Invoicing.Templates, merchant scope. - PUT
/api/invoicing/templates/{id}deprecated admin Templates: Updates an existing invoice template by id. Requires: Invoicing.Templates, Invoicing.Templates.Update, merchant scope.
Identity & Access
Login
Interactive sign-in and sign-out: password authentication, external login linking, and the password re-check a sensitive operation asks for.
Billing & Invoicing
Merchant Billing
Reseller-to-merchant billing: billing runs and history, plan-scoped reporting, and the stored payment method used to draft recurring charges.
- GET
/api/billing-runsdeprecated admin Billing Runs: Lists billing runs in the caller's reseller scope. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runsdeprecated admin 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 admin Billing Runs: Gets the active all-resellers batch, or the most recent batch. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runs/batch/cleardeprecated admin Billing Runs: Force-clears the current all-resellers fan-out batch. Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Manage, merchant scope. - GET
/api/billing-runs/environment-coveragedeprecated admin Billing Runs: Counts the merchants a run bills that their plan does not price. Requires: MerchantBilling.BillingRuns, merchant scope. - GET
/api/billing-runs/merchant-historydeprecated admin 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 admin Billing Runs: Gets the plan-scoped historic billing report. Requires: MerchantBilling.BillingRuns, MerchantBilling.Reports, merchant scope. - GET
/api/billing-runs/price-plan-history/exportdeprecated admin Billing Runs: Exports the plan-scoped historic billing report as a file. Requires: MerchantBilling.BillingRuns, MerchantBilling.Reports, merchant scope. - GET
/api/billing-runs/target-resellersdeprecated admin Billing Runs: Lists the resellers the caller can run billing for. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runs/trigger-all-resellersdeprecated admin 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 admin Billing Runs: Gets a single billing run by its identifier. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runs/{id}/canceldeprecated admin Billing Runs: Cancels a pending or running billing run. Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant scope. - GET
/api/billing-runs/{id}/exportdeprecated admin Billing Runs: Exports a billing run's merchant results and line items as a file. Requires: MerchantBilling.BillingRuns, merchant scope. - POST
/api/billing-runs/{id}/results/{resultId}/retry-chargedeprecated admin Billing Runs: Retries a failed recurring charge on a billing run. Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Retry, merchant scope. - GET
/api/merchants/{id}/billing/payment-methoddeprecated admin Payment Methods: Gets the merchant's active stored payment method. Requires: MerchantBilling.PaymentMethods, merchant scope. - POST
/api/merchants/{id}/billing/payment-method/capture-link/canceldeprecated admin Payment Methods: Cancels (revokes) the outstanding capture link for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - POST
/api/merchants/{id}/billing/payment-method/capture-link/resenddeprecated admin Payment Methods: Resends the outstanding capture link for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - POST
/api/merchants/{id}/billing/payment-method/capture-link/senddeprecated admin Payment Methods: Emails the merchant a capture link. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - GET
/api/merchants/{id}/billing/payment-method/capture-link/statusdeprecated admin Payment Methods: Gets the status of the outstanding capture link for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - GET
/api/merchants/{id}/billing/payment-method/capture-readinessdeprecated admin Payment Methods: Reports whether capture is configured. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - POST
/api/merchants/{id}/billing/payment-method/deactivatedeprecated admin Payment Methods: Soft-deactivates the active stored payment method for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope. - GET
/api/merchants/{id}/billing/payment-method/historydeprecated admin Payment Methods: Gets the merchant's stored-method history. Requires: MerchantBilling.PaymentMethods, merchant scope. - POST
/api/merchants/{id}/billing/payment-method/{paymentMethodId}/activatedeprecated admin Payment Methods: Re-activates a stored-but-inactive payment method for the merchant. Requires: MerchantBilling.PaymentMethods, MerchantBilling.PaymentMethods.Manage, merchant scope.
Merchants & Resellers
Merchant Payment Encryption Binding
Read or change one merchant's payment encryption provider bindings, and the key serial identifier entries under them, without sending the whole merchant document back.
- GET
/api/merchants/{id}/payment-encryption-bindingsdeprecated admin Payment encryption: lists the merchant's provider bindings. No permission required. - DELETE
/api/merchants/{id}/payment-encryption-bindings/{providerName}deprecated admin Payment encryption: unbinds one provider. Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/payment-encryption-bindings/{providerName}deprecated admin Payment encryption: gets the merchant's binding for one provider. Requires: Merchants.Merchants, merchant scope. - PUT
/api/merchants/{id}/payment-encryption-bindings/{providerName}deprecated admin Payment encryption: creates or replaces the merchant's binding for one provider. Requires: Merchants.Merchants.Update, merchant scope. - DELETE
/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}deprecated admin Payment encryption: removes one key entry. Requires: Merchants.Merchants.Update, merchant scope. - PUT
/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}deprecated admin Payment encryption: adds or replaces one key entry. Requires: Merchants.Merchants.Update, merchant scope. - POST
/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}/deactivatedeprecated admin Payment encryption: retires one key entry. Requires: Merchants.Merchants.Update, merchant scope. - POST
/api/merchants/{id}/payment-encryption-bindings/{providerName}/keys/{ksi}/reactivatedeprecated admin Payment encryption: returns one retired key entry to service. Requires: Merchants.Merchants.Update, merchant scope. - POST
/api/merchants/{id}/payment-encryption-bindings/{providerName}/test-connectiondeprecated admin Payment encryption: tests the connection to the bound provider. Requires: Merchants.Merchants.Update, merchant scope.
Merchants & Resellers
Merchants
Merchant onboarding, configuration, processing settings, and lifecycle management.
- GET
/api/merchantsdeprecated admin List merchants No permission required. - POST
/api/merchantsdeprecated admin Create merchant Requires: Merchants.Merchants.Create, merchant scope. - GET
/api/merchants/assignable-for-price-plandeprecated admin Lists the merchants that can be assigned to a price plan. Requires: Merchants.Merchants, merchant scope. - GET
/api/merchants/by-price-plandeprecated admin Lists the merchants currently assigned to a price plan. Requires: Merchants.Merchants, merchant scope. - POST
/api/merchants/get-default-merchant-user-asyncdeprecated admin Gets the default user account associated with the specified merchant. Requires: Merchants.Merchants, merchant scope. - POST
/api/merchants/get-merchant-users-asyncdeprecated admin Lists the active users of a merchant, with their email addresses. No permission required. - POST
/api/merchants/list/continuationdeprecated admin Retrieves a continuation-based page of merchants. No permission required. - POST
/api/merchants/list/continuation/countdeprecated admin Counts the Merchants that match a filter. No permission required. - POST
/api/merchants/list/continuation/summary-countsdeprecated admin Counts Merchants for several filters at once. No permission required. - GET
/api/merchants/reseller-scopedeprecated admin Lists the active merchants under the calling reseller and every reseller beneath it. Requires: Merchants.Merchants, merchant scope. - GET
/api/merchants/self/custom-fieldsdeprecated admin Get custom field definitions for the signed-in user's merchant Requires: Merchants.SelfServiceSettings, merchant scope. - PUT
/api/merchants/self/custom-fieldsdeprecated admin Update custom field definitions for the signed-in user's merchant Requires: Merchants.SelfServiceSettings.Manage, merchant scope. - GET
/api/merchants/self/order-data-defaultsdeprecated admin Get order data defaults for the signed-in user's merchant Requires: Merchants.SelfServiceSettings, merchant scope. - PUT
/api/merchants/self/order-data-defaultsdeprecated admin Update order data defaults for the signed-in user's merchant Requires: Merchants.SelfServiceSettings.Manage, merchant scope. - POST
/api/merchants/validate-processor-profile-deactivation-asyncdeprecated admin Reports whether a processor profile can be deactivated. No permission required. - DELETE
/api/merchants/{id}deprecated admin Delete merchant Requires: Merchants.Merchants.Delete, merchant scope. - GET
/api/merchants/{id}deprecated admin Get merchant by ID No permission required. - PUT
/api/merchants/{id}deprecated admin Update merchant Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/accessdeprecated admin Check merchant access No permission required. - POST
/api/merchants/{id}/assign-price-plan/{pricePlanId}deprecated admin Assigns a merchant to a price plan. Requires: MerchantBilling.PricePlans.Assign, merchant scope. - GET
/api/merchants/{id}/custom-fieldsdeprecated admin Reads one merchant's custom field definitions. No permission required. - POST
/api/merchants/{id}/lockdeprecated admin Locks the specified merchant, preventing modifications and deletions until unlocked. Requires: Merchants.Merchants.Lock, merchant scope. - GET
/api/merchants/{id}/namedeprecated admin Get merchant name No permission required. - POST
/api/merchants/{id}/promotedeprecated admin Promotes the specified merchant to the Production environment. Requires: Merchants.Merchants.ManageEnvironment, merchant scope. - GET
/api/merchants/{id}/registersdeprecated admin Get merchant registers No permission required. - POST
/api/merchants/{id}/restoredeprecated admin Restore deleted merchant Requires: Merchants.Merchants.Delete, merchant scope. - POST
/api/merchants/{id}/trial/extenddeprecated admin Extends the specified merchant's trial. Requires: Merchants.Merchants.ExtendTrial, merchant scope. - POST
/api/merchants/{id}/unassign-price-plandeprecated admin Clears a merchant's price-plan assignment. Requires: MerchantBilling.PricePlans.Assign, merchant scope. - POST
/api/merchants/{id}/unlockdeprecated admin Unlocks the specified merchant, allowing modifications and deletions again. Requires: Merchants.Merchants.Unlock, merchant scope. - GET
/api/merchants/{id}/processor-capabilitiesdeprecated admin Processor Capability: lists what each of the merchant's active processor profiles can do. No permission required. - GET
/api/merchants/{id}/processor-profilesdeprecated admin Processor Profile: lists the merchant's processor profiles. Requires: Merchants.Merchants, merchant scope. - POST
/api/merchants/{id}/processor-profilesdeprecated admin Processor Profile: adds a new processor profile to the merchant. Requires: Merchants.Merchants.Update, merchant scope. - DELETE
/api/merchants/{id}/processor-profiles/{profileId}deprecated admin Processor Profile: removes a processor profile from the merchant. Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/processor-profiles/{profileId}deprecated admin Processor Profile: gets a single processor profile by id. Requires: Merchants.Merchants, merchant scope. - PUT
/api/merchants/{id}/processor-profiles/{profileId}deprecated admin Processor Profile: replaces an existing processor profile. Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/processor-profiles/{profileId}/summarydeprecated admin Processor Profile: gets a read-only, non-secret summary of a single processor profile. Requires: Transactions.ProcessorConfiguration.View, merchant scope. - GET
/api/merchants/registers/by-legacy-number/{legacyNumber}deprecated admin Register: resolves a register by its legacy numeric key within the caller's own merchant. Requires: Merchants.SelfServiceSettings, merchant scope. - POST
/api/merchants/{id}/registersdeprecated admin Register: creates or replaces a single register on the merchant. Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/screening-provider-profilesdeprecated admin Screening Provider: lists the merchant's screening provider profiles. No permission required. - POST
/api/merchants/{id}/screening-provider-profilesdeprecated admin Screening Provider: adds a screening provider profile to the merchant. Requires: Merchants.Merchants.Create, merchant scope. - DELETE
/api/merchants/{id}/screening-provider-profiles/{profileId}deprecated admin Screening Provider: removes a screening provider profile from the merchant. Requires: Merchants.Merchants.Delete, merchant scope. - GET
/api/merchants/{id}/screening-provider-profiles/{profileId}deprecated admin Screening Provider: gets a single screening provider profile by id. No permission required. - PUT
/api/merchants/{id}/screening-provider-profiles/{profileId}deprecated admin Screening Provider: Replaces an existing profile. Requires: Merchants.Merchants.Update, merchant scope.
Merchants & Resellers
Merchant Shipping Binding
Read or change one merchant's shipping rate provider bindings without sending the whole merchant document back.
- GET
/api/merchants/{id}/shipping-bindingsdeprecated admin Shipping: lists the merchant's provider bindings. No permission required. - DELETE
/api/merchants/{id}/shipping-bindings/{providerName}deprecated admin Shipping: removes the merchant's binding for one provider, with any stored credentials. Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/shipping-bindings/{providerName}deprecated admin Shipping: gets the merchant's binding for one provider. Requires: Merchants.Merchants, merchant scope. - PUT
/api/merchants/{id}/shipping-bindings/{providerName}deprecated admin Shipping: creates or replaces the merchant's binding for one provider. Requires: Merchants.Merchants.Update, merchant scope. - POST
/api/merchants/{id}/shipping-bindings/{providerName}/test-connectiondeprecated admin Shipping: probes the merchant's bound provider and reports whether it answered. Requires: Merchants.Merchants.Update, merchant scope.
Merchants & Resellers
Merchant Tax Binding
Read or change one merchant's tax provider bindings without sending the whole merchant document back.
- GET
/api/merchants/{id}/tax-bindingsdeprecated admin Tax: lists the merchant's provider bindings. No permission required. - DELETE
/api/merchants/{id}/tax-bindings/{providerName}deprecated admin Tax: removes the merchant's binding for one provider, with any stored credentials. Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/tax-bindings/{providerName}deprecated admin Tax: gets the merchant's binding for one provider. Requires: Merchants.Merchants, merchant scope. - PUT
/api/merchants/{id}/tax-bindings/{providerName}deprecated admin Tax: creates or replaces the merchant's binding for one provider. Requires: Merchants.Merchants.Update, merchant scope. - POST
/api/merchants/{id}/tax-bindings/{providerName}/test-connectiondeprecated admin Tax: probes the merchant's bound provider and reports whether it answered. Requires: Merchants.Merchants.Update, merchant scope.
Merchants & Resellers
Merchant Three DS Binding
Read or change one merchant's 3-D Secure bindings without sending the whole merchant document back.
- GET
/api/merchants/{id}/three-d-secure-bindingsdeprecated admin 3-D Secure: lists the merchant's provider bindings. No permission required. - DELETE
/api/merchants/{id}/three-d-secure-bindings/{providerType}deprecated admin 3-D Secure: removes the merchant's binding for one provider, with its stored credentials. Requires: Merchants.Merchants.Update, merchant scope. - GET
/api/merchants/{id}/three-d-secure-bindings/{providerType}deprecated admin 3-D Secure: gets the merchant's binding for one provider. Requires: Merchants.Merchants, merchant scope. - PUT
/api/merchants/{id}/three-d-secure-bindings/{providerType}deprecated admin 3-D Secure: creates or replaces the merchant's binding for one provider. Requires: Merchants.Merchants.Update, merchant scope. - POST
/api/merchants/{id}/three-d-secure-bindings/{providerType}/test-connectiondeprecated admin 3-D Secure: probes the merchant's provider account and reports whether it answered. Requires: Merchants.Merchants.Update, merchant scope.
Messaging & Notifications
Messaging
Delivery records for the email and SMS the platform sends on a merchant's behalf, plus the SMS consent register that decides who may be texted.
- GET
/api/twilio/email-logdeprecated admin Email Log: lists 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 admin Email Log: gets the full event history for one outbound message by its correlation id. Requires: Twilio.EmailLog.View, merchant scope. - GET
/api/twilio/email-log/{id}deprecated admin Email Log: gets a single row by its id. Requires: Twilio.EmailLog.View, merchant scope. - GET
/api/twilio/sms-consentdeprecated admin SMS Consent: lists consent records for the caller's scope. Requires: Twilio.SmsConsent.View, merchant scope. - POST
/api/twilio/sms-consentdeprecated admin SMS Consent: 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 admin SMS Consent: checks whether SMS may be sent to a number in the caller's merchant scope. Requires: Twilio.SmsConsent.View, merchant scope. - GET
/api/twilio/sms-logdeprecated admin SMS Log: lists outbound SMS delivery records for the caller's scope. Requires: Twilio.SmsLog.View, merchant scope. - GET
/api/twilio/sms-log/by-correlation/{correlationId}deprecated admin SMS Log: gets the delivery record for one outbound message by its correlation id. Requires: Twilio.SmsLog.View, merchant scope.
Identity & Access
My Session
Self-service listing and revocation of the signed-in user's own active login sessions.
- GET
/api/app/my-session/approximate-total-countdeprecated admin Counts the entities matching `input`. No permission required. - GET
/api/app/my-session/continuation-listdeprecated admin No permission required. - GET
/api/app/my-session/summary-countsdeprecated admin No permission required. - POST
/api/app/my-session/{id}/ensure-entity-accessdeprecated admin No permission required. - POST
/api/app/my-session/{id}/revokedeprecated admin No permission required. - POST
/api/app/my-session/{id}/try-ensure-entity-accessdeprecated admin No permission required.
Platform Configuration
Processor Metadata
Read-only discovery API that exposes the configuration shape each payment processor requires.
- GET
/api/processorsdeprecated admin Lists every supported processor. Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope. - GET
/api/processors/{processorId}/config-schemadeprecated admin Returns the configuration field schema for one processor. Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope. - GET
/api/processors/{processorId}/config-schema/templatedeprecated admin Returns a ready-to-fill processor profile skeleton. Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope. - POST
/api/processors/{processorId}/validate-configdeprecated admin Dry-run validates a processor configuration payload. Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope.
Platform Configuration
Rate Limits
Stored rate limiting configuration: profiles that bind a set of limits to a scope, and the rules within them that cap request rates, concurrency, and accumulated amounts.
- GET
/api/rate-limiting/profilesdeprecated admin Rate Limit Profiles: retrieves a paged list of profiles. Requires: RateLimiting.Profiles, merchant scope. - POST
/api/rate-limiting/profilesdeprecated admin Rate Limit Profiles: creates a profile. Requires: RateLimiting.Profiles, RateLimiting.Profiles.Create, merchant scope. - GET
/api/rate-limiting/profiles/continuationdeprecated admin Rate Limit Profiles: retrieves a continuation-token paged list of profiles. Requires: RateLimiting.Profiles, merchant scope. - GET
/api/rate-limiting/profiles/continuation/countdeprecated admin Rate Limit Profiles: Counts the profiles matching the input. Requires: RateLimiting.Profiles, merchant scope. - DELETE
/api/rate-limiting/profiles/{id}deprecated admin Rate Limit Profiles: deletes a profile by id. Requires: RateLimiting.Profiles, RateLimiting.Profiles.Delete, merchant scope. - GET
/api/rate-limiting/profiles/{id}deprecated admin Rate Limit Profiles: retrieves a single profile by id. Requires: RateLimiting.Profiles, merchant scope. - PUT
/api/rate-limiting/profiles/{id}deprecated admin Rate Limit Profiles: updates a profile by id. Requires: RateLimiting.Profiles, RateLimiting.Profiles.Update, merchant scope. - GET
/api/rate-limiting/profiles/{id}/accessdeprecated admin Rate Limit Profiles: reports whether the caller may access the profile. Requires: RateLimiting.Profiles, merchant scope. - GET
/api/rate-limiting/profiles/{id}/namedeprecated admin Rate Limit Profiles: returns a profile's display name. Requires: RateLimiting.Profiles, merchant scope. - POST
/api/rate-limiting/profiles/{id}/restoredeprecated admin Rate Limit Profiles: restores a previously deleted profile. Requires: RateLimiting.Profiles, RateLimiting.Profiles.Update, merchant scope. - GET
/api/rate-limiting/rulesdeprecated admin Rate Limit Rules: retrieves a paged list of rules. Requires: RateLimiting.Rules, merchant scope. - POST
/api/rate-limiting/rulesdeprecated admin Rate Limit Rules: creates a rule. Requires: RateLimiting.Rules, RateLimiting.Rules.Create, merchant scope. - GET
/api/rate-limiting/rules/continuationdeprecated admin Rate Limit Rules: retrieves a continuation-token paged list of rules. Requires: RateLimiting.Rules, merchant scope. - GET
/api/rate-limiting/rules/continuation/countdeprecated admin Rate Limit Rules: retrieves the approximate total number of rules matching the input. Requires: RateLimiting.Rules, merchant scope. - GET
/api/rate-limiting/rules/limitersdeprecated admin Rate Limit Rules: lists every limiter the running host declares, with its defaults. Requires: RateLimiting.Rules, merchant scope. - GET
/api/rate-limiting/rules/profilesdeprecated admin Rate Limit Rules: lists every profile as a lightweight picker item. Requires: RateLimiting.Rules, merchant scope. - DELETE
/api/rate-limiting/rules/{id}deprecated admin Rate Limit Rules: deletes a rule by id. Requires: RateLimiting.Rules, RateLimiting.Rules.Delete, merchant scope. - GET
/api/rate-limiting/rules/{id}deprecated admin Rate Limit Rules: retrieves a single rule by id. Requires: RateLimiting.Rules, merchant scope. - PUT
/api/rate-limiting/rules/{id}deprecated admin Rate Limit Rules: updates a rule by id. Requires: RateLimiting.Rules, RateLimiting.Rules.Update, merchant scope. - GET
/api/rate-limiting/rules/{id}/accessdeprecated admin Rate Limit Rules: reports whether the caller may access the rule. Requires: RateLimiting.Rules, merchant scope. - GET
/api/rate-limiting/rules/{id}/namedeprecated admin Rate Limit Rules: returns a rule's display name. Requires: RateLimiting.Rules, merchant scope. - POST
/api/rate-limiting/rules/{id}/restoredeprecated admin Rate Limit Rules: restores a previously deleted rule. Requires: RateLimiting.Rules, RateLimiting.Rules.Update, merchant scope.
Billing & Invoicing
Recurring Billing
Recurring billing for customer contracts: triggering a run by hand, and the history of runs already executed.
Merchants & Resellers
Resellers
Reseller partner management, hierarchy, and merchant assignment.
- GET
/api/resellersdeprecated admin List resellers Requires: Resellers.Resellers, reseller scope. - POST
/api/resellersdeprecated admin Create reseller Requires: Resellers.Resellers.Create, reseller scope. - POST
/api/resellers/get-billing-preferences-asyncdeprecated admin Reads a reseller's billing preferences. Requires: Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/get-default-reseller-user-asyncdeprecated admin Gets default reseller user. Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/get-effective-collection-configuration-asyncdeprecated admin Reads a reseller's effective collection configuration. Requires: Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/get-for-billing-self-service-asyncdeprecated admin Reads a reseller in full for the merchant-billing setup flow. Requires: Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/get-own-billing-preferences-asyncdeprecated admin Reads the billing preferences of the calling operator's own reseller. Requires: Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/get-own-effective-collection-configuration-asyncdeprecated admin Reads the calling operator's own effective collection configuration. Requires: Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/list/continuationdeprecated admin Retrieves a continuation-based page of Resellers. Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/list/continuation/countdeprecated admin Counts the Resellers that match a filter. Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/list/continuation/summary-countsdeprecated admin Counts Resellers for several filters at once. Requires: Resellers.Resellers, reseller scope. - POST
/api/resellers/update-billing-preferences-asyncdeprecated admin Replaces a reseller's billing preferences. Requires: Resellers.Resellers.Update, reseller scope. - POST
/api/resellers/update-own-billing-preferences-asyncdeprecated admin Replaces the billing preferences of the calling operator's own reseller. Requires: Resellers.Resellers.Update, reseller scope. - DELETE
/api/resellers/{id}deprecated admin Delete reseller Requires: Resellers.Resellers.Delete, reseller scope. - GET
/api/resellers/{id}deprecated admin Get reseller by ID Requires: Resellers.Resellers, reseller scope. - PUT
/api/resellers/{id}deprecated admin Update reseller Requires: Resellers.Resellers.Update, reseller scope. - GET
/api/resellers/{id}/accessdeprecated admin Check reseller access No permission required. - GET
/api/resellers/{id}/namedeprecated admin Get reseller name No permission required. - POST
/api/resellers/{id}/restoredeprecated admin Restore deleted reseller Requires: Resellers.Resellers, reseller scope.
Identity & Access
Roles
Roles, and the claims attached to them. A role is how a set of permissions is granted to every user assigned it.
- GET
/api/identity/rolesdeprecated admin List roles Requires: AbpIdentity.Roles, host scope. - POST
/api/identity/rolesdeprecated admin Create new role Requires: AbpIdentity.Roles, AbpIdentity.Roles.Create, host scope. - GET
/api/identity/roles/alldeprecated admin Get all roles Requires: AbpIdentity.Roles, host scope. - GET
/api/identity/roles/all-claim-typesdeprecated admin GetAllClaimTypes for Role Requires: AbpIdentity.Roles, host scope. - DELETE
/api/identity/roles/{id}deprecated admin Delete role Requires: AbpIdentity.Roles, AbpIdentity.Roles.Delete, host scope. - GET
/api/identity/roles/{id}deprecated admin Get role by ID Requires: AbpIdentity.Roles, host scope. - PUT
/api/identity/roles/{id}deprecated admin Update role Requires: AbpIdentity.Roles, AbpIdentity.Roles.Update, host scope. - GET
/api/identity/roles/{id}/claimsdeprecated admin GetClaims for Role Requires: AbpIdentity.Roles, host scope. - PUT
/api/identity/roles/{id}/claimsdeprecated admin Update role claims Requires: AbpIdentity.Roles, AbpIdentity.Roles.Update, host scope. - PUT
/api/identity/roles/{id}/move-all-usersdeprecated admin Move all users to role Requires: AbpIdentity.Roles, AbpIdentity.Roles.Update, host scope. - DELETE
/api/identity/roles/{id}/users/{userId}deprecated admin Requires: AbpIdentity.Roles, AbpIdentity.Roles.Update, host scope.
Platform Configuration
Screening Provider Metadata
Read-only discovery API that exposes the configuration shape each external screening provider requires.
- GET
/api/screening-providersdeprecated admin Lists every supported screening provider. Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope. - GET
/api/screening-providers/{providerId}/config-schemadeprecated admin Returns the configuration field schema for a single screening provider. Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope. - GET
/api/screening-providers/{providerId}/config-schema/templatedeprecated admin Returns a ready-to-fill screening provider profile skeleton. Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope. - POST
/api/screening-providers/{providerId}/validate-configdeprecated admin Dry-run validates a screening provider configuration payload. Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope.
Reporting & Operations
Security
Self-service access to the signed-in user's own security log: sign-ins, password changes, and the other identity events recorded against their account.
- GET
/api/app/my-security-log/approximate-total-countdeprecated admin Counts the entities matching `input`. No permission required. - GET
/api/app/my-security-log/continuation-listdeprecated admin No permission required. - GET
/api/app/my-security-log/summary-countsdeprecated admin No permission required. - POST
/api/app/my-security-log/{id}/ensure-entity-accessdeprecated admin No permission required. - POST
/api/app/my-security-log/{id}/try-ensure-entity-accessdeprecated admin No permission required. - GET
/api/security-posture/sbom/buildsdeprecated admin List archived SBOM builds, most-recent-first, with continuation-token paging. Requires: SecurityPosture.Sbom, merchant scope. - GET
/api/security-posture/sbom/builds/{buildId}deprecated admin Return the component manifest for a single build. Requires: SecurityPosture.Sbom, merchant scope. - GET
/api/security-posture/sbom/builds/{buildId}/components/{componentName}deprecated admin Stream the CycloneDX JSON for one component within a build. Each call is audit-logged. Requires: SecurityPosture.Sbom, SecurityPosture.Sbom.Download, merchant scope.
Identity & Access
Security Overview
Reads the security posture of an account, and of a merchant's accounts and API keys, for the security hub.
- GET
/api/app/security-overviewdeprecated admin No permission required. - GET
/api/app/security-overview/for-user/{userId}deprecated admin Requires: AbpIdentity.Users, host scope. - GET
/api/app/security-overview/impersonation-access-historydeprecated admin Requires: AbpIdentity.Users, host scope. - GET
/api/app/security-overview/merchant-posturedeprecated admin Requires: AbpIdentity.Users, host scope. - POST
/api/app/security-overview/revoke-other-sessionsdeprecated admin No permission required.
Payments
Surcharging
Merchant credit-card surcharge configuration and notice filing.
- GET
/api/surcharging/configurations/force-enable/availabledeprecated admin Surcharging: Whether the non-production waiting-period bypass is available in this host. Requires: Surcharging.Admin.ForceEnable, merchant scope. - POST
/api/surcharging/configurations/{merchantId}/force-enabledeprecated admin Surcharging: Activates surcharging without waiting out the mandatory notice period. Requires: Surcharging.Admin.ForceEnable, merchant scope. - PUT
/api/surcharging/configurations/{merchantId}/state-policiesdeprecated admin Surcharging: Replaces a merchant's per-state restriction table (operator action). Requires: Surcharging.Admin.GlobalSettings, merchant scope. - GET
/api/surcharging/configurations/{merchantId}/state-policies/effectivedeprecated admin Surcharging: Returns a merchant's effective per-state surcharge posture. Requires: Surcharging.Admin.GlobalSettings, merchant scope.
Payments
Transactions
Payment transaction processing, search, settlement, and reporting.
- GET
/api/transactions/batch-sequencedeprecated admin 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 admin Override the next batch number for a merchant + processor. Requires: Transactions.Settlement.ManageBatchNumber, merchant scope. - POST
/api/transactions/settlement-overridedeprecated admin Apply a manual settlement-status override to one or more transactions. Requires: Transactions.Settlement.Override, merchant scope. - POST
/api/transactions/settlements/merchants/{merchantId}/triggerdeprecated admin Trigger settlement for a specific merchant. Requires: Transactions.Settlement.Trigger, merchant scope. - GET
/api/transactions/settlements/open-batchesdeprecated admin Returns the merchant's open batch summary. Requires: Transactions.Settlement.View, merchant scope. - GET
/api/transactions/settlements/recent-outcomesdeprecated admin Returns the merchant's final settlement batch outcomes, newest first. Requires: Transactions.Settlement.View, merchant scope. - GET
/api/transactions/settlements/run-statedeprecated admin Returns whether a settlement run you triggered for a merchant has finished. Requires: Transactions.Settlement.View, merchant scope. - POST
/api/transactions/settlements/triggerdeprecated admin Trigger settlement for all eligible merchants. Requires: Transactions.Settlement.Trigger, merchant scope.
Reporting & Operations
Usage
Metered usage reporting: period summaries, the underlying ledger entries, and the SKU definitions they are metered against.
- GET
/api/usage/entitlementsdeprecated admin List entitlements with optional filters using continuation-token paging. Requires: Usage.PlatformDefaults, merchant scope. - POST
/api/usage/entitlementsdeprecated admin Create a new entitlement. No permission required. - GET
/api/usage/entitlements/effectivedeprecated admin Resolves the effective entitlement at a given scope. Requires: Usage.PlatformDefaults, merchant scope. - DELETE
/api/usage/entitlements/{id}deprecated admin Delete an entitlement. No permission required. - GET
/api/usage/entitlements/{id}deprecated admin Get an entitlement by ID. Requires: Usage.PlatformDefaults, merchant scope. - PUT
/api/usage/entitlements/{id}deprecated admin Update an existing entitlement. No permission required.
Identity & Access
User Favorites
Per-user favorites API. All reads/writes are scoped to the operating user (impersonated user when impersonating, current user otherwise).
- DELETE
/api/favorites/userdeprecated admin Remove (unpin) a favorite for the operating user. Requires: Favorites.Manage, merchant scope. - GET
/api/favorites/userdeprecated admin Lists the operating user's favorites. Requires: Favorites.Manage, merchant scope. - POST
/api/favorites/userdeprecated admin Pin an entity as a favorite for the operating user. Requires: Favorites.Manage, merchant scope. - GET
/api/favorites/user/countdeprecated admin Count the operating user's favorites across every entity type. Requires: Favorites.Manage, merchant scope. - GET
/api/favorites/user/idsdeprecated admin List the entity ids the operating user has favorited for a single entity type. Requires: Favorites.Manage, merchant scope.
Identity & Access
Users
Back-office user administration: creating and maintaining users, assigning their roles and organization units, and managing their active sessions.
- GET
/api/account/link-userdeprecated admin GetAllList for User No permission required. - GET
/api/identity/usersdeprecated admin List users Requires: AbpIdentity.Users, host scope. - POST
/api/identity/usersdeprecated admin Create new user Requires: AbpIdentity.Users, AbpIdentity.Users.Create, host scope. - GET
/api/identity/users/all-claim-typesdeprecated admin GetAllClaimTypes for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/approximate-countdeprecated admin Gets the approximate total count of users based on the provided input. Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/assignable-rolesdeprecated admin Get assignable roles Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/available-organization-unitsdeprecated admin GetAvailableOrganizationUnits for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/by-email/{email}deprecated admin Find user by email Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/by-username/{username}deprecated admin Find user by username Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/continuation-listdeprecated admin Retrieves a paged list of users using continuation tokens for efficient pagination. Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/download-tokendeprecated admin GetDownloadToken for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/export-as-csvdeprecated admin GetListAsCsvFile for User No permission required. - GET
/api/identity/users/export-as-exceldeprecated admin GetListAsExcelFile for User No permission required. - GET
/api/identity/users/external-login-Providersdeprecated admin GetExternalLoginProviders for User Requires: AbpIdentity.Users, AbpIdentity.Users.Import, host scope. - POST
/api/identity/users/import-external-userdeprecated admin Import external user Requires: AbpIdentity.Users, AbpIdentity.Users.Import, host scope. - POST
/api/identity/users/import-users-from-filedeprecated admin ImportUsersFromFile for User Requires: AbpIdentity.Users, AbpIdentity.Users.Import, host scope. - GET
/api/identity/users/lookup/organization-unitsdeprecated admin GetOrganizationUnitLookup for User Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/lookup/rolesdeprecated admin GetRoleLookup for User Requires: AbpIdentity.Users, host scope. - DELETE
/api/identity/users/{id}deprecated admin Delete user Requires: AbpIdentity.Users, AbpIdentity.Users.Delete, host scope. - GET
/api/identity/users/{id}deprecated admin Get user by ID Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}deprecated admin Update user Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/identity/users/{id}/accessdeprecated admin Checks if the user has access to the specified entity. Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}/change-passworddeprecated admin UpdatePassword for User Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/identity/users/{id}/claimsdeprecated admin GetClaims for User Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}/claimsdeprecated admin Update user claims Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - PUT
/api/identity/users/{id}/lock/{lockoutEnd}deprecated admin Lock user account Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/identity/users/{id}/namedeprecated admin Gets the display name of a user by ID. Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/{id}/organization-unitsdeprecated admin Get user organization units Requires: AbpIdentity.Users, host scope. - POST
/api/identity/users/{id}/restoredeprecated admin Restores a deleted user by ID. Requires: AbpIdentity.Users, host scope. - GET
/api/identity/users/{id}/rolesdeprecated admin Get user roles Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}/rolesdeprecated admin Update user roles Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/identity/users/{id}/two-factor-enableddeprecated admin GetTwoFactorEnabled for User Requires: AbpIdentity.Users, host scope. - PUT
/api/identity/users/{id}/two-factor/{enabled}deprecated admin SetTwoFactorEnabled for User Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - PUT
/api/identity/users/{id}/unlockdeprecated admin Unlock user account Requires: AbpIdentity.Users, AbpIdentity.Users.Update, host scope. - GET
/api/account/sessionsdeprecated admin List sessions No permission required. - DELETE
/api/account/sessions/{id}deprecated admin Revoke for Sessions No permission required. - GET
/api/account/sessions/{id}deprecated admin Get session No permission required. - POST
/api/identity/sessions/revoke-alldeprecated admin Signs a user out of every session. Requires: AbpIdentity.Sessions, AbpIdentity.Sessions.RevokeAll, host scope.