ITP – Jornada de Pagamento com Redirecionamento

💡 A Jornada de Pagamento por Redirecionamento permite que o usuário seja direcionado ao banco para autenticação e autorização, garantindo segurança e conformidade com o Open Finance.

Introdução

A Iniciação de Transação de Pagamento (ITP) permite que o usuário realize pagamentos diretamente a partir de um iniciador, utilizando APIs do Open Finance.

Visão Geral da Jornada

Etapas principais:

Usuário inicia pagamento no seu app
Celcoin cria a jornada e gera o checkout
Usuário escolhe o banco
Banco autentica e autoriza
Banco devolve usuário à Celcoin
Celcoin finaliza
Usuário é redirecionado à sua redirectUrl

Pré-Requisitos

Você não poderá iniciar uma jornada, sem antes configurar previamente na API:

Conta de crédito

Onde o dinheiro será recebido.

Redirect URL

Para onde o usuário será enviado ao finalizar o fluxo bancário.

Webhooks

Usados para callbacks de status, sucesso e falhas.

Cadastro de Conta de Crédito

A conta de crédito deve ser cadastrada na API e será utilizada como o recebedor da operação, no momento da criação da Jornada.

POST `/baas/v1/open/itp/applications/applicationId/accounts`

curl --location 'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/applications/{applicationid}/accounts' \
--data '{
  "owner": {
    "personType": "PESSOA_JURIDICA",
    "cpfCnpj": "48572054000158",
    "name": "BaaS ITP"
  },
  "paymentAccount": {
    "accountType": "TRAN",
    "ispb": "13935893",
    "number": "4236311",
    "issuer": "0001"
  },
  "paymentKey": {
    "keyType": "CNPJ",
    "key": "48572054000158"
  }
}'

🔗 API Reference - Criação de conta de crédito

Body

Nome do campo	Tipo de preenchimento	Descrição do preenchimento	Obrigatório / Opcional
owner	object	Objeto contendo as informações do titular da conta.	Obrigatório
owner.personType	enum	Tipo de pessoa: `PESSOA_NATURAL` ou `PESSOA_JURIDICA`.	Obrigatório
owner.cpfCnpj	string	CPF ou CNPJ do titular da conta.	Obrigatório
owner.name	string	Nome ou razão social do titular.	Obrigatório
paymentAccount	object	Informações da conta de pagamento que será vinculada.	Obrigatório
paymentAccount.accountType	enum	Tipo da conta (`TRAN`, `CACC`, `SVGS` e `SLRY`)	Obrigatório
paymentAccount.ispb	string	Código ISPB da instituição financeira.	Obrigatório
paymentAccount.number	string	Número da conta.	Obrigatório
paymentAccount.issuer	string	Agência da conta.	Obrigatório
paymentKey	object	Informações da chave de pagamento associada.	Obrigatório
paymentKey.keyType	enum	Tipo da chave: `CPF`, `CNPJ`, `EMAIL`, `PHONE`, `EVP`.	Obrigatório
paymentKey.key	string	Valor da chave (ex: CPF, CNPJ, e-mail ou telefone).	Obrigatório

Exemplo de resposta

{
    "owner": {
        "personType": "PESSOA_JURIDICA",
        "cpfCnpj": "48572054000158",
        "name": "BaaS ITP"
    },
    "paymentAccount": {
        "accountType": "TRAN",
        "ispb": "13935893",
        "number": "4236311",
        "issuer": "0001"
    },
    "paymentKey": {
        "keyType": "CNPJ",
        "key": "48572054000158"
    },
    "applicationId": "12eb0ff4-b190-4822-9e7f-0368d06c578f",
    "createdAt": "2025-11-18T20:06:49.098Z",
    "updatedAt": "2025-11-18T20:06:49.098Z",
    "id": "691cd1d9c67b010011965d2a"
}

Importante: Ao armazenar o ID da conta de crédito, é preciso relacionar diretamente ao ApplicationID utilizado na criação.

Cadastro de URL de Redirecionamento

O usuário será enviado a esta URL ao término da jornada.

POST `/baas/v1/open/itp/applications/applicationId/redirects`

curl --location \
'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/applications/{applicationid}/redirects' \
--data '{
"allowedRedirectUrl": "https://www.celcoin.com.br/"
}'

Body

Nome do campo	Tipo de preenchimento	Descrição do preenchimento
allowedRedirectUrl	string	URL autorizada para redirecionamento após conclusão da jornada ou fluxo.

🔗 API Reference - Criação de URL de redirecionamento

Exemplo de resposta

{
    "allowedRedirectUrl": "https://www.celcoin.com.br/",
    "applicationId": "12eb0ff4-b190-4822-9e7f-0368d06c578f",
    "createdAt": "2025-11-18T20:12:15.558Z",
    "updatedAt": "2025-11-18T20:12:15.558Z",
    "id": "691cd31fc67b010011965d2b"
}

📘
Importante: Ao armazenar o ID da conta de crédito, é preciso relacionar diretamente ao ApplicationID utilizado na criação.

Cadastro de Webhooks

📢 Importante: O webhook irá notificá-lo sobre a atualização do status da transação do ITP.

POST `/baas/v1/open/itp/applications/applicationId/webhooks`

curl --location \
'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/applications/{applicationid}/webhooks' \
--data '{
  "authentication": {
    "authType": "basic_auth",
    "data": {
      "username": "teste",
      "password": "teste"
    }
  },
  "endpointBaseUrl": "https://webhook.celcoin/01b4efe0-646f-4480-b022-c27b6212e43b",
  "externalEndpoint": true,
   "externalEndpointUrl": "https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/payments/journeys-sessions/"
}

🔗 API Reference - Cadastro URL para recebimento de webhook

Body

Nome do campo	Tipo de preenchimento	Descrição do preenchimento	Obrigatório / Opcional
authentication	object	Objeto contendo as informações de autenticação utilizadas para chamadas ao webhook.	Obrigatório
authentication.authType	enum	Tipo de autenticação configurada (ex.: `basic_auth`, `bearer_token`, `no_auth` `api_key`).	Obrigatório
authentication.data	object	Dados usados no método de autenticação configurado.	Obrigatório quando authType requer credenciais
authentication.data.username	string	Usuário para autenticação Basic Auth.	Obrigatório quando authType = basic_auth
authentication.data.password	string	Senha para autenticação Basic Auth.	Obrigatório quando authType = basic_auth
endpointBaseUrl	string (URL)	URL base para onde os eventos serão enviados pelo webhook.	Obrigatório
externalEndpoint	boolean	Obrigatório o preenchimento como `true` para a utilização junto ao BaaS	Obrigatório
externalEndpointUrl	string (URL fixa)	Obrigatório o preenchimento fixo como `https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/payments/journeys-sessions/` para a utilização junto ao BaaS	Obrigatório

Exemplo de resposta

{
    "applicationId": "12eb0ff4-b190-4822-9e7f-0368d06c578f",
    "authentication": {
        "authType": "basic_auth",
        "data": {
            "username": "teste",
            "password": "teste"
        }
    },
    "endpointBaseUrl": "https://webhook.site/01b4efe0-646f-4480-b022-c27b6212e43b",
    "updatedAt": "2025-12-04T19:00:00.111Z",
    "externalEndpoint": true,
    "externalEndpointUrl": "https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/payments/journeys-sessions/",
    "id": "6925c7652b6278e5fcbacf4c"
}

Customização da Jornada (Whitelabel)

✨ Permite personalizar a aparência da jornada exibida ao usuário.

POST `/baas/v1/open/itp/applications/applicationId/settings`

curl --location \
'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/applications/{applicationid}/settings' \
--data '{
"key": "FAVICON",
"value": "iVBORw0KGgoAAAANSUhEUgAAAVQAAAGvEAYAAABUV/EsAAAABG..."
}'

🔗 API Reference - Customização da Jornada

Body

Key	Descrição	Value	Exemplo
FAVICON	Define o favicon exibido na jornada whitelabel.	Url para carregar o Favicon (string)	`"iVBORw0KGgoAAAANSUhEUgAA..."`
PRIMARY_COLOR	Define a cor primária da aplicação whitelabel.	Hexadecimal (string)	`"#4A90E2"`
JOURNEY_DEFAULT_ALIAS	Define o texto utilizado na aba de navegação da jornada.	Texto (string)	`Checkout de Redirecionamento ITP`
IDENTITY_PROVIDER	Define o provedor de identidade para gestão do usuário.	String	``

Exemplo de resposta

{
    "applicationId": "12eb0ff4-b190-4822-9e7f-0368d06c578f",
    "key": "FAVICON",
    "updatedAt": "2025-11-18T20:21:23.036Z",
    "value": "iVBORw0KGgoAAAANSUhEUgAAAVQAAAGvEAYAAABUV/EsAAAABG...”,
    "id": "691cd5432b6278e5fc11cc23"
}

Consulta de Participantes

🔍 Útil para exibir todos os detalhes dos bancos disponíveis no ecosistema do Open Finance. Você pode listar todos os participantes do ecosistema, assim como pode consultar um participante individualmente.

Listar participantes

GET `/baas/v1/open/itp/participants/brands`

curl --location 'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/participants/brands'

🔗 API Reference - Lista as detentoras participantes do ITP

Consultar participante individual

GET `/baas/v1/open/itp/participants/brands/brandId`

curl --location 'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/participants/brands/66f4d9e296f18bc4606e14ca'

API Reference - Detalhes de uma detentora participante do ITP

Exemplo de resposta

{
    "AuthorisationServerId": "c34022ef-6542-4056-a12e-71b4bf498792",
    "CustomerFriendlyDescription": "Authorization Server Ambiente de Teste PingFederate",
    "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
    "CustomerFriendlyName": "Santander Test",
    "Flags": {
        "Suporta Contas PF": [
            "Suporta Contas PF"
        ],
        "Suporta Contas PJ": [
            "Suporta Contas PJ"
        ]
    },
    "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/santander-tst/.well-known/openid-configuration",
    "OrganisationId": "66f4d9d996f18bc4606e0cec",
    "ParentAuthorisationServerId": null,
    "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
    "ApiFamilyType": {},
    "id": "66f4d9e296f18bc4606e14ca",
    "organisationBrands": [
        {
            "AuthorisationServerId": "b6100081-aaf5-4c25-bc0f-2b712798058a",
            "CustomerFriendlyDescription": "Santander Corretora Pessoa Física",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
            "CustomerFriendlyName": "Santander Corretora Pessoa Física",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/ccvm/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14d4"
        },
        {
            "AuthorisationServerId": "37d53ce8-a901-4e70-bfa3-587203930b85",
            "CustomerFriendlyDescription": "Olé Consignado",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-ole-obk/21-08-11_220517_P_logo-ole-open-banking.svg",
            "CustomerFriendlyName": "Olé Consignado",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/ole/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14c0"
        },
        {
            "AuthorisationServerId": "07b7bd3a-fb8d-43a9-b17f-712356007bde",
            "CustomerFriendlyDescription": "Alteração do nome conforme produção",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
            "CustomerFriendlyName": "Banco Santander Pessoa Física",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/santander-pf/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {
                "payments-pix-recurring-payments": true,
                "enrollments": true,
                "payments-pix": true
            },
            "id": "66f4d9e296f18bc4606e14c2"
        },
        {
            "AuthorisationServerId": "554cec86-497c-4743-9bf5-f904b757d552",
            "CustomerFriendlyDescription": "alteração do nome",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
            "CustomerFriendlyName": "Banco Santander Pessoa Jurídica",
            "Flags": {
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/santander-pj/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {
                "payments-pix-recurring-payments": true,
                "enrollments": true,
                "payments-pix": true
            },
            "id": "66f4d9e296f18bc4606e14cc"
        },
        {
            "AuthorisationServerId": "84303d99-23f3-48dd-adc1-0004fcd3750d",
            "CustomerFriendlyDescription": "teste em sua v5",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "SatanderRPv5",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/ST1st/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14da"
        },
        {
            "AuthorisationServerId": "2bbf9923-1c36-4e37-8b01-9717ac0d66d1",
            "CustomerFriendlyDescription": "Certificação FAPI DTH-INIC 02",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "Certificação FAPI DTH-INIC 02",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://demo.certification.openid.net/test/a/dth-inic-02/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ParentAuthorisationServerId": null,
            "ApiFamilyType": {
                "payments-pix": true
            },
            "id": "67b33e1ff74851b409e618a5"
        },
        {
            "AuthorisationServerId": "3bb3a4f8-47d3-4847-ba56-c07cada4e24e",
            "CustomerFriendlyDescription": "Santander Cartoes PJ",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
            "CustomerFriendlyName": "Santander Cartões Pessoa Jurídica",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/cartoes-pj/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14e0"
        },
        {
            "AuthorisationServerId": "91ef64b6-0687-4f71-bfe9-fbcb2ee75c56",
            "CustomerFriendlyDescription": "AuthServer para testes da Iniciação de Pagamento",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "Santander Payment Inic",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/InicPayS/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14e6"
        },
        {
            "AuthorisationServerId": "91385a96-04c0-4c99-880d-93c13cf689eb",
            "CustomerFriendlyDescription": "Santander Cartões Pessoa Fisica",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
            "CustomerFriendlyName": "Santander Cartões Pessoa Fisica",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/cartoes/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14c6"
        },
        {
            "AuthorisationServerId": "9598bc9d-fbae-448b-b562-70c3316999ec",
            "CustomerFriendlyDescription": "teste",
            "CustomerFriendlyLogoUri": "https://logodownload.org/teste.svg",
            "CustomerFriendlyName": "SantanderLocal",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://localhost.emobix.co.uk/test/a/ST1st/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14ce"
        },
        {
            "AuthorisationServerId": "005081ea-c951-4508-94bb-ab0cd71fa31e",
            "CustomerFriendlyDescription": "Servidor para Testes do Fapi Único DTH INIC",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "Certificação Fapi DTH INIC",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://demo.certification.openid.net/test/a/ST1st/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {
                "payments-pix": true
            },
            "id": "66f4d9e296f18bc4606e14ea"
        },
        {
            "AuthorisationServerId": "8bca392e-1c6b-4e6a-9fb4-20fcdff2b468",
            "CustomerFriendlyDescription": "teste em sua v6",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "SatanderRPv6",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/st1/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14de"
        },
        {
            "AuthorisationServerId": "cab80c21-f184-4650-8d0c-cb7c0c273dc7",
            "CustomerFriendlyDescription": "Santander Crédito Imobiliário Empresas é uma marca do Banco Santander que atua desde 1982 oferecendo negócios imobiliários em seus canais.",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
            "CustomerFriendlyName": "Santander Crédito Imobiliário Empresas",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/imobiliariopj/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14e3"
        },
        {
            "AuthorisationServerId": "05d4d1cb-e30b-4038-981a-d93d603a22be",
            "CustomerFriendlyDescription": "Segundo teste",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "SantanderRPv2",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/ST1st/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14d2"
        },
        {
            "AuthorisationServerId": "d4c9f80f-d78e-4251-a4e7-07bf298678de",
            "ApiFamilyType": {
                "payments-pix": true
            },
            "CustomerFriendlyDescription": "Servidor para certificação fapi",
            "CustomerFriendlyLogoUri": "https://certification.openid.net/img.svg",
            "CustomerFriendlyName": "DTH INIC Certificação FAPI 2026",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/ST1stinic/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ParentAuthorisationServerId": null,
            "id": "6900de69dfdf118e980e1076"
        },
        {
            "AuthorisationServerId": "e1e0b08e-3887-4240-a922-95e2844c919e",
            "CustomerFriendlyDescription": "testev7",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "SantanderRPv7",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/st1/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14dc"
        },
        {
            "AuthorisationServerId": "dde75242-5e6c-4e25-b1e8-4f0575e29822",
            "CustomerFriendlyDescription": "Certificação FAPI 2025 DTH",
            "CustomerFriendlyLogoUri": "https://certification.openid.net/img.svg",
            "CustomerFriendlyName": "DTH Certificação FAPI 2025",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/ST1stv2/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {
                "payments-pix": true
            },
            "id": "66f4d9e296f18bc4606e14d0"
        },
        {
            "AuthorisationServerId": "6a292d3c-ecf1-4511-8d93-295607df03fb",
            "CustomerFriendlyDescription": "Servidor para Testes do Fapi Único DTH INIC",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "Certificação FAPI-RP Pagamentos",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://demo.certification.openid.net/test/a/fapi-rp/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ParentAuthorisationServerId": null,
            "ApiFamilyType": {
                "payments-pix": true
            },
            "id": "67b33e1ff74851b409e618a2"
        },
        {
            "AuthorisationServerId": "f819f705-988e-4574-8363-a4939c1cb00e",
            "CustomerFriendlyDescription": "Teste v3",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "SatanderRPv3",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/ST1st/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14d6"
        },
        {
            "AuthorisationServerId": "6bc3f51f-9520-41a4-b440-b2673d507643",
            "CustomerFriendlyDescription": "Santander Amex authorization Server",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/documentos/img-amex-1-svg/24-06-17_171200_santander_amex_512%20x%20512.svg",
            "CustomerFriendlyName": "Santander Amex",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/amex/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14c4"
        },
        {
            "AuthorisationServerId": "072ad103-4ce2-4af0-a4b2-e1ff27d61ab1",
            "CustomerFriendlyDescription": "teste",
            "CustomerFriendlyLogoUri": "https://openid.net/wp-content/uploads/2022/11/df-l-oix-l-openid_rgb-300dpi.svg",
            "CustomerFriendlyName": "Santander RP novo",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/ST1st/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14e1"
        },
        {
            "AuthorisationServerId": "de1e25b6-96dc-4b8b-88ef-14f1cf0f0190",
            "CustomerFriendlyDescription": "Banco Santander Crédito Imobiliario",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
            "CustomerFriendlyName": "Santander Crédito Imobiliário Pessoas",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ]
            },
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/imobiliariopf/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14e8"
        },
        {
            "AuthorisationServerId": "eaae0ea5-8978-450c-ab85-30bbe10d275f",
            "CustomerFriendlyDescription": "Authorization Server Ambiente de Stage",
            "CustomerFriendlyLogoUri": "https://cms.santander.com.br/sites/WPS/imagem/img-santander-chama/21-08-06_200409_P_santander_chama.svg",
            "CustomerFriendlyName": "Santander Stage",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://openbanking-h.api.santander.com.br/open-banking/security/v2/obk-int/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14c8"
        },
        {
            "AuthorisationServerId": "29e235d1-fa61-447b-9e6a-9165684522c7",
            "CustomerFriendlyDescription": "testev4",
            "CustomerFriendlyLogoUri": "https://www.certification.openid.net/img.svg",
            "CustomerFriendlyName": "SatanderRPv4",
            "Flags": {},
            "OpenIDDiscoveryDocument": "https://www.certification.openid.net/test/a/ST1st/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0cec",
            "ParentAuthorisationServerId": null,
            "OrganisationName": "BCO SANTANDER (BRASIL) S.A.",
            "ApiFamilyType": {},
            "id": "66f4d9e296f18bc4606e14d8"
        }
    ]
}

Criação da Jornada de pagamento com redirecionamento

O endpoint mais importante de toda a integração.

POST `/baas/v1/open/itp/payments/journeys-sessions`

curl --location 'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/payments/journeys-sessions' \
--data '{
    "journeyId": "payments-redirect",
    "paymentInitiationData": {
        "loggedUser": {
            "document": {
                "identification": "12345678909",
                "rel": "CPF"
            }
        },
        "creditorAccountId": "691cd1d9c67b010011965d2a",
        "payment": {
            "type": "PIX",
            "date": "2025-11-25",
            "currency": "BRL",
            "amount": "1.00",
            "details": {
                "localInstrument": "DICT", 
                "proxy": "48572054000158"   
            }
        }
    },
    "redirectUrl": "https://www.celcoin.com.br/",
    "settings": [
        {
            "key": "PRIORITIES_BRANDS",
            "value": [
                "6675da380656c2806df52bdb",
                "6675da380656c2806df52b8a",
                "6675da380656c2806df52cc2",
                "6675da380656c2806df52bb9",
                "6675da380656c2806df52be1",
                "6675da380656c2806df52cbd"
            ]
        },
        {
            "key": "JOURNEY_RULES",
            "value": [
                {
                    "path": "homeButton",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.loggedUser.document.identification",
                    "optional": true,
                    "editable": false
                },
                {
                    "path": "brandId",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.payment.amount",
                    "optional": false,
                    "editable": false
                },
                {
                    "path": "paymentInitiationData.remittanceInformation",
                    "optional": true,
                    "editable": false
                },
                {
                    "path": "paymentInitiationData.payment.date",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.payment.schedule",
                    "optional": true,
                    "editable": false
                }
            ]
        }
    ]
}'

API Reference - Criação de uma Jornada de redirecionamento

Body

Nome do Campo	Tipo de Preenchimento	Descrição do Preenchimento	Obrigatório / Opcional
journeyId	string	Identificador da jornada a ser utilizada. (`payments-redirect`, `payments-schedule-redirect`, `payments-fido`)	Obrigatório
brandId	string	ID da instituição participante que será feito o pagamento. Ao preencher esse campo, a instituição estará pré-selecionada na jornada.	Opcional
externalId	string	Identificador único da jornada, definido pelo cliente para fins de conciliação	Opcional
paymentInitiationData	object	Objeto principal contendo dados da iniciação de pagamento.	Obrigatório
paymentInitiationData.loggedUser	object	Informações do usuário logado, que será o pagador da operação.	Obrigatório
paymentInitiationData.loggedUser.document	object	Documento de identificação do usuário.	Obrigatório
paymentInitiationData.loggedUser.document.identification	string	Número do documento (CPF/CNPJ).	Obrigatório
paymentInitiationData.loggedUser.document.rel	string	Tipo do documento ( `CPF` ou `CNPJ`).	Obrigatório
paymentInitiationData.creditorAccountId	string	ID da conta de crédito	Obrigatório
paymentInitiationData.payment	object	Dados do pagamento.	Obrigatório
paymentInitiationData.payment.type	enum	Tipo de pagamento (`PIX`)	Obrigatório
paymentInitiationData.payment.currency	string	Código da moeda (ex: `BRL`).	Obrigatório
paymentInitiationData.payment.amount	string	Valor do pagamento.	Obrigatório
paymentInitiationData.payment.details	object	Detalhes adicionais do pagamento.	Obrigatório
paymentInitiationData.payment.details.localInstrument	enum	Instrumento de pagamento (ex: `QRDN`, `QRES`, `MANU`,`DICT` e `INIC`).	Obrigatório
paymentInitiationData.payment.details.proxy	string	Chave Pix.	Obrigatório para instrumento DICT
paymentInitiationData.payment.details.qrCode	string	EMV do QR Code	Obrigatório para instrumento QRDN ou QRES
paymentInitiationData.payment.details.creditorAccount	object	Conta bancária do recebedor.	Obrigatório para instrumento MANU
paymentInitiationData.payment.details.creditorAccount.accountType	enum	Tipo da conta	Obrigatório para instrumento MANU
paymentInitiationData.payment.details.creditorAccount.ispb	string	Código ISPB da instituição.	Obrigatório para instrumento MANU
paymentInitiationData.payment.details.creditorAccount.issuer	string	Agência da conta.	Obrigatório para instrumento MANU
paymentInitiationData.payment.details.creditorAccount.number	string	Número da conta.	Obrigatório para instrumento MANU
redirectUrl	string	URL para onde o usuário será redirecionado após o fluxo.	Obrigatório
tags	object	Metadados adicionais definidos pelo cliente.	Opcional
tags.tag1	string	Tag adicional customizada.	Opcional
settings	array	Lista de configurações customizadas da jornada.	Opcional
settings[].key	string	Chave da configuração (`JOURNEY_RULES` `PRIORITIES_BRANDS`).	Obrigatório
settings[].value	array / object	Valor associado à configuração.	Obrigatório
settings[].value[].path	string	Caminho do campo a ser configurado pela regra (no caso de JOURNEY_RULES).	Obrigatório
settings[].value[].optional	boolean	Define se o campo é opcional no fluxo.	Obrigatório
settings[].value[].editable	boolean	Define se o campo é editável no fluxo.	Obrigatório

Exemplo de resposta

{
    "journeyId": "payments-redirect",
    "paymentInitiationData": {
        "loggedUser": {
            "document": {
                "identification": "12345678909",
                "rel": "CPF"
            }
        },
        "creditorAccountId": "691cd1d9c67b010011965d2a",
        "payment": {
            "type": "PIX",
            "date": "2025-11-25",
            "currency": "BRL",
            "amount": "1.00",
            "details": {
                "localInstrument": "DICT",
                "proxy": "48572054000158",
                "creditorAccount": {
                    "accountType": "CACC",
                    "ispb": "13935893",
                    "issuer": "0001",
                    "number": "4236311"
                }
            }
        },
        "creditor": {
            "cpfCnpj": "48572054000158",
            "personType": "PESSOA_JURIDICA",
            "name": "BaaS ITP"
        }
    },
    "redirectUrl": "https://www.celcoin.com.br/",
    "settings": [
        {
            "key": "PRIORITIES_BRANDS",
            "value": [
                "6675da380656c2806df52bdb",
                "6675da380656c2806df52b8a",
                "6675da380656c2806df52cc2",
                "6675da380656c2806df52bb9",
                "6675da380656c2806df52be1",
                "6675da380656c2806df52cbd"
            ]
        },
        {
            "key": "JOURNEY_RULES",
            "value": [
                {
                    "path": "homeButton",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.loggedUser.document.identification",
                    "optional": true,
                    "editable": false
                },
                {
                    "path": "brandId",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.payment.amount",
                    "optional": false,
                    "editable": false
                },
                {
                    "path": "paymentInitiationData.remittanceInformation",
                    "optional": true,
                    "editable": false
                },
                {
                    "path": "paymentInitiationData.payment.date",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.payment.schedule",
                    "optional": true,
                    "editable": false
                }
            ]
        }
    ],
    "paymentInitiationApi": "PAYMENTS_V4",
    "applicationClientId": "openkeys_12eb0ff4-b190-4822-9e7f-0368d06c578f",
    "applicationId": "12eb0ff4-b190-4822-9e7f-0368d06c578f",
    "tokenId": "692754ca449aee001212e37b",
    "journeySessionStageId": "692754cadb0e820012f4b2da",
    "journeySessionUrl": "https://api-sandbox-wl-hml.openkeys.celcoin.sandbox.fsapps.app?journeyId=66f4c7811b6550001151dbba&api=PAYMENTS_V4&id=692754ca449aee001212e37b&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2OTI3NTRjYTQ0OWFlZTAwMTIxMmUzN2IiLCJpc3MiOiJvcGVuLWtleXMtaXRwLXYyIiwiYXpwIjoib3BlbmtleXNfMTJlYjBmZjQtYjE5MC00ODIyLTllN2YtMDM2OGQwNmM1NzhmIiwic2NvcGUiOiJqb3VybmV5IiwiaWF0IjoxNzY0MTg1MjkwLCJleHAiOjE3NjQxODg5NTB9.hnpbrT4fgNxIc5go6lF93rKPdiOE269Vgp8ptjc_j_Y",
    "status": "PENDING",
    "statusHistory": [
        {
            "updatedAt": "2025-11-26T19:28:10.330Z",
            "status": "PENDING"
        }
    ],
    "createdAt": "2025-11-26T19:28:10.331Z",
    "updatedAt": "2025-11-26T19:28:10.331Z",
    "id": "692754cadb0e820012f4b2db"
}

Destaque para os campos abaixo na resposta da API

Nome do Campo	Tipo	Descrição
journeySessionUrl	String	URL para redirecionamento do usuário para início da jornada
status	String	Status da Jornada `PENDING`, `AWAITING_AUTHORISATION`, `CONSUMED`, `FINISHED`
statusHistory	Objeto	Exibição do histórico de status da Jornada com registro de data/hora para cada etapa.
createdAt	string (YYYY-MM-DD)	Data/hora de criação da jornada
updatedAt	string (YYYY-MM-DD)	Data/hora de última atualização de status da jornada
id	String	ID único da Jornada (esse identificador deve ser armazenado)

❗️
A jornada possui 60 minutos de duração. Quando a jornada expirar, ela terá o status REJECTED.

Status da Jornada

Status	Descrição
PENDING	A jornada foi criada e está aguardando ação do usuário.
AWAITING_AUTHORISATION	Aguardando a autorização do pagamento no banco.
CONSUMED	O usuário consumiu a jornada de pagamento. Porém ainda não foi finalizada a etapa de pagamento
REJECTED	O usuário ou o banco recusou o pagamento.
FINISHED	A jornada foi finalizada.

Status dos Eventos

Status	Descrição
AWAITING_AUTHORISATION	Aguardando a autorização do pagamento no banco.
REDIRECTED	O usuário foi redirecionado para a instituição pagadora.
CODE_GENERATED	Foi criado o código interno de redirecionamento.
TOKEN_GENERATED	Token gerado no ecossistêma do Open Finance
AUTHORISED	Resultado da validação do token, dentro do ecossistêma do Open Finance
REJECTED	Resultado da validação do token, dentro do ecossistêma do Open Finance
CONSUMED	O usuário consumiu a jornada de pagamento.

Webhooks da Jornada

👍
Os webhooks serão disparados quando a Jornada mudar de fase para os status CONSUMED e FINISHED. A notificação do webhook terá o intuito de notificar o cliente para que realize um GET utilizando o ID da transação.

Body do webhook recebido

{
  "url": "https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/payments/journeys-sessions/692754cadb0e820012f4b2db",
  "timestamp": "2025-12-03T19:46:17.890Z"
}

GET `baas/v1/open/itp/payments/journeys-sessions/idJonarda`

{
    "journeyId": "payments-redirect",
    "paymentInitiationData": {
        "loggedUser": {
            "document": {
                "identification": "12345678909",
                "rel": "CPF"
            }
        },
        "creditorAccountId": "691cd1d9c67b010011965d2a",
        "payment": {
            "type": "PIX",
            "date": "2025-11-25",
            "currency": "BRL",
            "amount": "1.00",
            "details": {
                "localInstrument": "DICT",
                "proxy": "48572054000158",
                "creditorAccount": {
                    "accountType": "CACC",
                    "ispb": "13935893",
                    "issuer": "0001",
                    "number": "4236311"
                }
            }
        },
        "creditor": {
            "cpfCnpj": "48572054000158",
            "personType": "PESSOA_JURIDICA",
            "name": "BaaS ITP"
        }
    },
    "redirectUrl": "https://www.celcoin.com.br/",
    "settings": [
        {
            "key": "PRIORITIES_BRANDS",
            "value": [
                "6675da380656c2806df52bdb",
                "6675da380656c2806df52b8a",
                "6675da380656c2806df52cc2",
                "6675da380656c2806df52bb9",
                "6675da380656c2806df52be1",
                "6675da380656c2806df52cbd"
            ]
        },
        {
            "key": "JOURNEY_RULES",
            "value": [
                {
                    "path": "homeButton",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.loggedUser.document.identification",
                    "optional": true,
                    "editable": false
                },
                {
                    "path": "brandId",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.payment.amount",
                    "optional": false,
                    "editable": false
                },
                {
                    "path": "paymentInitiationData.remittanceInformation",
                    "optional": true,
                    "editable": false
                },
                {
                    "path": "paymentInitiationData.payment.date",
                    "optional": true,
                    "editable": true
                },
                {
                    "path": "paymentInitiationData.payment.schedule",
                    "optional": true,
                    "editable": false
                }
            ]
        }
    ],
    "paymentInitiationApi": "PAYMENTS_V4",
    "applicationClientId": "openkeys_362721e6-e4d8-46cf-9a62-bcab5acf3d59",
    "applicationId": "6917374a81ead700117aed5c",
    "tokenId": "69309348b4440100113002d6",
    "journeySessionStageId": "69309348490b84001101fa74",
    "journeySessionUrl": "https://api-sandbox-wl-hml.openkeys.celcoin.sandbox.fsapps.app?journeyId=66f4c7811b6550001151dbba&api=PAYMENTS_V4&id=69309348b4440100113002d6&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2OTMwOTM0OGI0NDQwMTAwMTEzMDAyZDYiLCJpc3MiOiJvcGVuLWtleXMtaXRwLXYyIiwiYXpwIjoib3BlbmtleXNfMzYyNzIxZTYtZTRkOC00NmNmLTlhNjItYmNhYjVhY2YzZDU5Iiwic2NvcGUiOiJqb3VybmV5IiwiaWF0IjoxNzY0NzkxMTEyLCJleHAiOjE3NjQ3OTQ3NzJ9.gMxlQmuJGjcdz257YVc7fkCdYIaySQ5Kmhv9mcc2VL4",
    "status": "FINISHED",
    "statusHistory": [
        {
            "updatedAt": "2025-12-03T19:45:12.020Z",
            "status": "PENDING"
        },
        {
            "updatedAt": "2025-12-03T19:45:40.155Z",
            "status": "AWAITING_AUTHORISATION"
        },
        {
            "updatedAt": "2025-12-03T19:46:06.622Z",
            "status": "CONSUMED"
        },
        {
            "updatedAt": "2025-12-03T19:46:17.924Z",
            "status": "FINISHED"
        }
    ],
    "createdAt": "2025-12-03T19:45:12.020Z",
    "updatedAt": "2025-12-03T19:46:17.924Z",
    "paymentInitiationId": "69309364490b84001101fa76",
    "id": "69309348490b84001101fa75",
    "journey": {
        "name": "Jornada ITP de Pagamento com redirecionamento",
        "description": "Jornada ITP de Pagamento com as seguintes etapas: escolha da instatuição bancária, confirmação dos dados de pagamento, redirecionamento para a detentora da conta, calback da detentora e confirmação da operação",
        "alias": "payments-redirect",
        "acceptPaymentInitiationApis": [
            "PAYMENTS_V4"
        ],
        "settings": [
            {
                "key": "JOURNEY_RULES",
                "value": [
                    {
                        "path": "paymentInitiationData.loggedUser.document.identification",
                        "customizable": true,
                        "optional": false,
                        "editable": false
                    },
                    {
                        "path": "brandId",
                        "customizable": true,
                        "optional": true,
                        "editable": true
                    },
                    {
                        "path": "paymentInitiationData.payment.amount",
                        "customizable": true,
                        "optional": false,
                        "editable": false
                    },
                    {
                        "path": "paymentInitiationData.remittanceInformation",
                        "customizable": true,
                        "optional": true,
                        "editable": false
                    },
                    {
                        "path": "paymentInitiationData.payment.date",
                        "customizable": true,
                        "optional": true,
                        "editable": false
                    },
                    {
                        "path": "paymentInitiationData.payment.schedule",
                        "customizable": true,
                        "optional": true,
                        "editable": false
                    }
                ]
            },
            {
                "key": "DISABLE_BRANDS",
                "value": [
                    "66f4d9e296f18bc4606e1615",
                    "66f4d9e296f18bc4606e1612",
                    "66f4d9e296f18bc4606e161e",
                    "66f4d9e296f18bc4606e160f",
                    "66f4d9e296f18bc4606e161c"
                ]
            }
        ],
        "createdAt": "2024-09-26T02:31:29.115Z",
        "updatedAt": "2025-01-29T02:44:10.093Z",
        "id": "66f4c7811b6550001151dbba"
    },
    "application": {
        "id": "6917374a81ead700117aed5c",
        "name": "Celcoin testes ITP",
        "description": "Testes ITP Leonardo Celcoin",
        "image": "https://celcoin-prd-okp.s3.cloudystorm.io/celcoin-prd-okp/itp_v2/openkeys_icon.png",
        "settings": [
            {
                "applicationId": "6917374a81ead700117aed5c",
                "key": "PRIMARY_COLOR",
                "updatedAt": "2025-12-03T19:57:10.679Z",
                "value": "#00000",
                "id": "6917374a2b6278e5fc7d05ca"
            },
            {
                "applicationId": "6917374a81ead700117aed5c",
                "key": "FAVICON",
                "updatedAt": "2025-12-03T20:08:56.026Z",
                "value": "https://e7.pngegg.com/pngimages/1017/208/png-clipart-usability-testing-user-experience-software-testing-logo-user-experience-company-text.png",
                "id": "693095b32b6278e5fcf6d7f7"
            }
        ]
    },
    "token": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2OTMwOTM0OGI0NDQwMTAwMTEzMDAyZDYiLCJpc3MiOiJvcGVuLWtleXMtaXRwLXYyIiwiYXpwIjoib3BlbmtleXNfMzYyNzIxZTYtZTRkOC00NmNmLTlhNjItYmNhYjVhY2YzZDU5Iiwic2NvcGUiOiJqb3VybmV5IiwiaWF0IjoxNzY0NzkxMTEyLCJleHAiOjE3NjQ3OTQ3NzJ9.gMxlQmuJGjcdz257YVc7fkCdYIaySQ5Kmhv9mcc2VL4",
        "createdAt": "2025-12-03T19:45:12.005Z",
        "updatedAt": "2025-12-03T19:45:12.005Z",
        "id": "69309348b4440100113002d6"
    },
    "paymentInitiation": {
        "journeySessionId": "69309348490b84001101fa75",
        "brandId": "6900de69dfdf118e980e10ec",
        "redirectUrl": "http://localhost:8080/callback",
        "data": {
            "loggedUser": {
                "document": {
                    "identification": "12345678909",
                    "rel": "CPF"
                }
            },
            "creditorAccountId": "693091d3490b84001101fa63",
            "payment": {
                "type": "PIX",
                "date": "2025-12-03",
                "currency": "BRL",
                "amount": "5.00",
                "details": {
                    "localInstrument": "DICT",
                    "proxy": "12345678901",
                    "creditorAccount": {
                        "accountType": "TRAN",
                        "ispb": "13935893",
                        "number": "4236312",
                        "issuer": "0001"
                    }
                }
            },
            "creditor": {
                "personType": "PESSOA_NATURAL",
                "cpfCnpj": "02122886609",
                "name": "Testes Leo"
            }
        },
        "applicationId": "6917374a81ead700117aed5c",
        "paymentInitiationApi": "PAYMENTS_V4",
        "tokenId": "69309348b4440100113002d6",
        "createdAt": "2025-12-03T19:45:40.148Z",
        "updatedAt": "2025-12-03T19:46:04.950Z",
        "authorizationUrl": "https://api.opb.ca422f1m.dev.fsapps.app/orgs/visa/auth?client_id=sQ0y5dBf9p1Vvg7HVKkjl&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AxrW8xxBMKMmC1PadjfTag",
        "ofConsentId": "69309365490b84001101fa78",
        "idempotencyKey": "fdb596cd-15e6-48df-b9eb-384430685e58",
        "id": "69309364490b84001101fa76",
        "ofPayments": [
            {
                "paymentInitiationId": "69309364490b84001101fa76",
                "consentId": "urn:visahml:bf1b8578-1a5d-4d78-8ed8-caa522bb564b",
                "endToEndId": "E13935893202512031946TONXK8YAION",
                "cnpjInitiator": "13935893000109",
                "localInstrument": "DICT",
                "proxy": "12345678901",
                "payment": {
                    "currency": "BRL",
                    "amount": "5.00"
                },
                "creditorAccount": {
                    "ispb": "13935893",
                    "issuer": "0001",
                    "number": "4236312",
                    "accountType": "TRAN"
                },
                "creationDateTime": "2025-12-03T19:46:06Z",
                "debtorAccount": {
                    "ispb": "12345678",
                    "issuer": "0001",
                    "number": "969139",
                    "accountType": "CACC"
                },
                "paymentId": "fb371ee0-b2d7-4430-8010-84e822648a84",
                "status": "ACSC",
                "statusUpdateDateTime": "2025-12-03T19:46:28Z",
                "id": "6930937c490b84001101fa7b"
            }
        ],
        "ofConsent": {
            "paymentInitiationId": "69309364490b84001101fa76",
            "consentId": "urn:visahml:bf1b8578-1a5d-4d78-8ed8-caa522bb564b",
            "organization_id": "c55ceb2e-c9fb-4989-8ed1-39208d6d7951",
            "brand_id": "cf4412a8-5b91-4e72-bf70-87b7e07d1344",
            "authorization_url": "https://api.opb.ca422f1m.dev.fsapps.app/orgs/visa/auth?client_id=sQ0y5dBf9p1Vvg7HVKkjl&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AxrW8xxBMKMmC1PadjfTag",
            "consent_id": "urn:visahml:bf1b8578-1a5d-4d78-8ed8-caa522bb564b",
            "code_verifier": "LXohgSw2VkGnjD-w6drucLTBNvXBGd6xzDa1PbmFJpY",
            "nonce": "-l9gkcFnpFmDGHqS9-3P_GJkMOYaRYZwxv0J348LWE8",
            "state": "69309364490b84001101fa76",
            "redirect_uri": "https://api-sandbox-wl-hml.openkeys.celcoin.sandbox.fsapps.app/callback",
            "scope": "openid payments consent:urn:visahml:bf1b8578-1a5d-4d78-8ed8-caa522bb564b",
            "consentTerm": 0,
            "consentTermUnit": "M",
            "creationDateTime": "2025-12-03T19:45:40.000Z",
            "creditor": {
                "personType": "PESSOA_NATURAL",
                "cpfCnpj": "02122886609",
                "name": "Testes Leo"
            },
            "events": [
                {
                    "date": "2025-12-03T19:45:40.000Z",
                    "event": "AWAITING_AUTHORISATION"
                },
                {
                    "date": "2025-12-03T19:45:41.328Z",
                    "event": "REDIRECTED"
                },
                {
                    "date": "2025-12-03T19:46:03.774Z",
                    "event": "CODE_GENERATED"
                },
                {
                    "date": "2025-12-03T19:46:04.263Z",
                    "event": "TOKEN_GENERATED"
                },
                {
                    "date": "2025-12-03T19:46:04.795Z",
                    "event": "AUTHORISED"
                },
                {
                    "date": "2025-12-03T19:46:06.578Z",
                    "event": "CONSUMED"
                }
            ],
            "expirationDateTime": "2025-12-03T20:46:04.805Z",
            "journey": [],
            "kind": "PAYMENT",
            "loggedUser": {
                "document": {
                    "identification": "12345678909",
                    "rel": "CPF"
                }
            },
            "nfc": false,
            "organizationLogo": "https://www.celcoin.com.br/img/rede-celcoin-logo.svg",
            "organizationName": "Mock Bank Visa Conecta",
            "ownerBrandId": "cf4412a8-5b91-4e72-bf70-87b7e07d1344",
            "ownerId": "c55ceb2e-c9fb-4989-8ed1-39208d6d7951",
            "payment": {
                "type": "PIX",
                "date": "2025-12-03",
                "currency": "BRL",
                "amount": "5.00",
                "details": {
                    "localInstrument": "DICT",
                    "proxy": "12345678901",
                    "creditorAccount": {
                        "ispb": "13935893",
                        "issuer": "0001",
                        "number": "4236312",
                        "accountType": "TRAN"
                    }
                }
            },
            "status": "CONSUMED",
            "statusUpdateDateTime": "2025-12-03T19:46:06.578Z",
            "transactions": [],
            "access_token": "tl9JeaxSNLQmtMV6soo777Bn0CM84qsq2o7jTaenP-d",
            "expires_at": 1764792064,
            "id_token": "eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpKSjhvWnlyd2lIbEppbjNiYTRzb0k3QmVHSXZlSUNhV0lFVzNQNWV5YWcifQ.eyJzdWIiOiI3OWI1ZjU0OTE4NjI4Y2M3ZjZhOTAwYTM4NmQxNGEwNCIsImFjciI6InVybjpicmFzaWw6b3BlbmJhbmtpbmc6bG9hMiIsIm5vbmNlIjoiLWw5Z2tjRm5wRm1ER0hxUzktM1BfR0prTU9ZYVJZWnd4djBKMzQ4TFdFOCIsImF0X2hhc2giOiJoWkNTSDVfUzNmcXZaLW04U0VzNFhBIiwiYXVkIjoic1EweTVkQmY5cDFWdmc3SFZLa2psIiwiZXhwIjoxNzY0Nzk0NzY0LCJpYXQiOjE3NjQ3OTExNjQsImlzcyI6Imh0dHBzOi8vYXBpLm9wYi5jYTQyMmYxbS5kZXYuZnNhcHBzLmFwcC9vcmdzL3Zpc2EifQ.mgFHskCPulOMemPTA2cQk2gtha73qR0I5FTCszcirWMxwbOKa_6ssROzWFigA8Md9QGRmYL9ZOIZeIXM5tHz9cbK_Y7FcJcczSGhcMYtUfMrPEfR8pB9ahyaar72A1LzTpYjHO-pi5PVeo6P6lt5l0EIao3vGbl7AE23jPseN7ZRbNpvJsxZ8_Uz8Kxb2ULYSPAMdBMR2JpFvg0s3M5iXSGcEmnnDVONr-DngTF0JUvFu6CtRi8qxP_35rF0pmWOksY9LWsk0WScoVEDBbLSHZA62TyL6PKHksK9RSaPV8gJOT2RCR0amlGcbgyjmqLmsI2H5Fasn_f472RsqCt1PQ",
            "refresh_token": "DO4I063vizct-Te05KdFhEnidiPQuZpwmSS2TuM1b03",
            "token_type": "Bearer",
            "debtorAccount": {
                "ispb": "12345678",
                "issuer": "0001",
                "number": "969139",
                "accountType": "CACC"
            },
            "rejectionReason": null,
            "id": "69309365490b84001101fa78"
        },
        "brand": {
            "AuthorisationServerId": "cf4412a8-5b91-4e72-bf70-87b7e07d1344",
            "ApiFamilyType": {
                "payments-pix": true,
                "payments-pix-recurring-payments-automatic": true,
                "enrollments": true,
                "payments-pix-recurring-payments": true
            },
            "CustomerFriendlyDescription": "Servidor de autorização para Visa",
            "CustomerFriendlyLogoUri": "https://www.celcoin.com.br/img/rede-celcoin-logo.svg",
            "CustomerFriendlyName": "Mock Bank Visa Conecta",
            "Flags": {
                "Suporta Contas PF": [
                    "Suporta Contas PF"
                ],
                "Suporta Contas PJ": [
                    "Suporta Contas PJ"
                ],
                "EM HOMOLOGACAO (DC)": [
                    "EM HOMOLOGACAO (DC)"
                ]
            },
            "OpenIDDiscoveryDocument": "https://api.opb.ca422f1m.dev.fsapps.app/orgs/visa/.well-known/openid-configuration",
            "OrganisationId": "66f4d9d996f18bc4606e0b87",
            "OrganisationName": "CELCOIN INSTITUICAO DE PAGAMENTO S.A.",
            "ParentAuthorisationServerId": null,
            "id": "6900de69dfdf118e980e10ec"
        }
    }
}

API Reference - Consulta de status de uma Jornada

📘
Verifique o campo status, para saber o status da transação e o statusHistory para ver todo o histórico de status da Jornada.

👍
Mock para o ambiente de Sandbox
Ao criar a Jornada, selecione o participante Finansystech Banking Demo Auth Server (brandId 66f4d9e296f18bc4606e1618) para realizar com sucesso a jornada de redirecionamento

Pagamentos Agendados

📘
Para a utilização da jornada de pagamentos agendados, é identificado pelo preenchimento payments-schedule-redirect no journeyID.

Ao realizar pagamentos agendados, deve-se incluir o objeto Schedule na requisição, onde poderá definir a frequência desses pagamentos, de acordo com a tabela abaixo.

Schedule	Descrição
Single	Será utilizado para pagamento agendado, sem recorrência.
Daily	Será utilizado para pagamentos agendados recorrentes com frequência diária.
Weekly	Será utilizado para pagamentos agendados recorrentes com frequência semanal.
Montly	Será utilizado para pagamentos agendados recorrentes com frequência mensal.

❗️
Ao utilizar a frequência semanal, você deve verificar que a data preenchida no campo startDate corresponda ao dia da semana selecionado.

📘
Atenção: No objeto schedule deve-se preencher somente um tipo de frequência de pagamento,por jornada criada. Sendo single, daily, weekly ou monthly.

POST `/baas/v1/open/itp/payments/journeys-sessions`

curl --location 'https://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/payments/journeys-sessions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ***
--data '{
  "journeyId": "payments-schedule-redirect",
  "paymentInitiationData": {
    "loggedUser": {
      "document": {
        "identification": "12345678909",
        "rel": "CPF"
      }
    },
"creditorAccountId": "68b094ce4b90da0011f5fc3f",
    "payment": {
      "type": "PIX",
      "schedule":{ 
        "weekly": {
          "dayOfWeek": "SEGUNDA_FEIRA",
          "startDate": "2026-08-23",
          "quantity": 10
        }
      },
      "details": {
        "localInstrument": "DICT",
        "creditorAccount": {
          "accountType": "CACC",
          "ispb": "13935893",
          "number": "4236312"
        },
        "proxy": "12345678909"
      },
      "currency": "BRL",
      "amount": "1.12"
    },
    "debtorAccount": {
      "accountType": "CACC",
      "ispb": "12345678",
      "number": "1234567890"
    }
  },
  "redirectUrl": "http://localhost:8080/callback"
}'

API Reference - Criação de uma Jornada de redirecionamento

❗️
Você pode agendar no máximo 24 pagamentos. Caso não tenha os dias 29, 30 e 31 no mês de competência, o pagamento ocorrerá no dia seguinte.

Configuração das Jornadas de redirecionamento

Journey Rules	Descrição
paymentInitiationData.loggedUser.document.identification	Possibilidade de tornar opcional ou editável o CPF/CNPJ do pagador da transação.
brandId	Possibilidade de tornar selecionável para que o pagador selecione o banco de destino.
paymentInitiationData.payment.amount	Possibilidade de tornar editável o valor da transação.
paymentInitiationData.remittanceInformation	Possibilidade de tornar opcional ou editável uma mensagem definida pelo gerador da cobrança.
paymentInitiationData.payment.date	Possibilidade de tornar editável a data do pagamento da transação.
paymentInitiationData.payment.schedule	Possibilidade de tornar editável ou opcional o agendamento do pagamento, por parte do usuário pagador

📘
As configurações da chave PRIORITIES_BRANDS permitirão escolher quais participantes (brandIDs) aparecerão na exibição da jornada, com um limite de até 6 participantes.
Para realizar a configuração, deve-se utilizar os IDs dos participantes, retornados no endpoint de consulta de participantes.

Updated about 8 hours ago

Introdução

Visão Geral da Jornada

Pré-Requisitos

Cadastro de Conta de Crédito

POST /baas/v1/open/itp/applications/applicationId/accounts

Body

Cadastro de URL de Redirecionamento

POST /baas/v1/open/itp/applications/applicationId/redirects

Body

Cadastro de Webhooks

POST /baas/v1/open/itp/applications/applicationId/webhooks

Body

Customização da Jornada (Whitelabel)

POST /baas/v1/open/itp/applications/applicationId/settings

Body

Consulta de Participantes

GET /baas/v1/open/itp/participants/brands

GET /baas/v1/open/itp/participants/brands/brandId

Criação da Jornada de pagamento com redirecionamento

POST /baas/v1/open/itp/payments/journeys-sessions

Body

Status da Jornada

Status dos Eventos

Webhooks da Jornada

Body do webhook recebido

GET baas/v1/open/itp/payments/journeys-sessions/idJonarda

Pagamentos Agendados

POST /baas/v1/open/itp/payments/journeys-sessions

Configuração das Jornadas de redirecionamento

POST `/baas/v1/open/itp/applications/applicationId/accounts`

POST `/baas/v1/open/itp/applications/applicationId/redirects`

POST `/baas/v1/open/itp/applications/applicationId/webhooks`

POST `/baas/v1/open/itp/applications/applicationId/settings`

GET `/baas/v1/open/itp/participants/brands`

GET `/baas/v1/open/itp/participants/brands/brandId`

POST `/baas/v1/open/itp/payments/journeys-sessions`

GET `baas/v1/open/itp/payments/journeys-sessions/idJonarda`

POST `/baas/v1/open/itp/payments/journeys-sessions`