Event Types

This page lists the webhook events that you may receive from SpherePay. For each webhook, we include the event name, description, and the payload.

Event Name	Description
address.create	A new address has been created
bankAccount.create	A new bank account has been created
customer.create	A new customer has been created
customer.kyc.pending	The customer's KYC is pending
customer.kyc.successful	The customer's KYC has been approved
customer.kyc.rejected	The customer's KYC has been rejected
customer.kyc.additionalReviewRequired	The customer's KYC requires additional review
customer.tos.pending	The customer's TOS is pending
customer.tos.successful	The customer has completed and agreed to the Terms of Service
payout.cancelled	A payout has been cancelled
payout.create	A payout has been created
payout.failed	A payout has failed
payout.funded	A payout has been funded
payout.pending	A payout is pending for funding
payout.processing	A payout is being processed
payout.refunded	A payout has been refunded
payout.successful	A payout has been successful
wallet.create	A new wallet has been created
webhook.create	A new webhook has been created

Retrieve Webhook Event

Use this API request to add a new webhook.

GET https://api.spherepay.co/v1/event/{event_id}

For the full API specification, see the Sphere API Reference.

Response Example

{
  "id": "event_d9703d1368074a5c8abde749ac04a3c1",
  "name": "wallet.create",
  "data": {
    "wallet": {
      "id": "wallet_925402799af140fb85ab98ce4330e417",
      "mock": false,
      "risk": null,
      "owner": "merchant",
      "signed": false,
      "address": "5ycZq7CQPahECKzXWAxbjghkv2nM81zLYym9SWGZxdLj",
      "created": "2024-08-15T21:57:45.432Z",
      "deleted": null,
      "network": "sol",
      "primary": false,
      "updated": "2024-08-15T21:57:45.432Z",
      "customer": null,
      "exported": null,
      "feePayer": false,
      "nickname": null,
      "lookupKey": null
    }
  },
  "webhookRecords": [
    {
      "requestIds": ["request_fefa2ff6169e45efa74b022e0fe868fb"],
      "webhook": {
        "id": "webhook_dab187e460e54595a76f66d38b0ee624",
        "name": "Example Webhook",
        "description": "An example webhook",
        "active": true,
        "deliveryRate": "1",
        "status": "healthy",
        "events": [
          "bankAccount.create",
          "wallet.create"
        ],
        "url": "https://example.com/webhook",
        "secret": "secret_cb8dedcf79a84b04b163ec74c7146481",
        "updated": "2024-08-15T21:57:20.144Z",
        "created": "2024-08-15T17:55:57.879Z"
      }
    }
  ],
  "mock": false,
  "updated": "2024-08-15T21:57:45.467Z",
  "created": "2024-08-15T21:57:45.467Z"
}

Retrieve Webhook Event

Response Example

On this page