v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Enrollment Payment Initiation

Lists enrollment payment initiations.

Method for listing enrollment payment initiations.

get/baas/v1/open/itp/enrollments/payment-initiation

Query parameters

pagestring

Page number.

pageSizestring

Size of a page.

initialDatestring
Example:2024-01-01

Date from format (ISO Date)

finalDatestring
Example:2024-12-31

Date to format (ISO Date)

querystring

Response

Enrollment payment initiations successfully listed.

Example response

{
  "data": [
    {
      "brandId": "66f4d9e296f18bc4606e1618",
      "journeySessionId": "f362a873-c127-4122-b711-a37b24a36914",
      "redirectUrl": "https://meuapp.exemplo.com/callback",
      "directoryCallback": true,
      "authorizationDevice": "Dispositivo de autorização",
      "data": {
        "enrollment": {
          "loggedUser": {
            "document": {
              "identification": "11122233344",
              "rel": "CPF"
            }
          },
          "businessEntity": {
            "document": {
              "identification": "00000000000191",
              "rel": "CNPJ"
            }
          },
          "debtorAccount": {
            "accountType": "CACC",
            "ispb": "00000000",
            "issuer": "0001",
            "number": "0001234567"
          },
          "enrollmentName": "Nome Dispositivo"
        },
        "riskSignals": {
          "deviceId": "00aa11bb22cc33dd",
          "osVersion": "14",
          "userTimeZoneOffset": "-03",
          "language": "pt",
          "accountTenure": "2023-08-20",
          "geolocation": {
            "type": "FINE"
          },
          "antennaInformation": "CellIdentityLte:{ mCi=2******60 mPci=274 mTac=5***1 mEarfcn=9510 mBands=[28] mBandwidth=2147483647 mMcc=724 mMnc=10 mAlphaLong=VIVO mAlphaShort=VIVO mAdditionalPlmns={} mCsgInfo=null}, CellIdentityLte:{ mCi=1*****01 mPci=361 mTac=3***6 mEarfcn=9410 mBands=[28] mBandwidth=2147483647 mMcc=724 mMnc=03 mAlphaLong=TIMBRASIL mAlphaShort=TIMBRASIL mAdditionalPlmns={} mCsgInfo=null}",
          "integrity": {
            "appRecognitionVerdict": "PLAY_RECOGNIZED",
            "deviceRecognitionVerdict": "['MEETS_DEVICE_INTEGRITY']"
          }
        }
      },
      "paymentInitiationApi": "ENROLLMENTS_V2",
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "journeySession": {
        "createdAt": "2024-01-01T20:32:44.581Z",
        "updatedAt": "2024-01-01T20:32:44.581Z",
        "deletedAt": "2024-01-01T20:32:44.581Z",
        "settings": [
          {
            "key": "JOURNEY_RULES"
          }
        ]
      },
      "authorizationUrl": "https://example.com",
      "ofEnrollment": {
        "authorization_url": "https://example.com",
        "redirect_uri": "https://example.com",
        "consentTerm": 0.123,
        "riskSignals": {
          "deviceId": "00aa11bb22cc33dd",
          "osVersion": "14",
          "userTimeZoneOffset": "-03",
          "language": "pt",
          "accountTenure": "2023-08-20",
          "geolocation": {
            "type": "FINE"
          },
          "antennaInformation": "CellIdentityLte:{ mCi=2******60 mPci=274 mTac=5***1 mEarfcn=9510 mBands=[28] mBandwidth=2147483647 mMcc=724 mMnc=10 mAlphaLong=VIVO mAlphaShort=VIVO mAdditionalPlmns={} mCsgInfo=null}, CellIdentityLte:{ mCi=1*****01 mPci=361 mTac=3***6 mEarfcn=9410 mBands=[28] mBandwidth=2147483647 mMcc=724 mMnc=03 mAlphaLong=TIMBRASIL mAlphaShort=TIMBRASIL mAdditionalPlmns={} mCsgInfo=null}"
        },
        "organizationLogo": "https://example.com",
        "status": "AWAITING_RISK_SIGNALS",
        "loggedUser": {
          "document": {
            "rel": "CPF"
          }
        }
      },
      "idempotencyKey": "783336ed-c1dd-40a8-b0b7-2e884b6221c2",
      "httpCalls": [
        {
          "response": {
            "status": "200",
            "statusText": "OK"
          },
          "createdAt": "2024-01-01T20:32:44.581Z",
          "updatedAt": "2024-01-01T20:32:44.581Z",
          "deletedAt": "2024-01-01T20:32:44.581Z"
        }
      ],
      "brand": {
        "createdAt": "2024-01-01T20:32:44.581Z",
        "updatedAt": "2024-01-01T20:32:44.581Z",
        "deletedAt": "2024-01-01T20:32:44.581Z",
        "settings": {
          "brandId": "66f4d9e296f18bc4606e1618",
          "sandboxUsersTests": [
            {
              "username": "usuario_teste",
              "password": "senha1234",
              "document": {
                "identification": "11122233344",
                "rel": "CPF"
              }
            }
          ],
          "updatedAt": "2024-09-26T03:51:03.642Z",
          "uptimeStatus": "OPERATIONAL",
          "id": "66f4da2796f18bc4606e2b87"
        }
      },
      "ofConsent": {
        "authorization_url": "https://example.com",
        "status": "AWAITING_AUTHORISATION",
        "organizationLogo": "https://example.com",
        "redirect_uri": "https://example.com",
        "consentTerm": 0.123,
        "creditor": {
          "cpfCnpj": "12345678000199",
          "personType": "PESSOA_JURIDICA",
          "name": "João da Silva Santos"
        },
        "loggedUser": {
          "document": {
            "identification": "11122233344",
            "rel": "CPF"
          }
        },
        "payment": {
          "type": "PIX",
          "date": "2025-08-05",
          "currency": "BRL",
          "amount": "10.00",
          "details": {
            "localInstrument": "DICT",
            "proxy": "usuario@ficticio.com",
            "creditorAccount": {
              "ispb": "00000000",
              "issuer": "0001",
              "number": "0001234567",
              "accountType": "CACC"
            }
          }
        },
        "rejectionReason": {
          "code": "TEMPO_EXPIRADO_AUTORIZACAO"
        }
      },
      "ofPayments": [
        {
          "localInstrument": "DICT",
          "payment": {
            "currency": "BRL",
            "amount": "1.00"
          },
          "creditorAccount": {
            "number": "1234567890",
            "accountType": "CACC",
            "ispb": "12345678",
            "issuer": "1774"
          },
          "cnpjInitiator": "13935893000109",
          "proxy": "cliente-a00001@pix.bcb.gov.br",
          "endToEndId": "E13935893202511021042TKe1h8bM2FO",
          "authorisationFlow": "FIDO_FLOW",
          "creationDateTime": "2025-11-13T21:41:49Z",
          "debtorAccount": {
            "ispb": "12345678",
            "issuer": "0001",
            "number": "969139",
            "accountType": "CACC"
          },
          "paymentId": "9917ab8f-e134-490b-b2b5-59ecd4e0abd0",
          "status": "ACSC",
          "statusUpdateDateTime": "2025-11-13T21:41:56Z",
          "id": "EXAMPLE-PAYMENT-ID-0002"
        }
      ],
      "ofConsentId": "EXAMPLE-CONSENT-ID-0001"
    }
  ],
  "meta": {
    "total": 0.123,
    "page": 0.123,
    "pageSize": 0.123,
    "totalPages": 0.123
  }
}