Last updated

User permissions

This topic lists every permission that you can assign to a user, role, or API key.

Permissions control which features and API operations a user, role, or API key can access. Permissions are organized into resource groups, such as customers, invoices, and transactions.

To assign permissions to users or roles, see Users. To assign permissions to API keys, see API keys. The following sections list every permission, grouped by resource.

AML

  • GetAmlCheckCollection - Retrieve AML checks
  • GetAmlCheck - Retrieve an AML check
  • GetAmlSettings - Retrieve AML settings
  • PostAmlCheckReview - Review an AML check
  • PostAmlCheckStartReview - Start review of an AML check
  • PostAmlCheckStopReview - Stop review of an AML check
  • PutAmlSettings - Update AML settings

API keys

  • GetApiKeyCollection - Retrieve API keys
  • GetApiKey - Retrieve API key
  • PostApiKey - Create an API key
  • PutApiKey - Upsert an API key
  • DeleteApiKey - Delete API key

Account registration settings

  • GetAccountRegistrationSettingsCollection - Retrieve account registration settings
  • GetAccountRegistrationSettings - Retrieve account registration settings
  • PostAccountRegistrationSettings - Create account registration settings
  • PutAccountRegistrationSettings - Upsert account registration settings
  • DeleteAccountRegistrationSettings - Delete account registration settings

Allowlists

  • GetAllowlistCollection - Retrieve allowlist collection
  • GetAllowlist - Retrieve allowlist record
  • PostAllowlist - Create allowlist record
  • DeleteAllowlist - Delete allowlist record

Application owners

  • GetApplicationInstanceCollection - Retrieve application instances
  • GetApplicationInstanceByOrganization - Retrieve an application instance
  • PostApplication - Register an application

Application users

  • GetApplicationCollection - Retrieve applications
  • GetApplication - Retrieve application
  • GetApplicationInstance - Retrieve an application instance
  • GetApplicationInstanceConfiguration - Retrieve an application instance configuration
  • PutApplicationInstance - Upsert an application instance
  • PutApplicationInstanceConfiguration - Upsert an application instance configuration
  • DeleteApplicationInstance - Delete application instance

Balance transactions

  • GetBalanceTransactionCollection - Retrieve balance transactions
  • GetBalanceTransaction - Retrieve a balance transaction

Billing portals

  • GetBillingPortalCollection - Retrieve billing portals
  • GetBillingPortal - Retrieve a billing portal
  • PostBillingPortal - Create a billing portal
  • PutBillingPortal - Upsert a billing portal
  • DeleteBillingPortal - Delete a billing portal

Blocklists

  • GetBlocklistCollection - Retrieve blocklists
  • GetBlocklist - Retrieve a blocklist
  • PostBlocklist - Create a blocklist
  • PutBlocklist - Create a blocklist with specified ID
  • DeleteBlocklist - Delete a blocklist

Broadcast messages

  • GetBroadcastMessageCollection - Retrieve broadcast messages
  • GetBroadcastMessage - Retrieve a broadcast message
  • PostBroadcastMessage - Create a broadcast message
  • PatchBroadcastMessage - Update a broadcast message
  • DeleteBroadcastMessage - Delete a broadcast message

Cashiers

  • GetCashier - Retrieve a cashier
  • PostCashier - Create a cashier

Checkout forms

  • GetCheckoutFormCollection - Retrieve checkout forms
  • GetCheckoutForm - Retrieve a checkout form
  • PostCheckoutForm - Create a checkout form
  • PutCheckoutForm - Upsert a checkout form
  • DeleteCheckoutForm - Delete a checkout form

Coupons

  • GetCouponCollection - Retrieve coupons
  • GetCouponRedemptionCollection - Retrieve coupon redemptions
  • GetCoupon - Retrieve a coupon
  • GetCouponRedemption - Retrieve a coupon redemption
  • PostCoupon - Create a coupon
  • PostCouponExpiration - Specify a coupon expiration time
  • PostCouponRedemption - Redeem a coupon
  • PostCouponRedemptionCancellation - Cancel a coupon redemption
  • PutCoupon - Upsert a coupon

Credit memos

  • GetCreditMemoCollection - Retrieve credit memos
  • GetCreditMemo - Retrieve a credit memo
  • PostCreditMemo - Create a credit memo
  • PostCreditMemoRefund - Refund a credit memo
  • PostCreditMemoVoid - Void a credit memo
  • PutCreditMemo - Upsert a credit memo
  • PatchCreditMemo - Partially update a credit memo

Credit memos timeline

  • GetCreditMemoTimelineCollection - Retrieve credit memo timeline messages
  • GetCreditMemoTimeline - Retrieve a credit memo timeline message
  • PostCreditMemoTimeline - Create a credit memo timeline message
  • DeleteCreditMemoTimeline - Delete a credit memo timeline message

Custom domains

  • GetCustomDomainCollection - Retrieve custom domains
  • GetCustomDomain - Retrieve a custom domain
  • PostCustomDomain - Create 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

  • GetAuthenticationTokenCollection - Retrieve authentication tokens
  • GetCredentialCollection - Retrieve credentials
  • GetPasswordTokenCollection - Retrieve tokens
  • GetAuthenticationOption - Retrieve authentication options
  • GetAuthenticationTokenVerification - Verify an authentication token
  • GetCredential - Retrieve a credential
  • GetPasswordToken - Retrieve a reset password token
  • PostAuthenticationToken - Login a customer
  • PostAuthenticationTokenExchange - Exchange an authentication token
  • PostCredential - Create a credential
  • PostPasswordToken - Create a reset password token
  • PutAuthenticationOption - Change authentication options
  • PutCredential - Upsert a credential
  • DeleteAuthenticationToken - Logout a customer
  • DeleteCredential - Delete a credential
  • DeletePasswordToken - Delete a reset password token

Customers

  • GetCustomerCollection - Retrieve customers
  • GetCustomer - Retrieve a customer
  • GetCustomerCreditBalance - Retrieve customer credit balance
  • GetCustomerLeadSource - Retrieve a customer's lead source
  • GetCustomerSummaryMetricReport - Retrieve a customer's lifetime summary metrics
  • PostCustomer - Create a customer
  • PostCustomerComplianceScreeningReport - Create a compliance screening report
  • PutCustomer - Upsert a customer
  • PutCustomerLeadSource - Create a customer's lead source
  • DeleteCustomer - Merge and delete a customer
  • DeleteCustomerLeadSource - Delete a customer's lead source

Customers timeline

  • GetCustomerTimelineCollection - Retrieve customer timeline messages
  • GetCustomerTimelineCustomEventTypeCollection - Retrieve customer timeline custom event types
  • GetCustomerTimeline - Retrieve a customer timeline message
  • GetCustomerTimelineCustomEventType - Retrieve customer timeline custom event type
  • PostCustomerTimeline - Create a customer timeline comment
  • PostCustomerTimelineCustomEventType - Create customer timeline custom event type
  • DeleteCustomerTimeline - Delete a customer timeline message

Dashboards

  • GetProfileDashboard - Retrieve profile dashboard
  • GetProfileDashboardMetricReport - Retrieve dashboard metric data
  • PutProfileDashboard - Update profile dashboard

Data exports

  • GetDataExportCollection - Retrieve data export requests
  • GetDataExport - Retrieve a data export request
  • PostDataExport - Request the data export of a resource
  • PutDataExport - Modify a data export
  • DeleteDataExport - Delete a data export

Deposits

  • GetDepositCustomPropertySetCollection - Retrieve custom deposit properties sets
  • GetDepositRequestCollection - Retrieve deposit requests
  • GetDepositStrategyCollection - Retrieve deposit amount strategies
  • GetDepositCustomPropertySet - Retrieve a custom deposit property set
  • GetDepositRequest - Retrieve a deposit request
  • GetDepositStrategy - Retrieve a deposit amount strategy
  • PostDepositCustomPropertySet - Create a custom deposit property set
  • PostDepositRequest - Create a deposit request
  • PostDepositStrategy - Create a deposit amount strategy
  • PutDepositCustomPropertySet - Upsert a custom deposit property set
  • PutDepositStrategy - Upsert a deposit amount strategy
  • DeleteDepositCustomPropertySet - Delete a custom deposit property set
  • DeleteDepositStrategy - Delete a deposit amount strategy

Disputes

  • GetDisputeCollection - Retrieve disputes
  • GetDispute - Retrieve a dispute
  • PostDispute - Create a dispute
  • PutDispute - Upsert a dispute

Email delivery settings

  • GetEmailDeliverySettingCollection - Retrieve email delivery settings
  • GetEmailDeliverySetting - Retrieve an email delivery setting
  • PostEmailDeliverySetting - Create an email delivery setting
  • PostResendEmailDeliverySettingVerification - Resend email delivery setting verification email
  • PutEmailDeliverySettingsVerification - Verify an email delivery setting
  • PatchEmailDeliverySetting - Update an email delivery setting
  • DeleteEmailDeliverySetting - Delete an email delivery setting

Email messages

  • GetEmailMessageCollection - Retrieve email messages
  • GetEmailMessage - Retrieve an email message
  • PostEmailMessage - Create an email message
  • PatchEmailMessage - Send an email message
  • DeleteEmailMessage - Delete 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
  • GetExternalServiceSettings - Retrieve external service settings
  • PostExternalIdentifier - Sync an external identifier
  • PutExternalIdentifier - Upsert an external identifier
  • PutExternalServiceSettings - Update external service settings
  • DeleteExternalIdentifier - Delete an external identifier

Fees

  • GetFeeCollection - Retrieve fee entries
  • GetFee - Retrieve a fee entry
  • PostFee - Create a fee entry
  • PutFee - Upsert a fee entry
  • PatchFee - Patch a fee entry
  • DeleteFee - Delete a fee entry

Files

  • GetAttachmentCollection - Retrieve attachments
  • GetFileCollection - Retrieve files
  • GetAttachment - Retrieve an attachment
  • GetFile - Retrieve a file record
  • GetFileDownload - Download a file
  • PostAttachment - Create an attachment
  • PostFile - Create a file
  • PutAttachment - Update an attachment
  • PutFile - Update a file
  • DeleteAttachment - Delete an attachment
  • DeleteFile - Delete a file

Gateway accounts

  • GetGatewayAccountCollection - Retrieve gateway accounts
  • GetGatewayAccountDowntimeScheduleCollection - List gateway account downtime schedules
  • GetGatewayAccountLimitCollection - Retrieve gateway account limits
  • GetGatewayAccount - Retrieves a gateway account
  • GetGatewayAccountDowntimeSchedule - Retrieve a gateway account downtime schedule
  • GetGatewayAccountFinancialSettings - Retrieve financial settings of a gateway account
  • GetGatewayAccountLimit - Retrieve a gateway account limit
  • PostDigitalWalletOnboardingApplePay - Register a domain for Apple Pay
  • PostGatewayAccount - Create a gateway account
  • PostGatewayAccountCheckCredentials - Verify gateway account credentials
  • PostGatewayAccountClosure - Close a gateway account
  • PostGatewayAccountDisablement - Disable a gateway account
  • PostGatewayAccountDowntimeSchedule - Create a gateway account downtime schedule
  • PostGatewayAccountEnablement - Enable a gateway account
  • PutGatewayAccount - Upsert a gateway account
  • PutGatewayAccountDowntimeSchedule - Update a gateway account downtime schedule
  • PutGatewayAccountFinancialSettings - Set financial settings
  • PutGatewayAccountLimit - Update a gateway account limit
  • PatchGatewayAccount - Update a gateway account
  • DeleteGatewayAccount - Delete a gateway account
  • DeleteGatewayAccountDowntimeSchedule - Delete a gateway account downtime schedule
  • DeleteGatewayAccountLimit - Delete a gateway account limit

Gateway accounts timeline

  • GetGatewayAccountTimelineCollection - Retrieve gateway account timeline messages
  • GetGatewayAccountTimeline - Retrieve a gateway timeline message
  • PostGatewayAccountTimeline - Create a gateway account timeline comment
  • 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
  • GetInvoiceItemCollection - Retrieve invoice items
  • GetInvoiceTransactionAllocationCollection - Retrieve transaction amounts allocations
  • GetInvoice - Retrieve an invoice
  • GetInvoiceItem - Retrieve an invoice item
  • PostInvoice - Create an invoice
  • PostInvoiceAbandonment - Abandon an invoice
  • PostInvoiceAllocateCreditBalance - Allocate customer credit balance to an invoice
  • PostInvoiceIssuance - Issue an invoice
  • PostInvoiceItem - Create an invoice item
  • PostInvoiceRecalculation - Recalculate an invoice
  • PostInvoiceReissuance - Reissue an invoice
  • PostInvoiceTransaction - Apply a transaction to an invoice
  • PostInvoiceVoid - Void an invoice
  • PutInvoice - Upsert an invoice
  • PutInvoiceItem - Update an invoice item
  • DeleteInvoiceItem - Delete an invoice item

Invoices timeline

  • GetInvoiceTimelineCollection - Retrieve invoice timeline messages
  • GetInvoiceTimeline - Retrieve an invoice timeline message
  • PostInvoiceTimeline - Create an invoice timeline comment
  • DeleteInvoiceTimeline - Delete an invoice timeline message

Journal

  • GetJournalAccountCollection - Retrieve journal accounts
  • GetJournalEntryCollection - Retrieve journal entries
  • GetJournalRecordCollection - Retrieve journal records
  • GetJournalAccount - Retrieve journal account
  • GetJournalEntry - Retrieve journal entry
  • GetJournalRecord - Retrieve journal record
  • PostJournalAccount - Create a journal account
  • PostJournalEntry - Create a journal entry
  • PostJournalRecord - Create a journal record
  • PutJournalAccount - Upsert a journal account
  • PutJournalEntry - Upsert a journal entry
  • PutJournalRecord - Upsert a journal record
  • DeleteJournalRecord - Delete a journal record

KYC documents

  • GetKycDocumentCollection - Retrieve KYC documents
  • GetKycRequestCollection - Retrieve KYC requests
  • GetKycDocument - Retrieve a KYC document
  • GetKycRequest - Retrieve a KYC request
  • GetKycSettings - Retrieve KYC settings
  • PostKycDocument - Create 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
  • PostKycRequest - Create a KYC request
  • PutKycDocument - Upsert a KYC document
  • PutKycSettings - Update KYC settings
  • PatchKycRequest - Update a KYC request
  • DeleteKycRequest - Delete the KYC request

Lists

  • GetListCollection - Retrieve lists
  • GetList - Retrieve latest list version
  • GetListVersion - Retrieve specific list version
  • PostList - Create a list
  • PutList - Upsert a list
  • DeleteList - Delete a list

Memberships

  • GetMembershipCollection - Retrieve memberships
  • GetMembership - Retrieve a membership
  • PutMembership - Upsert membership
  • DeleteMembership - Delete a membership

Metadata

  • GetPaymentGatewayMetadataCollection - Retrieve payment gateway metadata
  • GetPaymentMethodCollection - Retrieve payment method metadata
  • GetPaymentGatewayMetadata - Retrieve payment gateway metadata
  • GetPaymentMethod - Retrieve metadata of a payment method

Orders

  • GetSubscriptionCancellationCollection - Retrieve subscription order cancellations
  • GetSubscriptionCollection - Retrieve orders
  • GetSubscriptionPauseCollection - Retrieve subscription order pauses
  • GetSubscriptionReactivationCollection - Retrieve subscription order reactivations
  • GetSubscriptionUpcomingInvoiceCollection - Retrieve upcoming subscription order invoice
  • GetSubscription - Retrieve an order
  • GetSubscriptionCancellation - Retrieve a subscription order cancellation
  • GetSubscriptionPause - Retrieve a subscription order pause
  • GetSubscriptionReactivation - Retrieve a subscription order reactivation
  • GetSubscriptionSummaryMetricReport - Retrieve subscription order summary metrics
  • GetSubscriptionUpcomingInvoice - Retrieve an upcoming subscription order invoice
  • PostPreviewOrder - Preview an order
  • PostSubscription - Create an order
  • PostSubscriptionCancellation - Cancel a subscription order
  • PostSubscriptionInterimInvoice - Issue an interim invoice
  • PostSubscriptionItemsChange - Change subscription order items
  • PostSubscriptionPause - Pause a subscription order
  • PostSubscriptionReactivation - Reactivate a subscription order
  • PostSubscriptionUpcomingInvoiceIssuance - Issue an upcoming invoice for early pay
  • PostSubscriptionVoid - Void a subscription order
  • PostUpcomingInvoiceIssuance - Issue a specific upcoming invoice for early pay
  • PutSubscription - Upsert an order
  • PutSubscriptionCancellation - Upsert a subscription order cancellation
  • PutSubscriptionPause - Update a subscription order pause
  • PatchSubscriptionCancellation - Update a subscription order cancellation
  • PatchSubscriptionItem - Update a subscription order item
  • DeleteSubscription - Delete a pending order
  • DeleteSubscriptionCancellation - Delete a subscription order cancellation
  • DeleteSubscriptionPause - Delete a subscription order pause

Orders experimental

  • GetOrderCancellationCollection - Retrieve order cancellation collection
  • GetOrderCollection - Retrieve orders
  • GetOrderPauseCollection - Retrieve order pauses
  • GetOrderReactivationCollection - Retrieve order reactivations
  • GetOrder - Retrieve an order
  • GetOrderCancellation - Retrieve an order cancellation
  • GetOrderPause - Retrieve an order pause
  • GetOrderReactivation - Retrieve an order reactivation
  • GetOrderUpcomingInvoice - Retrieve an upcoming order invoice
  • PostOrder - Create an order
  • PostOrderCancellation - Cancel an order
  • PostOrderInterimInvoice - Issue an interim invoice
  • PostOrderItemsChange - Change order items
  • PostOrderPause - Pause an order
  • PostOrderReactivation - Reactivate an order
  • PostOrderUpcomingInvoiceIssuance - Issue an upcoming invoice for early pay
  • PostOrderVoid - Void an order
  • PutOrder - Upsert an order
  • PutOrderCancellation - Upsert an order cancellation
  • PutOrderPause - Update an order pause
  • PatchOrderCancellation - Update an order cancellation
  • PatchOrderItem - Update an order item
  • DeleteOrderCancellation - Delete an order cancellation
  • DeleteOrderPause - Delete an order pause

Orders timeline

  • GetSubscriptionTimelineCollection - Retrieve order timeline messages
  • GetSubscriptionTimeline - Retrieve an order timeline message
  • PostSubscriptionTimeline - Create an order timeline comment
  • DeleteSubscriptionTimeline - Delete an order timeline message

Organization data exports

  • GetOrganizationExportCollection - Retrieve organization data exports
  • GetOrganizationExport - Retrieve an organization data export request
  • PostOrganizationExport - Request an organization data export

Organizations

  • GetOrganizationCollection - Retrieve organizations
  • GetOrganization - Retrieve an organization
  • PostOrganization - Create an organization
  • PatchOrganization - Update an organization

Payment instruments

  • GetPaymentCardBankNameCollection - Retrieve payment card issuing bank names
  • GetPaymentInstrumentCollection - Retrieve payment instruments
  • GetPaymentInstrument - Retrieve a payment instrument
  • PostPaymentInstrument - Create a payment instrument
  • PostPaymentInstrumentDeactivation - Deactivate a payment instrument
  • PostPaymentInstrumentNameInquiry - Verify name on a payment instrument
  • PatchPaymentInstrument - Update payment instrument

Payment tokens

  • GetTokenCollection - Retrieve tokens
  • GetToken - Retrieve a token
  • PostDigitalWalletValidation - Validate a digital wallet session
  • PostToken - Create a payment token

Plans

  • GetPlanCollection - Retrieve plans
  • GetPlan - Retrieve a plan
  • PostPlan - Create a plan
  • PutPlan - Upsert a plan
  • DeletePlan - Delete a plan

Products

  • GetProductCollection - Retrieve products
  • GetProduct - Retrieve a product
  • PostProduct - Create a product
  • PutProduct - Upsert a product
  • DeleteProduct - Delete a product

Profile

  • GetProfile - Retrieve user's own profile
  • GetProfileMfa - Retrieve user MFA status
  • PostPermissionsEmulation - Start permissions emulation
  • PostProfileMfa - Update user MFA
  • PutProfile - Update a user profile
  • DeletePermissionsEmulation - Stop permissions emulation
  • DeleteProfileMfa - Delete user MFA

Quotes

  • GetQuoteCollection - Retrieve quotes
  • GetQuote - Retrieve a quote
  • PostQuote - Create a quote
  • PostQuoteAcceptance - Accept a quote
  • PostQuoteCancellation - Cancel a quote
  • PostQuoteIssuance - Issue a quote
  • PostQuoteRecall - Recall a quote
  • PostQuoteRejection - Reject a quote
  • PutQuote - Upsert a quote
  • PatchQuote - Partially update a quote

Quotes timeline

  • GetQuoteTimelineCollection - Retrieve quote timeline messages
  • GetQuoteTimeline - Retrieve a quote timeline message
  • PostQuoteTimeline - Create a quote timeline comment
  • DeleteQuoteTimeline - Delete a quote timeline message

Reports

  • GetAmlAuditReport - Retrieve an AML audit report
  • GetAmlCheckReport - Retrieve an AML checks report
  • GetAmlInheritedMatchSummaryReport - Retrieve AML inherited-match report
  • GetAnnualRecurringRevenueReport - Retrieve an ARR report
  • GetApiLogSummaryReport - Retrieve an API log summary 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
  • 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
  • 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
  • GetTransactionReport - Retrieve a transactions report
  • GetTransactionTimeDisputeReport - Retrieve a transaction time dispute report
  • GetTriggeredEventReport - Retrieve events triggered summary report
  • GetTriggeredEventRuleReport - Retrieve a rules matched summary report

Reset password

  • PostForgotPasswordRequest - Request a password reset

Risk score

  • GetRiskScoreBlocklistRules - Retrieve risk score blocklist rules
  • GetRiskScoreRules - Retrieve risk score rules
  • PutRiskScoreBlocklistRules - Modify risk score blocklist rules
  • PutRiskScoreRules - Modify risk score rules

Roles

  • GetRoleCollection - Retrieve roles
  • GetRole - Retrieve a role
  • PostRole - Create a role
  • PutRole - Create a role with ID
  • DeleteRole - Delete a role

Rules

  • GetEventCollection - Retrieve system events
  • GetEventRuleCollection - Retrieve event rules
  • GetEventRuleHistoryCollection - Retrieve change history of a ruleset
  • GetEventRuleSetDraftCollection - Retrieve draft rulesets
  • GetEvent - Retrieve event information
  • GetEventRuleHistory - Retrieve change history record of a ruleset
  • GetEventRuleSetDraft - Retrieve a draft ruleset
  • GetEventRuleVersion - Retrieve a version of a ruleset
  • PostEventRuleSetDraft - Create a draft ruleset
  • PostPreviewRuleActionEmailSending - Send a test email
  • PutEventRule - Update event rules
  • PutEventRuleSetDraft - Update a draft ruleset
  • DeleteEventRuleSetDraft - Delete a draft ruleset

Rules timeline

  • GetRuleSetCollection - Retrieve rules engine timeline messages
  • GetRuleSetTimeline - Retrieve a rules engine timeline message
  • PostRuleSetTimeline - Create a rules engine timeline comment
  • DeleteRuleSetTimeline - Delete a rules engine timeline message
  • GetSearch - Search merchant data

Segments

  • GetGridSegmentCollection - Retrieve a user's segments
  • GetGridSegment - Retrieve a segment
  • PostGridSegment - Create a new UI segment
  • PutGridSegment - Update a segment
  • DeleteGridSegment - Delete a segment

Service credentials

  • GetServiceCredentialCollection - Retrieve service credentials
  • GetServiceCredentialItemCollection - List credential root items
  • GetServiceCredential - Retrieve a service credential
  • PostServiceCredential - Create a service credential
  • PatchServiceCredential - Update a service credential

Shipping rates

  • GetShippingRateCollection - Retrieve shipping rates
  • GetShippingRate - Retrieve a shipping rate
  • PostShippingRate - Create a shipping rate
  • PutShippingRate - Create a shipping rate with ID
  • DeleteShippingRate - Delete a shipping rate

Status

  • GetStatus - Retrieve API current status

Storefront KYC documents

  • StorefrontGetKycDocument - Retrieve a KYC Document
  • StorefrontGetKycLivenessSession - Retrieve a KYC liveness session
  • StorefrontGetKycRequest - Retrieve a KYC request
  • StorefrontPatchKycDocument - Update a KYC document
  • StorefrontPostKycDocument - Create a KYC document
  • StorefrontPostKycLivenessSession - Create a KYC liveness session
  • StorefrontPostKycLivenessSessionFinish - Finish KYC liveness session

Storefront account

  • StorefrontGetAccount - Retrieve account
  • StorefrontPatchAccount - Update account
  • StorefrontPatchAccountPassword - Change an account password
  • StorefrontPostAccountResendVerification - Resend email verification
  • StorefrontPostAccountVerification - Verify an account email
  • StorefrontPostForgotPassword - Request a password reset
  • StorefrontPostLogin - Create a session with username and password
  • StorefrontPostLogout - Destroys the user's current session
  • StorefrontPostRegister - Register account
  • StorefrontPostResetPassword - Finish password reset

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

  • StorefrontGetDepositRequest - Retrieve a deposit request
  • StorefrontGetDepositStrategy - Retrieve a deposit amount strategy
  • StorefrontPostDeposit - Create a deposit

Storefront invoices

  • StorefrontGetInvoiceCollection - Retrieve invoices
  • StorefrontGetInvoice - Retrieve an invoice
  • StorefrontPatchInvoice - Update an invoice

Storefront orders

  • StorefrontGetOrderCollection - Retrieve orders
  • StorefrontGetOrder - Retrieve an order
  • StorefrontGetOrderUpcomingInvoice - Retrieve an upcoming order invoice
  • StorefrontPatchOrder - Update an order
  • StorefrontPostOrderCancellation - Cancel an order
  • StorefrontPostOrderPause - Pause a subscription order
  • StorefrontPostSubscription - Create a subscription
  • StorefrontPostSubscriptionItemsChange - Change subscription items
  • StorefrontPostSubscriptionReactivation - Reactivate a subscription

Storefront payment instruments

  • StorefrontGetPaymentInstrumentCollection - Retrieve payment instruments
  • StorefrontGetPaymentInstrument - Retrieve a payment instrument
  • StorefrontGetPaymentInstrumentSetup - Retrieve a payment instrument setup transaction
  • StorefrontPatchPaymentInstrument - Update payment instrument
  • StorefrontPostPaymentInstrument - Create a payment instrument
  • StorefrontPostPaymentInstrumentDeactivation - Deactivate a payment instrument
  • 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
  • StorefrontPostPreviewPurchase - Preview a purchase
  • StorefrontPostPurchase - Make 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
  • StorefrontGetTransactionCollection - Retrieve transactions
  • StorefrontGetPayoutRequest - Retrieve a payout request
  • StorefrontGetTransaction - Retrieve a transaction
  • StorefrontGetTransactionDccOffer - Retrieve a transaction DCC offer
  • StorefrontPatchPayoutRequest - Update a payout request
  • StorefrontPatchTransactionDccOffer - Update a transaction DCC offer
  • StorefrontPostKycRequestBypass - Skip a transaction KYC verification
  • StorefrontPostKycRequestContinue - Finish a transaction KYC verification
  • StorefrontPostPayoutRequest - Create a payout request

Storefront websites

  • StorefrontGetWebsite - Retrieve a website

Tags

  • GetTagCollection - Retrieve tags
  • GetTagRuleCollection - Retrieve tags rules list
  • GetTag - Retrieve a tag
  • GetTagRule - Retrieve a tags rule
  • PostTagAmlCheckCollection - Tag a list of AML checks
  • PostTagCustomerCollection - Tag a list of customers
  • PostTagKycDocumentCollection - Tag a list of KYC documents
  • PostTag - Create a tag
  • PostTagAmlCheck - Tag an AML check
  • PostTagCustomer - Tag a customer
  • PostTagKycDocument - Tag a KYC document
  • PostTagRule - Create tags rule
  • PutTagRule - Create a tags rule with specified ID
  • PatchTag - Update a tag
  • DeleteTagAmlCheckCollection - Untag a list of AML checks
  • DeleteTagCustomerCollection - Untag a list of customers
  • DeleteTagKycDocumentCollection - Untag a list of KYC documents
  • DeleteTag - Delete a tag
  • DeleteTagAmlCheck - Untag an AML check
  • DeleteTagCustomer - Untag a customer
  • DeleteTagKycDocument - Untag a KYC document
  • DeleteTagRule - Delete tags rule

Tracking

  • GetTrackingApiCollection - Retrieve API tracking logs
  • GetTrackingListCollection - Retrieve value list changes
  • GetTrackingTaxCollection - Retrieve tax service tracking logs
  • GetTrackingWebhookCollection - Retrieve webhook tracking logs
  • GetTrackingApi - Retrieve an API tracking log
  • GetTrackingTax - Retrieve a tax service tracking log
  • GetTrackingWebhook - Retrieve a webhook tracking log
  • PostTrackingWebhookResendRequest - Schedule a resend webhook attempt

Transactions

  • GetPayoutRequestAllocationCollection - Retrieve payout request allocations
  • GetPayoutRequestBatchCollection - Retrieve payout request batches
  • GetPayoutRequestCollection - Retrieve payout requests
  • GetTransactionCollection - Retrieve transactions
  • GetPayoutRequest - Retrieve a payout request
  • GetPayoutRequestAllocation - Retrieve a payout request allocation
  • GetPayoutRequestBatch - Retrieve a payout request batch
  • GetPayoutRequestBatchPreview - Preview payout request batch results
  • GetPayoutRequestPaymentInstruments - Retrieve associated payment instruments
  • GetTransaction - Retrieve a transaction
  • PostPayout - Create a credit transaction
  • PostPayoutRequest - Create a payout request
  • PostPayoutRequestAllocation - Create a payout request allocation
  • PostPayoutRequestAllocationsProcess - Initiate processing of allocations
  • PostPayoutRequestAutoAllocations - Create automatic payout request allocations
  • PostPayoutRequestBatch - Create a payout request batch
  • PostPayoutRequestBatchApprove - Approve payout requests in a batch
  • PostPayoutRequestBatchAutoAllocate - Allocate batch payout requests automatically
  • PostPayoutRequestBatchBlock - Block batch payout requests
  • PostPayoutRequestBatchUnblock - Unblock payout requests in a batch
  • PostPayoutRequestSplit - Create a payout request split
  • PostPayoutRequestsToBatch - Add requests to a payout request batch
  • PostReadyToPay - Ready to pay
  • PostRemovePayoutRequestsFromBatch - Remove requests from a payout request batch
  • PostTransaction - Create a transaction
  • PostTransactionQuery - Query a transaction
  • PostTransactionRefund - Refund a transaction
  • PostTransactionUpdate - Update a transaction status
  • PutPayoutRequest - Upsert a payout request
  • PatchPayoutRequest - Update a payout request
  • PatchPayoutRequestAllocation - Update allocation status
  • PatchPayoutRequestBatch - Update a payout request batch
  • PatchTransaction - Update a transaction
  • DeletePayoutRequestBatch - Delete a payout request batch

Transactions timeline

  • GetPayoutRequestTimelineCollection - Retrieve payout request timeline messages
  • GetTransactionTimelineCollection - Retrieve transaction timeline messages
  • GetPayoutRequestTimelineMessage - Retrieve a payout request timeline message
  • GetTransactionTimeline - Retrieve a transaction Timeline message
  • PostPayoutRequestTimeline - Create a payout request timeline comment
  • PostTransactionTimeline - Create a transaction timeline comment
  • DeletePayoutRequestTimelineMessage - Delete a payout request timeline message
  • DeleteTransactionTimeline - Delete a transaction timeline message

Usage

  • GetUsageCollection - Retrieve usage records
  • GetUsage - Retrieve a usage record
  • PostUsage - Create a usage record
  • DeleteUsage - Delete a usage record

Users

  • GetUserCollection - Retrieve a list of users
  • GetUser - Retrieve a user
  • GetUserMfa - Retrieve user MFA status
  • PostUser - Create a user
  • PutUser - Upsert a user

Webhooks

  • GetWebhookCollection - Retrieve webhooks
  • GetWebhook - Retrieve a webhook
  • PostPreviewWebhook - Send a test webhook
  • PostWebhook - Create a webhook
  • PutWebhook - Upsert a webhook
  • DeleteWebhook - Delete a webhook

Websites

  • GetWebsiteCollection - Retrieve websites
  • GetWebsite - Retrieve a website
  • PostWebsite - Create a website
  • PutWebsite - Upsert a website
  • DeleteWebsite - Delete a website