Refund Charge
Refund a previously paid PIX charge.
Base URLs
| Environment | URL |
|---|---|
| Production | https://api-pix.crypto2pay.app/v2/pix/refund |
Request
POST /v2/pix/refund
Headers
| Header | Value |
|---|---|
Authorization | YOUR_API_KEY |
Content-Type | application/json |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | required | Internal charge ID |
Example Request
curl -X POST https://api-pix.crypto2pay.app/v2/pix/refund \
-H "Authorization: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": 59276
}'
Success Response (200)
{
"id": 59276,
"transaction_id": "12345678933",
"status": 4,
"currency": "BRL",
"amount": 145,
"refund_status": "processing"
}
Response Fields
| Field | Type | Description |
|---|---|---|
id | integer | Internal charge ID |
transaction_id | string | Your platform's transaction identifier |
status | integer | Charge status (4 = Refunded) |
currency | string | Transaction currency |
amount | number | Refunded amount |
refund_status | string | Current refund processing status (processing) |
Error Responses
| Status | Description |
|---|---|
404 | Charge not found — no charge exists with the provided id |
400 | Charge must be paid to be refunded — the charge has not been paid |
400 | Charge already refunded — a refund has already been issued for this charge |