Skip to Main Content
Riverty Docs
    riverty logo Docs

    Create a Payment Cancellation

    Path

    POST /claims/{claimNumber}/accountingDocuments/cancellations

    Request Parameters

    claimNumber
    required
    string
    Refers to an existing claim

    Request Body

    application/json

    referenceNumber
    string
    Max length: 40
    The payment number assigned by the client for each payment. It is optional, but it should be included if possible, as it allows us to ensure that payments sent twice are only processed once.
    date
    string
    yyyy-MM-dd
    Max length: 10
    The date of the payment.
    amount
    number
    Max length: 12
    This is a description of the payment.
    currency
    string
    Max length: 3
    This reflects all relevant currencies in ISO-4217.

    Responses

    Successful Request

    Request Example

        
        {
 "date": "2024-07-23",
 "amount": 0,
 "currency": "str",
 "referenceNumber": "string"
}

    Response Example

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