getTransactions
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getTransactions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getTransactionsBasedOnName",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getTransactions"
payload = {
"method": "getTransactionsBasedOnName",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getTransactionsBasedOnName',
payPeriodId: '2AF56831-2841-438D-9722-E097AC1CCCAC'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getTransactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/reports/getTransactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getTransactionsBasedOnName',
'payPeriodId' => '2AF56831-2841-438D-9722-E097AC1CCCAC'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/reports/getTransactions"
payload := strings.NewReader("{\n \"method\": \"getTransactionsBasedOnName\",\n \"payPeriodId\": \"2AF56831-2841-438D-9722-E097AC1CCCAC\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.rollfi.xyz/reports/getTransactions")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getTransactionsBasedOnName\",\n \"payPeriodId\": \"2AF56831-2841-438D-9722-E097AC1CCCAC\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getTransactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getTransactionsBasedOnName\",\n \"payPeriodId\": \"2AF56831-2841-438D-9722-E097AC1CCCAC\"\n}"
response = http.request(request)
puts response.read_body{
"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"
},
{
"requestReferenceId": "5244151",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "132F5B54-D23B-458B-8F69-1F08F0FA7A23",
"transactionName": "AchCredit",
"transferAmount": 14988.62,
"status": "complete"
},
{
"requestReferenceId": "5244154",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "4391AD1B-51D2-42F3-B815-D5F3D68A5DC7",
"transactionName": "AchCredit",
"transferAmount": 10244.69,
"status": "complete"
},
{
"requestReferenceId": "5244153",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "4EFC8423-667B-4389-9DE2-8D56ACCD7BF8",
"transactionName": "AchCredit",
"transferAmount": 14151.46,
"status": "complete"
},
{
"requestReferenceId": "5244155",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "98A73017-2B14-4C17-A986-320DA48C0C5B",
"transactionName": "AchCredit",
"transferAmount": 9975.36,
"status": "complete"
},
{
"requestReferenceId": "5244158",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "04FE795D-76EB-438C-9CC7-7BA7BD98D6CA",
"transactionName": "AchCredit",
"transferAmount": 9958.75,
"status": "pending"
},
{
"requestReferenceId": "5244156",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "F1830475-EFCF-4A6E-A6FB-682F61898537",
"transactionName": "AchCredit",
"transferAmount": 14246.53,
"status": "complete"
},
{
"requestReferenceId": "5244150",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "D48DA316-ED8C-4815-B0EC-14057D344951",
"transactionName": "AchCredit",
"transferAmount": 3644.48,
"status": "complete"
},
{
"requestReferenceId": "5243486",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "EmployerBankAccount",
"sourceAccount": "1111222233331111",
"destination": "Ledger",
"destinationAccount": "76650000049771",
"transactionName": "AchDebit",
"transferAmount": 101741.64,
"status": "complete"
},
{
"requestReferenceId": "5244152",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "90A22A2C-5DB3-4BBE-A2CA-31E0D37D6356",
"transactionName": "AchCredit",
"transferAmount": 3897.82,
"status": "complete"
}
]
}{
"error": {
"code": 400,
"message": "Invalid PayPeriodId"
}
}Reports
getTransactions
The getTransactions API retrieves all payroll transaction records for a specific pay period.
What it does:
- Returns all payment transactions related to a pay period within a payroll
- Provides transaction details including source, destination, amounts, and status for all payments processed
- Shows complete transaction history for direct deposits, tax payments, and other payroll-related transfers
GET
/
reports
/
getTransactions
getTransactions
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getTransactions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getTransactionsBasedOnName",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getTransactions"
payload = {
"method": "getTransactionsBasedOnName",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getTransactionsBasedOnName',
payPeriodId: '2AF56831-2841-438D-9722-E097AC1CCCAC'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getTransactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/reports/getTransactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getTransactionsBasedOnName',
'payPeriodId' => '2AF56831-2841-438D-9722-E097AC1CCCAC'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/reports/getTransactions"
payload := strings.NewReader("{\n \"method\": \"getTransactionsBasedOnName\",\n \"payPeriodId\": \"2AF56831-2841-438D-9722-E097AC1CCCAC\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.rollfi.xyz/reports/getTransactions")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getTransactionsBasedOnName\",\n \"payPeriodId\": \"2AF56831-2841-438D-9722-E097AC1CCCAC\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getTransactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getTransactionsBasedOnName\",\n \"payPeriodId\": \"2AF56831-2841-438D-9722-E097AC1CCCAC\"\n}"
response = http.request(request)
puts response.read_body{
"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"
},
{
"requestReferenceId": "5244151",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "132F5B54-D23B-458B-8F69-1F08F0FA7A23",
"transactionName": "AchCredit",
"transferAmount": 14988.62,
"status": "complete"
},
{
"requestReferenceId": "5244154",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "4391AD1B-51D2-42F3-B815-D5F3D68A5DC7",
"transactionName": "AchCredit",
"transferAmount": 10244.69,
"status": "complete"
},
{
"requestReferenceId": "5244153",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "4EFC8423-667B-4389-9DE2-8D56ACCD7BF8",
"transactionName": "AchCredit",
"transferAmount": 14151.46,
"status": "complete"
},
{
"requestReferenceId": "5244155",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "98A73017-2B14-4C17-A986-320DA48C0C5B",
"transactionName": "AchCredit",
"transferAmount": 9975.36,
"status": "complete"
},
{
"requestReferenceId": "5244158",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "04FE795D-76EB-438C-9CC7-7BA7BD98D6CA",
"transactionName": "AchCredit",
"transferAmount": 9958.75,
"status": "pending"
},
{
"requestReferenceId": "5244156",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "F1830475-EFCF-4A6E-A6FB-682F61898537",
"transactionName": "AchCredit",
"transferAmount": 14246.53,
"status": "complete"
},
{
"requestReferenceId": "5244150",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "D48DA316-ED8C-4815-B0EC-14057D344951",
"transactionName": "AchCredit",
"transferAmount": 3644.48,
"status": "complete"
},
{
"requestReferenceId": "5243486",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "EmployerBankAccount",
"sourceAccount": "1111222233331111",
"destination": "Ledger",
"destinationAccount": "76650000049771",
"transactionName": "AchDebit",
"transferAmount": 101741.64,
"status": "complete"
},
{
"requestReferenceId": "5244152",
"companyId": "C2019899-9EEF-49F7-9B51-70744AFAFE61",
"payPeriodId": "2AF56831-2841-438D-9722-E097AC1CCCAC",
"source": "Ledger",
"sourceAccount": "A4567F07-CB88-4973-8A60-0AF2F9512C41",
"destination": "EmployeeBankAccount",
"destinationAccount": "90A22A2C-5DB3-4BBE-A2CA-31E0D37D6356",
"transactionName": "AchCredit",
"transferAmount": 3897.82,
"status": "complete"
}
]
}{
"error": {
"code": 400,
"message": "Invalid PayPeriodId"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
Show child attributes
Show child attributes
⌘I
