APG PayAPG Paydocs

Orders

Get order

GET/orders/{orderId}
Request
GEThttps://api.tst.au.apgpay.dev/orders/{orderId}
curl -X GET https://api.tst.au.apgpay.dev/orders/{orderId} \
  -H "Authorization: Bearer $API_KEY"

Return one order.

Permissions

Required permission
orders:query

Requires the `query` action on `orders` for the supplied runtime context

Path parameters

orderIdstring
required

Responses

The response is a tagged shape: type is always "OrdrViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "OrdrViewAttributes"
orderIdOrdrIdrequired

Identifier of an order.

Example ordr_9f2Kd8QpLzXw

merchantIdMchtIdrequired

Identifier of a merchant.

Example mcht_9f2Kd8QpLzXw

marketplaceIdMktpId

The marketplace the merchant trades under, where it does.

Example mktp_9f2Kd8QpLzXw

Who is paying.

statusOrdrStatusrequired
CreatedAcceptedPaidCancelledFulfilledReturnedUnknown
orderTypeOrdrTyperequired

What kind of order this is.

OnlineManualInvoiceUnknown

The amounts on an order. All are in the single currency given here.

The product lines on the order.

descriptionstring

Where the goods go. Absent unless your credential may read order PII.

Who is paying, and where. Absent unless your credential may read order PII.

settlementOrdrSettlement

Whether payments for this order use real-time settlement.

DefaultStandardRealtimePreferredRealtimeRequiredUnknown
request3DSOnPaymentbooleanrequired

Whether a 3DS challenge is required when this order is paid.

Example true

emailCustomerReceiptbooleanrequired

Whether the payer is emailed a receipt.

Example true

referenceOrderIdstringrequired

Your own reference for this order. Required at creation, so always present.

Example your-own-reference

metadatamap of any JSON value

Free-form data. Absent unless your credential may read order PII.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "type": "OrdrViewAttributes",
  "orderId": "ordr_9f2Kd8QpLzXw",
  "merchantId": "mcht_9f2Kd8QpLzXw",
  "marketplaceId": "mktp_9f2Kd8QpLzXw",
  "customer": {
    "type": "OrdrCustomerAttributes",
    "name": "Ada Lovelace",
    "emailAddress": "ada@example.com",
    "phoneNumber": "+61400000000"
  },
  "status": "Created",
  "orderType": "Online",
  "amounts": {
    "type": "OrdrAmountsAttributes",
    "currency": "AUD",
    "total": 1250,
    "tax": 1250,
    "paid": 1250,
    "outstanding": 1250,
    "surcharge": 1250,
    "discount": 1250
  },
  "lineItems": [
    {
      "type": "OrdrLineItemInvoice",
      "description": "string",
      "unitCount": 12.5,
      "fee": 1250,
      "tax": 1250,
      "value": 1250,
      "category": "string",
      "notes": "string"
    }
  ],
  "description": "string",
  "shipping": {
    "type": "OrdrShippingAttributes",
    "name": "Ada Lovelace",
    "address": {
      "type": "OrdrAddressAttributes",
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "3000",
      "country": "AU"
    },
    "amount": 1250,
    "carrier": "string",
    "trackingNumber": "string",
    "phone": "+61400000000"
  },
  "billing": {
    "type": "OrdrBillingAttributes",
    "name": "Ada Lovelace",
    "address": {
      "type": "OrdrAddressAttributes",
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "3000",
      "country": "AU"
    },
    "phone": "+61400000000"
  },
  "settlement": "Default",
  "request3DSOnPayment": true,
  "emailCustomerReceipt": true,
  "referenceOrderId": "your-own-reference",
  "metadata": {
    "yourKey": {}
  },
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses