...
Cenário | Status do recurso na detentora | API Resources (…/resources/v1/resources) | API de listagem de Produto (/bank-fixed-incomesexchanges)¹ | APIs de Dados de Produtos (/bank-fixed-incomesexchanges/{investmentIdoperationId})² |
|---|---|---|---|---|
Sem consentimento | - | 401 unauthorized | 401 unauthorized | 401 unauthorized |
Com consentimento não autorizado | - | 401 unauthorized | 401 unauthorized | 401 unauthorized |
Com consentimento autorizado (pendente múltipla alçada) | - | 200 - Retorna recurso com status PENDING_AUTHORISATION | 200 Não retorna | 403 forbidden |
Com consentimento autorizado (aprovado múltipla alçada) | OK | 200 - Retorna recurso com status AVAILABLE | 200 retorna o recurso na lista | 200 retorna dados para o recurso |
Com consentimento autorizado (aprovado múltipla alçada) | Bloqueio temporário | 200 - Retorna recurso com status TEMPORARILY_UNAVAILABLE | 200 não retorna na lista o recurso “bloqueado” | 403 forbidden |
Com consentimento autorizado (aprovado múltipla alçada) | Liquidado a menos de 12 meses | 200 - Retorna o recurso como status AVAILABLE | 200 retorna o recurso na lista | 200 retorna o recurso na lista |
Com consentimento autorizado (aprovado múltipla alçada) | Vencido a mais de 12 meses (recurso nunca compartilhado na vigência do consentimento) | 200 - Não retorna o recurso | 200 - Não retorna o recurso | 403 forbidden |
Com consentimento autorizado (aprovado múltipla alçada) | Liquidado a mais de 12 meses (recurso já compartilhado na vigência do consentimento) | 200 - Retorna o recurso como status UNAVAILABLE | 200 - Não retorna o recurso | 403 forbidden |
Com consentimento autorizado (aprovado múltipla alçada) | - | 200 - Retorna recurso com status UNAVAILABLE | 200 - Não retorna o recurso recusado na lista | 403 forbidden |
Com consentimento autorizado (recurso inexistente) | - | 200 - Não retorna o recurso | 200 - Não retorna o recurso | 403 forbidden |
Com Consentimento revogado ou expirado³ | - | 401 unauthorized | 401 unauthorized | 401 unauthorized |
...
Recomenda-se que a Receptora consulte a API Resources logo após identificar que o consentimento se encontra autorizado de modo a obter todos as operações de produtos de câmbio consentida pelo cliente e seus respectivos identificadores – lembrando que para câmbio pode não haver nenhuma operação no momento da primeira consulta, e posteriormente novas operações podem aparecer.
Recomenda-se que a Receptora implemente uma rotina de consulta de novas operações consumindo a API de Resources de forma periódica. Cabe a Instituição Receptora definir a periodicidade que melhor atende às suas necessidades.
Recomenda-se que a Receptora, caso obtenha um erro HTTP Status Code 403 - Forbidden nas API de Câmbio avalie o JSON retornado no body da requisição para identificar as informações adicionais referentes ao erro, como o status específico da API Resources que impede o consumo da informação.
Recomenda-se que a Receptora consulte a API Resources caso obtenha um erro na API de produtos de câmbio, de modo a identificar uma possível alteração de status
do recurso.