Pular para o conteúdo principal

Gerar cartão físico

Request

ENDPOINT
/prepaid/card
MÉTODO
POST
Request Body
{
"account_key": "5294ed8d-08fc-4397-b15f-6d9aa07b0041",
"program_key": "7d405c31-ec9a-46c1-8ac8-54bab209bf41",
"type": "plastic",
"card_name": "ecommerce",
"printed_name": "Aurora Catarina",
"contactless_enabled": true,
"delivery_address": {
"address": "Rua Cel. Domingos Diniz",
"neighborhood": "Centro",
"zip_code": "35797000",
"city": "Presidente Juscelino",
"state": "MG",
"complement": "Quadra 08 Lote 259",
"reference": "Supermercado Presidente",
"address_type": "residential"
}
}
info

O endereço utilizado para o envio do cartão físico, será o mesmo informado na abertura da conta de pagamento na QI Tec.

Body params

CampoTipoDescriçãoCaracteres
account_key *stringChave de identificação da conta de pagamento na QI Tech.uuid
program_key *stringChave de identificação do programa para emitir um cartão.uuid
type *stringTipo do cartão a ser emitido (PLASTIC).Enumeradores
card_name *stringAlias do cartão, como esse cartão será identificado.15
printed_name *stringNome que será impresso no cartão (não será permitido o uso de números e caracteres especiais).26
contactless_enabled *booleanHabilitar ou desabilitar o uso de contactless do cartão-
delivery_addressObjectEndereco de entrega do cartãoObjeto Address

Enumeradores card_type

EnumeradorTradução
plasticCartão físico
virtualCartão virtual

Address

CampoTipoDescriçãoCaracteres
address*stringEndereço de entrega100
neighborhood*stringBairro do endereço de entrega100
zip_code*stringCEP do endereço de entrega8
city*stringCidade do endereço de entrega100
state*stringEstado do endereço de entrega2
complementstringComplemento do endereço de entrega100
referencestringPonto de referência do endereço de entrega100
address_type*stringTipo de entregaEnumeradores

Enumeradores address_type

EnumeradorTradução
residentialEndereço residencial
commercialEndereço comercial
otherOutro endereço

Response

STATUS
201
Response Body
{
"card_key": "05fd3654-1f5d-479d-ade5-64239fdf214d",
"created_at": "2023-06-20T19:28:16Z",
"status":"created"
}

Erros

STATUS
4XX
Response Body
{
"title": "Bad Request",
"description": "The type of person is invalid for this program, please try another.",
"translation": "Invalid Person",
"code": "CARD000007"
}
CodeStatus codeDescrição
QIT000001400Invalid Json schema.
CARD000005404It was not possible to fetch the Program for the program_key {program_key}.
CARD000006404It was not possible to fetch the Account for the account_key {account_key}.
CARD000007400The type of person is invalid for this program, please try another.
CARD000008400The Card Holder with the status {status} is invalid for the operation.
CARD000009400We're sorry, but the card could not be generated. Please try again later.
CARD000010404It was not possible to fetch the Person for the person_key {owner_person_key}.
CARD000033403Create plastic card is not allowed for program_key {program_key}.

Webhook

WEBHOOK_TYPE
baas.prepaid_card.card
Webhook Body
{
"webhook_type": "baas.prepaid_card.card",
"event_datetime": "2023-07-24T12:00:00.000Z",
"data": {
"card_key": "9bd93e97-bb6d-410f-8981-06b2765f12a1",
"account_key": "595e08f0-da4e-40f7-8db4-f9a25c829818",
"program_key": "bf74df61-557a-45cb-914f-41e127a6e18c",
"status": "created",
"type": "plastic"
}
}