Banco Boreal
HomeLanding
HomeLanding
  1. pix-invoices
  • Home
  • Payment Gateway
    • auth
      • /login
      • /me
      • /refresh
    • brcode-decode
      • /brcode-decode
    • brcode-payments
      • /brcode-payments
      • /brcode-payments
      • /brcode-payments/{id}
    • pix-invoices
      • /pix-invoices
        GET
      • /pix-invoices
        POST
      • /pix-invoices/{id}
        GET
      • /pix-invoices/{id}/cancel/
        PATCH
    • boletos
      • /boletos/
      • boletos_create
      • boletos_read
      • boletos_update
      • boletos_partial_update
      • boletos_delete
      • boletos_cancel
      • boletos_partial_update_local
    • transfers
      • analytics
        • transfers analytics
      • {id}
        • transfers read
      • transfers list
      • transfers create
    • receiver-accounts
      • {id}
        • receiver-accounts read
        • receiver-accounts update
        • receiver-accounts partial update
        • receiver-accounts delete
      • receiver-accounts list
      • receiver-accounts create
    • split-settings
      • split-settings update
    • split-receivers
      • {id}
        • split-receivers read
        • split-receivers update
        • split-receivers partial update
        • split-receivers delete
      • split-receivers list
      • split-receivers create
    • split-transactions
      • analytics
        • split-transactions analytics
      • {id}
        • split-transactions read
      • split-transactions list
    • balance
      • balance_list
    • statement
      • statement_list
    • organizations
      • /organizations/
      • /organizations/{id}/
      • /organizations/{id}/workspaces
    • workspaces
      • /workspaces/
      • /workspaces/host/{host}/
      • /workspaces/{id}/
      • /workspaces/{workspace_id}/members
    • event-types
      • /event-types/
    • subscriptions
      • /subscriptions
      • /subscriptions
      • /subscriptions/{id}
      • /subscriptions/{id}
  • Esquemas
    • Schemas
      • BRCodePayment
      • Address
      • Boleto
      • Account
      • WebhookSubscription
      • PixInvoice
      • Organization
      • AssetTemplate
      • Person
      • Ledger
      • Workspace
      • ProductTemplate
HomeLanding
HomeLanding
  1. pix-invoices

/pix-invoices

GET
/pix-invoices/

Requisição

Authorization
Adicionar o parâmetro
Authorization
a Cabeçalhos
, cujo valor é concatenar o Token após o Bearer.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Consulta

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/pix-invoices/?page' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200OK
application/json
Body

Exemplo
{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "98384715-6329-454b-8f08-b3a34951af2b",
            "amount": 1000000,
            "nominal_amount": 0,
            "paid_amount": 0,
            "name": "João da Silva",
            "tax_id": "12345678909",
            "street": "Rua das Flores",
            "street_number": "123",
            "neighborhood": "Centro",
            "city": "São Paulo",
            "state": "SP",
            "postal_code": "01001000",
            "due_date": "2025-01-17T12:00:00Z",
            "expiration_date": "2025-01-20T12:00:00Z",
            "fine": 2,
            "interest": 1,
            "tags": [
                "invoice",
                "pix"
            ],
            "descriptions": [
                "Compra de produtos eletrônicos"
            ],
            "brcode": "00020101021226910014BR.GOV.BCB.PIX2569spi-h.itau.com.br/pix/qr/v2/cobv/0ab0458f-38d7-41cd-9a99-9b08f70cb1af5204000053039865802BR5925BANCO BOREAL NEGOCIOS DIG6013FLORIANOPOLIS62070503***6304CF82",
            "image": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAADK0lEQVR4Xu2XUXIbIRBE4SJw/1vkKHARyHuDV5KVKlc+vPMlylZ2h1ZVp7tnwGX/vP6U98rb+gDO+gDO+i/AKKWu1lofdY9W56S+apTTABTmKJ3PSZ3N0tjulvMAo84Fz77qHH2V0krpq1tOBaARHEfrqwmpYNMBq46CX3xSBYRGuQD5YVHFoIlLhoc9y2kA0zn/Xd9T/b47fxcQa3R6RmlGMy2aFysJgEH0jT9dZq1/JYd2zgPAT00GY8S5QQPZPV0L0wDmY7JpYKRXaF7NepC8H4Ak2HOSq0/Eh1KRbB6AqaUxU42gZw/5heFwTQIgUnADMxym9q3jpD66OwFAYuyUEMyZ3mwi83ORvB+wPFbxxge4xTAbSnaRTADQsGGWcl2a0cFPsxIAmBOZOZOLc0SqqnQ1bwJAktGoAEMzZlqM98usHIBzXIFCnqJc9G9PBMRlgudRGaheshwcvj26+36AI4tu8RXgjFl2uuZy835AHGqsGk3cWowOztihgUmApU/VtHi4T1kyS8urWbcDgiYlKRZP2BWvrDyA75DkdykRiSU+MMW4NMDWmHIuFaqkc+fmff0vEgD7EJrxdKLStO1p1u2AoEU8yIu2zfAqcpwHiOPLGQoGffSsOzyCdhJAadj3cG8mlym6Q6WHUPcDZElQW7cKikGyTnSu0N4PGLoUnDxEiqea0VkPsxIA3Lx7RAab7J8D4lPBkgAcKER1G9TuJPHHPSinAcwFFW2avMSx0qeVPMAoQdLmXYrk5rnt5AEisF/NGyLpV1WrL7NSAPQIUQm1ojyPg0+zbgds91GnMcKkS2zA2Lw7DaBAeOT8YpjZNLqEfDUPQJWXuZ3iJW4YO64XVZpJgGFmYVePQtFFU4aPxrkf4D3b0ADCKp5bLB/TAO4ySBGLycEkbdpk5WreDMDWMOK64moDtxldHKIlAcbJhnFVriVdgfM5SG8HBCt3JWd8mGJ+IxUw4tUmtnG8YYB+MSsJgDdnYti23VYiN68kMwAt/vbgMFEl2teJegUmA7DdCoVIj7/qhHevbt4MGIZWcmAq/5pcvqV4aYAf1wdw1gdw1i8A/gJCdqX7O1XDswAAAABJRU5ErkJggg==",
            "status": "registered",
            "created_at": "2025-01-16T04:44:23.044779Z",
            "updated_at": "2025-01-16T04:44:34.610152Z",
            "payment_info": null
        },
        {
            "id": "4adb9b1f-bd12-4eec-b4b0-82080b949020",
            "amount": 1000000,
            "nominal_amount": 0,
            "paid_amount": 0,
            "name": "João da Silva",
            "tax_id": "12345678909",
            "street": "Rua das Flores",
            "street_number": "123",
            "neighborhood": "Centro",
            "city": "São Paulo",
            "state": "SP",
            "postal_code": "01001000",
            "due_date": "2025-01-17T12:00:00Z",
            "expiration_date": "2025-01-20T12:00:00Z",
            "fine": 2,
            "interest": 1,
            "tags": [
                "invoice",
                "pix"
            ],
            "descriptions": [
                "Compra de produtos eletrônicos"
            ],
            "brcode": "00020101021226910014BR.GOV.BCB.PIX2569spi-h.itau.com.br/pix/qr/v2/cobv/384211ed-e3f3-4446-8d6a-b8d439742c085204000053039865802BR5925BANCO BOREAL NEGOCIOS DIG6013FLORIANOPOLIS62070503***6304F114",
            "image": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAADI0lEQVR4Xu2WQXIjIRAEh4/A/3+xT4GPwGY2oxmtDo49ePokpLA9kIooV1c3OtbP68/xufOxvsBeX2Cv/wL6cZQ1Zm29rN7GGOzPsrezADYGZ6xey2xrHjXIOMkCehmTNyJHr/U4eLfZ3E4FRm86U9vkDIemW8kA5hxYVPrBLnXDo1yAN5I4Miy9zVorZ2/Feh4wnZ59rH9T/Xk6fhdwzVpMLNp6NS07xCsNwCIEEdTe/F3p317DrpYGoItuRV6ZCOxoLFOOEqYBKBpODWQOZ9lUsMW6/ovngXkWB03xJ/GZzhHEpgExO5pAd34o2Hm6N5MAnfKRgOjZsG99soBpgD5hyjSl3bgCFvPzEvk84GVSdGWK2UZtW/YSmQAgkjoV01L39NAzzbr/i6cB/OCMNumWB3RaqXk3bwqAP2oNw9DpTCsE5yrW84B/xWO3azhsbhCbRGD5WLCIGX74JSs098hQFsA+7vCK8ti80UmcnsVKAOha75G41GqsEt9wYq4kAaSEM6pUtl1mlUvlLlYG0BwaClVq8bRIHHfzPg44PLpxpUCKnEpGqXtZQLdT7WCmZ/EAeXrGNE0Dhi/0cK7IiEq1bK9iZQBnYVSl4KiVg+wq1vOAfsh4i+APNauALcRnAaGoXnd62BUuvYxKAAbHVYnTm5U6dWF7+Er144AJsWk9j0vVBo4SvoqVAdCmWmWZIFpA/NSwJGDZqPy9NIYL7ZwnC7fSAEc5m1wrh1WKR1S3q3kTgO3UDo4mech3T83KA4YN48nac916xWdGGkCzEtrqHFdqvMhs9RNZwLnJ1Urfhk0+nhlKAqhRsVcjJtWmsUrTEOUBTWnmht7lRmHb2e51mwcwteIIbZFefpicdXXW88C0cZv7U4ErJnoN3WmAdWFaYEz3cneGUDw0X82bALB4ZoDFV5th1xQZXllANxuWrE2vU9Mb4D1pnwdCVdiCuA1GYFOBHo/Dyx2uOkYo2F2sJIAhEjmJtm27ldq7yByg+WWTTVxa50w5A5MB8A6i28XFiVIF1ns1Hwa6ocUXIbWaXD419C0L+HF9gb2+wF6/APwFpOu0CwCuYigAAAAASUVORK5CYII=",
            "status": "registered",
            "created_at": "2025-01-16T04:43:28.356363Z",
            "updated_at": "2025-01-16T05:22:20.368125Z",
            "payment_info": null
        },
        {
            "id": "3385083f-e1ca-4a5c-8d4e-5e44d4cfe7d5",
            "amount": 1000000,
            "nominal_amount": 0,
            "paid_amount": 0,
            "name": "João da Silva",
            "tax_id": "12345678909",
            "street": "Rua das Flores",
            "street_number": "123",
            "neighborhood": "Centro",
            "city": "São Paulo",
            "state": "SP",
            "postal_code": "01001000",
            "due_date": "2025-01-17T12:00:00Z",
            "expiration_date": "2025-01-20T12:00:00Z",
            "fine": 2,
            "interest": 1,
            "tags": [
                "invoice",
                "pix"
            ],
            "descriptions": [
                "Compra de produtos eletrônicos"
            ],
            "brcode": "00020101021226910014BR.GOV.BCB.PIX2569spi-h.itau.com.br/pix/qr/v2/cobv/827fd0e3-abc0-47a3-ba12-11734661182b5204000053039865802BR5925BANCO BOREAL NEGOCIOS DIG6013FLORIANOPOLIS62070503***6304E99C",
            "image": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAADKElEQVR4Xu2WUW4jIRBE4SJw/1vsUeAizdYrZsZOVor2I/SXie3Y8CyVuqsLl/Xz+lO+73xbH2CvD7DXfwGjlBo9Wh91jT7n1H5Ub6cB2pij+rWJXFGaSZ9kAToNPVopfeil8Cb6/lIiMFrX/9KoV1C4OtOBQFuPOop2A9rbeYAe2i0Vt6hL0VrT2VuzzgO4c/67vrr6++n8XYCFRDlWW7KM3KIZeg1vAqAGDW3KsX24ZxP/UK6eBkwfS54mF0a+CThamAWgkh2N7PTsFN75bRogKcyJ7KqRUZwWwgQ8LsMkADoYNIaCLQI0CHe03908D/hYXm2AqpAFFw0w8rMAYrzsKu2n8O2fNIBxVXH0VIYLJswGg3SLTAAwrW61FQoO94kqdYr1NOs44NhShl0/MFQgOqUq3cObAAQnNGZOOCpVHO93sxIAVkiVjrqztOtI89sTgWBaXBd5FbsSHPLs06wEAD24psGwXDpXLg2QGOJj96exFB2jSvIlMgFApmpyXe5Wubhg3rp5HNCxBCIVt1ROK0R5Nes4gEdQRoMU5PLOoG2+W7IAnVy1sWPUPEn1L++7kucBxAwf+mGr+Ffv3awUYHCJKMCqwDrdK4KsJAKUBct2bjXCXLmO6NfwHgfsGKzbdpRiG1fpmazzAElBcOhj8Iaika2PyASA3G40qHOtFG61ZdF3sxIAxnSR5bRJRDekVwqWBEjd4INcI7D6wZnvmSRgENxkly5U/Oo/pcdreM8Dga6JcWzbxqFGiGKlAQvHNpQSYioS/arU6mnWccCSdLlTHuzjA13zfCMLYGJokG+RoEwwDO9KAzAJ2Y1Ifu00T62+UxMBbUjb8uwOp4e2SvF1mwSQYFK3LUOjJHai8Jms8wAzu62yLNEeVrbrcxrgvmCQuV1D75hk9ywL0OJUwipuZWr4seEBSgIG3kAdrlWgFjTzlaeb5wH3SZ7t7pvsoxRT4VYqIE2EBpe7OqRyqWb9rVlZAPHhYWGfUZJvvohMAGxU/QuqpKINBucyTAZwMVbWKonSANZ7Nw8DaktFpGyqM8nkzeRLKw34cX2AvT7AXr8A/AV2PZfr3CTzGQAAAABJRU5ErkJggg==",
            "status": "registered",
            "created_at": "2025-01-16T05:31:13.727825Z",
            "updated_at": "2025-01-16T05:31:19.610424Z",
            "payment_info": null
        }
    ]
}
Modificado em 2025-01-16 16:56:09
Página anterior
/brcode-payments/{id}
Próxima página
/pix-invoices
Built with