TransactionHistory-GetDetail-v3: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
No edit summary
Line 293: Line 293:
|-
|-
| SKU || string || A SKU is a unique code consisting of letters and numbers that identify the characteristics of each product.
| SKU || string || A SKU is a unique code consisting of letters and numbers that identify the characteristics of each product.
|-
|}
=== Marketplace ===
{{api_output_table_header}}
|-
| Name || string || The name of the marketplace.
|-
| PublicKey || Guid|| The public key of the marketplace.
|-
|-
|}
|}

Revision as of 11:44, 20 March 2023

Barion API: transaction history details

GET /v3/TransactionHistory/GetDetail

The /v3/TransactionHistory/GetDetail API endpoint is used to query the details of the specified transaction history element.

Prerequisites before use:

Authentication

Barion Wallet Authentication

Input properties

The input properties should be defined in the query string.

Property name Property type Limitations and constraints Description
ItemId Guid
  • Required
The identifier of the history element.

Input properties

Output properties

Property name Property type Description
DetailInformation custom structure The data structure depends on the history item type. The structures are linked below.


History item structures:

History item type Link to the structure
BankTransferPayment BankTransferPayment structure
BankTransferPaymentFee BankTransferPaymentFee structure
BlockAmount BlockAmount structure
CardPayment CardPayment structure
CardProcessingFee CardProcessingFee structure
CardTopUp CardTopUp structure
CashTopUp CashTopUp structure
Comission Comission structure
Donation Donation structure
ElectronicMoneyPayment ElectronicMoneyPayment structure
ExternalTransfer ExternalTransfer structure
GatewayFee GatewayFee structure
InternalTransfer InternalTransfer structure
IssueFromCustody IssueFromCustody structure
PayeeTransaction PayeeTransaction structure
RefundToBankAccount RefundToBankAccount structure
RefundToCard RefundToCard structure
RefundToWallet RefundToWallet structure
RejectedWithdraw RejectedWithdraw structure
RejectedWithdrawFee RejectedWithdrawFee structure
ReleaseAmount ReleaseAmount structure
UnsuccessfulRefundToBankAccount UnsuccessfulRefundToBankAccount structure
UnsuccessfulRefundToCard UnsuccessfulRefundToCard structure
UnsuccessfulTransfer UnsuccessfulTransfer structure
UnsuccessfulWithdraw UnsuccessfulWithdraw structure
WireTopUp WireTopUp structure
Withdraw Withdraw structure
WithdrawFee WithdrawFee structure

Custom structures

BankTransferPayment

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.
PaymentId Guid The identifier of the payment transaction.
PurchasedItems PurchasedItem The list of the purchased items.
MarketPlace MarketPlace The details of the marketplace where the transaction happened.

BankTransferPaymentFee

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

BlockAmount

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

CardPayment

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

CardProcessingFee

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

CardTopUp

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

CashTopUp

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

Comission

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

Donation

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

ElectronicMoneyPayment

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

ExternalTransfer

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

GatewayFee

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

InternalTransfer

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

IssueFromCustody

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

PayeeTransaction

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

RefundToBankAccount

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

RefundToCard

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

RefundToWallet

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

RejectedWithdraw

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

RejectedWithdrawFee

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

ReleaseAmount

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

UnsuccessfulRefundToBankAccount

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

UnsuccessfulRefundToCard

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

UnsuccessfulTransfer

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

UnsuccessfulWithdraw

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

WireTopUp

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

Withdraw

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

WithdrawFee

Property name Property type Description
HistoryId Guid The identifier of the transaction.
HistoryType HistoryItemType The type of the transaction.
HappenedAtUtc DateTime The exact time when the transaction happened.
SourceAccount UserHistoryParticipant The user who initiated the transaction or from whom the money originated.
TargetAccount UserHistoryParticipant The user who will receive the amount of the transaction.
Amount decimal The amount of the transaction.
Currency string The 3-character ISO 4217 currency code of the payment.
Description string Description of the transaction. Max: 640 characters.
IsInProgress bool This flag indicates that the transaction is not in the final state.

Common structures

Purchased item

Property name Property type Description
Name string The name of the purchased item.
Description string Description about the item.
Quantity number The quantity of the purchased items.
Unit number The unit is the standard measure of the quantity.
UnitPrice number The unit price shows the price of the smallest unit.
ItemTotal number The sum of the unit price for the units.
SKU string A SKU is a unique code consisting of letters and numbers that identify the characteristics of each product.

Marketplace

Property name Property type Description
Name string The name of the marketplace.
PublicKey Guid The public key of the marketplace.