v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

get status from id

Get status from a particular transaction.

get/baas/v1/open/itp/sweeping-accounts/payment-initiation/{id}

Path parameters

idstring required

Response

brandIdstring
redirectUrlstring
journeySessionIdstring
applicationIdstring
paymentInitiationApistring
tokenIdstring
createdAtstring
updatedAtstring
authorizationUrlstring
ofConsentIdstring
idstring
ofPaymentsobject[]
ofHttpCallsobject[]

Example response

{
  "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": "692d800bfd35c73b8d02ee6b",
  "applicationId": "68a482d2b3ee755e8bbdec8a",
  "paymentInitiationApi": "SWEEPING_ACCOUNTS_V2",
  "tokenId": "692d800b764d313b8d387cbe",
  "createdAt": "2025-12-01T11:46:19.979Z",
  "updatedAt": "2025-12-01T11:46:35.815Z",
  "authorizationUrl": "https://api-openfinance.opb.bricks.demo.fsapps.io/orgs/bricks/auth?client_id=CSYrcp9dzeRdUWbuXLFiF&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AQKOIr54kltrVuJPZpS4tx",
  "ofConsentId": "692d801bfd35c73b8d02ee6e",
  "id": "692d800bfd35c73b8d02ee6c",
  "ofConsent": {
    "paymentInitiationId": "692d800bfd35c73b8d02ee6c",
    "consentId": "urn:bricks-demo:8ea46973-22fc-417a-a86a-6d69191f5bfb",
    "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%3AQKOIr54kltrVuJPZpS4tx",
    "consent_id": "urn:bricks-demo:8ea46973-22fc-417a-a86a-6d69191f5bfb",
    "code_verifier": "si6u3AwiSXE5VuKb9WkWsUIPbcravAvTvFK8G31K6Ds",
    "nonce": "26tGV2kt-NrsZBw5AFTKVlRGDWm7Q1051uAu-iMcXFg",
    "state": "692d800bfd35c73b8d02ee6c",
    "redirect_uri": "https://smartkeys-wl.celcoin.hml.fsapps.io/callback",
    "scope": "openid recurring-payments recurring-consent:urn:bricks-demo:8ea46973-22fc-417a-a86a-6d69191f5bfb",
    "consentTermUnit": "M",
    "creationDateTime": "2025-12-01T11:46:29.000Z",
    "creditors": [
      {
        "personType": "PESSOA_NATURAL",
        "cpfCnpj": "12345678909",
        "name": "João Silva"
      }
    ],
    "events": [
      {
        "date": "2025-12-01T11:46:29.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:8ea46973-22fc-417a-a86a-6d69191f5bfb",
    "status": "AUTHORISED",
    "statusUpdateDateTime": "2025-12-01T11:47:49.279Z",
    "access_token": "Uypz_o5xWzymdKkEbyY4FegJSXAjGSetBuYla9QqlJQ",
    "expires_at": 1764590569,
    "id_token": "eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlZMdThGLXgybk9JRlp2em5RcmwwbDQ1TkdmS0Y0aFpHQ0pUNy1peTVpRWcifQ.eyJzdWIiOiI3OWI1ZjU0OTE4NjI4Y2M3ZjZhOTAwYTM4NmQxNGEwNCIsImFjciI6InVybjpicmFzaWw6b3BlbmJhbmtpbmc6bG9hMiIsIm5vbmNlIjoiMjZ0R1Yya3QtTnJzWkJ3NUFGVEtWbFJHRFdtN1ExMDUxdUF1LWlNY1hGZyIsImF0X2hhc2giOiJrcXc0eVk5d2dXalhRZEt0MmVPZ19BIiwiYXVkIjoiQ1NZcmNwOWR6ZVJkVVdidVhMRmlGIiwiZXhwIjoxNzY0NTkzMjY5LCJpYXQiOjE3NjQ1ODk2NjksImlzcyI6Imh0dHBzOi8vYXBpLW9wZW5maW5hbmNlLm9wYi5icmlja3MuZGVtby5mc2FwcHMuaW8vb3Jncy9icmlja3MifQ.j4vQd2IrBU8ZjmNb6GPq-0qO1tRGpo7rSV73kHOrAJvI7Td5XSe-CsNo_Nrm2y1GNDzEC0SAc74y1KGz2IdO72AAEQHfaBNCMxlS4RANuL8-O6DWfqpcYo-CiDcgB0nda8qKR7FqlfRCm9YchVxf9Sk2YDjI4i0hSccPgrjO_qf-IQOmmAb_sbMy22rPrEEpvIC33OmVSGgnHyVMY6uTAGckKRNMgjV3XinhTRWigUFRUyhDFBqYQCnoCZVaxAUF6eLHe27q5sTS6uiSUGmnXu4iWn9EwRfDR60Jpv22pYOzhAYUVnFBDzgx0CT4jQrrDFUHBqe1v2AaCL_qqr03Yw",
    "refresh_token": "1rqgwxSKoAFaYsSVhoZk363cjsKE89F6dbrUYXwlXMD",
    "token_type": "Bearer",
    "id": "692d801bfd35c73b8d02ee6e"
  },
  "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"
  }
}