2. Payment-Based Earnings

Retrieve payment-based earnings information.

GET {{PaymentBaseAddress}}/api/paywall/marketplace/report/earning/payment

Important: To use the Payment-Based Earnings service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' section

ParameterTypeRequiredDescription

apikeypublic

string

Yes

The Public Key obtained from the merchant panel.

apiclientpublic

string

Yes

The Public Client obtained from the merchant panel.

paymentid

int

Yes

Ödemenin PayWall'daki Id bilgisi

The response returned from the service:

ParameterTypeDescription

ErrorCode

int

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

Result

bool

It returns a true or false value. If the operation is successful, it returns 'true'.

Message

string

If the operation is unsuccessful, this is the error message provided, offering language support based on the locale parameter.

Body

object

Operation details.

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": [
        {
            "ProductId": 1626240, // Ürünün PayWall'daki Id bilgisi
            "ProductExternalId": "ProductId", // Ürünün şirket tarafındaki Id bilgisi
            "ProductName": "ProductName", // Ürünün şirket tarafındaki isim bilgisi
            "ProductAmount": 10.00, // Ürünün toplam tutarı
            "MerchantEarning": 0.10, // Üründen şirketin elde ettiği kazanç
            "MerchantReflectionDate": "2023-07-02T00:00:00", // Şirkete ait kazancın ne zaman yansıtılacağı
            "SubMerchantEarning": 9.90, // Üründen alt şirketin elde ettiği kazanç
            "SubMerchantReflectionDate": "2023-07-12T00:00:00" // Alt şirkete ait kazancın ne zaman yansıtılacağı
        },
        {
            "ProductId": 1626241,
            "ProductExternalId": "ProductId",
            "ProductName": "ProductName",
            "ProductAmount": 5.00,
            "MerchantEarning": 0.05,
            "MerchantReflectionDate": "2023-07-02T00:00:00",
            "SubMerchantEarning": 4.95,
            "SubMerchantReflectionDate": "2023-07-12T00:00:00"
        },
        {
            "ProductId": 1626242,
            "ProductExternalId": "ProductId",
            "ProductName": "ProductName",
            "ProductAmount": 10.00,
            "MerchantEarning": 0.10,
            "MerchantReflectionDate": "2023-07-02T00:00:00",
            "SubMerchantEarning": 9.90,
            "SubMerchantReflectionDate": "2023-07-12T00:00:00"
        },
        {
            "ProductId": 1626243,
            "ProductExternalId": "ProductId",
            "ProductName": "ProductName",
            "ProductAmount": 10.00,
            "MerchantEarning": 0.10,
            "MerchantReflectionDate": "2023-07-02T00:00:00",
            "SubMerchantEarning": 9.90,
            "SubMerchantReflectionDate": "2023-07-12T00:00:00"
        },
        {
            "ProductId": 1626244,
            "ProductExternalId": "ProductId",
            "ProductName": "ProductName",
            "ProductAmount": 10.00,
            "MerchantEarning": 0.10,
            "MerchantReflectionDate": "2023-07-02T00:00:00",
            "SubMerchantEarning": 9.90,
            "SubMerchantReflectionDate": "2023-07-12T00:00:00"
        },
        {
            "ProductId": 1626245,
            "ProductExternalId": "ProductId",
            "ProductName": "ProductName",
            "ProductAmount": 10.00,
            "MerchantEarning": 0.10,
            "MerchantReflectionDate": "2023-07-02T00:00:00",
            "SubMerchantEarning": 9.90,
            "SubMerchantReflectionDate": "2023-07-12T00:00:00"
        },
        {
            "ProductId": 1626246,
            "ProductExternalId": "ProductId",
            "ProductName": "ProductName",
            "ProductAmount": 10.00,
            "MerchantEarning": 0.10,
            "MerchantReflectionDate": "2023-07-02T00:00:00",
            "SubMerchantEarning": 9.90,
            "SubMerchantReflectionDate": "2023-07-12T00:00:00"
        }
    ]
}

Last updated