show

GET 
/v1/orders/:id

show

Request

Path Parameters

id stringrequired
Example: :id

Responses

200

returns an order

application/json

Schema

Schema

id string
merchantobject
id string
acquirer_id string
name string
arabic_name string
merchant_id string
rule_precedence string
currency string
amount integer
captured_amount integer
refunded_amount integer
voided_amount integer
description string
created_at string
updated_at string
sourceobject
type string
issuer nullable
card_type nullable
category nullable
country_alpha2 nullable
scheme string
first_digits string
last_digits string
month integer
year integer
reauthorized_order_id nullable
airlineobject
reference string
sub_merchantobject
id string
registered_name string
trading_name string
email string
agreement nullable
transactions undefined[]

Example (from schema)

{
  "id": "string",
  "merchant": {
    "id": "string",
    "acquirer_id": "string",
    "name": "string",
    "arabic_name": "string",
    "merchant_id": "string",
    "rule_precedence": "string"
  },
  "currency": "string",
  "amount": 0,
  "captured_amount": 0,
  "refunded_amount": 0,
  "voided_amount": 0,
  "description": "string",
  "created_at": "string",
  "updated_at": "string",
  "source": {
    "type": "string",
    "scheme": "string",
    "first_digits": "string",
    "last_digits": "string",
    "month": 0,
    "year": 0
  },
  "airline": {
    "reference": "string"
  },
  "sub_merchant": {
    "id": "string",
    "registered_name": "string",
    "trading_name": "string",
    "email": "string"
  },
  "transactions": [
    null
  ]
}

Example

{
  "id": "0191fac6-a7d5-79a8-a2b0-5ddf43376a8d",
  "merchant": {
    "id": "0191fac6-a785-771a-b9c0-cb936687265c",
    "acquirer_id": "0191fac6-a73b-77a9-ab3e-93a3ac1bb135",
    "name": "Merchant 1",
    "arabic_name": "الإسم العربي",
    "merchant_id": "6001",
    "rule_precedence": "acquirer"
  },
  "currency": "SAR",
  "amount": 181845,
  "captured_amount": 0,
  "refunded_amount": 0,
  "voided_amount": 0,
  "description": "Sed iusto consequuntur culpa.",
  "created_at": "2024-09-16T12:20:08Z",
  "updated_at": "2024-09-16T12:20:08Z",
  "source": {
    "type": "card",
    "issuer": null,
    "card_type": null,
    "category": null,
    "country_alpha2": null,
    "scheme": "visa",
    "first_digits": "42424242",
    "last_digits": "4242",
    "month": 2,
    "year": 2025
  },
  "reauthorized_order_id": null,
  "airline": {
    "reference": "733546299445"
  },
  "sub_merchant": {
    "id": "b7506c083ecdb77a5a462fa1ee0425",
    "registered_name": "Rippin, Nienow and Johns",
    "trading_name": "O'Conner-Frami",
    "email": "lupe.reilly@veum.test"
  },
  "agreement": null,
  "transactions": []
}

401

returns unauthorized

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Missing authentication information"
}

403

returns forbidden

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Unauthorized"
}

Loading...