Listar Cartões

GET /cards

Para utilizar esse método, o access_token deve conter o scope cards.read

Retorna todas as informações dos cartões de acordo com o filtro informado.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

myIds

string

Não

Card.myId
Ids dos cartões no seu sistema.
Separe cada id por vírgula.

galaxPayIds

string

Não

Ids dos cartões no cel_cash.
Separe cada id por vírgula.

customerMyIds

string

Não

Customer.myId
Id do cliente no seu sistema.
Separe cada id por vírgula.

customerGalaxPayIds

string

Não

Customer.galaxPayId
Id do cliente no cel_cash.
Separe cada id por vírgula.

createdAtFrom

date

Não

Data de criação inicial

createdAtTo

date

Não

Data de criação final.

status

string

Não

Status do cartão. Separe cada valor por vírgula.

Valor	Explicação
active	Ativo
inactive	Inativo

startAt

int

Sim

Ponteiro inicial para trazer os registros.

limit

int

Sim

Qtd máxima de registros para trazer.

order

string

Não

Ordenação do resultado. String que deverá ser montada da seguinte maneira:
campoDaEntidade.tipoDeOrdem

Valor	Explicação
createdAt.asc	Cartão criado em - Ordem crescente
createdAt.desc	Cartão criado em - Ordem decrescente

URL da Requisição

https://api.sandbox.cel.cash/v2/cards

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "totalQtdFoundInPage": 1,
    "Cards": [
        {
            "myId": "pay-664b00a76150b2.18263184",
            "galaxPayId": 1,
            "number": "4716********4539",
            "customerGalaxPayId": 1,
            "customerMyId": "ASDASD11",
            "createdAt": "2020-06-02 10:10:00",
            "updatedAt": "2020-06-02 10:10:00",
            "Brand": {
                "id": "mastercard",
                "name": "MasterCard",
                "maxInstallment": 12,
                "operatorIds": "pagseguro,cielo"
            },
            "expiresAt": "2024-05"
        }
    ]
}

Nome

Tipo

Explicação

totalQtdFoundInPage

int 11 dígitos

Quantidade total de registros do retorno da busca na página atual.

Cards

Array de cartões
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema.

galaxPayId

int 255 dígitos

Id no cel_cash

number

string 30 caracteres

Número truncado do cartão.

customerGalaxPayId

int 11 dígitos

Customer.galaxPayId
ID do cliente dentro do cel_cash.

customerMyId

string 255 caracteres

Customer.myId
Id do cliente no seu sistema.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Brand

Bandeira do cartão da transação.
Clique para ver os campos.

string 255 caracteres

Id da bandeira de cartão.

name

string 255 caracteres

Nome da bandeira.

maxInstallment

int 11 dígitos

Máximo de vezes que pode ser parcelado.

operatorIds

text

Operadoras que aceitam a bandeira, separados por vírgula.
CardOperator.id

expiresAt

string 7 caracteres

Mês e ano da expiração do cartão.
String contendo ano e mês de expiração do cartão.
YYYY-MM

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Nenhum cartão encontrado com os parâmetros utilizados.