Laravel SDK currency services

Use AvraAPI::currency() for the four released Currency operations. Every method returns ApiResponse; read the operation result from data and retain requestId for support and troubleshooting.

Every Currency operation supports the shared one-request privacy control: AvraAPI::currency()->withPrivacyMode()->getCodes(). It sends X-Privacy-Mode: 1 only for the next request, then clears automatically. Privacy Mode keeps normal routing, billing, and usage tracking while suppressing request and response payload storage.

The SDK trims and uppercases base and target before sending a request. They must still be active Currency codes. Call getCodes() rather than maintaining a hard-coded currency list.

Get supported currency codes

getCodes(): ApiResponse returns active Currency codes, including CBSL target codes when available. SDK function

Copy the SDK call

$response = AvraAPI::currency()->getCodes();

Read the active code list in a Laravel controller

<?php

use Avraapi\Laravel\Facades\AvraAPI;

// AvraAPI SDK call.
$response = AvraAPI::currency()->getCodes();

// Your application code.
$count = $response->data['count'];
$codes = $response->data['codes'];
$firstCode = $codes[0]['code'];
$requestId = $response->requestId;

Response

{
  "success": true,
  "request_id": "d57a5f8b-69bc-4877-8da7-31bb9dbfa575",
  "data": {
    "count": 169,
    "codes": [
      {"code": "AED", "name": "UAE Dirham"},
      {"code": "AFN", "name": "Afghan Afghani"},
      {"code": "ALL", "name": "Albanian Lek"}
    ]
  }
}

The API returns every active code; the sample list is shortened for readability. LKR-SELL, LKR-BUY, and LKR-CBSL are target-only CBSL codes, not ordinary base currencies. See CBSL Rates.

Get latest rates from one base currency

getLatestRates(string $base): ApiResponse returns the available rate map for one active base currency. The base is not repeated in data.rates. SDK function

Copy the SDK call

$response = AvraAPI::currency()->getLatestRates('BASE_CURRENCY');

Argument	Use
`base`	Active source currency, for example `USD`.

Read a rate map

<?php

use Avraapi\Laravel\Facades\AvraAPI;

// AvraAPI SDK call.
$response = AvraAPI::currency()->getLatestRates('usd');

// Your application code.
$base = $response->data['base'];
$eurRate = $response->data['rates']['EUR'];
$updatedAt = $response->data['last_updated'];

Response

{
  "success": true,
  "request_id": "882bc900-bd42-4286-a828-2594636245e6",
  "data": {
    "base": "USD",
    "last_updated": "2026-05-06T00:00:01.000000Z",
    "rates": {"AED": 3.6725, "AFN": 63.9347, "ALL": 82.0532}
  }
}

Treat last_updated as a freshness value, not a binding financial quote. Apply your own pricing, approval, and rounding rules before displaying a price.

Get one currency-pair rate

getPairRate(string $base, string $target): ApiResponse returns one rate. The target can be LKR-SELL, LKR-BUY, or LKR-CBSL for a CBSL rate type. SDK function

Copy the SDK call

$response = AvraAPI::currency()->getPairRate(
    'BASE_CURRENCY',
    'TARGET_CURRENCY',
);

Argument	Use
`base`	Active source currency, for example `USD`.
`target`	Active target currency, for example `LKR`.

Read one pair rate

<?php

use Avraapi\Laravel\Facades\AvraAPI;

// AvraAPI SDK call.
$response = AvraAPI::currency()->getPairRate('USD', 'LKR');

// Your application code.
$rate = $response->data['rate'];
$pair = $response->data['base'].'/'.$response->data['target'];
$updatedAt = $response->data['last_updated'];

Response

{
  "success": true,
  "request_id": "57ce6c72-5a8b-42c2-aa24-27f811c883ed",
  "data": {
    "base": "USD",
    "target": "LKR",
    "rate": 319.752,
    "last_updated": "2026-05-06 00:00:01"
  }
}

For CBSL target behaviour, read CBSL Rates.

Convert a currency amount

convert(string $base, string $target, float $amount): ApiResponse calculates the current conversion for one positive amount. SDK function

Copy the SDK call

$response = AvraAPI::currency()->convert(
    'BASE_CURRENCY',
    'TARGET_CURRENCY',
    10.0,
);

Argument	Use
`base`	Active source currency, for example `USD`.
`target`	Active target currency, for example `LKR`.
`amount`	Positive amount to convert.

Convert and use a positive amount

<?php

use Avraapi\Laravel\Facades\AvraAPI;

// AvraAPI SDK call.
$response = AvraAPI::currency()->convert('USD', 'LKR', 10.0);

// Your application code.
$convertedAmount = $response->data['conversion_result'];
$rateUsed = $response->data['rate'];
$display = sprintf(
    '%s %s = %s %s',
    $response->data['amount'],
    $response->data['base'],
    $convertedAmount,
    $response->data['target'],
);

Response

{
  "success": true,
  "request_id": "f6bd3df0-c642-446c-ba2b-345bbb3fd0e9",
  "data": {
    "base": "USD",
    "target": "LKR",
    "rate": 319.752,
    "amount": 10,
    "conversion_result": 3197.52,
    "last_updated": "2026-05-06 00:00:01"
  }
}

The result is an application calculation, not a settlement instruction or binding rate. See Convert a currency amount.

Handle Currency errors

Currency methods throw typed SDK exceptions instead of returning an error ApiResponse. Use the Laravel-safe exception pattern in Laravel Overview and setup and the linked REST pages for operation-specific error codes.

Introduction

PHP SDK (v1.5.2)

Laravel SDK (v1.2.0)

Node.js SDK (v1.2.0)

Laravel SDK currency services

Get supported currency codes

Response

Get latest rates from one base currency

Response

Get one currency-pair rate

Response

Convert a currency amount

Response

Handle Currency errors

​Get supported currency codes

​Response

​Get latest rates from one base currency

​Response

​Get one currency-pair rate

​Response

​Convert a currency amount

​Response

​Handle Currency errors

Get supported currency codes

Response

Get latest rates from one base currency

Response

Get one currency-pair rate

Response

Convert a currency amount

Response

Handle Currency errors