English

Buscando transações

[GET] https://gateway.paag.dev/api/transactions

Você usará este endpoint para listar todas as transações em seu processador. Observe que para cada novo evento enviado sob a mesma transação, o campo updated_at da transação é atualizado.

A filtragem está habilitada para este endpoint através do parâmetro de consulta search. Portanto, ao buscar por um campo, envie-o através dos parâmetros de consulta do endpoint, por exemplo:

Example

https://gateway.paag.dev/api/transactions?search[first_name]=John&search[last_name]=Doe

Tipos de Filtro

Você pode usar filtros nos campos conforme descrito abaixo:

starts with corresponde a registros de forma semelhante ao SQL LIKE, por exemplo: uma string Transac irá corresponder tanto a Transaction quanto a TransactionEvent;
exact comparison corresponde a registros por meio de comparação exata (sensível a maiúsculas e minúsculas) por exemplo: uma string Transaction NÃO corresponderá a transaction;
date corresponde a registros por meio de uma data SQL, e esses campos devem ser fornecidos no formato Y-m-d H:i:s por exemplo: 2022-02-02 17:59:00

Além disso, este endpoint fornece paginação para navegar pelos conjuntos de registros. As informações de paginação podem ser encontradas no campo de resposta meta. As páginas sempre retornam 50 registros por vez. Ao utilizar as capacidades de relatório, certifique-se de monitorar os limites de taxa por meio dos cabeçalhos de resposta X-RateLimit-Limit e X-RateLimit-Remaining

Parâmetros de consulta

Nome do campo	Tipo de dado	Tipo de filtro
`search[merchant_transaction_id]`	string	starts with
`search[card_number]`	string	starts with. Should only search by the first six digits
`search[first_name]`	string	starts with
`search[last_name]`	string	starts with
`search[email]`	string	starts with
`search[mobile_phone]`	string	starts with
`search[user_id]`	string	exact comparison
`search[city]`	string	starts with
`search[state]`	string	exact comparison
`search[zip]`	string	exact comparison
`search[shipping_city]`	string	starts with
`search[shipping_state]`	string	exact comparison
`search[shipping_zip]`	string	exact comparison
`search[created_at_gte]`	date	date
`search[created_at_lte]`	date	date
`search[updated_at_gte]`	date	date
`search[updated_at_lte]`	date	date

Exemplos

Obter todas as transações de janeiro de 2024

cURLPython

curl --request GET \
    --url 'https://gateway.paag.dev/api/transactions?search[created_at_gte]=2024-01-01&search[created_at_lte]=2024-01-31' \
    --header 'Authorization: Bearer MY_API_TOKEN' \
    --header 'accept: application/json'

import requests

url = "https://gateway.paag.dev/api/transactions?search[created_at_gte]=2024-01-01&search[created_at_lte]=2024-01-31"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer MY_API_TOKEN"
}

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

print(response.text)

Respostas

201 - Sucesso

{
"transactions": [
    {
    "id": "123-456-789",
    "merchant_id": "123-456-789",
    "user_id": "123-456-789",
    "processor_id": "123-456-789",
    "merchant_transaction_id": "0000001",
    "card_number": "411111******1111",
    "card_brand": "visa",
    "card_expiry_month": "01",
    "card_expiry_year": "2021",
    "first_name": "Foo",
    "last_name": "Bar",
    "street_address_1": "Addr 1",
    "street_address_2": "Addr 2",
    "city": "New York",
    "state": "PA",
    "country": "US",
    "zip": "12345",
    "email": "foo.bar@mail.com",
    "mobile_phone": "+1231231234",
    "updated_at": "2022-02-02T16:33:40+00:00",
    "created_at": "2022-02-02T16:33:39+00:00",
    "events": [
        {
        "id": "123-456-789",
        "success": true,
        "event_type": "sale",
        "amount": "1.00",
        "updated_at": "2022-02-02T16:33:40+00:00",
        "created_at": "2022-02-02T16:33:39+00:00"
        }
    ]
    },
    {
    "id": "123-456-789",
    "merchant_id": "123-456-789",
    "user_id": "123-456-789",
    "processor_id": "123-456-789",
    "merchant_transaction_id": "0000001",
    "card_number": "411111******1111",
    "card_brand": "visa",
    "card_expiry_month": "01",
    "card_expiry_year": "2021",
    "first_name": "Foo",
    "last_name": "Bar",
    "street_address_1": "Addr 1",
    "street_address_2": "Addr 2",
    "city": "New York",
    "state": "PA",
    "country": "US",
    "zip": "12345",
    "email": "foo.bar@mail.com",
    "mobile_phone": "+1231231234",
    "updated_at": "2018-02-16T16:33:32+00:00",
    "created_at": "2018-02-16T16:33:29+00:00",
    "events": [
        {
        "id": "123-456-789",
        "success": true,
        "event_type": "sale",
        "amount": "1.00",
        "updated_at": "2022-02-02T16:33:40+00:00",
        "created_at": "2022-02-02T16:33:39+00:00"
        }
    ]
    }
],
"meta": {
    "last_page": 1,
    "current_page": 1,
    "total": 2
}
}

401 - Não autenticado

{
"error": {
    "message": {
    "base": ["Not authenticated"]
    },
    "status": 401
},
"debug": []
}