Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Payments

Synchronously attempt a payment on a payment intent

This is the same endpoint but the payment is handled synchronously, it means it will wait for the provider response before returning the status of the payment intent. This endpoint is not the favored way to integrate our api and is not available for all merchants and for all providers.

post/payment-intents/{id}/payments/sync

Path parameters

idstring required

Identifier of the payment intent on which the payment attempt is made.

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.

Request body

tokenstring required

The token which identify a payment intent. This is a field returned at payment intent creation.

paymentMethod'mobile_money' | 'credit_card' | 'bank_transfer' required

The method selected by the customer to make the payment.

countrystring required

Two-letter ISO country code. Represents the country where the selected provider is located.

providerstring

The name of the selected provider in lowercase. The list of supported providers can be found at /data/providers. If type is 'bank_transfer', provider will be optionnal and will be a bank name

overrideBusinessIdstring

This field is mandatory for merchants that have the corresponding setting enabled, It allows to send a custom name

Example request

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo",
  "country": "CI",
  "mobileMoney": {
    "msisdn": "15948253"
  },
  "bankTransfer": {
    "expirationDelay": 3600,
    "kybName": "MechantName"
  },
  "overrideBusinessId": "e9bb247c-6e3f-4a39-a539-78e3bf115994",
  "paymentInformation": {
    "recipient_name_hashmac": "a1b2c3d4e5f6",
    "recipient_phone_hashmac": "a1b2c3d4e5f6",
    "customer_id_hashmac": "a1b2c3d4e5f6"
  }
}

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"
}