UPG Errors

use Avraapi\Laravel\Facades\AvraAPI;

$availability = AvraAPI::payment()->availability();

if (! $availability->isReady()) {
    // Safe to use in a browser response: no credentials or Vault data exist here.
    return [
        'checkout_available' => false,
        'reason' => $availability->reason?->value,
        'message' => $availability->message,
    ];
}

// Use only methods where the server says available.
$methods = array_filter(
    $availability->methods,
    static fn ($method): bool => $method->isAvailable(),
);

const availability = await client.payment().availability();

if (!availability.isReady()) {
  return {
    checkout_available: false,
    reason: availability.reason,
    message: availability.message,
  };
}

const methods = availability.methods.filter((method) => method.available);

use Avraapi\Laravel\Facades\AvraAPI;

use Avraapi\Apix\Exceptions\ApixException;
use Avraapi\Apix\Exceptions\ApixNetworkException;
use Avraapi\Apix\Exceptions\ApixRateLimitException;
use Avraapi\Apix\Exceptions\ApixServiceUnavailableException;
use Avraapi\Apix\Exceptions\PaymentAccessException;
use Avraapi\Apix\Exceptions\PaymentConfigurationException;
use Avraapi\Apix\Exceptions\PaymentProviderException;

try {
    $session = AvraAPI::payment()->createOrder($options);
} catch (PaymentAccessException | PaymentConfigurationException $exception) {
    // Log $exception->getRequestId() on the backend.
    return ['checkout_available' => false, 'retry' => false];
} catch (ApixRateLimitException | ApixServiceUnavailableException $exception) {
    return ['checkout_available' => false, 'retry' => true];
} catch (ApixNetworkException $exception) {
    // The provider/session outcome is unknown. Reconcile the pending merchant order first.
    return ['checkout_available' => false, 'retry' => false];
} catch (PaymentProviderException $exception) {
    return ['checkout_available' => false, 'retry' => false];
} catch (ApixException $exception) {
    return ['checkout_available' => false, 'retry' => false];
}

import {
  ApixError, ApixNetworkError, ApixRateLimitError, ApixServiceUnavailableError,
  PaymentAccessError, PaymentConfigurationError, PaymentProviderError,
} from '@avraapi/node-sdk';

try {
  const session = await client.payment().createOrder(options);
} catch (error) {
  if (error instanceof PaymentAccessError || error instanceof PaymentConfigurationError) {
    return { checkout_available: false, retry: false };
  }
  if (error instanceof ApixRateLimitError || error instanceof ApixServiceUnavailableError) {
    return { checkout_available: false, retry: true };
  }
  if (error instanceof ApixNetworkError || error instanceof PaymentProviderError || error instanceof ApixError) {
    // Preserve the pending order and reconcile before another checkout attempt.
    return { checkout_available: false, retry: false };
  }
  throw error;
}

use Avraapi\Laravel\Facades\AvraAPI;

use Avraapi\Apix\Payments\PaymentStatus;

$result = AvraAPI::payment()->completePayment($completionOptions);

if ($result->verified && $result->paymentStatus === PaymentStatus::Succeeded) {
    // Fulfil exactly once in your own order store.
} elseif (in_array($result->paymentStatus, [PaymentStatus::Pending, PaymentStatus::Unknown], true)) {
    // Keep the order pending. Inspect only the safe reconciliation metadata.
    $retryRecommended = (bool) ($result->reconciliation['retry_recommended'] ?? false);
} else {
    // Failed or cancelled: do not fulfil.
}

import { PaymentStatus } from '@avraapi/node-sdk';

const result = await client.payment().completePayment(completionOptions);

if (result.verified && result.paymentStatus === PaymentStatus.Succeeded) {
  // Fulfil exactly once in your own order store.
} else if ([PaymentStatus.Pending, PaymentStatus.Unknown].includes(result.paymentStatus)) {
  // Keep the order pending. Inspect only safe reconciliation metadata.
  const retryRecommended = result.reconciliation.retry_recommended === true;
} else {
  // Failed or cancelled: do not fulfil.
}