Lista de faturas

O método permite recuperar uma lista de todas as faturas, enviando uma solicitação POST.

Para obter uma lista de todas as faturas, envie uma solicitação POST para a seguinte URL:

O que o método permite fazer

Retorna uma lista de todas as faturas
Número máximo de registos por solicitação — 100
Por padrão, a resposta contém 10 registos

Ponto de extremidade

POST https://api.trybit.com/v2/invoice/merchant/list

Cabeçalhos

Nome

Tipo

Exemplo

Descrição

Autorização*

string

Token eyJ0eXAiOiJK<...>4npi1ksS8tSY

Chave da API do projeto

Corpo da solicitação

Parâmetros principais

Nome

Tipo

Exemplo

Descrição

start*

string

01.01.2026

Data no formato «dd.mm.yyyyy»

end*

string

31.01.2026

Data no formato «dd.mm.yyyyy». Deve ser posterior ou igual a start.

offset

int

Este é o índice do registo inicial a partir do qual a obtenção dos dados começa.

Por exemplo, se offset=10, os dados começarão a partir do 11.º registo.

limit

int

Este é o número do último registo que você deseja obter.

Por exemplo, se limit=20, você receberá registos até e incluindo o 20.º, começando pelo especificado em offset.

Exemplos de solicitação

Estes exemplos mostram como enviar uma solicitação para recuperar uma lista de faturas dentro dos limites especificados.

curl -X POST https://api.trybit.com/v2/invoice/merchant/list \\
     -H \"Authorization: Token <API KEY>\" \\
     -H \"Content-Type: application/json\" \\
     -d '{"start":"01.01.2023","end":"31.01.2023","offset":0,"limit":10}'

import requests

url = "https://api.trybit.com/v2/invoice/merchant/list"
headers = {
    "Authorization": "Token <API KEY>"
}
data = {
    "start": "01.01.2023",
    "end": "31.01.2023",
    "offset": 0,
    "limit": 10
}

response = requests.post(url, headers=headers, json=data)

if response.status_code == 200:
    print("Sucesso:", response.json())
else:
    print("Falha:", response.status_code, response.text)

fetch('https://api.trybit.com/v2/invoice/merchant/list', {
    method: 'POST',
    headers: {
        'Authorization': 'Token <API KEY>',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        start: '01.01.2023',
        end: '31.01.2023',
        offset: 0,
        limit: 10
    })
})
.then(response => {
    if (response.ok) {
        return response.json();
    } else {
        throw new Error('Falha: ' + response.status + ' ' + response.statusText);
    }
})
.then(data => console.log('Sucesso:', data))
.catch(error => console.error('Erro:', error));

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.trybit.com/v2/invoice/merchant/list");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(array(
    "start" => "01.01.2023",
    "end" => "31.01.2023",
    "offset" => 0,
    "limit" => 10
)));

$headers = array(
    "Authorization: Token <API KEY>",
    "Content-Type: application/json"
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Erro:' . curl_error($ch);
} else {
    $statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if ($statusCode == 200) {
        echo "Sucesso: " . $response;
    } else {
        echo "Falha: " . $statusCode . " " . $response;
    }
}

curl_close($ch);
?>

Exemplos de resposta

Uma solicitação bem-sucedida retorna uma resposta com o status sucesso e um resultado objeto.

{
    "status": "sucesso",
    "result": [
       {
           "uuid": "INV-89UX09KA",
           "created": "2026-01-01 09:03:58.958133",
           "address": "0xb07427fc721C23674c48233ffE93D3846ee58B63",
           "currency": {
               "id": 3,
               "code": "ETH",
               "fullcode": "ETH",
               "network": {
                   "code": "ERC20",
                   "id": 3,
                   "icon": "https://cdn.trybit.com/img/network/ERC.svg",
                   "fullname": "Ethereum"
               },
               "name": "Ethereum",
               "is_email_required": false,
               "stablecoin": false,
               "icon_base": "https://cdn.trybit.com/img/currency/ETH.svg",
               "icon_network": "https://cdn.trybit.com/img/currency/ETH.svg",
               "icon_qr": "https://cdn.trybit.com/img/stroke/ETH_STROKE.svg",
               "order": 9
           },
           "date_finished": "2026-01-01 19:27:37.258735",
           "expiry_date": "2026-01-02 09:03:57.493361",
           "side_commission": "cliente",
           "side_commission_cc": "comerciante",
           "type_payments": "cripto",
           "status": "pago",
           "invoice_status": "sucesso",
           "is_email_required": false,
           "project": {
               "id": 1,
               "name": "Teste",
               "fail": "Nenhum",
               "success": "Nenhum",
               "logo": null
           },
           "tx_list": [
               "0x4d52dc2d2fa8555ab10211bd6c9a7aed13e6f9e1901090b03e7bf74603178c15",
                          ],
           "test_mode": false,
           "type": "up",
           "user_email": "a**********b@gmail.com",
           "pay_url": "Nenhum",
           "phone": "",
           "order_id": "Nenhum",
           "amount_in_crypto": null,
           "amount_in_fiat": 1.0,
           "amount": 0.000693,
           "amount_usd": 1.0,
           "amount_to_pay": 0.000694,
           "amount_to_pay_usd": 2.03,
           "amount_paid": 0.000694,
           "amount_paid_usd": 2.03,
           "fee": 1e-06,
           "fee_usd": 0.0,
           "service_fee": 1.2e-05,
           "service_fee_usd": 0.04,
           "received": 0.000681,
           "received_usd": 1.99,
           "to_surcharge": 0.0,
           "to_surcharge_usd": 0.0
       }

    ],
    "all_count": 2
}

Parâmetros da resposta

Uma solicitação bem-sucedida retorna uma resposta com o status sucesso e um resultado objeto.

O resultado objeto contém:

Nome

Tipo

Exemplo

Descrição

uuid

string

INV-89UX09KA

Identificador único da fatura com o prefixo INV

created

string

2026-01-01 12:00:00.000000

Hora de criação da fatura no formato UTC+0: YYYY-MM-DD HH:MI:SS.FFFFFF

address

string

0xb07427<...>E93D3846ee58B63

Endereço de pagamento

expiry_date

string

2026-01-02 12:00:00.000000

Data de expiração da fatura no formato UTC+0: YYYY-MM-DD HH:MI:SS.FFFFFF.

Após o tempo de expiração, o status da fatura mudará para cancelado se o pagamento não tiver sido recebido.

side_commission

string

cliente

Pagador da taxa de transferência

side_commission_cc

string

cliente

Pagador da taxa de serviço

amount

float

0.033366

Valor da fatura na criptomoeda selecionada

amount_usd

float

100.0

Valor da fatura em USD

amount_in_fiat

float

100.0

Valor da fatura na moeda de criação (depende do currency parâmetro)

fee

float

4.500000159168849e-06

Taxa de transferência

fee_usd

float

0.01

Taxa de transferência em USD

service_fee

float

0.000634

Taxa de serviço

service_fee_usd

float

1.9

Taxa de serviço em USD

fiat_currency

string

USD

Código da moeda fiduciária na qual a fatura foi criada

status

string

created

Status da fatura

Quando uma solicitação de criação de fatura é enviada, o status é sempre created.

Outros status possíveis: pago (pago), parcial (parcialmente pago), pago a mais (pago a mais), e cancelado (cancelado).

is_email_required

bool

false

Parâmetro que exige o e-mail do pagador na fatura

link

string

pay.trybit.com/89UX09KA

Link para a página da fatura

currency

dict

"currency": {

"id": 3,

"code": "ETH",

"fullcode": "ETH",

"network": {

"code": "ERC20",

"id": 3,

"icon": "https://cdn.trybit.com/img/network/ERC.svg",

"fullname": "Ethereum"

"name": "Ethereum",

"is_email_required": false,

"stablecoin": false,

"icon_base": "https://cdn.trybit.com/img/currency/ETH.svg",

"icon_network": "https://cdn.trybit.com/img/currency/ETH.svg",

"icon_qr": "https://cdn.trybit.com/img/stroke/ETH_STROKE.svg",

"order": 9

}

Objeto da criptomoeda selecionada na fatura.

Também contém o rede objeto — informações sobre a rede da moeda selecionada.

project

dict

"project": {

"id": 0,

"name": "MyShop",

"fail": "https://test.com/failed-payment",

"success": "https://test.com/successful-payment",

"logo": "https://static.trybit.com/logo/logo.jpg"

}

Objeto contendo informações do projeto

test_mode

bool

false

Indicador da fatura de teste

received

float

0.00206

Montante creditado no saldo em criptomoeda

received_usd

float

0.26

Montante creditado no saldo em USD

to_surcharge

float

0.001172

Montante restante a pagar em criptomoeda

to_surcharge_usd

float

0.08

Montante restante a pagar em USD

AnteriorCancelamento de fatura SeguinteInformações da fatura

Última atualização há 1 mês

Isto foi útil?