List settlement files
curl --request GET \
--url https://financehub.paybyrd.com/api/v1/SettlementFiles \
--header 'x-api-key: <api-key>'import requests
url = "https://financehub.paybyrd.com/api/v1/SettlementFiles"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://financehub.paybyrd.com/api/v1/SettlementFiles', 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://financehub.paybyrd.com/api/v1/SettlementFiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://financehub.paybyrd.com/api/v1/SettlementFiles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://financehub.paybyrd.com/api/v1/SettlementFiles")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://financehub.paybyrd.com/api/v1/SettlementFiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"checksum": "ba421754061547e5d80153d3d2923be4",
"createdAt": "2026-05-26T13:11:02.390069-03:00",
"groupId": 1,
"merchantId": 1,
"id": "59188227-0811-4e30-8c57-b8dff2ab07e9",
"url": "https://financehubstoragestg.blob.core.windows.net/settlements-paybyrd/57/87/2026-05-26T16-11-00-4990180%2B0-PaybyrdSettlement.csv"
}
]
}{
"data": {
"problemDetails": {
"type": "ApplicationBadRequestFail",
"title": "Bad request",
"status": 400,
"instance": "bad_request",
"extensions": {}
},
"contentType": "application/problem+json",
"statusCode": 400
}
}{
"data": {
"problemDetails": {
"type": "ApplicationNotFoundFail",
"title": "Settlement file not found with the specified period.",
"status": 404,
"instance": "not_found",
"extensions": {}
},
"contentType": "application/problem+json",
"statusCode": 404
}
}{
"data": {
"problemDetails": {
"type": "ApplicationServerErrorFail",
"title": "Internal server error",
"status": 500,
"instance": "server_error",
"extensions": {}
},
"contentType": "application/problem+json",
"statusCode": 500
}
}Settlement files
List settlement files
Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.
GET
/
api
/
v1
/
SettlementFiles
List settlement files
curl --request GET \
--url https://financehub.paybyrd.com/api/v1/SettlementFiles \
--header 'x-api-key: <api-key>'import requests
url = "https://financehub.paybyrd.com/api/v1/SettlementFiles"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://financehub.paybyrd.com/api/v1/SettlementFiles', 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://financehub.paybyrd.com/api/v1/SettlementFiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://financehub.paybyrd.com/api/v1/SettlementFiles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://financehub.paybyrd.com/api/v1/SettlementFiles")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://financehub.paybyrd.com/api/v1/SettlementFiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"checksum": "ba421754061547e5d80153d3d2923be4",
"createdAt": "2026-05-26T13:11:02.390069-03:00",
"groupId": 1,
"merchantId": 1,
"id": "59188227-0811-4e30-8c57-b8dff2ab07e9",
"url": "https://financehubstoragestg.blob.core.windows.net/settlements-paybyrd/57/87/2026-05-26T16-11-00-4990180%2B0-PaybyrdSettlement.csv"
}
]
}{
"data": {
"problemDetails": {
"type": "ApplicationBadRequestFail",
"title": "Bad request",
"status": 400,
"instance": "bad_request",
"extensions": {}
},
"contentType": "application/problem+json",
"statusCode": 400
}
}{
"data": {
"problemDetails": {
"type": "ApplicationNotFoundFail",
"title": "Settlement file not found with the specified period.",
"status": 404,
"instance": "not_found",
"extensions": {}
},
"contentType": "application/problem+json",
"statusCode": 404
}
}{
"data": {
"problemDetails": {
"type": "ApplicationServerErrorFail",
"title": "Internal server error",
"status": 500,
"instance": "server_error",
"extensions": {}
},
"contentType": "application/problem+json",
"statusCode": 500
}
}
