Buscar informações de uma sessão de jornada
Sweeping Accounts V2 - Detail Journey Session API
Visão Geral
Esta API permite buscar os detalhes de uma sessão de jornada de sweeping accounts.
Endpoint
GET /open-keys/itp/api/v2/sweeping-accounts/v2/journeys-sessions/{id}Autenticação
A API requer autenticação OAuth2 com uma das seguintes permissões:
journey: Para fluxos que utilizam redirecionamento à detentora de contaapp: Para integrações diretas via API
O token de acesso deve ser enviado no header:
Authorization: Bearer {access_token}Exemplo de Requisição (cURL)
curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/sweeping-accounts/v2/journeys-sessions/6929f87b524daa7b8c72e28a' \
--header 'Authorization: ••••••'Exemplo de Requisição (JavaScript/Node.js)
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: 'https://api.exemplo.com/open-keys/itp/api/v2/sweeping-accounts/v2/journeys-sessions/6929f87b524daa7b8c72e28a',
headers: {
'Authorization': '••••••'
}
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
Exemplo de Requisição (Python)
import requests
url = "https://api.exemplo.com/open-keys/itp/api/v2/sweeping-accounts/v2/journeys-sessions/6929f87b524daa7b8c72e28a"
payload = {}
headers = {
'Authorization': '••••••'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
Resposta da API
Sucesso (200 OK)
A API retorna um objeto contendo:
{
"journeyId": "6927467b7220f7158cb60b3f",
"paymentInitiationData": {
"creditors": [
{
"name": "João Silva",
"cpfCnpj": "12345678909",
"personType": "PESSOA_NATURAL"
}
],
"loggedUser": {
"document": {
"identification": "12345678909",
"rel": "CPF"
}
},
"recurringConfiguration": {
"sweeping": {
"totalAllowedAmount": "10000.00",
"transactionLimit": "150.00",
"periodicLimits": {
"day": {
"quantityLimit": 5,
"transactionLimit": "25.00"
},
"week": {
"quantityLimit": 5,
"transactionLimit": "100.00"
},
"month": {
"quantityLimit": 5,
"transactionLimit": "300.00"
},
"year": {
"quantityLimit": 5,
"transactionLimit": "10000.00"
}
},
"startDateTime": "2025-11-27T16:00:00Z"
}
}
},
"redirectUrl": "http://localhost:8080/callback",
"paymentInitiationApi": "SWEEPING_ACCOUNTS_V2",
"applicationClientId": "openkeys_287f10e6-7917-4ff7-8291-e885a9e9076d",
"applicationId": "68a482d2b3ee755e8bbdec8a",
"tokenId": "6929f87b764d3127b812cea2",
"journeySessionStageId": "6929f87b524daa7b8c72e289",
"status": "CANCELLED",
"statusHistory": [
{
"updatedAt": "2025-11-28T19:31:07.153Z",
"status": "PENDING"
},
{
"updatedAt": "2025-11-28T19:31:29.985Z",
"status": "AWAITING_AUTHORISATION"
},
{
"updatedAt": "2025-11-28T19:32:04.977Z",
"status": "CANCELLED"
}
],
"createdAt": "2025-11-28T19:31:07.153Z",
"updatedAt": "2025-11-28T19:32:04.977Z",
"paymentInitiationId": "6929f87b524daa7b8c72e28b",
"id": "6929f87b524daa7b8c72e28a",
"token": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2OTI5Zjg3Yjc2NGQzMTI3YjgxMmNlYTIiLCJpc3MiOiJvcGVuLWtleXMtaXRwLXYyIiwiYXpwIjoib3BlbmtleXNfMjg3ZjEwZTYtNzkxNy00ZmY3LTgyOTEtZTg4NWE5ZTkwNzZkIiwic2NvcGUiOiJqb3VybmV5IiwiaWF0IjoxNzY0MzU4MjY3LCJleHAiOjE3NjQzNjE5Mjd9.qrhpUuDrQfezE2BkWdF7dQZ034kAj5lCG-2F6iIuiLE",
"createdAt": "2025-11-28T19:31:07.092Z",
"updatedAt": "2025-11-28T19:31:07.092Z",
"id": "6929f87b764d3127b812cea2"
},
"application": {
"id": "68a482d2b3ee755e8bbdec8a",
"name": "andre-dev",
"description": "Aplicação teste",
"image": "https://openplusdev.blob.core.windows.net/openplusdev/files/21cb64d5-15d4-4333-8974-b54958622aa0-Filipe_Mota_KF_BS_Tail_16x9-1.jpg",
"settings": []
},
"paymentInitiation": {
"brandId": "69025598418e4eda09274a00",
"redirectUrl": "http://localhost:8080/callback",
"data": {
"creditors": [
{
"name": "João Silva",
"cpfCnpj": "12345678909",
"personType": "PESSOA_NATURAL"
}
],
"loggedUser": {
"document": {
"identification": "12345678909",
"rel": "CPF"
}
},
"recurringConfiguration": {
"sweeping": {
"totalAllowedAmount": "10000.00",
"transactionLimit": "150.00",
"periodicLimits": {
"day": {
"quantityLimit": 5,
"transactionLimit": "25.00"
},
"week": {
"quantityLimit": 5,
"transactionLimit": "100.00"
},
"month": {
"quantityLimit": 5,
"transactionLimit": "300.00"
},
"year": {
"quantityLimit": 5,
"transactionLimit": "10000.00"
}
},
"startDateTime": "2025-11-27T16:00:00Z"
}
}
},
"journeySessionId": "6929f87b524daa7b8c72e28a",
"applicationId": "68a482d2b3ee755e8bbdec8a",
"paymentInitiationApi": "SWEEPING_ACCOUNTS_V2",
"tokenId": "6929f87b764d3127b812cea2",
"createdAt": "2025-11-28T19:31:07.173Z",
"updatedAt": "2025-11-28T19:31:30.008Z",
"authorizationUrl": "https://api-openfinance.opb.bricks.demo.fsapps.io/orgs/bricks/auth?client_id=CSYrcp9dzeRdUWbuXLFiF&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AsZtVGa1KI2u8XEtep32xe",
"ofConsentId": "6929f891524daa7b8c72e28d",
"id": "6929f87b524daa7b8c72e28b",
"ofPayments": [],
"ofConsent": {
"paymentInitiationId": "6929f87b524daa7b8c72e28b",
"consentId": "urn:bricks-demo:20249770-3daf-4b42-ac64-62358db4de24",
"organization_id": "c55ceb2e-c9fb-4989-8ed1-39208d6d7951",
"brand_id": "3a40d894-f3c2-47e3-97c2-d9a04cdac63c",
"authorization_url": "https://api-openfinance.opb.bricks.demo.fsapps.io/orgs/bricks/auth?client_id=CSYrcp9dzeRdUWbuXLFiF&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AsZtVGa1KI2u8XEtep32xe",
"consent_id": "urn:bricks-demo:20249770-3daf-4b42-ac64-62358db4de24",
"code_verifier": "zuSBhpxolj3jLW5-BYFlDFhp-GdZ2FZOJ8dy6SF12AU",
"nonce": "NYuv5Bz91H2xN7w-x7LLIJSPmVXLNvQIClFkw4Ucl8Q",
"state": "6929f87b524daa7b8c72e28b",
"redirect_uri": "https://smartkeys-wl.celcoin.hml.fsapps.io/callback",
"scope": "openid recurring-consent:urn:bricks-demo:20249770-3daf-4b42-ac64-62358db4de24 recurring-payments",
"consentTerm": 0,
"consentTermUnit": "M",
"creationDateTime": "2025-11-28T19:31:22.000Z",
"creditors": [
{
"personType": "PESSOA_NATURAL",
"cpfCnpj": "12345678909",
"name": "João Silva"
}
],
"events": [
{
"date": "2025-11-28T19:31:22.000Z",
"event": "AWAITING_AUTHORISATION"
},
{
"date": "2025-11-28T19:31:29.108Z",
"event": "REDIRECTED"
},
{
"date": "2025-11-28T19:32:04.147Z",
"event": "REJECTED"
}
],
"journey": [],
"kind": "AUTOMATIC_PAYMENT",
"loggedUser": {
"document": {
"identification": "12345678909",
"rel": "CPF"
}
},
"organizationLogo": "https://finansystech-pub.s3.sa-east-1.amazonaws.com/f_logo.svg",
"organizationName": "Finansystech Banking Demo Auth Server",
"ownerBrandId": "3a40d894-f3c2-47e3-97c2-d9a04cdac63c",
"ownerId": "c55ceb2e-c9fb-4989-8ed1-39208d6d7951",
"recurringConfiguration": {
"sweeping": {
"totalAllowedAmount": "10000.00",
"transactionLimit": "150.00",
"periodicLimits": {
"day": {
"quantityLimit": 5,
"transactionLimit": "25.00"
},
"week": {
"quantityLimit": 5,
"transactionLimit": "100.00"
},
"month": {
"quantityLimit": 5,
"transactionLimit": "300.00"
},
"year": {
"quantityLimit": 5,
"transactionLimit": "10000.00"
}
},
"startDateTime": "2025-11-27T16:00:00.000Z",
"useOverdraftLimit": true
}
},
"recurringConsentId": "urn:bricks-demo:20249770-3daf-4b42-ac64-62358db4de24",
"status": "REJECTED",
"statusUpdateDateTime": "2025-11-28T19:32:04.147Z",
"transactions": [],
"rejection": {
"rejectedBy": "INICIADORA",
"rejectedFrom": "INICIADORA",
"rejectedAt": "2025-11-28T19:31:48.000Z",
"reason": {
"code": "REJEITADO_USUARIO",
"detail": "REJEITADO_USUARIO"
}
},
"id": "6929f891524daa7b8c72e28d"
},
"brand": {
"AuthorisationServerId": "3a40d894-f3c2-47e3-97c2-d9a04cdac63c",
"ApiFamilyType": {
"payments-pix-recurring-payments-automatic": true,
"payments-pix-recurring-payments": true,
"enrollments": true,
"payments-pix": true
},
"CustomerFriendlyDescription": "Finansystech Banking Demo Auth Server",
"CustomerFriendlyLogoUri": "https://finansystech-pub.s3.sa-east-1.amazonaws.com/f_logo.svg",
"CustomerFriendlyName": "Finansystech Banking Demo Auth Server",
"Flags": {
"Suporta Contas PF": [
"Suporta Contas PF"
],
"Suporta Contas PJ": [
"Suporta Contas PJ"
]
},
"OpenIDDiscoveryDocument": "https://api-openfinance.opb.bricks.demo.fsapps.io/orgs/bricks/.well-known/openid-configuration",
"OrganisationId": "69025584418e4eda0927453c",
"OrganisationName": "CELCOIN INSTITUICAO DE PAGAMENTO S.A.",
"ParentAuthorisationServerId": null,
"id": "69025598418e4eda09274a00"
}
}
}Erros Comuns
401 Unauthorized
{
"error": "Unauthorized",
"message": "Token inválido ou expirado"
}Solução: Verifique se o token de acesso é válido e possui as permissões necessárias (journey ou app).
404 Not Found
{
"name": "EntityNotFoundError",
"message": "Entity not found",
"code": 404,
"type": null,
"data": {
"id": "692d800bfd35c73b8d02ee6"
}
}Solução: Verifique se o id enviado está correto.
Updated about 5 hours ago