Get Transaction
GET/v1/transactions/:transaction_id
Get Transaction
Request
Path Parameters
Responses
- 200
- 400
- 401
OK
Response Headers
Date
string
Content-Type
string
Transfer-Encoding
string
Connection
string
Set-Cookie
string
Access-Control-Allow-Origin
string
Access-Control-Allow-Methods
string
Access-Control-Allow-Headers
string
X-Request-ID
string
- application/hal+json
- Schema
- Example (from schema)
- Example
Schema
_links
object
self
object
Unique identifier for the transaction
Type of the transaction object
Timestamp when the transaction was created
Timestamp when the transaction was completed. Optional field, displayed only when transaction is completed
Timestamp when the transaction was refunded. Optional field, displayed only when transaction is refunded
Current status of the transaction
Merchant's reference number for the transaction
customer
object
The customer information related to this transaction
The unique identifier for the customer
The type of object (e.g., customer)
The timestamp when the customer was created
The email address of the customer
The locale of the customer, representing language and region
The country of the customer
The IP address of the customer
The country associated with the customer's IP address
The name of the customer
Amount refunded for this transaction. Optional field, displayed only when transaction is refunded
Original amount refunded. Optional field, displayed only when transaction is refunded
Type of transaction. Shows payment type - banklink or card
Payment method used in the transaction
Payment channel through which the transaction was made
Country where the transaction was made
Transaction fees. Optional field, displayed only when transaction is completed
VAT on transaction fees. Optional field, displayed only when transaction is completed
Net amount received by the merchant. Optional field, displayed only when transaction is completed
Additional merchant-specific data
banklink
object
Details of banklink payment. Optional field, displayed only when transaction type is banklink
The type of object, e.g., 'banklink_payment'.
The date and time when the payment was created, in ISO 8601 format.
The International Bank Account Number associated with the payment.
A description of the payment.
card
object
Details of Card payment. Optional field, displayed only when transaction type is card
Name of the cardholder
Masked card number used in the payment
Expiry date of the card
Type of card (e.g., Visa, MasterCard)
transaction_url
object
return_url
object
The URL and HTTP method to redirect after a successful operation
The URL to return to
The HTTP method (e.g., GET, POST) for the return link
cancel_url
object
The URL and HTTP method to redirect when the operation is canceled
The URL to return to
The HTTP method (e.g., GET, POST) for the return link
notification_url
object
The URL and HTTP method for notifications regarding the operation
The URL to return to
The HTTP method (e.g., GET, POST) for the return link
cart_url
object
The URL and HTTP method to access the shopping cart
The URL to return to
The HTTP method (e.g., GET, POST) for the return link
Indicates if recurring payments are required
{
"_links": {
"self": {
"href": "string"
}
},
"id": "string",
"object": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"completed_at": "2024-07-29T15:51:28.071Z",
"refunded_at": "2024-07-29T15:51:28.071Z",
"status": "string",
"reference": "string",
"customer": {
"id": "string",
"object": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"email": "string",
"locale": "string",
"country": "string",
"ip": "string",
"ip_country": "string",
"name": "string"
},
"refunded_amount": 0,
"refunded_original_amount": 0,
"type": "string",
"method": "string",
"channel": "string",
"country": "string",
"fees": 0,
"fees_vat": 0,
"net_amount": 0,
"merchant_data": "string",
"banklink": {
"object": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"iban": "string",
"description": "string"
},
"card": {
"card_holder_name": "string",
"card_number": "string",
"expiry_date": "string",
"card_type": "string"
},
"transaction_url": {
"return_url": {
"url": "string",
"method": "string"
},
"cancel_url": {
"url": "string",
"method": "string"
},
"notification_url": {
"url": "string",
"method": "string"
},
"cart_url": {
"url": "string",
"method": "string"
}
},
"recurring_required": true
}
{
"_links": {
"self": {
"href": "https://api.test.maksekeskus.ee/v1/transactions/1fea72b7-cc54-4844-8409-5ff188eb40c3"
}
},
"amount": 75.95,
"channel": null,
"country": "ee",
"created_at": "2024-01-06T12:04:14+0000",
"currency": "EUR",
"customer": {
"country": "ee",
"created_at": "2024-01-06T12:04:14+0000",
"email": "mk.test@maksekeskus.ee",
"id": "d4c7bcc8-c962-49d9-b18b-a9c79fdbd8cc",
"ip": "10.128.96.76",
"locale": "en",
"name": "d4c7bcc8-c962-49d9-b18b-a9c79fdbd8cc",
"object": "customer"
},
"id": "1fea72b7-cc54-4844-8409-5ff188eb40c3",
"merchant_data": "Internal Order ID: 321",
"method": null,
"object": "transaction",
"recurring_required": false,
"reference": "123abc",
"status": "CREATED",
"transaction_url": {
"cancel_url": {
"method": "POST",
"url": "https://example.com/cancel_url"
},
"cart_url": null,
"notification_url": {
"method": "POST",
"url": "https://example.com/notification_url"
},
"return_url": {
"method": "POST",
"url": "https://example.com/return_url"
}
},
"type": null
}
Bad Request
Response Headers
Date
string
Content-Type
string
Transfer-Encoding
string
Connection
string
Set-Cookie
string
Access-Control-Allow-Origin
string
Access-Control-Allow-Methods
string
Access-Control-Allow-Headers
string
X-Request-ID
string
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Error code indicating the type of error
Error message describing the issue
errors
object[]
Type of error
Parameter in the request that caused the error
The expected value or format for the parameter
{
"code": 1001,
"message": "Invalid request",
"errors": [
{
"type": "string",
"parameter": "transaction",
"expected": "string"
}
]
}
{
"code": 1001,
"message": "Invalid request",
"errors": [
{
"type": "invalid",
"parameter": "transaction",
"expected": "correct UUID"
}
]
}
Unauthorized
Response Headers
Date
string
Content-Type
string
Transfer-Encoding
string
Connection
string
Set-Cookie
string
WWW-Authenticate
string
- application/json
- Schema
- Example (from schema)
- Example
Schema
Error code representing the type of error.
Detailed error message.
{
"code": 0,
"message": "string"
}
{
"code": 1004,
"message": "Unauthorized"
}