LogoLogo
  • GENERAL
    • About Criptan
    • Get started
      • Introduction
      • 1. Activate your account
      • 2. Add funds to your balance
      • 3. Start interacting with the API
    • API
      • Introduction
      • Authentication
        • Auth Transactions and Earn
          • API Reference
        • Auth Business (Criptan Pay)
      • Real-Time API (WebSockets)
        • OHLCV
        • TICKERS
      • Webhooks
        • Transactions and Earn Webhooks
        • Business Webhooks
      • API reference
      • Changelog
    • Developer tools
      • Sandbox
      • Support
      • Feedback
    • Security
  • Transactions
    • General
      • Overview
      • Available exchange
      • Geographic availability
      • Use cases
        • Buy
          • UX example
        • Sell
          • UX example
        • Send crypto
          • UX example
        • Receive crypto
          • UX example
        • Recurring purchases
          • UX example
        • Check history
      • FAQ
    • API Reference
      • Trades
      • Withdrawals
      • Information
  • Earn
    • General
      • Overview
      • Geographic availability
      • Use cases
        • 3, 6, 12 months
          • Make a deposit
            • UX example
          • Set up auto-renew a deposit automatically
            • UX example
        • Flex
          • Make a deposit
            • UX example
          • Make a withdrawal
            • UX example
          • Cancel a withdrawal
            • UX example
          • Set up reinvest or not rewards
            • UX example
        • Flex and 3, 6, 12 months
          • Receiving Rewards
      • FAQ
    • API Reference
  • Business (Criptan Pay)
    • General
      • Business (Criptan Pay)
      • Onboarding
      • Payment Button
      • Charges
      • FAQ
    • API Reference
      • Charge
      • Generate charge receipt
      • Get payment
    • Types CPay definitions
      • BusinessAccount
      • BusinessCharge
Powered by GitBook
On this page
  1. Business (Criptan Pay)
  2. Types CPay definitions

BusinessAccount

Account entity. This is the type that is returned in API responses.

Property
Description
Type
Optional

acceptanceRate

Amount of the acceptance fee (EUR) that a merchant chooses to accept less for each payment

string

Yes

accountStatus

Account status

string: "ACTIVE" | "DELETED" | "NOT_CONFIGURED" | "REJECTED" | "UNDER_REVIEW"

No

userId

User Id

string

No

id

Account Id

string

No

cryptoHoldingPercentage

Percentage (0-100) that indicate how much the charge is converted to fiat:

  • 0 - nothing is sell

  • 100 - all crypto is sell into fiat

string

Yes

branding

Branding values to customize the UI

BusinessAccountBranding

Yes

notificationUrl

notification url to post webhook on charge status changes

string

Yes

apiKeyId

api key used for api usage

string

Yes

secret

secret value to use on webhook

string

Yes

requiresClientData

Flag that indicates if the charge should include client data

Boolean

Yes

Subtypes

BusinessAccountBranding

Property
Description
Type
Optional

accentColor

Customization accent color

string

Yes

bgColor

Customization background color

string

Yes

logoUrl

Shop logo url

string

Yes

shopName

Shop name

string

Yes

PreviousTypes CPay definitionsNextBusinessCharge

Last updated 1 year ago