Consultar dados de uma Conta Cartão

Existem duas maneiras para se consultar as informações de uma conta:

accountId - Retorna exatamente a conta referente ao id informado.
Documento - Retorna uma lista de contas, uma vez que um documento pode estar presente em mais de um programa.

Para obter informações de uma conta criada, realize uma chamada no endpoint abaixo utilizando o accountId.

Para pesquisar de outras formas utilize a documentação da API.

Exemplo de chamada buscando por accountId:

curl --request GET \
  --url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/{accountId}\
  --header 'Authorization: Bearer {TOKEN}' \
  --header 'User-Agent: insomnia/10.0.0' \

👍
Sucesso 200

{
    "version": false,
    "status": 200,
    "body": [
        {
            "id": 256,
            "customers": [
                {
                    "id": 256,
                    "name": "MARCIA FERREIRA COSTA",
                    "email": "[email protected]",
                    "documentNumber": "326055109803",
                    "owner": true,
                    "dateOfBirth": "1984-07-11",
                    "createdAt": "2025-02-04 17:13:44"
                }
            ],
            "addresses": [
                {
                    "id": 256,
                    "addressType": "RESIDENTIAL",
                    "address": "RUA VEREADOR NAPOLEAO NOVISK",
                    "number": "1",
                    "complement": null,
                    "neighborhood": "LOTEAMENTO LOANDA",
                    "city": "ATIBAIA",
                    "state": "SP",
                    "country": "Brasil",
                    "zipAddress": "12945160",
                    "active": true,
                    "mailingAddress": true,
                    "createdAt": "2025-02-04 00:00:00"
                }
            ],
            "phones": [
                {
                    "id": 256,
                    "type": "MOBILE",
                    "countryCode": 55,
                    "areaCode": 11,
                    "number": "999551111",
                    "extension": null,
                    "active": true,
                    "createdAt": "2025-02-04 00:00:00"
                }
            ],
            "accountLimit": [],
            "dueDate": [],
            "accountStatus": "NORMAL",
            "financialStatus": "NORMAL",
            "program": [
                {
                    "programId": 41,
                    "name": "NovoDebito4",
                    "type": "DEBITO",
                    "timezone": "America/Sao_Paulo",
                    "binId": 81373,
                    "startRange": 0,
                    "endRange": 333332,
                    "status": true,
                    "countryCode": "BRA",
                    "avaliableCards": 333332,
                    "currencyCode": "986",
                    "createdAt": "2025-02-04 16:46:17",
                    "updatedAt": "2025-02-04 17:21:48"
                }
            ]
        }
    ]
}

Significado dos objetos

Campos (obrigatórios)	Tipo	Descrição
program	list	Lista de programas ao qual a conta pesquisada faz parte.
dueDate	list	Data de vencimento atual da fatura do cliente.
name	string (100)	Nome do portador do cartão
email	string (100)	E-mail do portador do cartão
gender	string (1)	Indica o gênero do portador da conta. M para masculino e F para feminino
maritalStatus	string (10)	Indica o status civil do portador da conta, SINGLE para solteiro, MARRIED para casado, DIVORCED para divorciado e WIDOWER para viúvo
(grantedLimit)	int	Limite concedido para pós-pago (informado pelo cliente) - obrigatório apenas para programas de crédito, incluindo cartões pré-pago que transacionam na trilha do crédito
(limit)	int	Limite que o cliente definiu para uso, sempre igual ou menor que o granted_limit. -opcional
accountType	string (30)	Tipo da conta, preencher sempre PHYSICAL.
accountName	string (50)	Nome do proprietário da conta para identificação
documentNumber	string (20)	Documento do portador do cartão (CPF ou CNPJ)
birthDate	string (10)	Data de nascimento do portador do cartão
phoneType	string (10)	Tipo de telefone RESIDENTIAL é para telefone residencial, COMMERTIAL é para telefone comercial e MOBILE para telefone celular
countryCode	int	DDI em que o telefone se encontra
phone	string (10)	Número do telefone
areaCode	int	DDD em que o telefone se encontra
addressType	string (10)	Tipo de endereço, RESIDENTIAL é residencial, COMMERTIAL é comercial e Others
address	string (50)	Logradouro do endereço
number	int	Número do endereço
neighborhood	string (50)	Bairro do endereço
city	string (50)	Cidade do endereço
state	string (2)	Estado do endereço
country	string (5)	País do endereço
zipCode	string (10)	CEP do endereço
mailingAddress	boolean	Indica se é o endereço de entrega e correspondência.
complementaryAddress	string (100)	Complemento de informações para o endereço

Updated about 24 hours ago