Payment Model
| Field | Type | Description |
|---|---|---|
amount | number | The total transaction amount. |
paymentId | string | Unique identifier for the payment. |
transactionId | string | Unique identifier for the transaction corresponding to the payment. Only for successful payments. |
status | PaymentStatus | Current status of the transaction. |
statusHistory | array of objects | List of past statuses with timestamps. Each object includes status and changedAt. |
createdAt | string (ISO8601) | Timestamp for when the transaction was created. |
connectionId | string | Unique identifier for the payment connection. |
transactionType | string | Type of transaction (e.g., "sale", "refund"). |
tip | number | Additional tip amount added to the payment. |
description | string | Description provided for the transaction. |
discount | number | Discount amount applied to the payment. |
currency | string | Currency in which the transaction is made (e.g., "EUR"). |
merchantId | string | Unique identifier for the merchant. |
Currency Support
Currently, only transactions in EUR (Euro) are supported. Attempts to specify other currencies will not be processed.
Custom Metadata
The metaData field allows partners to add custom fields in a key-value format. These fields will appear in the metaData object within the transaction, making it possible to attach additional information specific to each transaction (e.g., "storeID", "orderReference").
statusHistory Object Structure
The statusHistory field is an array of objects, where each object includes the following fields:
| Field | Type | Description |
|---|---|---|
status | PaymentStatus | Status name (e.g., "initiated", "aborting"). |
changedAt | string (ISO8601) | ISO8601 timestamp indicating when status changed |
PaymentStatus Enum
| Value | Description |
|---|---|
initiated | The payment process has been initiated. |
failedInitiating | The payment initiation process failed. |
processing | The payment is currently being processed. |
aborted | The payment was aborted by the user or system. |
aborting | The payment is in the process of being aborted. |
failedAborting | The attempt to abort the payment failed. |
failed | The payment process completed but failed. |
successful | The payment completed successfully. |
Payment Status
The status field reflects the real-time state of the transaction, and the statusHistory array logs each status change, providing a comprehensive record of the payment’s progress.
Initiated and Processing: These statuses indicate the payment flow’s beginning and active processing stages.
Success and Failure States: Once the payment completes, it transitions to either successful or failed, with additional statuses available to capture failure or interruption points, such as aborted or failedInitiating.
Tracking Changes: Each entry in statusHistory includes a changedAt timestamp, allowing partners to track exactly when each status change occurred.
Updated 10 days ago