Get Customers

Get Customers

GET /customers

Get Customers

cURL

curl --request GET \
  --url https://testapi.fractalpay.com/api/v1/customers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_key": "{{merchant_key}}"
}
'

import requests

url = "https://testapi.fractalpay.com/api/v1/customers"

payload = { "merchant_key": "{{merchant_key}}" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({merchant_key: '{{merchant_key}}'})
};

fetch('https://testapi.fractalpay.com/api/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://testapi.fractalpay.com/api/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_POSTFIELDS => json_encode([
    'merchant_key' => '{{merchant_key}}'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://testapi.fractalpay.com/api/v1/customers"

	payload := strings.NewReader("{\n  \"merchant_key\": \"{{merchant_key}}\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.get("https://testapi.fractalpay.com/api/v1/customers")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchant_key\": \"{{merchant_key}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://testapi.fractalpay.com/api/v1/customers")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchant_key\": \"{{merchant_key}}\"\n}"

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

200

{
  "data": {
    "allList": [
      {
        "Email": "[e-mail]",
        "Phone": "5134140000",
        "create_date": "2024-08-21T16:32:22.000Z",
        "customer_id": "c_f10702845f",
        "first_name": "John",
        "last_name": "Woe"
      },
      {
        "Email": "[e-mail]",
        "Phone": "4548591474",
        "create_date": "2024-07-15T16:12:35.000Z",
        "customer_id": "c_0c5f67e242",
        "first_name": "John F",
        "last_name": "Doe"
      }
    ],
    "page": 1,
    "perPage": 20,
    "totalCount": 2,
    "totalPage": 1
  },
  "message": "All customer list",
  "result": true
}

Authorizations

Authorization · string · header · required

Use your Fractal API credentials.

Username = Client ID Password = Secret Key

Sandbox credentials can be generated from the Test Portal.

Body

application/json

merchant_key · string · required

The merchant's unique key. Returned in the merchant_key field of the get merchants by client call.

Example:

"{{merchant_key}}"

Response

200 - application/json

Get Customers

data · object

Show child attributes

message · string

Example:

"All customer list"

result · boolean

Example:

true