Get Payments

This is a focused description of how to get payment information from the Deliveries endpoint, and explains what data you are receiving

To receive payment information, you need to make a GET request to the Deliveries endpoint with the following parameters:

URL-ParameterValue
Statusnew
TypePayment
DirectionFarPayToCompany
FromDate(Format: yyyyMMdd)
ToDate(Format: yyyyMMdd)
Remark!

Note that FromDate and ToDate are not mandatory parameters, but they are highly recommended to provide a precise scope of the deliveries you are receiving.

When a delivery is received, it will contain a Base64-encoded document that your system needs to retrieve and decode to a clear text presentation.

Example delivery

{
  "Id": 123456789,
  "DeliveryFormat": "FormatXML",
  "DeliveryStatus": "New",
  "ErrorMessage": null,
  "DeliveryType": "PaymentResponse",
  "InvoiceNumber": null,
  "File": {
    "Filename": "PaymentsMP_202511234567887654.xml",
    "Data": "PD94bWwgdmVyc2lvbjvWE1MU2NoZW1hLW....nRzPg0K"
  }
}

In the File.Data field, there is the actual payment file in Base64 format. Now, decode the string and process the payment file.

<?xml version="1.0" encoding="UTF-8"?>
<Payments xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://app.farpay.io/xsd/payments.xsd">
  <PayeeParty>
    <ID schemeID="CVR">12345678</ID>
  </PayeeParty>
  <BankTotal>
    <PaymentTotal>2.25</PaymentTotal>
    <PayoutTotal>0.00</PayoutTotal>
  </BankTotal>
  <Payment>
    <PaymentID>11111</PaymentID>
    <PaymentType>MPS</PaymentType>
    <PaymentStatus>Paid</PaymentStatus>
    <PaymentSign>Payment</PaymentSign>
    <Amount>1.25</Amount>
    <PaymentReference>o0001</PaymentReference>
    <PaymentDate>2025-12-04</PaymentDate>
    <PaymentDueDate>2025-12-06</PaymentDueDate>
    <InvoiceNumber>10045</InvoiceNumber>
    <CustomerNumber>24112025</CustomerNumber>
    <AccountNumber>12345</AccountNumber>
  </Payment>
  <Payment>
    <PaymentID>11112</PaymentID>
    <PaymentType>MPS</PaymentType>
    <PaymentStatus>Paid</PaymentStatus>
    <PaymentSign>Payment</PaymentSign>
    <Amount>1.00</Amount>
    <PaymentReference>o0002</PaymentReference>
    <PaymentDate>2025-12-04</PaymentDate>
    <PaymentDueDate>2025-12-06</PaymentDueDate>
    <InvoiceNumber>10044</InvoiceNumber>
    <CustomerNumber>24112026</CustomerNumber>
    <AccountNumber>12345</AccountNumber>
  </Payment>
</Payments>

The payment information will have various payment types, based on the actual payment processor.