airtimeCreateOrder method

Future<AirtimeOrder?> airtimeCreateOrder(
  1. String idempotencyKey, {
  2. AirtimeOrderRequest? airtimeOrderRequest,
  3. Future<void>? abortTrigger,
})

Order airtime

Places an airtime top-up order and returns the accepted order. Takes the same body as quote and needs the manage order permission (403 / 10003 without it). An Idempotency-Key header with a new UUID is required for every purchase: a retry with the same key and body returns the order already accepted, 202 / 12002 with Retry-After while it is still being accepted, and a changed body gives 409 / 12001. The number's operator is looked up again, as in quote; item errors are named at items[i], and a current price above inputs.maxPrice gives 409 / 11002 before anything is charged. Track fulfillment with the order routes or the order.fulfillment.updated webhook.

Parameters:

  • String idempotencyKey (required): UUID idempotency key for safe retries of this operation.

  • AirtimeOrderRequest airtimeOrderRequest:

Implementation

Future<AirtimeOrder?> airtimeCreateOrder(String idempotencyKey, { AirtimeOrderRequest? airtimeOrderRequest, Future<void>? abortTrigger, }) async {
  final response = await airtimeCreateOrderWithHttpInfo(idempotencyKey, airtimeOrderRequest: airtimeOrderRequest, abortTrigger: abortTrigger,);
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AirtimeOrder',) as AirtimeOrder;

  }
  return null;
}