v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Fechar um pedido

Utilizado para fechar um pedido para que não seja mais possível adicionar cobranças.

patch/orders/{order_id}/closed

Path parameters

order_idstring required

Código do pedido.

Request body

statusstring required

Status final do pedido. Valores possíveis: paid, canceled ou failed. Caso não enviado, valor default será paid.

Response

200

idstring

codestring

amountinteger

currencystring

closedboolean

statusstring

created_atstring

updated_atstring

closed_atstring

Example response

{
  "id": "or_koMvlQOTMCb9dpPO",
  "code": "O8YDFPZUM3",
  "amount": 2990,
  "currency": "BRL",
  "closed": true,
  "items": [
    {
      "id": "oi_jkW1MBc9MtKdzK20",
      "description": "Bolinho de feijoada",
      "amount": 2990,
      "quantity": 1,
      "status": "active",
      "created_at": "2017-06-06T16:03:41Z",
      "updated_at": "2017-06-06T16:03:41Z"
    }
  ],
  "customer": {
    "id": "cus_mBloKMLnswtD4O3a",
    "name": "Carlos Peçanha",
    "email": "carlospecanha@outlook.com",
    "created_at": "2016-10-07T19:50:39Z",
    "updated_at": "2017-06-06T16:03:40Z",
    "metadata": {
      "company": "Mundipagg",
      "nome_da_mae": "Maria"
    }
  },
  "status": "paid",
  "created_at": "2017-06-06T16:03:40Z",
  "updated_at": "2017-06-06T16:03:40Z",
  "closed_at": "2017-06-06T16:03:47Z"
}