Create a PaymentIntent object
This endpoint is the first entry point of the PAY-IN circuit. First of all, you must create a payment intent which describes your intention to collect an amount of money in a currency. Later on, you will perform payments associated with this payment intent. Please do save the fields returned by this endpoint, especially the field ‘id’ and ‘token’. That will help you identity the payment intent in our platform whenever you want to retrieve it.
Headers
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.
Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.
Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.
live, sandbox Body
This is a custom field you can fill with any reference you have on your side matching this payment intent. It can allow you to make a correspondence with this payment intent in your system. This field is specifically useful for customer's references, like your customer ID.
This is a custom field you can fill with any reference you have on your side matching this payment intent. It can allow you to make a correspondence with this payment intent in your system. This field is specifically useful for purchase's references, like an order your customer made.
Amount intended to be collected by this payment intent. 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).
Three-letter ISO currency code.
This field is mandatory for aggregators and allows you to override the business name displayed to the end users. This is useful if you don't want your clients to see "Hub2" as the target of their payment but your company name instead.
Response
Unique identifier for the PaymentIntent
Identifier of the merchant owning this PaymentIntent
Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.
Datetime in UTC timezone at which this object was updated for the last time . Follows the Datetime ISO.
A unique JSON Web Token allowing to attempt a Payment on the PaymentIntent on a client-side application.
A reference provided by the client during the creation of this PaymentIntent
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.
The current status of this PaymentIntent
action_required, canceled, payment_required, processing, successful 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).
Three-letter ISO currency code.
List of Payment attempts made on this PaymentIntent
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.
live, sandbox 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.
In case of a Payment attempt failure, this object will describe the reason of the failure
For Aggregator, name of the merchant