allocations

query Allocations($input: FeeInput!) {
  allocations(input: $input) {
    items {
      acceptor {
        allocations
        businessName
        id
        name
        reference
      }
      accountNumberPrefix
      accountNumberSuffix
      activityDate
      allocationCalculatedAmount
      allocationType
      billableEventAmount
      billableEventCurrency
      billableEventType
      billingEventSourceId
      billingEventSourceType
      consumerType
      description
      fundingCurrency
      fundsReleaseDate
      fundsTransferDescriptor
      fundsTransferId
      merchantCategory
      name
      orderReference
      organization {
        allocations
        businessName
        capabilities
        id
        legalName
        name
        phoneNumber
      }
      paymentBrand
      paymentFundingSource
      paymentId
      paymentProduct
      perspective
      presenterId
      processingNetwork
      productPillar
      rateMultiplier
      rateUnitAmount
      transactionDateTime
      transactionId
      transactionReference
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
  }
}

{
  "data": {
    "allocations": {
      "items": [
        {
          "acceptor": {
            "allocations": "example",
            "authorizationSummaries": "example",
            "billingDescriptor": "CLACKSWORTH KEYBOARDS",
            "businessName": "Clacksworth Keyboards",
            "fees": "example",
            "feeSummaries": "example",
            "fundingAchReturns": "example",
            "fundingDisputeEvents": "example",
            "fundingSummaries": "example",
            "fundingTransactions": "example",
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "Ben Torres",
            "paymentTransactions": "example",
            "paymentTransactionSummaries": "example",
            "reference": "example"
          },
          "accountNumberPrefix": "example",
          "accountNumberSuffix": "example",
          "activityDate": "2026-01-15",
          "allocationCalculatedAmount": 0,
          "allocationType": "SETTLEMENT",
          "billableEventAmount": 0,
          "billableEventCurrency": "example",
          "billableEventType": "UNKNOWN",
          "billingEventSourceId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "billingEventSourceType": "TRANSACTION",
          "consumerType": "UNKNOWN",
          "description": "example",
          "fundingCurrency": "example",
          "fundsReleaseDate": "2026-01-15",
          "fundsTransferDescriptor": "example",
          "fundsTransferId": "c9a1e2d3-4b5f-6789-0abc-def123456789",
          "merchantCategory": "example",
          "name": "Ben Torres",
          "orderReference": "example",
          "organization": {
            "acceptorApplicationCounts": [
              "example"
            ],
            "acceptors": "example",
            "achNotificationsOfChange": "example",
            "achReturns": "example",
            "allocations": "example",
            "allowedMerchantCategories": [
              "example"
            ],
            "authorizationSummaries": "example",
            "businessAddress": "example",
            "businessName": "Clacksworth Keyboards",
            "capabilities": [
              "ACQUIRING"
            ],
            "fees": "example",
            "feeSummaries": "example",
            "fundingAchReturns": "example",
            "fundingDisbursementReturns": "example",
            "fundingDisputeEvents": "example",
            "fundingSummaries": "example",
            "fundingTransactions": "example",
            "id": "d8b2f3e4-5c6a-7890-1bcd-ef2345678901",
            "legalName": "example",
            "name": "Ben Torres",
            "paymentTransactions": "example",
            "paymentTransactionSummaries": "example",
            "phoneNumber": "example",
            "reportAvailability": [
              "example"
            ],
            "settings": "example"
          },
          "paymentBrand": "VISA",
          "paymentFundingSource": "UNKNOWN",
          "paymentId": "e7c3a4b5-6d7e-8901-2cde-f34567890123",
          "paymentProduct": "example",
          "perspective": "PARTNER",
          "presenterId": "b6d4e5f6-7a8b-9012-3def-456789012345",
          "processingNetwork": "VISA",
          "productPillar": "BOARDING",
          "rateMultiplier": 0,
          "rateUnitAmount": 0,
          "transactionDateTime": "2026-01-15T14:30:00Z",
          "transactionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "transactionReference": "example"
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

query Allocations($input: FeeInput!) {
  allocations(input: $input) {
    items {
      acceptor {
        allocations
        businessName
        id
        name
        reference
      }
      accountNumberPrefix
      accountNumberSuffix
      activityDate
      allocationCalculatedAmount
      allocationType
      billableEventAmount
      billableEventCurrency
      billableEventType
      billingEventSourceId
      billingEventSourceType
      consumerType
      description
      fundingCurrency
      fundsReleaseDate
      fundsTransferDescriptor
      fundsTransferId
      merchantCategory
      name
      orderReference
      organization {
        allocations
        businessName
        capabilities
        id
        legalName
        name
        phoneNumber
      }
      paymentBrand
      paymentFundingSource
      paymentId
      paymentProduct
      perspective
      presenterId
      processingNetwork
      productPillar
      rateMultiplier
      rateUnitAmount
      transactionDateTime
      transactionId
      transactionReference
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
  }
}

{
  "data": {
    "allocations": {
      "items": [
        {
          "acceptor": {
            "allocations": "example",
            "authorizationSummaries": "example",
            "billingDescriptor": "CLACKSWORTH KEYBOARDS",
            "businessName": "Clacksworth Keyboards",
            "fees": "example",
            "feeSummaries": "example",
            "fundingAchReturns": "example",
            "fundingDisputeEvents": "example",
            "fundingSummaries": "example",
            "fundingTransactions": "example",
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "Ben Torres",
            "paymentTransactions": "example",
            "paymentTransactionSummaries": "example",
            "reference": "example"
          },
          "accountNumberPrefix": "example",
          "accountNumberSuffix": "example",
          "activityDate": "2026-01-15",
          "allocationCalculatedAmount": 0,
          "allocationType": "SETTLEMENT",
          "billableEventAmount": 0,
          "billableEventCurrency": "example",
          "billableEventType": "UNKNOWN",
          "billingEventSourceId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "billingEventSourceType": "TRANSACTION",
          "consumerType": "UNKNOWN",
          "description": "example",
          "fundingCurrency": "example",
          "fundsReleaseDate": "2026-01-15",
          "fundsTransferDescriptor": "example",
          "fundsTransferId": "c9a1e2d3-4b5f-6789-0abc-def123456789",
          "merchantCategory": "example",
          "name": "Ben Torres",
          "orderReference": "example",
          "organization": {
            "acceptorApplicationCounts": [
              "example"
            ],
            "acceptors": "example",
            "achNotificationsOfChange": "example",
            "achReturns": "example",
            "allocations": "example",
            "allowedMerchantCategories": [
              "example"
            ],
            "authorizationSummaries": "example",
            "businessAddress": "example",
            "businessName": "Clacksworth Keyboards",
            "capabilities": [
              "ACQUIRING"
            ],
            "fees": "example",
            "feeSummaries": "example",
            "fundingAchReturns": "example",
            "fundingDisbursementReturns": "example",
            "fundingDisputeEvents": "example",
            "fundingSummaries": "example",
            "fundingTransactions": "example",
            "id": "d8b2f3e4-5c6a-7890-1bcd-ef2345678901",
            "legalName": "example",
            "name": "Ben Torres",
            "paymentTransactions": "example",
            "paymentTransactionSummaries": "example",
            "phoneNumber": "example",
            "reportAvailability": [
              "example"
            ],
            "settings": "example"
          },
          "paymentBrand": "VISA",
          "paymentFundingSource": "UNKNOWN",
          "paymentId": "e7c3a4b5-6d7e-8901-2cde-f34567890123",
          "paymentProduct": "example",
          "perspective": "PARTNER",
          "presenterId": "b6d4e5f6-7a8b-9012-3def-456789012345",
          "processingNetwork": "VISA",
          "productPillar": "BOARDING",
          "rateMultiplier": 0,
          "rateUnitAmount": 0,
          "transactionDateTime": "2026-01-15T14:30:00Z",
          "transactionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "transactionReference": "example"
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Query

Arguments

input

FeeInput!

required

Show child attributes

paging

PagingInput!

required

See PagingInput

where

FeeFilterInput!

required

See FeeFilterInput

Return type

AllocationDetailCollection

items

[AllocationDetail!]!

required

Show child attributes

acceptor

Acceptor

See Acceptor

accountNumberPrefix

String

The leading digits of the account.

accountNumberSuffix

String

The final digits of the account.

activityDate

Date!

required

The date the allocation was applied.

allocationCalculatedAmount

Decimal!

required

The total allocation amount calculated as a percentage of the transaction amount (including taxes), a flat allocation, or a combination of both.

allocationType

AllocationType!

required

The type of allocation, e.g., Interchange fee, network fee, processor fee, partner fee, partner settlement, acceptor settlement.See AllocationType

billableEventAmount

Decimal!

required

The net billable event amount, including any add-ons or deductions.

billableEventCurrency

String

The allocation’s billable event currency code in ISO 4217 alpha currency code format.

billableEventType

BillableType

The type of billable event, including, but not limited to: Authorization, Capture, Refund, Reversal, Authentication, Dispute, Funds transfer, Misc. adjustment, Token, Account updater, AVS verification, etc.See BillableType

billingEventSourceId

UUID

Reference id of item that allocation applies to (Refer to BillingEventSourceType field for referencing type).

billingEventSourceType

BillingEventSourceType

The type of entity that the billing event source id references, including, but not limited to: Transaction, Funds Transfer, Boarding Request, Acceptor, ACH Return, ACH Notice Of Change, Dispute.See BillingEventSourceType

consumerType

ConsumerType

Specifies the type of account associated with the cardholder’s card, e.g., Consumer, Commercial, Government, etc., which has an impact on the interchange qualification. NOTE: This field will present a null, not applicable, or empty value if the allocation is not tied to a specific transaction.See ConsumerType

description

String!

required

A detailed description of the allocation.

fundingCurrency

String!

required

The total allocation amount’s currency code in ISO 4217 alpha currency code format.

fundsReleaseDate

Date

The date that Tesouro releases the funds from its bank account to the recipient’s bank account.

fundsTransferDescriptor

String

A value created by Tesouro and sent with the funds transfer to the recipient’s bank for display on the bank statement. It includes information on who sent the money and the purpose of the payment. The recipient can use this value to help with bank and transaction reconciliation.

fundsTransferId

UUID

A unique identifier created by Tesouro and assigned to the transfer of money to a bank account, that identifies a cohort of funded transactions making up the transfer.

merchantCategory

String

Unique ISO four digit values used to classify merchants and their transactions into specific categories based on the type of business, trade or services supplied. https://www.iso.org/standard/79450.html

name

String!

required

The name of the allocation.

orderReference

String

A unique identifier created by the acceptor and assigned to the order placed by the customer.

organization

Organization

See Organization

paymentBrand

PaymentBrand

The specific payment brand used, e.g., Visa, MasterCard, Discover, American Express, etc.See PaymentBrand

paymentFundingSource

FundingSource

Specifies the source of the customer’s funds , e.g., credit, debit, or pre-paid.See FundingSource

paymentId

UUID

A unique 36 character identifier created by Tesouro and assigned to a group of transactions in the same payment request cohort. e.g., An authorization request, incremental authorization request, and the final capture would have the same paymentID. NOTE: This field will present a null, not applicable, or empty value if the allocation is not tied to a specific transaction.

paymentProduct

String

The product name according to the payment brand (e.g. World Elite Mastercard card) NOTE: This field will present a null, not applicable, or empty value if the allocation is not tied to a specific transaction.

perspective

Perspective

The perspective of the allocation, which can be either ‘Acceptor’ or ‘Partner’. This field is used to determine the perspective from which the allocation is reported.See Perspective

presenterId

UUID

A unique, 36 character identifier created by Tesouro and assigned to the machine user or system entity that is credentialed to make API requests and present payments to Tesouro and the network.

processingNetwork

Network

The applicable payment network, e.g., Visa, Mastercard, etc.See Network

productPillar

ProductPillar!

required

The Tesouro product pillar that this allocation applies to: “Boarding”, “Transaction processing”, “Funding”, “Risk, Compliance, and Dispute management”, or “Reporting”.See ProductPillar

rateMultiplier

Decimal!

required

The decimal used to multiply against the transaction amount to determine the “percentage” portion of the allocation rate.

rateUnitAmount

Decimal!

required

The unit amount charged on transaction, as part of the allocation rate.

transactionDateTime

DateTime

The date and time that Tesouro received the transaction, in UTC. Formatted as 2024-03-27T02:40:00Z

transactionId

UUID

A unique 36 character identifier assigned by Tesouro for every transaction request received.

transactionReference

String

A unique identifier created by the entity holding the direct relationship with the Acceptor, and used by that entity for reconciliation and transaction search. Tesouro uses this identifier to manage idempotency.

pageInfo

PageInfo!

required

Show child attributes

hasNextPage

Boolean!

required

hasPreviousPage

Boolean!

required

query Allocations($input: FeeInput!) {
  allocations(input: $input) {
    items {
      acceptor {
        allocations
        businessName
        id
        name
        reference
      }
      accountNumberPrefix
      accountNumberSuffix
      activityDate
      allocationCalculatedAmount
      allocationType
      billableEventAmount
      billableEventCurrency
      billableEventType
      billingEventSourceId
      billingEventSourceType
      consumerType
      description
      fundingCurrency
      fundsReleaseDate
      fundsTransferDescriptor
      fundsTransferId
      merchantCategory
      name
      orderReference
      organization {
        allocations
        businessName
        capabilities
        id
        legalName
        name
        phoneNumber
      }
      paymentBrand
      paymentFundingSource
      paymentId
      paymentProduct
      perspective
      presenterId
      processingNetwork
      productPillar
      rateMultiplier
      rateUnitAmount
      transactionDateTime
      transactionId
      transactionReference
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
  }
}

{
  "data": {
    "allocations": {
      "items": [
        {
          "acceptor": {
            "allocations": "example",
            "authorizationSummaries": "example",
            "billingDescriptor": "CLACKSWORTH KEYBOARDS",
            "businessName": "Clacksworth Keyboards",
            "fees": "example",
            "feeSummaries": "example",
            "fundingAchReturns": "example",
            "fundingDisputeEvents": "example",
            "fundingSummaries": "example",
            "fundingTransactions": "example",
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "Ben Torres",
            "paymentTransactions": "example",
            "paymentTransactionSummaries": "example",
            "reference": "example"
          },
          "accountNumberPrefix": "example",
          "accountNumberSuffix": "example",
          "activityDate": "2026-01-15",
          "allocationCalculatedAmount": 0,
          "allocationType": "SETTLEMENT",
          "billableEventAmount": 0,
          "billableEventCurrency": "example",
          "billableEventType": "UNKNOWN",
          "billingEventSourceId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "billingEventSourceType": "TRANSACTION",
          "consumerType": "UNKNOWN",
          "description": "example",
          "fundingCurrency": "example",
          "fundsReleaseDate": "2026-01-15",
          "fundsTransferDescriptor": "example",
          "fundsTransferId": "c9a1e2d3-4b5f-6789-0abc-def123456789",
          "merchantCategory": "example",
          "name": "Ben Torres",
          "orderReference": "example",
          "organization": {
            "acceptorApplicationCounts": [
              "example"
            ],
            "acceptors": "example",
            "achNotificationsOfChange": "example",
            "achReturns": "example",
            "allocations": "example",
            "allowedMerchantCategories": [
              "example"
            ],
            "authorizationSummaries": "example",
            "businessAddress": "example",
            "businessName": "Clacksworth Keyboards",
            "capabilities": [
              "ACQUIRING"
            ],
            "fees": "example",
            "feeSummaries": "example",
            "fundingAchReturns": "example",
            "fundingDisbursementReturns": "example",
            "fundingDisputeEvents": "example",
            "fundingSummaries": "example",
            "fundingTransactions": "example",
            "id": "d8b2f3e4-5c6a-7890-1bcd-ef2345678901",
            "legalName": "example",
            "name": "Ben Torres",
            "paymentTransactions": "example",
            "paymentTransactionSummaries": "example",
            "phoneNumber": "example",
            "reportAvailability": [
              "example"
            ],
            "settings": "example"
          },
          "paymentBrand": "VISA",
          "paymentFundingSource": "UNKNOWN",
          "paymentId": "e7c3a4b5-6d7e-8901-2cde-f34567890123",
          "paymentProduct": "example",
          "perspective": "PARTNER",
          "presenterId": "b6d4e5f6-7a8b-9012-3def-456789012345",
          "processingNetwork": "VISA",
          "productPillar": "BOARDING",
          "rateMultiplier": 0,
          "rateUnitAmount": 0,
          "transactionDateTime": "2026-01-15T14:30:00Z",
          "transactionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "transactionReference": "example"
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

ACH returns Async report

⌘I

Boarding

Transaction Processing

Risk, Compliance & Dispute Management

Reporting

Types

Arguments

Return type

Boarding

Transaction Processing

Risk, Compliance & Dispute Management

Reporting

Types

​Arguments

​Return type

Arguments

Return type