Payment Transaction Data API

Authentication

Prerequisites

In order to obtain an API Token you first need to have client_id and client secret from the previous step.

Token Request Flow

To authenticate and obtain an OAuth token, follow the standard OAuth token request flow.

• POST API URL

Copy

https://sandbox-app.lenderlink.ph/oauth/token

• Grant Type

Use this grant type when the client is a server and does not require user authentication.

Copy

"grant_type": "client_credentials"

• Requesting the Access Token

To request the Access Token, submit a POST request to the API URL, including the following body parameters in JSON format:

Copy

{
    "grant_type": "client_credentials",
    "client_id": "your client id",
    "client_secret": "your client secret",
}
                                        

• Handling the Token Response

Upon successful validation, the authorization server will respond with an access token:

{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "eyJ0eXAiOiJKasd10sJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5YTc4MzVm..."
}
                                        

• Token Lifespan

Access tokens have a limited lifespan of 86400 seconds. Once the token expires, you can obtain a new one.

Endpoint

The API endpoint for accessing the Payment Transaction Data is:

https://sandbox-app.lenderlink.ph/api/v1/ptd

Collection History Inquiry Request Parameters

These are the parameters passed by the Merchant via HTTP GET to retrieve the collection transaction history details of a payor based on the email address.

Web Method: GET

https://sandbox-app.lenderlink.ph/api/v1/ptd/inquiry/history

Parameter		Description
email	String	The email address key to search for in the collection transaction history database
refDate	Date	(Optional) The ending date range of the query. Note that the timeframe window to look for transactions is six (6) months up to the end-date, or present date if no end-date is specified.
excludeSelf	Boolean	(Optional) Query string parameter that can be set to true to exclude all transaction records belonging to the same merchantid requesting.
separateSelf	Boolean	(Optional) Query string parameter that can be set to true to separate all transaction records belonging to the same merchantid requesting under a special category of “Self”.

Collection History Inquiry Response Parameters

System responds with HTTP status 401 (unauthorized) if an unsupported version number was provided. Otherwise, a status 200 and a JSON object is returned in its body.

{
  "transactionCount": 47,
  "minAmount": 1.0,
  "maxAmount": 3000.0,
  "aveAmount": 136.0,
  "sumAmount": 6508.0,
  "stdDev": 500.0,
  "refDates": [
    "2024-12-10",
    "2024-12-01",
    "2024-11-29",
    "2024-11-15"
  ],
  "categories": [
    "Retail",
    "Loans",
    "Service"
  ],
  "processor": [
    "GCSH",
    "BDO",
    "711",
    "PRHB"
  ],
  "within1to30Days": [
    {
      "category": "Retail",
      "transactionCount": 1,
      "minAmount": 420.0,
      "maxAmount": 420.0,
      "sumAmount": 420.0,
      "standardDeviation": 0.0
    }
  ],
  "within31to60Days": [
    {
      "category": "Loans",
      "transactionCount": 1,
      "minAmount": 1.0,
      "maxAmount": 1.0,
      "sumAmount": 1.0,
      "standardDeviation": 0.0
    },
    {
      "category": "Retail",
      "transactionCount": 12,
      "minAmount": 1.0,
      "maxAmount": 88.0,
      "sumAmount": 182.0,
      "standardDeviation": 10.0
    }
  ],
  "beyond61Days": [
    {
      "category": "Retail",
      "transactionCount": 33,
      "minAmount": 1.0,
      "maxAmount": 3000.0,
      "sumAmount": 5895.0,
      "standardDeviation": 200.0
    }
  ]
}

The details of the JSON object are as follows:

Parameter	Data Type	Description
transactionCount	Integer	The number of successful collection transactions completed by the user within the time period
minAmount	Decimal	The smallest amount among all the transactions by that user within the period
maxAmount	Decimal	The largest amount among all the transactions by that user within the period
aveAmount	Decimal	The average amount of all the transactions by that user within the period
sumAmount	Decimal	The total amount of all the transactions by that user within the period
standardDeviation	Decimal	The population standard deviation of the amounts
refDates	Array of Date	An array of dates when the transactions occurred
categories	Array of String	An array of categories covering the various merchants where the payments were made to
processor	Array of String	An array of payment processors where the various payments were made to
within1to30Days	Array of Sub-Details Records	An array of records based on the transactions from the last 30 days showing the breakdown by category
within31to60Days	Array of Sub-Details Records	An array of records based on the transactions from the last 31 to 60 days showing the breakdown by category
beyond61Days	Array of Sub-Details Records	An array of records based on the transactions beyond the last 61 days showing the breakdown by category

The Sub-details Record follows the format:

Parameter	Data Type	Description
category	String	The industry or category of the merchant
transactionCount	Integer	The number of successful collection transactions completed by the user associated with the email within the time period
minAmount	Decimal	The smallest amount among all the transactions by that user within the time period
maxAmount	Decimal	The largest amount among all the transactions by that user within the time period
sumAmount	Decimal	The total amount of all the transactions by that user within the time period
standardDeviation	Decimal	The population standard deviation of the amounts

Payout Channel Details Request Parameters

These are the parameters passed by the Merchant using HTTP GET to verify the channel and account detail used for disbursement. The main usage of this function is to verify, for example, if the bank account number provided is valid (ie. has a previous successful transaction already).

Web Method: GET

https://sandbox-app.lenderlink.ph/api/v1/ptd/inquiry/payout/history

Parameter	Data Type	Description
processor	String	The payout channel used
processorDetail	String	The bank account number, ewallet account/phone number, or mobile/email addressed used for over-the-counter cash pickup, associated with the payout channel used

Payout Channel Details Response Parameters

System responds with HTTP status 404 if the processor and processorDetail combination does not exist. Otherwise, a status 200 and a JSON object containing “true” value is returned in its body.

Payout History Inquiry Request Parameters

These are the parameters passed by the Merchant via HTTP GET to retrieve the payout transaction history details of a payor based on the email address. The date range of the search is the last six (6) months.

Web Method: GET

https://sandbox-app.lenderlink.ph/api/v1/ptd/inquiry/payout/history

Parameter	Data Type	Description
emailOrPhone	String	The email address or mobile number provided by the sender during the payout transaction request
excludeSelf	Boolean	(Optional) Query string parameter that can be set to true to exclude all transaction records belonging to the same merchantid requesting.
separateSelf	Boolean	(Optional) Query string parameter that can be set to true to separate all transaction records belonging to the same merchantid requesting under a special category of “Self”.

Payout History Inquiry Response Parameters

System responds with HTTP status 401 (unauthorized) if an unsupported version number was provided. Otherwise, a status 200 and a JSON object is returned in its body.

{
  "transactionCount": 5,
  "minAmount": 100.00,
  "maxAmount": 5000.00,
  "aveAmount": 1000.00,
  "standardDeviation": 100.00,
  "refDates": [
    "2024-12-10",
    "2024-12-01",
    "2024-11-29",
    "2024-11-15"
  ],
  "categories": [
    "Retail",
    "Loans",
    "Education"
  ],
  "processor": [
    "GCSH",
    "BDO",
    "711"
  ]
}

The details of the JSON object are as follows:

Parameter	Data Type	Description
transactionCount	Integer	The number of successful payout transactions completed by the user associated with the email or mobile number within the time period
minAmount	Decimal	The smallest amount among all the transactions paid to that user within the time period
maxAmount	Decimal	The largest amount among all the transactions paid to that user within the time period
aveAmount	Decimal	The average amount of all the transactions by paid to that user within the time period
standardDeviation	Decimal	The population standard deviation of the amounts
refDates	Array of Date	An array of dates when the transactions occurred
categories	Array of String	An array of categories covering the various merchants where the payments were made to
processor	Array of String	An array of payout channel id’s where the various payments were made to