Gerar cartão físico
Request
ENDPOINT
/prepaid/cardMÉTODO
POSTRequest 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
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
account_key * | string | Chave de identificação da conta de pagamento na QI Tech. | uuid |
program_key * | string | Chave de identificação do programa para emitir um cartão. | uuid |
type * | string | Tipo do cartão a ser emitido (PLASTIC). | Enumeradores |
card_name * | string | Alias do cartão, como esse cartão será identificado. | 15 |
printed_name * | string | Nome que será impresso no cartão (não será permitido o uso de números e caracteres especiais). | 26 |
contactless_enabled * | boolean | Habilitar ou desabilitar o uso de contactless do cartão | - |
delivery_address | Object | Endereco de entrega do cartão | Objeto Address |
Enumeradores card_type
Enumerador | Tradução |
---|---|
plastic | Cartão físico |
virtual | Cartão virtual |
Address
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
address* | string | Endereço de entrega | 100 |
neighborhood* | string | Bairro do endereço de entrega | 100 |
zip_code* | string | CEP do endereço de entrega | 8 |
city* | string | Cidade do endereço de entrega | 100 |
state* | string | Estado do endereço de entrega | 2 |
complement | string | Complemento do endereço de entrega | 100 |
reference | string | Ponto de referência do endereço de entrega | 100 |
address_type* | string | Tipo de entrega | Enumeradores |
Enumeradores address_type
Enumerador | Tradução |
---|---|
residential | Endereço residencial |
commercial | Endereço comercial |
other | Outro endereço |
Response
STATUS
201Response Body
{
"card_key": "05fd3654-1f5d-479d-ade5-64239fdf214d",
"created_at": "2023-06-20T19:28:16Z",
"status":"created"
}
Erros
STATUS
4XXResponse Body
{
"title": "Bad Request",
"description": "The type of person is invalid for this program, please try another.",
"translation": "Invalid Person",
"code": "CARD000007"
}
Code | Status code | Descrição |
---|---|---|
QIT000001 | 400 | Invalid Json schema. |
CARD000005 | 404 | It was not possible to fetch the Program for the program_key {program_key}. |
CARD000006 | 404 | It was not possible to fetch the Account for the account_key {account_key}. |
CARD000007 | 400 | The type of person is invalid for this program, please try another. |
CARD000008 | 400 | The Card Holder with the status {status} is invalid for the operation. |
CARD000009 | 400 | We're sorry, but the card could not be generated. Please try again later. |
CARD000010 | 404 | It was not possible to fetch the Person for the person_key {owner_person_key}. |
CARD000033 | 403 | Create plastic card is not allowed for program_key {program_key}. |
Webhook
WEBHOOK_TYPE
baas.prepaid_card.cardWebhook 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"
}
}