Creating a virtual card

Request

ENDPOINT

/prepaid/card

METHOD

POST

Request Body

{
    "account_key": "5294ed8d-08fc-4397-b15f-6d9aa07b0041",
    "program_key":"7d405c31-ec9a-46c1-8ac8-54bab209bf41",
    "type": "virtual",
    "card_name": "ecommerce",
    "printed_name": "Aurora Catarina",
    "cvv_rotation_interval_hours": 72
}

Body params

Campo	Tipo	Descrição	Caracteres
account_key *	string	QI Tech Payment Account Identification Key	uuid
program_key *	string	Program identification key to issue a card.	uuid
type *	string	Type of card to be issued (VIRTUAL).	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
cvv_rotation_interval_hours *	int	Interval in hours to update the CVV number.	Number

Enumerators card_type

Enumerator	Translate
plastic	Physical Card
virtual	Virtual Card

Response

STATUS

201

Response Body

{
    "card_key": "05fd3654-1f5d-479d-ade5-64239fdf214d",
	"created_at": "2023-02-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}.
CARD000032	403	Create virtual 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": "virtual"
    }
}