Revision as of 14:14, 21 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.

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.
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.

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.
CardUsed	Card	The details of the payment card used for the payment transaction.
BlockedAmount	decimal	The amount that was blocked by Barion.

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.
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.
CardUsed	Card	The details of the payment card used for the payment transaction.
FraudScore	decimal	Indicating whether the transaction that this history item is representing has a chance to be a fraud.
TopUpAuthorizationCode	string	The authorization code received by the card processing system when executing the payment.

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.
PaymentId	Guid	The identifier of the payment transaction.

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.
CardUsed	Card	The details of the payment card used for the payment transaction.
FraudScore	decimal	Indicating whether the transaction that this history item is representing has a chance to be a fraud.
TopUpAuthorizationCode	string	The authorization code received by the card processing system when executing the payment.
AmountCharged	decimal	The amount that was charged from the bank card and credited to the user's wallet.
Fee	decimal	The fee was paid by the user to the Barion.

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.
Fee	decimal	The fee was paid by the user to the Barion.
TopUpComment	string	The comment of the wire transfer.

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.
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.

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.
WasClaimed	bool	True if the recipient claimed the transaction amount. Otherwise, false.
ResolvedAt	DateTime	The exact time when the recipient claimed the transaction amount.

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.
PaymentId	Guid	The identifier of the payment transaction.

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.
PaymentId	Guid	The identifier of the payment transaction.

RefundToBankAccount

Refund from the e-shop's wallet to the customer's bank account.

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.
OriginalPaymentId	Guid	The identifier of the payment transaction.

RefundToCard

Refund from the e-shop's wallet to the customer's bank card.

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.
OriginalPaymentId	Guid	The identifier of the payment transaction.
ToCard	Card	The details of the payment card used for the payment transaction.

RefundToWallet

Refund from the e-shop's wallet to the customer's wallet.

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.

RejectedWithdraw

The wire transfer was unsuccessful. In this case, Barion returns the wire transfer amount to the user's wallet.

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

The wire transfer was unsuccessful. In this case, Barion returns the wire transfer fee to the user's wallet.

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

The previously blocked amount is credited to the user's wallet.

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.
CardUsed	Card	The details of the payment card used for the payment transaction.
ReleasedAmount	decimal	The amount that was released by Barion.

UnsuccessfulRefundToBankAccount

It is an unsuccessful refund to a bank account, the amount is credited to the wallet.

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.
OriginalPaymentId	Guid	The identifier of the payment transaction.

UnsuccessfulRefundToCard

Unsuccessful refund to the source bank card, the amount is credited to the wallet.

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.
OriginalPaymentId	Guid	The identifier of the payment transaction.
ToCard	Card	The details of the payment card used for the payment transaction.

UnsuccessfulTransfer

Unsuccessful e-money transfer to a non-existent user. The recipient did not claim the amount, so it was credited to the source wallet.

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

Unsuccessful wire transfers from the wallet to the outside of the system. The amount of the transaction is credited to the user's balance.

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

Wallet top-up transactions that are completed via wire transfer.

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.
FromAccount	BankAccountInformation	The details of the source bank account.
WireComment	string	The comment of the wire transfer.

Withdraw

Wire transfers from the wallet to the outside of the system.

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.
ToAccount	BankAccountInformation	The details of the destination bank account.
Comment	string	The comment of the wire transfer.
Fee	decimal	The fee was paid by the user to the Barion.

WithdrawFee

The fee that is paid by the user to Barion after wire transfers outside of the system.

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

The structures listed here can be referenced by the detailers.

Purchased item

Property name	Property type	Description
Name	string	The name of the purchased item.
Description	string	Description about the item.
Quantity	decimal	The quantity of the purchased items.
Unit	decimal	The unit is the standard measure of the quantity.
UnitPrice	decimal	The unit price shows the price of the smallest unit.
ItemTotal	decimal	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.

Bank account information

Property name	Property type	Description
BankAccountNumber	string	The bank account number. It contains the full bank account number without formatting.
BankAccountOwner	string	The owner of the bank account.

Card information

Property name	Property type	Description
CardBin	string	The first 6 digits of the bank card number.
CardMaskedPan	string	The last 4 digits of the bank card number.
Type	CardType	The type of bank card.
CardSource	CardSource	The source of the bank card.
ValidThru	DateTime	The expiry of the payment card.
CardHolderName	string	The name written on the card.

@@ Line 231: / Line 231: @@
 === RefundToBankAccount ===
+Refund from the e-shop's wallet to the customer's bank account.
 {{TransactionHistoryDetail}}

TransactionHistory-GetDetail-v3: Difference between revisions