Orders / API v1

Get an order

GET/api/partner/v1/orders/{orderId}

Owning partner order. Credentials are terminal-only.

Authentication

Authorization: Bearer <PARTNER_API_KEY>

Keys, environments, and IP policy

Path parameters

orderIdstringrequired: uuid

Response

Owning partner order. Credentials are terminal-only.

Cache-Control no-store

dataobjectrequired

Show fields

orderobjectrequired

Show fields

orderIdstringrequired

uuid

partnerReferencestringrequired

statusstringrequired

"PROCESSING" · "COMPLETED" · "FAILED"

totalMinorintegerrequired

int64 · min: 1 · max: 9007199254740991

currencystringrequired

"SAR"

skustringrequired

productNameArstringrequired

productNameEnstringrequired

chargedPriceMinorintegerrequired

int64 · min: 1 · max: 9007199254740991

chargedCurrencystringrequired

"SAR"

faceValuestring | nullrequired

Frozen original provider denomination when supplied, not the charged SAR price. SKU-only OneCard orders may return null.

faceValueCurrencystring | nullrequired

Paired with faceValue; both fields are null when denomination metadata is unavailable.

min length: 3 · max length: 3

supportReferencestring | nullrequired

pollAfterSecondsinteger | nullrequired

Always non-null while status is PROCESSING, including manual review.

min: 1

createdAtstringrequired

date-time

updatedAtstringrequired

date-time

completedAtstring | nullrequired

date-time

howToUseArstringrequired

howToUseEnstringrequired

credentialsobject | nullrequired

Null until fulfillment completes; populated credentials match OrderCredentials.

Show fields

serialstring | nullrequired
pinstring | nullrequired
usernamestring | nullrequired

requestIdstringrequired

errorobject | nullrequired

null

Need help with your integration?Talk to the GiftU team