List customers

curl --request GET \
  --url https://api-global.fastpaybrasil.com/v1/customers \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
      "gatewayId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
      "name": "John Doe",
      "email": "[email protected]",
      "documentId": "12345678900",
      "documentType": "cpf",
      "phoneNumber": "+5511999999999",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 10,
    "totalPages": 10
  }
}

GET

customers

List customers

curl --request GET \
  --url https://api-global.fastpaybrasil.com/v1/customers \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
      "gatewayId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
      "name": "John Doe",
      "email": "[email protected]",
      "documentId": "12345678900",
      "documentType": "cpf",
      "phoneNumber": "+5511999999999",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 10,
    "totalPages": 10
  }
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Query Parameters

string

Search by name, email, document, or phone

string

Filter by exact email

documentId

string

Filter by document ID

page

integer

default:1

Page number (starts at 1)

size

integer

default:10

Number of items per page

Response

Successfully retrieved the list of customers

data

object[]

Array of customers in the current page

Show child attributes