v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB

Payment Recipient

List

Recovers all created payment recipients

get/payments/recipients

Query parameters

pageSizenumber double

Page size for the paging request, default: 500

pagenumber double

Page number for the paging request, default: 1

isDefaultboolean

Filter connectors by the isDefault attribute. If not sent, it won't filter.

pixKeystring

Filter payment recipient by Pix key

namestring

Filter payment recipient by name

taxNumberstring

Filter payment recipient by tax number (CPF or CNPJ)

Response

Retrieve a list of all payment recipients

pagenumber double

totalnumber double

totalPagesnumber double

Example response

{
  "results": [
    {
      "type": "BANK_ACCOUNT",
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "name": "Conta empresa",
      "taxNumber": "12345678900",
      "paymentInstitution": {
        "id": "00000000-0000-0000-0000-000000000000",
        "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"
      },
      "account": {
        "branch": "0001",
        "number": "123456",
        "type": "CHECKING_ACCOUNT"
      },
      "isDefault": false,
      "pixKey": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}