Outbound: Refund status change

post

https://api-bnpl-wl.sandbox.open-co.tech/x-outbound-webhook-refund-status

Direction: Outbound (BNPL WL → Partner). This is NOT a callable API endpoint — it documents the payload we send to your configured webhook_url.

Sent to your webhook_url when a refund transitions status.

Headers sent:

Header	Description
`Content-Type`	`application/json`
`X-Webhook-Signature`	base64url ECDSA signature of the body (verify with our public key)

Key fields:

refund_amount: the amount being refunded to the customer
payout_amount: the total amount already paid by the customer on this application (sum of confirmed payments)
transfer_amount: the actual amount transferred to the customer via PIX by the servicing layer. Zero when no PIX transfer was needed (e.g. full refund with no payments made).

Your endpoint must:

Return HTTP 2xx within 10 seconds
Be idempotent (you may receive the same event more than once)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

webhook_type

string

enum

Event type identifier

Allowed:

refund_id

string

Unique refund identifier

application_id

uuid

Application that is being refunded

person_id

uuid

Customer identifier

status

string

enum

Current refund status

Allowed:

refund_amount

double

Amount being refunded to the customer

payout_amount

double

Total amount already paid by the customer on this application (sum of confirmed/paid payments)

transfer_amount

double

Actual amount transferred to the customer via PIX by the servicing layer. Zero when no PIX transfer was needed (e.g. full refund with no payments made).

order_reference

string | null

Original order reference from the merchant

partner_reference_id

string | null

Partner-provided reference ID for this refund

created_at

date-time

Refund creation timestamp

completed_at

date-time | null

Refund completion timestamp (null if not yet completed)

x_webhook_signature

string

Base64url ECDSA-P521-SHA256 signature of the request body. Identical to the X-Webhook-Signature header — included in the body as a convenience for partners whose infrastructure strips custom headers.

Response

200

Your endpoint should return HTTP 2xx to acknowledge receipt

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here!