Documentação da API de acesso

Atualizado: 26/07/2021

Com a API OctaPay, produtores podem visualizar informações de suas vendas dentro da plataforma.

Consultar Transações

Com essa API é possível obter informações de todas as transações realizadas na OctaPay, com a possibilidade de paginação dos resultados. Cada página retorna um máximo de 100 transações.

Para gerar uma API_KEY, entre no painel da OctaPay, vá em Ferramentas > Api e clique em Gerar API

Url de requisição: https://api.octapay.com.br/ ou https://api.octapay.com.br/{número da página}

Método HTTP: POST

Formato da resposta: JSON

Parâmetros de cabeçalho:

Parâmetro

Descrição

Obrigatório

Authorization

Sua api_key

SIM

Content-Type

Deve ser enviado com o valor aplication/json

SIM

Exemplos:

<?php

$curl = curl_init();

curl_setopt_array($curl, array(

  CURLOPT_URL => ‘https://api.octapay.com.br/ ‘,

  CURLOPT_RETURNTRANSFER => true,

  CURLOPT_ENCODING => ”,

  CURLOPT_MAXREDIRS => 10,

  CURLOPT_TIMEOUT => 0,

  CURLOPT_FOLLOWLOCATION => true,

  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

  CURLOPT_CUSTOMREQUEST => ‘POST’,

  CURLOPT_HTTPHEADER => array(

    ‘Authorization: {api_key}‘,

    ‘Content-Type: application/json’

  ),

));

$response = curl_exec($curl);

curl_close($curl);

$teste = json_decode($response);

echo “Total de páginas: ” . $teste->info->paginas . “
“;

echo “Total de registros: ” . $teste->info->total_registros . “
“;

foreach ($teste->dados as $teste) {

    var_dump($teste);

}

 

Filtros de busca:

{

     “inicio”: “0000-00-00”,

     “fim”: “0000-00-00”,

     “transacao”: “PAY-000000000000”,

     “status”: 1,

     “produto”: “12345”,

     “pagamento”: 1,

     “comprador”: “Nome do Comprador”

}

Campo

Descrição

Tipo

Obrigatório

inicio

Data de cadastro ou data finalizada da transação

Data (yyyy-mm-dd)

NÃO

fim

Data de cadastro ou data finalizada da transação

Data (yyyy-mm-dd)

NÃO

status

Status da transação:

1. Aguardando pagamento

2. Em Análise

3. Pré Autorizada

4. Paga

5. Cancelada

6. Devolvida

7. Chargeback

8. Concluída

9. Bloqueada

 

Número

NÃO

transacao

Código da transação ou número do pedido: 

Nº transação: PAY-000000000000 ou 

Nº pedido: 23

 

String

NÃO

pagamento

Forma de pagamento:

  1. Cartão de Crédito
  2. Boleto
  3. Pix

Número

NÃO

comprador

Nome do comprador

String

NÃO

 

Retorno em formato JSON:

{
    “dados”: [
        {
            “registro”: 1,
            “produto”: {
                “codigo”: “12345”,
                “nome”: “Produto Teste Atualização2”,
                “preco”: “264.42”
            },
            “venda”: {
                “id”: “438”,
                “transacao”: “PAY-UT9XZRPSWOF6”,
                “data_pedido”: “2021-04-07 10:59:26”,
                “data_finalizada”: null,
                “forma_pagamento”: “2”,
                “status_transacao”: “1”,
                “parcelas”: “1”,
                “url_checkout”: “localhost/octapay/checkout/426A0EF5”,
                “link_boleto”: “https://sandbox.moip.com.br/v2/boleto/BOL-B3MIKP3BAYEO/print”,
                “linha_digitavel”: “34191.09032 63300.670195 61309.830000 5 85840000026442”,
                “data_vencimento”: “2021-04-08”,
                “valor_produto”: “264.42”,
                “valor_bruto”: “264.42”,
                “valor_frete”: “0.00”,
                “valor_desconto”: “0.00”,
                “src”: “”,
                “utm_source”: “”,
                “utm_medium”: “”,
                “utm_content”: “”,
                “utm_campaing”: null
            },
            “comprador”: {
                “nome”: “Pedro Henrique da Silva”,
                “email”: “[email protected]”,
                “cpf_cnpj”: “12719252654”,
                “telefone”: “33999102490”,
                “cep”: “35012140”,
                “rua”: “Rua São Bartolomeu”,
                “numero”: “330”,
                “complemento”: “”,
                “bairro”: “Vila Mariana”,
                “cidade”: “Governador Valadares”,
                “estado”: “MG”,
                “pais”: “BR”
            },
            “produtor”: {
                “nome”: “Pedro Henrique da Silva”,
                “cpf_cnpj”: null,
                “telefone”: null,
                “email”: “[email protected]
            }
        }
    ],
    “info”: {
        “total_registros”: 1,
        “paginas”: 1,
        “comissão_afiliado”: “1.134,11”,
        “valor_vendas”: “122.309,42”
    }
}

A OctaPay é a plataforma mais completa para afiliados e produtores que buscam sucesso em seus negócios online, sem perder a segurança e a facilidade. 

© OctaPay 2021 – Todos direitos reservados