Skip to main content

Contactless configuration

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

To enable or disable contactless payment for the card, the card status must be Active or Temporary block. (For information about status types, see here)

Request

ENDPOINT
/wallet/WALLET_KEY/card/CARD_KEY/contactless
METHOD
PATCH

Path params

FieldTypeDescriptionCharacters
WALLET_KEY *stringWallet identification key.uuid
CARD_KEY *stringCard identification key.uuid
Request Body
{
"contactless_enabled": false
}

Body params

FieldTypeDescriptionCharacters
contactless_enabled *BooleanIndicates whether it is enabled or not.true/false

Response

STATUS SUCCESS
200
Response Body
{
"card_key": "05fd3654-1f5d-479d-ade5-64239fdf214d",
"status": "active",
"account_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"program_key": "6b6ebaac-043b-4390-8d62-e8098ec901e9",
"type": "virtual",
"card_name": "ecommerce",
"printed_name": "Aurora Catarina",
"brand": "visa",
"last_four_digits": "5695",
"created_at": "2023-02-20T19:28:16Z",
"updated_at": "2023-02-22T19:28:16Z",
"cvv_rotation_interval_hours": 72
}

Errors

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"
}
CodeStatus codeDescription
QIT000001400Invalid Json schema.
CARD000011404It was not possible to fetch the Card for the card_key {card_key}.
CARD000023406The card type is invalid for this operation. Only plastic cards are allowed.
CARD000026400We're sorry, but the card could not be update contactless. Please try again later.
CARD000025406The status {status} is invalid for the operation.