Masumi Logo

/payment-income

Get payment income analytics for Payment Request transactions, over specified time periods.

POST
/payment/income
token<token>

API key authentication via header (token)

In: header

Request Body

application/json

Response Body

application/json

curl -X POST "https://loading/./../api/v1/payment/income" \  -H "Content-Type: application/json" \  -d '{    "agentIdentifier": "example_agent_identifier_asset_id",    "startDate": "2024-01-01",    "endDate": "2024-01-31",    "network": "Preprod"  }'
{
  "status": "Success",
  "data": {
    "agentIdentifier": "example_agent_identifier_asset_id",
    "periodStart": "2024-01-01T00:00:00.000Z",
    "periodEnd": "2024-01-31T23:59:59.000Z",
    "totalTransactions": 25,
    "TotalIncome": {
      "Units": [
        {
          "unit": "",
          "amount": 45000000
        }
      ],
      "blockchainFees": 2500000
    },
    "TotalRefunded": {
      "Units": [
        {
          "unit": "",
          "amount": 5000000
        }
      ],
      "blockchainFees": 400000
    },
    "TotalPending": {
      "Units": [
        {
          "unit": "",
          "amount": 2000000
        }
      ],
      "blockchainFees": 100000
    },
    "DailyIncome": [
      {
        "day": 10,
        "month": 1,
        "year": 2024,
        "Units": [
          {
            "unit": "",
            "amount": 2000000
          }
        ],
        "blockchainFees": 100000
      }
    ],
    "DailyRefunded": [
      {
        "day": 12,
        "month": 1,
        "year": 2024,
        "Units": [
          {
            "unit": "",
            "amount": 500000
          }
        ],
        "blockchainFees": 20000
      }
    ],
    "DailyPending": [
      {
        "day": 15,
        "month": 1,
        "year": 2024,
        "Units": [
          {
            "unit": "",
            "amount": 500000
          }
        ],
        "blockchainFees": 0
      }
    ],
    "MonthlyIncome": [
      {
        "month": 1,
        "year": 2024,
        "Units": [
          {
            "unit": "",
            "amount": 45000000
          }
        ],
        "blockchainFees": 2500000
      }
    ],
    "MonthlyRefunded": [
      {
        "month": 1,
        "year": 2024,
        "Units": [
          {
            "unit": "",
            "amount": 5000000
          }
        ],
        "blockchainFees": 400000
      }
    ],
    "MonthlyPending": [
      {
        "month": 1,
        "year": 2024,
        "Units": [
          {
            "unit": "",
            "amount": 2000000
          }
        ],
        "blockchainFees": 100000
      }
    ]
  }
}
Empty
Empty
Empty
Empty
Masumi Kanji