GET
/
payment-intents
[
  {
    "id": "pi_z1urYtVFgEebtcj8fxp4v",
    "merchantId": "<string>",
    "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",
        "failure": {
          "code": "internal_error",
          "message": "<string>",
          "params": [
            "<string>"
          ]
        },
        "fees": [
          {
            "id": "lAe5HnFpvOjwdT9vSIgPA",
            "rate": 123,
            "rateType": "percent",
            "amount": 5,
            "currency": "XOF",
            "label": "<string>",
            "taxes": [
              "<string>"
            ]
          }
        ],
        "nextAction": {
          "type": "ussd",
          "message": "<string>",
          "data": {
            "url": "<string>",
            "urls": "<string>",
            "method": "post",
            "headers": {},
            "data": {}
          }
        },
        "providerReference": "<string>",
        "gatewayId": "<string>",
        "number": "<string>",
        "onSuccessRedirectionUrl": "https://my.website.com/cancel",
        "onFailedRedirectionUrl": "https://my.website.com/finish",
        "billing": {}
      }
    ],
    "mode": "live",
    "nextAction": {
      "type": "ussd",
      "message": "<string>",
      "data": {
        "url": "<string>",
        "urls": "<string>",
        "method": "post",
        "headers": {},
        "data": {}
      }
    },
    "lastPaymentFailure": {
      "code": "internal_error",
      "message": "<string>",
      "params": [
        "<string>"
      ]
    },
    "overrideBusinessName": "MyBusiness"
  }
]

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

The response is of type object[].