Retrieve public metadata for the authenticated entity

GET

/entity-metadata

Returns lightweight public-facing metadata for the entity that owns the public API key used to authenticate the request. This endpoint is designed for client-side or storefront integrations — for example, a hosted checkout page that needs the entity's display name, logo, and checkout configuration without exposing sensitive entity data.

The entity is resolved entirely from the public key token; no id parameter is required. If the entity no longer exists (e.g. deleted after key issuance), the request returns 404.

checkout_settings is read from the checkout_settings app-setting-value configured at the entity level. If no value has been set yet, an empty object is returned rather than an error.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

Metadata for the entity was retrieved successfully.

Bodyapplication/json

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/entity-metadata' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Entity with logo and checkout settings configured

{
    "message": "Entity metadata retrieved successfully",
    "status": "success",
    "data": {
        "entity_id": "01JABC1234567890ABCDEFGHIJ",
        "entity_name": "Acme Corp Nigeria",
        "entity_logo": "https://assets.acmecorp.ng/logo.png",
        "checkout_settings": {
            "accepted_currencies": [
                "NGN",
                "USD"
            ],
            "redirect_url": "https://acmecorp.ng/payment/callback",
            "theme": {
                "primary_color": "#1a73e8"
            }
        }
    }
}

Modified at 2026-09-28 09:43:27

Set the selected entity

Create an entity sandbox session