v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Payment Recipient

List Institutions

Recovers all created payment institutions

get/payments/recipients/institutions

Query parameters

pageSizenumber double

Page size for the paging request, default: 500

pagenumber double

Page number for the paging request, default: 1

namestring

Filter institutions by name

Response

Retrieve a list of all payment institutions

pagenumber double
totalnumber double
totalPagesnumber double

Example response

{
  "results": [
    {
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "name": "Banco J. Safra S.A.",
      "ispb": "03017677",
      "tradeName": "Banco Safra",
      "compe": "074",
      "createdAt": "2020-04-21T15:00:00.000Z",
      "updatedAt": "2020-04-21T15:00:00.000Z"
    }
  ]
}