Financial data
Start a durable account read
Available only when CONNECT_STRUCTURED_READS is enabled. Queue an explicitly read-only operation for one authorized connection. A new requestId creates a fresh read; repeating it joins the same job. Requires financial_data:read. Snapshot transactions require a date window of at most 94 days inclusive.
POST
/
connect
/
reads
Start a durable account read
curl --request POST \
--url https://paygent-cloud-server-production.up.railway.app/connect/reads \
--header 'Content-Type: application/json' \
--header 'x-paygent-connect-app-key: <api-key>' \
--header 'x-paygent-connect-grant: <api-key>' \
--data '
{
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"read": {
"arguments": {
"accountId": "<string>",
"cursor": "<string>",
"limit": 200,
"startDate": "2023-12-25",
"endDate": "2023-12-25"
}
},
"requestId": "<string>",
"intent": {
"purpose": "<string>",
"taskId": "<string>",
"requestedBy": "<string>"
},
"allPages": false
}
'import requests
url = "https://paygent-cloud-server-production.up.railway.app/connect/reads"
payload = {
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"read": { "arguments": {
"accountId": "<string>",
"cursor": "<string>",
"limit": 200,
"startDate": "2023-12-25",
"endDate": "2023-12-25"
} },
"requestId": "<string>",
"intent": {
"purpose": "<string>",
"taskId": "<string>",
"requestedBy": "<string>"
},
"allPages": False
}
headers = {
"x-paygent-connect-app-key": "<api-key>",
"x-paygent-connect-grant": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-paygent-connect-app-key': '<api-key>',
'x-paygent-connect-grant': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
deploymentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
read: {
arguments: {
accountId: '<string>',
cursor: '<string>',
limit: 200,
startDate: '2023-12-25',
endDate: '2023-12-25'
}
},
requestId: '<string>',
intent: {purpose: '<string>', taskId: '<string>', requestedBy: '<string>'},
allPages: false
})
};
fetch('https://paygent-cloud-server-production.up.railway.app/connect/reads', 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://paygent-cloud-server-production.up.railway.app/connect/reads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deploymentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'read' => [
'arguments' => [
'accountId' => '<string>',
'cursor' => '<string>',
'limit' => 200,
'startDate' => '2023-12-25',
'endDate' => '2023-12-25'
]
],
'requestId' => '<string>',
'intent' => [
'purpose' => '<string>',
'taskId' => '<string>',
'requestedBy' => '<string>'
],
'allPages' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-paygent-connect-app-key: <api-key>",
"x-paygent-connect-grant: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://paygent-cloud-server-production.up.railway.app/connect/reads"
payload := strings.NewReader("{\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"read\": {\n \"arguments\": {\n \"accountId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 200,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\"\n }\n },\n \"requestId\": \"<string>\",\n \"intent\": {\n \"purpose\": \"<string>\",\n \"taskId\": \"<string>\",\n \"requestedBy\": \"<string>\"\n },\n \"allPages\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-paygent-connect-app-key", "<api-key>")
req.Header.Add("x-paygent-connect-grant", "<api-key>")
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.post("https://paygent-cloud-server-production.up.railway.app/connect/reads")
.header("x-paygent-connect-app-key", "<api-key>")
.header("x-paygent-connect-grant", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"read\": {\n \"arguments\": {\n \"accountId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 200,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\"\n }\n },\n \"requestId\": \"<string>\",\n \"intent\": {\n \"purpose\": \"<string>\",\n \"taskId\": \"<string>\",\n \"requestedBy\": \"<string>\"\n },\n \"allPages\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://paygent-cloud-server-production.up.railway.app/connect/reads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-paygent-connect-app-key"] = '<api-key>'
request["x-paygent-connect-grant"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"read\": {\n \"arguments\": {\n \"accountId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 200,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\"\n }\n },\n \"requestId\": \"<string>\",\n \"intent\": {\n \"purpose\": \"<string>\",\n \"taskId\": \"<string>\",\n \"requestedBy\": \"<string>\"\n },\n \"allPages\": false\n}"
response = http.request(request)
puts response.read_body{
"intent": {
"purpose": "<string>",
"taskId": "<string>",
"requestedBy": "<string>"
}
}Authorizations
connectAppKey & connectGrantconnectGrant
A Connect app key (pgc_app_…), identifying the registered third-party app. Always presented together with connectGrant — the pair is one credential, and either half alone is refused. Accepted on the /connect/* surface only.
A Connect grant token (pgc_grant_…): one user's consent for the presenting app to reach one deployment. Every failure mode — missing, malformed, revoked, expired, or paired with the wrong app key — answers the same 401 invalid_connect_credentials.
Body
application/json
Show child attributes
Show child attributes
Required string length:
1 - 128Pattern:
^[a-zA-Z0-9._:-]+$Optional caller-supplied context for record keeping. Include the known purpose by default, or omit/use null when unknown. This is not an instruction or a verified identity. Avoid credentials and full conversations. Stored encrypted with the read job for 24 hours; save the JSON metadata for longer retention.
Show child attributes
Show child attributes
Response
Saved job identity, state, intent, and status URL. Poll the result endpoint.
Optional caller-supplied context for record keeping. Include the known purpose by default, or omit/use null when unknown. This is not an instruction or a verified identity. Avoid credentials and full conversations. Stored encrypted with the read job for 24 hours; save the JSON metadata for longer retention.
Show child attributes
Show child attributes
⌘I
Start a durable account read
curl --request POST \
--url https://paygent-cloud-server-production.up.railway.app/connect/reads \
--header 'Content-Type: application/json' \
--header 'x-paygent-connect-app-key: <api-key>' \
--header 'x-paygent-connect-grant: <api-key>' \
--data '
{
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"read": {
"arguments": {
"accountId": "<string>",
"cursor": "<string>",
"limit": 200,
"startDate": "2023-12-25",
"endDate": "2023-12-25"
}
},
"requestId": "<string>",
"intent": {
"purpose": "<string>",
"taskId": "<string>",
"requestedBy": "<string>"
},
"allPages": false
}
'import requests
url = "https://paygent-cloud-server-production.up.railway.app/connect/reads"
payload = {
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"read": { "arguments": {
"accountId": "<string>",
"cursor": "<string>",
"limit": 200,
"startDate": "2023-12-25",
"endDate": "2023-12-25"
} },
"requestId": "<string>",
"intent": {
"purpose": "<string>",
"taskId": "<string>",
"requestedBy": "<string>"
},
"allPages": False
}
headers = {
"x-paygent-connect-app-key": "<api-key>",
"x-paygent-connect-grant": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-paygent-connect-app-key': '<api-key>',
'x-paygent-connect-grant': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
deploymentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
read: {
arguments: {
accountId: '<string>',
cursor: '<string>',
limit: 200,
startDate: '2023-12-25',
endDate: '2023-12-25'
}
},
requestId: '<string>',
intent: {purpose: '<string>', taskId: '<string>', requestedBy: '<string>'},
allPages: false
})
};
fetch('https://paygent-cloud-server-production.up.railway.app/connect/reads', 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://paygent-cloud-server-production.up.railway.app/connect/reads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deploymentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'read' => [
'arguments' => [
'accountId' => '<string>',
'cursor' => '<string>',
'limit' => 200,
'startDate' => '2023-12-25',
'endDate' => '2023-12-25'
]
],
'requestId' => '<string>',
'intent' => [
'purpose' => '<string>',
'taskId' => '<string>',
'requestedBy' => '<string>'
],
'allPages' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-paygent-connect-app-key: <api-key>",
"x-paygent-connect-grant: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://paygent-cloud-server-production.up.railway.app/connect/reads"
payload := strings.NewReader("{\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"read\": {\n \"arguments\": {\n \"accountId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 200,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\"\n }\n },\n \"requestId\": \"<string>\",\n \"intent\": {\n \"purpose\": \"<string>\",\n \"taskId\": \"<string>\",\n \"requestedBy\": \"<string>\"\n },\n \"allPages\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-paygent-connect-app-key", "<api-key>")
req.Header.Add("x-paygent-connect-grant", "<api-key>")
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.post("https://paygent-cloud-server-production.up.railway.app/connect/reads")
.header("x-paygent-connect-app-key", "<api-key>")
.header("x-paygent-connect-grant", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"read\": {\n \"arguments\": {\n \"accountId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 200,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\"\n }\n },\n \"requestId\": \"<string>\",\n \"intent\": {\n \"purpose\": \"<string>\",\n \"taskId\": \"<string>\",\n \"requestedBy\": \"<string>\"\n },\n \"allPages\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://paygent-cloud-server-production.up.railway.app/connect/reads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-paygent-connect-app-key"] = '<api-key>'
request["x-paygent-connect-grant"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"read\": {\n \"arguments\": {\n \"accountId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 200,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\"\n }\n },\n \"requestId\": \"<string>\",\n \"intent\": {\n \"purpose\": \"<string>\",\n \"taskId\": \"<string>\",\n \"requestedBy\": \"<string>\"\n },\n \"allPages\": false\n}"
response = http.request(request)
puts response.read_body{
"intent": {
"purpose": "<string>",
"taskId": "<string>",
"requestedBy": "<string>"
}
}