Skip to main content
Object

Fields

id
required
The id of the organization as defined in their profile.
acceptors
businessName
required
The descriptive name for the organization that is different from its legal entity name. Also known as “Doing Business As” (DBA), “trade name”, “assumed name”, or “fictitious name”.
The legal entity name for the organization.
name
required
The descriptive name for the organization that is different from its legal entity name. Also known as “Doing Business As” (DBA), “trade name”, “assumed name”, or “fictitious name”.
allowedMerchantCategories
required
The allowed Merchant Category Codes for acceptors within this organization.
settings
required
Organization settings.
businessAddress
The business address of the organization.
phoneNumber
The phone number of the organization.
achNotificationsOfChange
A Notification of Change (NOC), notifies the sender of an ACH payment that information related to the customer’s bank account was inaccurate or outdated, and provides the updated information that needs to be corrected before another payment can be sent from (or to) the account.
achReturns
An itemized list of ach returns for a given transaction activity date or acticity date.
allocations
An itemized list of applied allocations for a given transaction activity date or funds release date.
authorizationSummaries
A summary of authorizations (counts, amounts) for the given transaction date, grouped by acceptor, transaction currency, response code, and payment brand.
fees
An itemized list of applied fees for a given transaction activity date or funds release date.
feeSummaries
A summary of aggregated fees by acceptor and fee name/program for a specified activity date or funds release date, grouped by fee type, and where applicable, payment brand, product, and funding source.
fundingAchReturns
An itemized list of financially impacting ACH returns occurring on the pertinent funds release dates. Use this report to track ACH return-related money-movements.
fundingDisputeEvents
An itemized list of financially impacting dispute events occuring on the pertinent funds release dates. Use this report to track dispute-related money-movements.
fundingSummaries
A summary of financial activity for a given funds release date or transaction activity date. Use this report to understand financial impact of daily sales, reconcile sales activity to your bank deposits, or drill deeper into the composition of your funding.
fundingTransactions
An itemized list of funded transactions (captures, sales, and refunds) for the selected transaction activity date or funds release date.
reportAvailability
paymentTransactions
A list of payment transaction requests (including conveyed) submitted on the pertinent transaction activity dates. Use this report as an operational tool to reconcile against your internal record of submitted transactions.
paymentTransactionSummaries
A summary of transaction aggregates (counts and amounts, including conveyed transactions) by pertinent transaction type, currency, card brand, and transaction activity date.
acceptorApplicationCounts
required
{
  "id": "72ef289d-77d4-4696-8a08-da83ed15b751",
  "acceptors": AcceptorCollection,
  "businessName": "abc123",
  "legalName": "abc123",
  "name": "xyz789",
  "allowedMerchantCategories": [
    MerchantCategory
  ],
  "settings": OrganizationSettingsOutput,
  "businessAddress": AddressOutput,
  "phoneNumber": "abc123",
  "achNotificationsOfChange": AchNotificationOfChangeCollection,
  "achReturns": AchReturnCollection,
  "allocations": AllocationDetailCollection,
  "authorizationSummaries": AuthorizationSummaryCollection,
  "fees": FeeCollection,
  "feeSummaries": FeeSummaryCollection,
  "fundingAchReturns": FundingAchReturnOutputCollection,
  "fundingDisputeEvents": FundingDisputeEventOutputCollection,
  "fundingSummaries": FundingSummaryCollection,
  "fundingTransactions": FundingTransactionCollection,
  "reportAvailability": [
    ReportAvailability
  ],
  "paymentTransactions": PaymentTransactionCollection,
  "paymentTransactionSummaries": PaymentTransactionSummaryCollection,
  "acceptorApplicationCounts": [
    AcceptorApplicationCounts
  ]
}