GET
/
payment-intents

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

customerReference
string

The reference you provided during the creation of the payment intent. It is a reference to the customer for who this payment intent was created.

purchaseReference
string

The reference you provided during the creation of the payment intent. It is a reference to the purchase made by the customer for who this payment intent was created.

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 PaymentIntent

merchantId
string
required

Identifier of the merchant owning this PaymentIntent

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.

token
string
required

A unique JSON Web Token allowing to attempt a Payment on the PaymentIntent on a client-side application.

purchaseReference
string
required

A reference provided by the client during the creation of this PaymentIntent

customerReference
string
required

A reference provided by the client during the creation of this PaymentIntent. It is a reference to the customer for who this PaymentIntent was created.

status
enum<string>
required

The current status of this PaymentIntent

Available options:
action_required,
canceled,
payment_required,
processing,
successful
amount
number
required

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

payments
object[]
required

List of Payment attempts made on this PaymentIntent

mode
enum<string>
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.

Available options:
live,
sandbox
nextAction
object

Action required to execute to continue the processing of the current Payment on this PaymentIntent. 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.

lastPaymentFailure
object

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

overrideBusinessName
string

For Aggregator, name of the merchant

Send SmsCreate a PaymentIntent object