Sign in

v1

latestOpenAPI 3.0.02026-07-246335313.6 KB
Recon APIs

Get Dashboard Records

This endpoint is used to fetch the ingested records of a Data Source

post/api/recon/v3/dashboard-records

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

tostring required

The End date of date range

data_sourcestring required

The data_source_id for which you want to fetch the records

record_type'payment' | 'refund' required

payment for forward transactions and refund for recon of refund transactions

status'reconciled' | 'unreconciled' | 'SankeyReconOrders' | 'SankeyUnmatchedSku' required

status of records, can be empty string

mismatches'mismatch_no' | 'mismatch_fee' | 'mismatch_tax' | 'mismatch_amount' | 'mismatch_quantity'

to fetch reconciled transactions on basis of mismatch like Amount mismatch, Fee mismatch, Quantity mismatch, etc.

msm_idinteger required

Merchant Source Mapping ID, get it from data-sources api

pageinteger required

The page number of the records to be fetched

page_sizeinteger required

The page size of the records to be fetched

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "from": "2019-12-30T18:30:00.000Z",
  "to": "2024-07-08T18:29:59.000Z",
  "data_source": "LAZADA_ORDER",
  "record_type": "payment",
  "status": "reconciled",
  "mismatches": [
    "mismatch_fee",
    "mismatch_quantity"
  ],
  "msm_id": 27,
  "brand_id": [
    "Brand_id_1",
    "Brand_id_2"
  ],
  "marketplace_id": [
    "mp_id_1",
    "mp_id_2"
  ],
  "country": [
    "IN",
    "SG"
  ],
  "currency": [
    "INR",
    "USD"
  ],
  "page": 1,
  "page_size": 10,
  "environment": "sandbox"
}

Response

OK

messagestring

The description of the API request execution result.

status_codestring

Status code of the API response.

status_reasonstring

Status reason of the API response.