v1
latestOpenAPI 3.0.12026-07-245303882.5 MBlist operations
List all available payment initiations for the sweeping account operation.
get/baas/v1/open/itp/sweeping-accounts/payment-initiation
Query parameters
pageinteger
pageSizeinteger
initialDatestring
YYYY-MM-DD
finalDatestring
YYYY-MM-DD
status'PENDING' | 'CANCELLED' | 'EXPIRED' | 'AWAITING_AUTHORISATION' | 'AUTHORISED' | 'CONSUMED' | 'REJECTED' | 'FINISHED'
Response
Example response
{
"data": [
{
"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": "6929b540e927320636bcf559",
"applicationId": "68a482d2b3ee755e8bbdec8a",
"paymentInitiationApi": "SWEEPING_ACCOUNTS_V1",
"tokenId": "6929b540764d31106330116e",
"createdAt": "2025-11-28T14:44:16.666Z",
"updatedAt": "2025-11-28T14:44:36.007Z",
"authorizationUrl": "https://api-openfinance.opb.bricks.demo.fsapps.io/orgs/bricks/auth?client_id=CSYrcp9dzeRdUWbuXLFiF&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AApsnZs95664OrhKHjL3_H",
"ofConsentId": "6929b553e927320636bcf55c",
"journeySession": {
"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_V1",
"applicationClientId": "openkeys_287f10e6-7917-4ff7-8291-e885a9e9076d",
"applicationId": "68a482d2b3ee755e8bbdec8a",
"tokenId": "6929b540764d31106330116e",
"journeySessionStageId": "6929b540e927320636bcf558",
"status": "AUTHORISED",
"statusHistory": [
{
"updatedAt": "2025-11-28T14:44:16.645Z",
"status": "PENDING"
}
],
"createdAt": "2025-11-28T14:44:16.646Z",
"updatedAt": "2025-11-28T14:47:26.738Z",
"paymentInitiationId": "6929b540e927320636bcf55a",
"id": "6929b540e927320636bcf559",
"token": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2OTI5YjU0MDc2NGQzMTEwNjMzMDExNmUiLCJpc3MiOiJvcGVuLWtleXMtaXRwLXYyIiwiYXpwIjoib3BlbmtleXNfMjg3ZjEwZTYtNzkxNy00ZmY3LTgyOTEtZTg4NWE5ZTkwNzZkIiwic2NvcGUiOiJqb3VybmV5IiwiaWF0IjoxNzY0MzQxMDU2LCJleHAiOjE3NjQzNDQ3MTZ9.CFH6NKzVIUFZM-Mdd01qCoGmrObpETV5-xiwNrT9Zzs",
"createdAt": "2025-11-28T14:44:16.583Z",
"updatedAt": "2025-11-28T14:44:16.583Z",
"id": "6929b540764d31106330116e"
}
},
"id": "6929b540e927320636bcf55a",
"ofConsent": {
"paymentInitiationId": "6929b540e927320636bcf55a",
"consentId": "urn:bricks-demo:25ec7939-0798-4e5b-a19e-93068a89d432",
"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%3AApsnZs95664OrhKHjL3_H",
"consent_id": "urn:bricks-demo:25ec7939-0798-4e5b-a19e-93068a89d432",
"code_verifier": "1kyhnXsshxxXYETaLktCjy0e33q-7LtKUsFResa4_ik",
"nonce": "yqZ2oXjo4HB280dOLZyRq8zNJo8j8u8yipRhDmMSohE",
"state": "6929b540e927320636bcf55a",
"redirect_uri": "https://smartkeys-wl.celcoin.hml.fsapps.io/callback",
"scope": "openid recurring-payments recurring-consent:urn:bricks-demo:25ec7939-0798-4e5b-a19e-93068a89d432",
"consentTermUnit": "M",
"creationDateTime": "2025-11-28T14:44:25.000Z",
"creditors": [
{
"personType": "PESSOA_NATURAL",
"cpfCnpj": "12345678909",
"name": "João Silva"
}
],
"events": [
{
"date": "2025-11-28T14:44:25.000Z",
"event": "AWAITING_AUTHORISATION"
}
],
"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:25ec7939-0798-4e5b-a19e-93068a89d432",
"status": "AUTHORISED",
"statusUpdateDateTime": "2025-11-28T14:47:25.867Z",
"access_token": "n5ZFf8hosTujJD44yqJmgFqOqjT8ApiKikKxLY4_530",
"expires_at": 1764342145,
"id_token": "eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlZMdThGLXgybk9JRlp2em5RcmwwbDQ1TkdmS0Y0aFpHQ0pUNy1peTVpRWcifQ.eyJzdWIiOiI3OWI1ZjU0OTE4NjI4Y2M3ZjZhOTAwYTM4NmQxNGEwNCIsImFjciI6InVybjpicmFzaWw6b3BlbmJhbmtpbmc6bG9hMiIsIm5vbmNlIjoieXFaMm9Yam80SEIyODBkT0xaeVJxOHpOSm84ajh1OHlpcFJoRG1NU29oRSIsImF0X2hhc2giOiJsRmJxTEl5ZzN1MlRTMFB1a0d0SUF3IiwiYXVkIjoiQ1NZcmNwOWR6ZVJkVVdidVhMRmlGIiwiZXhwIjoxNzY0MzQ0ODQ1LCJpYXQiOjE3NjQzNDEyNDUsImlzcyI6Imh0dHBzOi8vYXBpLW9wZW5maW5hbmNlLm9wYi5icmlja3MuZGVtby5mc2FwcHMuaW8vb3Jncy9icmlja3MifQ.Ah5CjJ9g1RQAz1j8nVEXdmfdeTXPHMa83PCwXj1nHGp8gYt_KUjld_hqEscXF-RwPRWg9o28wtqRiPFmx0srZDglt55Op0OMx7ToTgomYnstmkKW_3x1x4hvX8S5bingmmrZop4N3UrRhj-Z5ts_Fu91d-kq5EqY4afzvMuTLA-lfqo4wgf_8xgBImK_dnllkB0GVajlegjn_Zl4eCGPiLZfgxjGTjJuYkwSaNkLsKIeKhhahayDZbi7qjUp2h9fHIn8ic1aDUkdndx_Eae0xD4gSSonu1OhLlSOD9zclvZRX4S-7WLe88ZNLElH6uLsLkGlwrzLhw_e7v9re5_V6g",
"refresh_token": "6asxVcFQPrcigjAOqPxl4BwERw0Md4-ibvUJO9uDj5j",
"token_type": "Bearer",
"id": "6929b553e927320636bcf55c"
},
"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.",
"id": "69025598418e4eda09274a00"
}
}
],
"meta": {
"total": 5,
"page": 1,
"pageSize": 1,
"totalPages": 5
}
}