post https://sandbox.sistematize.me:8443/api/v1/assinatura
Log in to see full request history
| time | status | user agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Assinatura é um contrato de cobrança recorrente, nosso sistema permite duas formas de assinatura, a primeira com recorrência indeterminada onde sempre será cobrada até que seja cancelada e a segunda com prazo definido pelo parâmetro_cobranca onde recebe a quantidade de renovações que esta assinatura deve passar .
Método de pagamento: Em assinatura é permitido o método de boleto e cartão que são representados pelo enum CARTAO, BOLETO, em caso de boleto a assinatura ficará com status pendente até receber uma confirmação de pagamento. Caso seja informado o cartão em método, deverá obrigatoriamente informar os dados do cartão.
Plano de assinatura: Esta informação representa para a assinatura o valor do plano e os itens que o compõe. Utilize o Dashboard ou as rotas de plano de assinatura para criar.
Dia de vencimento: Esta informação representa a data da renovação da assinatura, a primeira cobrança ocorrerá no valor integral do plano informado.
Importante :
Ao alterar o valor do plano, as assinaturas que estão vinculadas a este plano serão ajustadas automaticamente em suas próximas cobranças.
Criando assinatura com cartão:
POST: END_POINT/assinatura
{
"forma_pagamento":"CARTAO",
"quantidade_cobranca":0,
"juros_atraso_boleto":0,
"multa_atraso_boleto":0,
"empresa":{
"id":"56f7bbb3-bf5d-43df-a39c-604acfaa8f35"
},
"titular":{
"id":"a0ce0374-7601-4c73-b994-0152d9cb4aef"
},
"plano":{
"id":503,
"empresa_id":"56f7bbb3-bf5d-43df-a39c-604acfaa8f35",
"status":"ATIVO",
"descricao":"plano dos parceiros",
"disponivel_ecommerce":true,
"dias_validade":30,
"itens":[
{
"quantidade":12,
"produto":{
"id":"f7924179-4148-4218-803f-69ef5e55b29d",
"status":"ATIVO",
"empresa_id":"56f7bbb3-bf5d-43df-a39c-604acfaa8f35",
"categoria":{
"id":"12fbdccf-1335-4da2-8eb0-bbabbcefe1c4",
"empresa_id":"56f7bbb3-bf5d-43df-a39c-604acfaa8f35",
"nome":"Cerveja",
"foto_url":"https://sandbox.sistematize.me:8443/api/v1/public/categoria/12fbdccf-1335-4da2-8eb0-bbabbcefe1c4/imagem/7303e7f8-97d3-4212-8fd7-31aaf4ff795b.jpg",
"destaque":false,
"prioridade":98,
"data_criacao":"2024-08-30T18:45:51",
"data_atualizacao":"2024-08-30T18:50:44"
},
"nome":"Original",
"descricao":"350 ml",
"codigo_barras":"7891991009706",
"valor":7,
"foto_url":"https://sandbox.sistematize.me:8443/api/v1/public/produto/f7924179-4148-4218-803f-69ef5e55b29d/imagem/e32757ab-6b02-4f10-8cd5-b3da71178a86.jpg",
"conteudo":0,
"profundidade":0,
"largura":0,
"altura":0,
"peso_bruto":0,
"peso_liquido":0,
"preco_custo":0,
"margem_sobre_custo":0,
"unidade_medida":"UN",
"aliquota_icms":0,
"aliquota_pis":0,
"aliquota_cofins":0,
"balanca":false,
"disponivel_totem":false,
"disponivel_ecommerce":false,
"nivel_minimo":5,
"data_criacao":"2024-08-30T18:52:24",
"data_atualizacao":"2024-11-14T20:54:25"
},
"desconto":14,
"valor":7,
"executado":false,
"total":70,
"valorLiquido":70
}
],
"valorTotal":70,
"valorPorDia":2.33
},
"splits":[
],
"observacoes":"",
"emitir_nfse":true
}
Retorno:
{
"id": int,
"empresa": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"titular": {
"id": "String",
"tipo": "String",
"nome": "String",
"cpf": "String",
"e-mail": "String",
"telefone_celular": "String",
"cep": "String",
"endereco": "String",
"número": "String",
"bairro": "String",
"cidade": "String",
"uf": "String"
},
"plano": {
"id": int,
"status": "String",
"descricao": "String",
"valor": double
},
"status": "String",
"metodo": "String",
"data_cadastro": "String",
"data_atualizada": "String",
"data_validade": "String",
"dia_vencimento": int,
"cartão": {
"id": "String",
"holder_name": "String",
"primeiros_dígitos": "String",
"últimos_dígitos": "String",
"expira": "String",
"marca": "String"
},
"ultima_cobranca": {
"id": int,
"empresa": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"cliente": {
"id": "String",
"tipo": "String",
"nome": "String",
"cpf": "String",
"e-mail": "String",
"telefone_celular": "String",
"cep": "String",
"endereco": "String",
"número": "String",
"bairro": "String",
"cidade": "String",
"uf": "String"
},
"data_criacao": "String",
"data_atualização": "String",
"status": "String",
"tipo": "String",
"origem": "String",
"valor": double,
"valor_líquido": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"parcelas": int,
"card_holder_name": "String",
"card_first_digits": "String",
"cartão_últimos_dígitos": "String",
"card_expires": "String",
"card_brand": "String",
"nsu": "String",
"nsu_terminal": "String",
"numero_terminal": "String",
"pdv_adquirente": "String",
"pagamentos": [
{
"id": "String",
"status": "String",
"recebedor": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String"
},
"data_compensacao_original": "String",
"data_compensacao": "String",
"valor": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"valor_líquido": double,
"parcela": int
},
{
"id": "String",
"status": "String",
"recebedor": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String"
},
"data_compensacao_original": "String",
"data_compensacao": "String",
"valor": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"valor_líquido": double,
"parcela": int
},
{
"id": "String",
"status": "String",
"recebedor": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"data_compensacao_original": "String",
"data_compensacao": "String",
"valor": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"valor_líquido": double,
"parcela": int
}
]
}
}
Para assinar o boleto utilize a mesma rota:
Importante:
O boleto gerado terá 7 dias corridos para pagamento, até que seja pago a assinatura fique com o status PENDENTE .
{
"dia_vencimento":int,
"metodo":"String",
"empresa":{"id":"String"},
"titular":{"id": "String"},
"plano":{"id":int}
}
Retorno:
{
"id": int,
"empresa": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"titular": {
"id": "String",
"tipo": "String",
"nome": "String",
"cpf": "String",
"e-mail": "String",
"telefone_celular": "String",
"cep": "String",
"endereco": "String",
"número": "String",
"bairro": "String",
"cidade": "String",
"uf": "String"
},
"plano": {
"id": int,
"status": "String",
"descricao": "String",
"valor": double
},
"status": "String",
"metodo": "String",
"data_cadastro": "String",
"data_atualizada": "String",
"data_validade": "String",
"dia_vencimento": int,
"ultima_cobranca": {
"id": int,
"empresa": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"cliente": {
"id": "String",
"tipo": "String",
"nome": "String",
"cpf": "String",
"e-mail": "String",
"telefone_celular": "String",
"cep": "String",
"endereco": "String",
"número": "String",
"bairro": "String",
"cidade": "String",
"uf": "String"
},
"data_criacao": "String",
"data_atualização": "String",
"status": "String",
"tipo": "String",
"origem": "String",
"valor": double,
"valor_líquido": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"parcelas": 1,
"vencimento_boleto": "String",
"url_boleto": "String",
"nsu": "String",
"nsu_terminal": "String",
"numero_terminal": "String",
"pdv_adquirente": "String",
"pagamentos": [
{
"id": "String",
"status": "String",
"recebedor": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"data_compensacao_original": "String",
"data_compensacao": "String",
"valor": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"valor_líquido": double,
"parcela": int
}
]
}
}
Responses