PayNow

ON_REFUND

Triggered when a refund is completed

Payload
bodyobjectRequired
amountintegerRequired
The initial payment amount, represented in cents
approved_atstringRequired
Indicates when the refund was approved
billing_emailstringRequired
The email address of the intial payment customer
completed_atstringRequired
Indicates when the refund was completed
created_atstringRequired
Indicates when the refund was created
currencystringRequired
The ISO-4217 Currency Code of the Payment
gatewaystringRequired
The Payment Gateway associated with the refund
gateway_fee_amountintegerRequired
The initial gateway fee amount, represented in cents
idstringRequired
The Flake ID of the Refund
order_idstringRequired
The Flake ID of Order associated with the refund
payment_idstringRequired
The Flake ID of the Payment associated with the refund
pending_atstringRequired
Indicates when the refund was pending
platform_fee_amountintegerRequired
The initial platform fee amount, represented in cents
statusstringRequired
The status of the refund. Possible options: created, approved, processing, completed, canceled, failed
store_idstringRequired
The Flake ID of the store associated with the Refund
store_net_amountintegerRequired
The initial store net amount, represented in cents
store_refund_amountintegerRequired
The amount refunded to the store, represented in cents
tax_amountintegerRequired
The initial tax amount, represented in cents
tax_inclusivebooleanRequired
Indicates if taxes were inclusive in the associated payment
customerCustomerDTOOptional
idstringRequired
The Flake ID of the Customer
minecraftMinecraftCustomerDTORequired
→ MinecraftCustomerDTO
profileGenericProfileDTORequired
→ GenericProfileDTO
steamSteamCustomerDTORequired
→ SteamCustomerDTO
namestringOptional
event_idstringRequired
The ID of the Webhook Event
event_typeenumRequired
The type of webhook event
Possible enum values
  • ON_ORDER_COMPLETED
  • ON_REFUND
  • ON_CHARGEBACK
  • ON_CHARGEBACK_CLOSED
  • ON_DELIVERY_ITEM_ADDED
  • ON_DELIVERY_ITEM_ACTIVATED
  • ON_DELIVERY_ITEM_USED
  • ON_DELIVERY_ITEM_REVOKED
  • ON_DELIVERY_ITEM_EXPIRED
  • ON_DELIVERY_ITEM_RENEWED
  • ON_SUBSCRIPTION_ACTIVATED
  • ON_SUBSCRIPTION_RENEWED
  • ON_SUBSCRIPTION_CANCELED
  • ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
  • ON_CONNECTED_USER_REGISTERED
  • ON_CONNECTED_USER_BECAME_PAYABLE
  • ON_CONNECTED_USER_BECAME_UNPAYABLE
  • ON_CONNECTED_USER_PAYOUT_CREATED
  • ON_CONNECTED_USER_PAYOUT_COMPLETED
  • ON_CONNECTED_USER_TRANSACTION_INSERTED
  • ON_CONNECTED_USER_TRUST_STATUS_CHANGED
  • ON_TRIAL_ACTIVATED
  • ON_TRIAL_COMPLETED
  • ON_TRIAL_CANCELED
  • ON_PURCHASE_FOLLOW_UP_ATTEMPT_EMAIL_SENT
  • ON_PURCHASE_FOLLOW_UP_ATTEMPT_SUCCEEDED
  • ON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_EMAIL_SENT
  • ON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_SUCCEEDED
  • ON_PAYMENT_COMPLETED
  • ON_PAYMENT_FAILED
Example payload
{
  "event_type": "ON_REFUND",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "order_id": "411486491630370816",
    "payment_id": "411486491630370816",
    "gateway": "string",
    "currency": "USD",
    "tax_inclusive": false,
    "amount": 5000,
    "gateway_fee_amount": 150,
    "tax_amount": 800,
    "platform_fee_amount": 250,
    "store_net_amount": 3800,
    "store_refund_amount": 5000,
    "created_at": "2024-01-20T12:00:00Z",
    "approved_at": "2024-01-20T12:30:00Z",
    "pending_at": "2024-01-20T12:15:00Z",
    "completed_at": "2024-01-20T13:00:00Z",
    "billing_email": "john@doe.com",
    "status": "created",
    "customer": {
      "id": "411486491630370816",
      "steam": {
        "id": "76561197960287930",
        "name": "John",
        "avatar_url": "string"
      },
      "minecraft": {
        "id": "string",
        "name": "Notch",
        "avatar_url": "string"
      },
      "profile": {
        "id": "string",
        "platform": "string",
        "name": "John",
        "avatar_url": "string"
      },
      "name": "John"
    }
  }
}