Get a top-up order by your own externalReference

GET

/api/v1/orders/topup/reference/{externalReference}

const url = 'https://api-omni.linra.net/api/v1/orders/topup/reference/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-omni.linra.net/api/v1/orders/topup/reference/example \
  --header 'Authorization: Bearer <token>'

Authorizations

partnerBearer

Parameters

Path Parameters

externalReference

required

string

Responses

200

The top-up order.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

orderId

string format: uuid

orderGlobalId

string

sagaId

string

partnerId

string format: uuid

partnerGlobalId

string

geoScopeGlobalId

string

externalReference

string

phoneNumber

string

amount

number format: decimal

currency

string

status

string

statusDetail

Product-specific status detail carried on Topup/eSIM order responses.

object

productType

string

statusCode

string

description

string

nullable

vendorOrderId

string

nullable

errorMessage

string

nullable

submittedAt

string format: date-time

completedAt

string format: date-time

nullable

currentRetryCount

integer

nextPollAt

string format: date-time

nullable

displayCurrency

string

nullable

rate

number

nullable

amountDisplay

number

nullable

Example

{
  "state": "SUCCESS",
  "payload": {
    "currency": "SAR",
    "statusDetail": {
      "productType": "Topup",
      "statusCode": "TOPUP_SUCCESS"
    }
  }
}

404

Unknown reference.

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

429

Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Retry-After

integer

Seconds to wait before retrying.