Serviço de edição de agendamento

Após obter um SEID na etapa anterior, a loja poderá realizar edição do agendamento de fato. Todos os parâmetros enviados serão considerados para edição, ou seja, caso não queira alterar um atributo do agendamento, basta enviar o parâmetro vazio.

Detalhes da chamada

Recurso: /v1/schedules/edits/{seid}
Método HTTP: PUT
Formato da requisição: JSON
Formato da resposta: JSON
Parâmetros de cabeçalho:

Parâmetro	Descrição	Formato	Obrigatório
`merchant_id`	Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes.	< 15 AN	SIM
`merchant_key`	Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes.	< 80 AN	SIM
`Content-Type`	Deve ser enviado com o valor `application/json`.	= 15 AN	SIM

Exemplos

Abaixo estão alguns exemplos de chamada do serviço de edição de agendamento utilizando a ferramenta cURL.

Edição de múltiplos atributos

Requisição:

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/schedules/edits/qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm02"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "status":"INA",
   "amount":"5555",
   "next_date":"15/07/2017",
   "installments":"2",
   "installment_type":"3",
   "soft_descriptor":"Assinatura",
   "show_times_invoice":"false",
   "card":{
      "expiry_date":"1222",
      "number":"5555555555555555"
   }
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "schedule":{
      "status":"INA",
      "amount":"5555",
      "next_date":"15/07/2017",
      "number_of_times":"3",
      "current_times":"0",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "schedule_edit":{
      "status":"CON"
   }
}

Inativação de agendamento

Requisição:

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/schedules/edits/qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm02"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "status":"INA"
}
--verbose

Resposta:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "schedule":{
      "status":"INA",
      "amount":"900",
      "next_date":"03/08/2017",
      "number_of_times":"3",
      "current_times":"0",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "schedule_edit":{
      "status":"CON"
   }
}

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de edição de agendamento:

Parâmetro	Descrição	Formato	Obrigatório
`status`	Status do agendamento. Pode receber os seguintes valores: `ATV` – Ativa o agendamento. Este valor deve ser usado sobre agendamentos com status `INA` (inativo). Caso o agendamento seja reativado após sua data de execução, ele será reagendado para o mesmo dia do mês seguinte. `INA` – Inativa o agendamento, ou seja, os pagamentos agendados previamente não serão mais executados.	= 3 AN	NÃO
`amount`	Valor em centavos dos pagamentos agendados.	< 12 N	NÃO
`next_date`	Data da próxima execução do agendamento no formato `DD/MM/AAAA`. Só são permitidas datas futuras com dia entre 1 e 28.	= 10 D	NÃO
`installments`	Número de parcelas de cada pagamento agendado.	< 2 N	NÃO
`installment_type`	Tipo de financiamento do parcelamento de cada pagamento agendado: Valor `3` = parcelamento com juros da administradora do cartão. Valor `4` = parcelamento realizado pela loja e sem juros (adotar este valor como padrão/default para transações à vista).	< 2 N	NÃO
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. Saiba mais	< 30 AN	NÃO
`show_times_invoice`	Para agendamentos por tempo finito, enviar esse campo com valor `true` caso se deseje acrescentar ao final do campo `soft_descriptor` o número de execuções/total de execuções (exemplo: Assinatura 3/12).	< 5 T/F	NÃO
	card
`number`	Número do cartão do comprador (PAN).	< 19 N	NÃO
`expiry_date`	Data de vencimento do cartão no formato `MMAA`. O envio deste parâmetro deve, obrigatoriamente, vir acompanhado do número do cartão, ou seja, não é possível enviar apenas a data de validade.	= 4 N	NÃO

Parâmetros de resposta

Em caso de sucesso, o código de resposta HTTP será 200. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de edição de agendamento:

Parâmetro	Descrição	Formato
`code`	Código de resposta do e-SiTef. Qualquer código diferente de `0`(zero) significa falha. Saiba mais.	< 4 N
`message`	Mensagem de resposta do e-SiTef.	< 500 AN
	schedule
`status`	Status do agendamento no e-SiTef. Saiba mais.	= 3 AN
`amount`	Valor dos pagamentos agendados especificado pela loja (em centavos) na criação da transação.	< 12 N
`next_date`	Data de execução do próximo pagamento agendado no formato `DD/MM/AAAA`.	= 10 D
`number_of_times`	Número total de pagamentos agendados.	< 3 N
`current_times`	Número de pagamentos agendados já executados.	< 3 N
`installments`	Número de parcelas a ser utilizado nos pagamentos agendados.	< 2 N
`installment_type`	Tipo de financiamento a ser utilizado nos pagamentos agendados.	< 2 N
`soft_descriptor`	Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador.	< 30 AN
`show_times_invoice`	Para agendamentos por tempo finito, caso esse campo tenha valor `true` acrescenta ao final do campo `soft_descriptor` o número de execuções/total de execuções (exemplo: Assinatura 3/12).	< 5 T/F
	schedule_edit
`status`	Status da edição de agendamento no e-SiTef. Pode assumir os seguintes valores: `NOV` – Novo `EXP` – Expirado `CON` – Confirmado `INV` – Inválido	= 3 AN