PHP SDK Universal API call

ApixClient::call() is the PHP SDK’s Universal Function. Use it only when a released provider route is not yet available through a typed service method. For a service that already has a typed method, such as Currency, Security, Location, SMS, or Utilities, use that typed method instead.

The Universal Function is for released provider routes. It is not a shortcut around the Universal Payment Gateway, payment completion, provider configuration, or browser-safety requirements.

SDK function

Copy the Universal Function signature

$response = $avraapi->call(
    method: 'GET_OR_POST',
    path: 'RELEASED_PROVIDER_ROUTE',
    payload: [],
);

Argument	Use
`method`	`GET` or `POST`, case-insensitive.
`path`	A released provider route in any supported path format.
`payload`	Optional query parameters for `GET`, or a JSON request body for `POST`.

The method returns ApiResponse|BinaryResponse. JSON responses expose their operation result through $response->data; image or binary-media responses use BinaryResponse, just as typed Utility methods do.

Use a typed service whenever it exists

The following two calls reach the same released Currency route. The typed method is clearer, validates its own inputs, and should be your default.

Preferred: typed SDK method

<?php

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

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

Universal Function: supported fallback

<?php

// AvraAPI SDK call. GET payload values become query parameters.
$response = $avraapi->call('GET', 'utility/currency/codes');

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

Send a released POST operation

Use an exact released route and its documented body fields. This example uses the public Security endpoint; normally, prefer $avraapi->security()->checkVpn() for the same operation.

POST through the Universal Function

<?php

// AvraAPI SDK call.
$response = $avraapi->call('POST', 'security/vpn-shield', [
    'ip' => '194.195.93.1',
]);

// Your application code.
$isVpn = $response->data['is_vpn'];
$requestId = $response->requestId;

Refer to the REST API Reference for the route’s request fields, response shape, billing rules, and error cases before using a new provider operation.

Path formats

The client normalises all of these forms before sending the request. Choose one consistent form for your application; a short relative route is usually the clearest.

Equivalent route paths

<?php

// Each call resolves to the configured AvraAPI base URL plus utility/currency/codes.
$avraapi->call('GET', 'utility/currency/codes');
$avraapi->call('GET', '/utility/currency/codes');
$avraapi->call('GET', '/api/v1/utility/currency/codes');
$avraapi->call('GET', 'https://avraapi.com/api/v1/utility/currency/codes');

The client removes a leading API version path and the host portion of a full URL, then uses the configured APIX_BASE_URL. This is useful when moving a verified route from the API Reference into your backend code.

Response handling

Use the returned type before consuming the output. Most provider routes return an ApiResponse; media routes can return BinaryResponse.

Handle a JSON or media result

<?php

use Avraapi\Apix\Responses\ApiResponse;
use Avraapi\Apix\Responses\BinaryResponse;

// AvraAPI SDK call. Use a released route and its documented payload.
$response = $avraapi->call('POST', 'utilities/qr/generate', [
    'data' => 'https://example.com/receipt/ORDER-001',
    'format' => 'png',
]);

// Your application code.
if ($response instanceof BinaryResponse) {
    $path = $response->saveAs(__DIR__.'/generated/receipt-qr.png');
} elseif ($response instanceof ApiResponse) {
    $data = $response->data;
}

Boundaries and safety

Do not use call() for payment initiation, payment completion, callbacks, gateway credentials, or any route that is not released in the public API Reference. Payment work uses the dedicated server-side payment() service.

call() sends the normal Project Client ID, Client Secret, and environment headers. It does not expose fluent withProvider() or withPrivacyMode() controls, so use the typed provider service when you need either of those one-request options.

Introduction

PHP SDK (v1.5.2)

Laravel SDK (v1.2.0)

Node.js SDK (v1.2.0)

PHP SDK Universal API call

SDK function

Use a typed service whenever it exists

Send a released POST operation

Path formats

Response handling

Boundaries and safety

Next steps

Provider service guides

REST API Reference

​SDK function

​Use a typed service whenever it exists

​Send a released POST operation

​Path formats

​Response handling

​Boundaries and safety

​Next steps

Provider service guides

REST API Reference

SDK function

Use a typed service whenever it exists

Send a released POST operation

Path formats

Response handling

Boundaries and safety

Next steps