post https://sandbox.sistematize.me:8443/api/v1/assinatura
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
{
"dia_vencimento":int,
"metodo":"String",
"empresa":{"id":"String"},
"titular":{"id": "String"},
"plano":{"id":int},
"cartão":{
"número":"String",
"holder_name":"String",
"expira":"String",
"cvv":"String"
},
"dividir":[
{
"recebedor":{"id": "UUID"},
"metodo":"String",
"paga_taxa_transacao":boolean,
"paga_resto_divisao_taxa":boolean,
"valor":int
},{
"recebedor":{"id": "UUID"},
"metodo":"String",
"paga_taxa_transacao":boolean,
"valor":int
},{
"recebedor":{"id": "UUID"},
"metodo":"String",
"valor":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,
"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
}
]
}
}