Consultar Status do Credenciamento da Conta

Uma vez que a subconta tenha sido criada, é possível checar o status que ela está, validando sua aptidão para transacionar ou não cartão de crédito.

Para realizar a validação, é necessário ter um token válido.

Endpoint

GET https://sandbox.openfinance.celcoin.dev/baas/v1/cash/accreditation?account={account}

Parâmetro	Tipo	Envio	Obrigatório	Descrição
`account`	string	Query	Sim	Id da subconta a ser consultada.
`Authorization`	string	Header	Sim	Token de autenticação no formato `Bearer {TOKEN}`.
`Content-Type`	string	Header	Sim	`application/json`

Exemplo de Requisição

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/accreditation?account={account}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}'

Importante: caso você tenha utilizado identificadores externos, denominados myId na requisição, os mesmos serão exibidos também na listagem de clientes.

Retorno

Conta ativa

{
    "message": "Conta ativa e aprovada para utilizar cartão.",
    "status": "active"
}

Conta inativa

{
    "message": "Conta não está ativa no momento.",
    "status": "inactive"
}

Subconta inválida

Caso você passe um Id de subconta que não pertence ao seu arranjo, será devolvida a seguinte mensagem:

{
    "error": {
        "message": "Subconta inválida uma vez que não pertence a empresa logada."
    }
}

Campos do response

Campo	Tipo	Valores	Descrição
`message`	string	—	Descrição legível da situação atual do credenciamento.
`status`	string	`active` · `inactive`	Indica se a conta está apta a transacionar cartão.
`documentation`	string	`APPROVED` · `REJECT`	Resultado da análise documental. Retornado apenas quando a análise foi concluída — enquanto o credenciamento estiver em análise, o campo não é devolvido.
`reason`	string	—	Motivo da recusa. Retornado apenas quando `documentation` = `REJECT`.

Simulação em Sandbox

Em Sandbox, os Ids de subconta abaixo retornam cenários fixos de credenciamento, permitindo validar o tratamento de cada situação sem depender de uma análise real.

Cenário	Id da conta	`status`	`documentation`	`reason`
EM ANÁLISE	`91362471442499`	`inactive`	—	—
REJEITADA	`32397019033036`	`inactive`	`REJECT`	Documento de identidade não oficial
REJEITADA	`60413093177788`	`inactive`	`REJECT`	Site incorreto
APROVADA	`83477789647244`	`active`	`APPROVED`	—

1. Conta pendente (credenciamento em análise)

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/accreditation?account=91362471442499' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}'

200 — Response body

{
    "message": "Credenciamento em análise, aguardando resposta.",
    "status": "inactive"
}

2. Conta rejeitada — documento de identidade não oficial

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/accreditation?account=32397019033036' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}'

200 — Response body

{
    "message": "Conta não está ativa no momento.",
    "status": "inactive",
    "documentation": "REJECT",
    "reason": "Documento de identidade não oficial"
}

3. Conta rejeitada — site incorreto

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/accreditation?account=60413093177788' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}'

200 — Response body

{
    "message": "Conta não está ativa no momento.",
    "status": "inactive",
    "documentation": "REJECT",
    "reason": "Site incorreto"
}

4. Conta aprovada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/accreditation?account=83477789647244' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}'

200 — Response body

{
    "message": "Conta ativa e aprovada para utilizar cartão.",
    "status": "active",
    "documentation": "APPROVED"
}

Updated 6 days ago

Did this page help you?