Listar transações

curl --location -g --request GET 'https://api.paylogos.com.br/v1/transactions?limit=20&page&sort=time-descending&offset=0&date_range&date_range[gt]&date_range[gte]&date_range[lt]&date_range[lte]&reference_id&status&payment_type'

{ "resource": "string", "uri": "string", "limit": 0, "offset": 0, "has_more": true, "query_count": 0, "total": 0, "items": { "id": "string", "status": "succeeded", "resource": "string", "amount": "string", "original_amount": "string", "currency": "string", "description": "string", "payment_type": "string", "transaction_number": "string", "sales_receipt": "string", "on_behalf_of": "string", "statement_descriptor": "string", "payment_method": { "id": "string", "resource": "string", "description": "string", "card_brand": "string", "first4_digits": "string", "last4_digits": "string", "expiration_month": "string", "expiration_year": "string", "holder_name": "string", "is_active": true, "is_valid": true, "is_verified": true, "customer": "string", "fingerprint": "string", "uri": "string", "metadata": {}, "created_at": "string", "updated_at": "string" }, "refunded": true, "voided": true, "captured": true, "fees": "string", "fee_details": { "amount": "string", "prepaid": true, "currency": "string", "type": "string", "description": "string" }, "uri": "string", "metadata": {}, "expected_on": "2019-08-24T14:15:22Z", "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:

Exemplo:

page

number

opcional

Seleciona a página

sort

string

opcional

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

Exemplo:

time-descending

offset

number

opcional

Determina o ponto de inicio dos registros retornados

Padrão:

Exemplo:

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

reference_id

string

opcional

Retorna transações onde o reference id for igual o informado

status

string

opcional

Retorna transações onde o status for igual o informado. Para busca múltipla basta concatenar com ,

Exemplo:

succeededfailedcanceledpre_authorizedreversedrefundedpendingnewpartial_refundeddisputecharged_back

payment_type

string

opcional

Retorna transações onde o payment type for igual o informado. Para busca múltipla basta concatenar com ","(vírgula)

Exemplo:

creditboletopix

Respostas

🟢200Transações recuperadas com sucesso

application/json

Body

resource

string

opcional

uri

string

opcional

limit

number

opcional

offset

number

opcional

has_more

boolean

opcional

query_count

number

opcional

total

number

opcional

items

object (CardTransactionReturn)

opcional

string

opcional

status

string

opcional

Retorna transações onde o status for igual o informado. Para busca múltipla basta concatenar com ,

Exemplo:

succeededfailedcanceledpre_authorizedreversedrefundedpendingnewpartial_refundeddisputecharged_back

resource

string

opcional

amount

string

opcional

original_amount

string

opcional

currency

string

opcional

description

string

opcional

payment_type

string

opcional

transaction_number

string

opcional

sales_receipt

string

opcional

on_behalf_of

string

opcional

statement_descriptor

string

opcional

payment_method

object

opcional

refunded

boolean

opcional

voided

boolean

opcional

captured

boolean

opcional

fees

string

opcional

fee_details

object

opcional

uri

string

opcional

metadata

object

opcional

expected_on

string <date-time>

opcional

created_at

string <date-time>

opcional

Criado em

updated_at

string <date-time>

opcional

Atualizado em