Listar recebedores

GET

/v1/recipients

Lista, de forma paginada, os recebedores cadastrados pelo merchant autenticado, do mais recente para o mais antigo. Cada item traz o status de onboarding — o mesmo valor retornado por Consultar status do recebedor.

Para a referência completa dos status, veja Status do split de pagamentos.

Filtros

Os filtros são opcionais, enviados como query params, e podem ser combinados — o recebedor precisa atender a todos. Os documentos podem ser enviados com ou sem máscara.

Autorizações

bearerAuth

Token Bearer do merchant obtido via POST /oauth2/token usando as credenciais do merchant (não do app). Veja Autenticação.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Consulta

page

Página a ser retornada.

Tipo

integer

Exemplo1

Mínimo

1

Padrão

1

per_page

Quantidade de recebedores por página.

Tipo

integer

Exemplo20

Mínimo

1

Máximo

100

Padrão

20

email

E-mail da conta do recebedor (comparação exata).

Tipo

string

Exemplo"[email protected]"

Formato

"email"

recipient_document

CPF da conta do recebedor. Precisa ser um CPF válido.

Tipo

string

Exemplo"358.738.820-29"

recipient_company_document

Documento da empresa do recebedor. Aceita CNPJ ou, para empresas de pessoa física, CPF. Precisa ser um documento válido.

Tipo

string

Exemplo"97.761.238/0001-71"

Respostas

Recebedores retornados.

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"recipient_hash": "0a0c3269-b5fa-543b-b9ad-1cf27d0944c1",

  

  

  

"status": "Onboarding completed",

  

  

  

"account": {

  

  

  

  

"name": "Maria Souza",

  

  

  

  

"email": "[email protected]",

  

  

  

  

"cpf": "35873882029",

  

  

  

  

"phone": "11976187304"

  

  

  

},

  

  

  

"company": {

  

  

  

  

"name": "Souza Comércio LTDA",

  

  

  

  

"document_number": "97761238000171"

  

  

  

},

  

  

  

"created_at": "2026-10-01 14:32:10"

  

  

},

  

  

{

  

  

  

"recipient_hash": "5d25c7b6-a52d-54e7-85a8-8a17f6e2549e",

  

  

  

"status": "Awaiting face match completion",

  

  

  

"account": {

  

  

  

  

"name": "João Lima",

  

  

  

  

"email": "[email protected]",

  

  

  

  

"cpf": "52998224725",

  

  

  

  

"phone": "21988887777"

  

  

  

},

  

  

  

"company": {

  

  

  

  

"name": "João Lima",

  

  

  

  

"document_number": "52998224725"

  

  

  

},

  

  

  

"created_at": "2026-09-28 09:15:47"

  

  

}

  

],

  

"meta": {

  

  

"page": 1,

  

  

"pages": 1,

  

  

"total": 2,

  

  

"limit": 20

  

}

}

GET

/v1/recipients

Exemplos

Sandboxhttps://api.sandboxappmax.com.br

Authorization (Bearer)

Cole uma vez e use em todos os playgrounds — o token fica salvo somente nesta aba do navegador e é apagado quando ela for fechada.