⚡
Zydon
Uptime serviços Zydon
  • Bem-vindo à Zydon
  • Quickstart
    • Chaves de acesso
    • Autenticação
  • Cadastros Gerais
    • Profiles
      • Import
      • Get import spreadsheet
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Companies
      • Import
      • Get import spreadsheet
    • Resource files
      • Details
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
  • Produtos
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Prices
      • Product
        • Calculate
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Discounts
      • Products
    • Price tables
      • Copy
      • Products
    • Warehouses
      • Import
      • Get import spreadsheet
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Portal User Search
      • User
        • Search
  • Pedidos
    • Payment groups
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Status
    • Coupons
      • Manual
      • Automatic
    • Sales
      • Statuses
        • Available
  • Financeiro
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
  • Webhooks
    • Sincronização de dados
    • Envio de Pedido
    • Cadastro de Parceiro
  • About
  • API reference
    • Warehouses
      • Import
      • Get import spreadsheet
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Status
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Profiles
      • Import
      • Get import spreadsheet
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Price tables
      • Copy
      • Products
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Payment groups
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
    • Discounts
      • Products
    • Coupons
      • Manual
      • Automatic
    • Companies
      • Import
      • Get import spreadsheet
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Sales
      • Statuses
        • Available
    • Resource files
      • Details
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Sales funnel
    • Template
      • Validate
      • Install
      • Export
    • Home
      • Sales
      • Sales by period
      • Products
      • Users
    • Prices
      • Product
        • Calculate
  • Specification
  • About
  • Specification
Fornecido por GitBook
Nesta página
  1. Pedidos

Payment methods

Delete payment method

delete
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
PaymentMethod removed successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
delete
DELETE /api/sales/payment-methods/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text"
}

Get payment methods

get
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
only_activebooleanOpcional
Respostas
200
OK
application/json
404
PaymentMethod was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/payment-methods HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "minimum_value": 1,
      "maximum_value": 1,
      "has_online_payment_integration": true,
      "active": true,
      "adjustment_rate": 1,
      "minimum_installment_value": 1,
      "vendor": "text",
      "rede_merchant_id": "text",
      "rede_merchant_key": "text",
      "cielo_merchant_id": "text",
      "cielo_merchant_key": "text",
      "getnet_merchant_id": "text",
      "getnet_merchant_key": "text",
      "getnet_merchant_seller_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}
  • GETGet payment method
  • PUTUpdate payment method
  • DELETEDelete payment method
  • GETGet payment methods
  • POSTCreate payment method

Get payment method

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
404
PaymentMethod was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/payment-methods/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "vendor": "text",
  "rede_merchant_id": "text",
  "rede_merchant_key": "text",
  "cielo_merchant_id": "text",
  "cielo_merchant_key": "text",
  "getnet_merchant_id": "text",
  "getnet_merchant_key": "text",
  "getnet_merchant_seller_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update payment method

put
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
namestringObrigatório
typestringObrigatório
minimum_valuenumberObrigatório
maximum_valuenumberObrigatório
has_online_payment_integrationbooleanObrigatório
activebooleanObrigatório
adjustment_ratenumberOpcional
minimum_installment_valuenumberOpcional
vendorstringOpcional
rede_merchant_idstringOpcional
rede_merchant_keystringOpcional
cielo_merchant_idstringOpcional
cielo_merchant_keystringOpcional
getnet_merchant_idstringOpcional
getnet_merchant_keystringOpcional
getnet_merchant_seller_idstringOpcional
Respostas
200
PaymentMethod updated successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
put
PUT /api/sales/payment-methods/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "id": "text",
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "vendor": "text",
  "rede_merchant_id": "text",
  "rede_merchant_key": "text",
  "cielo_merchant_id": "text",
  "cielo_merchant_key": "text",
  "getnet_merchant_id": "text",
  "getnet_merchant_key": "text",
  "getnet_merchant_seller_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Create payment method

post
Autorizações
Corpo
idstringOpcional
namestringObrigatório
typestringObrigatório
minimum_valuenumberObrigatório
maximum_valuenumberObrigatório
has_online_payment_integrationbooleanObrigatório
activebooleanObrigatório
adjustment_ratenumberOpcional
minimum_installment_valuenumberOpcional
vendorstringOpcional
rede_merchant_idstringOpcional
rede_merchant_keystringOpcional
cielo_merchant_idstringOpcional
cielo_merchant_keystringOpcional
getnet_merchant_idstringOpcional
getnet_merchant_keystringOpcional
getnet_merchant_seller_idstringOpcional
Respostas
201
PaymentMethod created successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
post
POST /api/sales/payment-methods HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "vendor": "text",
  "rede_merchant_id": "text",
  "rede_merchant_key": "text",
  "cielo_merchant_id": "text",
  "cielo_merchant_key": "text",
  "getnet_merchant_id": "text",
  "getnet_merchant_key": "text",
  "getnet_merchant_seller_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "has_online_payment_integration": true,
  "active": true,
  "adjustment_rate": 1,
  "minimum_installment_value": 1,
  "installments": [
    {
      "id": "text",
      "payment_method_id": "text",
      "sequence": 1,
      "installment_id": "text",
      "tax": 1,
      "discount": 1
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}