API Reference
Start typing to search…

Order

Eventos

Contexto order

Nome

Descrição

order.created

Enviado quando um pedido é criado.
Os possíveis status de order são: pending, zero_dollar, approved, denied, authorized, rejected.

order.updated

Enviado quando um link de pagamento é pago.
Os possíveis status de order são: approved, cancelled, expired, refunded, contested, charged_back.


Exemplo

Evento: order.created

{
  "context": "order",
  "event": "order.created",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-05-13T12:23:34.503Z",
  "version": "1",
  "data": {
    "id_order": "ord_uimyps0qg2fmer3ad4fscb",
    "id_merchant": "mer_TseqOuVj8LGUSq",
    "status": "approved",
    "type": "credit_card",
    "external_reference_id": "ef3f601e-e868-48dc-b618-947694a43d3c",
    "description": "laboriosam fugiat reiciendis",
    "customer": {
      "name": "Davi Lucca Oliveira",
      "document": "63303757046",
      "ip": "236.49.170.237"
    },
    "currency": "BRL",
    "amount": 1500,
    "amount_captured": 1500,
    "amount_refund": 0,
    "amount_installment": 1500,
    "installment_number": 1,
    "amount_interchange": 0,
    "mcc_code": null,
    "nsu_tef": "p8w67001cxyt",
    "nsu_acquirer": "655431",
    "nsu_cancellation": null,
    "card": {
      "brand": "visa",
      "first_digits": "476112",
      "last_digits": "0148",
      "exp_month": "12",
      "exp_year": "2031",
      "holder_name": "MILENA CAROLINA",
      "holder_document": "06949928017"
    },
    "soft_description": null,
    "authorization_code": "655431",
    "created_at": "2024-05-13T12:23:34.490535Z",
    "updated_at": "2024-05-13T12:23:34.490535Z",
    "completed_at": "2024-05-13T12:23:34.490535Z",
    "canceled_at": null,
    "establishment_id": "4e0ec338-b344-4dba-92d7-5cf4923408bc"
  }
}
{
  "context": "order",
  "event": "order.created",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-05-13T12:24:28.573Z",
  "version": "1",
  "data": {
    "id_order": "ord_ccoywt98jflhrlgvi29ino",
    "id_merchant": "mer_TseqOuVj8LGUSq",
    "status": "authorized",
    "type": "credit_card",
    "external_reference_id": "cc5197bd-51c9-4938-8815-fc618afe7072",
    "description": "deleniti aspernatur libero",
    "customer": {
      "name": "Antônio Batista",
      "document": "63303757046",
      "ip": "207.28.86.102"
    },
    "currency": "BRL",
    "amount": 1500,
    "amount_captured": 0,
    "amount_refund": 0,
    "amount_installment": 1500,
    "installment_number": 1,
    "amount_interchange": 0,
    "mcc_code": null,
    "nsu_tef": "lp1qtl6suqgd",
    "nsu_acquirer": "362012",
    "nsu_cancellation": null,
    "card": {
      "brand": "visa",
      "first_digits": "476112",
      "last_digits": "0148",
      "exp_month": "12",
      "exp_year": "2031",
      "holder_name": "MILENA CAROLINA",
      "holder_document": "06949928017"
    },
    "soft_description": null,
    "authorization_code": "362012",
    "created_at": "2024-05-13T12:24:28.562232Z",
    "updated_at": "2024-05-13T12:24:28.562232Z",
    "completed_at": null,
    "canceled_at": null,
    "establishment_id": "4e0ec338-b344-4dba-92d7-5cf4923408bc"
  }
}
{
  "context": "order",
  "event": "order.created",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-05-13T12:25:48.248Z",
  "version": "1",
  "data": {
    "id_order": "ord_ke9ko0ory8emnz1i6bcfad",
    "id_merchant": "mer_TseqOuVj8LGUSq",
    "status": "pending",
    "type": "pix",
    "external_reference_id": "772aed6d-c01c-4252-8fce-ee974943f4e1",
    "description": "adipisci sed ipsa",
    "customer": {
      "name": "Alessandra Barros",
      "document": "63303757046",
      "ip": "149.101.6.103"
    },
    "currency": "BRL",
    "amount": 1500,
    "amount_captured": 0,
    "amount_refund": 0,
    "amount_installment": 1500,
    "installment_number": 1,
    "amount_interchange": 0,
    "mcc_code": null,
    "nsu_tef": "itdtjjhpmdca",
    "nsu_acquirer": "a5abab02-79e6-4d29-9ed0-e2e41c5eeb94",
    "nsu_cancellation": null,
    "soft_description": null,
    "authorization_code": null,
    "pix": {
      "expiration": 60,
      "emv": "eyJpZCI6ICJhNWFiYWIwMi03OWU2LTRkMjktOWVkMC1lMmU0MWM1ZWViOTQiLCAiYW1vdW50IjogIjE1MDAiLCAiaXRlbXMiOiBbeyJpdGVtX3RpdGxlIjogIkNhbWlzZXRhIiwgInVuaXRfcHJpY2UiOiA1LjAsICJxdWFudGl0eSI6IDMsICJza3UiOiAiMDAwMDEiLCAidGl0bGUiOiAiQ2FtaXNldGEifV19"
    },
    "created_at": "2024-05-13T12:25:48.238717Z",
    "updated_at": "2024-05-13T12:25:48.238717Z",
    "completed_at": null,
    "canceled_at": null,
    "establishment_id": "4e0ec338-b344-4dba-92d7-5cf4923408bc"
  }
}

Evento: order.updated

{
  "context": "order",
  "event": "order.updated",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-05-13T12:32:50.565Z",
  "version": "1",
  "data": {
    "id_order": "ord_j68ikhkkved6j8zb6dy8kh",
    "id_merchant": "mer_TseqOuVj8LGUSq",
    "status": "refunded",
    "type": "credit_card",
    "external_reference_id": "2c93a8cc-d16c-47b2-8b30-3be78c140682",
    "description": "aspernatur maiores repellat",
    "customer": {
      "name": "Maitê Batista",
      "document": "63303757046",
      "ip": "108.126.42.32"
    },
    "currency": "BRL",
    "amount": 1500,
    "amount_captured": 1500,
    "amount_refund": 0,
    "amount_installment": 1500,
    "installment_number": 1,
    "amount_interchange": 0,
    "mcc_code": null,
    "nsu_tef": "d4uwk12uwg58",
    "nsu_acquirer": "655438",
    "nsu_cancellation": null,
    "card": {
      "brand": "visa",
      "first_digits": "476112",
      "last_digits": "0148",
      "exp_month": "12",
      "exp_year": "2031",
      "holder_name": "MILENA CAROLINA",
      "holder_document": "06949928017"
    },
    "soft_description": null,
    "authorization_code": "655438",
    "created_at": "2024-05-13T12:32:02.780599Z",
    "updated_at": "2024-05-13T12:32:49.152477Z",
    "completed_at": "2024-05-13T12:32:11.61722Z",
    "canceled_at": "2024-05-13T12:32:49.152477Z",
    "establishment_id": "4e0ec338-b344-4dba-92d7-5cf4923408bc"
  }
}
{
  "context": "order",
  "event": "order.updated",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-05-13T12:28:08.200Z",
  "version": "1",
  "data": {
    "id_order": "ord_ke9ko0ory8emnz1i6bcfad",
    "id_merchant": "mer_TseqOuVj8LGUSq",
    "status": "expired",
    "type": "pix",
    "external_reference_id": "772aed6d-c01c-4252-8fce-ee974943f4e1",
    "description": "adipisci sed ipsa",
    "customer": {
      "name": "Alessandra Barros",
      "document": "63303757046",
      "ip": "149.101.6.103"
    },
    "currency": "BRL",
    "amount": 1500,
    "amount_captured": 0,
    "amount_refund": 0,
    "amount_installment": 1500,
    "installment_number": 1,
    "amount_interchange": 0,
    "mcc_code": null,
    "nsu_tef": "itdtjjhpmdca",
    "nsu_acquirer": "a5abab02-79e6-4d29-9ed0-e2e41c5eeb94",
    "nsu_cancellation": null,
    "soft_description": null,
    "authorization_code": null,
    "pix": {
      "expiration": 60,
      "emv": "eyJpZCI6ICJhNWFiYWIwMi03OWU2LTRkMjktOWVkMC1lMmU0MWM1ZWViOTQiLCAiYW1vdW50IjogIjE1MDAiLCAiaXRlbXMiOiBbeyJpdGVtX3RpdGxlIjogIkNhbWlzZXRhIiwgInVuaXRfcHJpY2UiOiA1LjAsICJxdWFudGl0eSI6IDMsICJza3UiOiAiMDAwMDEiLCAidGl0bGUiOiAiQ2FtaXNldGEifV19"
    },
    "created_at": "2024-05-13T12:25:48.238717Z",
    "updated_at": "2024-05-13T12:28:08.188229Z",
    "completed_at": null,
    "canceled_at": null,
    "establishment_id": "4e0ec338-b344-4dba-92d7-5cf4923408bc"
  }
}
{
  "context": "order",
  "event": "order.updated",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-05-13T12:31:21.423Z",
  "version": "1",
  "data": {
    "id_order": "ord_lbh5bo9g1lrrmztnflh05p",
    "id_merchant": "mer_TseqOuVj8LGUSq",
    "status": "approved",
    "type": "pix",
    "external_reference_id": "6c6c62da-6722-42f7-8079-20cd8f07da35",
    "description": "adipisci ratione perspiciatis",
    "customer": {
      "name": "Felícia Carvalho",
      "document": "63303757046",
      "ip": "150.200.181.180"
    },
    "currency": "BRL",
    "amount": 1500,
    "amount_captured": 0,
    "amount_refund": 0,
    "amount_installment": 1500,
    "installment_number": 1,
    "amount_interchange": 0,
    "mcc_code": null,
    "nsu_tef": "3ir7io30d03n",
    "nsu_acquirer": "4740c9aa-fbf1-4bd0-9bb2-8f16ea697cd6",
    "nsu_cancellation": null,
    "soft_description": null,
    "authorization_code": null,
    "pix": {
      "expiration": 60,
      "emv": "eyJpZCI6ICI0NzQwYzlhYS1mYmYxLTRiZDAtOWJiMi04ZjE2ZWE2OTdjZDYiLCAiYW1vdW50IjogIjE1MDAiLCAiaXRlbXMiOiBbeyJpdGVtX3RpdGxlIjogIkNhbWlzZXRhIiwgInVuaXRfcHJpY2UiOiA1LjAsICJxdWFudGl0eSI6IDMsICJza3UiOiAiMDAwMDEiLCAidGl0bGUiOiAiQ2FtaXNldGEifV19"
    },
    "created_at": "2024-05-13T12:30:47.927601Z",
    "updated_at": "2024-05-13T12:31:21.410797Z",
    "completed_at": null,
    "canceled_at": null,
    "establishment_id": "4e0ec338-b344-4dba-92d7-5cf4923408bc"
  }
}