Payment method

Obter Forma de Pagamento

GEThttps://api.zydon.com.br/api/sales/partners/{partner_id}/payment-method/{id}

Authorization

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

Path parameters

partner_id*string

id*string

Response

200404500

OK

Body

application/json

idstring

partner_idstring

payment_method_idstring

payment_method_namestring

payment_method_typestring

payment_method_min_valuenumber

payment_method_max_valuenumber

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "partner_id": "text",
  "payment_method_id": "text",
  "payment_method_name": "text",
  "payment_method_type": "text",
  "payment_method_min_value": 0,
  "payment_method_max_value": 0
}

Atualizar Formas de Pagamento

PUThttps://api.zydon.com.br/api/sales/partners/{partner_id}/payment-method/{id}

Authorization

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

Path parameters

partner_id*string

id*string

Body

application/json

idstring

payment_method_id*string

Response

200422500

Partner Payment Method updated successfully

Body

application/json

idstring

partner_idstring

payment_method_idstring

payment_method_namestring

payment_method_typestring

payment_method_min_valuenumber

payment_method_max_valuenumber

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners/{partner_id}/payment-method/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "payment_method_id": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "partner_id": "text",
  "payment_method_id": "text",
  "payment_method_name": "text",
  "payment_method_type": "text",
  "payment_method_min_value": 0,
  "payment_method_max_value": 0
}

Remover Forma de Pagamento

DELETEhttps://api.zydon.com.br/api/sales/partners/{partner_id}/payment-method/{id}

Authorization

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

Path parameters

partner_id*string

id*string

Response

204422500

Partner Payment Method removed successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

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

Response

204

{
  "id": "text"
}

Listar Formas de Pagamento

GEThttps://api.zydon.com.br/api/sales/partners/{partner_id}/payment-method

Authorization

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

Path parameters

partner_id*string

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListPartnerPaymentMethodResponse (object)

Request

JavaScriptCurlPython

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

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "partner_id": "text",
      "payment_method_id": "text",
      "payment_method_name": "text",
      "payment_method_type": "text",
      "payment_method_min_value": 0,
      "payment_method_max_value": 0
    }
  ]
}

Criar Forma de Pagamento

POSThttps://api.zydon.com.br/api/sales/partners/{partner_id}/payment-method

Authorization

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

Path parameters

partner_id*string

Body

application/json

id*string

payment_method_id*string

Response

201422500

Partner Payment Method created successfully

Body

application/json

idstring

partner_idstring

payment_method_idstring

payment_method_namestring

payment_method_typestring

payment_method_min_valuenumber

payment_method_max_valuenumber

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/partners/{partner_id}/payment-method', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "payment_method_id": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "partner_id": "text",
  "payment_method_id": "text",
  "payment_method_name": "text",
  "payment_method_type": "text",
  "payment_method_min_value": 0,
  "payment_method_max_value": 0
}