Transaction
|
Attribute |
Type |
Description |
|
id |
Number |
The uniqie id of the transaction |
|
payment_reference |
String |
A unique reference of the transactions |
|
transaction_type |
Transaction Type |
The type of the transaction |
|
transaction_amount |
String |
The amount of the transaction after possible conversions |
|
transaction_currency |
String |
The currency of the receiving account. 3 character ISO 4217 code (eg. “EUR”, “GBP”, “USD”) |
|
original_amount |
String |
The amount for which the transaction was initiated |
|
original_currency |
String |
The currency in which the transaction was initiated. 3 character ISO 4217 code (eg. “EUR”, “GBP”, “USD”) |
|
sign |
String |
Permitted codes are “booked”, “pending” and “both” |
|
date |
String |
The date of the transaction |
|
operation_type |
Operation Type |
The type of the operation |
|
reference_number
|
String | An optional custom reference number set for POS transaction |
|
reference_number_type
|
Number | Possible values: ReferenceNumber = 1, InvoiceNumber = 2, ProductID = 3, ReservationNumber = 4 |
|
terminal_id
|
String | The TID of the POS device in case the transactions was made on a POS device. |
|
serial_number
|
String | The serial number of the POS device in case the transactions was made on a POS device. |
|
account_number
|
String | The identifier of the settlement account. |
| ruid | String | Unique identifier of the submitted request. Up to 255 characters. |
|
billing_descriptor
|
String | Merchant billing descriptor |
| pan | String | Last four digits of the card number. |
Transaction Details
|
Attribute |
Type |
Description |
|
reference |
String |
The "payment_reference" of the transaction. |
|
general |
Object |
Contains the "canRequestReversal", "isFee", "isReversal", and "transactionType" information of the transaction. |
|
details |
Array of Transaction Detail |
A list with details related to the transaction. |
Transaction Detail
|
Attribute |
Type |
Description |
|
title |
String |
The type of the detail or the title of a section of details |
|
value |
String |
The value of the detail. If this value is empty, the title of the detail is for a section of details. The next N values are from this section |
Transaction Type
|
Value |
Description |
|
001 |
Fee |
|
002 |
Cash Withdrawal |
|
003 |
Outgoing Bank Transfer |
|
004 |
Balance Transfer |
|
005 |
E-money Redemption |
|
006 |
Account Funding |
|
007 |
Original Credit |
|
008 |
POS Purchase |
|
009 |
Online Purchase |
|
010 |
Internal Transfer |
|
011 |
Refund |
|
012 |
Money Request |
|
013 |
Payment |
|
014 |
Direct Debit |
|
015 |
Pre-Authorization |
|
016 |
MOTO Payment |
|
017 |
MOTO Refund |
|
018 |
MOTO Pre-Authorization |
|
019 |
ATM Deposit |
|
022 |
NFC Payment |
|
023 |
ATM Surcharge |
|
024 |
Withdrawal |
|
026 |
Utility Bills |
|
035 |
Payment Request |
|
036 |
Payment Return |
|
037 |
Reverse With Hold |
|
038 |
Reverse Release |
|
039 |
Commission |
|
040 |
Cash Funding |
|
041 |
Negative Set Off |
|
042 |
Charge Back |
|
501 |
Payment on POS |
Account
|
Attribute |
Type |
Description |
|
account_number |
String |
A unique identifier of the account. |
|
iban |
String |
The IBAN associated with the account. |
|
currency |
String |
The currency of the account. 3 character ISO 4217 code (eg. “EUR”, “GBP”, “USD”) |
|
name |
String |
A custom name of the account. Can be changed by the account holder via the myPOS Account. |
|
is_reserve |
Boolean |
A flag describing whether the account is a reserve one or not. Note: The IBAN will be empty if this parameter is returned "true". |
Pagination
|
Attribute |
Type |
Description |
|
page |
Number |
The page number. |
|
page_size |
Number |
The number of items per page. |
|
total |
Number |
Total number of records available. |
Language
| Attribute | Type | Description |
| code | String | Language code in format: XX. |
| description | String | Full name of the language. |
Payment Button
| Attribute | Type | Description |
| code | String | Unique code of payment button. |
| url | String | Url address of payment button. |
| custom_name | String | Current name of the payment button. |
| amount | Number | Total amount which is the sum from single item amount and quantity of items. |
| currency | String | Currency in which the payment button is operating. |
| status | Status | Current status of the payment button. |
Payment Button Status Type
| Value | Description |
| 1 | Active |
| 2 | Disabled |
Payment Link
| Attribute | Type | Description |
| code | String | Unique code of payment link. |
| url | String | Url address of payment link. |
| custom_name | String | Current name of the payment link. |
| amount | Number | Total amount which is the sum from single item amount and quantity of items. |
| currency | String | Currency in which payment link is operating. |
| status | Status | Current status of the payment link. |
Payment Link Status Type
| Value | Description |
| 1 | Active |
| 2 | Disabled |
| 4 | Expired |
Payment Button Details
| Attribute | Type | Description |
|
created_on
|
String | Date of payment button creation. Format: YYYY-MM-DD hh:mm:ss |
|
code
|
String | Unique code of payment button. |
|
url
|
String | Url address of the payment button which is generated after the creation of this button. |
|
custom_name
|
String | Payment button name. |
|
item_name
|
String | Item name. |
|
enable
|
Boolean | Flag that provides information if this button is currently enabled or disabled. |
|
item_price
|
Number | Price of a single item. Separator is '.'. |
|
total_amount
|
Number | Multiplication of a single item price with quantity. |
|
quantity
|
Number | Items quantity |
|
button_size
|
Number | Information about button size. This size reflects on the button when it's rendering in UI. |
|
send_sms
|
Boolean | Receiving SMS when a purchase is processed. |
|
send_email
|
Boolean | Receiving email when a purchase is processed. |
|
ask_for_customer_name
|
Boolean | Require customer name on the payment page. |
|
ask_for_shipping_address
|
Boolean | Require shipping address on the payment page. |
|
ask_for_customer_email
|
Boolean | Require customer email on the payment page. |
|
ask_for_customer_phone_number
|
Boolean | Require customer phone on the payment page. |
|
currency
|
String | The currency of the account. 3 character ISO 4217 code (eg. “EUR”, “GBP”, “USD”) |
|
pref_language
|
String | Preferred language of the payment button. It's in format 'XX'. Available languages could be received from Languages |
|
website
|
String | Website address. |
|
cancel_url
|
String | Customer will be redirected on this address when cancel request is executed. |
|
return_url
|
String | Customer will be redirected on this address when retrun request is executed. |
|
account_number
|
String | Account number which is related to this payment button. |
Payment Link Details
| Attribute | Type | Description |
| created_on | String | Date of payment link creation. Format: YYYY-MM-DD hh:mm:ss |
|
code
|
String | Unique code of payment link. |
|
url
|
String | Url address of the payment link which is generated after the creation of this button. |
|
custom_name
|
String | Payment link name. |
|
item_name
|
String | Item name. |
|
enable
|
Boolean | Flag that provides information if this payment link is currently enabled or disabled. |
|
item_price
|
Number | Price of a single item. Separator is '.'. |
|
total_amount
|
Number | Multiplication of a single item price with quantity. |
|
quantity
|
Number | Items quantity |
| send_sms | Boolean | Receiving SMS when a purchase is processed. |
| send_email | Boolean | Receiving email when a purchase is processed. |
| ask_for_customer_name | Boolean | Require customer name on the payment page. |
| currency | String | The currency of the account. 3 character ISO 4217 code (eg. “EUR”, “GBP”, “USD”) |
| pref_language | String | Preferred language of the payment button. It's in format 'XX'. Available languages could be received from Languages |
| website | String | Website address. |
| account_number | String | Account number which is related to this payment button. |
| hide_quantity | Boolean | If the quantity of items is hidden or not for customers. |
| expired_date | String | Date until this payment link will be active. Format is: YYYY-MM-DD |
Payment Request Details
|
Attribute |
Type |
Description |
|
code |
String |
The code of the payment request |
|
url |
String |
Url address of created payment request. |
|
added_on |
String |
The time and date when the payment request was created. |
| client_name | String | The name of the client to whom the payment request will be sent. |
| amount | Decimal | The amount to be paid by the client. Separator is '.'. |
| currency | String | The currency, related to this payment request. Currency must be connected with some of the existing accounts (Settlement Data). |
| reason | String | A message shown to the client with the reason for the requested payment. |
| booking_text | String | Custom name of the payment request as seen in the myPOS account. |
| attempts | Number | Returns the attempts for payment by the client. |
| expiry_on | String | The time and date of expiry of the payment request. |
|
qr_generated
|
Boolean | Show if the payment request is generated as QR code. |
| String | The email address to which the payment request was sent. | |
| gsm | String | The phone number to which the payment request was sent. |
| status | Number |
Payment Request Status Type
| Value | Description |
| 1 | Pending |
| 2 | Seen |
| 3 | Failed |
| 4 | Paid |
| 5 | Expired |
| 6 | Cancelled |
Payment Request
|
Attribute |
Type |
Description |
|
code |
String |
The code of the payment request |
|
url |
String |
Url address of created payment request. |
|
added_on |
String |
The time and date when the payment request was created. |
| client_name | String | The name of the client to whom the payment request will be sent. |
| amount | Decimal | The amount to be paid by the client. Separator is '.'. |
| currency | String | The currency, related to this payment request. Currency must be connected with some of the existing accounts (Settlement Data). |
| reason | String | A message shown to the client with the reason for the requested payment. |
| booking_text | String | Custom name of the payment request as seen in the myPOS account. |
| status | Number |
Settlement Data
| Attribute | Type | Description |
| currency | String | Settlement currency. 3 character ISO 4217 code (eg. “EUR”, “GBP”, “USD”) |
| account | Account | Current associated account with this settlement currency. |
