Skip to main content
GET
/
customers
Get Customers
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}}"
}
'
{
  "data": {
    "allList": [
      {
        "Email": "john@fractal.com",
        "Phone": "5134140000",
        "create_date": "2024-08-21T16:32:22.000Z",
        "customer_id": "f1070284-5fda-11ef-bae5-0ef0812e6179",
        "first_name": "John",
        "last_name": "Woe"
      },
      {
        "Email": "mike@james.com",
        "Phone": "4548591474",
        "create_date": "2024-07-15T16:12:35.000Z",
        "customer_id": "0c5f67e2-42c5-11ef-af4e-0ef0812e6179",
        "first_name": "John F",
        "last_name": "Doe"
      }
    ],
    "page": 1,
    "perPage": 20,
    "totalCount": 2,
    "totalPage": 1
  },
  "message": "All customer list",
  "result": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.fractalpay.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
message
string
Example:

"All customer list"

​
result
boolean
Example:

true