Nessa seção, será apresentado o procedimento para tokenização do cartão para reutilização do token nas cobranças.
Endpoint
/v1/terceiro/cartao
Método
POST
Parâmetros
| Campo | Descrição | Tipo |
|---|---|---|
| APP (obrigatório) | Nome do App | text |
| CNPJ (obrigatório) | CNPJ do estabelecimento | text |
| SENHA (obrigatório) | Senha do dia | text |
Body
{
"id_cob_cedente": 3,
"pag_nome_razao_social": "JOAO DA SILVA",
"pag_cpf_cnpj": "11111111111",
"pag_cep": "11111111",
"pag_numero": 999,
"pag_complemento": "Complemento",
"pag_bairro": "Bairro",
"pag_localidade": "Cidade",
"pag_logradouro": "Logradouro",
"pag_estado": "XX",
"pag_telefone": "9999999999",
"pag_celular": "99999999999",
"pag_email": "teste@email.com.br",
"card_numero": "111111111111111",
"card_cvv": "111",
"card_mes_vencimento": "11",
"card_ano_vencimento": "1111",
"card_nome_titular": "JOAO DA SILVA",
"card_cpf_cnpj_titular": "11111111111",
"card_cep_cobranca": "11111111",
"card_apelido": "CARTAO TESTE"
}Exemplo de retorno (json)
{
}Método
GET
Parâmetros
| Campo | Descrição | Tipo | Observação |
|---|---|---|---|
| APP (Obrigatório) | Nome do App | text | |
| CNPJ (Obrigatório) | CNPJ do estabelecimento | text | |
| SENHA (Obrigatório) | Senha do dia | text | |
| acao (Obrigatório) | Código da ação a ser executada | text | Há duas opções de preenchimento: “get” ou “list” |
| id_cob_cedente (Obrigatório) | Identificador do cedente | int | |
| card_token | Token do cartão | text | Somente é obrigatório caso o parâmetro acao seja "get" |
Exemplo de retorno (json)
{
}O método de alteração do cartão somente permite alterar o nome do titular, o documento do titular e o apelido do cartão.
Método
PUT
Parâmetros
| Campo | Descrição | Tipo |
|---|---|---|
| APP (Obrigatório) | Nome do App | text |
| CNPJ (Obrigatório) | CNPJ do estabelecimento | text |
| SENHA (Obrigatório) | Senha do dia | text |
| card_token | Token do cartão | text |
Body
{
"card_nome_titular": "João da Silva",
"card_cpf_cnpj_titular": "123",
"card_apelido": "CARTAO FALHA"
}Exemplo de retorno (json)
{
}Método
DELETE
Parâmetros
| Campo | Descrição | Tipo |
|---|---|---|
| APP (Obrigatório) | Nome do App | text |
| CNPJ (Obrigatório) | CNPJ do estabelecimento | text |
| SENHA (Obrigatório) | Senha do dia | text |
| card_token (Obrigatório) | Token do cartão | text |
Exemplo de retorno (json)
{
}*Descrever mais…
Solicitação de pagamento. (Um convênio pode ter várias cobranças).
Situações da Cobrança
| Situação | Descrição | Natureza | Relacionamento |
|---|---|---|---|
| NW | Nova Cobrança | Transiente | RG, CS, FR |
| RG | Registrado | Transiente | FC, PG |
| FR | Falha ao registrar | Transiente | FC |
| PG | Pago | Transiente quando cartão, caso contrário definitivo | FC |
| FC | Fila de cancelamento | Transiente | CR, ES |
| CS | Cancelado sem registro | Definitivo | |
| CR | Cancelado com registro | Definitivo | |
| ES | Estornado | Definitivo |
Endpoint
/v1/terceiro/cobranca
Método
POST
Parâmetros
| Campo | Descrição | Tipo |
|---|---|---|
| APP (Obrigatório) | Nome do App | text |
| CNPJ (Obrigatório) | CNPJ do estabelecimento | text |
| SENHA (Obrigatório) | Senha do dia | text |
Explicação do body
| Campo | Descrição | Tipo | Observação |
|---|---|---|---|
id_cob_convenio |
Código do Convênio | int | |
tipo |
Tipo da cobrança: PIX, CARTAO, BOLETO | text | |
documento_data |
Data de criação do documento | date | |
documento_valor |
Valor da cobrança | numeric | |
documento_vencimento |
Data de vencimento da cobrança | date | |
card_token |
Token do cartão a ser cobrado | text | Somente quando o tipo é CARTAO |
codigo_cobranca |
Identificador da cobrança provido pelo cliente | text | Campo livre |
sacado |
Pagador da cobrança | object | |
sacado→nome_razao_social |
Nome do pagador | text | |
sacado→cpf_cnpj |
CPF/CNPJ do pagador | text | |
sacado→email |
Email do pagador | text | |
sacado→telefone |
Telefone do pagador | text | Campo Opcional |
sacado→celular |
Celular do pagador | text | |
sacado→cep |
CEP do pagador | text | |
sacado→logradouro |
Logradouro do pagador | text | |
sacado→localidade |
Cidade do pagador | text | |
sacado→bairro |
Bairro do pagador | text | |
sacado→numero |
Número do endereço do pagador | int | Número ou complemento |
sacado→complemento |
Complemento do endereço do pagador | text | Número ou complemento |
sacado→estado |
Estado do pagador | text | |
avalista |
Responsável por pagar o título caso o sacado não o faça | object | Opcional |
avalista→nome_razao_social |
Nome do avalista | text | |
avalista→cpf_cnpj |
CPF/CNPJ do avalista | text | |
avalista→email |
Email do avalista | text | |
avalista→telefone |
Telefone do avalista | text | Campo Opcional |
avalista→celular |
Celular do avalista | text | |
avalista→cep |
CEP do avalista | text | |
avalista→logradouro |
Logradouro do avalista | text | |
avalista→localidade |
Cidade do avalista | text | |
avalista→bairro |
Bairro do avalista | text | |
avalista→numero |
Número do endereço do avalista | int | Número ou complemento |
avalista→complemento |
Complemento do endereço do avalista | text | Número ou complemento |
avalista→estado |
Estado do avalista | text | |
data_desconto1 |
Data do primeiro desconto | date | Somente quando o tipo é BOLETO |
perc_desconto1 |
Percentual do primeiro desconto | numeric | Somente quando o tipo é BOLETO |
data_desconto2 |
Data do segundo desconto | date | Somente quando o tipo é BOLETO |
perc_desconto2 |
Percentual do segundo desconto | numeric | Somente quando o tipo é BOLETO |
data_desconto3 |
Data do terceiro desconto | date | Somente quando o tipo é BOLETO |
perc_desconto3 |
Percentual do terceiro desconto | numeric | Somente quando o tipo é BOLETO |
perc_juros_dia |
Percentual de juros cobrados ao dia após o vencimento do documento | numeric | Somente quando o tipo é BOLETO |
perc_multa |
Percentual de multa cobrada após o vencimento do documento | numeric | Somente quando o tipo é BOLETO |
documento_especie |
Espécie do documento (Ex: DM, 01) | text | Somente quando o tipo é BOLETO |
documento_numero |
Número do documento | text | Somente quando o tipo é BOLETO |
instrucoes |
Instruções para cobrança do documento (Ex: Pagar na Agência X) | text | Somente quando o tipo é BOLETO |
prazo_baixa |
Prazo em dias para o documento ser baixado automaticamente após o vencimento | int | Somente quando o tipo é BOLETO |
prazo_protesto |
Prazo em dias para o documento entrar em protesto automaticamente após o vencimento | int | Somente quando o tipo é BOLETO |
incluir_pix_boleto |
Parâmetro que indica se deve incluir QR CODE do PIX no documento | boolean | Somente quando o tipo é BOLETO |
Body
{
"id_cob_convenio": 6,
"tipo": "PIX",
"documento_data": "1111-11-11",
"documento_valor": 0.01,
"documento_vencimento": "1111-11-11",
"card_token": "dc17bd697082395c632f2f2735eefa19",
"codigo_cobranca": "cod_cob_1",
"sacado": {
"estado": "XX",
"telefone": "9999999999",
"numero": 1,
"logradouro": "Logradouro",
"bairro": "Bairro",
"localidade": "Cidade",
"celular": "99999999999",
"nome_razao_social": "SACADO DAS NEVES",
"cpf_cnpj": "99999999999",
"email": "teste@email.com",
"cep": "99999999"
},
"avalista": {
"estado": "XX",
"telefone": "9999999999",
"numero": 1,
"logradouro": "Logradouro",
"bairro": "Bairro",
"localidade": "Cidade",
"celular": "99999999999",
"nome_razao_social": "AVALISTA DAS NEVES",
"cpf_cnpj": "99999999999",
"email": "teste@email.com",
"cep": "99999999"
}
,
"data_desconto1": "1111-11-11",
"perc_desconto1": 10.5,
"data_desconto2": "1111-11-11",
"perc_desconto2": 9.5,
"data_desconto3": "1111-11-11",
"perc_desconto3": 8.5,
"perc_juros_dia": 0.5,
"perc_multa": 10,
"documento_especie": "01",
"documento_numero": 101010,
"instrucoes": "Instruções para pagamento",
"prazo_baixa": 1,
"prazo_protesto": 1,
"incluir_pix_boleto": "N"
}Exemplo de retorno (json)
{
}Método
GET
Parâmetros
| Campo | Descrição | Tipo | Observação |
|---|---|---|---|
| APP (Obrigatório) | Nome do App | text | |
| CNPJ (Obrigatório) | CNPJ do estabelecimento | text | |
| SENHA (Obrigatório) | Senha do dia | text | |
| id_cob_convenio (Obrigatório) | Identificador do convênio | int | |
| acao (Obrigatório) | Código da ação a ser executada | text | Há duas opções de preenchimento: “get” ou “list” |
| id_cob_cobranca | Identificador da cobrança | int | Somente é obrigatório quando o parâmetro acao é "get" |
| data_inicial | Data inicial para filtro | date | Somente é obrigatório quando o parâmetro acao é “list” |
| data_final | Data final para filtro | date | Somente é obrigatório quando o parâmetro acao é “list” |
Exemplo de retorno (json)
{
}Quando a cobrança estiver na situação NW ou RG, a cobrança é cancelada. Se a cobrança for do tipo Cartão e estiver paga, será feito o estorno da cobrança, se aplicável.
Método
DELETE
Parâmetros
| Campo | Descrição | Tipo |
|---|---|---|
| APP (Obrigatório) | Nome do App | text |
| CNPJ (Obrigatório) | CNPJ do estabelecimento | text |
| SENHA (Obrigatório) | Senha do dia | text |
| id_cob_cobranca (Obrigatório) | Identificador da cobrança | int |
Exemplo de retorno (json)
{
}Caso ainda tenha dúvidas ou necessite de informações adicionais, ou ainda tenha encontrado algum erro ou deseje propor alguma mudança ou melhoria, entre em contato com nosso suporte através do e-mail suporte@txfuel.com.br ou pelo WhatsApp (41) 9 9701-1807.