Refunds and transactions
In this section you will learn how to handle transaction refunds and how to use the Merchant Portal.
Transaction refunds may be ordered by the Merchant via API. For this purpose, it is necessary to prepare support for methods described in Refunds and transactions - API. Another way to execute a refund is to manually order a refund via the Merchant Portal.
The refund functionality is not available between 11 p.m. and 6:30 a.m. due to the settlement/payment process being performed on the Merchant's account at the time.
Refunds and transactions - API
The Merchant API app forming part of the InPost Pay system supplies the following services:
GET
/v1/izi/transaction
Allows to fetch a list of transactions for the authorized Merchant. A full description of fields concerning
transactions and filters that may be used to limit the returned result can be found below.POST
/v1/izi/transaction/{transaction_id}/refund
Allows to order a full or partial refund for the selected transaction
executed in one of the authorized Merchant’s stores. In the case of this service, an additional verification is carried out by verifying the message signature.
To generate a signature, it is necessary to use the secret. You can generate the secret on your own in merchant.inpost.pl or contact support at the following address: integracjapay@inpost.pl.
It is not the same client_secret used to obtain access_token. A full description how to correctly generate a message signature can be found below.
List of methods:
GET
/v1/izi/transaction
- List of transactionsPOST
/v1/izi/transaction/{transaction_id}/refund
- Returning an order
Authorization
Authentication is required and performed in the same way as for integration with InPost Pay (Basket App). It is necessary to fetch access_token using the client_id and client_secret, and then transfer it as a Bearer Token in the Authorization header.
Available environment:
Sandbox: https://sandbox-api.inpost.pl
Production: https://api.inpost.pl
REST API Specification
Merchant Panel
The Merchant Portal is a portal that allows to:
View the details of particular transactions
Effect refunds
Browse settlements
Preview signed documents
Check information on collected commissions.
Instructions on how to use the Merchant panel can be found below.
Link to the Merchant panel (refunds and transactions): https://merchant.aion.eu/
Link to the administrator panel (assigning privileges): https://merchant.aion.eu/administration
Merchant Panel operation manual
User Manual
Example settlement report
InPost Pay Transaction Panel
In the https://merchant.inpost.pl InPost Pay panel, you can orders transaction refunds and view the list of transactions for your online store.
In order to gain access to the list of transactions, enter the details of your store in the Store Details tab, navigate to the API Keys tab and click the Create Secret button that will appear in the upper right corner of the screen.
Detailed instructions on how to fill in Store Details can be found in section 3.Fill in your store details. Detailed instructions on how to generate the Secret for refunds can be found in section 6. API Keys – Merchant Secret (optional for ERP/API integration).
List of Transactions
On that screen you will see a list of all your online store transactions made via InPost Pay. This tab presents a list of transactions that allows to search for a transaction and effect a refund. The screen allows to search for transactions by using filters.
In the table you will find:
Transaction ID: Unique number identifying each transaction. It is a key number that will allow you to easily find detailed information about a specific transaction.
Creation date: Date and hour when the transaction was effected.
Status: Current status of your transaction (e.g. completed, cancelled, pending payment). The exact status will depend on the stage of the payment process.
Amount: Transaction value in PLN. Amount that was actually paid or should be paid.
Payment method: Method used by the client to make the payment (e.g. card, bank transfer, BLIK payment).
Description: A brief description of the transaction that may contain additional information about the payment.
Order ID: Order number to which the relevant transaction applies, assigned by the store. It allows to connect payments to a specific order placed by the customer. Order ID is the number before the ‘|’ symbol.
On the top of the page, you will find filters that may be used to filter the list of transactions.
Transaction details
To view the details of a specific transaction, click the three dot symbol on the right side of the relevant transaction.
The transaction details page contains the following information:
Creation Date: Date and hour when the transaction was created.
Authorization Date: Date and hour when the payment was authorized.
Amount: Displays the transaction amount in Polish zlotys (PLN).
Status: Indicates the current transaction status.
Payment Method: Indicates the payment method used by the customer.
Order Number: ID of the order connected with the transaction.
Merchant Name: Your store name.
payment_gateway_id & POS_ID: Internal payment system identifiers.
Settled: Indicates whether the transaction has already been settled.
Description: Additional information about the transaction.
Refund amount: Displays the amount that may be refunded to the customer under that transaction.
Refund type: Allows to select the type of refund (e.g. partial or full).
Amount (text field): A field used to enter the amount of refund, if it is a partial refund. If the refund is a full refund, the field is non-editable.
Refund (button): Allows to send a request to make a refund to the customer.
The refund functionality is not available between 11 p.m. and 6:30 a.m. due to the settlement process being performed on at that time. This means that a refund request may be sent only outside these hours.
Effecting a refund
Refunds are possible, if their amount does not exceed the current balance on the store’s account. A specific amount may be secured on the account for refund purposes, to do so please contact bok.pay@inpost.pl.
The refund functionality is not available between 11 p.m. and 6:30 a.m. due to the settlement process being performed on at that time.
On business days, after 6:30 a.m., funds from your store’s account are transferred to the bank account indicated in the contract! To change that cycle, please contact bok.pay@inpost.pl.
To effect a refund, go to transaction details of the transaction you want to refund.
In the "Refund" section, select the type of refund: "Full" (full refund) or "Partial" (partial refund).
If you select "Partial", enter the requested refund amount in the appropriate field.
Once type and amount of refund have been selected, click the "Refund" button. The system will display a refund summary window containing the most important information (transaction ID, refund amount). Check whether the information is correct and click "Confirm refund".
Once the system has successfully sent the refund request, the system will display a confirmation message. Information on the refund status will be available in transaction history.
List of refunded transactions
In the refund tab, you will see the only the list of transactions that have been refunded in full.
Important information:
Always diligently check the information being entered before confirming a refund.
In the event of any issues or doubts, please contact customer service at the following address: bok.pay@inpost.pl.