GET
/
payments

Headers

ApiKey
string
required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId
string
required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment
enum<string>
required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:
live,
sandbox

Query Parameters

to
string

A date in UTC timezone to filters data to, inclusively. Follows the Datetime ISO. The default value is now().

from
string

A date in UTC timezone to filters data from, inclusively. Follows the Datetime ISO. The default value is the first day of this month.

page
number

The page number in the returned data. The default value is 1. Do use with 'perPage' query parameter to paginate properly.

perPage
number

The maximum number of results that will be return. The default value is 10. Do use with 'page' query parameter to paginate properly.

Response

200 - application/json
id
string
required

Unique identifier for the Payment

intentId
string
required

Unique identifier for the PaymentIntent owning this Payment

createdAt
string
required

Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.

updatedAt
string
required

Datetime in UTC timezone at which this object was updated for the last time . Follows the Datetime ISO.

status
enum<string>
required

Current status of this Payment

Available options:
created,
failed,
pending,
successful
amount
number
required

Amount intended to be collected by this payment. 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).

currency
string
required

Three-letter ISO currency code.

method
enum<string>
required

The method selected by the customer to make this Payment

Available options:
mobile_money,
credit_card
country
string
required

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

failure
object

In case of a Payment attempt failure, this object will describe the reason of the failure

fees
object[]
required

Some fees may be applied on a Payment. This array provides information of the fees that could have been applied on this Payment.

nextAction
object

Action required to execute to continue the processing of this Payment. The action allows the customer to validate the Payment. - A redirection action provides all the information to redirect the customer to an external page, - A ussd action provides a message to display to the user for the validation of the Payment. He will receive a USSD message on his phone describing how to make the validation, - A otp action requires that you display an input to the customer to collect an OTP. A message is provided to explains to the user how to get this OTP. Then, the client will have to send the authentication request.

providerReference
string
required

provider reference that identify this payment

gatewayId
string
required

gatewayId used for this payment (Mobile Money Only)

Retrieve configured URLsRetrieve a Provisionings collection