Create a PaymentIntent

curl --request POST \
  --url https://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstname": "<string>",
  "lastname": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "description": "<string>",
  "merchant_reference": "<string>",
  "fee_bearer": "<string>",
  "confirmation_method": "<string>",
  "confirm": true,
  "items": [
    {}
  ],
  "redirect_url": "<string>",
  "metadata": {},
  "collect_shipping_address": true,
  "payment_method_types": [
    {}
  ]
}
'

import requests

url = "https://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents"

payload = {
    "firstname": "<string>",
    "lastname": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "amount": "<string>",
    "currency": "<string>",
    "description": "<string>",
    "merchant_reference": "<string>",
    "fee_bearer": "<string>",
    "confirmation_method": "<string>",
    "confirm": True,
    "items": [{}],
    "redirect_url": "<string>",
    "metadata": {},
    "collect_shipping_address": True,
    "payment_method_types": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstname: '<string>',
    lastname: '<string>',
    email: '<string>',
    phone: '<string>',
    amount: '<string>',
    currency: '<string>',
    description: '<string>',
    merchant_reference: '<string>',
    fee_bearer: '<string>',
    confirmation_method: '<string>',
    confirm: true,
    items: [{}],
    redirect_url: '<string>',
    metadata: {},
    collect_shipping_address: true,
    payment_method_types: [{}]
  })
};

fetch('https://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents', 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://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents",
  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([
    'firstname' => '<string>',
    'lastname' => '<string>',
    'email' => '<string>',
    'phone' => '<string>',
    'amount' => '<string>',
    'currency' => '<string>',
    'description' => '<string>',
    'merchant_reference' => '<string>',
    'fee_bearer' => '<string>',
    'confirmation_method' => '<string>',
    'confirm' => true,
    'items' => [
        [
                
        ]
    ],
    'redirect_url' => '<string>',
    'metadata' => [
        
    ],
    'collect_shipping_address' => true,
    'payment_method_types' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents"

	payload := strings.NewReader("{\n  \"firstname\": \"<string>\",\n  \"lastname\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"merchant_reference\": \"<string>\",\n  \"fee_bearer\": \"<string>\",\n  \"confirmation_method\": \"<string>\",\n  \"confirm\": true,\n  \"items\": [\n    {}\n  ],\n  \"redirect_url\": \"<string>\",\n  \"metadata\": {},\n  \"collect_shipping_address\": true,\n  \"payment_method_types\": [\n    {}\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstname\": \"<string>\",\n  \"lastname\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"merchant_reference\": \"<string>\",\n  \"fee_bearer\": \"<string>\",\n  \"confirmation_method\": \"<string>\",\n  \"confirm\": true,\n  \"items\": [\n    {}\n  ],\n  \"redirect_url\": \"<string>\",\n  \"metadata\": {},\n  \"collect_shipping_address\": true,\n  \"payment_method_types\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstname\": \"<string>\",\n  \"lastname\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"merchant_reference\": \"<string>\",\n  \"fee_bearer\": \"<string>\",\n  \"confirmation_method\": \"<string>\",\n  \"confirm\": true,\n  \"items\": [\n    {}\n  ],\n  \"redirect_url\": \"<string>\",\n  \"metadata\": {},\n  \"collect_shipping_address\": true,\n  \"payment_method_types\": [\n    {}\n  ]\n}"

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

{
  "status_code": 200,
  "response_type": "success",
  "data": {
    "id": "695e7cdf77f104409c0e5760",
    "object": "payment_intent",
    "amount": "1000",
    "currency": "XAF",
    "status": "requires_action",
    "client_secret": "pi_695e7cdf..._secret_...",
    "payment_ref": "PWG_d4e9cd66d451",
    "checkout_url": "https://checkout.pavewaygroup.com/initpay/695e7cdf77f104409c0e5760?client_secret=...",
    "customer": {
      "firstname": "John",
      "lastname": "Doe",
      "email": "[email protected]"
    },
    "metadata": {}
  }
}

POST

payment-intents

Create a PaymentIntent

curl --request POST \
  --url https://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstname": "<string>",
  "lastname": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "description": "<string>",
  "merchant_reference": "<string>",
  "fee_bearer": "<string>",
  "confirmation_method": "<string>",
  "confirm": true,
  "items": [
    {}
  ],
  "redirect_url": "<string>",
  "metadata": {},
  "collect_shipping_address": true,
  "payment_method_types": [
    {}
  ]
}
'

import requests

url = "https://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents"

payload = {
    "firstname": "<string>",
    "lastname": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "amount": "<string>",
    "currency": "<string>",
    "description": "<string>",
    "merchant_reference": "<string>",
    "fee_bearer": "<string>",
    "confirmation_method": "<string>",
    "confirm": True,
    "items": [{}],
    "redirect_url": "<string>",
    "metadata": {},
    "collect_shipping_address": True,
    "payment_method_types": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstname: '<string>',
    lastname: '<string>',
    email: '<string>',
    phone: '<string>',
    amount: '<string>',
    currency: '<string>',
    description: '<string>',
    merchant_reference: '<string>',
    fee_bearer: '<string>',
    confirmation_method: '<string>',
    confirm: true,
    items: [{}],
    redirect_url: '<string>',
    metadata: {},
    collect_shipping_address: true,
    payment_method_types: [{}]
  })
};

fetch('https://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents', 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://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents",
  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([
    'firstname' => '<string>',
    'lastname' => '<string>',
    'email' => '<string>',
    'phone' => '<string>',
    'amount' => '<string>',
    'currency' => '<string>',
    'description' => '<string>',
    'merchant_reference' => '<string>',
    'fee_bearer' => '<string>',
    'confirmation_method' => '<string>',
    'confirm' => true,
    'items' => [
        [
                
        ]
    ],
    'redirect_url' => '<string>',
    'metadata' => [
        
    ],
    'collect_shipping_address' => true,
    'payment_method_types' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents"

	payload := strings.NewReader("{\n  \"firstname\": \"<string>\",\n  \"lastname\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"merchant_reference\": \"<string>\",\n  \"fee_bearer\": \"<string>\",\n  \"confirmation_method\": \"<string>\",\n  \"confirm\": true,\n  \"items\": [\n    {}\n  ],\n  \"redirect_url\": \"<string>\",\n  \"metadata\": {},\n  \"collect_shipping_address\": true,\n  \"payment_method_types\": [\n    {}\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstname\": \"<string>\",\n  \"lastname\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"merchant_reference\": \"<string>\",\n  \"fee_bearer\": \"<string>\",\n  \"confirmation_method\": \"<string>\",\n  \"confirm\": true,\n  \"items\": [\n    {}\n  ],\n  \"redirect_url\": \"<string>\",\n  \"metadata\": {},\n  \"collect_shipping_address\": true,\n  \"payment_method_types\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://paveway-gateway-adwfci84.uc.gateway.dev/v1/payment-intents")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstname\": \"<string>\",\n  \"lastname\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"amount\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"merchant_reference\": \"<string>\",\n  \"fee_bearer\": \"<string>\",\n  \"confirmation_method\": \"<string>\",\n  \"confirm\": true,\n  \"items\": [\n    {}\n  ],\n  \"redirect_url\": \"<string>\",\n  \"metadata\": {},\n  \"collect_shipping_address\": true,\n  \"payment_method_types\": [\n    {}\n  ]\n}"

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

{
  "status_code": 200,
  "response_type": "success",
  "data": {
    "id": "695e7cdf77f104409c0e5760",
    "object": "payment_intent",
    "amount": "1000",
    "currency": "XAF",
    "status": "requires_action",
    "client_secret": "pi_695e7cdf..._secret_...",
    "payment_ref": "PWG_d4e9cd66d451",
    "checkout_url": "https://checkout.pavewaygroup.com/initpay/695e7cdf77f104409c0e5760?client_secret=...",
    "customer": {
      "firstname": "John",
      "lastname": "Doe",
      "email": "[email protected]"
    },
    "metadata": {}
  }
}

Creates a PaymentIntent object. After the PaymentIntent is created, attach a payment method and confirm to continue the payment.

Authentication

Include your Secret Key in the Authorization header as a Bearer token.

Request Body

Customer Information

string

required

Customer’s first name.

string

required

Customer’s last name.

string

Customer’s email address. Required if phone is not provided. Used for sending receipts and linking saved payment methods.

string

Customer’s phone number with country prefix (e.g., 237612345678). Required if email is not provided.

Payment Details

string

required

Amount in the smallest currency unit. e.g., “1000” for 1000 XAF. This should be a string to maintain precision.

string

default:"XAF"

Three-letter ISO currency code. e.g., XAF, NGN, USD.

string

required

A brief description of the transaction, often shown on the customer’s bank statement or receipt.

string

required

Your unique identifier for the transaction. This is used for reconciliation and prevents duplicate charges via idempotency.

Configuration

string

default:"merchant"

Specifies who bears the transaction fees.

merchant:(Default) Fees are deducted from the payout amount you receive. The customer pays exactly the amount.
customer: Fees are added on top of the amount. The customer pays amount + fees, and you receive the full amount.

string

default:"automatic"

How the payment should be confirmed.

automatic: (Default) Suitable for hosted checkout pages.
manual: Requires a separate server-side confirmation call.

boolean

default:"false"

Set to true to immediately attempt to confirm the PaymentIntent if a payment method is already attached or provided.

array

An array of objects representing line items in order. Each item should have name, price, currency, and quantity.

string

The URL to redirect the customer to after they complete the payment on an external gateway or hosted page.

object

A set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

boolean

default:"false"

Whether to prompt the customer for a shipping address during the checkout process.

array

The list of payment method types (e.g., ['card', 'mobile_money']) that this PaymentIntent is allowed to use.

Response

string

Unique identifier for the PaymentIntent.

string

String representing the object’s type. Objects of the same type share the same value. Value is payment_intent.

string

Amount intended to be collected, in the smallest currency unit (e.g., “1000” for 1000 XAF).

string

Three-letter ISO currency code.

string

Status of the PaymentIntent: requires_action, processing, succeeded, failed, canceled.

string

The client secret of this PaymentIntent. Used for client-side retrieval and confirmation.

string

PaveWay’s unique public reference for this transaction (e.g., PWG_...).

string

Your unique identifier for the transaction.

string

The URL to redirect your customer to for hosted checkout.

object

Show properties

string

Customer’s first name.

string

Customer’s last name.

string

Customer’s email.

{
  "status_code": 200,
  "response_type": "success",
  "data": {
    "id": "695e7cdf77f104409c0e5760",
    "object": "payment_intent",
    "amount": "1000",
    "currency": "XAF",
    "status": "requires_action",
    "client_secret": "pi_695e7cdf..._secret_...",
    "payment_ref": "PWG_d4e9cd66d451",
    "checkout_url": "https://checkout.pavewaygroup.com/initpay/695e7cdf77f104409c0e5760?client_secret=...",
    "customer": {
      "firstname": "John",
      "lastname": "Doe",
      "email": "[email protected]"
    },
    "metadata": {}
  }
}

Payments API

Customers

Sessions

Subscriptions API

Financial Services API

Webhooks

Create a PaymentIntent

Authentication

Request Body

Customer Information

Payment Details

Configuration

Response

​Authentication

​Request Body

​Customer Information

​Payment Details

​Configuration

​Response

Authentication

Request Body

Customer Information

Payment Details

Configuration

Response