v1

latestOpenAPI 3.0.02026-07-265892227.1 KB

Receipt

Retrieve a Receipt

Retrieve a sucessful or failed transfer or payment receipt

get/receipts/{id}

Path parameters

idstring required

Identifier can be receiptId or transactionId (ex: TransferId)

Query parameters

isReceiptIdentifierboolean

Indicate if the provided identifier is a receipt id (true) or a transfer or payment id (false).

Response

idstring required

Unique identifier for the Receipt

datestring required

Datetime in UTC timezone at which the associated transaction was successful. Follows the Datetime ISO.

descriptionstring required

An arbitrary string attached to the Transfer. Mostly useful for displaying to user.

transactionIdstring required

Unique identifier for the associated transaction

operatorReferencestring required

Merchant transaction number

referencestring required

Customer transaction number

customerNumberstring required

Customer full identifier (aka msisdn, ..)

amountnumber required

Amount intended to be sent to the recipient. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).

currencystring required

Three-letter ISO currency code.

method'mobile_money' | 'bank_transfer' | 'airtime' required

The method selected to make this Transfer

countrystring required

Two-letter ISO country code. Represents the country where the provider selected by the customer is localized.

providerstring required

The name of the provider selected by the customer, in lowercase. The list of supported providers can be found at /data/providers

mode'live' | 'sandbox' required

Mode in which this PaymentIntent exists. The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode. The live mode has to be used to make real transactions.

Example response

{
  "id": "rc_z1urYtVFgEebtcj8fxp4v",
  "date": "2020-10-15T12:16:26.128Z",
  "amount": 100,
  "currency": "XOF",
  "method": "mobile_money",
  "country": "CI",
  "provider": "orange",
  "mode": "live"
}