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

Create Layout

POST
/api/user/checkout/create-layout

🎨 Criar Layout de Checkout#

Este endpoint permite criar um novo layout personalizado para o checkout. A requisição deve ser feita utilizando o método POST, com os dados enviados no formato multipart/form-data.

✅ Requisitos da Requisição#

Método HTTP: POST
Endpoint: /api/user/checkout/create-layout
Content-Type: multipart/form-data
Autenticação: api_token

🧠 Header da requisição#

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

📥 Body da Requisição#

ParâmetroTipoObrigatórioDescrição
primaryColorstringSimA cor primária do layout do checkout
statusstringSimO status do layout do checkout
typographystringSimO tipo de fonte do layout do checkout
logofile ($binary)NãoO logo do layout do checkout (arquivo)

Request

Header Params

Body Params application/json

Examples

Responses

🟢201Created
application/json
Body

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/user/checkout/create-layout' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "primaryColor ": "string",
    "status": "string",
    "typography ": "string",
    "logo": "string"
}'
Response Response Example
201 - Success
{
  "status": 201,
  "message": "O layout do checkout foi criado com sucesso",
  "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"
  },
  "error": null
}
Modified at 2025-07-23 19:02:40
Previous
Summary by ID
Next
Find
Built with