Payment receipts and credit references
Financial Line provides the ability to generate receipts in the form of a PDF file or raw HTML for successful payments/operations. Such receipts may be generated in PDF and raw HTML formats for the following operations: purchase (regular and split payments), auth, and credit.
The receipts for the incoming transactions (purchase, auth) include such data as:
- Receipt/transaction number
- Payer's full name
- Card mask and its brand
- Payer's taxpayer identification number
- Payer's identifier in your system
- Your business name
- Your business identification code
- Your business IBAN
- Order amount
- External fee
- Total amount
- Transaction date and time
- Value date
- Payment purpose
- Your business website
- Identifier in the acquiring bank
- Authorization code
- Type of operation
- Acquirer identifier
- Payment device identifier
- Information about the financial company through which the payment was processed
The receipts (payment instruction) for outgoing transactions (credit) may contain the following information:
- Payment instruction/transaction number
- Your business name
- Your business identification code
- Your business IBAN
- Your business website
- Recipient's full name
- Recipient's card mask and its brand
- Recipient's taxpayer identification number
- Recipient's identifier in your system
- Amount
- Date and time of acceptance for execution
- Date and time of the transaction
- Order number
- Identifier in the acquiring bank
- Authorization code
- Type of operation
- Acquirer identifier
- Payment device identifier
- Information about the financial company through which the transaction was processed
The list of fields contained in receipts depends on the amount of information transmitted in each individual payment request.
You can obtain receipts using one of the following methods:
- Automatic delivery of receipts to your email for payments made within a specific project (for purchase transactions only).
- Retrieving receipts through an API request.
- Manual download of receipts via the merchant portal.
Additionally, for credit transactions, you can obtain references that are official documents (outgoing letters) from financial companies confirming the fact that the payment instruction for crediting funds to the recipient (borrower) has been accepted for execution. Such documents are signed with the financial company's qualified electronic signature (QES), which can be verified using publicly available resources, such as the Diia website.
To gain access to working with credit references, please contact Financial Line Support.
Credit references contain the following information:
- Unique outgoing number
- Date of reference issuance
- Date of the credit transaction
- Unique transaction identifier
- Amount transferred to the borrower and the currency
- Borrower's full name and card mask
References reissued for the same transactions will have a new number.
Ways to obtain credit references:
- Receiving references via an API request.
- Manually downloading references through the merchant portal.
Automatic receipt delivery
The automatic receipt delivery option allows for emails with receipts in PDF format to be sent to the specified email address for every successful transaction of the above-mentioned types. To configure this receipt delivery method, please contact Financial Line Support.
API-Based receipt and credit reference downloads
We offer the option to request receipts through our API. This method enables receiving receipts in either HTML or PDF formats.
To receive a receipt for a particular payment, the GET
HTTP method request must be made, including the following set of parameters:
Path variables:
Parameter | Type | Required | Description |
---|---|---|---|
POS_ID | UUID | ✅ | Merchant's identifier (POS_ID) |
ORDER_ID | String | ✅ | Merchant's order identifier |
Query parameters:
Parameter | Type | Required | Description |
---|---|---|---|
TRANSACTION_ID | UUID | Mandatory for credit transactions. If not provided, the receipt for the incoming transaction within the order will be received | |
FORMAT | String | ✅ | Receipt format (html, pdf) |
Request example:
$ curl -i "http://api.finline.io/api/v1/pos/${POS_ID}/orders/${ORDER_ID}/report/receipt?transactionId=TRANSACTION_ID&format=pdf" \
-H "Content-Type: application/json" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"
The response to the request will be provided in raw HTML format.
To obtain credit reports, the query parameter FORMAT
must contain the value: signed_pdf
Additionally, the request must also include an additional query parameter:
Parameter | Type | Required | Description |
---|---|---|---|
CREDIT_REFERENCE | boolean | ✅ | When true is passed, a credit reference will be received |
Request example:
$ curl -i "http://api.finline.io/api/v1/pos/${POS_ID}/orders/${ORDER_ID}/report/receipt?transactionId=TRANSACTION_ID&creditReference=true&format=pdf" \
-H "Content-Type: application/json" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"
If needed, you can also retrieve receipts for all successful transactions of a specific type made on a specific date. To do so, you must include the following set of parameters in your request:
Parameter | Type | Required | Description |
---|---|---|---|
POS_ID | String | ✅ | Merchant's identifier (POS_ID ) |
DATE | String | ✅ | Date in yyyy-MM-dd format |
FORMAT | String | ✅ | Receipt format (html, pdf) |
METHOD | ENUM | Payment method (purchase, auth, credit). If not provided, receipts for purchase and auth transactions will be sent |
Request example:
$ curl -i "https://api.finline.io/api/v1/pos/${POS_ID}/date/${DATE}/re port/receipt?format=${FORMAT}" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"
In response to such a request, a ZIP archive containing all receipts for transactions of the corresponding type conducted on the date specified in the request will be sent to you.
Receipts for a specific date cannot be obtained for purchase transactions involving split payments.
To obtain credit references for credit transactions over a certain period, the request must contain the following parameters:
Parameter | Type | Required | Description |
---|---|---|---|
POS_ID | String | ✅ | Merchant's identifier (POS_ID ) |
DATE | String | ✅ | Date in yyyy-MM-dd format |
FORMAT | String | ✅ | signed_pdf |
METHOD | ENUM | Credit |
Request example:
$ curl -i "https://api.finline.io/api/v1/pos/${POS_ID}/date/${DATE}/re port/receipt?format=signed_pdf&method=credit" \
-H "X-API-AUTH: CPAY ${API_KEY}:${API_SECRET}" \
-H "X-API-KEY: ${ENDPOINTS_KEY}"
In response to such a request, a ZIP archive containing all credit references for credit transactions conducted during the period specified in the request will be sent to you.
Downloading receipts and credit references through the merchant portal
The way to download receipts/credit references via the merchant portal:
Proceed to the "Transactions" section, find the required transaction, click the button to initiate additional actions, and select the corresponding option from the list.
In the "Transactions" section, find the required transaction and view its details by clicking on the corresponding record. In the details of the transaction, select the corresponding option from the list of additional actions located in the upper right corner of the page.
Once you have followed one of these ways, the receipt/credit reference file will be automatically downloaded to your computer or mobile device.