Tote

Buscar cartão bandeirado

Sandbox

https://horizon-api-sb.app.rpe.tech

GET

/api/v1/cartoes/bandeirados

Cartões

Use este endpoint para listar as informações dos cartões bandeirados do titular.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/cartoes/bandeirados?produto&idPortador' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json'

Response Example

200 - Processadora Cards

{
    "cartaoTitular": {
        "id": 123456,
        "bandeira": "A",
        "idPortadorCredito": 123456,
        "idPortadorDebito": 1234,
        "cpf": "12345678900",
        "funcaoCartao": "CREDITO",
        "virtual": true,
        "nomePortadorCartao": "GANDALF O CINZENTO",
        "statusEmbossing": "AGUARDANDO_EMBOSSING",
        "statusCartao": "ATIVO",
        "dataExpiracao": "2028-03-15",
        "idAdicional": 123,
        "panMascarado": "999999XXXXXX9999",
        "bloqueioCartao": {
            "dataBloqueio": "2024-02-29T13:08:59.442+0000",
            "observacao": "Bloqueado",
            "tipoBloqueio": {
                "chave": "BLOQUEIO_SENHA_INVALIDA",
                "descricao": "Bloqueado",
                "id": 8
            }
        },
        "cancelamentoCartao": {
            "dataCancelamento": "2025-01-03T14:19:32.680Z",
            "id": 6,
            "idCartaoCancelado": 6,
            "observacao": "Cancelado Cliente",
            "tipoCancelamento": {
                "chave": "6",
                "descricao": "Cancelado Cliente",
                "id": 6
            }
        },
        "telefone": {
            "area": "99",
            "telefone": "99999999"
        },
        "dataEmissao": "2023-03-15",
        "codigoExterno": "c68a761a-e46a-4375-b7fe-2fb0aabd3a18"
    },
    "cartaoVirtual": {
        "bandeira": "A",
        "bloqueioCartao": {
            "dataBloqueio": "2024-03-01T12:42:24.393+0000",
            "observacao": "Bloqueado",
            "tipoBloqueio": {
                "id": 8,
                "descricao": "Bloqueio",
                "chave": "BLOQUEIO_SENHA_INVALIDA"
            }
        }
    },
    "cartoesAdicionais": [
        {
            "id": 1234,
            "bandeira": "A",
            "idPortadorCredito": 1234,
            "idPortadorDebito": 1234,
            "cpf": "12345678900",
            "funcaoCartao": "CREDITO",
            "virtual": true,
            "nomePortadorCartao": "GANDOLFO O CINZENTINHO",
            "statusEmbossing": "AGUARDANDO_EMBOSSING",
            "statusCartao": "ATIVO",
            "dataExpiracao": "2028-03-15",
            "idAdicional": 11,
            "panMascarado": "1111XXXXXX1111",
            "bloqueioCartao": {
                "dataBloqueio": "2024-02-29T13:08:59.442+0000",
                "observacao": "Bloqueado",
                "tipoBloqueio": {
                    "chave": "BLOQUEIO_SENHA_INVALIDA",
                    "descricao": "Bloqueado",
                    "id": 8
                }
            },
            "telefone": {
                "area": "83",
                "telefone": "988999999"
            },
            "dataEmissao": "2023-03-15",
            "codigoExterno": "teste-bbf5081c45e6"
        }
    ],
    "cartoesAnteriores": [
        {
            "id": 1234,
            "bandeira": "A",
            "idPortadorCredito": 1234,
            "idPortadorDebito": 1234,
            "cpf": "12345678900",
            "funcaoCartao": "CREDITO",
            "virtual": true,
            "nomePortadorCartao": "GANDOLF M MITHRANDIR",
            "statusEmbossing": "AGUARDANDO_EMBOSSING",
            "statusCartao": "ATIVO",
            "dataExpiracao": "2023-04-15",
            "idAdicional": 1234,
            "panMascarado": "999999XXXXXX9999",
            "bloqueioCartao": {
                "dataBloqueio": "2024-02-29T13:08:59.442+0000",
                "observacao": "Bloqueado",
                "tipoBloqueio": {
                    "chave": "BLOQUEIO_SENHA_INVALIDA",
                    "descricao": "Bloqueado",
                    "id": 8
                }
            },
            "cancelamentoCartao": {
                "dataCancelamento": "2023-03-30T18:42:15.541+0000",
                "id": 88,
                "idCartaoCancelado": 1234,
                "observacao": "Cartão virtual cancelado",
                "tipoCancelamento": {
                    "chave": "CANCELAMENTO_INTERNO",
                    "descricao": "Cancelamento por motivo interno.",
                    "id": 6
                }
            },
            "telefone": {
                "area": "11",
                "telefone": "99999999"
            },
            "dataEmissao": "2023-03-15",
            "codigoExterno": "3teste8d78-dec628db5cc8"
        }
    ],
    "cartoesFuturos": [
        {
            "id": 1234,
            "bandeira": "a",
            "idPortadorCredito": 1234,
            "idPortadorDebito": 1234,
            "cpf": "12345678900",
            "funcaoCartao": "CREDITO",
            "virtual": true,
            "nomePortadorCartao": "GANDALF O CINZENTO",
            "statusEmbossing": "AGUARDANDO_EMBOSSING",
            "statusCartao": "ATIVO",
            "dataExpiracao": "2028-03-30",
            "idAdicional": 1234,
            "panMascarado": "999999XXXXXX9999",
            "bloqueioCartao": {
                "dataBloqueio": "2024-02-29T13:08:59.442+0000",
                "observacao": "Bloqueado",
                "tipoBloqueio": {
                    "chave": "BLOQUEIO_SENHA_INVALIDA",
                    "descricao": "Bloqueado",
                    "id": 8
                }
            },
            "cancelamentoCartao": {
                "dataCancelamento": "2023-03-30T18:42:15.541+0000",
                "id": 88,
                "idCartaoCancelado": 1234,
                "observacao": "Cartão virtual cancelado",
                "tipoCancelamento": {
                    "chave": "CANCELAMENTO_INTERNO",
                    "descricao": "Cancelamento por motivo interno.",
                    "id": 6
                }
            },
            "telefone": {
                "area": "83",
                "telefone": "999999999"
            },
            "dataEmissao": "2023-03-30",
            "codigoExterno": "teste-a9fd-75a6c6fee462"
        }
    ]
}

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Query

produto

enum<string>

opcional

Identificador do produto

Valores permitidos:

CREDITODEBITOCREDITO_DEBITO

Exemplo:

CREDITO

idPortador

integer <int64>

requerido

Identificador do portador.

Em caso de testes com a processadora Cards, utilize o valor default. Para testes com a processadora Dock, utilize o valor de exemplo fornecido.

Padrão:

2001

Exemplo:

2004

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Respostas

🟢200OK

application/json

Body

opcional

One of

Processadora Cards

Processadora Dock

cartaoTitular

object

opcional

Informações sobre o cartão

cartaoVirtual

object

opcional

Informações do cartão virtual.

cartoesAdicionais

array [object {17}]

opcional

Informações sobre os cartões adicionais.

cartoesAnteriores

array [object {18}]

opcional

Informações sobre os cartões anteriores.

cartoesFuturos

array [object {18}]

opcional

Informações sobre os cartões futuros.

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Página anterior

Buscar cartão pelo CPF

Próxima página

Token Merci