4. Fetch by Reference

This service should be used to access record information associated with the specified ExternalReference value.

Identify Wallet Record by WalletOwnerId

GET {{WalletUrl}}/api/v1/wallet/transaction/by/external-reference/5bc276c8-acb5-4cb7-90fe-1d3ff10fbcfb

Note: Before calling this service, you must include the apikeypublic and apiclientpublic parameters in the Header.

WalletAPI Address

The parameters to be sent to the service are as follows:

Parameter
Type
Compolsory
Description

apikeypublic

string

Yes

The public key used for authentication in API access.

apiclientpublic

string

Yes

The public client key that indicates which client the request originates from.

{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": [
        {
            "Id": "e1e2f263-7c0c-4997-a6c9-3e70de4ebda5",
            "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
            "Alias": "2816220769",
            "TransactionType": "Deposit",
            "Amount": 100000.00,
            "GiftAmount": null,
            "Description": "string",
            "ExternalReference": "5bc276c8-acb5-4cb7-90fe-1d3ff10fbcfb",
            "CreatedAt": "2025-08-20T11:56:17.206107Z",
            "UpdatedAt": null,
            "BalanceAfterTransaction": 100000.80,
            "BlockedBalanceAfterTransaction": 0.00,
            "AvailableBalanceAfterTransaction": 100000.80,
            "GiftBalanceBalanceAfterTransaction": 0.00,
            "CurrencyCode": "TRY",
            "SourceWalletId": null,
            "DestinationWalletId": null,
            "GiftBalanceId": null,
            "MainTransactionId": null,
            "UniqueCode": "bdf7ab45-2437-4f3b-ab56-5402f1c69654",
            "UsedGiftBalances": null,
            "CashbackAmount": 0
        }
    ]
}

Service Response

Parameter
Type
Description

IsFailure

bool

A boolean value indicating whether the related service operation has failed

IsSuccess

bool

Indicates whether the service has been completed successfully

Errors

Array

Contains the error messages that may occur during the service execution

HasNextPage

bool

Indicates whether there is a next page in pagination

HasPreviousPage

bool

Indicates whether there is a previous page

TotalCount

int

Represents the total number of records queried

TotalPages

int

Indicates how many pages the results are spread across

PageNumber

int

Indicates the current page number being viewed

Items

List

Contains the list of data objects returned within the page

Service Response (Items)

Parameter
Type
Dewcription

Id

Guid

Represents the unique identifier of the record or transaction in the system

WalletId

Guid

The unique ID of the wallet where the related transaction took place

TransactionType

string

Defines the category of the transaction (e.g., payment, refund, transfer)

Amount

decimal

Represents the total amount used within the transaction

GiftAmount

decimal

The amount used from the bonus balance in the transaction

Description

string

A short descriptive field related to the transaction

ExternalReference

string

A reference code defined in an external system

CreatedAt

DateTime

Indicates the timestamp when the transaction was created

UpdatedAt

DateTime

The last updated timestamp of the transaction

BalanceAfterTransaction

decimal

The current remaining wallet balance after the transaction

SourceWalletId

Guid

Indicates the wallet ID from which the funds were deducted

DestinationWalletId

Guid

The wallet ID of the destination where the funds were sent

GiftBalanceId

int

The ID of the bonus balance used in the transaction

MainTransactionId

Guid

The ID of the main (parent) transaction if this transaction is linked

UniqueCode

string

A unique identifier code generated specifically for the transaction

UsedGiftBalances

List

The field where the bonus balances in use are listed

CashbackAmount

decimal

Indicates the cashback amount provided to the user after the transaction

Last updated