Skip to main content
GET
/
v1.1
/
transactions
/
{transactionUUID}
/
webhook
Query webhook requests
curl --request GET \
  --url https://api.paymee.com.br/v1.1/transactions/{transactionUUID}/webhook \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>'
{
  "status": 0,
  "message": "success",
  "notifications": [
    {
      "date": "2019-02-12 16:59:12",
      "endpoint": "https://foo.bar/paymeeListener",
      "eventType": "PAYMENT_CONFIRMATION",
      "status": "SUCCESS",
      "responseCode": 200,
      "request": {
        "headers": {
          "Content-type": "application/json"
        },
        "payload": "{\"saleToken\":\"{transactionUUID}\",\"referenceCode\":\"01992211212782433139\",\"currency\":\"BRL\",\"amount\":11.00,\"shopper\":{\"fullName\":\"JOHN DOE\",\"firstName\":\"JHON\",\"lastName\":\"DOE\",\"email\":\"[email protected]\",\"cpf\":\"00000000000\"},\"date\":\"2019-02-12 17:29:33\",\"newStatus\":\"PAID\"}"
      },
      "response": {
        "headers": {
          "Content-Length": "0"
        },
        "body": "ok"
      }
    }
  ]
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Path Parameters

​
transactionUUID
string
required

Transaction UUID

Query Parameters

​
endpoint
string

Filter by requested endpoint

Maximum string length: 255
​
eventType
enum<string>

Webhook event type

Available options:
PAYMENT_CONFIRMATION,
REFUND_PAID,
REVERSAL_CREATE,
REVERSAL_PAID
​
status
enum<string>

Webhook request status

Available options:
SUCCESS,
HTTP_STATUS_NOT_EQUALS_200,
HTTP_REQUEST_TIMEOUT
​
responseCode
integer

HTTP status code returned by endpoint

Required range: x <= 999

Response

Success Response

​
status
enum<number>
Available options:
0
Example:

0

​
message
string
Example:

"success"

​
notifications
object[]