The Confirmation Object

Once a claim has been successfully processed, a confirmation can be retrieved. This confirmation includes essential details that can be used for tracking and referencing the claim within the client's system.

Attributes

Attributes	Type	Description
`date`	date	The date of the payment.
`type`	enum	This represent the type of confirmation. enum: `INVOICE`, `CLIENT_INTERESTS`, `CLIENT_COSTS`, `CREDIT_WAIVER`, `DIRECT_PAYMENT`, `RECALL`
`number`	string	Number of the payment, provided by the client or the agency.
`contractNumber`	string	The number assigned by client for each contract associated with the claim.
`amount`	number	The amount paid by the customer.
`currency`	string	This reflects all relevant currencies in ISO-4217.

Sample Request:

GET {{collection_api_base_url}}/v1/transactions?from=2024-05-22&to=2024-05-23&type=confirmation

Sample Confirmation Object

{
    "confirmation": {
        "date": "2023-01-12",
        "type": "INVOICE",
        "number": "I87999387",
        "contractNumber": "V113951839",
        "amount": 43.76,
        "currency": "EUR"
    }
}

Do you find this page helpful?