Payments

Obter Pagamento do Pedido

get

Authorizations

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

Path parameters

order_idstringrequired

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.zydon.com.br/api/sales/orders/{order_id}/payments/{id}' \
  --header 'Authorization: Bearer JWT'

200

404

500

200

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

OK

Atualizar Pagamento do Pedido

put

Authorizations

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

Path parameters

order_idstringrequired

idstringrequired

Body

payment_method_idstringrequired

amountnumberrequired

installmentsnumberrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.zydon.com.br/api/sales/orders/{order_id}/payments/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "payment_method_id": "text",
    "amount": 1,
    "installments": 1
  }'

200

422

500

200

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

Payment updated successfully

Remover Pagamento do Pedido

delete

Authorizations

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

Path parameters

order_idstringrequired

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.zydon.com.br/api/sales/orders/{order_id}/payments/{id}' \
  --header 'Authorization: Bearer JWT'

204

422

500

204

{
  "id": "text"
}

Payment removed successfully

Listar Pagamentos do Pedido

get

Authorizations

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

Path parameters

order_idstringrequired

Query parameters

searchstring · default: ""optional

pageinteger · int32 · default: 0optional

perPageinteger · int32 · default: 25optional

sortstring · default: ""optional

dirstring · default: "asc"optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.zydon.com.br/api/sales/orders/{order_id}/payments' \
  --header 'Authorization: Bearer JWT'

200

404

500

200

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

OK

Criar Pagamento do Pedido

post

Authorizations

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

Path parameters

order_idstringrequired

Body

idstringoptional

payment_method_idstringrequired

amountnumberrequired

installmentsnumberrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.zydon.com.br/api/sales/orders/{order_id}/payments' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "payment_method_id": "text",
    "amount": 1,
    "installments": 1
  }'

201

422

500

201

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

Payment created successfully