Issue a pass

POST

/v3/api/business/reseller/issued_passes

Creates a new client record and issues a pass to that client.

pass_id and client_id are required, and client_id must be unique per reseller.
transaction_id, first_name, last_name, and expiry_date are optional.
Duplicate transaction_id values are rejected.

Expiry behaviour by pass type:

Prepaid Passes: expiry is system-controlled and any partner-provided expiry_date is ignored.

Pay-as-You-Go Passes: expiry handling follows pay-as-you-go rules and expiry_date may be applied where relevant.

To find out whether your clients are on a pay-as-you-go or prepaid pass, reach out to your business relationship manager.

Idempotent — supply Idempotency-Key to safely retry.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

*/*

Pass issued successfully

Body*/*

🟠400

🟠401

🟠403

🟠404

🟠409

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v3/api/business/reseller/issued_passes' \
--header 'Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "pass_id": "pass_abc123",
    "client_id": "client_abc123",
    "transaction_id": "txn_abc123",
    "first_name": "Ada",
    "last_name": "Okafor",
    "expiry_date": "2026-12-31"
}'

Response Example

201 - Success

{
    "object": "issued_pass",
    "id": "brgpass_3b5d7f9a1c2e4f6b",
    "client_id": "client_abc123",
    "transaction_id": "txn_abc123",
    "tx_ref": "FLW-TXN-ABCDEFGH",
    "pass_id": "pass_premium_xyz",
    "pass_name": "Premium Wellness Pass",
    "passcode": "PASS5678",
    "status": "ACTIVE",
    "start_date": 1746700000000,
    "expires_at": 1777636800000,
    "categories": [
        {
            "type": "Gym",
            "duration": "MONTHLY",
            "visits_allowed": 4
        },
        {
            "type": "Spa",
            "duration": "MONTHLY",
            "credit_allocated": 20
        }
    ],
    "created": 1746700000000,
    "message": "Pass issued successfully"
}

Modified at 2026-05-21 13:30:24

Get All Reseller Passes

Update user's pass