This API is meant to set a payment into a dossier.

Request

The type attribute has to be set to payment. The product attribute has to be set to paymentmanager.

Within the tag filters you can specify the payment details:

• code must be set with the service identification.
• datepayment must be set with the date of the payment.
• amount must be set with the value of the payment.
• currency must be set with the currency of the payment.
• method (optional) can be set with one of the following code:
  • 01 - CREDIT CARD
  • 02 - BANK TRANSFER
  • 03 - RID / SEPA Direct Debit (SDD)
  • 04 - ALLOWANCE
  • 05 - CASH
  • 06 - CREDIT
  • 07 - DEPOSIT
  • 08 - VCC
• description (optional) can be set with a small textual description of the payment

<envelope>
    <header>
    <actor>test</actor>
        <user>test</user>
        <password>test</password>
        <version>1.0.0</version>
        <timestamp>202410241450</timestamp>
    </header>
    <query type="payment" product="paymentmanager" >
        <filters>
            <filter type="payment" code="B0221BJGAM" datepayment="2024-10-24"  amount="5.00" currency="EUR" method="02" description="Payment of invoice no. 123 dated 01/03/2026"/>
        </filters>
    </query>
</envelope>

Response

<?xml version="1.0" encoding="utf-8" ?>
<envelope>
    <header>
        <version>1.0.0</version>
        <timestamp>202410241450</timestamp>
    </header>
    <response type="payment" product="paymentmanager">
        <payment>
            <status code="OK"/>
            <service code="B0221BJGAM"/>
            <payment date="2024-10-24"/>
            <amount value="5.00"/>
            <currency value="EUR"/>
        </payment>
    </response>
</envelope>

In the case of errors, the 'status' is KO and the value of 'error' contains the list of errors separated by commas.

Errors can be:

• 'no code found' when the service identifier was not found in the database

• 'error updating dossier amount' when errors are found in entering the payment value

• 'error updating dossier configuration' when errors are found in the modification of the case configuration