Sign in
latestOpenAPI 3.0.02026-08-133383136.3 KB

fc4f4dd68f9b

Report

Get Partner Report

get/v1/reports/partner/partner-report

Headers

accept-languagestring

Language of the response, supported languages: en-us, in

Request body

limitnumber

Limit

skipnumber

Skip

sortColumn'finractDueDate' | 'finractSubmittedOnDate' | 'loanDisbursementDate' | 'loanAmount'

Sort By Column

sortDirectionstring

Sorting Direction

actualDisbursementDateLtestring

Actual Disbursement Date Less Than or Equal To

actualDisbursementDateGtestring

Actual Disbursement Date Greater Than or Equal To

loanType'BNPL' | 'GMV' | 'BNPL_Term' | 'GMV_Term'

Type of loan.

We support these two types,

  1. BNPL - Buyer Financing

  2. GMV - Seller Financing

clientIdstring

Client ID

clientIdInstring[]

Client IDs (in array)

paymentAmountLTEnumber

Payment Amount Less Than or Equal To

paymentAmountGTEnumber

Payment Amount Greater Than or Equal To

statusnumber

Status

statusInnumber[]

Statuses (in array)

Example request

{
  "limit": 7,
  "sortColumn": "finractDueDate | finractSubmittedOnDate | loanDisbursementDate | loanAmount",
  "sortDirection": "asc | desc",
  "actualDisbursementDateLte": "YYYY-MM-DD",
  "actualDisbursementDateGte": "YYYY-MM-DD",
  "loanType": "BNPL",
  "clientId": "12345678-1234-1234-1234-123467890123",
  "clientIdIn": [
    "12345678-1234-1234-1234-123467890123"
  ],
  "paymentAmountLTE": 1000,
  "paymentAmountGTE": 1000
}

Response

Partner's Report Details

statusCodenumber required

The HTTP status code of the error

messagestring required

Human-readable message containing all available details about the operation

successboolean required

A boolean indicating whether this was a success response or an error response

Example response

{
  "data": {
    "customers": [
      {
        "loans": [
          {
            "loanStatus": "active",
            "loanType": "BNPL",
            "loanTerm": 30,
            "loanAmount": 3500,
            "totalServiceFee": 99.17,
            "totalServiceFeeDue": 99.17,
            "loanDueDate": "18 September 2023",
            "dueDatePostGracePeriod": "21 September 2023",
            "gracePeriodInDays": 3,
            "requestedDate": "18 Aug 2023",
            "repaymentSchedule": [
              {
                "dueDate": "18 September 2023",
                "totalDueForPeriod": 3599.17,
                "totalServiceFeeForPeriod": 99.17,
                "totalServiceFeeDueForPeriod": 99.17,
                "principalDueForPeriod": 3500,
                "dueDatePostGracePeriod": "21 September 2023"
              }
            ],
            "payments": [
              {
                "paymentMethod": "Bank Transfer/UEN Payment/QR Code Payment"
              }
            ]
          }
        ]
      }
    ]
  }
}