Desativar cartão
curl --request DELETE \
--url https://api.sandbox.z2pay.com/v1/customers/{customerId}/cards/{cardId} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/customers/{customerId}/cards/{cardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/customers/{customerId}/cards/{cardId}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"id": "crd_hqx4mkpi8dcxbrb2nzynxnjky",
"customerId": "cust_j43n74fbt2geb8c1y86ssf6iw",
"brand": "visa",
"firstDigits": "411111",
"lastDigits": "1111",
"holderName": "JOAO DA SILVA",
"expirationMonth": "12",
"expirationYear": "2030",
"status": "disabled",
"createdAt": "2026-07-02T19:26:17.000Z",
"updatedAt": "2026-07-02T20:10:42.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Card not found"
}
}{
"error": "A request with this idempotency key is already being processed"
}{
"error": "Idempotency key already used with a different request body"
}Cartões
Desativar cartão
Desativa um cartão salvo — ele sai da listagem e deixa de poder ser cobrado.
DELETE
/
customers
/
{customerId}
/
cards
/
{cardId}
Desativar cartão
curl --request DELETE \
--url https://api.sandbox.z2pay.com/v1/customers/{customerId}/cards/{cardId} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/customers/{customerId}/cards/{cardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/customers/{customerId}/cards/{cardId}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"id": "crd_hqx4mkpi8dcxbrb2nzynxnjky",
"customerId": "cust_j43n74fbt2geb8c1y86ssf6iw",
"brand": "visa",
"firstDigits": "411111",
"lastDigits": "1111",
"holderName": "JOAO DA SILVA",
"expirationMonth": "12",
"expirationYear": "2030",
"status": "disabled",
"createdAt": "2026-07-02T19:26:17.000Z",
"updatedAt": "2026-07-02T20:10:42.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Card not found"
}
}{
"error": "A request with this idempotency key is already being processed"
}{
"error": "Idempotency key already used with a different request body"
}DELETE /customers/{customerId}/cards/{cardId}
Faz parte do recurso Cartões — como um cartão é salvo e como cobrá-lo estão lá.
Desativa o cartão. Ele sai da listagem, o GET por ID passa a responder 404
e o crd_ deixa de servir para cobrar.
A resposta é a última vez que você vê o cartão, e ela vem com
status: "disabled". Se você
registra a desativação do seu lado, é daqui que o dado sai — depois desta chamada, nenhuma rota
devolve esse crd_.Não há rota de reativação — mas salvar o mesmo cartão o reativa. Se o cliente informar o
mesmo cartão de novo (um token novo do Tokenizer, mesmos dados), a impressão
digital casa com o registro desativado e ele volta ativo, com o mesmo
crd_. Cartão
diferente gera um crd_ novo. Trate a desativação como “parar de cobrar”, não como apagar: o
reenvio do próprio cartão pelo cliente desfaz.O histórico não muda. Transações e pagamentos feitos com aquele cartão continuam existindo e
guardam os dados usados na cobrança. Desativar é sobre o uso futuro, não sobre o passado.
Endpoint idempotente. Envie o header
Idempotency-Key — desativar duas vezes por um retry não é
problema, mas a segunda chamada sem a chave responderia 404, já que o cartão não é mais
encontrado.Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Response
Cartão desativado
ID do cartão (crd_).
Cliente dono do cartão (cust_).
Bandeira (ex.: visa, mastercard).
Seis primeiros dígitos.
Quatro últimos dígitos.
Nome impresso no cartão.
Mês de validade (MM).
Ano de validade (YYYY).
Situação do cartão.
Criação, ISO 8601.
Última alteração, ISO 8601.