Get Order by Hash

Retrieves a public order view by its hashed ID. Useful for sharing order status with clients via a link without exposing the internal numeric ID.

GET /partner/orders/view/{hashedId}

Get order by public hash ID

cURL

curl --request GET \
  --url https://api.example.com/api/v1/partner/orders/view/{hashedId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 1001,
  "hashedId": "a3f7b2c1d4e5",
  "status": "CLIENTPAYMENTWAIT",
  "clientAmount": 1000,
  "exchangeAmount": 41500,
  "currency1": {
    "id": 123,
    "code": "USD"
  },
  "currency2": {
    "id": 123,
    "code": "UAH"
  },
  "cashbox": {
    "id": 1
  },
  "user": {
    "id": 1
  },
  "comment": "<string>",
  "clientComment": "<string>",
  "operationType": "offer",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Partner API key. Format: sk_branch_<32chars>, sk_personal_<32chars>, or pk_<32chars> (public, read-only)

Path Parameters

hashedId · string · required

The public hashed order identifier

Response

200

application/json

Order details

id · integer

Example:

1001

hashedId · string

Example:

"a3f7b2c1d4e5"

status · enum<string>

Available options: ORDERINIT, CLIENTPAYMENTWAIT, EXCHANGEPAYMENTWAIT, CASHOUT, SUCCESS, CANCEL

Example:

"CLIENTPAYMENTWAIT"

clientAmount · number

Example:

1000

exchangeAmount · number

Example:

41500

currency1 · object

Show child attributes

currency2 · object

Show child attributes

cashbox · object

A reference to another entity, identified by numeric ID

Show child attributes

user · object

A reference to another entity, identified by numeric ID

Show child attributes

comment · string | null

clientComment · string | null

operationType · enum<string>

Available options: offer, finop

createdAt · string<date-time>

updatedAt · string<date-time>