API access by client type

The APIs you can call depend on your Azupay client type, your API key’s permissions and the services enabled for your account. This guide explains access for Distribution Partners, Technical and System Integration Partners, Merchants, Sub-Merchants and Sub-Accounts.

Using your API key

To make a request for your own account, supply your API key:

Authorization: <your-api-key>

To use a your account’s API key for an eligible child account, append the child client ID:

Authorization: <parent-api-key>,<child-client-id>

This is called delegated access. It must be enabled by Azupay, the selected account must be an enabled direct child, and the your key must permit the operation. See Acting on behalf of child accounts for requirements and examples.

The tables below describe requests made without a child client ID in the Authorization header. Endpoint paths are relative to the /v1 API base path.

📘

Permissions still apply

“Available” means your client type is eligible to use the endpoint. Your API key must grant permission for the operation, and the required services and account configuration must be enabled.

Distribution Partner (DP)

A DP can manage child clients and their child client's API keys, and use enabled account-check and enquiry services in its own account context.

MethodEndpointAccess
POST/clientsAvailable
GET/clients/{clientId}Available
DELETE/clients/{clientId}Available
POST/client/{clientId}/apiKeysAvailable
GET/client/{clientId}/apiKeysAvailable
GET/client/{clientId}/apiKeys/{apiKeyId}Available
PATCH/client/{clientId}/apiKeys/{apiKeyId}Available
POST/accountCheckAvailable
POST/accountEnquiryAvailable
POST/payIDEnquiryAvailable
VariousPayment and other transaction endpointsNot available

Technical and System Integration Partners (TIP/SIP)

TIP and SIP accounts can manage child clients and their API keys, and perform certain account and PayID enquiries in their own account context.

MethodEndpointAccess
POST/clientsAvailable
GET/clients/{clientId}Available
DELETE/clients/{clientId}Available
POST/client/{clientId}/apiKeysAvailable
GET/client/{clientId}/apiKeysAvailable
GET/client/{clientId}/apiKeys/{apiKeyId}Available
PATCH/client/{clientId}/apiKeys/{apiKeyId}Available
POST/accountCheckNot available
POST/accountEnquiryAvailable
POST/payIDEnquiryAvailable
VariousPayment and other transaction endpointsNot available
📘

Account Check API access

TIP and SIP accounts cannot call POST /accountCheck in their own account context. These requests return will return a 403 error.

To confirm eligibility or discuss access requirements, contact your Account Manager or raise a support ticket through the Service Desk linked in the developer portal.

Merchant

A Merchant uses its own API key for operations on its account. Approved Merchants can also provision Sub-Accounts through the Clients API.

The table groups related APIs. Each individual operation requires the relevant permissions.

Endpoint or API groupAccess
Payment Request APIsAvailable
Payment APIsAvailable
PayTo agreement and initiation APIsAvailable
Balance and reporting APIsAvailable
POST /accountCheckAvailable
POST /accountEnquiryAvailable
POST /payIDEnquiryAvailable
POST /clientsAvailable
Child API-key management endpointsNot available

Sub-Merchant

A Sub-Merchant uses its own API key for its enabled payment products and account operations.

Endpoint or API groupAccess
Payment Request APIsAvailable
Payment APIsAvailable
PayTo agreement and initiation APIsAvailable
Balance and reporting APIsAvailable
POST /accountCheckAvailable
POST /accountEnquiryAvailable
POST /payIDEnquiryAvailable
POST /clientsNot available
Child API-key management endpointsNot available

Sub-Account

A Sub-Account uses its own API key for operations on that Sub-Account. Available products and permissions depend on its configuration.

Endpoint or API groupAccess
Payment Request APIsAvailable
Payment APIsAvailable
PayTo agreement and initiation APIsAvailable
Balance and reporting APIsAvailable
POST /accountCheckAvailable
POST /accountEnquiryAvailable
POST /payIDEnquiryAvailable
POST /clientsNot available
Child API-key management endpointsNot available

If access is denied

Check that:

  • Your account and API key are enabled.
  • The key permits the requested method and endpoint.
  • Your client type is eligible for the operation.
  • The required services and account configuration are enabled.
  • You are using the correct account context.

Contact your Account Manager or raise a support ticket if you need help confirming your client type, endpoint eligibility or access configuration.


Did this page help you?