API Reference

This API reference consists of all the APIs provided by Clear Gate. The Clear Gate API can be interacted with using HTTPS requests to obtain certain information from Clear Gate.

Typically a JSON object including the required details will be returned except Widget API and Checkout API, which redirect your customer to Clear Gate for hosted checkout payment experience.

If you have any suggestions or confusion about our reference pages, please create an issue directly on our GitHub repository.

Digital Goods

Hosted widget flow for digital goods, virtual products, and package-driven checkout.

Endpoint

GET https://api.cleargatefinance.com/api/subscription

Parameters

Parameter	Type	Required	Description
key	string	yes	Clear Gate project key assigned to the widget.
uid	string	yes	Unique end-user identifier in the merchant system.
widget	string	yes	Widget code configured for the product or package.
email	string	no	Customer email used for receipts and support lookup.
sign	string	yes	Signature generated from the request parameters and secret key.

Sample Request

<?php
// Digital Goods
$endpoint = "https://api.cleargatefinance.com/api/subscription";
$payload = {
  "key" => "project_1001",
  "uid" => "user_10482",
  "widget" => "cg_widget_01",
  "email" => "buyer@example.com"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-dg",
  "title": "Digital Goods",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Tokidoki

Package and subscription management endpoints for Tokidoki-based widget products.

Sample Request

<?php
// Tokidoki
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki",
  "title": "Tokidoki",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Build Widget
List all current packages

Build Widget

Create a widget URL for a specific package or price configuration.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/widget-url

Parameters

Parameter	Type	Required	Description
key	string	yes	Clear Gate project key assigned to the widget.
uid	string	yes	Unique end-user identifier in the merchant system.
widget	string	yes	Widget code configured for the product or package.
email	string	no	Customer email used for receipts and support lookup.
sign	string	yes	Signature generated from the request parameters and secret key.

Sample Request

<?php
// Build Widget
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/widget-url";
$payload = {
  "uid" => "user_10482",
  "package_id" => "pkg_gold",
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-api",
  "title": "Build Widget",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current packages
Create new package

List all current packages

Return the packages currently available in the Tokidoki catalog.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/packages

Sample Request

<?php
// List all current packages
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/packages";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-package",
  "title": "List all current packages",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Show details a package
Create new package

Show details a package

Look up a single package by identifier.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/packages?package_id={package_id}

Parameters

Parameter	Type	Required	Description
package_id	string	yes	Package identifier in the Clear Gate package catalog.
project_key	string	yes	Project key passed in the `X-ApiKey` header.

Sample Request

<?php
// Show details a package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/packages?package_id={package_id}";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-detail_package",
  "title": "Show details a package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current packages
Update a package

Create new package

Create a new package entry for a widget-based product.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/create-package

Parameters

Parameter	Type	Required	Description
key	string	yes	Clear Gate project key assigned to the widget.
uid	string	yes	Unique end-user identifier in the merchant system.
widget	string	yes	Widget code configured for the product or package.
email	string	no	Customer email used for receipts and support lookup.
sign	string	yes	Signature generated from the request parameters and secret key.

Sample Request

<?php
// Create new package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/create-package";
$payload = {
  "package_id" => "pkg_gold",
  "amount" => 19.99,
  "currency" => "USD",
  "name" => "Gold Pack"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-create_new_package",
  "title": "Create new package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Update a package
Remove a package

Update a package

Update package pricing, metadata, or availability.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/update-package

Parameters

Parameter	Type	Required	Description
key	string	yes	Clear Gate project key assigned to the widget.
uid	string	yes	Unique end-user identifier in the merchant system.
widget	string	yes	Widget code configured for the product or package.
email	string	no	Customer email used for receipts and support lookup.
sign	string	yes	Signature generated from the request parameters and secret key.

Sample Request

<?php
// Update a package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/update-package";
$payload = {
  "package_id" => "pkg_gold",
  "amount" => 24.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-update_package",
  "title": "Update a package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Create new package
Remove a package

Remove a package

Delete or archive a Tokidoki package entry.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/remove-package

Parameters

Parameter	Type	Required	Description
package_id	string	yes	Package identifier in the Clear Gate package catalog.
project_key	string	yes	Project key passed in the `X-ApiKey` header.

Sample Request

<?php
// Remove a package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/remove-package";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-remove_package",
  "title": "Remove a package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Update a package
List all current packages

List all current subscriptions

Retrieve the current Tokidoki subscription set for the project.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?page={number_page}

Sample Request

<?php
// List all current subscriptions
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-list_subscriptions",
  "title": "List all current subscriptions",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Show details a subscription
Cancel a subscription

Show details a subscription

Inspect a single subscription by ID, subscriber email, or package ID.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?subscription_id={subscription_id}

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?subscriber_email={email}

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?package_id={package_id}

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Show details a subscription
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?subscription_id={subscription_id}";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-show_subscription_details",
  "title": "Show details a subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current subscriptions
Cancel a subscription

Cancel a subscription

Request cancellation for an existing widget subscription.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/cancel-subscription

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Cancel a subscription
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/cancel-subscription";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-cancel_subscription",
  "title": "Cancel a subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Show details a subscription
Remove pending cancel subscription

Change subscription's package

Move an active subscription to a different package.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/request-change-package

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Change subscription's package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/request-change-package";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-change_package_subscription",
  "title": "Change subscription's package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Remove change package request
Show details a subscription

Remove change package request

Rollback a pending package-change request for a subscription.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/remove-change-package

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Remove change package request
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/remove-change-package";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-remove_change_package",
  "title": "Remove change package request",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Change subscription's package
Show details a subscription

Remove pending cancel subscription

Undo a pending subscription cancellation request.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/remove-pending-cancel

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Remove pending cancel subscription
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/remove-pending-cancel";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-remove_pending_cancel",
  "title": "Remove pending cancel subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Cancel a subscription
Show details a subscription

List all current transactions

Retrieve Tokidoki transaction history.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/transactions

Sample Request

<?php
// List all current transactions
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/transactions";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-list_transactions",
  "title": "List all current transactions",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Show details a transaction
Reporting API

Show details a transaction

Inspect a transaction by ID or linked subscription ID.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/transactions?transaction_id={transaction_id}

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/transactions?subscription_id={subscription_id}

Transaction lookup

Field	Description
transaction_id	Clear Gate transaction identifier.
subscription_id	Linked subscription identifier.

Sample Request

<?php
// Show details a transaction
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/transactions?transaction_id={transaction_id}";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-show_details_transaction",
  "title": "Show details a transaction",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current transactions
Payment Status

Onetime payment

Hosted checkout flow for one-time purchases.

Endpoint

GET https://api.cleargatefinance.com/api/subscription

Parameters

Parameter	Type	Required	Description
uid	string	yes	Unique user identifier.
amount	number	yes	Purchase amount in the requested currency.
currency	string	yes	ISO currency code.
ag_name	string	yes	Product or subscription plan title shown in checkout.
sign	string	yes	Signed checksum for hosted checkout creation.

Sample Request

<?php
// Onetime payment
$endpoint = "https://api.cleargatefinance.com/api/subscription";
$payload = {
  "uid" => "user_10482",
  "amount" => 39.99,
  "currency" => "USD",
  "ag_name" => "Starter Plan"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "checkout-onetime",
  "title": "Onetime payment",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Subscription
Digital Goods

Subscription

Hosted checkout flow for recurring billing plans.

Endpoint

GET https://api.cleargatefinance.com/api/subscription

Parameters

Parameter	Type	Required	Description
uid	string	yes	Unique user identifier.
amount	number	yes	Purchase amount in the requested currency.
currency	string	yes	ISO currency code.
ag_name	string	yes	Product or subscription plan title shown in checkout.
sign	string	yes	Signed checksum for hosted checkout creation.

Sample Request

<?php
// Subscription
$endpoint = "https://api.cleargatefinance.com/api/subscription";
$payload = {
  "uid" => "user_10482",
  "amount" => 29.99,
  "currency" => "USD",
  "ag_name" => "Monthly Plan"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "checkout-subscription",
  "title": "Subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Onetime payment
Subscription

User Profile

Additional end-user data used to strengthen authorization and fraud decisions.

Parameters

Parameter	Type	Required	Description
email	string	recommended	User email used for fraud checks and receipts.
history[registration_date]	integer	recommended	Unix timestamp of end-user registration.
history[payments_count]	integer	recommended	Total successful transactions for the user.
customer[firstname]	string	no	Customer first name.
customer[lastname]	string	no	Customer last name.

Sample Request

<?php
// User Profile
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "param-user_profile",
  "title": "User Profile",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Optional
Charge

Optional

Supplementary fields available across hosted and direct payment requests.

Parameters

Parameter	Type	Required	Description
ps	string	no	Preferred payment system code.
country_code	string	no	Country override for payment-method filtering.
success_url	string	no	Redirect URL after successful payment.
failure_url	string	no	Redirect URL after failed payment.
pingback_url	string	no	Server callback URL for transaction notifications.

Sample Request

<?php
// Optional
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "param-optional",
  "title": "Optional",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

User Profile
Payment Systems

Invoice

Create a hosted invoice and send it directly to your customer.

Endpoint

POST https://api.cleargatefinance.com/developers/invoice-api/invoice

Parameters

Parameter	Type	Required	Description
currency	string	yes	Invoice currency.
customer[email]	string	yes	Customer billing email.
items	array	yes	Invoice line items passed as structured objects.
due_date	string	no	Invoice due date in ISO-8601 format.
note	string	no	Internal invoice note shown to the payer.

Sample Request

<?php
// Invoice
$endpoint = "https://api.cleargatefinance.com/developers/invoice-api/invoice";
$payload = {
  "currency" => "USD",
  "customer[email]" => "billing@example.com",
  "due_in_days" => 7
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing",
  "title": "Invoice",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Contacts
Items

Contacts

Billing and delivery contact fields for invoice requests.

Parameters

Parameter	Type	Required	Description
customer[firstname]	string	no	Invoice recipient first name.
customer[lastname]	string	no	Invoice recipient last name.
customer[country]	string	no	Billing country code.
customer[phone]	string	no	Billing phone number.

Sample Request

<?php
// Contacts
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-contacts",
  "title": "Contacts",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Invoice
Items

Items

Line-item array structure for Clear Gate invoicing.

Parameters

Parameter	Type	Required	Description
items[][name]	string	yes	Line-item title.
items[][amount]	number	yes	Line-item amount.
items[][quantity]	integer	yes	Quantity purchased.
items[][currency]	string	yes	Currency for the line item.

Sample Request

<?php
// Items
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-items",
  "title": "Items",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Invoice
Invoice tax/discount

Invoice tax/discount

Top-level tax and discount fields for the invoice object.

Parameters

Parameter	Type	Required	Description
taxes[][name]	string	no	Tax label.
taxes[][amount]	number	no	Tax value.
discounts[][name]	string	no	Discount label.
discounts[][amount]	number	no	Discount value.

Sample Request

<?php
// Invoice tax/discount
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-tax_invoice",
  "title": "Invoice tax/discount",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Item tax/discount
Invoice

Item tax/discount

Per-line tax and discount fields for invoice items.

Parameters

Parameter	Type	Required	Description
taxes[][name]	string	no	Tax label.
taxes[][amount]	number	no	Tax value.
discounts[][name]	string	no	Discount label.
discounts[][amount]	number	no	Discount value.

Sample Request

<?php
// Item tax/discount
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-tax_item",
  "title": "Item tax/discount",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Invoice tax/discount
Items

Invoice response attributes

Attributes returned by the Clear Gate invoice create endpoint.

Attributes

Name	Description
id	Invoice identifier returned after creation.
token	Hosted invoice access token.
status	Invoice status in the Clear Gate system.
url	Hosted invoice URL for the payer.

Sample Request

<?php
// Invoice response attributes
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-response",
  "title": "Invoice response attributes",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Invoice

Onetime token

Create a single-use token from card details collected through Clear Gate brick fields.

Endpoint

POST https://pwgateway.com/api/token

Endpoint

POST https://api.cleargatefinance.com/api/brick/token

Parameters

Parameter	Type	Required	Description
public_key	string	yes	Public key used by the hosted brick fields.
number	string	yes	Card number collected through secure fields.
cvv	string	yes	Card verification value.
exp_month	integer	yes	Card expiry month.
exp_year	integer	yes	Card expiry year.

Sample Request

<?php
// Onetime token
$endpoint = "https://pwgateway.com/api/token";
$payload = {
  "number" => "4111111111111111",
  "cvv" => "123",
  "exp_month" => 12,
  "exp_year" => 2028
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-onetime_token",
  "title": "Onetime token",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

The onetime token object
Charge

The onetime token object

Attributes returned after card tokenization.

Attributes

Name	Description
id	One-time token identifier.
type	Token object type.
public_name	Masked card label returned for display.
card_type	Detected card brand.

Sample Request

<?php
// The onetime token object
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-onetime_token-object",
  "title": "The onetime token object",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Onetime token
Tokenization API

Charge

Server-side charge creation for tokenized card payments.

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge/$chargeid/void

Parameters

Parameter	Type	Required	Description
amount	number	yes	Amount to charge.
currency	string	yes	Processing currency.
token	string	yes	Brick token from the tokenization step.
email	string	yes	Customer email.
description	string	no	Merchant order descriptor.

Sample Request

<?php
// Charge
$endpoint = "https://api.cleargatefinance.com/api/brick/charge";
$payload = {
  "amount" => 9.99,
  "currency" => "USD",
  "token" => "tok_10482",
  "email" => "buyer@example.com"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge",
  "title": "Charge",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

The charge object
Obtain charge details
Refund a charge

The charge object

Response attributes for a Clear Gate brick charge.

Attributes

Name	Description
id	Charge identifier.
amount	Authorized or captured amount.
currency	Charge currency.
refundable_amount	Amount still eligible for refund.
status	Charge state in Clear Gate processing.

Sample Request

<?php
// The charge object
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-object",
  "title": "The charge object",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge

Obtain charge details

Retrieve a single brick charge by ID.

Endpoint

GET https://api.cleargatefinance.com/api/brick/charge/$chargeid

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Obtain charge details
$endpoint = "https://api.cleargatefinance.com/api/brick/charge/$chargeid";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-get",
  "title": "Obtain charge details",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge
Payment Status

Refund a charge

Refund a captured brick charge.

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge/$chargeid/refund

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Refund a charge
$endpoint = "https://api.cleargatefinance.com/api/brick/charge/$chargeid/refund";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-refund",
  "title": "Refund a charge",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge
Cancellation

Capture a charge

Capture a previously authorized charge.

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge/$chargeid/capture

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Capture a charge
$endpoint = "https://api.cleargatefinance.com/api/brick/charge/$chargeid/capture";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-capture",
  "title": "Capture a charge",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge
Void a charge

Void a charge

Void a not-yet-settled charge.

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge/$chargeid/void

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Void a charge
$endpoint = "https://api.cleargatefinance.com/api/brick/charge/$chargeid/void";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-void",
  "title": "Void a charge",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge
Capture a charge

Subscription

Card-based recurring subscription management through the brick API.

Endpoint

POST https://api.cleargatefinance.com/api/brick/subscription

Endpoint

POST https://api.cleargatefinance.com/api/brick/subscription/$id/cancel

Endpoint

GET https://api.cleargatefinance.com/api/brick/subscription/$id

Parameters

Parameter	Type	Required	Description
token	string	yes	Saved brick token.
amount	number	yes	Recurring charge amount.
currency	string	yes	Recurring billing currency.
period	string	yes	Recurring interval, for example `month`.
period_duration	integer	yes	Number of periods between charges.

Sample Request

<?php
// Subscription
$endpoint = "https://api.cleargatefinance.com/api/brick/subscription";
$payload = {
  "token" => "tok_10482",
  "amount" => 29.99,
  "currency" => "USD",
  "period" => "month",
  "period_duration" => 1
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-subscription",
  "title": "Subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

The subscription object
Obtain subscription details
Cancel a subscription

The subscription object

Subscription attributes returned by the brick API.

Attributes

Name	Description
id	Subscription identifier.
active	Whether the subscription is active.
next_charge_on	Next scheduled billing date.
period	Recurring interval label.

Sample Request

<?php
// The subscription object
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-subscription-object",
  "title": "The subscription object",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Subscription

Obtain subscription details

Retrieve a single brick subscription by ID.

Endpoint

GET https://api.cleargatefinance.com/api/brick/subscription/$id

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Obtain subscription details
$endpoint = "https://api.cleargatefinance.com/api/brick/subscription/$id";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-subscription-get",
  "title": "Obtain subscription details",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Subscription

Cancel a subscription

Cancel an active brick subscription.

Endpoint

POST https://api.cleargatefinance.com/api/brick/subscription/$id/cancel

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Cancel a subscription
$endpoint = "https://api.cleargatefinance.com/api/brick/subscription/$id/cancel";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-subscription-cancel",
  "title": "Cancel a subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Subscription

Tokenization API

Direct tokenization endpoint for secure payment-method exchange.

Endpoint

POST https://api.cleargatefinance.com/api/brick/tokenize

Headers

Header	Description
X-ApiKey	Private API key for tokenization requests.
Content-Type	Request body content type, usually `application/json`.

Parameters

Parameter	Type	Required	Description
public_key	string	yes	Public key issued for the project.
payment_method	string	yes	Payment method object collected on the front end.
customer[email]	string	no	Customer email for risk checks.

Sample Request

<?php
// Tokenization API
$endpoint = "https://api.cleargatefinance.com/api/brick/tokenize";
$payload = {
  "public_key" => "pub_live_10482",
  "payment_method" => "pm_card_visa",
  "customer[email]" => "buyer@example.com"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tokenization-api",
  "title": "Tokenization API",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Onetime token
Charge

Get token

Generate a short-lived mobile payment token.

Endpoint

POST https://api.cleargatefinance.com/api/mobiamo/token

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Requested amount.
currency	string	yes	Requested currency.
country_code	string	yes	Destination market for the mobile flow.
sign	string	yes	Signed request hash.

Attributes

Name	Description
token	Temporary mobile transaction token.
status	Current mobile payment state.
redirect_url	Hosted step-up or OTP destination if required.

Sample Request

<?php
// Get token
$endpoint = "https://api.cleargatefinance.com/api/mobiamo/token";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-token",
  "title": "Get token",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Initiate payment

Initiate payment

Start the mobile payment flow for a supported carrier or mobile method.

Endpoint

POST https://api.cleargatefinance.com/api/mobiamo/init-payment

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Requested amount.
currency	string	yes	Requested currency.
country_code	string	yes	Destination market for the mobile flow.
sign	string	yes	Signed request hash.

Attributes

Name	Description
token	Temporary mobile transaction token.
status	Current mobile payment state.
redirect_url	Hosted step-up or OTP destination if required.

Sample Request

<?php
// Initiate payment
$endpoint = "https://api.cleargatefinance.com/api/mobiamo/init-payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-initiate",
  "title": "Initiate payment",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Process payment
Get token

Process payment

Complete or confirm an in-progress mobile payment.

Endpoint

POST https://api.cleargatefinance.com/api/mobiamo/process-payment

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Requested amount.
currency	string	yes	Requested currency.
country_code	string	yes	Destination market for the mobile flow.
sign	string	yes	Signed request hash.

Attributes

Name	Description
token	Temporary mobile transaction token.
status	Current mobile payment state.
redirect_url	Hosted step-up or OTP destination if required.

Sample Request

<?php
// Process payment
$endpoint = "https://api.cleargatefinance.com/api/mobiamo/process-payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-process",
  "title": "Process payment",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Initiate payment
Get transaction details

Get transaction details

Inspect a mobile payment transaction.

Endpoint

POST https://api.cleargatefinance.com/api/mobiamo/get-payment

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Requested amount.
currency	string	yes	Requested currency.
country_code	string	yes	Destination market for the mobile flow.
sign	string	yes	Signed request hash.

Attributes

Name	Description
token	Temporary mobile transaction token.
status	Current mobile payment state.
redirect_url	Hosted step-up or OTP destination if required.

Sample Request

<?php
// Get transaction details
$endpoint = "https://api.cleargatefinance.com/api/mobiamo/get-payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-get-transaction",
  "title": "Get transaction details",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Process payment
Payment Status

Pricepoint

Fetch available mobile price points for a given market.

Endpoint

GET https://api.cleargatefinance.com/api/price-points/

Parameters

Parameter	Type	Required	Description
country_code	string	yes	Country used to filter price points.
carrier	string	no	Carrier code if already known.
currency	string	no	Optional currency filter.

Sample Request

<?php
// Pricepoint
$endpoint = "https://api.cleargatefinance.com/api/price-points/";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-pricepoint",
  "title": "Pricepoint",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Initiate payment

Response Codes

Response codes returned by the Mobiamo Direct API.

Possible Values

Code	Description
200	Request processed successfully.
400	Request validation failed.
401	Authentication failed or key is invalid.
500	Internal processing error.

Sample Request

<?php
// Response Codes
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-codes",
  "title": "Response Codes",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Process payment

Generate ePIN

Generate a MINT ePIN through the direct MINT integration.

Endpoint

POST https://api.cleargatefinance.com/pwapi/partners-mint

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Face value or redemption amount.
currency	string	yes	Currency code.
sign	string	yes	Signature checksum.

Sample Request

<?php
// Generate ePIN
$endpoint = "https://api.cleargatefinance.com/pwapi/partners-mint";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-generate",
  "title": "Generate ePIN",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Error codes
Get reseller balance

Error codes

Error codes for the Generate ePIN endpoint.

Codes

Code	Description
0	Request completed successfully.
1001	Invalid signature or unauthorized merchant.
2001	Insufficient balance or inventory.
3001	Invalid or already redeemed code.

Sample Request

<?php
// Error codes
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-generate-error_codes",
  "title": "Error codes",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Generate ePIN

Get reseller balance

Retrieve reseller balance information from Clear Gate MINT.

Endpoint

GET https://api.cleargatefinance.com/pwapi/mint-balances

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Face value or redemption amount.
currency	string	yes	Currency code.
sign	string	yes	Signature checksum.

Sample Request

<?php
// Get reseller balance
$endpoint = "https://api.cleargatefinance.com/pwapi/mint-balances";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-balance",
  "title": "Get reseller balance",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Generate ePIN
MINT redemption

MINT redemption

Redeem a MINT code through the direct API.

Endpoint

POST https://api.cleargatefinance.com/api/pure-mint/payment

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Face value or redemption amount.
currency	string	yes	Currency code.
sign	string	yes	Signature checksum.

Sample Request

<?php
// MINT redemption
$endpoint = "https://api.cleargatefinance.com/api/pure-mint/payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-redemption",
  "title": "MINT redemption",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Error codes
Get reseller balance

Error codes

Error codes for the MINT redemption endpoint.

Codes

Code	Description
0	Request completed successfully.
1001	Invalid signature or unauthorized merchant.
2001	Insufficient balance or inventory.
3001	Invalid or already redeemed code.

Sample Request

<?php
// Error codes
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-redemption-error_codes",
  "title": "Error codes",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

MINT redemption

Reporting API

Export transaction and settlement data from Clear Gate reporting.

Endpoint

POST https://api.cleargatefinance.com/developers/reports/transactions-export

Parameters

Parameter	Type	Required	Description
date_start	string	yes	Report start date.
date_end	string	yes	Report end date.
format	string	yes	Export format such as CSV.
timezone	string	no	Reporting timezone identifier.

Request Headers

Header	Description
X-ApiKey	Private API key used for report exports.
Accept	Expected response type.

Sample Request

<?php
// Reporting API
$endpoint = "https://api.cleargatefinance.com/developers/reports/transactions-export";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-reporting",
  "title": "Reporting API",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current transactions
Payment Status

Cancellation

Create cancellation or reversal requests for supported payments.

Endpoint

POST https://api.cleargatefinance.com/developers/api/ticket

Parameters

Parameter	Type	Required	Description
ref	string	yes	Original transaction reference.
reason	string	yes	Cancellation reason submitted to Clear Gate.
amount	number	no	Partial cancellation amount if supported.

Sample Request

<?php
// Cancellation
$endpoint = "https://api.cleargatefinance.com/developers/api/ticket";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-cancellation",
  "title": "Cancellation",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Refund a charge
Receipt

Coupon

Coupon management overview for Clear Gate promotions.

Sample Request

<?php
// Coupon
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-coupon",
  "title": "Coupon",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Creating a coupon
Retrieving information about a coupon

Creating a coupon

Create a new coupon object for a hosted flow.

Endpoint

POST https://api.cleargatefinance.com/api/coupon

Parameters

Parameter	Type	Required	Description
code	string	yes	Coupon code.
currency	string	no	Currency for validation or creation.
amount	number	no	Discount amount or benefit value.
expires_at	string	no	Coupon expiration timestamp.

Sample Request

<?php
// Creating a coupon
$endpoint = "https://api.cleargatefinance.com/api/coupon";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-coupon-create",
  "title": "Creating a coupon",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Retrieving information about a coupon

Retrieving information about a coupon

Look up a coupon by code or identifier.

Endpoint

GET https://api.cleargatefinance.com/api/coupon

Parameters

Parameter	Type	Required	Description
code	string	yes	Coupon code.
currency	string	no	Currency for validation or creation.
amount	number	no	Discount amount or benefit value.
expires_at	string	no	Coupon expiration timestamp.

Sample Request

<?php
// Retrieving information about a coupon
$endpoint = "https://api.cleargatefinance.com/api/coupon";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-coupon-info",
  "title": "Retrieving information about a coupon",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Creating a coupon

Delivery Confirmation

Confirm digital or physical fulfillment to reduce disputes and unlock settlement decisions.

Endpoint

POST https://api.cleargatefinance.com/api/delivery

Sample Request

<?php
// Delivery Confirmation
$endpoint = "https://api.cleargatefinance.com/api/delivery";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-delivery-confirmation",
  "title": "Delivery Confirmation",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Digital
Physical
Status

Digital

Delivery confirmation payload for digital goods and virtual fulfillment.

Parameters

Parameter	Type	Required	Description
ref	string	yes	Transaction reference.
type	string	yes	Delivery confirmation type set to `digital`.
details	string	yes	Digital fulfillment evidence or entitlement data.

Sample Request

<?php
// Digital
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-delivery-confirmation-digital",
  "title": "Digital",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Delivery Confirmation

Physical

Delivery confirmation payload for shipped physical goods.

Parameters

Parameter	Type	Required	Description
ref	string	yes	Transaction reference.
type	string	yes	Delivery confirmation type set to `physical`.
tracking_number	string	yes	Shipping tracking number.
carrier	string	yes	Shipping carrier label.

Sample Request

<?php
// Physical
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-delivery-confirmation-physical",
  "title": "Physical",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Delivery Confirmation

Status

Status values returned for delivery-confirmation events.

Possible values

Status	Description
pending	Confirmation not yet accepted.
received	Delivery confirmation accepted by Clear Gate.
rejected	Confirmation rejected and requires review.

Sample Request

<?php
// Status
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-delivery-confirmation-status",
  "title": "Status",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Delivery Confirmation

Payment Status

Retrieve the latest payment state for a hosted or direct transaction.

Endpoint

GET https://api.cleargatefinance.com/api/rest/payment

Parameters

Parameter	Type	Required	Description
ref	string	yes	Transaction reference.
uid	string	yes	Merchant user ID.
sign	string	yes	Request signature.

Sample Request

<?php
// Payment Status
$endpoint = "https://api.cleargatefinance.com/api/rest/payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-payment-status",
  "title": "Payment Status",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Obtain charge details
Show details a transaction

Payment Systems

List the payment methods available for a market or transaction context.

Endpoint

GET https://api.cleargatefinance.com/api/payment-systems/

Parameters

Parameter	Type	Required	Description
country_code	string	no	Country filter.
currency	string	no	Currency filter.
type	string	no	Payment-system family filter.

Attributes

Name	Description
id	Payment system identifier.
name	Human-readable payment method name.
logo_url	Asset URL used by hosted checkout.
currencies	Supported processing currencies.

Sample Request

<?php
// Payment Systems
$endpoint = "https://api.cleargatefinance.com/api/payment-systems/";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-payment-systems",
  "title": "Payment Systems",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Optional
Geolocation

Product Details

Fetch a hosted product configuration by merchant product ID.

Endpoint

GET https://api.cleargatefinance.com/api/rest/product/

Parameters

Parameter	Type	Required	Description
goodsid	string	yes	Merchant product identifier.
uid	string	yes	User identifier.
country_code	string	no	Country code for localized product pricing.

Sample Request

<?php
// Product Details
$endpoint = "https://api.cleargatefinance.com/api/rest/product/";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-product-details",
  "title": "Product Details",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Digital Goods
Payment Systems

Geolocation

Resolve a country or market from an IP address.

Endpoint

GET https://api.cleargatefinance.com/api/rest/country

Parameters

Parameter	Type	Required	Description
ip	string	yes	IP address to geolocate.
format	string	no	Output format.

Sample Request

<?php
// Geolocation
$endpoint = "https://api.cleargatefinance.com/api/rest/country";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-geolocation",
  "title": "Geolocation",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Payment Systems

Receipt

Retrieve a payment receipt or hosted receipt metadata.

Endpoint

GET https://api.cleargatefinance.com/api/rest/receipt

Parameters

Parameter	Type	Required	Description
ref	string	yes	Transaction reference.
uid	string	yes	End-user identifier.
sign	string	yes	Receipt request signature.

Sample Request

<?php
// Receipt
$endpoint = "https://api.cleargatefinance.com/api/rest/receipt";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-receipt",
  "title": "Receipt",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Payment Status
Cancellation

API Reference

This API reference consists of all the APIs provided by Clear Gate. The Clear Gate API can be interacted with using HTTPS requests to obtain certain information from Clear Gate.

Typically a JSON object including the required details will be returned except Widget API and Checkout API, which redirect your customer to Clear Gate for hosted checkout payment experience.

If you have any suggestions or confusion about our reference pages, please create an issue directly on our GitHub repository.

Digital Goods

Hosted widget flow for digital goods, virtual products, and package-driven checkout.

Endpoint

GET https://api.cleargatefinance.com/api/subscription

Parameters

Parameter	Type	Required	Description
key	string	yes	Clear Gate project key assigned to the widget.
uid	string	yes	Unique end-user identifier in the merchant system.
widget	string	yes	Widget code configured for the product or package.
email	string	no	Customer email used for receipts and support lookup.
sign	string	yes	Signature generated from the request parameters and secret key.

Sample Request

<?php
// Digital Goods
$endpoint = "https://api.cleargatefinance.com/api/subscription";
$payload = {
  "key" => "project_1001",
  "uid" => "user_10482",
  "widget" => "cg_widget_01",
  "email" => "buyer@example.com"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-dg",
  "title": "Digital Goods",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Onetime payment
Build Widget

Tokidoki

Package and subscription management endpoints for Tokidoki-based widget products.

Sample Request

<?php
// Tokidoki
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki",
  "title": "Tokidoki",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Build Widget
List all current packages

Build Widget

Create a widget URL for a specific package or price configuration.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/widget-url

Parameters

Parameter	Type	Required	Description
key	string	yes	Clear Gate project key assigned to the widget.
uid	string	yes	Unique end-user identifier in the merchant system.
widget	string	yes	Widget code configured for the product or package.
email	string	no	Customer email used for receipts and support lookup.
sign	string	yes	Signature generated from the request parameters and secret key.

Sample Request

<?php
// Build Widget
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/widget-url";
$payload = {
  "uid" => "user_10482",
  "package_id" => "pkg_gold",
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-api",
  "title": "Build Widget",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current packages
Create new package

List all current packages

Return the packages currently available in the Tokidoki catalog.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/packages

Sample Request

<?php
// List all current packages
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/packages";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-package",
  "title": "List all current packages",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Show details a package
Create new package

Show details a package

Look up a single package by identifier.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/packages?package_id={package_id}

Parameters

Parameter	Type	Required	Description
package_id	string	yes	Package identifier in the Clear Gate package catalog.
project_key	string	yes	Project key passed in the `X-ApiKey` header.

Sample Request

<?php
// Show details a package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/packages?package_id={package_id}";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-detail_package",
  "title": "Show details a package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current packages
Update a package

Create new package

Create a new package entry for a widget-based product.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/create-package

Parameters

Parameter	Type	Required	Description
key	string	yes	Clear Gate project key assigned to the widget.
uid	string	yes	Unique end-user identifier in the merchant system.
widget	string	yes	Widget code configured for the product or package.
email	string	no	Customer email used for receipts and support lookup.
sign	string	yes	Signature generated from the request parameters and secret key.

Sample Request

<?php
// Create new package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/create-package";
$payload = {
  "package_id" => "pkg_gold",
  "amount" => 19.99,
  "currency" => "USD",
  "name" => "Gold Pack"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-create_new_package",
  "title": "Create new package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Update a package
Remove a package

Update a package

Update package pricing, metadata, or availability.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/update-package

Parameters

Parameter	Type	Required	Description
key	string	yes	Clear Gate project key assigned to the widget.
uid	string	yes	Unique end-user identifier in the merchant system.
widget	string	yes	Widget code configured for the product or package.
email	string	no	Customer email used for receipts and support lookup.
sign	string	yes	Signature generated from the request parameters and secret key.

Sample Request

<?php
// Update a package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/update-package";
$payload = {
  "package_id" => "pkg_gold",
  "amount" => 24.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-update_package",
  "title": "Update a package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Create new package
Remove a package

Remove a package

Delete or archive a Tokidoki package entry.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/remove-package

Parameters

Parameter	Type	Required	Description
package_id	string	yes	Package identifier in the Clear Gate package catalog.
project_key	string	yes	Project key passed in the `X-ApiKey` header.

Sample Request

<?php
// Remove a package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/remove-package";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-remove_package",
  "title": "Remove a package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Update a package
List all current packages

List all current subscriptions

Retrieve the current Tokidoki subscription set for the project.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?page={number_page}

Sample Request

<?php
// List all current subscriptions
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-list_subscriptions",
  "title": "List all current subscriptions",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Show details a subscription
Cancel a subscription

Show details a subscription

Inspect a single subscription by ID, subscriber email, or package ID.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?subscription_id={subscription_id}

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?subscriber_email={email}

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?package_id={package_id}

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Show details a subscription
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/subscriptions?subscription_id={subscription_id}";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-show_subscription_details",
  "title": "Show details a subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current subscriptions
Cancel a subscription

Cancel a subscription

Request cancellation for an existing widget subscription.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/cancel-subscription

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Cancel a subscription
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/cancel-subscription";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-cancel_subscription",
  "title": "Cancel a subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Show details a subscription
Remove pending cancel subscription

Change subscription's package

Move an active subscription to a different package.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/request-change-package

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Change subscription's package
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/request-change-package";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-change_package_subscription",
  "title": "Change subscription's package",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Remove change package request
Show details a subscription

Remove change package request

Rollback a pending package-change request for a subscription.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/remove-change-package

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Remove change package request
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/remove-change-package";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-remove_change_package",
  "title": "Remove change package request",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Change subscription's package
Show details a subscription

Remove pending cancel subscription

Undo a pending subscription cancellation request.

Endpoint

POST https://api.cleargatefinance.com/developers/tokidoki-api/remove-pending-cancel

Parameters

Parameter	Type	Required	Description
subscription_id	string	yes	Subscription identifier returned by Clear Gate.
package_id	string	no	Package identifier used for updates or filtering.
subscriber_email	string	no	Subscriber email for direct lookup.

Sample Request

<?php
// Remove pending cancel subscription
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/remove-pending-cancel";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-remove_pending_cancel",
  "title": "Remove pending cancel subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Cancel a subscription
Show details a subscription

List all current transactions

Retrieve Tokidoki transaction history.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/transactions

Sample Request

<?php
// List all current transactions
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/transactions";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-list_transactions",
  "title": "List all current transactions",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Show details a transaction
Reporting API

Show details a transaction

Inspect a transaction by ID or linked subscription ID.

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/transactions?transaction_id={transaction_id}

Endpoint

GET https://api.cleargatefinance.com/developers/tokidoki-api/transactions?subscription_id={subscription_id}

Transaction lookup

Field	Description
transaction_id	Clear Gate transaction identifier.
subscription_id	Linked subscription identifier.

Sample Request

<?php
// Show details a transaction
$endpoint = "https://api.cleargatefinance.com/developers/tokidoki-api/transactions?transaction_id={transaction_id}";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "widget-tokidoki-show_details_transaction",
  "title": "Show details a transaction",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current transactions
Payment Status

Onetime payment

Hosted checkout flow for one-time purchases.

Endpoint

GET https://api.cleargatefinance.com/api/subscription

Parameters

Parameter	Type	Required	Description
uid	string	yes	Unique user identifier.
amount	number	yes	Purchase amount in the requested currency.
currency	string	yes	ISO currency code.
ag_name	string	yes	Product or subscription plan title shown in checkout.
sign	string	yes	Signed checksum for hosted checkout creation.

Sample Request

<?php
// Onetime payment
$endpoint = "https://api.cleargatefinance.com/api/subscription";
$payload = {
  "uid" => "user_10482",
  "amount" => 39.99,
  "currency" => "USD",
  "ag_name" => "Starter Plan"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "checkout-onetime",
  "title": "Onetime payment",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Subscription
Digital Goods

Subscription

Hosted checkout flow for recurring billing plans.

Endpoint

GET https://api.cleargatefinance.com/api/subscription

Parameters

Parameter	Type	Required	Description
uid	string	yes	Unique user identifier.
amount	number	yes	Purchase amount in the requested currency.
currency	string	yes	ISO currency code.
ag_name	string	yes	Product or subscription plan title shown in checkout.
sign	string	yes	Signed checksum for hosted checkout creation.

Sample Request

<?php
// Subscription
$endpoint = "https://api.cleargatefinance.com/api/subscription";
$payload = {
  "uid" => "user_10482",
  "amount" => 29.99,
  "currency" => "USD",
  "ag_name" => "Monthly Plan"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "checkout-subscription",
  "title": "Subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Onetime payment
Subscription

User Profile

Additional end-user data used to strengthen authorization and fraud decisions.

Parameters

Parameter	Type	Required	Description
email	string	recommended	User email used for fraud checks and receipts.
history[registration_date]	integer	recommended	Unix timestamp of end-user registration.
history[payments_count]	integer	recommended	Total successful transactions for the user.
customer[firstname]	string	no	Customer first name.
customer[lastname]	string	no	Customer last name.

Sample Request

<?php
// User Profile
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "param-user_profile",
  "title": "User Profile",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Optional
Charge

Optional

Supplementary fields available across hosted and direct payment requests.

Parameters

Parameter	Type	Required	Description
ps	string	no	Preferred payment system code.
country_code	string	no	Country override for payment-method filtering.
success_url	string	no	Redirect URL after successful payment.
failure_url	string	no	Redirect URL after failed payment.
pingback_url	string	no	Server callback URL for transaction notifications.

Sample Request

<?php
// Optional
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "param-optional",
  "title": "Optional",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

User Profile
Payment Systems

Invoice

Create a hosted invoice and send it directly to your customer.

Endpoint

POST https://api.cleargatefinance.com/developers/invoice-api/invoice

Parameters

Parameter	Type	Required	Description
currency	string	yes	Invoice currency.
customer[email]	string	yes	Customer billing email.
items	array	yes	Invoice line items passed as structured objects.
due_date	string	no	Invoice due date in ISO-8601 format.
note	string	no	Internal invoice note shown to the payer.

Sample Request

<?php
// Invoice
$endpoint = "https://api.cleargatefinance.com/developers/invoice-api/invoice";
$payload = {
  "currency" => "USD",
  "customer[email]" => "billing@example.com",
  "due_in_days" => 7
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing",
  "title": "Invoice",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Contacts
Items

Contacts

Billing and delivery contact fields for invoice requests.

Parameters

Parameter	Type	Required	Description
customer[firstname]	string	no	Invoice recipient first name.
customer[lastname]	string	no	Invoice recipient last name.
customer[country]	string	no	Billing country code.
customer[phone]	string	no	Billing phone number.

Sample Request

<?php
// Contacts
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-contacts",
  "title": "Contacts",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Invoice
Items

Items

Line-item array structure for Clear Gate invoicing.

Parameters

Parameter	Type	Required	Description
items[][name]	string	yes	Line-item title.
items[][amount]	number	yes	Line-item amount.
items[][quantity]	integer	yes	Quantity purchased.
items[][currency]	string	yes	Currency for the line item.

Sample Request

<?php
// Items
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-items",
  "title": "Items",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Invoice
Invoice tax/discount

Invoice tax/discount

Top-level tax and discount fields for the invoice object.

Parameters

Parameter	Type	Required	Description
taxes[][name]	string	no	Tax label.
taxes[][amount]	number	no	Tax value.
discounts[][name]	string	no	Discount label.
discounts[][amount]	number	no	Discount value.

Sample Request

<?php
// Invoice tax/discount
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-tax_invoice",
  "title": "Invoice tax/discount",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Item tax/discount
Invoice

Item tax/discount

Per-line tax and discount fields for invoice items.

Parameters

Parameter	Type	Required	Description
taxes[][name]	string	no	Tax label.
taxes[][amount]	number	no	Tax value.
discounts[][name]	string	no	Discount label.
discounts[][amount]	number	no	Discount value.

Sample Request

<?php
// Item tax/discount
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-tax_item",
  "title": "Item tax/discount",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Invoice tax/discount
Items

Invoice response attributes

Attributes returned by the Clear Gate invoice create endpoint.

Attributes

Name	Description
id	Invoice identifier returned after creation.
token	Hosted invoice access token.
status	Invoice status in the Clear Gate system.
url	Hosted invoice URL for the payer.

Sample Request

<?php
// Invoice response attributes
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "invoicing-response",
  "title": "Invoice response attributes",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Invoice

Onetime token

Create a single-use token from card details collected through Clear Gate brick fields.

Endpoint

POST https://pwgateway.com/api/token

Endpoint

POST https://api.cleargatefinance.com/api/brick/token

Parameters

Parameter	Type	Required	Description
public_key	string	yes	Public key used by the hosted brick fields.
number	string	yes	Card number collected through secure fields.
cvv	string	yes	Card verification value.
exp_month	integer	yes	Card expiry month.
exp_year	integer	yes	Card expiry year.

Sample Request

<?php
// Onetime token
$endpoint = "https://pwgateway.com/api/token";
$payload = {
  "number" => "4111111111111111",
  "cvv" => "123",
  "exp_month" => 12,
  "exp_year" => 2028
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-onetime_token",
  "title": "Onetime token",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

The onetime token object
Charge

The onetime token object

Attributes returned after card tokenization.

Attributes

Name	Description
id	One-time token identifier.
type	Token object type.
public_name	Masked card label returned for display.
card_type	Detected card brand.

Sample Request

<?php
// The onetime token object
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-onetime_token-object",
  "title": "The onetime token object",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Onetime token
Tokenization API

Charge

Server-side charge creation for tokenized card payments.

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge/$chargeid/void

Parameters

Parameter	Type	Required	Description
amount	number	yes	Amount to charge.
currency	string	yes	Processing currency.
token	string	yes	Brick token from the tokenization step.
email	string	yes	Customer email.
description	string	no	Merchant order descriptor.

Sample Request

<?php
// Charge
$endpoint = "https://api.cleargatefinance.com/api/brick/charge";
$payload = {
  "amount" => 9.99,
  "currency" => "USD",
  "token" => "tok_10482",
  "email" => "buyer@example.com"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge",
  "title": "Charge",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

The charge object
Obtain charge details
Refund a charge

The charge object

Response attributes for a Clear Gate brick charge.

Attributes

Name	Description
id	Charge identifier.
amount	Authorized or captured amount.
currency	Charge currency.
refundable_amount	Amount still eligible for refund.
status	Charge state in Clear Gate processing.

Sample Request

<?php
// The charge object
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-object",
  "title": "The charge object",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge

Obtain charge details

Retrieve a single brick charge by ID.

Endpoint

GET https://api.cleargatefinance.com/api/brick/charge/$chargeid

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Obtain charge details
$endpoint = "https://api.cleargatefinance.com/api/brick/charge/$chargeid";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-get",
  "title": "Obtain charge details",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge
Payment Status

Refund a charge

Refund a captured brick charge.

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge/$chargeid/refund

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Refund a charge
$endpoint = "https://api.cleargatefinance.com/api/brick/charge/$chargeid/refund";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-refund",
  "title": "Refund a charge",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge
Cancellation

Capture a charge

Capture a previously authorized charge.

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge/$chargeid/capture

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Capture a charge
$endpoint = "https://api.cleargatefinance.com/api/brick/charge/$chargeid/capture";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-capture",
  "title": "Capture a charge",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge
Void a charge

Void a charge

Void a not-yet-settled charge.

Endpoint

POST https://api.cleargatefinance.com/api/brick/charge/$chargeid/void

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Void a charge
$endpoint = "https://api.cleargatefinance.com/api/brick/charge/$chargeid/void";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-charge-void",
  "title": "Void a charge",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Charge
Capture a charge

Subscription

Card-based recurring subscription management through the brick API.

Endpoint

POST https://api.cleargatefinance.com/api/brick/subscription

Endpoint

POST https://api.cleargatefinance.com/api/brick/subscription/$id/cancel

Endpoint

GET https://api.cleargatefinance.com/api/brick/subscription/$id

Parameters

Parameter	Type	Required	Description
token	string	yes	Saved brick token.
amount	number	yes	Recurring charge amount.
currency	string	yes	Recurring billing currency.
period	string	yes	Recurring interval, for example `month`.
period_duration	integer	yes	Number of periods between charges.

Sample Request

<?php
// Subscription
$endpoint = "https://api.cleargatefinance.com/api/brick/subscription";
$payload = {
  "token" => "tok_10482",
  "amount" => 29.99,
  "currency" => "USD",
  "period" => "month",
  "period_duration" => 1
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-subscription",
  "title": "Subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

The subscription object
Obtain subscription details
Cancel a subscription

The subscription object

Subscription attributes returned by the brick API.

Attributes

Name	Description
id	Subscription identifier.
active	Whether the subscription is active.
next_charge_on	Next scheduled billing date.
period	Recurring interval label.

Sample Request

<?php
// The subscription object
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-subscription-object",
  "title": "The subscription object",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Subscription

Obtain subscription details

Retrieve a single brick subscription by ID.

Endpoint

GET https://api.cleargatefinance.com/api/brick/subscription/$id

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Obtain subscription details
$endpoint = "https://api.cleargatefinance.com/api/brick/subscription/$id";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-subscription-get",
  "title": "Obtain subscription details",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Subscription

Cancel a subscription

Cancel an active brick subscription.

Endpoint

POST https://api.cleargatefinance.com/api/brick/subscription/$id/cancel

Parameters

Parameter	Type	Required	Description
id	string	yes	Object identifier passed in the request path.
project_key	string	yes	Project or private API key used for authentication.

Sample Request

<?php
// Cancel a subscription
$endpoint = "https://api.cleargatefinance.com/api/brick/subscription/$id/cancel";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "brick-subscription-cancel",
  "title": "Cancel a subscription",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Subscription

Tokenization API

Direct tokenization endpoint for secure payment-method exchange.

Endpoint

POST https://api.cleargatefinance.com/api/brick/tokenize

Headers

Header	Description
X-ApiKey	Private API key for tokenization requests.
Content-Type	Request body content type, usually `application/json`.

Parameters

Parameter	Type	Required	Description
public_key	string	yes	Public key issued for the project.
payment_method	string	yes	Payment method object collected on the front end.
customer[email]	string	no	Customer email for risk checks.

Sample Request

<?php
// Tokenization API
$endpoint = "https://api.cleargatefinance.com/api/brick/tokenize";
$payload = {
  "public_key" => "pub_live_10482",
  "payment_method" => "pm_card_visa",
  "customer[email]" => "buyer@example.com"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tokenization-api",
  "title": "Tokenization API",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Onetime token
Charge

Get token

Generate a short-lived mobile payment token.

Endpoint

POST https://api.cleargatefinance.com/api/mobiamo/token

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Requested amount.
currency	string	yes	Requested currency.
country_code	string	yes	Destination market for the mobile flow.
sign	string	yes	Signed request hash.

Attributes

Name	Description
token	Temporary mobile transaction token.
status	Current mobile payment state.
redirect_url	Hosted step-up or OTP destination if required.

Sample Request

<?php
// Get token
$endpoint = "https://api.cleargatefinance.com/api/mobiamo/token";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-token",
  "title": "Get token",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Initiate payment

Initiate payment

Start the mobile payment flow for a supported carrier or mobile method.

Endpoint

POST https://api.cleargatefinance.com/api/mobiamo/init-payment

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Requested amount.
currency	string	yes	Requested currency.
country_code	string	yes	Destination market for the mobile flow.
sign	string	yes	Signed request hash.

Attributes

Name	Description
token	Temporary mobile transaction token.
status	Current mobile payment state.
redirect_url	Hosted step-up or OTP destination if required.

Sample Request

<?php
// Initiate payment
$endpoint = "https://api.cleargatefinance.com/api/mobiamo/init-payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-initiate",
  "title": "Initiate payment",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Process payment
Get token

Process payment

Complete or confirm an in-progress mobile payment.

Endpoint

POST https://api.cleargatefinance.com/api/mobiamo/process-payment

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Requested amount.
currency	string	yes	Requested currency.
country_code	string	yes	Destination market for the mobile flow.
sign	string	yes	Signed request hash.

Attributes

Name	Description
token	Temporary mobile transaction token.
status	Current mobile payment state.
redirect_url	Hosted step-up or OTP destination if required.

Sample Request

<?php
// Process payment
$endpoint = "https://api.cleargatefinance.com/api/mobiamo/process-payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-process",
  "title": "Process payment",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Initiate payment
Get transaction details

Get transaction details

Inspect a mobile payment transaction.

Endpoint

POST https://api.cleargatefinance.com/api/mobiamo/get-payment

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Requested amount.
currency	string	yes	Requested currency.
country_code	string	yes	Destination market for the mobile flow.
sign	string	yes	Signed request hash.

Attributes

Name	Description
token	Temporary mobile transaction token.
status	Current mobile payment state.
redirect_url	Hosted step-up or OTP destination if required.

Sample Request

<?php
// Get transaction details
$endpoint = "https://api.cleargatefinance.com/api/mobiamo/get-payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-get-transaction",
  "title": "Get transaction details",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Process payment
Payment Status

Pricepoint

Fetch available mobile price points for a given market.

Endpoint

GET https://api.cleargatefinance.com/api/price-points/

Parameters

Parameter	Type	Required	Description
country_code	string	yes	Country used to filter price points.
carrier	string	no	Carrier code if already known.
currency	string	no	Optional currency filter.

Sample Request

<?php
// Pricepoint
$endpoint = "https://api.cleargatefinance.com/api/price-points/";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-pricepoint",
  "title": "Pricepoint",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Initiate payment

Response Codes

Response codes returned by the Mobiamo Direct API.

Possible Values

Code	Description
200	Request processed successfully.
400	Request validation failed.
401	Authentication failed or key is invalid.
500	Internal processing error.

Sample Request

<?php
// Response Codes
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mobiamo-codes",
  "title": "Response Codes",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Process payment

Generate ePIN

Generate a MINT ePIN through the direct MINT integration.

Endpoint

POST https://api.cleargatefinance.com/pwapi/partners-mint

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Face value or redemption amount.
currency	string	yes	Currency code.
sign	string	yes	Signature checksum.

Sample Request

<?php
// Generate ePIN
$endpoint = "https://api.cleargatefinance.com/pwapi/partners-mint";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-generate",
  "title": "Generate ePIN",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Error codes
Get reseller balance

Error codes

Error codes for the Generate ePIN endpoint.

Codes

Code	Description
0	Request completed successfully.
1001	Invalid signature or unauthorized merchant.
2001	Insufficient balance or inventory.
3001	Invalid or already redeemed code.

Sample Request

<?php
// Error codes
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-generate-error_codes",
  "title": "Error codes",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Generate ePIN

Get reseller balance

Retrieve reseller balance information from Clear Gate MINT.

Endpoint

GET https://api.cleargatefinance.com/pwapi/mint-balances

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Face value or redemption amount.
currency	string	yes	Currency code.
sign	string	yes	Signature checksum.

Sample Request

<?php
// Get reseller balance
$endpoint = "https://api.cleargatefinance.com/pwapi/mint-balances";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-balance",
  "title": "Get reseller balance",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Generate ePIN
MINT redemption

MINT redemption

Redeem a MINT code through the direct API.

Endpoint

POST https://api.cleargatefinance.com/api/pure-mint/payment

Parameters

Parameter	Type	Required	Description
uid	string	yes	Merchant user identifier.
amount	number	yes	Face value or redemption amount.
currency	string	yes	Currency code.
sign	string	yes	Signature checksum.

Sample Request

<?php
// MINT redemption
$endpoint = "https://api.cleargatefinance.com/api/pure-mint/payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-redemption",
  "title": "MINT redemption",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Error codes
Get reseller balance

Error codes

Error codes for the MINT redemption endpoint.

Codes

Code	Description
0	Request completed successfully.
1001	Invalid signature or unauthorized merchant.
2001	Insufficient balance or inventory.
3001	Invalid or already redeemed code.

Sample Request

<?php
// Error codes
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "mint-redemption-error_codes",
  "title": "Error codes",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

MINT redemption

Reporting API

Export transaction and settlement data from Clear Gate reporting.

Endpoint

POST https://api.cleargatefinance.com/developers/reports/transactions-export

Parameters

Parameter	Type	Required	Description
date_start	string	yes	Report start date.
date_end	string	yes	Report end date.
format	string	yes	Export format such as CSV.
timezone	string	no	Reporting timezone identifier.

Request Headers

Header	Description
X-ApiKey	Private API key used for report exports.
Accept	Expected response type.

Sample Request

<?php
// Reporting API
$endpoint = "https://api.cleargatefinance.com/developers/reports/transactions-export";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-reporting",
  "title": "Reporting API",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

List all current transactions
Payment Status

Cancellation

Create cancellation or reversal requests for supported payments.

Endpoint

POST https://api.cleargatefinance.com/developers/api/ticket

Parameters

Parameter	Type	Required	Description
ref	string	yes	Original transaction reference.
reason	string	yes	Cancellation reason submitted to Clear Gate.
amount	number	no	Partial cancellation amount if supported.

Sample Request

<?php
// Cancellation
$endpoint = "https://api.cleargatefinance.com/developers/api/ticket";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-cancellation",
  "title": "Cancellation",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Refund a charge
Receipt

Coupon

Coupon management overview for Clear Gate promotions.

Sample Request

<?php
// Coupon
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-coupon",
  "title": "Coupon",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Creating a coupon
Retrieving information about a coupon

Creating a coupon

Create a new coupon object for a hosted flow.

Endpoint

POST https://api.cleargatefinance.com/api/coupon

Parameters

Parameter	Type	Required	Description
code	string	yes	Coupon code.
currency	string	no	Currency for validation or creation.
amount	number	no	Discount amount or benefit value.
expires_at	string	no	Coupon expiration timestamp.

Sample Request

<?php
// Creating a coupon
$endpoint = "https://api.cleargatefinance.com/api/coupon";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-coupon-create",
  "title": "Creating a coupon",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Retrieving information about a coupon

Retrieving information about a coupon

Look up a coupon by code or identifier.

Endpoint

GET https://api.cleargatefinance.com/api/coupon

Parameters

Parameter	Type	Required	Description
code	string	yes	Coupon code.
currency	string	no	Currency for validation or creation.
amount	number	no	Discount amount or benefit value.
expires_at	string	no	Coupon expiration timestamp.

Sample Request

<?php
// Retrieving information about a coupon
$endpoint = "https://api.cleargatefinance.com/api/coupon";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-coupon-info",
  "title": "Retrieving information about a coupon",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Creating a coupon

Delivery Confirmation

Confirm digital or physical fulfillment to reduce disputes and unlock settlement decisions.

Endpoint

POST https://api.cleargatefinance.com/api/delivery

Sample Request

<?php
// Delivery Confirmation
$endpoint = "https://api.cleargatefinance.com/api/delivery";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-delivery-confirmation",
  "title": "Delivery Confirmation",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Digital
Physical
Status

Digital

Delivery confirmation payload for digital goods and virtual fulfillment.

Parameters

Parameter	Type	Required	Description
ref	string	yes	Transaction reference.
type	string	yes	Delivery confirmation type set to `digital`.
details	string	yes	Digital fulfillment evidence or entitlement data.

Sample Request

<?php
// Digital
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-delivery-confirmation-digital",
  "title": "Digital",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Delivery Confirmation

Physical

Delivery confirmation payload for shipped physical goods.

Parameters

Parameter	Type	Required	Description
ref	string	yes	Transaction reference.
type	string	yes	Delivery confirmation type set to `physical`.
tracking_number	string	yes	Shipping tracking number.
carrier	string	yes	Shipping carrier label.

Sample Request

<?php
// Physical
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-delivery-confirmation-physical",
  "title": "Physical",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Delivery Confirmation

Status

Status values returned for delivery-confirmation events.

Possible values

Status	Description
pending	Confirmation not yet accepted.
received	Delivery confirmation accepted by Clear Gate.
rejected	Confirmation rejected and requires review.

Sample Request

<?php
// Status
$endpoint = "/docs/apis";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-delivery-confirmation-status",
  "title": "Status",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Delivery Confirmation

Payment Status

Retrieve the latest payment state for a hosted or direct transaction.

Endpoint

GET https://api.cleargatefinance.com/api/rest/payment

Parameters

Parameter	Type	Required	Description
ref	string	yes	Transaction reference.
uid	string	yes	Merchant user ID.
sign	string	yes	Request signature.

Sample Request

<?php
// Payment Status
$endpoint = "https://api.cleargatefinance.com/api/rest/payment";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-payment-status",
  "title": "Payment Status",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Obtain charge details
Show details a transaction

Payment Systems

List the payment methods available for a market or transaction context.

Endpoint

GET https://api.cleargatefinance.com/api/payment-systems/

Parameters

Parameter	Type	Required	Description
country_code	string	no	Country filter.
currency	string	no	Currency filter.
type	string	no	Payment-system family filter.

Attributes

Name	Description
id	Payment system identifier.
name	Human-readable payment method name.
logo_url	Asset URL used by hosted checkout.
currencies	Supported processing currencies.

Sample Request

<?php
// Payment Systems
$endpoint = "https://api.cleargatefinance.com/api/payment-systems/";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-payment-systems",
  "title": "Payment Systems",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Optional
Geolocation

Product Details

Fetch a hosted product configuration by merchant product ID.

Endpoint

GET https://api.cleargatefinance.com/api/rest/product/

Parameters

Parameter	Type	Required	Description
goodsid	string	yes	Merchant product identifier.
uid	string	yes	User identifier.
country_code	string	no	Country code for localized product pricing.

Sample Request

<?php
// Product Details
$endpoint = "https://api.cleargatefinance.com/api/rest/product/";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-product-details",
  "title": "Product Details",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Digital Goods
Payment Systems

Geolocation

Resolve a country or market from an IP address.

Endpoint

GET https://api.cleargatefinance.com/api/rest/country

Parameters

Parameter	Type	Required	Description
ip	string	yes	IP address to geolocate.
format	string	no	Output format.

Sample Request

<?php
// Geolocation
$endpoint = "https://api.cleargatefinance.com/api/rest/country";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-geolocation",
  "title": "Geolocation",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Payment Systems

Receipt

Retrieve a payment receipt or hosted receipt metadata.

Endpoint

GET https://api.cleargatefinance.com/api/rest/receipt

Parameters

Parameter	Type	Required	Description
ref	string	yes	Transaction reference.
uid	string	yes	End-user identifier.
sign	string	yes	Receipt request signature.

Sample Request

<?php
// Receipt
$endpoint = "https://api.cleargatefinance.com/api/rest/receipt";
$payload = {
  "uid" => "user_10482",
  "amount" => 9.99,
  "currency" => "USD"
};
// Submit request with your Clear Gate SDK or HTTP client.

Sample Response

{
  "object": "tools-receipt",
  "title": "Receipt",
  "success": true,
  "request_id": "cg_req_102948",
  "created_at": "2026-06-20T14:47:47Z"
}

Related APIs

Payment Status
Cancellation