Developers
REST API
GuidesErrorsLogin
Get API Keys
API Navigation
  • Overview
  • Quick start
  • Authentication
  • Collect a payment
  • Payment status
  • Refunds
  • Testing
  • Production
  • Security
API reference
  • Create API keys POST
  • List API keys GET
  • Get API key GET
  • Delete API key DEL
  • Collect with MTN POST
  • MTN payment status GET
  • Collect with Airtel POST
    Create and pay
  • Create order POST
  • Order fee POST
  • Pay order with card POST
  • Pay order with bank POST
    • Status and verify
  • Order status POST
  • Verify order POST
    • Cards and tokens
  • Save card POST
  • Tokenize charge GET
    • Refunds
  • Refund order POST
    • Lists and stats
  • List orders GET
  • Get order GET
  • List banks GET
  • Order stats GET
  • List transactions GET
  • Get transaction GET
  • Transaction statuses GET
Errors and limits
  1. Docs
  3. API reference
  5. Get API key

Get API key

Read one API key config. The key in the path must match x-api-key.

OpenAPI SpecRun in Postman
GET/developer/gatewayConfigs/:apiKeyAPI
Authentication:API key and secret•x-api-key: <your-key>(Bearer token for server-to-server API calls)
Requires x-api-key and x-api-secret headers. The path apiKey must match x-api-key.
Required Headers
x-api-keystring
Gateway API key created while signed in.
x-api-secretstring
Secret returned once when the gateway key is created.

Request Parameters

FieldTypeRequiredDescription
apiKeystringRequiredPublic API key identifier matching the x-api-key header.
import axios from "axios";

const url = "https://payment-service-mh2d.onrender.com/api/developer/gatewayConfigs/:apiKey";

const headers = {
    "x-api-key": process.env.ZIBA_API_KEY,
    "x-api-secret": process.env.ZIBA_API_SECRET,
};

try {
  const response = await axios.get(url, {
    headers,
    timeout: 15000,
  });
  console.log("Success:", response.status, response.data);
} catch (error) {
  console.error("Request failed:", error.response?.data || error.message);
}
Auth guide

Response fields

FieldTypePresenceDescription
idstringAlways returnedGateway configuration ID.
apiKeystringAlways returnedPublic API key identifier.
namestringAlways returnedDescriptive label assigned to this key.
descriptionstringAlways returnedEnvironment or usage description.
userIdstringAlways returnedOwning merchant account ID.

Status codes

HTTP StatusMeaning
200The API key config payload, without plaintext apiSecret.
401Missing or invalid API key or secret. { status: "fail", message }.
404Path key does not match the authenticated key.

Related

Create API keysList API keys
Was this page helpful?

Let us know how we can make our API documentation better.

PreviousList API keys
NextDelete API key