Find all

GET

/api/user/payees/bank

Este endpoint permite consultar as contas bancárias cadastradas para o recebedor autenticado.

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/payees/bank

Content-Type: application/json

Autenticação: api_token

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	AtivoB2B/1.0	Sim

Request

Header Params

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/user/payees/bank' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'

Response Example

200 - Success

{
  "status": 200,
  "message": "Os recebedores foram listados com sucesso",
  "data": {
    "data": [
      {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "gatewayId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "sellerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "bankName": "Banco XX",
        "bankCode": "000",
        "agency": "00000",
        "account": "000000000000",
        "digit": "00",
        "status": "ACTIVE",
        "type": "CHECKING",
        "createdAt": "2025-04-14T14:21:15.247Z",
        "updatedAt": "2025-04-14T14:21:15.247Z"
      },
      {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "gatewayId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "sellerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "bankName": "Banco YY",
        "bankCode": "000",
        "agency": "00000",
        "account": "000000000000",
        "digit": "00",
        "status": "INACTIVE",
        "type": "CHECKING",
        "createdAt": "2025-04-14T14:20:53.187Z",
        "updatedAt": "2025-04-14T14:21:15.250Z"
      }
    ],
    "pages": 2,
    "page": 1,
    "limit": 10,
    "total": 16
  },
  "error": null
}

Modified at 2025-07-23 19:02:40

Create

Find by ID

Find all

✅ Requisitos da Requisição#

🧠 Header da requisição#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição