Payment methods

Get payment method

GEThttps://api.zydon.com.br/api/sales/payment-methods/{id}

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

id*string

Response

200404500

OK

Body

application/json

idstring

namestring

typestring

minimum_valuenumber

maximum_valuenumber

has_online_payment_integrationboolean

activeboolean

attributesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/payment-methods/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 0,
  "maximum_value": 0,
  "has_online_payment_integration": false,
  "active": false
}

Update payment method

PUThttps://api.zydon.com.br/api/sales/payment-methods/{id}

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

id*string

Body

application/json

name*string

type*string

minimum_value*number

maximum_value*number

has_online_payment_integration*boolean

active*boolean

attributesobject

Response

200422500

PaymentMethod updated successfully

Body

application/json

id*string

name*string

type*string

minimum_value*number

maximum_value*number

has_online_payment_integration*boolean

active*boolean

attributesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/payment-methods/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "has_online_payment_integration": false,
      "maximum_value": 0,
      "minimum_value": 0,
      "name": "text",
      "type": "text"
    }),
});
const data = await response.json();

Response

200422500

{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 0,
  "maximum_value": 0,
  "has_online_payment_integration": false,
  "active": false
}

Delete payment method

DELETEhttps://api.zydon.com.br/api/sales/payment-methods/{id}

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

id*string

Response

204422500

PaymentMethod removed successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/payment-methods/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

204422500

{
  "id": "text"
}

Get payment methods

GEThttps://api.zydon.com.br/api/sales/payment-methods

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListPaymentMethodResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/payment-methods', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "minimum_value": 0,
      "maximum_value": 0,
      "has_online_payment_integration": false,
      "active": false
    }
  ]
}

Create payment method

POSThttps://api.zydon.com.br/api/sales/payment-methods

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Body

application/json

idstring

name*string

type*string

minimum_value*number

maximum_value*number

has_online_payment_integration*boolean

active*boolean

attributesobject

Response

201422500

PaymentMethod created successfully

Body

application/json

idstring

namestring

typestring

minimum_valuenumber

maximum_valuenumber

has_online_payment_integrationboolean

activeboolean

attributesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/payment-methods', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "has_online_payment_integration": false,
      "maximum_value": 0,
      "minimum_value": 0,
      "name": "text",
      "type": "text"
    }),
});
const data = await response.json();

Response

201422500

{
  "id": "text",
  "name": "text",
  "type": "text",
  "minimum_value": 0,
  "maximum_value": 0,
  "has_online_payment_integration": false,
  "active": false
}