Query a transaction

GET

v1.1

transactions

{transactionUUID}

Query a transaction

curl --request GET \
  --url https://api.paymee.com.br/v1.1/transactions/{transactionUUID} \
  --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/{transactionUUID}"

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/{transactionUUID}', 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/{transactionUUID}",
  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/{transactionUUID}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.paymee.com.br/v1.1/transactions/{transactionUUID}")
  .header("x-api-key", "<x-api-key>")
  .header("x-api-token", "<x-api-token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "amount": 0.99,
  "appliedRate": 0.1,
  "creation": "2018-07-03 23:51:18",
  "currency": "BRL",
  "discounts": 0,
  "id": 2404,
  "maxAge": "2018-07-04 01:00:18",
  "message": "success",
  "referenceCode": "0199201120510",
  "refunds": {
    "available": 0.98,
    "quantity": 1,
    "requested": 0.01,
    "transactions": [
      {
        "bankDetails": {
          "account": "00000-0",
          "bank": "218 - BANCO BS2 S.A.",
          "branch": "0000"
        },
        "creation": "2019-10-15 16:13:26",
        "creditDate": "2019-10-15 16:13:59",
        "creditTransferDetails": {
          "referenceCode": "example-999",
          "saleUUID": "00000000-0000-0000-0000-000000000000",
          "total": 0.01
        },
        "remark": "Créditos Transferidos",
        "status": "PAID",
        "total": 0.01,
        "uuid": "00000000-0000-0000-0000-000000000000"
      }
    ]
  },
  "shipping": 0,
  "shopper": {
    "bankDetails": {
      "account": "00011-0",
      "branch": "0001"
    },
    "document": {
      "number": "00000000000",
      "type": "CPF"
    },
    "email": "JOHN DOE",
    "phone": {
      "number": "11999999999",
      "type": "MOBILE"
    }
  },
  "situation": "CANCELLED",
  "status": 0,
  "total": 0.99,
  "type": "SALE",
  "uuid": "00000000-0000-0000-0000-000000000000"
}

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"

Path Parameters

transactionUUID

string

required

Unique transaction identifier (UUID)

Response

Success response

status

enum<number>

Response status code.

Available options:

0,

-1,

999

Example:

0

message

string

Response status message.

Example:

"success"

number

Internal transaction ID.

Example:

2404

uuid

string

Transaction UUID.

Example:

"00000000-0000-0000-0000-000000000000"

type

string

Transaction type.

Example:

"SALE"

situation

enum<string>

Transaction situation.

Available options:

PENDING,

CANCELLED,

PAID

Example:

"CANCELLED"

currency

string

ISO‑4217 currency code.

Example:

"BRL"

amount

number

Order amount.

Example:

0.99

shipping

number

Shipping costs.

Example:

0

discounts

number

Discounts applied.

Example:

0

total

number

(amount + shipping) − discounts.

Example:

0.99

appliedRate

number

PayMee service fee.

Example:

0.1

referenceCode

string

Merchant's unique sale identification.

Example:

"0199201120510"

creation

string

Creation date and time (yyyy-MM-dd HH:mm:ss).

Example:

"2018-07-03 23:51:18"

maxAge

string

Order max age (yyyy-MM-dd HH:mm:ss).

Example:

"2018-07-04 01:00:18"

shopper

object

Show child attributes

beneficiary

object

Show child attributes

refunds

object

Show child attributes

serviceFee

number

Service fee applied to payouts.

Example:

1.25

has_return_error

boolean

Indicates if a return error is present.

Example:

false

return_error

object

Show child attributes

track

object

Show child attributes

boleto

object

Boleto fields appear directly in response.instructions on creation and in boleto on transaction queries.

Show child attributes

split

Parent sale · object

Present only for split sales. Parent sales return the parent variant; transactions received by a recipient account return the recipient variant.

Parent sale
Recipient sale

Show child attributes

Query a transaction

curl --request GET \
  --url https://api.paymee.com.br/v1.1/transactions/{transactionUUID} \
  --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/{transactionUUID}"

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/{transactionUUID}', 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/{transactionUUID}",
  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/{transactionUUID}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.paymee.com.br/v1.1/transactions/{transactionUUID}")
  .header("x-api-key", "<x-api-key>")
  .header("x-api-token", "<x-api-token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "amount": 0.99,
  "appliedRate": 0.1,
  "creation": "2018-07-03 23:51:18",
  "currency": "BRL",
  "discounts": 0,
  "id": 2404,
  "maxAge": "2018-07-04 01:00:18",
  "message": "success",
  "referenceCode": "0199201120510",
  "refunds": {
    "available": 0.98,
    "quantity": 1,
    "requested": 0.01,
    "transactions": [
      {
        "bankDetails": {
          "account": "00000-0",
          "bank": "218 - BANCO BS2 S.A.",
          "branch": "0000"
        },
        "creation": "2019-10-15 16:13:26",
        "creditDate": "2019-10-15 16:13:59",
        "creditTransferDetails": {
          "referenceCode": "example-999",
          "saleUUID": "00000000-0000-0000-0000-000000000000",
          "total": 0.01
        },
        "remark": "Créditos Transferidos",
        "status": "PAID",
        "total": 0.01,
        "uuid": "00000000-0000-0000-0000-000000000000"
      }
    ]
  },
  "shipping": 0,
  "shopper": {
    "bankDetails": {
      "account": "00011-0",
      "branch": "0001"
    },
    "document": {
      "number": "00000000000",
      "type": "CPF"
    },
    "email": "JOHN DOE",
    "phone": {
      "number": "11999999999",
      "type": "MOBILE"
    }
  },
  "situation": "CANCELLED",
  "status": 0,
  "total": 0.99,
  "type": "SALE",
  "uuid": "00000000-0000-0000-0000-000000000000"
}

API Documentation

Checkout

Split

Payouts

Loan

Transactions

Payment Methods

Financial

Webhooks and Callbacks

Payer Information

Pix Automatic (Recurrence)

Headers

Path Parameters

Response