List Brazil Counterparties

This endpoint returns a paginated list of Brazil banking counterparties.

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
  Authorization: APIKey {YOUR_API_KEY}

Endpoint

GET

/api/v2/banking/counterparties/br

Query Parameters

Parameter	Type	Description
page	integer	Page number (default: 1).
limit	integer	Number of items per page (default: 100).
accountId	string (uuid)	Filter by account ID.
search	string	Optional. Search counterparties by name or reference.
currency	string	Optional. Filter by currency code.

Response Sample

{
  "total": 2,
  "page": 1,
  "limit": 100,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000004",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "reference": "BR-VENDOR-001",
      "currency": "BRL",
      "counterpartyName": "Ana Silva",
      "address": {
        "address1": "Rua Augusta 1500",
        "city": "Sao Paulo",
        "state": "SP",
        "postalCode": "01304-001",
        "country": "BR"
      },
      "pixKey": "1a717532-2ae7-4b11-b1bd-2ff5559f4d52",
      "pixKeyType": "EVP",
      "type": "individual",
      "bankAddress": {
        "address1": "Av. Paulista 1374",
        "city": "Sao Paulo",
        "state": "SP",
        "postalCode": "01310-100",
        "country": "BR"
      },
      "status": "active",
      "createdAt": "2023-01-05T00:00:00Z",
      "updatedAt": "2023-01-05T00:00:00Z"
    }
  ]
}

Support and Resources

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

• Instagram: BlockWyre Instagram
• Twitter: BlockWyre Twitter
• Facebook: BlockWyre Facebook
• LinkedIn: BlockWyre LinkedIn

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!