Onerway
POST

Profit share result webhook

View as Markdown
Webhook URL
Receive profit share and reversal results, and use relatedTxnId and relatedMerchantTxnId to associate them with the original payment. Automatic notifications use the original payment's paymentMethodOptions.share.profitShareNotifyUrl; without this address, no automatic notification is sent. For API-initiated profit shares and reversals, use urlCallback; it can be omitted if the original payment already has profitShareNotifyUrl configured.

Signature coverage

Request signing guide

All payload fields are included in the signature except:

  • sign(signature value)

Webhook payload fields

profitTypestring
Whether this notification reports a profit share or a reversal.
Allowed values
share
The notification reports a profit share.
return
The notification reports a profit share reversal.
profitReferencestring
Reference for the profit share or reversal. For operations initiated through the API, this is the reference supplied by the merchant. For automatic profit shares and reversals, Onerway generates it. Use relatedTxnId and relatedMerchantTxnId to associate the result with the original payment.
profitGatewayReferencestring
Onerway order number of the profit share or reversal.
statestring
Overall processing state of the order. Do not treat completed as every detail having succeeded; check receivers[].result individually.
Allowed values
processing
The profit share order is still being processed.
completed
The profit share order finished processing. Check each detail result separately.
currencystring
Settlement currency of the profit share or reversal.
relatedTxnIdstring
Transaction ID of the original payment. A reversal still references the original payment, not the profit share order.
relatedMerchantTxnIdstring
Merchant order number of the original payment.
Per-recipient processing results.
signstringSignature field · Excluded from signature
Verify the profit share or reversal notification against this signature using your SECRET. See Webhook signature verification.
Constraints
Rule
Exclude sign itself from the canonical string when verifying this webhook.

Webhook example

{
  "profitType": "share",
  "profitReference": "example_profit_share_reference",
  "profitGatewayReference": "replace_with_profit_gateway_reference",
  "state": "completed",
  "currency": "USD",
  "relatedTxnId": "9007199254740993",
  "relatedMerchantTxnId": "example_payment_order",
  "receivers": "[{\"profitDetailReference\":\"example_profit_share_detail_reference\",\"profitDetailGatewayReference\":\"replace_with_profit_detail_gateway_reference\",\"type\":\"1\",\"amount\":\"80.00\",\"result\":\"success\",\"failReason\":null,\"createdAt\":\"2026-06-22 10:00:00\",\"finishedAt\":\"2026-06-22 10:00:08\"}]",
  "sign": "replace_with_sha256_signature"
}

Acknowledgement

Return HTTP 200 after the profit share webhook is received and accepted. No response body is required.

Response body example

HTTP 200
An empty 200 response is enough; Onerway does not parse the acknowledgement body.

No response body.

Authorization, capture, and void webhook

Receive pre-authorization creation, capture, and void notifications and associate them through the same payment intent.

Saved payment method result webhook

Receive the final result notification for saved payment method (binding) transactions, covering standalone and subscription-with-binding flows.