10.3. Report - Enums

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/pgw/doc/axepta-api/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
"axepta API MCP server": {
  "url": "https://bump.sh/pgw/doc/axepta-api/mcp"
}
Close

ReportTaskNameEnum

Report task type:

  • report_csv - Report in CSV format

ReportTypeEnum

Report type:

  • transaction - Basic transaction report
  • transaction_on_payout - Transactions on payout
  • transaction_settled - Settled transactions only

ReportStatusEnum

Report status:

  • new - New, waiting for processing
  • preparing - Preparing data
  • prepared - Data prepared
  • generating - Generating file
  • generated - Report generated and ready
  • error - Error during generation
  • deleted - Report deleted
  • cancelled - Report cancelled

ReportColumnEnum

Available columns (all optional, select as needed):

Quota (Order):

  • quotaUuid - Order UUID
  • quotaStatus - Order status
  • quotaAmount - Order amount
  • quotaPayerFirstName - Payer first name
  • quotaPayerLastName - Payer last name
  • quotaPayerPhone - Payer phone
  • quotaPayerEmail - Payer email

Payer:

  • payerAccountNumber - Payer account number

Transaction:

  • transactionInternalId - Transaction ID
  • transactionType - Transaction type (sale/refund)
  • transactionAmount - Transaction amount
  • transactionMerchantOrderId - Merchant order ID
  • transactionTitle - Transaction title
  • transactionStatus - Transaction status
  • transactionIsPaidOut - Whether paid out
  • transactionSettled - Settlement timestamp
  • transactionCreated - Creation timestamp
  • transactionModified - Modification timestamp
  • transactionRelatedInternalId - Related transaction ID
  • transactionFeeAmount - Fee amount

Payment Method:

  • paymentMethodName - Payment method name
  • paymentMethodCode - Payment method code
  • paymentMethodChannelName - Payment channel name
  • paymentMethodChannelCode - Payment channel code

Service:

  • serviceUuid - Service UUID
  • serviceName - Service name

Currency:

  • currencyIso4217 - ISO 4217 currency code

PaymentMethodCodeEnum

Payment methods:

  • blik - BLIK
  • card - Payment card
  • pbl - Bank transfer (Pay by Link)
  • wallet - E-wallet

TransactionStatusEnum

Transaction statuses:

  • new - New
  • pending - Pending
  • authorized - Authorized
  • submitted_for_settlement - Submitted for settlement
  • settled - Settled
  • rejected - Rejected
  • error - Error
  • cancelled - Cancelled

TransactionTypeEnum

Transaction types:

  • sale - Sale
  • refund - Refund

TransactionPaidOutEnum

Payout status:

  • payout - Fully paid out
  • partial - Partially paid out
  • not_payout - Not paid out

ReportFrequencyEnum

Frequency of generating scheduled reports:

  • day - Daily (report for the previous day)
  • week - Weekly (report for the previous week)
  • month - Monthly (report for the previous month)

Note: Applies only to scheduled reports (planned reports).

LanguageCode

Report language (column headers):

  • EN - English
  • PL - Polish

Timezone

Time zone used for formatting date and time in the report:

  • Location: In the conditions.date.timezone object
  • Format: TZ database (e.g. "Europe/Warsaw", "America/New_York")
  • Default: "Europe/Warsaw"
  • Full list of available zones: TZ database

Formatting (object)

The formatting object contains CSV file formatting settings:

Column Separator (columnSeparator):

  • , (comma)
  • ; (semicolon)
  • | (vertical bar)
  • \t (tab)

Number Separator (numberSeparator):

  • . (dot)
  • , (comma)