List Pix Inflows

List incoming Pix payments for your partner users.

Endpoint

GET /partner/v1/pix-in

Request

Headers

Name	Type	Required	Description
X-API-Key	string	Yes	Your partner API key

Response

Success (200 OK)

{
  "pix_in": [
    {
      "amount_cents": 10000,
      "description": "Payment for services",
      "end_to_end_id": "E12345678202401011234abcdefghijkl",
      "method": "dict",
      "sender_name": "João Silva",
      "sender_tax_id": "12345678900",
      "sender_account_number": "12345",
      "sender_account_type": "checking",
      "sender_bank_code": "001",
      "sender_branch_code": "0001",
      "created_at": 1704067200,
      "last_updated_at": 1704067260,
      "status": "credited"
    }
  ]
}

Response fields

Field	Type	Description
amount_cents	integer	Payment amount in cents (BRL)
description	string	Payment description (optional)
end_to_end_id	string	Unique Pix transaction identifier
method	string	How the payment was initiated
sender_name	string	Sender’s name
sender_tax_id	string	Sender’s CPF/CNPJ
sender_account_number	string	Sender’s account number
sender_account_type	string	Type of sender’s account
sender_bank_code	string	Sender’s bank ISPB code
sender_branch_code	string	Sender’s branch code
created_at	integer	Unix timestamp of creation
last_updated_at	integer	Unix timestamp of last update
status	string	Current status of the inflow

Payment methods

Method	Description
manual	Manual bank transfer
dict	Using Pix key lookup
static_qr_code	Static QR code payment
dynamic_qr_code	Dynamic QR code payment
payer_qr_code	Payer-generated QR code
initiator	Payment initiator service

Account types

Type	Description
checking	Checking account
savings	Savings account
payment	Payment account
salary	Salary account

Inflow statuses

Status	Description
processing	Payment is being processed
approved	Payment approved by the bank
denied	Payment was denied
success	Payment completed successfully
credited	Funds credited to the user
failed	Payment failed

Example

curl https://api.bipa.tech/partner/v1/pix-in \
  -H "X-API-Key: your_partner_api_key"