Checkout
Transactions
Payment Methods
Webhooks and Callbacks
Payer Information
Transactions
Query a transaction
Returns detailed information about a sale, payout or refund transaction.
GET
/
v1.1
/
transactions
/
{transactionUUID}
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
API authentication key
Example:
"your-x-api-key"
API authentication token
Example:
"your-x-api-token"
Path Parameters
Unique transaction identifier (UUID)
Response
200
application/json
Success response
The response is of type object
.
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"
}