Activate physical card

All physical cards need to be activated using an activation code that is sent along with the physical card to the holder.

When receiving the card by mail, the card holder must inform the QI partner so that the partner can activate the card through this endpoint.

Attention

For security reasons, there is no possibility of consulting the activation code via API on the part of the partner.

This code is sent exclusively to the cardholder at the time of posting the physical card.

Request

ENDPOINT

/prepaid/card/CARD_KEY/activate

METHOD

PATCH

Path params

Field	Type	Description	Characters
CARD_KEY *	string	Card identification key.	uuid

Request Body

{
    "code": "253615"
}

Body params

Field	Type	Description	Characters
code *	string	Activation code of the card.	6

Erros

STATUS

4XX

Response 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.card

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