Outbound: Refund status change

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:

HeaderDescription
Content-Typeapplication/json
X-Webhook-Signaturebase64url 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 excess amount paid by the customer over the application value. When the customer has paid more than the application amount (via installments that include interest/fees), this is the surplus to be returned. Zero when there is no excess.

Your endpoint must:

  • Return HTTP 2xx within 10 seconds
  • Be idempotent (you may receive the same event more than once)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

Event type identifier

Allowed:
string

Unique refund identifier

uuid

Application that is being refunded

uuid

Customer identifier

string
enum

Current refund status

Allowed:
double

Amount being refunded to the customer

double

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

double

Excess amount paid by the customer over the application value (max of 0 and total paid minus application amount). Zero when the customer has not yet paid more than the application value.

string | null

Original order reference from the merchant

string | null

Partner-provided reference ID for this refund

date-time

Refund creation timestamp

date-time | null

Refund completion timestamp (null if not yet completed)

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here!