Emissão, consulta e cancelamento de cobranças por boleto, PIX e cartão de crédito (uma ou várias por chamada, em lote), acompanhamento dos lotes e cofre de cartões usados nas cobranças por cartão.
Autenticação em todos os exemplos: veja Autenticação. Teste no navegador pelo Swagger ou importe a coleção do Postman.
| Endpoint | Métodos | Para que serve |
|---|---|---|
cobranca |
GET, POST, DELETE | Cobranças por boleto, PIX ou cartão: emitir, consultar e cancelar |
lote |
GET | Andamento dos lotes de cobrança |
cartao |
GET, POST, PUT, DELETE | Cofre de cartões de crédito do cedente (para cobranças por cartão) |
Cobranças por boleto, PIX ou cartão: emitir, consultar e cancelar. Rota principal do ZP Cobrança. A cobrança é emitida num convênio (conta bancária + integrador + tipo) do cedente do acesso. Uma cobrança só por chamada: o ZP grava e já registra no banco/integrador na mesma chamada. Várias cobranças: o ZP cria um lote, grava todas na situação NW e o registro no banco é feito depois, pela rotina do ZP (acompanhe por /lote e GET cobranca). Se qualquer cobrança do pedido for recusada na validação, nenhuma é gravada. PUT existe na permissão, mas não está implementado (405). Escopo: o perfil Filial usa os convênios do próprio cedente; os outros perfis informam id_tx_estabelecimento (= id do cedente).
/v1/terceiro/cobrancaConsulta uma cobrança ou lista as de um convênio por vencimento
Perfis: App, Rede, Estabelecimento, Cliente, Pessoa
Ações (parâmetro acao):
| Ação | O que faz |
|---|---|
get |
Uma cobrança pelo id_cobranca (padrão). |
list |
Cobranças do convênio com vencimento entre data_inicial e data_final. |
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_convenio |
integer | sim | Convênio (id_cob_convenio). |
acao |
string | não | get (uma cobrança, padrão) ou list (por período de vencimento). |
id_cobranca |
integer | não | acao=get: obrigatório. acao=list: não enviar. |
data_inicial |
date | não | acao=list: obrigatório; vencimento inicial (AAAA-MM-DD). acao=get: não enviar. |
data_final |
date | não | acao=list: obrigatório; vencimento final, maior ou igual à inicial. |
id_tx_estabelecimento |
integer | não | Cedente; fixo no perfil Filial. |
curl -s -X GET "$BASE/v1/terceiro/cobranca?$AUTH&id_convenio=10"
Resposta:
{
"status": "ok",
"cobrancas_sucesso": {
"cobrancas": [
{
"id_cob_cobranca": 5001,
"tipo": "BOLETO",
"situacao": "RG",
"codigo_cobranca": "PED-1001",
"id_cob_convenio": 10,
"id_cob_integrador": 3,
"id_cob_tipo": 1,
"integracao": "<nome do integrador>",
"homologacao": true,
"nosso_numero": 123,
"documento_especie": "DM",
"documento_numero": 1001,
"documento_data": "2026-11-12",
"documento_valor": 150.0,
"documento_vencimento": "2026-12-10",
"documento_hora_vencimento": null,
"instrucoes": "NÃO RECEBER APÓS 30 DIAS DO VENCIMENTO",
"observacoes": "",
"perc_multa": 2.0,
"perc_juros_dia": 0.033,
"perc_desconto1": 0.0,
"data_desconto1": null,
"perc_desconto2": 0.0,
"data_desconto2": null,
"perc_desconto3": 0.0,
"data_desconto3": null,
"prazo_baixa": 0,
"prazo_protesto": 0,
"linha_digitavel": "99999999999999999999999999999999999999999999999",
"codigo_barras": "99999999999999999999999999999999999999999999",
"pix_emv": "",
"pix_tx_id": "",
"token_cartao": "",
"identificador_externo": "<id no banco/integrador>",
"data_hora_processamento": "2026-11-12 10:00:00.000",
"data_pagamento": null,
"data_credito": null,
"valor_recebido": 0.0,
"valor_multa": 0.0,
"valor_juros": 0.0,
"valor_tarifas": 0.0,
"response_json_integrador": "<resposta do integrador>",
"url_impressao_cobranca": "https://zp1.txfuel.com.br/api/v1/generica/zpCobrancaPdf?cobranca=<hash>&cob_tipo=BOLETO",
"cedente": {
"cpf_cnpj": "11222333000181",
"nome_razao_social": "EMPRESA EXEMPLO LTDA",
"cep": "80000000",
"logradouro": "AVENIDA EXEMPLO",
"numero": 1000,
"complemento": "SALA 1",
"bairro": "CENTRO",
"localidade": "CURITIBA",
"estado": "PR",
"telefone": "4133330000",
"celular": "41988880000",
"email": "financeiro@exemplo.com.br"
},
"conta": {
"banco": "<banco>",
"agencia": "1234",
"agencia_dv": "0",
"numero": "56789",
"numero_dv": "0"
},
"sacado": {
"cpf_cnpj": "12345678909",
"nome_razao_social": "CLIENTE EXEMPLO DA SILVA",
"cep": "80000000",
"logradouro": "RUA EXEMPLO",
"numero": 100,
"complemento": "",
"bairro": "CENTRO",
"localidade": "CURITIBA",
"estado": "PR",
"telefone": "",
"celular": "41999990000",
"email": "cliente@exemplo.com.br"
},
"avalista": {
"cpf_cnpj": "",
"nome_razao_social": "",
"cep": "",
"logradouro": "",
"numero": 0,
"complemento": "",
"bairro": "",
"localidade": "",
"estado": "",
"telefone": "",
"celular": "",
"email": ""
}
}
],
"totalRequestTimeMs": 25,
"totalDatabaseTimeMs": 0,
"totalGatewayTimeMs": 0,
"idLote": 0
}
}
Erros específicos: 400 — {"errors":{"acao":"Ação inválida, era esperado: get ou list"}}.; 400 — {"errors":{"id_convenio":"O Parâmetro id_convenio é obrigatório"}} ou "Convenio não localizado: ".; 400 — {"errors":{"data_inicial":"Parâmetros data_inicial e data_final são obrigatórios"}} (list) ou "Não informar os parâmetros data_inicial e data_final para acao = get".; 400 — {"errors":{"data_final":"A data final deve ser maior ou igual à data inicial"}}.; 400 — {"errors":{"id_cobranca":"Cobrança não localizada: "}}: inexistente, de outro convênio ou fora do escopo..
/v1/terceiro/cobrancaEmite uma ou várias cobranças
Corpo JSON. Datas no formato AAAA-MM-DD. documento_hora_vencimento é aceito mas hoje não é gravado. Regras de CARTAO/PIX: sem multa, juros, descontos, prazos de baixa/protesto e sem avalista. Resposta: com uma cobrança, já registrada (linha digitável, PIX copia e cola, ou pagamento do cartão); com várias, situação NW e idLote preenchido.
Perfis: App, Rede, Estabelecimento, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_tx_estabelecimento |
integer | não | Cedente (id do cedente = id da filial). Fixo no perfil Filial; nos outros perfis, informe. |
Corpo (JSON objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_convenio |
integer | sim | Convênio do cedente (id_cob_convenio). |
tipo |
string | sim | BOLETO, PIX ou CARTAO; tem de ser o tipo do convênio. |
cobrancas |
array | sim | Uma ou mais cobranças. |
curl -s -X POST "$BASE/v1/terceiro/cobranca?$AUTH" \
-H 'Content-Type: application/json' \
-d '{"id_convenio": 10, "tipo": "BOLETO", "cobrancas": [{"codigo_cobranca": "PED-1001", "documento_numero": 1001, "documento_data": "2026-11-12", "documento_valor": 150.0, "documento_vencimento": "2026-12-10", "documento_especie": "DM", "instrucoes": "NÃO RECEBER APÓS 30 DIAS DO VENCIMENTO", "perc_multa": 2.0, "perc_juros_dia": 0.033, "incluir_pix_boleto": true, "sacado": {"cpf_cnpj": "12345678909", "nome_razao_social": "CLIENTE EXEMPLO DA SILVA", "cep": "80000000", "logradouro": "RUA EXEMPLO", "numero": 100, "complemento": "", "bairro": "CENTRO", "localidade": "CURITIBA", "estado": "PR", "telefone": "", "celular": "41999990000", "email": "cliente@exemplo.com.br"}}]}'
Resposta:
{
"status": "ok",
"cobrancas_sucesso": {
"cobrancas": [
{
"id_cob_cobranca": 5001,
"tipo": "BOLETO",
"situacao": "RG",
"codigo_cobranca": "PED-1001",
"id_cob_convenio": 10,
"id_cob_integrador": 3,
"id_cob_tipo": 1,
"integracao": "<nome do integrador>",
"homologacao": true,
"nosso_numero": 123,
"documento_especie": "DM",
"documento_numero": 1001,
"documento_data": "2026-11-12",
"documento_valor": 150.0,
"documento_vencimento": "2026-12-10",
"documento_hora_vencimento": null,
"instrucoes": "NÃO RECEBER APÓS 30 DIAS DO VENCIMENTO",
"observacoes": "",
"perc_multa": 2.0,
"perc_juros_dia": 0.033,
"perc_desconto1": 0.0,
"data_desconto1": null,
"perc_desconto2": 0.0,
"data_desconto2": null,
"perc_desconto3": 0.0,
"data_desconto3": null,
"prazo_baixa": 0,
"prazo_protesto": 0,
"linha_digitavel": "99999999999999999999999999999999999999999999999",
"codigo_barras": "99999999999999999999999999999999999999999999",
"pix_emv": "",
"pix_tx_id": "",
"token_cartao": "",
"identificador_externo": "<id no banco/integrador>",
"data_hora_processamento": "2026-11-12 10:00:00.000",
"data_pagamento": null,
"data_credito": null,
"valor_recebido": 0.0,
"valor_multa": 0.0,
"valor_juros": 0.0,
"valor_tarifas": 0.0,
"response_json_integrador": "<resposta do integrador>",
"url_impressao_cobranca": "https://zp1.txfuel.com.br/api/v1/generica/zpCobrancaPdf?cobranca=<hash>&cob_tipo=BOLETO",
"cedente": {
"cpf_cnpj": "11222333000181",
"nome_razao_social": "EMPRESA EXEMPLO LTDA",
"cep": "80000000",
"logradouro": "AVENIDA EXEMPLO",
"numero": 1000,
"complemento": "SALA 1",
"bairro": "CENTRO",
"localidade": "CURITIBA",
"estado": "PR",
"telefone": "4133330000",
"celular": "41988880000",
"email": "financeiro@exemplo.com.br"
},
"conta": {
"banco": "<banco>",
"agencia": "1234",
"agencia_dv": "0",
"numero": "56789",
"numero_dv": "0"
},
"sacado": {
"cpf_cnpj": "12345678909",
"nome_razao_social": "CLIENTE EXEMPLO DA SILVA",
"cep": "80000000",
"logradouro": "RUA EXEMPLO",
"numero": 100,
"complemento": "",
"bairro": "CENTRO",
"localidade": "CURITIBA",
"estado": "PR",
"telefone": "",
"celular": "41999990000",
"email": "cliente@exemplo.com.br"
},
"avalista": {
"cpf_cnpj": "",
"nome_razao_social": "",
"cep": "",
"logradouro": "",
"numero": 0,
"complemento": "",
"bairro": "",
"localidade": "",
"estado": "",
"telefone": "",
"celular": "",
"email": ""
}
}
],
"totalRequestTimeMs": 850,
"totalDatabaseTimeMs": 40,
"totalGatewayTimeMs": 800,
"idLote": 0
}
}
Erros específicos: 400 — {"errors":{"body":"request.cobrancas é obrigatório 1 ou mais registros."}} (também para id_convenio e tipo ausentes).; 400 — {"errors":{"body.idConvenio":"Convênio não localizado: !"}}: convênio inexistente, inativo ou de outro cedente.; 400 — {"errors":{"body.tipo":"O Convenio [] ... está configurado para PIX e foi solicitado: BOLETO!"}}.; 400 — Erro de validação: {"status":"error","errors":{"body.cobrancas":"Falha ao incluir 1 cobrança, verifique o objeto cobrancas_erro!"},"cobrancas_erro":[{"cobranca":{},"errors":["sacado_email: Não pode ficar sem valor"]}]}.; 400 — com uma cobrança só, se o banco/integrador recusar o registro: cobrancas_erro traz a resposta do integrador; a cobrança fica gravada na situação FR (falha no registro).; 500 — corpo vazio ou que não é JSON..
/v1/terceiro/cobrancaCancela uma cobrança
Não cancela no banco na mesma chamada: cobrança nova (NW) vira CS; registrada ou paga vira FC e a rotina do ZP faz o cancelamento. Acompanhe pelo GET.
Perfis: App, Rede, Estabelecimento, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_cobranca |
integer | sim | Cobrança (id_cob_cobranca). |
id_tx_estabelecimento |
integer | não | Cedente; fixo no perfil Filial. |
curl -s -X DELETE "$BASE/v1/terceiro/cobranca?$AUTH&id_cobranca=5001"
Resposta:
{
"status": "ok",
"cobrancas_sucesso": {
"cobrancas": [
{
"id_cob_cobranca": 5001,
"situacao": "FC",
"...": "(demais campos da cobrança)"
}
],
"totalRequestTimeMs": 12,
"totalDatabaseTimeMs": 12,
"totalGatewayTimeMs": 0,
"idLote": 0
}
}
Erros específicos: 400 — {"errors":{"id_cobranca":"O Parâmetro id_cobranca é obrigatório!"}}.; 400 — {"errors":{"id_cobranca":"Cobrança não localizada: "}}.; 400 — {"errors":{"id_cobranca":"A cobrança não foi enviada para a fila de cancelamento, para ser enviada ela precisa ser: NOVA, REGISTRADA ou PAGA!"}}..
Andamento dos lotes de cobrança. Mostra quantas cobranças de cada lote (criado pelo POST cobranca com mais de uma cobrança) já foram processadas pela rotina do ZP. Só GET. Atenção: a rota não confere se o convênio é do acesso (ver dúvidas no relatório).
/v1/terceiro/loteUm lote ou lista de lotes de um convênio
Perfis: App, Rede, Estabelecimento, Cliente, Pessoa
Ações (parâmetro acao):
| Ação | O que faz |
|---|---|
get |
Um lote (padrão). |
list |
Lotes do convênio criados no período, paginados. |
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_cob_convenio |
integer | sim | Convênio dos lotes. |
acao |
string | não | get (um lote, padrão) ou list. |
id_cob_lote |
integer | não | acao=get: obrigatório. |
data_inicial |
date | não | acao=list: data de criação inicial (padrão 1980-01-01). Aceita também data_inicio e data_ini. |
data_final |
date | não | acao=list: data de criação final (padrão 2099-12-31). Aceita também data_fim. |
size |
integer | não | acao=list: tamanho da página, de 1 a 50. |
page |
integer | não | acao=list: página. |
curl -s -X GET "$BASE/v1/terceiro/lote?$AUTH&id_cob_convenio=10"
Resposta:
{
"status": "ok",
"id_cob_lote": 77,
"total_cobrancas": 120,
"cobrancas_processadas": 118,
"cobrancas_pendentes": 2,
"lote_processado": "N"
}
Erros específicos: 400 — {"errors":{"validation":{"id_cob_lote":["Se a ação for get o id_cob_lote tem de ser maior que 0"]}}}.; 200 — só {"status":"ok"} quando o lote não existe no convênio..
Cofre de cartões de crédito do cedente (para cobranças por cartão). Guarda o cartão do pagador e devolve um card_token, usado depois no POST cobranca com tipo CARTAO. A resposta nunca traz o número completo nem o CVV. Escopo: o cartão é do cedente; no perfil Filial vale o cedente da própria filial (perfil Pessoa: o cedente da pessoa). Use sempre dados de teste em homologação (ex.: 4111 1111 1111 1111).
/v1/terceiro/cartaoLista os cartões do cedente ou consulta um
acao=get devolve os campos do cartão na raiz (sem a lista cartoes).
Perfis: App, Rede, Estabelecimento, Cliente, Pessoa
Ações (parâmetro acao):
| Ação | O que faz |
|---|---|
list |
Cartões ativos do cedente (padrão). |
get |
Um cartão por id_cob_cartao ou card_token. |
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_cob_cedente |
integer | sim | Cedente. |
acao |
string | não | list (padrão) ou get. |
id_cob_cartao |
integer | não | acao=get: id do cartão (ou use card_token). |
card_token |
string | não | acao=get: token do cartão (ou use id_cob_cartao). |
curl -s -X GET "$BASE/v1/terceiro/cartao?$AUTH&id_cob_cedente=25"
Resposta:
{
"status": "ok",
"cartoes": [
{
"id_cob_cartao": 300,
"id_cob_cedente": 25,
"card_token": "0123456789abcdef0123456789abcdef",
"card_numero": "4111 **** **** 1111",
"card_bandeira": "VISA",
"card_nome_titular": "CLIENTE EXEMPLO",
"card_cpf_cnpj_titular": "12345678909",
"card_mes_vencimento": "12",
"card_ano_vencimento": "2030",
"card_cep_cobranca": "80000000",
"card_apelido": "CARTAO EMPRESA",
"pag_nome_razao_social": "CLIENTE EXEMPLO DA SILVA",
"pag_cpf_cnpj": "12345678909",
"pag_cep": "80000000",
"pag_numero": 100,
"pag_complemento": "",
"pag_bairro": "CENTRO",
"pag_localidade": "CURITIBA",
"pag_estado": "PR",
"pag_telefone": "",
"pag_celular": "41999990000",
"pag_email": "cliente@exemplo.com.br",
"data_hora_criacao": "2026-11-12T10:00:00"
}
]
}
Erros específicos: 400 — {"errors":{"validation":{"id_cob_cedente":["Cedente inválido"]}}}.; 400 — {"errors":{"validation":{"id_cob_cartao":["Cartão não encontrado"]}}}.; 400 — {"errors":{"validation":{"acao":["Ação inválida"]}}}..
/v1/terceiro/cartaoCadastra um cartão
Corpo JSON.
Perfis: App, Rede, Estabelecimento, Cliente, Pessoa
Corpo (JSON objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_cob_cedente |
integer | sim | Cedente dono do cartão (o do acesso). |
pag_nome_razao_social |
string | sim | Nome do pagador. |
pag_cpf_cnpj |
string | sim | CPF/CNPJ do pagador, só números. |
pag_cep |
string | sim | CEP, 8 dígitos. |
pag_logradouro |
string | sim | Logradouro. |
pag_numero |
integer | não | Número. Obrigatório o número OU o complemento. |
pag_complemento |
string | não | Complemento. |
pag_bairro |
string | sim | Bairro. |
pag_localidade |
string | sim | Cidade. |
pag_estado |
string | sim | UF. |
pag_telefone |
string | não | Telefone fixo com DDD (validado quando informado). |
pag_celular |
string | sim | Celular com DDD. |
pag_email |
string | sim | E-mail. |
card_numero |
string | sim | Número do cartão (só os dígitos são usados). |
card_cvv |
string | sim | Código de segurança. |
card_mes_vencimento |
string | sim | Mês, 2 dígitos. |
card_ano_vencimento |
string | sim | Ano, 4 dígitos. |
card_nome_titular |
string | sim | Nome impresso no cartão. |
card_cpf_cnpj_titular |
string | sim | CPF/CNPJ do titular. |
card_cep_cobranca |
string | não | CEP de cobrança do cartão (validado quando informado). |
card_apelido |
string | não | Apelido para identificar o cartão. |
curl -s -X POST "$BASE/v1/terceiro/cartao?$AUTH" \
-H 'Content-Type: application/json' \
-d '{"id_cob_cedente": 25, "pag_nome_razao_social": "CLIENTE EXEMPLO DA SILVA", "pag_cpf_cnpj": "12345678909", "pag_cep": "80000000", "pag_logradouro": "RUA EXEMPLO", "pag_numero": 100, "pag_bairro": "CENTRO", "pag_localidade": "CURITIBA", "pag_estado": "PR", "pag_celular": "41999990000", "pag_email": "cliente@exemplo.com.br", "card_numero": "4111111111111111", "card_cvv": "123", "card_mes_vencimento": "12", "card_ano_vencimento": "2030", "card_nome_titular": "CLIENTE EXEMPLO", "card_cpf_cnpj_titular": "12345678909", "card_apelido": "CARTAO EMPRESA"}'
Resposta:
{
"status": "ok",
"id_cob_cartao": 300,
"id_cob_cedente": 25,
"card_token": "0123456789abcdef0123456789abcdef",
"card_numero": "4111 **** **** 1111",
"card_bandeira": "VISA",
"card_nome_titular": "CLIENTE EXEMPLO",
"card_cpf_cnpj_titular": "12345678909",
"card_mes_vencimento": "12",
"card_ano_vencimento": "2030",
"card_cep_cobranca": "80000000",
"card_apelido": "CARTAO EMPRESA",
"pag_nome_razao_social": "CLIENTE EXEMPLO DA SILVA",
"pag_cpf_cnpj": "12345678909",
"pag_cep": "80000000",
"pag_numero": 100,
"pag_complemento": "",
"pag_bairro": "CENTRO",
"pag_localidade": "CURITIBA",
"pag_estado": "PR",
"pag_telefone": "",
"pag_celular": "41999990000",
"pag_email": "cliente@exemplo.com.br",
"data_hora_criacao": "2026-11-12T10:00:00"
}
Erros específicos: 400 — {"errors":{"validation":{"body":["Corpo da requisição inválido"]}}}: corpo vazio ou não JSON.; 400 — {"errors":{"validation":{"id_cob_cedente":["Cedente inválido"]}}}: cedente inexistente, inativo ou fora do escopo.; 400 — {"errors":{"validation":{"card_numero":["Não pode ficar sem valor"], "pag_cep":["Valor não preenchido ou inválido"], "endereco":["O número ou o complemento do pagador devem ser preenchidos obrigatoriamente."]}}}..
/v1/terceiro/cartaoAltera titular e apelido de um cartão
Só titular, CPF/CNPJ do titular e apelido mudam; os campos não enviados ficam vazios. O ZP desativa o registro antigo e cria outro com o mesmo card_token: o id_cob_cartao muda (use o da resposta).
Perfis: App, Rede, Estabelecimento, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_cob_cartao |
integer | não | Cartão (ou use card_token). |
card_token |
string | não | Token do cartão (ou use id_cob_cartao). |
Corpo (JSON objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
card_nome_titular |
string | sim | Nome do titular (sem ele a gravação é recusada). |
card_cpf_cnpj_titular |
string | sim | CPF/CNPJ do titular (validado). |
card_apelido |
string | não | Apelido; ausente = fica vazio. |
curl -s -X PUT "$BASE/v1/terceiro/cartao?$AUTH" \
-H 'Content-Type: application/json' \
-d '{"card_nome_titular": "CLIENTE EXEMPLO", "card_cpf_cnpj_titular": "12345678909", "card_apelido": "CARTAO NOVO"}'
Resposta:
{
"status": "ok",
"id_cob_cartao": 300,
"id_cob_cedente": 25,
"card_token": "0123456789abcdef0123456789abcdef",
"card_numero": "4111 **** **** 1111",
"card_bandeira": "VISA",
"card_nome_titular": "CLIENTE EXEMPLO",
"card_cpf_cnpj_titular": "12345678909",
"card_mes_vencimento": "12",
"card_ano_vencimento": "2030",
"card_cep_cobranca": "80000000",
"card_apelido": "CARTAO EMPRESA",
"pag_nome_razao_social": "CLIENTE EXEMPLO DA SILVA",
"pag_cpf_cnpj": "12345678909",
"pag_cep": "80000000",
"pag_numero": 100,
"pag_complemento": "",
"pag_bairro": "CENTRO",
"pag_localidade": "CURITIBA",
"pag_estado": "PR",
"pag_telefone": "",
"pag_celular": "41999990000",
"pag_email": "cliente@exemplo.com.br",
"data_hora_criacao": "2026-11-12T10:00:00"
}
Erros específicos: 400 — {"errors":{"validation":{"body":["Corpo da requisição inválido"]}}}.; 400 — {"errors":{"validation":{"id_cob_cartao":["Cartão não encontrado"]}}}.; 400 — {"errors":{"validation":{"cartao":["Erro ao atualizar cartão: "]}}}..
/v1/terceiro/cartaoDesativa um cartão
Desativa (ativo = N); o cartão deixa de aparecer e o token deixa de valer para novas cobranças.
Perfis: App, Rede, Estabelecimento, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_cob_cartao |
integer | não | Cartão (ou use card_token). |
card_token |
string | não | Token do cartão (ou use id_cob_cartao). |
curl -s -X DELETE "$BASE/v1/terceiro/cartao?$AUTH"
Resposta:
{
"status": "ok"
}
Erros específicos: 400 — {"errors":{"validation":{"id_cob_cartao":["Cartão não encontrado"]}}}.; 400 — {"errors":{"validation":{"cartao":["Erro ao excluir cartão: "]}}}..