v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Estabelecimentos

Listar gateways do estabelecimento

get/v1/marketplace/establishments/{id}/gateways

Path parameters

idstring required

Query parameters

filtersstring
Example:{ "status": "CREATED" }

JSON com filtros.

searchstring
Example:Dado a se buscar

Texto de busca.

perPagenumber

Quantidade de registros por página.

pagenumber

Página.

sortersstring
Example:[ { "column": "created_at", "direction": "DESC" } ]

JSON com lista de ordenadores.

Headers

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Response

totalnumber required

Número total de registros.

pagenumber required

Página atual.

perPagenumber required

Número de registros por página.

lastPagenumber required

Número total de páginas.

Example response

{
  "data": [
    {
      "bank_account": {
        "account_check_digit": "1",
        "account_number": "123456",
        "routing_check_digit": "9",
        "routing_number": "1234",
        "type": "CHECKING",
        "bank": {
          "name": "Banco X",
          "code": "022",
          "ispb": "02318222"
        }
      },
      "spb_account": {
        "account_check_digit": "1",
        "account_number": "123456",
        "routing_check_digit": "9",
        "routing_number": "1234",
        "type": "CHECKING",
        "bank": {
          "name": "Banco X",
          "code": "022",
          "ispb": "02318222"
        }
      },
      "metadata": {
        "code": "123",
        "email": "user@mail.com",
        "token": "456",
        "statement_descriptor": "X Pagamentos"
      }
    }
  ]
}