Orders

Server

Download schema

Orders

Create a wallet purchase or one-call order

GET

https://roamworks.tech

/v1/orders

Use a quoteId, or pass inline items with expectedTotalMinor. Requires Idempotency-Key.

Create a wallet purchase or one-call order › Responses

200

Purchases

A JSON object whose fields depend on the operation.

Success

Create a wallet purchase or one-call order

POST

https://roamworks.tech

/v1/orders

Use a quoteId, or pass inline items with expectedTotalMinor. Requires Idempotency-Key.

Create a wallet purchase or one-call order › Headers

Idempotency-Key

string · required

Create a wallet purchase or one-call order › Request Body

quoteId

string · uuid · required

reference

string · required

Create a wallet purchase or one-call order › Responses

Purchase

A JSON object whose fields depend on the operation.

Success

Get purchase and child orders

GET

https://roamworks.tech

/v1/orders/{id}

Status is processing, partially_fulfilled, completed, failed or cancelled.

Get purchase and child orders › path Parameters

id

string · uuid · required

Get purchase and child orders › Responses

Purchase

A JSON object whose fields depend on the operation.

Success

Redeem eSIMs

POST

https://roamworks.tech

/v1/orders/{id}/redeem

Create a redemption batch for up to 20 issued eSIMs.

Redeem eSIMs › path Parameters

id

string · uuid · required

Redeem eSIMs › Headers

Idempotency-Key

string · required

Redeem eSIMs › Request Body

format

string · enum

Enum values:

lpa

both

itemIds

string[]

Redeem eSIMs › Responses

Redemption batch

A JSON object whose fields depend on the operation.

Success

Quotes Wallet