| Type: ulid Length: 26
The unique ID assigned to each transaction which is generated
by our system using the ULID format. Each ID is
precisely 26 characters long, ensuring a unique and consistent
identifier for every transaction. This ULID is
automatically created by our system and is used to uniquely identify
and track each transaction in our database.
|
| Type: enum
The three-character ISO-4217 Currency Code that identifies the currency for the transaction. Your business
should be eligible to use the selected currency code.
|
| Type: decimal
The amount value that needs to be collected for the
transaction. The length includes the value, the decimal digit and the decimal value. The API accepts 2 digits like 50.53.
|
| Type: string|null Max: 50
It's a unique identifier assigned to each transaction. It's
primary role is to distinguish one transaction from another, ensuring
that each transaction can be individually tracked and managed without
any confusion. Please notice that duplicate values are not allowed
and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id
value is used to Identify Resource when you consume any transaction endpoint with sending identify_by
query parameter with value reference_id.
|
| Type: integer
This attribute represents the unique inquiry code that
customers must provide to the partner. This code is essential
for partners to look up the transaction details and to process
the payment on behalf of the customer. It serves as a key to
access specific transaction information, ensuring that payments
are accurately matched to the correct transaction.
You can simulate a complete transaction payment through our Pay Order POS terminal flow to test this service effectively. This allows for a hands-on experience to ensure that the payment process is efficient and user-friendly at actual retail locations.
|
| Type: datetime|null
It indicates when the transaction becomes invalid. It ensures
payments are made within a specified timeframe, useful for
time-sensitive offers. It informs both the payer and the recipient
about the exact deadline until which the payment can be processed.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
|
| Type: boolean
This attribute indicates whether the transaction is expired or
not. If the transaction expires_at attribute is filled, then
this attribute value will be true.
|
| Type: ulid
This field is the key to associating each transaction with the
correct payer, enhancing the personalization and accuracy of the
transaction process. It's not only enhances transaction precision
but also contributes significantly to effective payer relationship
management and data analysis.
|
| The payer model for the transaction. |
| Type: ulid Length: 26
The unique ID assigned to each payer which is generated
by our system using the ULID format. Each ID is
precisely 26 characters long, ensuring a unique and consistent
identifier for every payer. This ULID is
automatically created by our system and is used to uniquely identify
and track each payer in our database.
| | Type: string Min: 2 Max: 100
This is the fundamental attribute representing the payer's full
legal or preferred name. It's used in all forms of communication
and identification. It's crucial for personalization and ensures
that all correspondences and documents are correctly addressed.
| | Type: string Min: 5 Max: 255
The email address is a key point of contact for digital communication.
It's used for sending transactional emails, marketing material and
support communications.
| | Type: string
This attribute stores the payer's mobile number. It's essential for
direct contact, SMS notifications, and can also be used in cases where
email communication is insufficient or inappropriate.
| | Type: datetime The created datetime of the payer.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
| | Type: datetime The updated datetime of the payer.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
|
|
| Type: datetime|null
This attribute indicates the exact timestamp when the
transaction was paid.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
|
| Type: boolean
This attribute indicates whether the transaction is paid or not.
If the transaction paid_at attribute is filled, then this
attribute value will be true.
|
| Type: datetime The created datetime of the transaction.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
|
| Type: datetime The updated datetime of the transaction.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
|