This glossary provides definitions and explanations of key terms used across Hydrogen API products. It is designed to serve as a quick reference for developers and other payment processing and integration stakeholders. The glossary categorises terms alphabetically, allowing for easy navigation and a better understanding of the various parameters, values, and objects associated with any API product.
| Term | Meaning |
|---|
| accountName | The name associated with the account used for a transaction. |
| accountNo | The account number used for a transaction. |
| amount | The amount to be charged for a transaction. |
| authorizationObject | Contains details related to the authorization of a transaction. |
| Term | Meaning |
|---|
| bank | The financial institution associated with a transaction. |
| bankName | The name of the bank associated with a virtual account or transaction. |
| Term | Meaning |
|---|
| callback | A URL to which the system sends transaction status updates. |
| canRetry | Indicates whether a failed transaction can be attempted again. |
| cardToken | A unique identifier representing a stored card for recurring payments. |
| chargedAmount | The actual amount charged in a transaction, which may differ from the initial amount. |
| clientReferenceInformation | Additional reference information provided by the client. |
| completedTimeUtc | The time when a transaction was completed, in Coordinated Universal Time (UTC). |
| currency | The type of money used in a transaction (e.g., NGN, USD). |
| customerEmail | The email address of the customer making the payment. |
| customerName | The name of the customer making the payment. |
| Term | Meaning |
|---|
| description | A brief explanation of the purpose or nature of a transaction. |
| discountAmount | The amount of discount applied to a transaction. |
| discountPercentage | The percentage of discount applied to a transaction. |
| Term | Meaning |
|---|
| email | The email address associated with a customer or transaction. |
| endDate | The date when a recurring payment cycle is set to end. |
| expiryDateTime | The date and time when a virtual account or payment link expires. |
| Term | Meaning |
|---|
| fees | Charges associated with processing a transaction. |
| frequency | The interval at which recurring payments are made (e.g., daily, weekly, monthly). |
| Term | Meaning |
|---|
| ip | The Internet Protocol address from which a transaction was initiated. |
| isBankDiscountEnabled | Indicates whether a discount is available for bank transfers. |
| isCardSpecificDiscount | Indicates whether a discount is specific to certain card types. |
| isRecurring | Indicates whether a payment is part of a recurring series. |
| Term | Meaning |
|---|
| merchantRef | A unique identifier assigned by the merchant to a transaction. |
| meta | Additional information or metadata associated with a transaction. |
| Term | Meaning |
|---|
| orderId | A unique identifier for an order or transaction. |
| otpOrBankTransferTimeoutLeft | The remaining time before a one-time password or bank transfer expires. |
| Term | Meaning |
|---|
| paidAt | The date and time when a payment was successfully completed. |
| paymentId | A unique identifier for a payment transaction. |
| paymentType | The method used for payment (e.g., Card, BankTransfer). |
| processorResponse | The response received from the payment processing system. |
| processorTransactionId | A unique identifier assigned by the payment processor to a transaction. |
| Term | Meaning |
|---|
| reconciliationId | An identifier used for reconciling transactions in financial records. |
| remittanceAmount | The amount that is actually transferred or remitted in a transaction. |
| responseCode | A code indicating the result of a transaction or API call. |
| responseDescription | A description explaining the result of a transaction or API call. |
| Term | Meaning |
|---|
| status | The current state of a transaction (e.g., Pending, Failed, Paid). |
| submitTimeUtc | The time when a transaction was submitted, in Coordinated Universal Time (UTC). |
| Term | Meaning |
|---|
| totalAmount | The full amount of a transaction, including any fees or additional charges. |
| transactionId | A unique identifier for a specific transaction. |
| transactionRef | A reference code used to track and identify a specific transaction. |
| transactionStatus | The current status of a transaction in the payment process. |
| Term | Meaning |
|---|
| vatFee | The amount of Value Added Tax (VAT) applied to a transaction. |
| vatPercentage | The percentage of Value Added Tax (VAT) applied to a transaction. |
| virtualAccountName | The name associated with a virtual account generated for a transfer. |
| virtualAccountNo | A dynamically generated account number for receiving transfers. |
