v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Consultar pedido

get/orders/{order_id}

Path parameters

order_idstring required

Identificador do pedido PagBank. Formato: ORDE_XXXXXXXXXXXX <br> Esse parâmetro você receberá na resposta da criação do pedido como id.

Headers

Authorizationstring

Token de autenticação. Deve ser enviado no formato Bearer <token>.

Response

200

idstring

reference_idstring

created_atstring

chargesobject[]

Example response

{
  "id": "ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328",
  "reference_id": "ex-00001",
  "created_at": "2020-11-21T23:23:22.69-03:00",
  "shipping": {
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "complement": "apto 12",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  },
  "items": [
    {
      "reference_id": "referencia do item",
      "name": "nome do item",
      "quantity": 1,
      "unit_amount": 500,
      "dimensions": {
        "length": 12,
        "width": 34,
        "height": 32
      },
      "weight": 100
    }
  ],
  "customer": {
    "name": "Jose da Silva",
    "email": "email@test.com",
    "tax_id": "12345678909",
    "phones": [
      {
        "country": "+55",
        "area": "11",
        "number": "999999999",
        "type": "MOBILE"
      }
    ]
  },
  "qr_code": [
    {
      "id": "QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74",
      "amount": {
        "value": 500
      },
      "text": "00020101021226600016BR.COM.PAGSEGURO013686FE511B-E945-4FE1-BB5D-297974C0DB7452048999530398654045.005802BR5922Rafael Gouveia Firmino6009SAO PAULO63049879",
      "links": [
        {
          "rel": "QRCODE.PNG",
          "href": "https://sandbox.api.pagseguro.com/qrcode/QRCO_86FE511B-E945-4FE1-BB5D-297974C0DB74/png",
          "media": "image/png",
          "type": "GET"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "SELF",
      "href": "https://sandbox.api.pagseguro.com/orders/ORDE_F87334AC-BB8B-42E2-AA85-8579F70AA328",
      "media": "application/json",
      "type": "GET"
    }
  ]
}