# User permissions This topic lists all user permissions. To add permissions to users or roles in your team, see [Users](/docs/settings/users). Enter the API operations to grant users or roles access to specific features or functions. To revoke a permission, remove the operation from the list. ## AML - `GetAmlCheckCollection` - Retrieve AML checks - `GetAmlCheck` - Retrieve an AML check - `PostAmlCheckStartReview` - Start review of an AML check - `PostAmlCheckStopReview` - Stop review of an AML check - `PostAmlCheckReview` - Review an AML check - `GetAmlSettings` - Retrieve AML settings - `PutAmlSettings` - Update AML settings ## API keys - `GetApiKeyCollection` - Retrieve API keys - `PostApiKey` - Create an API key - `GetApiKey` - Retrieve API key - `PutApiKey` - Upsert an API key - `DeleteApiKey` - Delete API key ## Allowlists - `GetAllowlistCollection` - Retrieve allowlist collection - `PostAllowlist` - Create allowlist record - `GetAllowlist` - Retrieve allowlist record - `DeleteAllowlist` - Delete allowlist record ## Application owners - `PostApplication` - Register an application - `GetApplicationInstanceCollection` - Retrieve application instances - `GetApplicationInstanceByOrganization` - Retrieve an application instance ## Application users - `GetApplicationInstance` - Retrieve an application instance - `PutApplicationInstance` - Upsert an application instance - `DeleteApplicationInstance` - Delete application instance - `GetApplicationInstanceConfiguration` - Retrieve an application instance configuration - `PutApplicationInstanceConfiguration` - Upsert an application instance configuration - `GetApplicationCollection` - Retrieve applications - `GetApplication` - Retrieve application ## Balance transactions - `GetBalanceTransactionCollection` - Retrieve balance transactions - `GetBalanceTransaction` - Retrieve a balance transaction ## Billing portals - `GetBillingPortalCollection` - Retrieve billing portals - `PostBillingPortal` - Create a billing portal - `GetBillingPortal` - Retrieve a billing portal - `PutBillingPortal` - Upsert a billing portal - `DeleteBillingPortal` - Delete a billing portal ## Blocklists - `GetBlocklistCollection` - Retrieve blocklists - `PostBlocklist` - Create a blocklist - `GetBlocklist` - Retrieve a blocklist - `PutBlocklist` - Create a blocklist with specified ID - `DeleteBlocklist` - Delete a blocklist ## Broadcast messages - `GetBroadcastMessageCollection` - Retrieve broadcast messages - `PostBroadcastMessage` - Create a broadcast message - `GetBroadcastMessage` - Retrieve a broadcast message - `DeleteBroadcastMessage` - Delete a broadcast message - `PatchBroadcastMessage` - Update a broadcast message ## Cashiers - `PostCashier` - Create a cashier - `GetCashier` - Retrieve a cashier ## Checkout forms - `GetCheckoutFormCollection` - Retrieve checkout forms - `PostCheckoutForm` - Create a checkout form - `GetCheckoutForm` - Retrieve a checkout form - `PutCheckoutForm` - Upsert a checkout form - `DeleteCheckoutForm` - Delete a checkout form ## Coupons - `GetCouponRedemptionCollection` - Retrieve coupon redemptions - `PostCouponRedemption` - Redeem a coupon - `GetCouponRedemption` - Retrieve a coupon redemption - `PostCouponRedemptionCancellation` - Cancel a coupon redemption - `GetCouponCollection` - Retrieve coupons - `PostCoupon` - Create a coupon - `GetCoupon` - Retrieve a coupon - `PutCoupon` - Upsert a coupon - `PostCouponExpiration` - Specify a coupon expiration time ## Credit memos - `GetCreditMemoCollection` - Retrieve credit memos - `PostCreditMemo` - Create a credit memo - `GetCreditMemo` - Retrieve a credit memo - `PutCreditMemo` - Upsert a credit memo - `PatchCreditMemo` - Partially update a credit memo - `PostCreditMemoVoid` - Void a credit memo - `PostCreditMemoRefund` - Refund a credit memo ## Credit memos timeline - `GetCreditMemoTimelineCollection` - Retrieve credit memo timeline messages - `PostCreditMemoTimeline` - Create a credit memo timeline message - `GetCreditMemoTimeline` - Retrieve a credit memo timeline message - `DeleteCreditMemoTimeline` - Delete a credit memo timeline message ## Custom domains - `GetCustomDomainCollection` - Retrieve custom domains - `PostCustomDomain` - Create a custom domain - `GetCustomDomain` - Retrieve a custom domain - `DeleteCustomDomain` - Delete a custom domain ## Custom fields - `GetCustomFieldCollection` - Retrieve custom fields - `GetCustomField` - Retrieve a custom field - `PutCustomField` - Create or alter a custom field ## Customer authentication - `GetAuthenticationOption` - Retrieve authentication options - `PutAuthenticationOption` - Change authentication options - `GetAuthenticationTokenCollection` - Retrieve authentication tokens - `PostAuthenticationToken` - Login a customer - `GetAuthenticationTokenVerification` - Verify an authentication token - `DeleteAuthenticationToken` - Logout a customer - `PostAuthenticationTokenExchange` - Exchange an authentication token - `GetCredentialCollection` - Retrieve credentials - `PostCredential` - Create a credential - `GetCredential` - Retrieve a credential - `PutCredential` - Upsert a credential - `DeleteCredential` - Delete a credential - `GetPasswordTokenCollection` - Retrieve tokens - `PostPasswordToken` - Create a reset password token - `GetPasswordToken` - Retrieve a reset password token - `DeletePasswordToken` - Delete a reset password token ## Customers - `GetCustomerCollection` - Retrieve customers - `PostCustomer` - Create a customer - `GetCustomer` - Retrieve a customer - `PutCustomer` - Upsert a customer - `DeleteCustomer` - Merge and delete a customer - `GetCustomerLeadSource` - Retrieve a customer's lead source - `PutCustomerLeadSource` - Create a customer's lead source - `DeleteCustomerLeadSource` - Delete a customer's lead source - `GetCustomerCreditBalance` - Retrieve customer credit balance - `GetCustomerSummaryMetricReport` - Retrieve a customer's lifetime summary metrics ## Customers timeline - `GetCustomerTimelineCustomEventTypeCollection` - Retrieve customer timeline custom event types - `PostCustomerTimelineCustomEventType` - Create customer timeline custom event type - `GetCustomerTimelineCustomEventType` - Retrieve customer timeline custom event type - `GetCustomerTimelineCollection` - Retrieve customer timeline messages - `PostCustomerTimeline` - Create a customer timeline comment - `GetCustomerTimeline` - Retrieve a customer timeline message - `DeleteCustomerTimeline` - Delete a customer timeline message ## Data exports - `PostDataExport` - Request the data export of a resource - `GetDataExportCollection` - Retrieve data export requests - `GetDataExport` - Retrieve a data export request - `PutDataExport` - Modify a data export - `DeleteDataExport` - Delete a data export ## Deposits - `PostDepositRequest` - Create a deposit request - `GetDepositRequestCollection` - Retrieve deposit requests - `GetDepositRequest` - Retrieve a deposit request - `PostDepositStrategy` - Create a deposit amount strategy - `GetDepositStrategyCollection` - Retrieve deposit amount strategies - `GetDepositStrategy` - Retrieve a deposit amount strategy - `PutDepositStrategy` - Upsert a deposit amount strategy - `DeleteDepositStrategy` - Delete a deposit amount strategy - `PostDepositCustomPropertySet` - Create a custom deposit property set - `GetDepositCustomPropertySetCollection` - Retrieve custom deposit properties sets - `GetDepositCustomPropertySet` - Retrieve a custom deposit property set - `PutDepositCustomPropertySet` - Upsert a custom deposit property set - `DeleteDepositCustomPropertySet` - Delete a custom deposit property set ## Disputes - `GetDisputeCollection` - Retrieve disputes - `PostDispute` - Create a dispute - `GetDispute` - Retrieve a dispute - `PutDispute` - Upsert a dispute ## Email delivery settings - `PutEmailDeliverySettingsVerification` - Verify an email delivery setting - `GetEmailDeliverySettingCollection` - Retrieve email delivery settings - `PostEmailDeliverySetting` - Create an email delivery setting - `GetEmailDeliverySetting` - Retrieve an email delivery setting - `DeleteEmailDeliverySetting` - Delete an email delivery setting - `PatchEmailDeliverySetting` - Update an email delivery setting - `PostResendEmailDeliverySettingVerification` - Resend email delivery setting verification email ## Email messages - `GetEmailMessageCollection` - Retrieve email messages - `PostEmailMessage` - Create an email message - `GetEmailMessage` - Retrieve an email message - `DeleteEmailMessage` - Delete an email message - `PatchEmailMessage` - Send an email message ## Email notifications - `GetEmailNotificationCollection` - Retrieve email notification events - `GetSendThroughAttributionCollection` - Retrieve email notification attributions ## External identifiers - `GetExternalIdentifierCollection` - Retrieve external identifiers - `GetExternalIdentifier` - Retrieve an external identifier - `PostExternalIdentifier` - Sync an external identifier - `PutExternalIdentifier` - Upsert an external identifier - `DeleteExternalIdentifier` - Delete an external identifier - `GetExternalServiceSettings` - Retrieve external service settings - `PutExternalServiceSettings` - Update external service settings ## Fees - `GetFeeCollection` - Retrieve fee entries - `PostFee` - Create a fee entry - `GetFee` - Retrieve a fee entry - `PutFee` - Upsert a fee entry - `PatchFee` - Patch a fee entry - `DeleteFee` - Delete a fee entry ## Files - `GetAttachmentCollection` - Retrieve attachments - `PostAttachment` - Create an attachment - `GetAttachment` - Retrieve an attachment - `PutAttachment` - Update an attachment - `DeleteAttachment` - Delete an attachment - `GetFileCollection` - Retrieve files - `PostFile` - Create a file - `GetFile` - Retrieve a file record - `PutFile` - Update a file - `DeleteFile` - Delete a file - `GetFileDownload` - Download a file ## Gateway accounts - `GetGatewayAccountCollection` - Retrieve gateway accounts - `PostGatewayAccount` - Create a gateway account - `GetGatewayAccount` - Retrieves a gateway account - `PutGatewayAccount` - Upsert a gateway account - `PatchGatewayAccount` - Update a gateway account - `DeleteGatewayAccount` - Delete a gateway account - `PostGatewayAccountClosure` - Close a gateway account - `PostGatewayAccountDisablement` - Disable a gateway account - `GetGatewayAccountDowntimeScheduleCollection` - List gateway account downtime schedules - `PostGatewayAccountDowntimeSchedule` - Create a gateway account downtime schedule - `GetGatewayAccountDowntimeSchedule` - Retrieve a gateway account downtime schedule - `PutGatewayAccountDowntimeSchedule` - Update a gateway account downtime schedule - `DeleteGatewayAccountDowntimeSchedule` - Delete a gateway account downtime schedule - `PostGatewayAccountEnablement` - Enable a gateway account - `GetGatewayAccountLimitCollection` - Retrieve gateway account limits - `GetGatewayAccountLimit` - Retrieve a gateway account limit - `PutGatewayAccountLimit` - Update a gateway account limit - `DeleteGatewayAccountLimit` - Delete a gateway account limit - `PostGatewayAccountCheckCredentials` - Verify gateway account credentials - `GetGatewayAccountFinancialSettings` - Retrieve financial settings of a gateway account - `PutGatewayAccountFinancialSettings` - Set financial settings - `PostDigitalWalletOnboardingApplePay` - Register a domain for Apple Pay ## Gateway accounts timeline - `GetGatewayAccountTimelineCollection` - Retrieve gateway account timeline messages - `PostGatewayAccountTimeline` - Create a gateway account timeline comment - `GetGatewayAccountTimeline` - Retrieve a gateway timeline message - `DeleteGatewayAccountTimeline` - Delete a gateway timeline message ## Histograms - `GetHistogramAmlCheckReport` - Retrieve AML check histogram report data - `GetHistogramTransactionReport` - Retrieve transaction histogram report data ## Integrations - `GetIntegrationCollection` - Retrieve integrations - `GetIntegration` - Retrieve an integration for specific label ## Invoices - `GetInvoiceCollection` - Retrieve invoices - `PostInvoice` - Create an invoice - `GetInvoice` - Retrieve an invoice - `PutInvoice` - Upsert an invoice - `GetInvoiceItemCollection` - Retrieve invoice items - `PostInvoiceItem` - Create an invoice item - `GetInvoiceItem` - Retrieve an invoice item - `PutInvoiceItem` - Update an invoice item - `DeleteInvoiceItem` - Delete an invoice item - `PostInvoiceIssuance` - Issue an invoice - `PostInvoiceAbandonment` - Abandon an invoice - `PostInvoiceVoid` - Void an invoice - `PostInvoiceRecalculation` - Recalculate an invoice - `PostInvoiceReissuance` - Reissue an invoice - `GetInvoiceTransactionAllocationCollection` - Retrieve transaction amounts allocations - `PostInvoiceAllocateCreditBalance` - Allocate customer credit balance to an invoice - `PostInvoiceTransaction` - Apply a transaction to an invoice ## Invoices timeline - `GetInvoiceTimelineCollection` - Retrieve invoice timeline messages - `PostInvoiceTimeline` - Create an invoice timeline comment - `GetInvoiceTimeline` - Retrieve an invoice timeline message - `DeleteInvoiceTimeline` - Delete an invoice timeline message ## Journal - `GetJournalAccountCollection` - Retrieve journal accounts - `PostJournalAccount` - Create a journal account - `GetJournalAccount` - Retrieve journal account - `PutJournalAccount` - Upsert a journal account - `GetJournalEntryCollection` - Retrieve journal entries - `PostJournalEntry` - Create a journal entry - `GetJournalEntry` - Retrieve journal entry - `PutJournalEntry` - Upsert a journal entry - `GetJournalRecordCollection` - Retrieve journal records - `PostJournalRecord` - Create a journal record - `GetJournalRecord` - Retrieve journal record - `PutJournalRecord` - Upsert a journal record - `DeleteJournalRecord` - Delete a journal record ## KYC documents - `PostKycRequest` - Create a KYC request - `GetKycRequestCollection` - Retrieve KYC requests - `GetKycRequest` - Retrieve a KYC request - `PatchKycRequest` - Update a KYC request - `DeleteKycRequest` - Delete the KYC request - `GetKycDocumentCollection` - Retrieve KYC documents - `PostKycDocument` - Create a KYC document - `GetKycDocument` - Retrieve a KYC document - `PutKycDocument` - Upsert a KYC document - `PostKycDocumentAcceptance` - Accept a KYC document - `PostKycDocumentMatches` - Update KYC document matches - `PostKycDocumentRejection` - Reject a KYC document - `PostKycDocumentReview` - Review a KYC document - `PostKycDocumentStartReview` - Start review of a KYC document - `PostKycDocumentStopReview` - Stop review of a KYC document - `GetKycSettings` - Retrieve KYC settings - `PutKycSettings` - Update KYC settings ## Lists - `GetListCollection` - Retrieve lists - `PostList` - Create a list - `GetList` - Retrieve latest list version - `PutList` - Upsert a list - `DeleteList` - Delete a list - `GetListVersion` - Retrieve specific list version ## Memberships - `GetMembershipCollection` - Retrieve memberships - `GetMembership` - Retrieve a membership - `PutMembership` - Upsert membership - `DeleteMembership` - Delete a membership ## Metadata - `GetPaymentMethodCollection` - Retrieve payment method metadata - `GetPaymentMethod` - Retrieve metadata of a payment method - `GetPaymentGatewayMetadataCollection` - Retrieve payment gateway metadata - `GetPaymentGatewayMetadata` - Retrieve payment gateway metadata ## Orders - `GetSubscriptionCollection` - Retrieve orders - `PostSubscription` - Create an order - `GetSubscription` - Retrieve an order - `PutSubscription` - Upsert an order - `DeleteSubscription` - Delete a pending order - `PostSubscriptionVoid` - Void a subscription order - `PostSubscriptionItemsChange` - Change subscription order items - `PatchSubscriptionItem` - Update a subscription order item - `PostSubscriptionInterimInvoice` - Issue an interim invoice - `GetSubscriptionPauseCollection` - Retrieve subscription order pauses - `PostSubscriptionPause` - Pause a subscription order - `GetSubscriptionPause` - Retrieve a subscription order pause - `PutSubscriptionPause` - Update a subscription order pause - `DeleteSubscriptionPause` - Delete a subscription order pause - `GetSubscriptionCancellationCollection` - Retrieve subscription order cancellations - `PostSubscriptionCancellation` - Cancel a subscription order - `GetSubscriptionCancellation` - Retrieve a subscription order cancellation - `PutSubscriptionCancellation` - Upsert a subscription order cancellation - `PatchSubscriptionCancellation` - Update a subscription order cancellation - `DeleteSubscriptionCancellation` - Delete a subscription order cancellation - `GetSubscriptionReactivationCollection` - Retrieve subscription order reactivations - `PostSubscriptionReactivation` - Reactivate a subscription order - `GetSubscriptionReactivation` - Retrieve a subscription order reactivation - `GetSubscriptionUpcomingInvoiceCollection` - Retrieve upcoming subscription order invoice - `GetSubscriptionUpcomingInvoice` - Retrieve an upcoming subscription order invoice - `PostSubscriptionUpcomingInvoiceIssuance` - Issue an upcoming invoice for early pay - `PostUpcomingInvoiceIssuance` - Issue a specific upcoming invoice for early pay - `PostPreviewOrder` - Preview an order - `GetSubscriptionSummaryMetricReport` - Retrieve subscription order summary metrics ## Orders experimental - `GetOrderCollection` - Retrieve orders - `PostOrder` - Create an order - `GetOrder` - Retrieve an order - `PutOrder` - Upsert an order - `GetOrderUpcomingInvoice` - Retrieve an upcoming order invoice - `GetOrderPauseCollection` - Retrieve order pauses - `PostOrderPause` - Pause a order - `GetOrderPause` - Retrieve an order pause - `PutOrderPause` - Update an order pause - `DeleteOrderPause` - Delete an order pause - `GetOrderCancellationCollection` - Retrieve order cancellation collection - `PostOrderCancellation` - Cancel an order - `GetOrderCancellation` - Retrieve an order cancellation - `PutOrderCancellation` - Upsert an order cancellation - `PatchOrderCancellation` - Update an order cancellation - `DeleteOrderCancellation` - Delete an order cancellation - `GetOrderReactivationCollection` - Retrieve order reactivations - `PostOrderReactivation` - Reactivate an order - `GetOrderReactivation` - Retrieve an order reactivation - `PostOrderVoid` - Void an order - `PostOrderItemsChange` - Change order items - `PatchOrderItem` - Update an order item - `PostOrderInterimInvoice` - Issue an interim invoice - `PostOrderUpcomingInvoiceIssuance` - Issue an upcoming invoice for early pay ## Orders timeline - `GetSubscriptionTimelineCollection` - Retrieve order timeline messages - `PostSubscriptionTimeline` - Create an order timeline comment - `GetSubscriptionTimeline` - Retrieve an order timeline message - `DeleteSubscriptionTimeline` - Delete an order timeline message ## Organization data exports - `GetOrganizationExportCollection` - Retrieve organization data exports - `PostOrganizationExport` - Request an organization data export - `GetOrganizationExport` - Retrieve an organization data export request ## Organizations - `GetOrganizationCollection` - Retrieve organizations - `PostOrganization` - Create an organization - `GetOrganization` - Retrieve an organization - `PatchOrganization` - Update an organization ## Payment instruments - `GetPaymentInstrumentCollection` - Retrieve payment instruments - `PostPaymentInstrument` - Create a payment instrument - `GetPaymentInstrument` - Retrieve a payment instrument - `PatchPaymentInstrument` - Update payment instrument - `PostPaymentInstrumentDeactivation` - Deactivate a payment instrument - `PostPaymentInstrumentNameInquiry` - Verify name on a payment instrument - `GetPaymentCardBankNameCollection` - Retrieve payment card issuing bank names ## Payment tokens - `PostToken` - Create a payment token - `GetTokenCollection` - Retrieve tokens - `GetToken` - Retrieve a token - `PostDigitalWalletValidation` - Validate a digital wallet session ## Plans - `GetPlanCollection` - Retrieve plans - `PostPlan` - Create a plan - `GetPlan` - Retrieve a plan - `PutPlan` - Upsert a plan - `DeletePlan` - Delete a plan ## Products - `GetProductCollection` - Retrieve products - `PostProduct` - Create a product - `GetProduct` - Retrieve a product - `PutProduct` - Upsert a product - `DeleteProduct` - Delete a product ## Profile - `PostPermissionsEmulation` - Start permissions emulation - `DeletePermissionsEmulation` - Stop permissions emulation - `GetProfile` - Retrieve user's own profile - `PutProfile` - Update a user profile - `GetProfileMfa` - Retrieve user MFA status - `PostProfileMfa` - Update user MFA - `DeleteProfileMfa` - Delete user MFA ## Quotes - `GetQuoteCollection` - Retrieve quotes - `PostQuote` - Create a quote - `GetQuote` - Retrieve a quote - `PutQuote` - Upsert a quote - `PatchQuote` - Partially update a quote - `PostQuoteAcceptance` - Accept a quote - `PostQuoteCancellation` - Cancel a quote - `PostQuoteIssuance` - Issue a quote - `PostQuoteRecall` - Recall a quote - `PostQuoteRejection` - Reject a quote ## Quotes timeline - `GetQuoteTimelineCollection` - Retrieve quote timeline messages - `PostQuoteTimeline` - Create a quote timeline comment - `GetQuoteTimeline` - Retrieve a quote timeline message - `DeleteQuoteTimeline` - Delete a quote timeline message ## Reports - `GetApiLogSummaryReport` - Retrieve an API log summary report - `GetAmlCheckReport` - Retrieve an AML checks report - `GetAmlInheritedMatchSummaryReport` - Retrieve AML inherited-match report - `GetCumulativeSubscriptionReport` - Retrieve a cumulative subscriptions report - `GetDashboardReport` - Retrieve dashboard data - `GetDccMarkupReport` - Retrieve a DCC markup report - `GetDeclinedTransactionReport` - Retrieve a declined transactions report - `GetDeferredRevenueReport` - Retrieve a deferred revenue report - `GetDisputeReport` - Retrieve a disputes report - `GetTriggeredEventReport` - Retrieve events triggered summary report - `GetTriggeredEventRuleReport` - Retrieve a rules matched summary report - `GetFutureRenewalReport` - Retrieve a future renewals report - `GetJournalReport` - Retrieve a journal report - `GetJournalSummaryReport` - Retrieve a journal summary report - `GetKycAcceptanceSummaryReport` - Retrieve a KYC acceptance summary report - `GetKycRejectionSummaryReport` - Retrieve a KYC rejections report - `GetKycRequestSummaryReport` - Retrieve a KYC requests report - `GetMonthlyRecurringRevenueReport` - Retrieve a MRR report - `GetAnnualRecurringRevenueReport` - Retrieve an ARR report - `GetRenewalSaleReport` - Retrieve a renewal sales report - `GetRetentionPercentageReport` - Retrieve a retention percentage report - `GetRetentionValueReport` - Retrieve a retention value report - `GetRevenueWaterfallReport` - Retrieve a revenue waterfall report - `GetSubscriptionCancellationReport` - Retrieve a subscription cancellation report - `GetSubscriptionRenewalReport` - Retrieve a subscription renewal report - `GetTaxReport` - Retrieve a tax report - `GetTimeSeriesTransactionReport` - Retrieve a time series transactions report - `GetTransactionTimeDisputeReport` - Retrieve a transaction time dispute report - `GetTransactionReport` - Retrieve a transactions report ## Reset password - `PostForgotPasswordRequest` - Request a password reset ## Risk score - `GetRiskScoreRules` - Retrieve risk score rules - `PutRiskScoreRules` - Modify risk score rules - `GetRiskScoreBlocklistRules` - Retrieve risk score blocklist rules - `PutRiskScoreBlocklistRules` - Modify risk score blocklist rules ## Roles - `GetRoleCollection` - Retrieve roles - `PostRole` - Create a role - `GetRole` - Retrieve a role - `PutRole` - Create a role with ID - `DeleteRole` - Delete a role ## Rules - `GetEventCollection` - Retrieve system events - `GetEvent` - Retrieve event information - `GetEventRuleCollection` - Retrieve event rules - `PutEventRule` - Update event rules - `GetEventRuleHistoryCollection` - Retrieve change history of a ruleset - `GetEventRuleHistory` - Retrieve change history record of a ruleset - `GetEventRuleVersion` - Retrieve a version of a ruleset - `GetEventRuleSetDraftCollection` - Retrieve draft rulesets - `PostEventRuleSetDraft` - Create a draft ruleset - `GetEventRuleSetDraft` - Retrieve a draft ruleset - `DeleteEventRuleSetDraft` - Delete a draft ruleset - `PutEventRuleSetDraft` - Update a draft ruleset - `PostPreviewRuleActionEmailSending` - Send a test email ## Rules timeline - `GetRuleSetCollection` - Retrieve rules engine timeline messages - `PostRuleSetTimeline` - Create a rules engine timeline comment - `GetRuleSetTimeline` - Retrieve a rules engine timeline message - `DeleteRuleSetTimeline` - Delete a rules engine timeline message ## Search - `GetSearch` - Search merchant data ## Segments - `GetGridSegmentCollection` - Retrieve a user's segments - `PostGridSegment` - Create a new UI segment - `GetGridSegment` - Retrieve a segment - `PutGridSegment` - Update a segment - `DeleteGridSegment` - Delete a segment ## Service credentials - `GetServiceCredentialCollection` - Retrieve service credentials - `PostServiceCredential` - Create a service credential - `GetServiceCredential` - Retrieve a service credential - `PatchServiceCredential` - Update a service credential - `GetServiceCredentialItemCollection` - List credential root items ## Shipping rates - `GetShippingRateCollection` - Retrieve shipping rates - `PostShippingRate` - Create a shipping rate - `GetShippingRate` - Retrieve a shipping rate - `PutShippingRate` - Create a shipping rate with ID - `DeleteShippingRate` - Delete a shipping rate ## Status - `GetStatus` - Retrieve API current status ## Storefront KYC documents - `StorefrontGetKycDocumentCollection` - Retrieve KYC documents - `StorefrontPostKycDocument` - Create a KYC document - `StorefrontGetKycDocument` - Retrieve a KYC Document - `StorefrontPatchKycDocument` - Update a KYC document - `StorefrontGetKycRequest` - Retrieve a KYC request - `StorefrontPostKycLivenessSession` - Create a KYC liveness session - `StorefrontGetKycLivenessSession` - Retrieve a KYC liveness session - `StorefrontPostKycLivenessSessionFinish` - Finish KYC liveness session ## Storefront account - `StorefrontGetAccount` - Retrieve account - `StorefrontPatchAccount` - Update account - `StorefrontPostForgotPassword` - Request a password reset - `StorefrontPatchAccountPassword` - Change an account password - `StorefrontPostAccountResendVerification` - Resend email verification - `StorefrontPostResetPassword` - Finish password reset - `StorefrontPostAccountVerification` - Verify an account email - `StorefrontPostLogin` - Create a session with username and password - `StorefrontPostLogout` - Destroys the user's current session - `StorefrontPostRegister` - Register account ## Storefront billing portals - `StorefrontGetBillingPortal` - Retrieve a billing portal ## Storefront cashiers - `StorefrontGetCashier` - Retrieve a cashier - `StorefrontPostCashierPayoutRequestCancellation` - Cancel pending payout requests ## Storefront checkout forms - `StorefrontGetCheckoutForm` - Retrieve a checkout form ## Storefront custom fields - `StorefrontGetCustomFieldCollection` - Retrieve custom fields ## Storefront deposits - `StorefrontGetDepositStrategy` - Retrieve a deposit amount strategy - `StorefrontGetDepositRequest` - Retrieve a deposit request - `StorefrontPostDeposit` - Create a deposit ## Storefront invoices - `StorefrontGetInvoiceCollection` - Retrieve invoices - `StorefrontGetInvoice` - Retrieve an invoice - `StorefrontPatchInvoice` - Update an invoice ## Storefront orders - `StorefrontGetOrderUpcomingInvoice` - Retrieve an upcoming order invoice - `StorefrontGetOrderCollection` - Retrieve orders - `StorefrontGetOrder` - Retrieve an order - `StorefrontPatchOrder` - Update an order - `StorefrontPostOrderCancellation` - Cancel an order - `StorefrontPostOrderPause` - Pause a subscription order - `StorefrontPostSubscriptionItemsChange` - Change subscription items - `StorefrontPostSubscriptionReactivation` - Reactivate a subscription - `StorefrontPostSubscription` - Create a subscription ## Storefront payment instruments - `StorefrontGetPaymentInstrumentCollection` - Retrieve payment instruments - `StorefrontPostPaymentInstrument` - Create a payment instrument - `StorefrontGetPaymentInstrument` - Retrieve a payment instrument - `StorefrontPatchPaymentInstrument` - Update payment instrument - `StorefrontPostPaymentInstrumentDeactivation` - Deactivate a payment instrument - `StorefrontGetPaymentInstrumentSetup` - Retrieve a payment instrument setup transaction - `StorefrontPostPaymentInstrumentSetup` - Create a setup payment instrument transaction ## Storefront plans - `StorefrontGetPlanCollection` - Retrieve a list of plans - `StorefrontGetPlan` - Retrieve a plan ## Storefront products - `StorefrontGetProductCollection` - Retrieve products - `StorefrontGetProduct` - Retrieve a product ## Storefront purchases - `StorefrontPostPayment` - Perform a payment - `StorefrontPostPurchase` - Make a purchase - `StorefrontPostPreviewPurchase` - Preview a purchase - `StorefrontPostReadyToPay` - Ready to pay - `StorefrontPostReadyToPayout` - Ready to payout ## Storefront quotes - `StorefrontGetQuote` - Retrieve a quote - `StorefrontPostQuoteAcceptance` - Accept a quote - `StorefrontPostQuoteRejection` - Reject a quote ## Storefront transactions - `StorefrontGetPayoutRequestCollection` - Retrieve payout requests - `StorefrontPostPayoutRequest` - Create a payout request - `StorefrontGetPayoutRequest` - Retrieve a payout request - `StorefrontPatchPayoutRequest` - Update a payout request - `StorefrontGetTransactionCollection` - Retrieve transactions - `StorefrontGetTransaction` - Retrieve a transaction - `StorefrontGetTransactionDccOffer` - Retrieve a transaction DCC offer - `StorefrontPatchTransactionDccOffer` - Update a transaction DCC offer - `StorefrontPostKycRequestContinue` - Finish a transaction KYC verification - `StorefrontPostKycRequestBypass` - Skip a transaction KYC verification ## Storefront websites - `StorefrontGetWebsite` - Retrieve a website ## Tags - `GetTagCollection` - Retrieve tags - `PostTag` - Create a tag - `GetTag` - Retrieve a tag - `PatchTag` - Update a tag - `DeleteTag` - Delete a tag - `PostTagCustomerCollection` - Tag a list of customers - `DeleteTagCustomerCollection` - Untag a list of customers - `PostTagCustomer` - Tag a customer - `DeleteTagCustomer` - Untag a customer - `PostTagKycDocumentCollection` - Tag a list of KYC documents - `DeleteTagKycDocumentCollection` - Untag a list of KYC documents - `PostTagKycDocument` - Tag a KYC document - `DeleteTagKycDocument` - Untag a KYC document - `PostTagAmlCheckCollection` - Tag a list of AML checks - `DeleteTagAmlCheckCollection` - Untag a list of AML checks - `PostTagAmlCheck` - Tag an AML check - `DeleteTagAmlCheck` - Untag an AML check - `GetTagRuleCollection` - Retrieve tags rules list - `PostTagRule` - Create tags rule - `GetTagRule` - Retrieve a tags rule - `PutTagRule` - Create a tags rule with specified ID - `DeleteTagRule` - Delete tags rule ## Tracking - `GetTrackingApiCollection` - Retrieve API tracking logs - `GetTrackingApi` - Retrieve an API tracking log - `GetTrackingTaxCollection` - Retrieve tax service tracking logs - `GetTrackingTax` - Retrieve a tax service tracking log - `GetTrackingListCollection` - Retrieve value list changes - `GetTrackingWebhookCollection` - Retrieve webhook tracking logs - `GetTrackingWebhook` - Retrieve a webhook tracking log - `PostTrackingWebhookResendRequest` - Schedule a resend webhook attempt ## Transactions - `PostReadyToPay` - Ready to pay - `PostTransaction` - Create a transaction - `GetTransactionCollection` - Retrieve transactions - `GetTransaction` - Retrieve a transaction - `PatchTransaction` - Update a transaction - `PostPayout` - Create a credit transaction - `PostTransactionQuery` - Query a transaction - `PostTransactionUpdate` - Update a transaction status - `PostTransactionRefund` - Refund a transaction - `GetPayoutRequestCollection` - Retrieve payout requests - `PostPayoutRequest` - Create a payout request - `GetPayoutRequest` - Retrieve a payout request - `PutPayoutRequest` - Upsert a payout request - `PatchPayoutRequest` - Update a payout request - `PostPayoutRequestCancellation` - Cancel a payout request - `PostPayoutRequestSplit` - Request a payout request split - `GetPayoutRequestPaymentInstruments` - Retrieve associated payment instruments - `GetPayoutRequestAllocationCollection` - Retrieve payout request allocations - `PostPayoutRequestAllocation` - Create a payout request allocation - `PostPayoutRequestAutoAllocation` - Create an automatic payout request allocation - `GetPayoutRequestAllocation` - Retrieve a payout request allocation - `PatchPayoutRequestAllocation` - Update allocation status - `PostPayoutRequestAllocationsProcess` - Initiate processing of allocations - `GetPayoutRequestBatchCollection` - Retrieve payout request batches - `PostPayoutRequestBatch` - Create a payout request batch - `GetPayoutRequestBatch` - Retrieve a payout request batch - `PatchPayoutRequestBatch` - Update a payout request batch - `PostPayoutRequestBatchAutoAllocate` - Allocate batch payout requests automatically - `PostPayoutRequestBatchApprove` - Approve payout requests in a batch - `PostPayoutRequestBatchBlock` - Block batch payout requests - `GetPayoutRequestBatchPreview` - Preview payout request batch results ## Transactions timeline - `GetTransactionTimelineCollection` - Retrieve transaction timeline messages - `PostTransactionTimeline` - Create a transaction timeline comment - `GetTransactionTimeline` - Retrieve a transaction Timeline message - `DeleteTransactionTimeline` - Delete a transaction timeline message - `GetPayoutRequestTimelineCollection` - Retrieve payout request timeline messages - `PostPayoutRequestTimeline` - Create a payout request timeline comment - `GetPayoutRequestTimelineMessage` - Retrieve a payout request timeline message - `DeletePayoutRequestTimelineMessage` - Delete a payout request timeline message ## Usage - `GetUsageCollection` - Retrieve usage records - `PostUsage` - Create a usage record - `GetUsage` - Retrieve a usage record - `DeleteUsage` - Delete a usage record ## Users - `GetUserCollection` - Retrieve a list of users - `PostUser` - Create a user - `GetUser` - Retrieve a user - `PutUser` - Upsert a user - `GetUserMfa` - Retrieve user MFA status ## Webhooks - `PostPreviewWebhook` - Send a test webhook - `GetWebhookCollection` - Retrieve webhooks - `PostWebhook` - Create a webhook - `GetWebhook` - Retrieve a webhook - `PutWebhook` - Upsert a webhook - `DeleteWebhook` - Delete a webhook ## Websites - `GetWebsiteCollection` - Retrieve websites - `PostWebsite` - Create a website - `GetWebsite` - Retrieve a website - `PutWebsite` - Upsert a website - `DeleteWebsite` - Delete a website