Skip to main content

Overview

The API suite offers a streamlined approach to operations, featuring key characteristics designed for optimal flexibility and integration:

  • Secure Authentication: Each API request requires a Bearer Token for authentication to ensure secure interactions. See Authentication.
  • Flexible Interaction Models: Supports both synchronous and asynchronous requests to accommodate different operational needs. See Design Principles.

Balances API​

Provide access to balance information across various currencies. Learn More

Products API​

Retrieve detailed listings of products, including specifications, pricing, availability, and other critical information necessary for product. Learn More

Ordering API​

Create new orders and retrieve past order information, providing a comprehensive order management process.

  • Create Bulk Order: Facilitates the creation of a new bulk order by specifying products and quantities. This API operates asynchronously; once the client submits a request, the API accepts the order immediately without initiating fulfillment. The fulfillment process occurs subsequently through asynchronous processing. Please be advised that there will be a waiting period for order fulfillment. Learn More
  • Create Instant Order: Facilitates the creation of a new order with one product and one quantity at a time. Once the API receives a client request, it immediately creates and fulfills the order. The API keeps the connection alive until the entire process is completed, which should be within 30 seconds. If the order and fulfillment process are completed within this timeframe, the API returns a transaction ID along with a COMPLETED status, allowing the client to retrieve a code from the GetCodes API. However, if the API is unable to complete the fulfillment process within 30 seconds, it returns a transaction ID with a PROCESSING status. The client is then responsible for polling the order status until a COMPLETED status is received. Learn More
  • Retrieve Orders: Allows you to retrieve an order list with pagination support. You can use it to check the latest status of specific orders. Learn More

Codes API​

Allows you to fetch codes that are ready for use within specific orders. As our system fulfills an order, codes will be progressively available for each individual product. You have the flexibility to fetch codes either partially as they become available or fully in a single request. Learn More