Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Payments

Retrieve a Payments collection

Return a list of Payments, eventually filtered by criteria.

get/payments

Query parameters

isDelegatedboolean
Example:true

Only transactions matching the given delegated status

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 Payment

intentIdstring required

Unique identifier for the PaymentIntent owning this Payment

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.

status'created' | 'failed' | 'pending' | 'successful' required

Current status of this Payment

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

currencystring required

Three-letter ISO currency code.

method'mobile_money' | 'credit_card' | 'bank_transfer' required

The method selected by the customer to make this Payment

countrystring required

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

providerReferencestring required

provider reference that identify this payment

gatewayIdstring required

gatewayId used for this payment (Mobile Money Only)

numberstring required

The identifier referencing the payment method of the customer. - In case of a payment by Mobile Money, it corresponds to the customer phone number corresponding to his Mobile Money account, - In case of a payment by Credit Card, it corresponds to the four last digits of the customer's credit card number.

isDelegatedboolean

Indicates whether this payment is a delegated payment.

Example response

[
  {
    "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": "mobile_money",
    "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"
    }
  }
]