Criar Cartão

POST /cards/{customerId}/{typeId}

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

Método utilizado para criar cartões dentro do sistema.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

myId

string 255 caracteres

Sim

Id referente no seu sistema, para salvar no cel_cash.

isBackup

bool

Não

Informar se será cadastrado como cartão reserva.

number

string 30 caracteres

Sim

Número do cartão.
Para APROVAR: 4111 1111 1111 1111
Para NEGAR: 4242 4242 4242 4242

holder

string 30 caracteres

Sim

Nome do portador. Não aceita caracteres especiais ou acentuação.

expiresAt

string 7 caracteres

Sim

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

cvv

string 4 caracteres

Sim

Código de segurança.

Parâmetros da URL:

{customerId}: Id do cliente dono do cartão.
{typeId}: Tipo do id. Opções:
- galaxPayId: Id no cel_cash
- myId: Id referente no seu sistema, para salvar no cel_cash.

URL da Requisição

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

URL da Requisição

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

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Card": {
        "myId": "pay-6891b76703dd28.82129392",
        "galaxPayId": 1,
        "isBackup": false,
        "number": "4716********4539",
        "customerMyId": "ASDASD11",
        "customerGalaxPayId": 1,
        "createdAt": "2020-06-02 10:10:00",
        "updatedAt": "2020-06-02 10:10:00",
        "expiresAt": "2025-08",
        "Brand": {
            "id": "mastercard",
            "name": "MasterCard",
            "maxInstallment": 12,
            "operatorIds": "cielo,pagseguro"
        }
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Card

Cartão
Clique para ver os campos.

myId

string 255 caracteres

Id referente no seu sistema.

galaxPayId

int 11 dígitos

Id no cel_cash

isBackup

bool

Cartão reserva.

number

string 30 caracteres

Número truncado do cartão.

customerMyId

string 255 caracteres

Customer.myId
Id do cliente no seu sistema.

customerGalaxPayId

int 11 dígitos

Customer.galaxPayId
ID do cliente dentro do cel_cash.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

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

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

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

Cartão cadastrado com sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Cliente não encontrado.