Payments

Obter Pagamento do Pedido

get

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

order_idstringObrigatório

idstringObrigatório

Respostas

200

OK

application/json

404

Payment was not found

application/json

500

An internal server error was thrown

application/json

get

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

HTTPcURLJavaScriptPython

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,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Atualizar Pagamento do Pedido

put

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

order_idstringObrigatório

idstringObrigatório

Corpo

application/json

payment_method_idstringObrigatório

amountnumberObrigatório

installmentsinteger · int32Obrigatório

Respostas

200

Payment updated successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

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

HTTPcURLJavaScriptPython

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: 100

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

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

Remover Pagamento do Pedido

delete

Autorizações

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

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

422

A validation error was thrown

500

An internal server error was thrown

delete

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

HTTPcURLJavaScriptPython

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

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

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

OK

application/json

404

Payment was not found

application/json

500

An internal server error was thrown

application/json

get

/orders/{order_id}/payments

HTTPcURLJavaScriptPython

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,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Criar Pagamento do Pedido

post

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

order_idstringObrigatório

Corpo

application/json

idstringOpcional

payment_method_idstringObrigatório

amountnumberObrigatório

installmentsinteger · int32Obrigatório

installment_idstringOpcional

transaction_idstringOpcional

Respostas

201

Payment created successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/orders/{order_id}/payments

HTTPcURLJavaScriptPython

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: 160

{
  "id": "text",
  "payment_method_id": "text",
  "amount": 1,
  "installments": 1,
  "installment_id": "text",
  "transaction_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

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