A API de Cartões contém todos os endpoints necessários para criar cartões nomeados e não nomeados, ativá-los, realizar pesquisas, obter as informações de um determinado cartão e muito mais.
O endpoint /cards/v1/
permite criar um novo cartão, tanto físico como virtual.
Validaremos que cumplas los requisitos que detallamos en la documentación.
O endpoint /cards/v1/
permite buscar um grupo de cartões com base nos atributos especificados.
Você pode filtrar e classificar cartões seguindo esta documentação.
Os atributos que podem ser ordenados são:
card_type
user_id
status
affinity_group_id
status_detail
shipment_id
innominate
start_date
.O endpoint /cards/v1/{id}
permite obter informações sobre um cartão específico.
O endpoint /cards/v1/{id}
permite atualizar o status, o grupo de afinidade e o PIN de um cartão.
Será necessário especificar um motivo da lista abaixo para atualizar o status de um cartão:
Novo status | Motivo válido |
---|---|
BLOCKED / DISABLED | CLIENT_INTERNAL_REASON |
BLOCKED / DISABLED | USER_INTERNAL_REASON |
DISABLED | LOST |
DISABLED | STOLEN |
DISABLED | BROKEN |
DISABLED | UPGRADE |
O endpoint /cards/v1/activation
permite ativar um cartão físico e configurar um PIN.
Validaremos que cumplas los requisitos que detallamos en la documentación.
Adicione este endpoint ao seu serviço para que possamos comunicar as últimas novidades sobre seus cartões em tempo real.
Se tiver dúvidas sobre como configurar um webhook, visite nossa documentação.
Esperamos uma resposta na faixa 2XX para garantir que você tenha recebido a notificação. Caso contrário, iremos reenviá-la.
ACTIVATION
: Notificaremos você sempre que um de seus clientes ativar seu cartão.api-secret
deve-se usar, caso vários pares de api-key
e api-secret
tenham sido configurados.O endpoint /cards/v1/{id}/shipment
permite atualizar o endereço de envio de um cartão.
O cartão deverá ser nomeado fisicamente e possuir o status CREATED
.
O endpoint /cards/v1/batches
permite criar um lote de cartões sem nome.
Validaremos que cumplas los requisitos que detallamos en la documentación.
CLIENT
.O endpoint /cards/v1/batches/bulk
permite que você crie até 15 lotes de cartões sem nome ao mesmo tempo.
Validaremos que cumplas los requisitos que detallamos en la documentación.
CLIENT
.O endpoint /cards/v1/batches/shipments/{shipmentId}
permite atualizar o endereço de envio de um lote de cartões.
O lote de cartões deverá ser nomeado fisicamente e possuir status CREATED
.
/config/affinity-groups/{id}
permite obter informações sobre um grupo de afinidade específico.