Create a Payment

Payments are integral to the debt collection process, enabling clients and customers to settle outstanding claims. Our Collection API differentiates between two primary types of payment scenarios:

Payment to Riverty

In this scenario, the customer (debtor) makes a payment directly to Riverty. This often follows the receipt of a dunning letter that instructs the debtor to make payments towards their outstanding debt. When this occurs, the client can call the transaction endpoint to retrieve the payment information related to a specific claim.

Payment to Client

Alternatively, the customer may opt to make payment directly to the client towards a specific claim. It is then the client’s responsibility to update Riverty with the details of this payment by calling the endpoint highlighted above to ensure the claim records are accurate and up-to-date.

Endpoint

GET {{collection_api_base_url}}/v1/claims/{claimNumber}/payments

Sample Request Body

{
    "invoiceNumber": "I0417211448",
    "paymentNumber": "P5803137068",
    "date": "2023-06-23",
    "contractNumber": "12677889976666",
    "description": "Quia molestias voluptates vero harum ea ea iste animi est.",
    "amount": 150,
    "currency": "EUR",
    "allocateTo": "PRINCIPAL_CLAIM"
}
´´´

### Sample Response

```json
{
  "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
´´´

Tracking and Retrieving Payment Information

Clients can accurately track and confirm payments made towards a claim by using the transactions endpoint. This endpoint allows clients to retrieve payment information related to a specific claim.

Important Note:
An accounting document is created for each payment processed, which provides a detailed record of the transaction. The type of the accounting document depends on who received the payment:

• agency_payment: Created when the payment is made directly to Riverty.
• direct_payment: Created when the payment is made to the client and then updated in Riverty's system.

Check our documentation on accounting document to learn more.