Seja bem-vindo à documentação do Wide Pay! Aqui você encontrará as informações necessárias para fazer a integração com nossa infraestrutura.

Visão geral

Com a API do Wide Pay, é possível utilizar qualquer recurso disponível em sua conta, como: gerar transações, carnês, assinaturas e receber notificações toda vez que algum status sofrer alteração.

Também é possível utilizar os recursos de pagamento de contas, recargas de celular, transferências bancárias, transferências entre contas Wide Pay e transferências para cartões pré-pagos.

Carteira e token

Para utilização da API, é necessário ter o ID da carteira e o token de autenticação.

O conceito de carteiras do Wide Pay serve para que você possa separar os recebimentos, pagamentos e transferências, como, por exemplo, se você tiver duas lojas.

Para ter um gerenciamento completo de suas carteiras, como criar, editar, obter ID e token, primeiramente, faça o login em sua conta Wide Pay, acesse o menu superior Configurações e depois clique em Carteiras.

Ambiente de testes

A configuração do ambiente de teste é realizada na hora em que você adiciona a carteira no Wide Pay.

Após realizados os testes de integração, você poderá migrar a carteira para o ambiente de produção. Lembramos que uma carteira já em produção não pode ser migrada para o ambiente de testes.

Endpoint e respostas

Todas as respostas da API são em JSON e as requisições são feitas no endpoint:

https://api.widepay.com/v1

Toda chamada para a API tem, no retorno, o atributo sucesso e, em caso de erro, também virá o atributo erro, conforme os exemplos abaixo:

{
  "sucesso": true
}
{
  "sucesso": false,
  "erro": "Mensagem de erro..."
}

As mensagens de erros variam de acordo com o método e existe uma condição especial para os erros abaixo:

  • Caso a mensagem de erro seja Erro na validação dos campos. será porque algum atributo obrigatório do método não foi enviado ou é inválido e também virá o atributo validacao, com o detalhamento dos atributos inválidos, conforme o exemplo abaixo:

    {
      "sucesso": false,
      "erro": "Erro na validação dos campos.",
      "validacao": [
        {
          "id":  "cpf",
          "erro":  "O CPF informado é inválido."
        },
        {
          "id":  "vencimento",
          "erro":  "O preenchimento do campo é obrigatório."
        }
      ]
    }
  • Caso a mensagem de erro seja Erro na execução da solicitação. será porque não houve sucesso da chamada em nenhum dos itens e também virá o atributo execucao, com o detalhamento dos erros, conforme o exemplo abaixo:

    {
      "sucesso": false,
      "erro": "Erro na execução da solicitação.",
      "execucao": [
        {
          "id":  "8FA0E7B48E882379",
          "erro":  "Cobrança não encontrada."
        },
        {
          "id":  "5C5C051E86177A22",
          "erro":  "A cobrança já está baixada."
        }
      ]
    }

Exemplos

Nos exemplos que você encontrará na documentação, usaremos o cURL e os códigos compatíveis com as bibliotecas disponíveis.

Os exemplos da documentação utilizam ID 148446 e token 800440511285a9b0808ea85a94f3dd62, portanto, lembre-se de substituir pelo ID e token da sua carteira.

Dúvidas ou sugestões

Mande um e-mail para contato@widepay.com em caso de dúvidas ou sugestões de melhorias e integrações da API.

Recebimentos

Cobranças

Em cobranças, você pode realizar recebimentos via boleto ou cartão de crédito.

Confira na tabela abaixo a lista de todos os status de uma cobrança e sua respectiva descrição.

Status Forma Descrição
Aguardando Boleto e cartão Cobrança criada e aguardando pagamento
Baixado Boleto e cartão Cobrança baixada é uma forma de confirmação manual do pagamento
Cancelado Boleto e cartão Cobrança cancelada pelo solicitante
Contestado Boleto e cartão Quando o pagador faz uma contestação do pagamento ao Wide Pay
Em análise Boleto e cartão Após o pagamento, a cobrança pode ser submetida a uma análise antifraude
Estornado Cartão Quando a cobrança é estornada pelo solicitante
Recebido Boleto e cartão Pagamento recebido
Recusado Cartão Pagamento recusado pela administradora de cartão ou pela análise antifraude
Vencido Boleto e cartão Um dia após o vencimento caso não haja o pagamento, o status é alterado

Caso queira testar a alteração de status em uma carteira em ambiente de teste, você poderá pagar uma cobrança via cartão de crédito. Valores até R$ 100,00 retornará Recusado, acima de R$ 100,00 retornará Recebido.

Gerando uma cobrança

URL
https://api.widepay.com/v1/recebimentos/cobrancas/adicionar
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
forma Sim Definido Forma de recebimento: Boleto e/ou Cartão
cliente Sim String Nome do cliente, tamanho máximo: 100 caracteres
pessoa Sim Definido Pode ser Física ou Jurídica
cpf Condicional CPF Obrigatório, se o atributo pessoa for Física
cnpj Condicional CNPJ Obrigatório, se o atributo pessoa for Jurídica
email Não E-mail -
telefone Não Telefone -
endereco Não Objeto -
endereco[rua] Não String Tamanho máximo: 100 caracteres
endereco[numero] Não String Tamanho máximo: 10 caracteres
endereco[complemento] Não String Tamanho máximo: 100 caracteres
endereco[bairro] Não String Tamanho máximo: 100 caracteres
endereco[cep] Não CEP -
endereco[cidade] Não String Tamanho máximo: 100 caracteres
endereco[estado] Não String Tamanho: 2 caracteres
itens Sim Array Itens da cobrança, máximo de itens: 10
itens[][descricao] Sim String Tamanho máximo: 255 caracteres
itens[][valor] Sim Decimal Casas decimais: 2, valor mínimo: -999999.99, valor máximo: 999999.99
itens[][quantidade] Não Numérico Valor padrão: 1, valor máximo: 99999
itens[][desconto] Não Decimal Casas decimais: 2, não pode ultrapassar a quantidade x valor do item
referencia Não String Código de referência para associar à cobrança um ID específico do seu sistema ou aplicação, tamanho máximo: 100 caracteres
notificacao Não URL URL que será chamada quando a cobrança muda de status
redirecionamento Não URL URL que o sistema redirecionará quando houver o pagamento e utilizado somente se o atributo forma for Cartão
vencimento Condicional Data Obrigatório, se o atributo forma for Boleto
enviar Não Definido Formas de envio da cobrança, atualmente só pode ser E-mail
marketplace Não Array Regras da divisão por marketplace, máximo de itens: 5. Se não definido, utilizará o valor definido no Wide Pay
marketplace[][carteira] Não Numérico ID da carteira para transferência
marketplace[][valor] Não Decimal Porcentagem da transferência, casas decimais: 2, valor máximo: 100.00
boleto Não Objeto Parâmetros opcionais de configuração do boleto, utilizado somente se o atributo forma for Boleto
boleto[desconto] Não Decimal Desconto para pagamento por boleto até o vencimento, casas decimais: 2, não pode ultrapassar 50% do valor da cobrança
boleto[multa] Não Decimal Valor em porcentagem, casas decimais: 2, valor máximo: 20, se não definido, pegará o valor definido no Wide Pay
boleto[juros] Não Decimal Valor em porcentagem aplicado ao mês, casas decimais: 2, valor máximo: 20, se não definido, pegará o valor definido no Wide Pay
boleto[instrucoes] Não String, Array Linhas de instruções, máximo de itens: 4, tamanho máximo de cada item: 100 caracteres. Se não definido, utilizará o valor definido no Wide Pay
ATRIBUTOS DE RETORNO
Atributo Descrição
id ID da cobrança gerada
link Link de pagamento da cobrança
Exemplo 1
Criando uma cobrança simples com o envio mínimo de atributos
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/adicionar' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'forma=Cartão' \
    -d 'cliente=Lívia Pontarolo Almeida' \
    -d 'pessoa=Física' \
    -d 'cpf=463.384.662-02' \
    -d 'itens[0][descricao]=Descrição item 1' \
    -d 'itens[0][valor]=22.50'
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$adicionar = $wp->api('recebimentos/cobrancas/adicionar', array(
    'forma' => 'Cartão',
    'cliente' => 'Lívia Pontarolo Almeida',
    'pessoa' => 'Física',
    'cpf' => '463.384.662-02',
    'itens' => array(
        array(
            'descricao' => 'Descrição item 1',
            'valor' => 22.50
        )
    )
));

if ($adicionar->sucesso) {

    echo $adicionar->id; // ID da cobrança gerada

} else {

    echo $adicionar->erro;

    if ($adicionar->erro == 'Erro na validação dos campos.') {
        print_r($adicionar->validacao); // Imprime os erros de validação
    }

}
Exemplo 2
Criando uma cobrança completa com o envio de todos os atributos disponíveis
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/adicionar' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'forma=Boleto,Cartão' \
    -d 'cliente=Lívia Pontarolo Almeida' \
    -d 'pessoa=Física' \
    -d 'cpf=463.384.662-02' \
    -d 'email=emaildalivia@gmail.com' \
    -d 'telefone=67 98888-0000' \
    -d 'endereco[rua]=Rua Primeiro de Julho' \
    -d 'endereco[numero]=192' \
    -d 'endereco[complemento]=Sala 25' \
    -d 'endereco[bairro]=Vila Carvalho' \
    -d 'endereco[cep]=79005-610' \
    -d 'endereco[cidade]=Campo Grande' \
    -d 'endereco[estado]=MS' \
    -d 'itens[0][descricao]=Descrição item 1' \
    -d 'itens[0][valor]=20' \
    -d 'itens[0][quantidade]=2' \
    -d 'itens[0][desconto]=4.99' \
    -d 'itens[1][descricao]=Descrição item 2' \
    -d 'itens[1][valor]=10.50' \
    -d 'referencia=Fatura 12345' \
    -d 'notificacao=http://www.minhaaplicacao.com/script-notificacao.php' \
    -d 'redirecionamento=http://www.minhaaplicacao.com/script-redirecionamento.php' \
    -d 'vencimento=2017-08-10' \
    -d 'enviar=E-mail' \
    -d 'marketplace[0][carteira]=10500' \
    -d 'marketplace[0][valor]=10' \
    -d 'marketplace[1][carteira]=10800' \
    -d 'marketplace[1][valor]=5' \
    -d 'boleto[desconto]=4.5' \
    -d 'boleto[multa]=2' \
    -d 'boleto[juros]=1' \
    -d 'boleto[instrucoes][0]=Instrução personalizada ao cliente, linha 1' \
    -d 'boleto[instrucoes][1]=Instrução personalizada ao cliente, linha 2'
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$adicionar = $wp->api('recebimentos/cobrancas/adicionar', array(
    'forma' => 'Boleto,Cartão',
    'cliente' => 'Lívia Pontarolo Almeida',
    'pessoa' => 'Física',
    'cpf' => '463.384.662-02',
    'email' => 'emaildalivia@gmail.com',
    'telefone' => '67 98888-0000',
    'endereco' => array(
        'rua' => 'Rua Primeiro de Julho',
        'numero' => '192',
        'complemento' => 'Sala 25',
        'bairro' => 'Vila Carvalho',
        'cep' => '79005-610',
        'cidade' => 'Campo Grande',
        'estado' => 'MS'
    ),
    'itens' => array(
        array(
            'descricao' => 'Descrição item 1',
            'valor' => 20,
            'quantidade' => 2,
            'desconto' => 4.99
        ),
        array(
            'descricao' => 'Descrição item 2',
            'valor' => 10.50
        )
    ),
    'referencia' => 'Fatura 12345',
    'notificacao' => 'http://www.minhaaplicacao.com/script-notificacao.php',
    'redirecionamento' => 'http://www.minhaaplicacao.com/script-redirecionamento.php',
    'vencimento' => '2017-08-10',
    'enviar' => 'E-mail',
    'marketplace' => array(
        array(
            'carteira' => 10500,
            'valor' => 10
        ),
        array(
            'carteira' => 10800,
            'valor' => 5
        )
    ),
    'boleto' => array(
        'desconto' => 4.5,
        'multa' => 2,
        'juros' => 1,
        'instrucoes' => array(
            'Instrução personalizada ao cliente, linha 1',
            'Instrução personalizada ao cliente, linha 2'
        )
    )
));

if ($adicionar->sucesso) {

    echo $adicionar->id; // ID da cobrança gerada

} else {

    echo $adicionar->erro; // Erro

    if ($adicionar->erro == 'Erro na validação dos campos.') {
        print_r($adicionar->validacao); // Imprime os erros de validação
    }

}

Retorno dos exemplos:

{
  "sucesso": true,
  "id": "4A13E8BE9842C174",
  "link": "https://www.widepay.com/148446-4A13E8BE9842C174"
}

Boleto de uma cobrança

Lembramos que para obter os dados do boleto de uma cobrança, a forma de recebimento da mesma deve ser Boleto.

URL
https://api.widepay.com/v1/recebimentos/cobrancas/boleto
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
id Sim String ID da cobrança
atualizar Não Definido Atualiza automaticamente a data do boleto caso esteja vencido, pode ser Não ou Sim, valor padrão: Sim
html Não Definido Traz no retorno da requisição o HTML do boleto, pode ser Não ou Sim, valor padrão: Não
carne Não Definido Muda o layout HTML do boleto do formato convencional para o formato de carnê, pode ser Não ou Sim, valor padrão: Não
ATRIBUTOS DE RETORNO
Atributo Descrição
parametros Parâmetros da configuração do boleto, pode ser usado para gerar o boleto por sistema próprio, os dados mudam dependendo do banco configurado no Wide Pay
codigo Código de barras do boleto
html HTML do boleto
Exemplo 3
Obtendo dados do boleto de uma cobrança
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/boleto' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id=8AF962B49E3920BB' \
    -d 'atualizar=Sim' \
    -d 'html=Sim' \
    -d 'carne=Não'
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$boleto = $wp->api('recebimentos/cobrancas/boleto', array(
    'id' => '8AF962B49E3920BB',
    'atualizar' => 'Sim',
    'html' => 'Sim',
    'carne' => 'Não'
));

if ($boleto->sucesso) {

    print_r($boleto->parametros); // Imprime os parâmetros de configuração do boleto

    echo $boleto->codigo; // Código de barras do boleto
    echo $boleto->html; // HTML do boleto

} else {

    echo $boleto->erro; // Erro

}

Retorno do exemplo:

{
  "sucesso": true,
  "parametros": {
    "banco": "033",
    "agencia": "4582",
    "conta": "13001057-3",
    "codigo": "208822",
    "carteira": "101",
    "numero": "1"
  },
  "codigo": "03399.81276 22000.000004 00001.901016 1 73280000002250",
  "html": "<table>...</table>"
}

Consultando uma cobrança

URL
https://api.widepay.com/v1/recebimentos/cobrancas/consultar
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
id Não String, Array ID da cobrança a ser consultada, pode ser um ou mais. Caso não seja passado o ID, será retornado às últimas cobranças geradas
ATRIBUTOS DE RETORNO
Atributo Descrição
total Total de cobranças retornadas
cobrancas Lista com as cobranças encontradas
Exemplo 4
Efetuando a consulta de uma cobrança
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/consultar' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id=264C51BE984C7718'
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$consultar = $wp->api('recebimentos/cobrancas/consultar', array(
    'id' => '264C51BE984C7718'
));

if ($consultar->sucesso) {

    echo $consultar->cobrancas[0]['id']; // ID da cobrança
    echo $consultar->cobrancas[0]['status']; // Status da cobrança

    print_r($consultar->cobrancas[0]); // Imprime todos os dados da cobrança

} else {

    echo $consultar->erro; // Erro

}

Alguns atributos do retorno variam de acordo com a forma do recebimento, abaixo você encontrará a descrição de alguns atributos importantes de uma cobrança, e mais abaixo, alguns exemplos de retornos:

  • valor Valor total da cobrança
  • recebido Valor recebido
  • tarifa Valor da tarifa descontada pelo Wide Pay
  • recebimento Data do recebimento
  • compensacao Data de compensação do valor recebido
  • status Status atual da cobrança
  • detalhamento Detalhes do recebimento
  • historico Datas de alteração do status

Retorno de um exemplo de cobrança que está aguardando pagamento:

{
  "sucesso": true,
  "total": "1",
  "cobrancas": [
    {
      "id": "264C51BE984C7718",
      "cobranca": null,
      "carne": null,
      "assinatura": null,
      "forma": "Boleto,Cartão",
      "cliente": "Lívia Pontarolo Almeida",
      "pessoa": "Física",
      "cpf": "463.384.662-02",
      "cnpj": null,
      "email": "emaildalivia@gmail.com",
      "telefone": "67 98888-0000",
      "endereco": {
        "rua": "Rua Primeiro de Julho",
        "numero": "192",
        "complemento": "Sala 25",
        "bairro": "Vila Carvalho",
        "cep": "79005-610",
        "cidade": "Campo Grande",
        "estado": "MS"
      },
      "itens": [
        {
          "descricao": "Descrição item 1",
          "valor": "20",
          "quantidade": "2",
          "desconto": "4.99"
        },
        {
          "descricao": "Descrição item 2",
          "valor": "10.5",
          "quantidade": "1",
          "desconto": "0"
        }
      ],
      "referencia": "Fatura 12345",
      "valor": "40.51",
      "recebido": null,
      "tarifa": null,
      "notificacao": "http://www.minhaaplicacao.com/script-notificacao.php",
      "redirecionamento": "http://www.minhaaplicacao.com/script-redirecionamento.php",
      "vencimento": "2017-08-10",
      "recebimento": null,
      "compensacao": null,
      "criacao": "2017-06-25 18:55:18",
      "status": "Aguardando",
      "detalhamento": null,
      "duplicado": null,
      "compensado": null,
      "historico": [
        {
          "status": "Aguardando",
          "data": "2017-06-25 18:55:18"
        }
      ]
    }
  ]
}

Retorno de um exemplo de cobrança recebida por boleto:

{
  "sucesso": true,
  "total": "1",
  "cobrancas": [
    {
      "id": "264C51BE984C7718",
      "cobranca": null,
      "carne": null,
      "assinatura": null,
      "forma": "Boleto",
      "cliente": "Lívia Pontarolo Almeida",
      "pessoa": "Física",
      "cpf": "463.384.662-02",
      "cnpj": null,
      "email": null,
      "telefone": null,
      "endereco": {
        "rua": null,
        "numero": null,
        "complemento": null,
        "bairro": null,
        "cep": null,
        "cidade": null,
        "estado": null
      },
      "itens": [
        {
          "descricao": "Descrição item 1",
          "valor": "22.50",
          "quantidade": "1",
          "desconto": "0"
        }
      ],
      "referencia": null,
      "valor": "22.50",
      "recebido": "22.50",
      "tarifa": "2.15",
      "notificacao": null,
      "redirecionamento": null,
      "vencimento": "2017-08-10",
      "recebimento": "2017-06-23 00:00:00",
      "compensacao": "2017-06-30",
      "criacao": "2017-06-22 10:50:35",
      "status": "Recebido",
      "detalhamento": {
        "tarifa": {
          "fixa": "2.15"
        }
      },
      "duplicado": null,
      "compensado": "Não",
      "historico": [
        {
          "status": "Aguardando",
          "data": "2017-06-22 10:50:35"
        },
        {
          "status": "Recebido",
          "data": "2017-06-24 00:30:10"
        }
      ]
    }
  ]
}

Retorno de um exemplo de cobrança recebida por cartão de crédito:

{
  "sucesso": true,
  "total": "1",
  "cobrancas": [
    {
      "id": "264C51BE984C7718",
      "cobranca": null,
      "carne": null,
      "assinatura": null,
      "forma": "Cartão",
      "cliente": "Lívia Pontarolo Almeida",
      "pessoa": "Física",
      "cpf": "463.384.662-02",
      "cnpj": null,
      "email": null,
      "telefone": null,
      "endereco": {
        "rua": null,
        "numero": null,
        "complemento": null,
        "bairro": null,
        "cep": null,
        "cidade": null,
        "estado": null
      },
      "itens": [
        {
          "descricao": "Descrição item 1",
          "valor": "51.75",
          "quantidade": "1",
          "desconto": "0"
        }
      ],
      "referencia": null,
      "valor": "51.75",
      "recebido": "51.75",
      "tarifa": "2.91",
      "notificacao": null,
      "redirecionamento": null,
      "vencimento": null,
      "recebimento": "2017-06-20 14:20:12",
      "compensacao": "2017-07-20",
      "criacao": "2017-06-10 09:34:28",
      "status": "Recebido",
      "detalhamento": {
        "bandeira": "MasterCard",
        "cartao": "9080",
        "parcelas": "1",
        "fatura": "NomeLoja",
        "tarifa": {
          "fixa": 0.35,
          "porcentagem": 2.56
        }
      },
      "duplicado": null,
      "compensado": "Sim",
      "historico": [
        {
          "status": "Aguardando",
          "data": "2017-06-10 09:34:28"
        },
        {
          "status": "Recebido",
          "data": "2017-06-20 14:20:12"
        }
      ]
    }
  ]
}

Cancelando uma cobrança

URL
https://api.widepay.com/v1/recebimentos/cobrancas/cancelar
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
id Sim String, Array ID da cobrança a ser cancelada, pode ser um ou mais
ATRIBUTOS DE RETORNO
Atributo Descrição
total Total de cobranças canceladas
Exemplo 5
Efetuando o cancelamento de uma cobrança
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/cancelar' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id=8AF962B49E3920BB'
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$cancelar = $wp->api('recebimentos/cobrancas/cancelar', array(
    'id' => '8AF962B49E3920BB'
));

if ($cancelar->sucesso) {

    echo $cancelar->total; // Total de cobranças canceladas

} else {

    echo $cancelar->erro; // Erro

}

Retorno do exemplo:

{
  "sucesso": true,
  "total": 1
}
Exemplo 6
Efetuando o cancelamento de duas ou mais cobranças
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/cancelar' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id[0]=8AF962B49E3920BB' \
    -d 'id[1]=922FEDBE9835857A'
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$cancelar = $wp->api('recebimentos/cobrancas/cancelar', array(
    'id' => array('8AF962B49E3920BB', '922FEDBE9835857A')
));

if ($cancelar->sucesso) {

    echo $cancelar->total; // Total de cobranças canceladas

} else {

    echo $cancelar->erro; // Erro

}

Retorno do exemplo:

{
  "sucesso": true,
  "total": 2
}

Baixando uma cobrança

URL
https://api.widepay.com/v1/recebimentos/cobrancas/baixar
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
id Sim String, Array ID da cobrança a ser baixada, pode ser um ou mais
ATRIBUTOS DE RETORNO
Atributo Descrição
total Total de cobranças baixadas
Exemplo 7
Efetuando a baixa de uma cobrança
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/baixar' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id=8AF962B49E3920BB'
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$baixar = $wp->api('recebimentos/cobrancas/baixar', array(
    'id' => '8AF962B49E3920BB'
));

if ($baixar->sucesso) {

    echo $baixar->total; // Total de cobranças canceladas

} else {

    echo $baixar->erro; // Erro

}

Retorno do exemplo:

{
  "sucesso": true,
  "total": 1
}
Exemplo 8
Efetuando a baixa de duas ou mais cobranças
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/cancelar' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id[0]=8AF962B49E3920BB' \
    -d 'id[1]=922FEDBE9835857A'
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$baixar = $wp->api('recebimentos/cobrancas/baixar', array(
    'id' => array('8AF962B49E3920BB', '922FEDBE9835857A')
));

if ($baixar->sucesso) {

    echo $baixar->total; // Total de cobranças canceladas

} else {

    echo $baixar->erro; // Erro

}

Retorno do exemplo:

{
  "sucesso": true,
  "total": 2
}

Recebendo notificação da cobrança

As notificações servem para que você seja informado de uma alteração de status da cobrança. Dessa forma você poderá, por exemplo, identificar um pagamento e fazer os procedimentos de liquidação no seu sistema ou aplicação.

As notificações são enviadas quando uma cobrança possui uma URL de notificação definida na criação, ou, se não estiver definida, o sistema envia a notificação para a URL informada nas configurações do Wide Pay.

O envio da notificação é feito via POST via o parâmetro notificacao, que conterá o ID numérico da notificação que será usado para fazer a consulta dos dados da cobrança. Também virá o parâmetro carteira, contendo o ID da carteira dona da cobrança.

URL
https://api.widepay.com/v1/recebimentos/cobrancas/notificacao
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
id Sim Numérico ID da notificação a ser consultada
ATRIBUTOS DE RETORNO
Atributo Descrição
cobranca Objeto com dados da cobrança
Exemplo 9
Efetuando a consulta de uma notificação
curl \
    -X POST 'https://api.widepay.com/v1/recebimentos/cobrancas/notificacao' \
    -u '148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id='
<?php

require_once('../src/WidePay.php'); // Caminho para o SDK

$wp = new WidePay('148446', '800440511285a9b0808ea85a94f3dd62'); // ID e token da carteira

$notificacao = $wp->api('recebimentos/cobrancas/notificacao', array(
    'id' => $_POST["notificacao"] // ID da notificação recebido do Wide Pay via POST
));

if ($notificacao->sucesso) {

    echo $notificacao->cobranca['id']; // ID da cobrança
    echo $notificacao->cobranca['status']; // Status da cobrança

    print_r($notificacao->cobranca); // Imprime todos os dados da cobrança

} else {

    echo $notificacao->erro; // Erro

}

Retorno do exemplo:

{
  "sucesso": true,
  "cobranca": {
    "id": "9F15771E9FA3AFEF",
    "cobranca": null,
    "carne": null,
    "assinatura": null,
    "forma": "Cartão",
    "cliente": "Lívia Pontarolo Almeida",
    "pessoa": "Física",
    "cpf": "463.384.662-02",
    "cnpj": null,
    "email": null,
    "telefone": null,
    "endereco": {
      "rua": null,
      "numero": null,
      "complemento": null,
      "bairro": null,
      "cep": null,
      "cidade": null,
      "estado": null
    },
    "itens": [
      {
        "descricao": "Descrição item 1",
        "valor": "60",
        "quantidade": "1",
        "desconto": "0"
      }
    ],
    "referencia": null,
    "valor": "60.00",
    "recebido": null,
    "tarifa": null,
    "notificacao": "http://www.minhaaplicacao.com/script-notificacao.php",
    "redirecionamento": null,
    "vencimento": null,
    "recebimento": null,
    "compensacao": null,
    "criacao": "2017-05-17 08:29:05",
    "status": "Baixado",
    "detalhamento": null,
    "duplicado": null,
    "compensado": null,
    "historico": [
      {
        "status": "Aguardando",
        "data": "2017-05-17 08:29:05"
      },
      {
        "status": "Baixado",
        "data": "2017-06-25 15:22:41"
      }
    ]
  }
}