Introdução sobre a funcionalidade de Assinaturas (Recorrência) na API Efí
Introdução
Realize cobranças recorrentes aos seus clientes por meio de planos de assinaturas. Com essa opção, seus clientes autorizam os débitos e você não precisa se preocupar em enviar cobranças a cada mês, evitando o risco de esquecimentos de pagamento.
Uma assinatura é um conjunto de transações geradas de forma recorrente. Para criar uma assinatura, você deve gerar uma cobrança e incluir informações sobre o número de parcelas e a periodicidade em que o sistema deve gerar transações iguais à primeira. Essas informações são chamadas de Planos de Assinaturas.
Uma assinatura é caracterizada pela cobrança recorrente, podendo ser realizada por boleto ou cartão:
Cartão de Crédito: seu cliente irá informar os dados de pagamento e a cobrança será debitada de acordo com a configuração do plano. O valor será descontado até que todas as parcelas sejam pagas ou até que a assinatura seja cancelada por você ou pelo cliente. Para calcular os limites do cartão, consideramos o valor mensal, não o total da cobrança com todas as parcelas.
Boleto Bancário: seu cliente receberá a cobrança por e-mail 10 dias antes do vencimento até que termine a quantidade de parcelas solicitadas ou até que você ou seu cliente cancele a assinatura. Se a cobrança automática cair num fim de semana ou feriado, nosso sistema vai gerar, automaticamente, uma cobrança com data de vencimento para o próximo dia útil.
Para criar uma assinatura, siga esses três passos:
Crie o plano de assinatura, definindo a periodicidade e quantas cobranças serão geradas;
Crie inscrições (assinaturas) para vincular ao plano em One Step ou Two Steps;
Defina a forma de pagamento da assinatura e insira os dados do cliente.
Como funciona
Uma assinatura é criada com status new indicando que está pronta para ser ativada. Assim que a forma de pagamento é definida, o status muda para active, mostrando que a assinatura está ativa e pronta para gerar cobranças recorrentes.
A assinatura permanecerá ativa durante todo o ciclo de geração de cobranças, mas pode deixar de ser ativa por três motivos:
A pessoa pagadora cancelou o serviço, clicando no link de cancelamento presente no e-mail de confirmação de assinatura. Assim, o status é alterado para canceled;
O vendedor cancelou o serviço, clicando no link de cancelamento presente em sua interface de recebimentos, ou por meio do webservice de cancelamento através do endpoint /subscription/cancel ou função cancelSubscription da SDK. Assim, o status é alterado para canceled;
Todas as cobranças já foram geradas. Assim, o status é alterado para expired, ou seja, a assinatura está expirada e todas as cobranças configuradas para a assinatura já foram emitidas.
Para acompanhar a assinatura, é importante observar os status das transações geradas. Se uma transação não puder ser confirmada como paga, o status será unpaid, , indicando que o pagamento não foi concluído. Nesse caso, o vendedor deve tomar ações apropriadas, como interromper o serviço, tentar cobrar de outra forma ou cancelar a assinatura.
As duas formas de pagamento disponíveis são: boleto e cartão. Com o boleto, o cliente recebe o boleto com base nas repetições definidas no plano, e ele pode ser enviado por e-mail. Com o cartão, a cobrança é debitada automaticamente do cartão do cliente, seguindo as repetições do plano.
Tanto a pessoa que fez a assinatura quanto o vendedor podem cancelar a assinatura a qualquer momento. Quando isso ocorre, ambos são avisados via e-mail, com todos os detalhes do cancelamento.
Crie o plano de assinatura
Inicialmente, será criado o plano de assinatura, sendo definido três informações pelo integrador:
- name - Nome do plano de assinatura;
- interval (em meses) - Periodicidade da cobrança (por exemplo,
1 para mensal); - repeats - Quantas cobranças devem ser geradas para esse plano.
Para criar um plano de assinatura, você deve enviar uma requisição POST para a rota /plan.
POST /v1/plan
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"name": "Plano de Internet - Velocidade 10 Mb",
"interval": 1,
"repeats": 12
}
A resposta abaixo representa Sucesso do consumo.
{
"code": 200,
"data": {
"plan_id": numero_plan_id,
"name": "Plano de Internet - Velocidade 10 Mb",
"interval": 12,
"repeats": null,
"created_at": "2016-06-28 15:48:32"
}
}
Retentativa de pagamento de assinatura via cartão de crédito
Os pagamentos das assinaturas realizados via cartão de crédito, que forem recusados por algum motivo operacional, como falta de limite, dados incorretos e problemas temporários com o cartão, poderão ter uma nova tentativa de pagamento via API.
Dessa forma, não será necessário realizar todo o processo de emissão da cobrança novamente, tornando o fluxo mais rápido e eficiente.
POST /v1/charge/:id/retry
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"payment": {
"credit_card": {
"customer": {
"name": "Gorbadoc Oldbuck",
"cpf": "94271564656",
"email": "email_do_cliente@servidor.com.br",
"birth": "1990-08-29",
"phone_number": "5144916523"
},
"billing_address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
},
"payment_token": "75bfce47d230b550f7eaac2a932e0878a934cb3",
"update_card": true
}
}
}
As respostas abaixo representam Sucesso do consumo.
{
"code": 200,
"data": {
"installments": 1,
"installment_value": 8900,
"charge_id": numero_charge_id,
"status": "waiting",
"total": 8900,
"payment": "credit_card"
}
}
InformaçãoEsta funcionalidade permite que o integrador tente reprocessar uma cobrança de assinatura que falhou. Para isso, a cobrança deve atender aos seguintes critérios:
a cobrança deve ser do tipo cartão de créditoa cobrança deve ter o status unpaid
Assinatura Cancelada ou DesativadaCaso uma assinatura esteja cancelada ou desativada, e uma nova tentativa de pagamento for realizada com sucesso na última cobrança pendente, a assinatura será automaticamente reativada.
Você pode buscar informações sobre os planos criados. Existem filtros avançados que podem ser usados para encontrar planos, como:
Name: retorna resultados a partir da procura pelo nome do plano cadastrado previamente;Limit: limite máximo de registros de resposta;Offset: determina a partir de qual registro a busca será realizada.
GET /v1/plans
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
Parâmetro de entrada: informe a "name", "limit" e "offset" do plano desejado
As respostas abaixo representam Sucesso(200) do consumo.
{
"code": 200,
"data": [
{
"plan_id": numero_plan_id,
"name": "Plano de Internet - Velocidade 1 Mb",
"interval": 1,
"repeats": null,
"created_at": "2016-05-02"
},
{
"plan_id": numero_plan_id,
"name": "Plano de Internet - Velocidade 10 Mb",
"interval": 12,
"repeats": null,
"created_at": "2016-06-28"
},
{
"plan_id": numero_plan_id,
"name": "Plano de Internet - Velocidade 20 Mb",
"interval": 10,
"repeats": null,
"created_at": "2016-06-29"
},
{
"plan_id": numero_plan_id,
"name": "Plano de Internet - Velocidade 30 Mb",
"interval": 12,
"repeats": null,
"created_at": "2016-06-29"
}
]
}
Permitir a edição do nome do plano de assinatura
Você pode editar o nome de um plano de assinatura que já foi criado. Para fazer isso, basta fornecer o identificador do plan_id do plano que deseja editar.
PUT /v1/plan/:id
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"name": "Meu novo nome do plano"
}
As respostas abaixo representam Sucesso(201) do consumo.
Cancelar um plano de assinatura
Você pode cancelar um plano de assinatura a qualquer momento. Para isso, basta informar o plan_id do plano que deseja cancelar.
DELETE/v1/plan/:id
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
Parâmetro de entrada: informe a "charge_id" da transação desejada
As respostas abaixo representam Sucesso(201) do consumo.
Crie inscrições (assinaturas) para vincular ao plano em One Step
Após criar o plano, é hora de criar as assinaturas e vinculá-las ao plano. As assinaturas são úteis quando você precisa cobrar seus clientes de forma recorrente. Com o plano configurado, os custos futuros serão criados automaticamente, seguindo a configuração do plano.
Lembre-se de informar o plan_id do plano que você criou anteriormente para fazer a associação.
Para criar e vincular as assinaturas, basta enviar uma requisição POST para a rota /plan/:id/subscription/one-step.
Atributo "trial_days" que permite conceder um período de teste A API oferece o atributo trial_days, que permite definir um período de teste gratuito para assinaturas do tipo cartão de crédito. Esse atributo está disponível somente quando o pagamento é realizado com credit_card.
Estrutura hierárquica dos atributos do Schema que podem ser utilizados:
- /v1/plan/:id/subscription/one-step
"items"
"name"
"value"
"amount"
"shippings"
"name"
"value"
"payee_code"
"metadata"
"custom_id"
"notification_url"
"payment"
"banking_billet"
"customer"
"name"
"cpf"
"email"
"phone_number"
"birth"
"address"
"street"
"number"
"neighborhood"
"zipcode"
"city"
"complement"
"state"
"juridical_person"
"corporate_name"
"cnpj"
"expire_at"
"discount"
"type"
"percentage"
"currency"
"value"
"conditional_discount"
"type"
"percentage",
"currency"
"value"
"until_date"
"configurations"
"fine"
"interest"
"message"
"credit_card"
"customer"
"name"
"cpf"
"email"
"phone_number"
"birth"
"address"
"street"
"number"
"neighborhood"
"zipcode"
"city"
"complement"
"state"
"juridical_person"
"corporate_name"
"cnpj"
"billing_address"
"street"
"number"
"neighborhood"
"zipcode"
"city"
"complement"
"state"
"payment_token"
"discount"
"type"
"percentage"
"currency"
"value"
"message"
"trial_days"
POST /v1/plan/:id/subscription/one-step
Atributos Nesta seção estão descritos os atributos para Assinatura do tipo Boleto (Objeto banking_billet) e Cartão de crédito (Objeto credit_card)
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
- Dados de entrada (Bolix)
- Dados de entrada (Cartão)
{
"items": [
{
"name": "Meu Produto",
"value": 5990,
"amount": 1
}
],
"payment": {
"banking_billet": {
"customer": {
"name": "Gorbadoc Oldbuck",
"cpf": "94271564656",
"email": "email_do_cliente@servidor.com.br",
"phone_number": "5144916523",
"address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
}
},
"expire_at": "2023-12-30",
"configurations": {
"fine": 200,
"interest": 33
},
"message": "Pague pelo código de barras ou pelo QR Code"
}
}
}
{
"items": [
{
"name": "Meu Produto",
"value": 5990,
"amount": 1
}
],
"payment": {
"credit_card": {
"customer": {
"name": "Gorbadoc Oldbuck",
"cpf": "94271564656",
"email": "email_do_cliente@servidor.com.br",
"birth": "1990-08-29",
"phone_number": "5144916523"
},
"payment_token": "",
"billing_address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
}
}
}
}
As respostas abaixo representam Sucesso do consumo.
- 🟢 200 (Bolix)
- 🟢 200 (Cartão)
{
"code": 200,
"data": {
"subscription_id": 25329,
"status": "active",
"barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000",
"link": "link_do_boleto_da_assinatura",
"billet_link":"link_https_para_acesso_o_bolix",
"pdf": {
"charge": "link_pdf_boleto_assinatura"
},
"expire_at": "2018-12-30",
"plan": {
"id": 2758,
"interval": 1,
"repeats": null
},
"charge": {
"id": 511843,
"status": "waiting",
"parcel": 1,
"total": 7900
},
"first_execution": "31/10/2018",
"total": 7900,
"payment": "banking_billet"
}
}
{
"code": 200,
"data": {
"subscription_id": 25328,
"status": "active",
"plan": {
"id": 2758,
"interval": 1,
"repeats": null
},
"charge": {
"id": 511842,
"status": "waiting",
"parcel": 1,
"total": 7900
},
"first_execution": "31/10/2018",
"total": 7900,
"payment": "credit_card"
}
}
Crie inscrições (assinaturas) para vincular ao plano em Two Steps
Primeiramente, é necessário criar a assinatura e vinculá-la ao plano. Você deve informar o item/produto/serviço, valor e quantidade para criar a assinatura. Em seguida, defina a forma de pagamento da assinatura e os dados do cliente, informando o charge_id da transação e os dados do cliente.
1. Crie inscrições (assinaturas) para vincular ao plano
Com o plano criado, é hora de criar as assinaturas e associá-las aos planos. As assinaturas são úteis quando você precisa cobrar seus clientes de forma recorrente. Dessa forma, os custos subsequentes serão criados automaticamente, seguindo a configuração do plano.
Lembre-se de informar o plan_iddo plano que você criou anteriormente para fazer a associação.
Para associar assinaturas aos planos, basta enviar uma requisição POST para a rota /plan/:id/subscription.
Estrutura hierárquica dos atributos do Schema que podem ser utilizados:
- /v1/plan/:id/subscription
"items"
"name"
"value"
"amount"
"shippings"
"name"
"value"
"payee_code"
"metadata"
"custom_id"
"notification_url"
POST /v1/plan/:id/subscription
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"items": [
{
"name": "Internet - Mensalidade",
"value": 6990,
"amount": 1
}
]
}
As respostas abaixo representam Sucesso do consumo.
{
"code": 200,
"data": {
"subscription_id": numero_subscription_id,
"status": "new",
"custom_id": null,
"charges": [
{
"charge_id": numero_charge_id,
"status": "new",
"total": 6990,
"parcel": 1
}
],
"created_at": "2016-06-29 10:42:59"
}
}
Após criar o plano de assinatura e vincular as assinaturas aos planos, é hora de definir a forma de pagamento recorrente das assinaturas. Isso pode ser feito através de boleto bancário ou cartão de crédito.
- Cartão de Crédito: seu cliente realiza o pagamento, de acordo com a periodicidade que você definiu (mensal, trimestral, etc) no plano, sendo o mesmo valor cobrado automaticamente em seu cartão de crédito de seu cliente. Na recorrência por cartão, seu cliente digita os dados do cartão apenas no primeiro pagamento, depois a cobrança é realizada automaticamente sem que ele precise informar os dados novamente;
Assinatura do tipo Cartão de crédito Para gerar uma assinatura do tipo Cartão de crédito, é necessário antes de consumir o endpoint POST /v1/subscription/:id/pay, obter o payment_token. Você pode ver mais detalhes em Obtenção do payment_token.
- Boleto Bancário: será gerado conforme o número de repetições definido pelo plano, podendo ser enviado por e-mail.Tanto a pessoa que fez a assinatura quanto o vendedor podem cancelar a assinatura a qualquer momento. Quando isso ocorre, ambos são avisados via e-mail, com todos os detalhes do cancelamento.
Atributo "trial_days" que permite conceder um período de teste A API oferece o atributo trial_days, que permite definir um período de teste gratuito para assinaturas do tipo cartão de crédito. Esse atributo está disponível somente quando o pagamento é realizado com credit_card.
Para associar assinaturas à forma de pagamento, você deve enviar uma requisição POST para a rota /subscription/:id/pay.
Estrutura hierárquica dos atributos do Schema que podem ser utilizados:
"payment"
"banking_billet"
"customer"
"name"
"cpf"
"email"
"phone_number"
"birth"
"address"
"street"
"number"
"neighborhood"
"zipcode"
"city"
"complement"
"state"
"juridical_person"
"corporate_name"
"cnpj"
"expire_at"
"discount"
"type"
"percentage"
"currency"
"value"
"conditional_discount"
"type"
"percentage",
"currency"
"value"
"until_date"
"configurations"
"fine"
"interest"
"message"
"credit_card"
"customer"
"name"
"cpf"
"email"
"phone_number"
"birth"
"address"
"street"
"number"
"neighborhood"
"zipcode"
"city"
"complement"
"state"
"juridical_person"
"corporate_name"
"cnpj"
"billing_address"
"street"
"number"
"neighborhood"
"zipcode"
"city"
"complement"
"state"
"payment_token"
"discount"
"type"
"percentage"
"currency"
"value"
"message"
"trial_days"
POST /v1/subscription/:id/pay
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
- Dados de entrada (Bolix)
- Dados de entrada (Cartão)
{
"payment": {
"banking_billet": {
"customer": {
"name": "Gorbadoc Oldbuck",
"cpf": "94271564656",
"email": "email_do_cliente@servidor.com.br",
"phone_number": "5144916523",
"address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
}
},
"expire_at": "2023-12-30",
"configurations": {
"fine": 200,
"interest": 33
},
"message": "Pague pelo código de barras ou pelo QR Code"
}
}
}
{
"payment": {
"credit_card": {
"customer": {
"name": "Gorbadoc Oldbuck",
"cpf": "94271564656",
"email": "email_do_cliente@servidor.com.br",
"birth": "1990-08-29",
"phone_number": "5144916523"
},
"payment_token": "",
"billing_address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
}
}
}
}
As respostas abaixo representam Sucesso do consumo.
- 🟢 200 (Bolix)
- 🟢 200 (Cartão)
{
"code": 200,
"data": {
"subscription_id": 25329,
"status": "active",
"barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000",
"link": "link_do_boleto_da_assinatura",
"billet_link":"link_https_para_acesso_o_bolix",
"pdf": {
"charge": "link_pdf_boleto_assinatura"
},
"expire_at": "2018-12-30",
"plan": {
"id": 2758,
"interval": 1,
"repeats": null
},
"charge": {
"id": 511843,
"status": "waiting",
"parcel": 1,
"total": 7900
},
"first_execution": "31/10/2018",
"total": 7900,
"payment": "banking_billet"
}
}
{
"code": 200,
"data": {
"subscription_id": 25328,
"status": "active",
"plan": {
"id": 2758,
"interval": 1,
"repeats": null
},
"charge": {
"id": 511842,
"status": "waiting",
"parcel": 1,
"total": 7900
},
"first_execution": "31/10/2018",
"total": 7900,
"payment": "credit_card"
}
}
Essa funcionalidade permite obter informações de uma assinatura vinculada a um plano específico.
GET /v1/subscription/:id
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
Parâmetro de entrada: informe a "subscription_id" da transação desejada
As respostas abaixo representam Sucesso(200) do consumo.
{
"code": 200,
"data": {
"subscription_id": numero_subscription_id,
"value": 6990,
"status": "new",
"custom_id": null,
"notification_url": null,
"payment_method": null,
"next_execution": null,
"next_expire_at": null,
"plan": {
"plan_id": numero_plan_id,
"name": "Plano de Internet - Velocidade 10 Mb",
"interval": 12,
"repeats": null
},
"occurrences": 0,
"created_at": "2016-06-29 10:42:59",
"history": [
{
"charge_id": numero_charge_id,
"status": "new",
"created_at": "2016-06-29 10:42:59"
}
]
}
}
Retornar lista de cobranças
Para retornar informações de cobranças emitidas em uma aplicação (como as cobranças de uma assinatura, por exemplo), você deve enviar uma requisição GET para a rota /v1/charges.
Este endpoint possui filtros para afunilar os resultados da busca, tais como CPF/CNPJ e status. Dentre todos os filtros disponíveis, os filtros charge_type, begin_date e end_date são obrigatórios e representam o tipo da transação e o intervalo de datas em que as cobranças consultadas devem estar compreendidas. Apenas assinaturas do tipo boleto serão retornadas.
Importante!Atualmente este recurso está em versão beta. Estamos entusiasmados em compartilhar essa ferramenta com você, porém, é essencial lembrar que ela está em desenvolvimento ativo e pode passar por alterações durante este período.
Valorizamos profundamente seu feedback durante esta fase e queremos ouvir suas experiências e sugestões para aprimorar continuamente nossos serviços. Sinta-se à vontade para entrar em contato conosco por meio de nossa comunidade do Discord ou outros canais de suporte.
GET /v1/charges
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
Parâmetros de entrada:
"charge_type"
"customer_document"
"status"
"custom_id"
"value"
"date_of"
"begin_date"
"end_date"
"limit"
"page"
"offset"
As respostas abaixo representam Sucesso(200) do consumo.
{
"code": 200,
"data": [
{
"id": 700029856,
"total": 2000,
"status": "unpaid",
"custom_id": null,
"created_at": "2024-04-04T14:50:44.000Z",
"customer": {
"name": "Gorbadock Oldbuck",
"phone_number": "5144916523",
"cpf": "94271564656"
},
"payment": {
"payment_method": "banking_billet",
"paid_at": null,
"banking_billet": {
"barcode": "36490.00019 00030.231908 00000.04378 7 00000100002000",
"link": "https://visualizacao.gerencianet.com.br/emissao/302309_538_XICOR4/A4XB-302309-4037-DOD8",
"expire_at": "2024-04-04T15:00:00.000Z",
"configurations": {
"days_to_write_off": 90,
"interest_type": "daily"
},
"pdf": {
"charge": "https://download.gerencianet.com.br/302309_538_XICOR4/302309-4037-DOD8.pdf"
}
},
"pix": {
"qrcode": "0002010102122694014BR.GOV.BCB.PIX2572qrcodespix.sejaefi.com.br/bolix/v2/cobv/f8f5ff18cbdf4ede844189941892238d5214000053039865802BR5905EFISA6008SAOPAULO62070503***6304945E",
"qrcode_image": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 41 41\" shape-rendering=\"crispEdges\"><path fill=\"#ffffff\" d=\"M0 0h41v41H0z\"/><path stroke=\"#000000\" d=\"M0 0.5h7m1 0h2m2 0h2m1 0h2m3 0h2m2 0h2m2 0h1m3 0h1m1 0h7M0 1.5h1m5 0h1m3 0h2m1 0h1m2 0h2m1 0h1m1 0h1m4 0h4m4 0h1m5 0h1M0 2.5h1m 0h3m1 0h1m3 0h2m1 0h1m1 0h5m2 0h1m6 0h2m1 0h1m1 0h1m1 0h3m1 0h1M0 3.5h1m1 0h3m1 0h1m2 0h1m1 0h1m3 0h4m2 0h2m1 0h3m1 0h2m2 0h1m1 0h1m1 0h3m1 0h1M0 4.5h1m1 0h3m1 0h1m2 0h1m1 0h2m1 0h3m1 0h4m1 0h2m1 0h2m1 0h1m1 0h1m2 0h1m1 0h3m1 0h1M0 5.5h1m5 0h1m4 0h4m1 0h5m1 0h4m2 0h1m3 0h1m1 0h1m5 0h1M0 6.5h7m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h7M8 7.5h2m1 0h1m7 0h3m2 0h3m2 0h3M0 8.5h2m1 0h2m1 0h1m8 0h1m2 0h3m1 0h2m3 0h1m2 0h1m1 0h1m1 0h1m5 0h1M0 9.5h3m4 0h6m3 0h2m1 0h3m1 0h2m2 0h3m1 0h1m1 0h2m2 0h4M2 10.5h1m3 0h1m1 0h2m1 0h1m3 0h3m3 0h1m2 0h1m3 0h4m1 0h1m1 0h2m1 0h2M1 11.5h2m5 0h1m1 0h3m2 0h2m2 0h2m1 0h1m1 0h3m1 0h4m4 0h1m2 0h1M4 12.5h1m1 0h3m2 0h4m1 0h2m1 0h1m1 0h1m1 0h2m2 0h2m2 0h1m1 0h1m3 0h4M1 13.5h1m1 0h3m2 0h2m3 0h4m1 0h2m2 0h4m1 0h1m4 0h3m1 0h2m2 0h1M0 14.5h3m1 0h1m1 0h2m1 0h5m2 0h2m1 0h2m1 0h2m3 0h1m1 0h1m2 0h3m2 0h1m1 0h2M0 15.5h1m1 0h1m2 0h1m4 0h2m1 0h1m1 0h1m1 0h1m1 0h10m1 0h2m2 0h1m4 0h1M0 16.5h1m1 0h2m2 0h3m1 0h1m2 0h2m1 0h1m1 0h2m3 0h1m1 0h6m4 0h5M1 17.5h1m1 0h2m2 0h4m1 0h1m1 0h4m6 0h6m3 0h4m1 0h2M0 18.5h2m3 0h4m1 0h3m1 0h1m3 0h1m1 0h1m6 0h1m3 0h1m1 0h2m1 0h2m1 0h2M0 19.5h1m1 0h4m2 0h3m2 0h5m3 0h1m2 0h1m1 0h1m4 0h1m2 0h1m1 0h5M0 20.5h1m1 0h1m2 0h2m4 0h1m1 0h1m1 0h3m1 0h8m1 0h9m1 0h3M0 21.5h3m1 0h1m3 0h1m1 0h1m1 0h1m2 0h2m1 0h3m1 0h1m2 0h1m4 0h1m1 0h2m2 0h2m2 0h1M0 22.5h2m1 0h1m2 0h1m2 0h1m1 0h1m1 0h1m3 0h2m1 0h1m2 0h1m2 0h2m4 0h1m5 0h2M1 23.5h3m4 0h1m2 0h4m1 0h2m2 0h1m2 0h4m1 0h1m2 0h3m1 0h2m3 0h1M0 24.5h3m1 0h1m1 0h2m2 0h2m2 0h1m3 0h2m2 0h2m2 0h2m1 0h1m1 0h1m2 0h1m4 0h2M2 25.5h1m4 0h1m1 0h2m1 0h1m7 0h6m1 0h1m2 0h1m1 0h5m1 0h3M2 26.5h3m1 0h3m1 0h1m2 0h1m1 0h2m1 0h1m1 0h2m3 0h2m1 0h1m1 0h1m1 0h3m1 0h1m2 0h1M1 27.5h1m3 0h1m1 0h2m1 0h4m3 0h3m2 0h2m1 0h2m1 0h1m1 0h1m5 0h1m1 0h1M0 28.5h1m2 0h4m2 0h1m1 0h2m1 0h1m3 0h1m1 0h1m1 0h3m1 0h1m1 0h7m2 0h4M0 29.5h1m2 0h1m3 0h3m1 0h1m2 0h1m1 0h2m5 0h1m1 0h1m1 0h1m2 0h2m2 0h3m3 0h1M0 30.5h2m4 0h1m2 0h1m2 0h4m5 0h1m1 0h8m2 0h3m2 0h3M0 31.5h2m1 0h3m1 0h1m3 0h1m1 0h1m1 0h3m1 0h3m1 0h5m1 0h1m4 0h1m1 0h2m1 0h1M0 32.5h2m3 0h2m2 0h3m3 0h1m1 0h7m3 0h1m1 0h1m2 0h5m1 0h1m1 0h1M8 33.5h1m1 0h3m2 0h2m2 0h2m3 0h2m1 0h6m3 0h1m1 0h3M0 34.5h7m7 0h1m2 0h1m1 0h1m3 0h2m1 0h2m2 0h3m1 0h1m1 0h1m1 0h2M0 35.5h1m5 0h1m6 0h2m2 0h2m3 0h2m5 0h1m1 0h2m3 0h4M0 36.5h1m1 0h3m1 0h1m1 0h2m1 0h3m1 0h3m1 0h4m1 0h2m2 0h1m1 0h1m1 0h5m1 0h3M0 37.5h1m1 0h3m1 0h1m1 0h1m1 0h1m1 0h1m3 0h1m1 0h3m2 0h4m2 0h3m2 0h1m1 0h3M0 38.5h1m1 0h3m1 0h1m5 0h1m3 0h2m1 0h1m4 0h3m1 0h9m2 0h2M0 39.5h1m5 0h1m1 0h1m2 0h1m3 0h1m2 0h1m1 0h1m4 0h2m1 0h1m1 0h3m5 0h3M0 40.5h7m1 0h1m1 0h1m3 0h1m1 0h1m1 0h1m4 0h1m1 0h6m1 0h2m2 0h2m1 0h1\"/></svg>"
}
}
},
{
"id": 698753033,
"total": 2000,
"status": "unpaid",
"custom_id": null,
"created_at": "2024-04-02T05:27:33.000Z",
"customer": {
"name": "Gorbadoc Oldbuck",
"phone_number": "5144916523",
"cpf": "94271564656"
},
"payment": {
"payment_method": "banking_billet",
"paid_at": null,
"banking_billet": {
"barcode": "36490.00050 00230.230908 00000.039842 9 0000000010000",
"link": "https://visualizacao.gerencianet.com.br/emissao/302309_529_FOFO8/A4XB-302309-3984-LANA0",
"expire_at": "2024-04-12T15:00:00.000Z",
"configurations": {
"days_to_write_off": null,
"interest_type": null
},
"pdf": {
"charge": "https://download.gerencianet.com.br/302309_529_FOFO8/302309-3984-LANA0.pdf"
}
},
"pix": {
"qrcode": "0002010102122942014BR.GOV.BCB.PIX2572qrcodespix.sejaefi.com.br/bolix/v2/cobv/431a57a6c31d41b2b17fb3f06861d89e1204000053039865802BR5905EFISA6008SAOPAULO62070503***63045FE2",
"qrcode_image": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 45 45\" shape-rendering=\"crispEdges\"><path fill=\"#ffffff\" d=\"M0 0h45v45H0z\"/><path stroke=\"#000000\" d=\"M0 0.5h7m1 0h2m3 0h2m2 0h2m1 0h1m3 0h2m1 0h1m1 0h3m4 0h1m1 0h7M0 1.5h1m5 0h1m2 0h2m2 0h1m2 0h1m2 0h2m3 0h1m4 0h1m1 0h2m 0h1m2 0h1m5 0h1M0 2.5h1m1 0h3m1 0h1m2 0h2m2 0h2m2 0h3m2 0h5m1 0h1m1 0h2m3 0h1m2 0h1m1 0h3m1 0h1M0 3.5h1m1 0h3m1 0h1m2 0h2m4 0h2m1 0h4m4 0h1m1 0h1m2 0h2m2 0h2m1 0h1m1 0h3m1 0h1M0 4.5h1m1 0h3m1 0h1m6 0h4m1 0h1m1 0h8m1 0h1m2 0h5m1 0h1m1 0h3m1 0h1M0 5.5h1m5 0h1m9 0h1m3 0h1m3 0h1m3 0h2m1 0h1m6 0h1m5 0h1M0 6.5h7m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h7M8 7.5h3m3 0h1m2 0h1m2 0h1m3 0h5m1 0h1m2 0h1m2 0h1M0 8.5h2m1 0h2m1 0h1m2 0h1m3 0h1m2 0h1m1 0h1m1 0h5m1 0h2m3 0h3m1 0h1m2 0h1m5 0h1M1 9.5h1m2 0h2m3 0h6m1 0h1m1 0h1m2 0h2m3 0h1m1 0h1m2 0h1m5 0h2m1 0h1m1 0h1m1 0h1M0 10.5h3m3 0h1m2 0h1m1 0h1m6 0h2m2 0h1m2 0h1m1 0h1m3 0h2m4 0h3m2 0h1m1 0h1M1 11.5h2m2 0h1m2 0h1m1 0h1m2 0h2m1 0h1m2 0h2m2 0h2m3 0h1m1 0h1m5 0h1m1 0h5M0 12.5h4m1 0h3m2 0h2m1 0h1m3 0h1m1 0h2m3 0h1m2 0h5m1 0h2m4 0h2m1 0h1m1 0h1M1 13.5h1m2 0h1m4 0h3m4 0h2m1 0h2m2 0h1m1 0h1m4 0h3m4 0h2M2 14.5h1m3 0h1m1 0h1m1 0h1m1 0h1m1 0h3m1 0h1m1 0h3m1 0h1m1 0h8m2 0h1m2 0h1m3 0h1M0 15.5h3m1 0h2m1 0h2m9 0h1m4 0h5m3 0h1m1 0h3m1 0h4m1 0h3M1 16.5h1m2 0h1m1 0h1m1 0h2m1 0h1m1 0h1m1 0h1m1 0h3m1 0h1m1 0h2m1 0h2m2 0h1m2 0h2m2 0h1m1 0h2M0 17.5h4m1 0h1m4 0h3m2 0h1m1 0h3m2 0h3m1 0h4m1 0h1m2 0h1m2 0h1m2 0h2m2 0h1M0 18.5h1m5 0h4m1 0h1m1 0h3m1 0h3m2 0h1m1 0h1m1 0h1m1 0h1m2 0h2m1 0h1m5 0h5M0 19.5h1m1 0h2m1 0h1m2 0h4m1 0h8m2 0h1m2 0h1m1 0h6m2 0h1m2 0h1M0 20.5h3m1 0h6m2 0h3m1 0h1m2 0h6m2 0h2m1 0h1m4 0h9M1 21.5h1m2 0h1m3 0h7m2 0h1m2 0h1m3 0h1m1 0h2m2 0h3m1 0h1m1 0h1m3 0h5M0 22.5h1m3 0h1m1 0h1m1 0h1m1 0h1m3 0h1m5 0h1m1 0h1m1 0h3m4 0h1m1 0h1m1 0h2m1 0h1m1 0h1m1 0h1m1 0h1M4 23.5h1m3 0h2m3 0h1m3 0h1m2 0h1m3 0h2m1 0h1m1 0h1m1 0h6m3 0h4M0 24.5h2m2 0h11m1 0h1m3 0h5m2 0h1m1 0h4m2 0h6m1 0h3M1 25.5h2m1 0h2m1 0h2m1 0h2m2 0h1m3 0h5m2 0h2m1 0h1m1 0h1m1 0h3m2 0h2m4 0h2M0 26.5h1m1 0h6m1 0h2m2 0h2m1 0h4m1 0h1m1 0h1m2 0h4m1 0h5m1 0h1m3 0h1m1 0h1M0 27.5h3m6 0h1m1 0h1m1 0h1m2 0h2m6 0h1m3 0h1m4 0h2m1 0h3m1 0h1m3 0h1M2 28.5h2m1 0h4m1 0h1m1 0h1m1 0h1m2 0h1m1 0h2m1 0h1m2 0h1m2 0h2m1 0h1m1 0h1m1 0h1m2 0h2m4 0h1M0 29.5h1m1 0h1m5 0h1m2 0h4m1 0h1m3 0h1m3 0h3m1 0h2m1 0h2m1 0h2m2 0h1m1 0h5M1 30.5h2m1 0h4m2 0h2m3 0h1m1 0h4m1 0h4m1 0h1m1 0h2m4 0h1m1 0h1m2 0h4M1 31.5h1m1 0h2m5 0h1m1 0h2m2 0h4m1 0h2m1 0h7m3 0h1m1 0h3m2 0h1m1 0h2M3 32.5h1m1 0h2m1 0h1m2 0h2m1 0h3m1 0h4m5 0h1m2 0h3m1 0h1m1 0h3m2 0h4M1 33.5h3m1 0h1m2 0h2m2 0h1m1 0h2m1 0h5m1 0h1m3 0h2m3 0h2m1 0h3m4 0h1m1 0h1M4 34.5h1m1 0h5m1 0h1m1 0h7m1 0h1m1 0h2m1 0h2m4 0h3m2 0h1m5 0h1M1 35.5h4m2 0h3m1 0h3m1 0h1m2 0h1m1 0h1m2 0h1m2 0h1m2 0h3m2 0h1m1 0h2m3 0h3M0 36.5h1m2 0h2m1 0h1m3 0h1m2 0h1m2 0h10m2 0h3m1 0h2m2 0h5m3 0h1M8 37.5h1m1 0h1m3 0h1m1 0h2m1 0h2m3 0h1m2 0h1m2 0h2m3 0h2m3 0h3m1 0h1M0 38.5h7m2 0h2m1 0h2m3 0h1m1 0h2m1 0h1m1 0h1m3 0h1m2 0h4m1 0h1m1 0h1m1 0h1m2 0h1M0 39.5h1m5 0h1m2 0h2m2 0h4m2 0h2m3 0h4m1 0h1m1 0h1m3 0h2m3 0h3M0 40.5h1m1 0h3m1 0h1m1 0h2m1 0h2m1 0h1m5 0h6m1 0h1m1 0h2m1 0h3m1 0h7M0 41.5h1m1 0h3m1 0h1m1 0h3m2 0h1m2 0h3m3 0h2m2 0h2m1 0h2m3 0h1m3 0h2m1 0h2M0 42.5h1m1 0h3m1 0h1m2 0h1m1 0h1m1 0h1m2 0h2m2 0h3m1 0h1m3 0h1m1 0h1m1 0h2m1 0h1m1 0h1m2 0h1m1 0h3M0 43.5h1m5 0h1m1 0h2m1 0h1m2 0h1m2 0h1m3 0h1m1 0h1m7 0h1m4 0h1m5 0h1m1 0h1M0 44.5h7m1 0h1m2 0h4m1 0h1m1 0h2m1 0h1m2 0h2m1 0h1m3 0h1m1 0h2m3 0h6\"/></svg>"
}
}
},
{
"id": 686108680,
"total": 2000,
"status": "unpaid",
"custom_id": null,
"created_at": "2024-03-02T04:35:05.000Z",
"customer": {
"name": "Gorbadock Oldbuck",
"phone_number": "5144916523",
"cpf": "94271564656"
},
"payment": {
"payment_method": "banking_billet",
"paid_at": null,
"banking_billet": {
"barcode": "36490.00019 0030.231908 00000.039784 6 00000000002000",
"link": "https://visualizacao.gerencianet.com.br/emissao/302309_523_MALDO6/A4XB-302309-3978-MEHX6",
"expire_at": "2024-03-12T15:00:00.000Z",
"configurations": {
"days_to_write_off": null,
"interest_type": null
},
"pdf": {
"charge": "https://download.gerencianet.com.br/302309_523_MALDO6/302309-3978-MEHX6.pdf"
}
},
"pix": {
"qrcode": "000201101226940014BR.GOV.BCB.PIX2572qrcodespix.sejaefi.com.br/bolix/v2/cobv/1134216cf0864df5baa11a303afa868c225204000053039865802BR5905EFISA6008SAOPAULO62070503***63043E24",
"qrcode_image": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 41 41\" shape-rendering=\"crispEdges\"><path fill=\"#ffffff\" d=\"M0 0h41v41H0z\"/><path stroke=\"#000000\" d=\"M0 0.5h7m1 0h1m2 0h1m2 0h2m1 0h1m1 0h1m1 0h6m4 0h1m2 0h7M0 1.5h1m5 0h1m3 0h1m1 0h1m1 0h1m1 0h2m4 0h3m2 0h2m1 0h2m2 0h1m5 0h1M0 2.5h1m1 0h3m1 0h1m1 0h2m6 0h1m2 0h1m2 0h1m1 0h2m1 0h1m4 0h1m1 0h1m 0h3m1 0h1M0 3.5h1m1 0h3m1 0h1m1 0h1m1 0h3m3 0h1m3 0h2m2 0h2m1 0h3m4 0h1m1 0h3m1 0h1M0 4.5h1m1 0h3m1 0h1m1 0h1m3 0h1m1 0h3m3 0h1m1 0h1m3 0h1m2 0h1m2 0h1m1 0h1m1 0h3m1 0h1M0 5.5h1m5 0h1m2 0h2m1 0h1m1 0h1m1 0h1m2 0h1m2 0h2m3 0h5m2 0h1m5 0h1M0 6.5h7m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h7M9 7.5h1m3 0h1m2 0h3m1 0h2m4 0h2m3 0h1M0 8.5h4m2 0h1m1 0h1m2 0h1m3 0h1m3 0h4m1 0h1m2 0h1m3 0h3m2 0h3m1 0h1M1 9.5h2m1 0h2m2 0h1m1 0h6m3 0h1m1 0h4m1 0h1m2 0h1m1 0h2m4 0h1m1 0h2M1 10.5h1m1 0h1m2 0h4m2 0h3m1 0h1m5 0h1m2 0h1m1 0h5m1 0h3m2 0h3M2 11.5h1m2 0h1m2 0h3m1 0h1m2 0h4m1 0h1m1 0h2m1 0h1m2 0h1m5 0h2m1 0h1M0 12.5h1m3 0h5m1 0h1m1 0h3m2 0h2m5 0h4m1 0h2m3 0h1m1 0h1m2 0h1M0 13.5h3m4 0h6m1 0h5m1 0h1m1 0h3m1 0h1m2 0h1m1 0h1m3 0h3m2 0h1M1 14.5h2m1 0h1m1 0h1m1 0h1m1 0h4m1 0h5m1 0h2m5 0h4m2 0h1m2 0h1m2 0h1M0 15.5h2m2 0h2m1 0h3m1 0h7m7 0h1m4 0h4m1 0h1m1 0h1m2 0h1M0 16.5h3m2 0h2m2 0h2m1 0h3m1 0h1m4 0h1m1 0h4m1 0h2m3 0h1m1 0h1M0 17.5h5m3 0h4m2 0h3m1 0h2m1 0h1m1 0h1m1 0h7m1 0h2m2 0h2m1 0h1M2 18.5h7m3 0h3m1 0h1m2 0h1m3 0h1m3 0h2m3 0h1m2 0h2m1 0h3M1 19.5h2m1 0h2m2 0h3m1 0h1m1 0h6m1 0h1m1 0h1m2 0h1m7 0h2m2 0h1M0 20.5h1m1 0h1m1 0h3m3 0h2m1 0h1m2 0h1m2 0h1m2 0h2m1 0h1m1 0h2m1 0h2m6 0h2M1 21.5h1m2 0h2m2 0h3m1 0h1m2 0h2m2 0h1m1 0h1m3 0h1m2 0h1m1 0h2m1 0h2m2 0h3M0 22.5h1m1 0h5m3 0h4m2 0h2m3 0h1m1 0h1m2 0h1m3 0h1m1 0h2m1 0h2m1 0h1M1 23.5h3m6 0h1m1 0h1m1 0h3m1 0h1m1 0h1m2 0h2m1 0h1m2 0h5m1 0h1m2 0h1m1 0h1M2 24.5h3m1 0h3m3 0h2m2 0h3m1 0h1m2 0h1m1 0h1m2 0h1m2 0h2m2 0h1m3 0h1M0 25.5h1m1 0h1m2 0h1m2 0h4m6 0h3m1 0h1m4 0h1m3 0h4m2 0h2m1 0h1M0 26.5h2m1 0h1m1 0h3m1 0h2m2 0h2m1 0h2m2 0h1m1 0h1m1 0h2m1 0h2m1 0h1m1 0h2M0 27.5h1m4 0h1m1 0h4m1 0h1m2 0h3m1 0h3m1 0h1m3 0h1m2 0h1m1 0h2m2 0h1m2 0h1M0 28.5h2m3 0h2m1 0h1m3 0h1m2 0h1m2 0h1m1 0h2m1 0h1m2 0h2m3 0h3m1 0h1m1 0h3M2 29.5h3m8 0h1m2 0h1m2 0h2m1 0h1m3 0h1m1 0h2m4 0h3m3 0h1M0 30.5h1m1 0h1m2 0h4m2 0h2m2 0h1m1 0h1m1 0h1m1 0h2m4 0h2m1 0h1m2 0h1m4 0h2M3 31.5h3m3 0h1m1 0h1m3 0h2m1 0h1m1 0h2m4 0h3m1 0h1m3 0h1m3 0h2M1 32.5h2m1 0h1m1 0h2m2 0h1m4 0h1m1 0h1m2 0h1m1 0h3m4 0h2m1 0h6m1 0h2M8 33.5h1m3 0h1m1 0h1m2 0h1m1 0h1m2 0h1m1 0h3m3 0h3m3 0h1m3 0h1M0 34.5h7m2 0h2m1 0h1m2 0h1m3 0h1m1 0h1m1 0h1m1 0h2m3 0h3m1 0h1m1 0h1m1 0h1m1 0h1M0 35.5h1m5 0h1m3 0h4m3 0h1m1 0h1m1 0h2m1 0h1m5 0h1m1 0h1m3 0h1m1 0h1m1 0h1M0 36.5h1m1 0h3m1 0h1m2 0h2m1 0h1m1 0h3m4 0h1m1 0h1m3 0h1m2 0h8m1 0h2M0 37.5h1m1 0h3m1 0h1m1 0h3m2 0h3m1 0h3m4 0h1m1 0h1m1 0h1m5 0h2m1 0h2M0 38.5h1m1 0h3m1 0h1m1 0h1m7 0h6m1 0h1m1 0h5m1 0h2m1 0h2m2 0h1m1 0h1M0 39.5h1m5 0h1m1 0h1m1 0h1m1 0h1m1 0h3m1 0h1m1 0h3m2 0h1m2 0h1m1 0h1M0 40.5h7m1 0h1m1 0h3m1 0h3m4 0h1m1 0h4m1 0h2m2 0h3m3 0h1\"/></svg>"
}
}
}
],
"params": {
"begin_date": "2023-05-06T00:00:00.000Z",
"end_date": "2024-05-01T00:00:00.000Z",
"pagination": {
"limit": 3,
"offset": 0,
"page": 1
}
}
}
Limite de consumoAssim como todos os endpoints de nossa API, a listagem de cobranças também possui um limite diário, que pode ser conferido na aba Limites de Consumo.
Caso as consultas excedam estes valores, recomendamos abrir um ticket em sua conta, solicitando a liberação.
Associar plano ao link de pagamento
Após criar o seu plano de Assinatura, você pode gerar um link de pagamento para associar assinaturas a esse plano. Para fazer isso, envie uma requisição POST para a rota /v1/plan/:id/subscription/one-step/link.
Estrutura hierárquica dos atributos do Schema que podem ser utilizados:
- /v1/plan/:id/subscription/one-step/link
"items"
"name"
"value"
"amount"
"marketplace"
"payee_code"
"percentage"
"shippings"
"name"
"value"
"payee_code"
"metadata"
"custom_id"
"notification_url"
"settings"
"billet_discount"
"card_discount"
"conditional_discount"
"type"
"percentage",
"currency"
"value"
"until_date"
"message"
"expire_at"
"request_delivery_address"
"payment_method"
"banking_billet"
"credit_card"
"all"
POST /v1/plan/:id/subscription/one-step/link
Atributos Nesta seção estão descritos os atributos para Assinatura do tipo Boleto (Objeto banking_billet) e Cartão de crédito (Objeto credit_card)
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"items": [
{
"amount": 2,
"name": "Silicon Valley",
"value": 564
}
],
"metadata": {
"custom_id": "Assinatura",
"notification_url": "sua_url_notificação"
},
"settings": {
"payment_method": "all" ,
"expire_at": "2025-02-08",
"request_delivery_address": true
}
}
As respostas abaixo representam Sucesso do consumo.
{
"code": 200,
"data": {
"subscription_id": 8021,
"status": "new",
"custom_id": "Assinatura",
"charge": {
"id": 371496106,
"status": "link",
"total": 1128,
"parcel": 1
},
"payment_url": "https://pagamento.gerencianet.com.br/:identificador",
"payment_method": "all",
"conditional_discount_date": null,
"request_delivery_address": true,
"expire_at": "2025-02-08",
"created_at": "2021-11-09 12:06:54"
}
}
Incluir "notification_url" e "custom_id" em uma assinatura existente
É possível definir ou alterar as informações enviadas na propriedade metadata da transação a qualquer momento. Isso é útil para atualizar a URL de notificação vinculada às transações ou modificar o custom_id previamente associado às suas transações.
Para fazer essas alterações, você deve enviar uma requisição PUT para a rota /v1/charge/:id/metadata, onde :id é o charge_id da transação que deseja atualizar.
Casos de uso deste endpoint:- A pessoa integradora alterou o IP do servidor que estava associado na URL de notificação das transações;
- A pessoa integradora atualizou a URL de notificação para as novas transações criadas (
createCharge), mas precisa atualizar também as transações anteriores (updateChargeMetadata) que foram geradas e que estão associadas com a URL incorreta/desatualizada; - Foi instalado SSL (https) no servidor do cliente e mesmo que o cliente defina uma regra de redirecionamento 301 ou 302, será necessário definir a nova URL nas transações que estão usando a URL "antiga";
- Integrador gerou cobranças sem informar a URL de notificação ao enviar a requisição de criação da transação;
- Modificar ou acrescentar uma informação junto ao atributo
custom_id associado às transações geradas previamente; e outros cenários possíveis.
PUT /v1/subscription/:id/metadata
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"notification_url": 'http:
"custom_id": 'REF0001'
}
As respostas abaixo representam Sucesso(201) do consumo.
Alterar dados de uma assinatura
Você pode editar assinaturas ativas em um plano de assinaturas. Para isso, basta informar os campos que deseja editar e o subscription_id da assinatura.
Para realizar a alteração da assinatura, envie uma requisição PUT para a rota /v1/subscription/:id com as informações atualizadas no body.
Somente assinaturas do tipo Cartão de Crédito podem ser alteradas. Para alterar os dados de uma assinatura existente, é necessário que o método de pagamento definido seja cartão de crédito.
PUT /v1/subscription/:id
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"plan_id": 3,
"customer": {
"email": "gorbadoc.oldbuck@gmail.com",
"phone_number": "31123456789"
},
"items": [{
"name": "Product 1",
"value": 1000,
"amount": 1
}],
"shippings": [{
"name": "frete",
"value": 1800
}],
"payment_token": "75bfce47d230b550f7eaac2a932e0878a934cb3"
}
As respostas abaixo representam Sucesso(201) do consumo.
{
"code": 200,
"data": {
"subscription_id": 1,
"status": "active",
"value": 2800,
"custom_id": null,
"notification_url": null,
"payment_method": "credit_card",
"next_execution": "2024-01-05",
"next_expire_at": "2024-01-05",
"plan": {
"plan_id": 3,
"name": "Novo plano",
"interval": 1,
"repeats": 12
},
"customer": {
"email": "gorbadoc.oldbuck@gmail.com",
"phone_number": "31123456789"
},
"occurrences": 1,
"created_at": "2023-12-05T13:47:03.000Z"
}
}
Cancelar uma assinatura
Você pode cancelar assinaturas ativas em um plano de assinaturas. Para isso, basta informar o subscription_id da assinatura que deseja cancelar.
Para realizar o cancelamento da assinatura, envie uma requisição PUT para a rota /v1/subscription/:id/cancel da assinatura que você quer cancelar.
PUT /v1/subscription/:id/cancel
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
Parâmetro de entrada: informe a "subscription_id" da transação desejada
As respostas abaixo representam Sucesso(201) do consumo.
Acrescentar descrição ao histórico de uma assinatura
O histórico de uma assinatura registra todas as ações que ocorreram com ela até o momento atual. Você pode adicionar mensagens personalizadas a esse histórico usando o endpoint /v1/subscription/:id/history.
As mensagens personalizadas não têm impacto na assinatura em si, apenas são adicionadas ao histórico dela. Para isso, você deve informar o subscription_idda assinatura desejada. Essa descrição deve ter pelo menos um caractere e no máximo 255 caracteres.
POST/v1/subscription/:id/history
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"description": "Minha mensagem do histórico aqui"
}
As respostas abaixo representam Sucesso do consumo.
Reenvio do link associado ao plano para o email desejado
Um link de pagamento associado a um plano pode ser reenviado por e-mail. Para fazer isso, você só precisa enviar o identificador charge_id do link e o endereço de e-mail válido para o qual deseja enviar o boleto.
Para reenviar o link por e-mail, basta fazer uma requisição POST para a rota /v1/charge/:id/subscription/resend.
POST /v1/charge/:id/subscription/resend
Requer ativação da API de Emissão de cobranças em sua aplicação
Requisição
{
"email": "email_do_cliente@servidor.com.br"
}
As respostas abaixo representam Sucesso do consumo.