Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Payments

Retrieve a PaymentIntent collection

This endpoints is here to provide you an efficient way of retrieving multiple payment intents at the same time. Everything is provided in the request's headers to perform a proper pagination on the results.

get/payment-intents

Query parameters

customerReferencestring
Example:cust_01924059

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.

purchaseReferencestring
Example:ref_2020_11_10_001

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.

tostring
Example:2020-10-15T12:09:49.355Z

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

fromstring
Example:2020-10-15T12:09:49.355Z

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

pagenumber
Example:2

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

perPagenumber
Example:5

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

Headers

ApiKeystring 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.

MerchantIdstring 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'live' | 'sandbox' required

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

Response

idstring required

Unique identifier for the PaymentIntent

merchantIdstring required

Identifier of the merchant owning this PaymentIntent

createdAtstring required

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

updatedAtstring required

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

tokenstring required

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

purchaseReferencestring required

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

customerReferencestring 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'action_required' | 'canceled' | 'failed' | 'payment_required' | 'processing' | 'successful' required

The current status of this PaymentIntent

amountnumber 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).

currencystring required

Three-letter ISO currency code.

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.

overrideBusinessNamestring

For Aggregator, name of the merchant

subMerchantIdstring

Submerchant ID

Example response

[
  {
    "id": "pi_z1urYtVFgEebtcj8fxp4v",
    "createdAt": "2020-10-15T12:09:49.355Z",
    "updatedAt": "2020-10-15T12:16:26.128Z",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElkIjoiMTYiLCJtb2RlIjoic2FuZGJveCIsInBheW1lbnRJZCI6InBpX3oxdXJZdFZGZ0VlYnRjajhmeHA0diIsImlhdCI6MTYwMjc1OTE4M30.OZ0fDnMVWvcT-gRthyBD58PFC20gabGKt1UPRe4aNi4",
    "purchaseReference": "ref_2020_11_10_001",
    "customerReference": "cust_01924059",
    "status": "successful",
    "amount": 100,
    "currency": "XOF",
    "payments": [
      {
        "id": "pay_QW2d6JnqiatcH8KhK0mD1",
        "intentId": "pi_z1urYtVFgEebtcj8fxp4v",
        "createdAt": "2020-10-15T12:09:49.355Z",
        "updatedAt": "2020-10-15T12:16:26.128Z",
        "status": "successful",
        "amount": 100,
        "currency": "XOF",
        "method": "credit_card",
        "country": "CI",
        "fees": [
          {
            "id": "lAe5HnFpvOjwdT9vSIgPA",
            "amount": 5,
            "currency": "XOF"
          }
        ],
        "nextAction": {
          "data": {
            "method": "post"
          }
        },
        "paymentInformation": {
          "recipient_name_hashmac": "a1b2c3d4e5f6",
          "recipient_phone_hashmac": "a1b2c3d4e5f6",
          "customer_id_hashmac": "a1b2c3d4e5f6"
        },
        "onSuccessRedirectionUrl": "https://my.website.com/cancel",
        "onFailedRedirectionUrl": "https://my.website.com/finish"
      }
    ],
    "mode": "live",
    "nextAction": {
      "data": {
        "method": "post"
      }
    },
    "overrideBusinessName": "MyBusiness",
    "subMerchantId": "submerchant_123"
  }
]