Retrieve Your Claim Number

To retrieve the claim number assigned by the collection backend for a claim handover request, follow these steps using our transaction endpoint:

Send the Request
Send a GET request to the transaction endpoint, ensuring the access token is included in the authorization header. Specify the time period during which the desired transaction occurred (i.e., when the claim handover request was sent):

from : A valid start date of the desired transaction.
to : A valid end date

Check the Response
A successful request will return a 200 OK. In the response body, check if the claim handover was successful or not. A successful claim request will have "type": "CONFIRMATION" and an unsuccessful will have "type": "REJECTION". The associated claim number for the request can be found included in the JSON response.

Save the Claim Number
Ensure to save the claim number, as it is an important parameter for following up on or getting details about a specific claim.

Sample Request

GET {{collection\_api\_base\_url}}/v1/transactions?from=2024-05-22T00:00:00Z&to=2024-05-22T11:13:59Z
Content-Type: application/json
Authorization: Bearer {{access\_token}}

Sample Response

[
  {
    "sortNumber": 1,
    "id": "ea9011de-726e-4127-8057-55f2e863b14a",
    "type": "CONFIRMATION",
    "customerNumber": "400000535",
    "claimNumber": "DE-S242243324007",
    "confirmation": {
      "date": "2024-05-22",
      "type": "CLIENT_COSTS",
      "number": "117976352",
      "amount": 16,
      "currency": "EUR",
      "additionalProperties": {}
    }
  },
  {
    "sortNumber": 2,
    "id": "1fd1a0f2-3b5a-477e-a29b-b7b6bdbee429",
    "type": "CONFIRMATION",
    "customerNumber": "400000535",
    "claimNumber": "DE-S242243324007",
    "confirmation": {
      "date": "2024-05-22",
      "type": "INVOICE",
      "number": "318040697",
      "amount": 160,
      "currency": "EUR",
      "additionalProperties": {}
    }
  }
]

Please Note: The claim number is included in the JSON response body of a successful GET transaction request (see the sample response below).