View Categories

Get Invoice

< 1 min read

Use this GET request to retrieve invoice informations.

{{base_url}}/api-services/v1/invoice/type_facturier={type}&reference={reference}

The parameter type_facturier defines the type of billing and accepts two values: ‘TEMP’ or ‘REGULAR’.

The parameter reference is the invoice reference returned after calling the ‘Post invoice’ API. It accepts multiple lengths:

  • 8 characters
  • 12 characters
  • 10 characters

Headers

Parameter NameValueMandatoryDescription
apikeyStringYesyour API key (provided by RichattPay)
Accept-Languageen: default
fr
An optional indicator to specify the preferred language.

Example of successful response

{
    "invoice_reference": "100287931441",
    "amount": 500.0,
    "du_date": null,
    "ispartialok": true,
    "client_name": "Mohamed Abdel Kerim",
    "label": null
}

Examples of error response

Status(403)

{"error":" The API key is missing or expired"}