PUT
/
v1.1
/
transactions
/
{saleUUID}
/
refund
Request a sale refund
curl --request PUT \
  --url https://api.paymee.com.br/v1.1/transactions/{saleUUID}/refund \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '{
  "amount": 150,
  "reason": "shopper'\''s request"
}'
{
  "status": 0,
  "message": "success",
  "uuid": "a3b59529-ac56-3e24-9011-320456dd9491",
  "currency": "BRL",
  "originalAmount": 11,
  "totalToRefund": 11,
  "currentBalance": 16495.84,
  "discounts": 0,
  "shopper": {
    "bankDetails": {
      "account": "12345-6",
      "branch": "1234"
    },
    "document": {
      "type": "CPF",
      "number": "00000000000"
    },
    "email": "JOHN DOE",
    "phone": {
      "type": "MOBILE",
      "number": "11999990000"
    }
  }
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Path Parameters

​
saleUUID
string
required

UUID of the sale to be refunded

Body

application/json

Response

200
application/json

refund request accepted

The response is of type object.