Node.js SDK Universal API call

ApixClient.call() is the Node.js SDK Universal Function. Use it only when a released provider route is not yet available through a typed service method. For Currency, Security, Location, SMS, or Utilities operations that already have a typed method, use that 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

const response = await avraapi.call(
  'GET_OR_POST',
  'RELEASED_PROVIDER_ROUTE',
  {},
);

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 Promise<ApiResponse | BinaryResponse>. JSON responses contain their operation result in data; image and media responses use BinaryResponse, just as typed Utility methods do.

Use a typed service whenever it exists

These calls reach the same released Currency route. The typed method expresses intent more clearly and should be your default.

Preferred: typed SDK method

// AvraAPI SDK call.
const response = await avraapi.currency().getCodes();

// Your application code.
const codes = response.get('data.codes');

Universal Function: supported fallback

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

// Your application code.
const codes = response.get('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 security().checkVpn() for the same operation.

POST through the Universal Function

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

// AvraAPI SDK call.
const response = await avraapi.call('POST', 'security/vpn-shield', {
  ip: '194.195.93.1',
});

// Your application code.
if (response instanceof ApiResponse) {
  const isVpn = response.get('data.is_vpn');
  const requestId = response.requestId;
}

Read the REST API Reference for request fields, response shape, billing rules, and errors before calling a new provider route.

Path formats

The client normalises each path before sending it. Choose one consistent form; a short relative route is usually clearest.

Equivalent route paths

// Each call resolves to the configured base URL plus utility/currency/codes.
await avraapi.call('GET', 'utility/currency/codes');
await avraapi.call('GET', '/utility/currency/codes');
await avraapi.call('GET', '/api/v1/utility/currency/codes');
await 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.

Response handling

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

Handle a JSON or media result

import { ApiResponse, BinaryResponse } from '@avraapi/node-sdk';

// AvraAPI SDK call. Use a released route and documented payload.
const response = await avraapi.call('POST', 'utilities/qr/generate', {
  data: 'https://example.com/receipt/ORDER-001',
  format: 'png',
});

// Your application code.
if (response instanceof BinaryResponse) {
  await response.saveAs('./generated/receipt-qr.png');
} else if (response instanceof ApiResponse) {
  const data = response.data;
}

Boundaries and safety

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

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

Introduction

PHP SDK (v1.5.2)

Laravel SDK (v1.2.0)

Node.js SDK (v1.2.0)

Node.js 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