Skip to main content
This glossary provides definitions for key terms related to Cashii integration.

API Key

A secret token used to authenticate your application when making requests to the Cashii API. Generated from your commercial account settings. See Authentication.

Commercial Account

A type of Cashii account required for businesses and developers integrating with the Cashii API. API keys are linked to commercial accounts.

Metadata

A JSON object field included when creating a Remote Payment. Allows you to attach custom data (like an order ID or customer ID) to the payment request for your own tracking purposes.

Payment ID (`paymentId` / `code`)

The unique 16-digit identifier generated by Cashii when a Remote Payment is created. Used to track the payment request and initiate the user payment flow.

Payment Status

Indicates the current state of a Remote Payment. Common statuses include pending, paid, canceled, rejected, and refunded. See Core Concepts.

Redirect URL (`redirectUrl`)

The URL within your application where Cashii redirects the user after they attempt a payment on the Cashii payment page. This URL receives transaction status information as query parameters.

Remote Payment

The core object representing a payment request initiated via the API. It includes details like amount, currency, status, and metadata. See Core Concepts.

Transaction ID (`transaction_id`)

A unique identifier for the actual financial transaction record within Cashii, generated after a payment attempt. Returned in the redirect URL query parameters.

Webhook (Future)

A mechanism (planned for future implementation) where Cashii would proactively send notifications to your server about payment status changes, instead of requiring you to poll the API.