Creating a physical card

Request

ENDPOINT

/prepaid/card

METHOD

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"
    }
}

Information

The address used for sending the physical card will be the same one provided when opening the payment account at QI Tech.

Body params

Field	Type	Description	Characters
account_key *	string	Account identification key on QI Tech payment.	uuid
program_key *	string	Program identification key to issue a card.	uuid
type *	string	Type of card to be issued (PLASTIC).	Enumerators
card_name *	string	Card alias, how this card will be identified.	15
printed_name *	string	Name to be printed on the card (numbers and special characters will not be allowed).	26
contactless_enabled *	boolean	Enable or disable the use of contactless on the card	-
delivery_address	Object	Card delivery address.	Object Address

Enumerators card_type

Enumerator	Translate
plastic	Physical Card
virtual	Virtual Card

Address

Field	Type	Description	Characters
address*	string	Card delivery address	100
neighborhood*	string	Neighborhood of the delivery address	100
zip_code*	string	ZIP code of the delivery address	8
city*	string	City of the delivery address	100
state*	string	State of the delivery address	2
complement	string	Complement of the delivery address	100
reference	string	Reference point of the delivery address	100
address_type*	string	Type of delivery	Enumerators

Enumeradores address_type

Enumerator	Translation
residential	Residential address
commercial	Commercial address
other	Other address

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"
}

Code	Status code	Description
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.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"
    }
}