1. Get Earnings

You can use this service to list (with pagination) the earnings of your members defined in Paywall.

Get earnings information by Member Id

GET {{Base Adres}}/api/paywall/marketplace/report/earning/member

Important: To use the Earnings By Member Id service, you must include the apikeypublic and apiclientpublic parameters in the Header section. PaymentAPI Address

Parameter
Type
Compolsory
Description

apikeypublic

string

Yes

Public Key obtained from the merchant panel.

apiclientpublic

string

Yes

Public Client obtained from the merchant panel.

memberid

int

Yes

Member ID information in Paywall

start

int

Yes

Start value

length

int

Yes

Number of records you want to retrieve Max: 50

sortvalue

string

Yes

The value by which sorting is done. Can be "asc" or "desc". If not provided, defaults to "asc".

sortcolumn

string

Yes

The column by which sorting is done. For this service, only the value "Id" is accepted.

datefrom

DateTime

No

Works in alignment with the "ReflectionDate" and represents the start of the date range.

dateto

DateTime

No

Works in alignment with the "ReflectionDate" and represents the end of the date range.

Response returned from the service:

Parameter
Type
Description

ErrorCode

int

Error code. Returns '0' if the operation is successful.

Result

bool

Returns a true or false value. Returns 'true' if the operation is successful.

Message

string

If the operation fails, this is the message describing the error, supporting localization based on the locale parameter.

Body

object

Detailed information about the transaction

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Data": [
            {
                "Id": 2472,
                "IsSubMerchant": true,
                "PaymentId": 1785842,
                "ProductId": 2218487,
                "CurrencyId": 1,
                "Currency": "TRY",
                "CalculationCommissionType": 1,
                "CalculationCommission": 12.00,
                "Earning": 0.88,
                "MarketPlaceEarningStatusId": 1,
                "MarketPlaceEarningStatus": "Hesaplandı",
                "MarketPlaceEarningTransactionId": 0,
                "ReflectionDate": "2024-02-10T00:00:00",
                "CalculationDateTime": "2024-01-25T14:59:21.0342382"
            },
            {
                "Id": 2470,
                "IsSubMerchant": true,
                "PaymentId": 1785841,
                "ProductId": 2218486,
                "CurrencyId": 1,
                "Currency": "TRY",
                "CalculationCommissionType": 1,
                "CalculationCommission": 12.00,
                "Earning": 0.88,
                "MarketPlaceEarningStatusId": 1,
                "MarketPlaceEarningStatus": "Hesaplandı",
                "MarketPlaceEarningTransactionId": 0,
                "ReflectionDate": "2024-02-10T00:00:00",
                "CalculationDateTime": "2024-01-25T14:58:06.1795818"
            },
            {
                "Id": 2469,
                "IsSubMerchant": true,
                "PaymentId": 1785841,
                "ProductId": 2218485,
                "CurrencyId": 1,
                "Currency": "TRY",
                "CalculationCommissionType": 1,
                "CalculationCommission": 12.00,
                "Earning": 0.88,
                "MarketPlaceEarningStatusId": 1,
                "MarketPlaceEarningStatus": "Hesaplandı",
                "MarketPlaceEarningTransactionId": 0,
                "ReflectionDate": "2024-02-10T00:00:00",
                "CalculationDateTime": "2024-01-25T14:58:06.1795818"
            },
            {
                "Id": 2468,
                "IsSubMerchant": true,
                "PaymentId": 1785841,
                "ProductId": 2218484,
                "CurrencyId": 1,
                "Currency": "TRY",
                "CalculationCommissionType": 1,
                "CalculationCommission": 12.00,
                "Earning": 0.88,
                "MarketPlaceEarningStatusId": 1,
                "MarketPlaceEarningStatus": "Hesaplandı",
                "MarketPlaceEarningTransactionId": 0,
                "ReflectionDate": "2024-02-10T00:00:00",
                "CalculationDateTime": "2024-01-25T14:58:06.1795818"
            },
            {
                "Id": 2467,
                "IsSubMerchant": true,
                "PaymentId": 1785841,
                "ProductId": 2218483,
                "CurrencyId": 1,
                "Currency": "TRY",
                "CalculationCommissionType": 1,
                "CalculationCommission": 12.00,
                "Earning": 0.88,
                "MarketPlaceEarningStatusId": 1,
                "MarketPlaceEarningStatus": "Hesaplandı",
                "MarketPlaceEarningTransactionId": 0,
                "ReflectionDate": "2024-02-10T00:00:00",
                "CalculationDateTime": "2024-01-25T14:58:06.1795818"
            },
            {
                "Id": 2466,
                "IsSubMerchant": true,
                "PaymentId": 1785841,
                "ProductId": 2218482,
                "CurrencyId": 1,
                "Currency": "TRY",
                "CalculationCommissionType": 1,
                "CalculationCommission": 12.00,
                "Earning": 0.88,
                "MarketPlaceEarningStatusId": 4,
                "MarketPlaceEarningStatus": "Ödeme Başarılı",
                "MarketPlaceEarningTransactionId": 2291912,
                "ReflectionDate": "2024-02-10T00:00:00",
                "CalculationDateTime": "2024-01-25T14:58:06.1795818"
            },
            {
                "Id": 2464,
                "IsSubMerchant": true,
                "PaymentId": 1785663,
                "ProductId": 2218225,
                "CurrencyId": 1,
                "Currency": "TRY",
                "CalculationCommissionType": 2,
                "CalculationCommission": 36.00,
                "Earning": 4.48,
                "MarketPlaceEarningStatusId": 12,
                "MarketPlaceEarningStatus": "Tekrar Dene",
                "MarketPlaceEarningTransactionId": 0,
                "ReflectionDate": "2024-02-19T00:00:00",
                "CalculationDateTime": "2024-01-22T18:14:52.631701"
            }
        ],
        "TotalRecord": 7
    }
}

Last updated