Authenticate the current payment

curl --request POST \
  --url https://api.example.com/payment-intents/{id}/authentication \
  --header 'ApiKey: <apikey>' \
  --header 'Content-Type: application/json' \
  --header 'Environment: <environment>' \
  --header 'MerchantId: <merchantid>' \
  --data '
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo",
  "confirmationCode": "<string>"
}
'

import requests

url = "https://api.example.com/payment-intents/{id}/authentication"

payload = {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo",
    "confirmationCode": "<string>"
}
headers = {
    "ApiKey": "<apikey>",
    "MerchantId": "<merchantid>",
    "Environment": "<environment>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    ApiKey: '<apikey>',
    MerchantId: '<merchantid>',
    Environment: '<environment>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo',
    confirmationCode: '<string>'
  })
};

fetch('https://api.example.com/payment-intents/{id}/authentication', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/payment-intents/{id}/authentication",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo',
    'confirmationCode' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "ApiKey: <apikey>",
    "Content-Type: application/json",
    "Environment: <environment>",
    "MerchantId: <merchantid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/payment-intents/{id}/authentication"

	payload := strings.NewReader("{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo\",\n  \"confirmationCode\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ApiKey", "<apikey>")
	req.Header.Add("MerchantId", "<merchantid>")
	req.Header.Add("Environment", "<environment>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/payment-intents/{id}/authentication")
  .header("ApiKey", "<apikey>")
  .header("MerchantId", "<merchantid>")
  .header("Environment", "<environment>")
  .header("Content-Type", "application/json")
  .body("{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo\",\n  \"confirmationCode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/payment-intents/{id}/authentication")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo\",\n  \"confirmationCode\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": "<unknown>",
  "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",
  "subMerchantId": "submerchant_123"
}

{
  "status": 401,
  "error": {
    "type": "authorization_error",
    "code": "wrong_credentials",
    "message": "L'ID marchand et/ou la clé d'API sont incorrects."
  }
}

{
  "httpStatus": 404,
  "message": "X not found",
  "error": "Not found"
}

{
  "status": 429,
  "error": "ThrottlerException: Too Many Requests"
}

{
  "type": "internal_error",
  "code": [
    "internal_error",
    "wrong_credentials",
    "not_granted",
    "live_mode_not_granted"
  ],
  "message": "An error occurred on our system. Please try again later."
}

{
  "status": 503,
  "code": "merchant_group_unavailable",
  "message": "Your merchant group could not be verified. Please retry in a few moments.",
  "request_id": "<string>"
}

POST

payment-intents

{id}

authentication

Authenticate the current payment

curl --request POST \
  --url https://api.example.com/payment-intents/{id}/authentication \
  --header 'ApiKey: <apikey>' \
  --header 'Content-Type: application/json' \
  --header 'Environment: <environment>' \
  --header 'MerchantId: <merchantid>' \
  --data '
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo",
  "confirmationCode": "<string>"
}
'

import requests

url = "https://api.example.com/payment-intents/{id}/authentication"

payload = {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo",
    "confirmationCode": "<string>"
}
headers = {
    "ApiKey": "<apikey>",
    "MerchantId": "<merchantid>",
    "Environment": "<environment>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    ApiKey: '<apikey>',
    MerchantId: '<merchantid>',
    Environment: '<environment>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo',
    confirmationCode: '<string>'
  })
};

fetch('https://api.example.com/payment-intents/{id}/authentication', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/payment-intents/{id}/authentication",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo',
    'confirmationCode' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "ApiKey: <apikey>",
    "Content-Type: application/json",
    "Environment: <environment>",
    "MerchantId: <merchantid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/payment-intents/{id}/authentication"

	payload := strings.NewReader("{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo\",\n  \"confirmationCode\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ApiKey", "<apikey>")
	req.Header.Add("MerchantId", "<merchantid>")
	req.Header.Add("Environment", "<environment>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/payment-intents/{id}/authentication")
  .header("ApiKey", "<apikey>")
  .header("MerchantId", "<merchantid>")
  .header("Environment", "<environment>")
  .header("Content-Type", "application/json")
  .body("{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo\",\n  \"confirmationCode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/payment-intents/{id}/authentication")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo\",\n  \"confirmationCode\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": "<unknown>",
  "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",
  "subMerchantId": "submerchant_123"
}

{
  "status": 401,
  "error": {
    "type": "authorization_error",
    "code": "wrong_credentials",
    "message": "L'ID marchand et/ou la clé d'API sont incorrects."
  }
}

{
  "httpStatus": 404,
  "message": "X not found",
  "error": "Not found"
}

{
  "status": 429,
  "error": "ThrottlerException: Too Many Requests"
}

{
  "type": "internal_error",
  "code": [
    "internal_error",
    "wrong_credentials",
    "not_granted",
    "live_mode_not_granted"
  ],
  "message": "An error occurred on our system. Please try again later."
}

{
  "status": 503,
  "code": "merchant_group_unavailable",
  "message": "Your merchant group could not be verified. Please retry in a few moments.",
  "request_id": "<string>"
}

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

Path Parameters

string

required

Identifier of the PaymentIntent requiring authentication.

Body

application/json

token

string

required

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

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnRlbnRJZCI6InBpXzBkeV9GZTJXQl8wNVVBdDdqMFloaSIsIm1lcmNoYW50SWQiOiIzIiwibW9kZSI6InNhbmRib3giLCJpYXQiOjE2OTUxMjY1MDJ9.8cpkja3PgSLFXiMW9BJN3ec5ndJFE2kIHvXvc834Wpo"

confirmationCode

string

required

The OTP code given by the provider selected by the customer.

Response

string

required

Unique identifier for the PaymentIntent

Example:

"pi_z1urYtVFgEebtcj8fxp4v"

merchantId

string

required

Identifier of the merchant owning this PaymentIntent

createdAt

string

required

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

Example:

"2020-10-15T12:09:49.355Z"

updatedAt

string

required

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

Example:

"2020-10-15T12:16:26.128Z"

token

string

required

A unique JSON Web Token allowing to attempt a Payment on the PaymentIntent on a client-side application. It expires 30 minutes after the PaymentIntent creation: paying or authenticating with it is then refused with a 401 bad_payment_intent_token error, and reading the PaymentIntent with it (status, details, fees) is refused the same way 15 minutes later.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElkIjoiMTYiLCJtb2RlIjoic2FuZGJveCIsInBheW1lbnRJZCI6InBpX3oxdXJZdFZGZ0VlYnRjajhmeHA0diIsImlhdCI6MTYwMjc1OTE4M30.OZ0fDnMVWvcT-gRthyBD58PFC20gabGKt1UPRe4aNi4"

purchaseReference

string

required

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

Example:

"ref_2020_11_10_001"

customerReference

string

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.

Example:

"cust_01924059"

status

enum<string>

required

The current status of this PaymentIntent

Available options:

action_required,

canceled,

failed,

payment_required,

processing,

successful

Example:

"successful"

amount

number

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

Example:

100

currency

string

required

Three-letter ISO currency code.

Example:

"XOF"

payments

any

required

mode

enum<string>

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.

Available options:

live,

sandbox

Example:

"live"

nextAction

NextAction · object

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.

Show child attributes

lastPaymentFailure

PaymentFailureCause · object

In case of a Payment attempt failure, this object will describe the reason of the failure

Show child attributes

overrideBusinessName

string

For Aggregator, name of the merchant

Example:

"MyBusiness"

subMerchantId

string

Submerchant ID

Example:

"submerchant_123"

Data

Balance

Webhooks

Sms

Payments

Provisioning

Receipt

Payment on Terminal

IRT

Transfers

Refunds

Payment Refunds

Deposits

Compliance

Recipients

Processing Only

Payment Links

Submerchants

Subscriptions

Instant Payment

Authenticate the current payment

Headers

Path Parameters

Body

Response