5. Notificando o Cliente – Central de Ajuda iPAGARE

Este recurso permite que uma notificação por E-Mail e/ou SMS seja enviada ao cliente de uma cobrança já cadastrada.

Você pode realizar a chamada a esta funcionalidade de duas maneiras distintas:

Através do UID da Cobrança gerado pela Southpayments
Através do MERCHANT_KEY da Cobrança (código que foi informado no momento da criação da cobrança)

AUTENTICAÇÃO

Veja a seção "Autenticação e Autorização".

Chamada através do UID da Cobrança

POST https://api.southpayments.com/orders/{UID}/notify_customer

REQUEST BODY (Json)

Nome	Tipo	Obrigatório	Comentário/Exemplo
merchant_id	string	sim	Código de estabelecimento fornecido pela Southpayments. Ex: 987heuiwqg8912g
order	object	não	Objeto Order com as informações sobre a notificação.
order.notify_customer	string	não	Valores possíveis: email: envia notificação para o e-mail cadastrado na cobrança; sms: envia notificação via SMS para o telefone celular cadastrado na cobrança both: envia tanto por e-mail quanto por SMS Se não for enviado, respeitará a configuração informada via Painel de Controle.
order.customer	object	não	Objeto Customer com os dados do cliente
customer.email	string	não	E-mail para o qual a notificação será enviada, sempre respeitando o parâmetro "notify_customer". Se não for informado, será utilizado o e-mail informado no momento da criação da Cobrança. Ex: joao@silva.com
customer.phone_number	string	não	Telefone celular (com DDD) para o qual será enviada a notificação, sempre respeitando o parâmtro "notify_customer". Se não informado, será utilizado o telefone informado no momento da criação da Cobrança. Ex: 11999999999

Exemplo - Envio por e-mail e SMS informando ambos

{
  "merchant_id": "4398yfnru3f7813",
  "order": {
    "notify_customer": "both", 
    "customer": {
      "email": "contato@xyz.com.br",
      "phone_number": "11999998877",
    }
  }
}

Chamada através do MERCHANT KEY da Cobrança

POST https://api.southpayments.com/orders/notify_customer

REQUEST BODY (Json)

Nome	Tipo	Obrigatório	Comentário/Exemplo
merchant_id	string	sim	Código de estabelecimento fornecido pela Southpayments. Ex: 987heuiwqg8912g
order	object	sim	Objeto Order com as informações sobre a notificação.
order.merchant_key	string	sim	Código da cobrança em seu sistema
notify_customer	string	não	Valores possíveis: email: envia notificação para o e-mail cadastrado na cobrança; sms: envia notificação via SMS para o telefone celular cadastrado na cobrança both: envia tanto por e-mail quanto por SMS Se não for enviado, respeitará a configuração informada via Painel de Controle.
order.customer	object	não	Objeto Customer com os dados do cliente
customer.email	string	não	E-mail para o qual a notificação será enviada, sempre respeitando o parâmtro "notify_customer". Se não for informado, será utilizado o e-mail informado no momento da criação da Cobrança. Ex: joao@silva.com
customer.phone_number	string	não	Telefone celular (com DDD) para o qual será enviada a notificação, sempre respeitando o parâmtro "notify_customer". Se não informado, será utilizado o telefone informado no momento da criação da Cobrança. Ex: 11999999999

Exemplo - Envio apenas por e-mail para o endereço já cadastrado

{
  "merchant_id": "4398yfnru3f7813",
  "order": {
    "merchant_key": "codigo-pedido", 
    "notify_customer": "email", 
  }
}

RETORNO - SUCESSO

Se a cobrança for encontrada, será retornado o código HTTP de sucesso juntamente com os dados da cobrança.

Código HTTP

200 (OK): Cobrança encontrada com sucesso.

Corpo da Resposta (Json)

O Retorno será a o objeto Cobrança para a qual o cliente foi notificado.

RETORNO - INSUCESSO

Os erros que podem ocorrer ao notificar um clienteé problema com autenticação e autorização, a cobrança não existir ou a cobrança já estar no status PAID ou CANCELLED.

Detalhes sobre os códigos HTTP e os motivos de insucesso estão apresentados na seção Códigos de Erro de Retorno.