Bynet
  1. Layouts
Bynet
  • 🚀 Introdução à API
  • 📦 Criar Pedido
  • My company
    • Get all data
      GET
    • Update
      PUT
    • Update documents
      PUT
    • Get by ID
      GET
    • Update other info
      PUT
  • Products
    • Create
      POST
    • Find All
      GET
    • Find by ID
      GET
    • Update
      PUT
    • Delete
      DELETE
    • Update Status
      PUT
  • Bank
    • Create
      POST
    • Find all
      GET
    • Find by ID
      GET
    • Find pre bank
      GET
  • Transactions
    • Find All
    • Create
    • Find by ID
    • Update delivery status
    • Export Excel
    • Summary all
    • Fee
    • Summary by ID
  • Checkout
    • Layouts
      • Create Layout
        POST
      • Find
        GET
      • Update settings
        PUT
      • Update status
        PUT
      • Find by ID
        GET
    • Find info
      GET
    • Create Order
      POST
    • Find info order
      GET
    • Find payment methods by ID
      GET
    • Create payment
      POST
    • Find payment methods
      GET
  • Transfers
    • Create
    • Update
    • Find all
    • Find by ID
    • summary
  • Cashout
    • Create
    • Find all
    • Find by ID
  • Customers
    • Find all
    • Find by ID
  • Balance
    • Find
    • Summary
    • Find finalcial reserve
  • Webhook
    • ⚙️ Webhook: Formato de Postback
    • Create
    • Find all
    • Find by ID
    • Update
    • Delete
  1. Layouts

Find

GET
/api/user/checkout/layout
Este endpoint permite listar os layouts configurados no checkout com base em filtros e paginação. A requisição deve ser feita utilizando o método GET, com os parâmetros enviados via query string.

✅ Requisitos da Requisição#

Método HTTP: GET
Endpoint: /api/user/checkout/layout
Content-Type: application/json
Autenticação: api_token

🧠 Header da requisição#

CampoTipoObrigatórioDescrição
x-api-keystringSimToken de autenticação API Key
User-AgentAtivoB2B/1.0Sim

🔎 Parâmetros de Query (opcionais)#

ParâmetroTipoDescriçãoExemplo
limitstringA quantidade de registros que deseja buscar10
pagestringA página que deseja buscar1
valuestringO valor a ser pesquisado (ex: código de cor do layout)#000000
orderDirectionstringA direção da ordenação dos resultados (ASC ou DESC)desc
orderBystringO campo que será utilizado para ordenar os resultadosid
statusstringO status do layout. Valores possíveis: ACTIVE, INACTIVEACTIVE

Request

Query Params

Header Params

Responses

🟢200Success
application/json
Body

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/user/checkout/layout?limit=10&page=1&value=%23000000&orderDirection=desc&orderBy=id&status=ACTIVE' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'
Response Response Example
200 - Success
{
  "data": {
    "data": [
      {
        "id": "0",
        "primaryColor": "#000000",
        "typography": "MONTSERRAT",
        "logo": null,
        "type": "CUSTOM",
        "status": "ACTIVE",
        "createdAt": "2025-04-17T19:33:40.320Z",
        "updatedAt": "2025-04-17T19:33:40.320Z",
        "deletedAt": null,
        "sellerId": "0"
      },
      {
        "id": "0",
        "primaryColor": "#009FE3",
        "typography": "INTER",
        "logo": null,
        "type": "CUSTOM",
        "status": "ACTIVE",
        "createdAt": "2025-04-03T18:29:06.329Z",
        "updatedAt": "2025-04-03T18:29:06.329Z",
        "deletedAt": null,
        "sellerId": "0"
      },
      {
        "id": "0",
        "primaryColor": "#000000",
        "typography": "MONTESERRAT",
        "logo": {
          "id": "0",
          "key": "0.png",
          "url": "X"
        },
        "type": "DEFAULT",
        "status": "ACTIVE",
        "createdAt": "2025-03-26T21:51:28.253Z",
        "updatedAt": "2025-04-16T14:38:35.377Z",
        "deletedAt": null,
        "sellerId": "0"
      }
    ],
    "pages": 1,
    "page": 1,
    "limit": 10,
    "total": 3
  },
  "message": "Os layouts foram encontrados com sucesso",
  "status": 200,
  "error": null
}
Modified at 2025-07-23 19:02:40
Previous
Create Layout
Next
Update settings
Built with