Skip to main content
GET
https://api.owem.com.br
/
v4
/
i
/
pix
/
in
/
refund
/
{endToEndId}
Get Refund Status
curl --request GET \
  --url https://api.owem.com.br/v4/i/pix/in/refund/{endToEndId} \
  --header 'Authorization: <authorization>'
{
  "requestId": "a111b222-c333-4d44-8e55-f66677788899",
  "success": true,
  "size": 1,
  "data": {
    "endToEndId": "D123456789202512240000000000001",
    "status": "succeeded",
    "payer": {
      "ispb": "12345678",
      "personType": "company",
      "cpfCnpj": "XX123456000XXX",
      "name": "EXAMPLE COMPANY LTD",
      "agency": "0001",
      "accountType": "checking",
      "accountNumber": "123456789012"
    },
    "receiver": {
      "ispb": "87654321",
      "personType": "person",
      "cpfCnpj": "XXX123456XX",
      "name": "JOHN DOE",
      "agency": "0001",
      "accountType": "savings",
      "accountNumber": "300543881811"
    },
    "updatedAt": 1766523045000,
    "updatedDate": "2025-12-24"
  }
}

​
Purpose

Returns the current status of an already initiated PIX IN refund, with payer/receiver view, amounts, and timestamps.

​
Authentication

​
Authorization
string
required
Basic Auth required in format: Basic {Base64(API_KEY:API_SECRET)}

​
Path Parameters

​
endToEndId
string
required
Refund E2E (not to be confused with the original credit E2E)
The endToEndId here is the refund E2E, not the original PIX IN. To relate the two, use the parentEndToEndId field in the Ledger query.

​
Response

​
requestId
string
UUID for tracking
​
success
boolean
Operation status
​
size
number
Number of returned items
​
data
object
{
  "requestId": "a111b222-c333-4d44-8e55-f66677788899",
  "success": true,
  "size": 1,
  "data": {
    "endToEndId": "D123456789202512240000000000001",
    "status": "succeeded",
    "payer": {
      "ispb": "12345678",
      "personType": "company",
      "cpfCnpj": "XX123456000XXX",
      "name": "EXAMPLE COMPANY LTD",
      "agency": "0001",
      "accountType": "checking",
      "accountNumber": "123456789012"
    },
    "receiver": {
      "ispb": "87654321",
      "personType": "person",
      "cpfCnpj": "XXX123456XX",
      "name": "JOHN DOE",
      "agency": "0001",
      "accountType": "savings",
      "accountNumber": "300543881811"
    },
    "updatedAt": 1766523045000,
    "updatedDate": "2025-12-24"
  }
}

​
Status Codes

HTTPDescription
200Refund found
400Malformed endToEndId
401Invalid credentials
403IP not allowlisted
404Refund not found (check if it’s the correct E2E)
429Rate limit exceeded
500Internal error

​
Refund Status

StatusDescription
processingRefund registered, in settlement
succeededRefund confirmed
failedRefund not completed
For accounting details (amounts, fees, links), query the Ledger: GET /v4/i/ledger/end-to-end/:endToEndId.
The parentEndToEndId field in Ledger relates the refund E2E with the original credit E2E.