DesenvolvedoresReferência da APIPedidos
Consultar pedido
GET
Traz os itens com as respostas dos campos de checkout, os pagamentos e os reembolsos do pedido.
Chave: Só chave secreta (chamada pelo servidor).
Escopo: orders:read.
chaveSecretaheader
AutorizaçãoBearer <chave de API>Chave secreta (sk_…). Use só no servidor; requisições de navegador (com Origin) são recusadas.
orderId*stringFormato
uuidSucesso.
application/json- response
data*meta*curl -X GET 'https://minepag.com.br/api/v1/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": -9007199254740991, "externalId": "string", "status": "pending", "paymentStatus": "pending", "source": "checkout", "environment": "sandbox", "currency": "BRL", "subtotal": -9007199254740991, "discountTotal": -9007199254740991, "total": -9007199254740991, "refundedTotal": -9007199254740991, "customer": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "name": "string" }, "metadata": { "property1": null, "property2": null }, "createdAt": "2019-08-24T14:15:22Z", "paidAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "cancelledAt": "2019-08-24T14:15:22Z", "refundedAt": "2019-08-24T14:15:22Z", "couponCode": "string", "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "priceId": "b245ceea-4bc7-4619-ae4c-559a1faf418e", "name": "string", "priceName": "string", "productType": "digital", "quantity": -9007199254740991, "unitAmount": -9007199254740991, "discountAmount": -9007199254740991, "totalAmount": -9007199254740991, "checkoutFields": [ { "key": "string", "label": "string", "value": "string" } ] } ], "payments": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5", "provider": "abacatepay", "method": "pix", "status": "pending", "amount": -9007199254740991, "refundedAmount": -9007199254740991, "currency": "BRL", "instructions": { "method": "pix", "copyPaste": "string", "qrCodeImage": "string", "expiresAt": "2019-08-24T14:15:22Z" }, "failureReason": "string", "dueAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "paidAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" } ], "refunds": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5", "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7", "amount": -9007199254740991, "status": "pending", "reason": "string", "initiatedBy": "merchant", "failureReason": "string", "processedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" } ] }, "meta": { "requestId": "string" }}