Payments

Obter Pagamento do Pedido

GEThttps://api.zydon.com.br/api/sales/orders/{order_id}/payments/{id}

Authorization

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

Path parameters

order_id*string

id*string

Response

200404500

OK

Body

application/json

idstring

order_idstring

payment_method_idstring

amountnumber

installmentsnumber

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "order_id": "text",
  "payment_method_id": "text",
  "amount": 0,
  "installments": 0
}

Atualizar Pagamento do Pedido

PUThttps://api.zydon.com.br/api/sales/orders/{order_id}/payments/{id}

Authorization

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

Path parameters

order_id*string

id*string

Body

application/json

payment_method_id*string

amount*number

installments*number

Response

200422500

Payment updated successfully

Body

application/json

idstring

order_idstring

payment_method_idstring

amountnumber

installmentsnumber

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "order_id": "text",
  "payment_method_id": "text",
  "amount": 0,
  "installments": 0
}

Remover Pagamento do Pedido

DELETEhttps://api.zydon.com.br/api/sales/orders/{order_id}/payments/{id}

Authorization

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

Path parameters

order_id*string

id*string

Response

204422500

Payment removed successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

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

Response

204

{
  "id": "text"
}

Listar Pagamentos do Pedido

GEThttps://api.zydon.com.br/api/sales/orders/{order_id}/payments

Authorization

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

Path parameters

order_id*string

Query parameters

Response

200404500

OK

Body

application/json

idstring

order_idstring

payment_method_idstring

amountnumber

installmentsnumber

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "order_id": "text",
  "payment_method_id": "text",
  "amount": 0,
  "installments": 0
}

Criar Pagamento do Pedido

POSThttps://api.zydon.com.br/api/sales/orders/{order_id}/payments

Authorization

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

Path parameters

order_id*string

Body

application/json

idstring

payment_method_id*string

amount*number

installments*number

Response

201422500

Payment created successfully

Body

application/json

idstring

order_idstring

payment_method_idstring

amountnumber

installmentsnumber

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/orders/{order_id}/payments', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 0,
      "installments": 0,
      "payment_method_id": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "order_id": "text",
  "payment_method_id": "text",
  "amount": 0,
  "installments": 0
}