curl --request GET \
--url https://api.example.com/spi/v1/regulatory/apix001/report \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/spi/v1/regulatory/apix001/report"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/spi/v1/regulatory/apix001/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/spi/v1/regulatory/apix001/report"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"reportId": "0193a6f0-7c1e-7b4a-9d2e-5f6a7b8c9d0e",
"period": "2026-10",
"ispb": "12345678",
"layoutVersion": "2.7",
"blocks": {
"transactions": {
"rows": [
{
"transactionDetail": 5,
"transactionPurpose": 1,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 5,
"transactionPurpose": 2,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 5,
"transactionPurpose": 3,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 5,
"transactionPurpose": 4,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 6,
"transactionPurpose": 1,
"transactionCount": 1,
"transactionAmount": "150.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 6,
"transactionPurpose": 2,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 6,
"transactionPurpose": 3,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 6,
"transactionPurpose": 4,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 7,
"transactionPurpose": 1,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 7,
"transactionPurpose": 2,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 7,
"transactionPurpose": 3,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 7,
"transactionPurpose": 4,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
}
],
"detailCoverage": [
{
"transactionDetail": 5,
"coverage": {
"status": "NOT_APPLICABLE",
"reason": "no indirect participant declaration valid in the month"
}
},
{
"transactionDetail": 6,
"coverage": {
"status": "COMPLETE"
}
},
{
"transactionDetail": 7,
"coverage": {
"status": "UNAVAILABLE",
"reason": "no outbound fraud refusal informed for the month"
}
}
]
},
"refunds": {
"rows": [
{
"refundDetail": 1,
"refundCount": 0,
"refundAmount": "0.00"
},
{
"refundDetail": 2,
"refundCount": 1,
"refundAmount": "89.90"
}
],
"coverage": {
"status": "COMPLETE"
}
},
"cautionaryBlocks": {
"rows": [
{
"cautionaryBlockDetail": 1,
"cautionaryBlockCount": 0,
"cautionaryBlockAmount": "0.00"
},
{
"cautionaryBlockDetail": 2,
"cautionaryBlockCount": 0,
"cautionaryBlockAmount": "0.00"
},
{
"cautionaryBlockDetail": 3,
"cautionaryBlockCount": 0,
"cautionaryBlockAmount": "0.00"
},
{
"cautionaryBlockDetail": 4,
"cautionaryBlockCount": 0,
"cautionaryBlockAmount": "0.00"
}
],
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"revenues": {
"rows": [
{
"revenueSource": 1,
"revenueAmount": "0.00"
},
{
"revenueSource": 2,
"revenueAmount": "0.00"
},
{
"revenueSource": 3,
"revenueAmount": "0.00"
},
{
"revenueSource": 4,
"revenueAmount": "0.00"
}
],
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"transactionTimes": {
"p50SpiUserExperienceTime": {
"value": "2.84",
"coverage": {
"status": "PARTIAL",
"reason": "measured from the client call to the result delivery; ends before t6a (Manual de Tempos v7.0 4.1.2)"
}
},
"p99SpiUserExperienceTime": {
"value": "7.91",
"coverage": {
"status": "PARTIAL",
"reason": "measured from the client call to the result delivery; ends before t6a (Manual de Tempos v7.0 4.1.2)"
}
},
"p50OutsideSpiUserExperienceTime": {
"value": "1.37",
"coverage": {
"status": "COMPLETE"
}
},
"p99OutsideSpiUserExperienceTime": {
"value": "1.37",
"coverage": {
"status": "COMPLETE"
}
},
"maxCautionaryBlockTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
}
},
"dictTimes": {
"p99KeyLookupTime": {
"value": "0.42",
"coverage": {
"status": "PARTIAL",
"reason": "lower bound: only the DICT hub call inside the initiate is measured, not the participant channel nor the rest of the initiate; a key lookup the client makes before the initiate is not seen; lookups that failed technically (timeout, connection, 5xx) are left out; negative answers are not measured; Pix Agendado key lookups are not measured"
}
},
"p95KeyRegistrationCodeSendTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95KeyRegistrationUserExperienceTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95KeyDeletionUserExperienceTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95PortabilityNotificationTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95PortabilitySendTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95MedOpeningTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
}
},
"dictLookups": {
"lookupCount": 48210,
"coverage": {
"status": "PARTIAL",
"reason": "a key lookup the client makes before the initiate is not seen; negative answers are not measured; Pix Agendado key lookups are not measured"
}
},
"availability": {
"availabilityIndex": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"authorizationTimes": {
"p95AuthorizationTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
}
},
"authorizations": {
"rows": [
{
"payerType": 1,
"authorizationCount": 0,
"activeAuthorizationCount": 0
},
{
"payerType": 2,
"authorizationCount": 0,
"activeAuthorizationCount": 0
}
],
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
}
}
}Get the APIX001 report of a closed reference month
Returns the current report of the month in the period query parameter: the ten blocks of the APIX001 layout for the ISPB of the tenant, in layout order and with the fixed rows of the layout, zero rows included. Every indicator and block carries coverage, so a 0.00 that is a filler is never read as a measured zero. A block that Pix Lerian does not compute comes back UNAVAILABLE with a reason, never omitted. A time indicator is in seconds, except maxCautionaryBlockTime, in hours.
A month never closed, or reopened and not closed again, answers 404 (PIX-0711): close it first. A future month answers 422 (PIX-0710). A period that is absent or not YYYY-MM answers 400 (PIX-0020), and a month before 2020-11 answers 400 (PIX-0003). The month state is read on the read replica, and on the primary when none is configured, so a reopen or a new close is visible once the replica has applied it. The close response already carries the report.
curl --request GET \
--url https://api.example.com/spi/v1/regulatory/apix001/report \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/spi/v1/regulatory/apix001/report"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/spi/v1/regulatory/apix001/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/spi/v1/regulatory/apix001/report"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"reportId": "0193a6f0-7c1e-7b4a-9d2e-5f6a7b8c9d0e",
"period": "2026-10",
"ispb": "12345678",
"layoutVersion": "2.7",
"blocks": {
"transactions": {
"rows": [
{
"transactionDetail": 5,
"transactionPurpose": 1,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 5,
"transactionPurpose": 2,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 5,
"transactionPurpose": 3,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 5,
"transactionPurpose": 4,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 6,
"transactionPurpose": 1,
"transactionCount": 1,
"transactionAmount": "150.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 6,
"transactionPurpose": 2,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 6,
"transactionPurpose": 3,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 6,
"transactionPurpose": 4,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 7,
"transactionPurpose": 1,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 7,
"transactionPurpose": 2,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 7,
"transactionPurpose": 3,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
},
{
"transactionDetail": 7,
"transactionPurpose": 4,
"transactionCount": 0,
"transactionAmount": "0.00",
"cashAmount": "0.00"
}
],
"detailCoverage": [
{
"transactionDetail": 5,
"coverage": {
"status": "NOT_APPLICABLE",
"reason": "no indirect participant declaration valid in the month"
}
},
{
"transactionDetail": 6,
"coverage": {
"status": "COMPLETE"
}
},
{
"transactionDetail": 7,
"coverage": {
"status": "UNAVAILABLE",
"reason": "no outbound fraud refusal informed for the month"
}
}
]
},
"refunds": {
"rows": [
{
"refundDetail": 1,
"refundCount": 0,
"refundAmount": "0.00"
},
{
"refundDetail": 2,
"refundCount": 1,
"refundAmount": "89.90"
}
],
"coverage": {
"status": "COMPLETE"
}
},
"cautionaryBlocks": {
"rows": [
{
"cautionaryBlockDetail": 1,
"cautionaryBlockCount": 0,
"cautionaryBlockAmount": "0.00"
},
{
"cautionaryBlockDetail": 2,
"cautionaryBlockCount": 0,
"cautionaryBlockAmount": "0.00"
},
{
"cautionaryBlockDetail": 3,
"cautionaryBlockCount": 0,
"cautionaryBlockAmount": "0.00"
},
{
"cautionaryBlockDetail": 4,
"cautionaryBlockCount": 0,
"cautionaryBlockAmount": "0.00"
}
],
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"revenues": {
"rows": [
{
"revenueSource": 1,
"revenueAmount": "0.00"
},
{
"revenueSource": 2,
"revenueAmount": "0.00"
},
{
"revenueSource": 3,
"revenueAmount": "0.00"
},
{
"revenueSource": 4,
"revenueAmount": "0.00"
}
],
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"transactionTimes": {
"p50SpiUserExperienceTime": {
"value": "2.84",
"coverage": {
"status": "PARTIAL",
"reason": "measured from the client call to the result delivery; ends before t6a (Manual de Tempos v7.0 4.1.2)"
}
},
"p99SpiUserExperienceTime": {
"value": "7.91",
"coverage": {
"status": "PARTIAL",
"reason": "measured from the client call to the result delivery; ends before t6a (Manual de Tempos v7.0 4.1.2)"
}
},
"p50OutsideSpiUserExperienceTime": {
"value": "1.37",
"coverage": {
"status": "COMPLETE"
}
},
"p99OutsideSpiUserExperienceTime": {
"value": "1.37",
"coverage": {
"status": "COMPLETE"
}
},
"maxCautionaryBlockTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
}
},
"dictTimes": {
"p99KeyLookupTime": {
"value": "0.42",
"coverage": {
"status": "PARTIAL",
"reason": "lower bound: only the DICT hub call inside the initiate is measured, not the participant channel nor the rest of the initiate; a key lookup the client makes before the initiate is not seen; lookups that failed technically (timeout, connection, 5xx) are left out; negative answers are not measured; Pix Agendado key lookups are not measured"
}
},
"p95KeyRegistrationCodeSendTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95KeyRegistrationUserExperienceTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95KeyDeletionUserExperienceTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95PortabilityNotificationTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95PortabilitySendTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"p95MedOpeningTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
}
},
"dictLookups": {
"lookupCount": 48210,
"coverage": {
"status": "PARTIAL",
"reason": "a key lookup the client makes before the initiate is not seen; negative answers are not measured; Pix Agendado key lookups are not measured"
}
},
"availability": {
"availabilityIndex": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
},
"authorizationTimes": {
"p95AuthorizationTime": {
"value": "0.00",
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
}
},
"authorizations": {
"rows": [
{
"payerType": 1,
"authorizationCount": 0,
"activeAuthorizationCount": 0
},
{
"payerType": 2,
"authorizationCount": 0,
"activeAuthorizationCount": 0
}
],
"coverage": {
"status": "UNAVAILABLE",
"reason": "not computed by Pix Lerian"
}
}
}
}Parámetros de consulta
Respuesta
OK
¿Esta página le ayudó?

