getTransactionBasedOnReference

The getTransactionBasedOnReference API retrieves payroll transaction details based on a specific request reference ID.

What it does:

• Returns transaction details including source, destination, amounts, and status for a specific reference ID
• Provides payroll transaction information filtered by request reference ID

GET /reports#getTransactionBasedOnReference

getTransactionBasedOnReference

cURL

curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getTransactionBasedOnReference' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getTransactionsBasedOnReference",
  "requestReferenceId": "5244157"
}
'

200

{
  "payrollTransaction": [
    {
      "requestReferenceId": "5244157",
      "companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
      "payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
      "source": "Ledger",
      "sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
      "destination": "EmployeeBankAccount",
      "destinationAccount": "ADAB2624-0DC9-4151-A4D5-00C83851F8BA",
      "transactionName": "AchCredit",
      "transferAmount": 3624.48,
      "status": "complete"
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · required

Example:

"getTransactionBasedOnReference"

requestReferenceId · string · required

Response

200

application/json

payrollTransaction · object[] · required

Show child attributes