Emissão de Cartão Virtual
Realize a emissão de um Cartão Virtual, aquele que não é emitido como um cartão físico.
Diferente dos cartões físicos, os cartões virtuais, uma vez gerados, não precisam ser desbloqueados (ativados) para que possam ser usados. Sua data de expiração segue o padrão de anos definido para o BIN, sendo possível ser utilizado para compras recorrentes.
No caso de operação com um cartão virtual do tipo compra única, aquele que é excluído após um uso, ou tempo pré-definido, essas regras e operação são de responsabilidade do contratante do serviço, ou seja, deve ser monitorado o webhook de compra e em seguida realizado o comando de exclusão do cartão. Caso não seja feito, o cartão permanecerá válido até sua data de expiração.
Alguns parâmetros podem ser definidos por cartão, conforme abaixo.
PREENCHER COM O DETALHAMENTO DOS CAMPOS DO REQUEST, SUA OBRIGATORIEDADE E O QUE ACONTECE CASO SEJA INFORMADO VAZIO OU NULO
Passos para Integrar
- Realizar autenticação na API.
- Realizar a Emissão do cartão virtual na API.
- Receber o Webhook com o status da Emissão.
Caso seja necessário, a consulta do status da emissão pode ser realizado manualmente.
- Consultar status da Emissão
Emissão de Cartão Virtual
Para realizar a emissão de um cartão virtual, após a autenticação, é necessário enviar a seguinte requisição no endpoint api/card, informando o valor VIRTUAL no campo type.
cURL da chamada
{
"name": "Nome do Cartão",
"printedName": "Nome impresso no cartão",
"type": "VIRTUAL",
"cvvRotationIntervalHours": 24,
"embossingGroup": "Grupo de Embossadora",
"abuEnabled": false,
"transactionLimit": 100000,
"customerId": 1,
"accountId": 2,
"programId": 1234,
"contactlessEnabled": true,
"modeType": "SINGLE"
}
Sucesso 200
{
"version": false,
"status": 200,
"body": {
"customerId": 67,
"accountId": 85,
"programId": 15,
"name": "Cartao Pre-Pago CEL ",
"printedName": "John Doe",
"type": "VIRTUAL",
"cvvRotationIntervalHours": 24,
"transactionLimit": 99999,
"contactlessEnabled": true,
"modeType": "SINGLE",
}
}
Significado dos objetos
Campo | Tipo | Descrição |
---|---|---|
version | string (10) | Versão da API |
status | int | https status retornado |
customerId | int | Id do cliente cadastrado na Celcoin |
accountId | int | Id da conta cadastrada |
programid | int | Id do programa utilizado |
name | string (50) | Nome de identificação do cartão |
printedName | string (26) | Nome impresso no cartão |
type | string (10) | PLASTIC indica que é um cartão físico e VIRTUAL indica que é um cartão virtual |
cvvRotationItevalHours | int | Intervalo em horas para troca do código CVV em cartões virtuais. |
transactionLimit | int | Indica o limite que pode ser utilizado em um cartão virtual por transação (valor máximo por compra) |
contaclessEnabled | boolean | TRUE indica que a aproximação está habilitado e FALSE indica que a aproximação esta desativada |
modeType | string (10) | SINGLE indica que o cartão só pode ser utilizado para uma modalidade atrelada as configurações do programa. Para cartões virtuais, sempre informar SINGLE. |
Consulta da Emissão
Em casos de intermitência, demora do webhook ou qualquer resposta inesperada retornada pelo endpoint api/card, é possível realizar uma consulta da emissão para verificar o status da mesma.
cURL da chamada
curl -X 'GET' \
'https://kubernetes.celcoin.dev/api/card/{cardId}?cardId=1' \
-H 'accept: application/json'
Sucesso 200
{
"version": false,
"status": 200,
"body": {
"id": 1216,
"last_digits": "0412",
"status": "NORMAL",
"function": "DEBIT",
"bin": "123456",
"type": "VIRTUAL",
"expirationDate": "24/08/2029"
}
}
Significado dos objetos
Campo | Tipo | Descrição |
---|---|---|
id | int | Id do cartão que foi criado. |
last_digits | int | Últimos 4 dígitos gerados no cartão. |
status | string(20) | Em que status o cartão se encontra. |
function | string(6) | Indica a modalidade do cartão |
bin | int | BIN que o cartão vai utilizar. |
type | string(7) | O Type define qual o tipo de cartão vai ser emitido, PLASTIC para cartões físicos, VIRTUAL para cartões virtuais. |
expirationDate | date | Data de expiração do cartão emitido. |
Updated 1 day ago