Your postback notification for a banking pay-in refund.

POST

/order/example-postback-to-banking-order-refund/[your_notification_url]

• Sandbox

Every time a transaction has its status changed, your system will receive a notification from ours, so that you know if transactions were paid.

We expect that your system returns to ours: status code 200. If not, we’ll retry 4 more times.

Request Body ^required

object

id

required

Identifier of the refunded pay-in order.

string

Example

92f7314d-111e-4ea2-b510-5332320809ca

code

required

External order code informed at creation time.

string

Example

payin-12345

event

required

Webhook event for the refund of a BANKING PAY-IN.

string

Allowed values: ORDER-PAYIN.REFUNDED ORDER-PAYIN.ERROR ORDER-PAYIN.REJECTED

Example

ORDER-PAYIN.REFUNDED

status

required

Refund outcome.

string

Allowed values: REFUNDED ERROR REJECTED

Example

REFUNDED

type

required

Webhook type.

string

Allowed values: REFUND

Example

REFUND

refundId

required

Refund identifier returned when the refund was requested.

string

Example

9315fe5b-ab3c-4010-a74e-ee7ca2385e21

refundedAt

Date when the refund was settled (UTC ISO-8601).

string

nullable

Example

2026-02-19T13:34:18.177Z

paidAt

Date when the original order was paid (UTC ISO-8601).

string

nullable

Example

2026-02-19T13:30:02.101Z

updatedAt

required

Date of the status transition (UTC ISO-8601).

string

Example

2026-02-19T13:34:18.177Z

endToEndId

PIX endToEndId of the refund.

string

nullable

Example

E12345678202602191334z9y8x7w6v5u

message

required

Human-readable message, filled when the refund fails.

string

subscription

Subscription the refunded order belongs to, the same object sent on its paid webhook. Present only when the order came from a subscription.

object

id

required

Identifier of the subscription this order belongs to.

string

Example

1f9a2b6c-6a0e-4a5e-9a1f-6d4f1f6f6b21

code

required

External subscription code informed at creation time.

string

Example

subscription-2024-0002

scheduledPayment

Scheduled payment this order settles. Present only when the pay-in is the settlement of a PIX Automatico scheduled payment.

object

id

required

Identifier of the scheduled payment settled by this order.

string

Example

7c1d9e2a-3b4f-4c5d-8e6f-9a0b1c2d3e4f

externalId

required

External scheduled payment code informed at creation time.

string

Example

scheduled-payment-2024-0001

Examples

PIX payin refunded

{
  "id": "de05f0db-e6a3-462e-8f1c-8dc8dd07c278",
  "code": "payin-12345",
  "event": "ORDER-PAYIN.REFUNDED",
  "status": "REFUNDED",
  "type": "REFUND",
  "refundId": "9315fe5b-ab3c-4010-a74e-ee7ca2385e21",
  "paidAt": "2026-02-19T13:32:21.552Z",
  "refundedAt": "2026-02-19T13:34:18.177Z",
  "updatedAt": "2026-02-19T13:34:18.177Z",
  "endToEndId": "D12345678202602191334z9y8x7w6v5u",
  "message": ""
}

PIX refunded - scheduled payment settlement

Refund of a PIX Automatico scheduled payment settlement. It carries the same “subscription” object sent on the paid webhook, so it can be matched with the subscription and the scheduled payment. “code” is a reference generated on our side, since this pay-in is not created by a request of yours.

{
  "id": "3b7e9d12-8c4a-4f6e-a1d2-5e8f7c6b4a39",
  "code": "a4c2e8f0-1b3d-4e5f-9a7b-6c8d0e2f4a61",
  "event": "ORDER-PAYIN.REFUNDED",
  "status": "REFUNDED",
  "type": "REFUND",
  "refundId": "a627d6b3-8550-4da1-9c85-1733c342a4fa",
  "paidAt": "2026-03-19T09:02:11.104Z",
  "refundedAt": "2026-03-20T14:10:45.320Z",
  "updatedAt": "2026-03-20T14:10:45.320Z",
  "endToEndId": "D12345678202603201410a1b2c3d4e5f",
  "message": "",
  "subscription": {
    "id": "1f9a2b6c-6a0e-4a5e-9a1f-6d4f1f6f6b21",
    "code": "subscription-2024-0002",
    "scheduledPayment": {
      "id": "7c1d9e2a-3b4f-4c5d-8e6f-9a0b1c2d3e4f",
      "externalId": "scheduled-payment-2024-0001"
    }
  }
}

Responses

200

The resource was returned successfully

object

returnCode

required

The current page.

string

Example

SUCCESS