Skip to main content
POST
/
v1
/
payments
Create a payment
curl --request POST \
  --url https://api.plexospay.com/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 10000,
  "operatorPhone": "+2389001234",
  "customerId": "<string>",
  "externalId": "<string>",
  "customer": {
    "phone": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "description": "<string>",
  "statementDescriptor": "<string>",
  "metadata": {}
}
'
import requests

url = "https://api.plexospay.com/v1/payments"

payload = {
"amount": 10000,
"operatorPhone": "+2389001234",
"customerId": "<string>",
"externalId": "<string>",
"customer": {
"phone": "<string>",
"name": "<string>",
"email": "<string>"
},
"description": "<string>",
"statementDescriptor": "<string>",
"metadata": {}
}
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({
amount: 10000,
operatorPhone: '+2389001234',
customerId: '<string>',
externalId: '<string>',
customer: {phone: '<string>', name: '<string>', email: '<string>'},
description: '<string>',
statementDescriptor: '<string>',
metadata: {}
})
};

fetch('https://api.plexospay.com/v1/payments', 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.plexospay.com/v1/payments",
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([
'amount' => 10000,
'operatorPhone' => '+2389001234',
'customerId' => '<string>',
'externalId' => '<string>',
'customer' => [
'phone' => '<string>',
'name' => '<string>',
'email' => '<string>'
],
'description' => '<string>',
'statementDescriptor' => '<string>',
'metadata' => [

]
]),
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://api.plexospay.com/v1/payments"

payload := strings.NewReader("{\n \"amount\": 10000,\n \"operatorPhone\": \"+2389001234\",\n \"customerId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"customer\": {\n \"phone\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"statementDescriptor\": \"<string>\",\n \"metadata\": {}\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://api.plexospay.com/v1/payments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 10000,\n \"operatorPhone\": \"+2389001234\",\n \"customerId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"customer\": {\n \"phone\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"statementDescriptor\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.plexospay.com/v1/payments")

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 \"amount\": 10000,\n \"operatorPhone\": \"+2389001234\",\n \"customerId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"customer\": {\n \"phone\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"statementDescriptor\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": "pi_abc123",
  "externalId": "<string>",
  "amount": "10000",
  "feeAmount": "200",
  "netAmount": "9800",
  "operatorPhone": "+2389001234",
  "operatorTxId": "<string>",
  "failureCode": "<string>",
  "failureMessage": "<string>",
  "description": "<string>",
  "statementDescriptor": "<string>",
  "customerId": "<string>",
  "metadata": {},
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
{
"error": {
"message": "<string>",
"code": "<string>"
}
}

Authorizations

Authorization
string
header
required

API key starting with sk_live_ or sk_test_

Headers

Idempotency-Key
string

Unique key to prevent duplicate payments

Body

application/json
amount
integer
required

Amount in centavos

Required range: 1 <= x <= 100000000
Example:

10000

operator
enum<string>
required

Mobile money operator

Available options:
CVMOVEL,
UNITEL_TMAIS,
MOCK
operatorPhone
string
required

Customer's phone number

Example:

"+2389001234"

currency
enum<string>

ISO currency code

Available options:
CVE,
AOA
customerId
string
externalId
string

Your reference ID

customer
object
description
string
statementDescriptor
string
metadata
object | null

Arbitrary key-value metadata (max 50 keys)

Response

Payment created

id
string
Example:

"pi_abc123"

externalId
string | null
amount
string

Amount in centavos

Example:

"10000"

currency
enum<string>

ISO currency code

Available options:
CVE,
AOA
feeAmount
string
Example:

"200"

netAmount
string
Example:

"9800"

operator
enum<string>

Mobile money operator

Available options:
CVMOVEL,
UNITEL_TMAIS,
MOCK
operatorPhone
string
Example:

"+2389001234"

operatorTxId
string | null
status
enum<string>
Available options:
CREATED,
OPERATOR_PENDING,
USER_CONFIRMING,
DEBITED,
SETTLED,
FAILED,
EXPIRED,
REFUNDED,
PARTIALLY_REFUNDED,
CANCELLED
failureCode
string | null
failureMessage
string | null
description
string | null
statementDescriptor
string | null
customerId
string | null
metadata
object | null

Arbitrary key-value metadata (max 50 keys)

expiresAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>