Paylogos

Listar compradores

GET

https://api.paylogos.com.br/v1/buyers

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.paylogos.com.br/v1/buyers?limit=&sort= &offset&date_range&date_range[gt]=&date_range[gte]&date_range[lt]&date_range[lte]'

Response Example

200 - Exemplo 1

{
    "resource": "string",
    "uri": "string",
    "items": [
        {
            "id": "string",
            "status": "new",
            "resource": "string",
            "account_balance": 0,
            "current_balance": 0,
            "first_name": "string",
            "last_name": "string",
            "email": "string",
            "phone_number": "string",
            "taxpayer_id": "string",
            "birthdate": "string",
            "description": "string",
            "address": {
                "line1": "string",
                "line2": "string",
                "line3": "string",
                "neighborhood": "string",
                "city": "string",
                "state": "string",
                "postal_code": "string",
                "country_code": "string"
            },
            "delinquent": true,
            "default_debit": "string",
            "default_credit": "string",
            "metadata": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ]
}

Requisição

Parâmetros Query

limit

number

opcional

Limita o número de objetos retornados, podendo ser entre 1 e 100

Padrão:

sort

string

opcional

Determinar como ordenar a lista em relação a data de criação do objeto

Padrão:

time-descending

Exemplo:

offset

number

opcional

Determina o ponto de inicio dos registros retornados

date_range

number

opcional

Filtro na lista base de objetos pela data de criação. O valor pode ser uma string com um horário em UTC timestamp, ou pode ser uma lista com os parametros abaixo

date_range[gt]

number

opcional

Retorna valores onde a data maior que o timestamp informado

date_range[gte]

number

opcional

Retorna valores onde a data for maior ou igual que o timestamp informado

date_range[lt]

number

opcional

Retorna valores onde a data for menor que o timestamp informado

date_range[lte]

number

opcional

Retorna valores onde a data for menor ou igual que o timestamp informado

Respostas

🟢200OK

application/json

Body

resource

string

opcional

uri

string

opcional

items

array[object (CompradorItemReturn) {19}]

opcional

string

opcional

status

string

opcional

Exemplo:

newexpiredaction_requiredpendingenabledactivedisableddeleted

resource

string

opcional

account_balance

number

opcional

current_balance

number

opcional

first_name

string

opcional

last_name

string

opcional

string

opcional

phone_number

string

opcional

taxpayer_id

string

opcional

birthdate

string

opcional

description

string

opcional

address

object (AddressReturn)

opcional

delinquent

boolean

opcional

default_debit

string

opcional

cartão default para compras

default_credit

string

opcional

conta bancaria default para depositios

metadata

object

opcional

created_at

string <date-time>

opcional

updated_at

string <date-time>

opcional

🟠403Proibido

Modificado em 2025-06-12 21:03:45