Skip to main content
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>'
{
  "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"

​
id
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
​
beneficiary
object
​
refunds
object
​
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
​
track
object
⌘I