# 1. Get Earnings

## **Retrieve earnings information based on payment**

<mark style="color:blue;">`GET`</mark> `{{Base Adres}}/api/paywall/marketplace/report/earning/payment`

{% hint style="info" %}
**Important:** To use the Payment-Based Earnings service, you must include the **apikeypublic** and **apiclientpublic** parameters in the **Header** section.\
\
[<mark style="color:green;">**PaymentAPI Address**</mark>](https://developer.paywall.one/payment-orchestration-integration-document/environment)
{% endhint %}

<table><thead><tr><th width="188">Parameter</th><th width="79">Type</th><th width="107">Compolsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>Public Key obtained from the merchant panel.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>Public Client obtained from the merchant panel.</td></tr><tr><td>paymentid</td><td>int</td><td>Yes</td><td>Payment ID information in Paywall</td></tr></tbody></table>

**Response returned from the service:**

<table><thead><tr><th width="189">Parameter</th><th width="100.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>ErrorCode</td><td>int</td><td>Error code. Returns '0' if the operation is successful.</td></tr><tr><td>Result</td><td>bool</td><td>Returns a true or false value. Returns 'true' if the operation is successful.</td></tr><tr><td>Message</td><td>string</td><td>If the operation fails, this is the message describing the error, and it supports localization based on the locale parameter.</td></tr><tr><td>Body</td><td>object</td><td>Detailed information about the transaction</td></tr></tbody></table>

{% tabs %}
{% tab title="JSON" %}
{% code lineNumbers="true" %}

```json
{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": [
        {
            "PaymentId": 111222,
            "ProductId": 2111651,
            "ProductExternalId": "ProductId",
            "ProductName": "ProductName",
            "ProductAmount": 26000.00,
            "MerchantEarningId": 1854,
            "MerchantEarning": 260.00,
            "MerchantReflectionDate": "2023-08-13T00:00:00",
            "SubMerchantEarningId": 1853,
            "SubMerchantEarning": 25740.00,
            "SubMerchantReflectionDate": "2023-08-23T00:00:00",
            "MerchantEarningStatusId": 4,
            "MerchantPayoutTransactionId": 0,
            "SubMerchantEarningStatusId": 4,
            "SubMerchantPayoutTransactionId": 6
        }
    ]
}
```

{% endcode %}
{% endtab %}
{% endtabs %}