v1

latestOpenAPI 3.0.3Apache 2.02026-07-24153058.9 KB
Order

Get Order Details

Retrieve details of a specific order.

get/api/v1/orders/{ref}

Path parameters

refstring required

Order reference.

Response

Order details retrieved successfully.

refstring required
status'PENDING' | 'AUTHORISED' | 'PAID' | 'CANCELLED' | 'DECLINED' required
cartIdstring

Example response

{
  "ref": "5B1F09D976B1FE66516E97D318ED5D8A57F3CF0078DC56ACA137A4ED356C663C",
  "status": "PENDING",
  "cartId": "a1b2c3d4",
  "amount": {
    "value": 1,
    "currency": "AED"
  },
  "customer": {
    "email": "someuser@test.com",
    "name": {
      "title": "Mr",
      "firstName": "Some",
      "lastName": "User"
    },
    "address": {
      "line1": "addr1",
      "line2": "addr2",
      "line3": "addr3",
      "city": "Dubai",
      "country": "AE"
    },
    "phone": "052858585"
  },
  "payment": {
    "status": "A",
    "message": "Authorised",
    "reference": "031111111111",
    "code": "091245"
  }
}