Contactless Configuration

Enable or disable the contactless payment functionality for in-person use.

To enable or disable the contactless payment feature of the card, the card status must be of type Active or Temporary block. (For information about the status types, refer to here)

Request

ENDPOINT

/prepaid/card/CARD_KEY/contactless

METHOD

PATCH

Path params

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

Request Body

{
    "contactless_enabled": false
}

Body params

Field	Type	Description	Characters
contactless_enabled *	Boolean	Indicates whether it is enabled or not.	true/false

Response

STATUS SUCCESS

200

Erros

STATUS

4XX

Response Body

{
  "title": "Bad Request",
  "description": "We're sorry, but the card could not be update contactless. Please try again later.",
  "translation": "Unexpected error update contactless card",
  "code": "CARD000026"
}

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}.
CARD000023	406	The card type is invalid for this operation. Only plastic cards are allowed.
CARD000026	400	We're sorry, but the card could not be update contactless. Please try again later.
CARD000025	406	The status {status} is invalid for the operation.

Webhook

WEBHOOK_TYPE

baas.prepaid_card.card.updated.contactless

Webhook Body

{
    "webhook_type": "baas.prepaid_card.card.updated.contactless",
    "event_datetime": "2023-07-25T12:00:00.000Z",
    "data": {
        "card_key": "9bd93e97-bb6d-410f-8981-06b2765f12a1",
        "contactless_enabled": true
    }
}