Skip to main content
GET
Listar recebedores
GET /recipients Faz parte do recurso recebedores — os conceitos e o objeto estão lá. Retorna a lista paginada dos recebedores vinculados à sua conta. Apenas recebedores do tipo merchant aparecem aqui.
Os dois filtros são exatos, e combiná-los é restritivo. email exige o endereço completo e document o CPF/CNPJ como foi cadastrado — valores parciais não retornam nada. Se você informar os dois e eles apontarem para recebedores diferentes, a lista volta vazia, em vez de trazer os dois.

Exemplo

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

page
integer
default:1

Página da listagem. Padrão: 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Padrão: 20. Máximo: 100.

Required range: 1 <= x <= 100
email
string<email>

E-mail do recebedor. Correspondência exata, um valor por requisição — envie o endereço completo.

document
string

CPF ou CNPJ do recebedor. Correspondência exata, um valor por requisição — envie exatamente como foi cadastrado, com ou sem pontuação.

Minimum string length: 11

Response

Lista paginada de recebedores

data
object[]

Lista de registros retornados na página atual.

pagination
object

Dados de paginação do resultado.