Payments

Obter Pagamento do Pedido

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

order_idstringObrigatório

idstringObrigatório

Respostas

200

application/json

idstringOpcional

order_idstringOpcional

payment_method_idstringOpcional

amountnumberOpcional

installmentsnumberOpcional

404

Payment was not found

application/json

500

An internal server error was thrown

application/json

get/orders/{order_id}/payments/{id}

GET /api/sales/orders/{order_id}/payments/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Atualizar Pagamento do Pedido

put

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

order_idstringObrigatório

idstringObrigatório

Corpo

payment_method_idstringObrigatório

amountnumberObrigatório

installmentsnumberObrigatório

Respostas

200

Payment updated successfully

application/json

idstringOpcional

order_idstringOpcional

payment_method_idstringOpcional

amountnumberOpcional

installmentsnumberOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/orders/{order_id}/payments/{id}

PUT /api/sales/orders/{order_id}/payments/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

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

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

Remover Pagamento do Pedido

delete

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

order_idstringObrigatório

idstringObrigatório

Respostas

204

Payment removed successfully

application/json

idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete/orders/{order_id}/payments/{id}

DELETE /api/sales/orders/{order_id}/payments/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text"
}

Listar Pagamentos do Pedido

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

order_idstringObrigatório

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

application/json

idstringOpcional

order_idstringOpcional

payment_method_idstringOpcional

amountnumberOpcional

installmentsnumberOpcional

404

Payment was not found

application/json

500

An internal server error was thrown

application/json

get/orders/{order_id}/payments

GET /api/sales/orders/{order_id}/payments HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Criar Pagamento do Pedido

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

order_idstringObrigatório

Corpo

idstringOpcional

payment_method_idstringObrigatório

amountnumberObrigatório

installmentsnumberObrigatório

Respostas

201

Payment created successfully

application/json

idstringOpcional

order_idstringOpcional

payment_method_idstringOpcional

amountnumberOpcional

installmentsnumberOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/orders/{order_id}/payments

POST /api/sales/orders/{order_id}/payments HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

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

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