PayNow

ON_PAYMENT_COMPLETED

Triggered when a payment is completed

Payload
bodyobjectRequired
amountintegerRequired
The payment amount, represented in cents
completed_atstringRequired
Indicates when the payment was completed
created_atstringRequired
Indicates when the payment was created
currencystringRequired
The ISO-4217 Currency Code of the Payment
gatewaystringRequired
The Payment Gateway of the Payment
gateway_fee_amountintegerRequired
The gateway fee amount, represented in cents
idstringRequired
The Flake ID of the Payment
order_idstringRequired
The Flake ID of the Order associated with the Payment
platform_fee_amountintegerRequired
The platform fee amount, represented in cents
statusstringRequired
The status of the payment
store_idstringRequired
The Flake ID of the Store associated with the Payment
store_net_amountintegerRequired
The net amount recieved by the associated store, represented in cents
tax_amountintegerRequired
The tax amount, represented in cents
tax_inclusivebooleanRequired
Indicates if the payment was Tax Inclusive
billing_countrystringOptional
The ISO-3166 country code the payment was billed to
customerCustomerDTOOptional
idstringRequired
The Flake ID of the Customer
minecraftMinecraftCustomerDTORequired
→ MinecraftCustomerDTO
profileGenericProfileDTORequired
→ GenericProfileDTO
steamSteamCustomerDTORequired
→ SteamCustomerDTO
namestringOptional
pending_atstringOptional
Indicates when the payment became pending
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_PAYMENT_COMPLETED",
  "event_id": "411486491630370816",
  "body": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "order_id": "411486491630370816",
    "gateway": "stripe",
    "currency": "USD",
    "tax_inclusive": true,
    "amount": 7500,
    "gateway_fee_amount": 200,
    "tax_amount": 1200,
    "platform_fee_amount": 375,
    "store_net_amount": 5925,
    "status": "completed",
    "created_at": "2024-01-20T12:00:00Z",
    "completed_at": "2024-01-20T13:00:00Z",
    "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"
    },
    "billing_country": "US",
    "pending_at": "2024-01-20T12:15:00Z"
  }
}