v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Transações

Listar transações

get/v1/marketplace/transactions

Query parameters

filtersstring
Example:{ "status": "CREATED" }

JSON com filtros. Campos filtráveis: created_at,type,status,gateway_authorization,establishment.id,representative.id,point_of_sale.type,point_of_sale.identification_number,original_amount,checkout_id

searchstring
Example:Dado a se buscar

Texto de busca.

perPagenumber

Quantidade de registros por página.

pagenumber

Página.

sortersstring
Example:[ { "column": "created_at", "direction": "DESC" } ]

JSON com lista de ordenadores. Campos ordenáveis: created_at,amount,original_amount

Headers

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Response

totalnumber required

Número total de registros.

pagenumber required

Página atual.

perPagenumber required

Número de registros por página.

lastPagenumber required

Número total de páginas.

Example response

{
  "data": [
    {
      "billet": {
        "due_date": "2026-07-18",
        "issue_date": "2026-06-18",
        "entry_date": "2023-09-09",
        "document_kind": "BOLETO_PROPOSTA",
        "iof_percentage": "32.45325",
        "messages": [
          "Mensagem 1",
          "Mensagem 2"
        ],
        "digitable_line": "03399356782060000000201234501011693970000000100",
        "barcode": "03396939700000001009356720600000000123450101",
        "qr_code_url": "pix.santander.com.br/qr/v2/cobv/...",
        "pdf_url": "https://storage.example.com/billets/billet.pdf",
        "configured_amount": 44308,
        "configured_original_amount": 45678,
        "discount": {
          "type": "VALOR_DATA_FIXA",
          "items": [
            {
              "value": 55,
              "limit_date": "2026-12-12"
            }
          ]
        },
        "fine": {
          "percentage": "1.20",
          "quantity_days": 5
        },
        "interest_percentage": "1.12",
        "payment": {
          "paid_via": "BARCODE",
          "date": "2025-11-24T13:46:52.015Z",
          "paid_amount": 10000,
          "interest_value": 150,
          "fine": 200
        }
      }
    }
  ]
}