List Customers
curl --request GET \
--url https://api-sandbox.pavewaygroup.com/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.pavewaygroup.com/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.pavewaygroup.com/v1/customers', 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-sandbox.pavewaygroup.com/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.pavewaygroup.com/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.pavewaygroup.com/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.pavewaygroup.com/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status_code": 200,
"response_type": "success",
"data": [
{
"id": "658dc...",
"firstname": "John",
"lastname": "Doe",
"email": "[email protected]",
"phone": "237612345678",
"balance": 0,
"active": true,
"created_at": 1704873600
}
]
}
Customers
List Customers
Retrieve a list of all customers associated with your business.
GET
/
customers
List Customers
curl --request GET \
--url https://api-sandbox.pavewaygroup.com/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.pavewaygroup.com/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.pavewaygroup.com/v1/customers', 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-sandbox.pavewaygroup.com/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.pavewaygroup.com/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.pavewaygroup.com/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.pavewaygroup.com/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status_code": 200,
"response_type": "success",
"data": [
{
"id": "658dc...",
"firstname": "John",
"lastname": "Doe",
"email": "[email protected]",
"phone": "237612345678",
"balance": 0,
"active": true,
"created_at": 1704873600
}
]
}
Returns a list of your customers. The customers are returned sorted by creation date, with the most recent appearing first.
Authentication
Include your Secret Key in theAuthorization header as a Bearer token.
Response
The response is a JSON object with adata field containing an array of customer objects.
Customer Object Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the customer. |
firstname | string | Customer’s first name. |
lastname | string | Customer’s last name. |
email | string | Customer’s email address. |
phone | string | Customer’s phone number. |
balance | number | Current account balance for the customer (in smallest currency unit). |
active | boolean | Whether the customer profile is currently active. |
created_at | timestamp | Unix timestamp when the customer was created. |
{
"status_code": 200,
"response_type": "success",
"data": [
{
"id": "658dc...",
"firstname": "John",
"lastname": "Doe",
"email": "[email protected]",
"phone": "237612345678",
"balance": 0,
"active": true,
"created_at": 1704873600
}
]
}
⌘I