Transaction API
Create Transaction
Last Updated: 15 October 2024Use this POST request to initiate a transaction related to one of the listed services. Note: It is essential to consult the list of available services to ensure that the service you wish to use is included. Headers Parameter Name Value Mendatory Description apikey String Yes your API key (provided by RichattPay) Accept-Language en: defaultfr An optional indicator to specify the preferred language. Body The variables Variable Type Description Mandatory institutionSender String(255) The name of the organization. Yes senderId String(255) The identifier of the sender, typically a passport number or similar. Example: BG00145200 Yes senderGender String(1) The gender of the sender. Acceptable values: M (Male), F (Female). Yes senderName String(255) The last name of the sender. Yes senderFstName String(255) The first name of the sender. Yes senderPhone String(32) The phone number associated with the sender. No senderEmail String(255) The email address of the sender. No senderAddress String(255) The postal address of the sender. No senderCity String(255) The city of the sender. Yes senderCountry String(3) The country of the sender following the ISO 3166-1 alpha-3 specification. Must be exactly 3 characters. Yes senderNationality String(3) The nationality of the sender following the ISO 3166-1 alpha-3 specification. Must be exactly 3 characters. Yes senderDateOfBirth Date The birth date of the sender in YYYY-MM-DD format. No beneficiaryId String(255) The identifier of the beneficiary. No beneficiaryGender String(1) The gender of the beneficiary. Acceptable values: M (Male), F (Female). Default value = M Yes beneficiaryName String(255) The last name of the beneficiary. Yes beneficiaryFstName String(255) The first name of the beneficiary. Yes beneficiaryPhone String The phone number associated with the beneficiary. No beneficiaryEmail String(255) The email address of the beneficiary.Must be a valid email. No beneficiaryAddress String(255) The postal address of the beneficiary. No benefciaryCity String(255) The city of the beneficiary. No beneficiaryCountry String(3) The country of the beneficiary following the ISO 3166-1 alpha-3 specification. Must be exactly 3 characters. Yes beneficiaryNationality String(3) The nationality of the beneficiary followingthe ISO 3166-1 alpha-3 specification. Must be exactly 3 characters. Yes relationWithSender String(255) The relationship of the beneficiary to the sender. No externalTransactionId String(255) The external identifier of the transaction. Yes amount Double The amount of the transaction. Must be between 100 and 10,000,000 MRU. Yes beneficiaryWallet String(255) The wallet number of the beneficiary.Must be an 8-digit number starting with 2, 3, or 4 Yes beneficiaryAccountNumber String(14) The account number associated with the transaction. Must be exactly 23 digits (RIB format).Mandatory when service is XXX_BANK_CASH_IN. Yes codeService String(255) The code identifying the service used for the transaction. Yes callbackUrl String(255) The URL to which transaction notifications will be sent. Yes Example of successful response Examples of error response To check the error responses, please refer to the list of errors. Status(514)
New Claim
Last Updated: 17 October 2024To file a complaint related to a transaction, the partner can send a POST request to the following URL, including the subject of the complaint, the message, and the transaction ID. Headers Parameter Name Value Mendatory Description apikey String Yes your API key (provided by RichattPay) Body Example of successful response Examples of error response Status(403) Status(404) Status(500)
Transaction status
Last Updated: 10 October 2024the partner has the ability to check the status of the transaction by making a POST request to the fomowing URL, with the external transaction ID in the body of the request. Note: If you call this resource more than 3 times per minute for the same transaction, your IP address may be blocked. Headers Parameter Name Value Mandatory Description apikey String Yes your API key (provided by RichattPay) Body Example of successful response Examples of error response Status(403) Status(404) Status(500) The different transaction statuses:
Balance
Last Updated: 10 October 2024By making a GET request to the following URL, the partner can check their balance. Headers Parameter Name Value Mendatory Description apikey String Yes your API key (provided by RichattPay) Example of successful response Examples of error response Status(403) Status(500)
List of errors
Last Updated: 11 October 2024To test the Transaction API, generate an API key from your partner space in the RichattPay application.Once you have obtained this key, insert it into a GET request to view the list of potential errors via the following URL: Headers Parameter Name Value Mandatory Description apikey String Yes your API key (provided by RichattPay) Accept-Language en: defaultfr An optional indicator to specify the preferred language. This endpoint allows you to retrieve the list of potential errors that may occur during a transaction submission. It provides detailed information about the types of errors you might encounter, whether they are related to the provided data, connection issues, or service-specific restrictions. Example of successful response The response will be an object containing the list of errors. Examples of error response Status(403) Status(500)
