Listar recebedores
Recebedores
Listar recebedores
Lista paginada dos recebedores vinculados à sua conta, com filtro por e-mail ou documento.
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
API Key da Credential (gerada no Backoffice)
Query Parameters
Página da listagem. Padrão: 1.
Required range:
x >= 1Itens por página. Padrão: 20. Máximo: 100.
Required range:
1 <= x <= 100E-mail do recebedor. Correspondência exata, um valor por requisição — envie o endereço completo.
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