Query transactions using filters

GET

v1.1

transactions

curl --request GET \
  --url https://api.paymee.com.br/v1.1/transactions \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>'

import requests

url = "https://api.paymee.com.br/v1.1/transactions"

headers = {
    "x-api-key": "<x-api-key>",
    "x-api-token": "<x-api-token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-api-token': '<x-api-token>'}
};

fetch('https://api.paymee.com.br/v1.1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paymee.com.br/v1.1/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>",
    "x-api-token: <x-api-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paymee.com.br/v1.1/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-api-token", "<x-api-token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paymee.com.br/v1.1/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'

response = http.request(request)
puts response.read_body

{
  "status": 0,
  "message": "success",
  "totalElements": 2,
  "totalPages": 1,
  "resultSize": 2,
  "result": [
    {
      "id": 346,
      "uuid": "a3b27666-49cc-3549-b621-60318a5e61e7",
      "referenceCode": "refcode12345",
      "type": "SALE",
      "situation": "PAID",
      "currency": "BRL",
      "amount": 206.9,
      "shipping": 0,
      "discounts": 0,
      "total": 206.9,
      "appliedRate": 2.05,
      "creation": "2018-01-02 16:20:00",
      "maxAge": "2018-01-02 18:00:00",
      "processingDate": "2018-01-02 16:20:05",
      "shopper": {
        "email": "foo@bar.com",
        "name": "JOHN DOE",
        "document": {
          "type": "CPF",
          "number": "00000000000"
        },
        "phone": {
          "type": "MOBILE",
          "number": "11999990000"
        },
        "bankDetails": {
          "account": "00011-0",
          "branch": "0001"
        }
      },
      "items": [
        {
          "id": "1",
          "name": "PRODUCT",
          "amount": 206.9,
          "taxes": 0,
          "discounts": 0,
          "total": 206.9,
          "quantity": 1
        }
      ]
    }
  ]
}

{
  "errorCount": 1,
  "errors": [
    {
      "error": "Forbidden",
      "message": "Access Denied"
    }
  ],
  "message": "field validation failure",
  "status": -1
}

Headers

x-api-key

string

required

API authentication key

Example:

"your-x-api-key"

x-api-token

string

required

API authentication token

Example:

"your-x-api-token"

Query Parameters

initialDate

string<date>

Filter initial date (yyyy‑MM‑dd)

Example:

"2018-01-01"

finalDate

string<date>

Filter final date (yyyy‑MM‑dd)

Example:

"2019-01-11"

currency

string

ISO‑4217 currency code

Maximum string length: 3

Example:

"BRL"

amount

number<double>

Transaction amount

Example:

206.9

referenceCode

string

Merchant internal order identification

Maximum string length: 50

Example:

"refcode12345"

situation

enum<string>

Transaction status

Available options:

PENDING,

CANCELLED,

PAID

Example:

"PAID"

type

enum<string>

Transaction type

Available options:

SALE,

REFUND,

WITHDRAW

Example:

"SALE"

maxPageResults

integer

Maximum results per page

Example:

100

page

integer

Page number (1‑based)

Example:

1

queryMode

enum<string>

Query mode:

CREATION – only transactions created within the period
PROCESSED – only transactions processed within the period
REGULAR – all transactions created and/or processed within the period (default)
RECONTILIATION – transactions accounted within the period

Available options:

CREATION,

PROCESSED,

REGULAR,

RECONTILIATION

Example:

"REGULAR"

Response

success response

status

number

Response status code (0 = success, -1 = validation failure)

Example:

0

message

string

Response status message

Example:

"success"

totalElements

number

Total number of transactions matching the filters

Example:

2

totalPages

number

Total number of pages available

Example:

1

resultSize

number

Number of records returned in this page

Example:

2

result

object[]

List of transactions

Show child attributes

Query transactions using filters

curl --request GET \
  --url https://api.paymee.com.br/v1.1/transactions \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>'

import requests

url = "https://api.paymee.com.br/v1.1/transactions"

headers = {
    "x-api-key": "<x-api-key>",
    "x-api-token": "<x-api-token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-api-token': '<x-api-token>'}
};

fetch('https://api.paymee.com.br/v1.1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paymee.com.br/v1.1/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>",
    "x-api-token: <x-api-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paymee.com.br/v1.1/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-api-token", "<x-api-token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paymee.com.br/v1.1/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'

response = http.request(request)
puts response.read_body

{
  "status": 0,
  "message": "success",
  "totalElements": 2,
  "totalPages": 1,
  "resultSize": 2,
  "result": [
    {
      "id": 346,
      "uuid": "a3b27666-49cc-3549-b621-60318a5e61e7",
      "referenceCode": "refcode12345",
      "type": "SALE",
      "situation": "PAID",
      "currency": "BRL",
      "amount": 206.9,
      "shipping": 0,
      "discounts": 0,
      "total": 206.9,
      "appliedRate": 2.05,
      "creation": "2018-01-02 16:20:00",
      "maxAge": "2018-01-02 18:00:00",
      "processingDate": "2018-01-02 16:20:05",
      "shopper": {
        "email": "foo@bar.com",
        "name": "JOHN DOE",
        "document": {
          "type": "CPF",
          "number": "00000000000"
        },
        "phone": {
          "type": "MOBILE",
          "number": "11999990000"
        },
        "bankDetails": {
          "account": "00011-0",
          "branch": "0001"
        }
      },
      "items": [
        {
          "id": "1",
          "name": "PRODUCT",
          "amount": 206.9,
          "taxes": 0,
          "discounts": 0,
          "total": 206.9,
          "quantity": 1
        }
      ]
    }
  ]
}

{
  "errorCount": 1,
  "errors": [
    {
      "error": "Forbidden",
      "message": "Access Denied"
    }
  ],
  "message": "field validation failure",
  "status": -1
}

API Documentation

Checkout

Payouts

Loan

Transactions

Payment Methods

Financial

Webhooks and Callbacks

Payer Information

Pix Automatic (Recurrence)

Query transactions using filters

Headers

Query Parameters

Response