v1

latestOpenAPI 3.0.02026-07-246335313.6 KB

Recon APIs

Get Dashboard Summary

This endpoint is used to fetch the reconciliation output summary for a pair of data sources.

post/api/recon/v3/summary

Headers

X-Portone-Client-Keystring

Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Content-Typestring

Request body

fromstring required

The Start date of date range for which you want to analyze the summary

tostring required

The End date of date range for which you want to analyze the summary

data_source_astring required

The first data_source_id for which you want to analyze the summary

data_source_bstring required

The second data_source_id for which you want to analyze the summary

record_type'payment' | 'refund' required

payment for forward transactions and refund for recon of refund transactions

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "from": "2022-05-15T18:30:00.000Z",
  "to": "2025-03-25T18:29:59.456Z",
  "data_source_a": "LAZADA_ORDER",
  "data_source_b": "LAZADA_SETTLEMENT",
  "record_type": "payment",
  "brand_id": [
    "Brand_id_1",
    "Brand_id_2"
  ],
  "marketplace_id": [
    "mp_id_1",
    "mp_id_2"
  ],
  "country": [
    "IN",
    "SG"
  ],
  "currency": [
    "INR",
    "USD"
  ],
  "environment": "sandbox"
}

Response

messagestring

Description of the API request execution result.

status_codestring

Status code of the API response.

status_reasonstring

Status reason of the API response.