Skip to main content
OBJECT

​
Fields

​
Organization
​
Acceptor
​
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.
​
Decimal!
required
The unit amount charged on transaction, as part of the allocation rate.
​
Decimal!
required
The decimal used to multiply against the transaction amount to determine the “percentage” portion of the allocation rate.
​
AllocationType!
required
The type of allocation, e.g., Interchange fee, network fee, processor fee, partner fee, partner settlement, acceptor settlement.
​
String!
required
The name of the allocation.
​
String!
required
A detailed description of the allocation.
​
Decimal!
required
The total allocation amount calculated as a percentage of the transaction amount (including taxes), a flat allocation, or a combination of both.
​
ProductPillar!
required
The Tesouro product pillar that this allocation applies to: “Boarding”, “Transaction processing”, “Funding”, “Risk, Compliance, and Dispute management”, or “Reporting”.
​
Date!
required
The date the allocation was applied.
​
DateTime
The date and time that Tesouro received the transaction, in UTC. Formatted as 2024-03-27T02:40:00Z
​
Decimal!
required
The net billable event amount, including any add-ons or deductions.
​
String
The leading digits of the account.
​
String
The final digits of the account.
​
PaymentBrand
The specific payment brand used, e.g., Visa, MasterCard, Discover, American Express, etc.
​
FundingSource
Specifies the source of the customer’s funds , e.g., credit, debit, or pre-paid.
​
String!
required
The total allocation amount’s currency code in ISO 4217 alpha currency code format.
​
String
The allocation’s billable event currency code in ISO 4217 alpha currency code format.
​
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
​
Network
The applicable payment network, e.g., Visa, Mastercard, etc.
​
String
A unique identifier created by the acceptor and assigned to the order placed by the customer.
​
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.
​
UUID
A unique 36 character identifier assigned by Tesouro for every transaction request received.
​
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.
​
Date
The date that Tesouro releases the funds from its bank account to the recipient’s bank account.
​
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.
​
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.
​
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.
​
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.
​
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.
​
UUID
Reference id of item that allocation applies to (Refer to BillingEventSourceType field for referencing type).
​
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.
​
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.