Ativar cartão físico
Todo cartão físico precisa ser ativado através de um código de ativação que é enviado junto do cartão físico, ao portador.
Ao receber o cartão por correspondência, o portador do cartão precisa informar ao parceiro da QI, para que o parceiro realize a ativação do cartão através deste endpoint.
Atenção
Por motivos de segurança, não existe a possibilidade de consulta do código de ativação via API por parte do parceiro.
Este código é enviado, exclusivamente ao portador do cartão, no momento da postagem do cartão físico.
Para realizar testes de integração, esse código é devolvido em ambiente de sandobox ao consultar um cartão.
Request
ENDPOINT
/prepaid/card/CARD_KEY/activateMÉTODO
PATCHPath params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
CARD_KEY * | string | Chave de identificação do cartão. | uuid |
Request Body
{
"code": "253615"
}
Body params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
code * | string | Código de ativação do cartão. | 6 |
Erros
STATUS
4XXResponse Body
{
"title": "Not Acceptable",
"description": "Invalid activation code [1254].",
"translation": "Unable to activate card",
"code": "CARD000020"
}
Code | Status code | Description |
---|---|---|
QIT000001 | 400 | Invalid Json schema. |
CARD000011 | 404 | It was not possible to fetch the Card for the card_key {card_key}. |
CARD000017 | 406 | The activation operation is not valid for the current card status [{card_status}]. |
CARD000018 | 400 | We're sorry, but the card could not be activate. Please try again later. |
CARD000020 | 406 | Invalid activation code [{code}]. |
CARD000023 | 406 | The card type is invalid for this operation. Only plastic cards are allowed. |
Webhook
WEBHOOK_TYPE
baas.prepaid_card.cardWebhook Body
{
"webhook_type": "baas.prepaid_card.card",
"event_datetime": "2023-07-25T12:00:00.000Z",
"data": {
"card_key": "9bd93e97-bb6d-410f-8981-06b2765f12a1",
"type": "plastic",
"status": "active",
"old_status": "embossing"
}
}