Listar cartões pré-pagos do cliente

POST

/api/ContaDigital/ConsultarCartaoPrePago

ContaDigital

Funcionalidade principal

O ConsultarCartaoPrePago recupera os dados de identificação e o estado operacional do cartão. Ele é utilizado para exibir informações básicas ao usuário, como o número mascarado (para reconhecimento), a bandeira e, principalmente, se o cartão está apto para uso (ativo) ou se possui algum impedimento (bloqueado/inativo).

Casos de uso comuns

Dashboard de cartões: Exibir na tela principal do App o cartão atual do usuário com o status em tempo real.

Verificação pré-compra: O sistema consulta o status do cartão antes de permitir que o usuário tente visualizar os dados sensíveis para compras online.

Gestão de ciclo de vida: Identificar se um cliente já possui um cartão emitido antes de oferecer a opção de "Solicitar Novo Cartão".

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/ContaDigital/ConsultarCartaoPrePago' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0
    }
}'

Response Example

{
    "Data": {
        "TarifaInclusaoCartaoNoName": 0,
        "TarifaSolicitacaoCartaoNominal": 0,
        "ListaCartoes": [
            {
                "IdCartao": 0,
                "DataCadastro": "string",
                "Apelido": "string",
                "Status": "string",
                "DescStatus": "string",
                "NumeroCartao": "string",
                "NomePortador": "string",
                "CpfPortador": "string",
                "EmissorCartao": "string",
                "LimiteCartao": 0,
                "SaldoUnificado": true,
                "MovimentoCartao": 0,
                "BloqueioEcommerce": true,
                "IdTipoCartao": 0,
                "DescTipoCartao": "string"
            }
        ]
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:06:24

Página anterior

Ajustar limite do cartão pré-pago

Próxima página

Listar transações do cartão pré-pago

Listar cartões pré-pagos do cliente

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns